Changeset 82 for trunk/src


Ignore:
Timestamp:
Mar 31, 2008, 9:06:48 AM (11 years ago)
Author:
cameron
Message:

Byteplex documentation

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/byteplex.h

    r68 r82  
    44    Licensed to International Characters, Inc., under the Academic
    55    Free License 3.0.
     6
     7    This module has as its goal the buffering of XML byte data and
     8    transformation of 16-bit and 32-bit code unit data so that the
     9    parsing engine is provided a uniform representation based on
     10    the concept of an 8-bit pseudo-ASCII representation (x8data).
     11
     12    A Byteplex object provides buffers for one to six parallel data
     13    streams based for an XML input entity, depending on the size of
     14    character code units. 
     15       1.  In the case of 8-bit code units, a single byte stream
     16           consisting of unmodified input data is maintained.
     17           x8data = src_buffer
     18       2.  In the case of 16-bit code units (UTF-16 and UCS-2 families),
     19             (a) the original code unit stream is maintained unmodified,
     20             (b) the x16hi byte stream is established for the high byte
     21                 of each code unit,
     22             (c) the x16lo byte stream is established for the low byte
     23                 of each code unit, and
     24             (d) x8data is established as the pseudo-ASCII byte stream,
     25                 with ASCII code units having their proper 8-bit values,
     26                 and all others having bit 0 set to 1.
     27       3.  In the case of 32-bit code units (UTF-32 family),
     28             (a) the original code unit stream is maintained unmodified,
     29             (b) the x32hh byte stream has high bytes of each code unit
     30             (c) the x32hl byte stream has second bytes of each code unit
     31             (d) the x32lh byte stream has third bytes of each code unit
     32             (e) the x32hh byte stream has low bytes of each code unit, and
     33             (f) x8data is established as the pseudo-ASCII byte stream,
     34                 with ASCII code units having their proper 8-bit values,
     35                 and all others having bit 0 set to 1.
     36
     37    The pseudo-ASCII representation is defined for both ASCII-based
     38    and EBCDIC-based character sets such that all characters in
     39    the ASCII repertoire (i.e., having Unicode code points from 0x00
     40    to 0x7F), are represented as themselves and no non-ASCII character
     41    is represented as a character in the ASCII repertoire.
     42
     43*/
    644
    745*/
Note: See TracChangeset for help on using the changeset viewer.