File: structMCodingInfoUTF.tex

package info (click to toggle)
m17n-docs 1.8.4-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, trixie
  • size: 53,736 kB
  • sloc: javascript: 7,609; sh: 1,256; makefile: 351; ansic: 206
file content (54 lines) | stat: -rw-r--r-- 2,933 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
\doxysection{MCoding\+Info\+UTF Struct Reference}
\label{structMCodingInfoUTF}\index{MCodingInfoUTF@{MCodingInfoUTF}}


Structure for extra information about a coding system of type \mbox{\hyperlink{group__m17nConv_ggaad6093554a9b9fbee4aff963bb3b1efba52dc03931e768c13c7968dcf817c7ad7}{MCODING\+\_\+\+TYPE\+\_\+\+UTF}}.  


\doxysubsection*{Data Fields}
\begin{DoxyCompactItemize}
\item 
int \mbox{\hyperlink{structMCodingInfoUTF_ad1a0a99c0bc1b2d78090df6824c28fe8}{code\+\_\+unit\+\_\+bits}}
\item 
int \mbox{\hyperlink{structMCodingInfoUTF_a76136aaed031c21a9d8ea4ebc32bddf4}{bom}}
\item 
int \mbox{\hyperlink{structMCodingInfoUTF_ac0c8e457d17f8e5e4b7e19265c7c04d4}{endian}}
\end{DoxyCompactItemize}


\doxysubsection{Detailed Description}
Structure for extra information about a coding system of type \mbox{\hyperlink{group__m17nConv_ggaad6093554a9b9fbee4aff963bb3b1efba52dc03931e768c13c7968dcf817c7ad7}{MCODING\+\_\+\+TYPE\+\_\+\+UTF}}. 

\doxysubsection{Field Documentation}
\mbox{\label{structMCodingInfoUTF_ad1a0a99c0bc1b2d78090df6824c28fe8}} 
\index{MCodingInfoUTF@{MCodingInfoUTF}!code\_unit\_bits@{code\_unit\_bits}}
\index{code\_unit\_bits@{code\_unit\_bits}!MCodingInfoUTF@{MCodingInfoUTF}}
\doxysubsubsection{\texorpdfstring{code\_unit\_bits}{code\_unit\_bits}}
{\footnotesize\ttfamily int MCoding\+Info\+UTF\+::code\+\_\+unit\+\_\+bits}

Specify bits of a code unit. The value must be 8, 16, or 32. ~\newline
 \mbox{\label{structMCodingInfoUTF_a76136aaed031c21a9d8ea4ebc32bddf4}} 
\index{MCodingInfoUTF@{MCodingInfoUTF}!bom@{bom}}
\index{bom@{bom}!MCodingInfoUTF@{MCodingInfoUTF}}
\doxysubsubsection{\texorpdfstring{bom}{bom}}
{\footnotesize\ttfamily int MCoding\+Info\+UTF\+::bom}

Specify how to handle the heading BOM (byte order mark). The value must be 0, 1, or 2. The meanings are as follows\+:

0\+: On decoding, check the first two byte. If they are BOM, decide endian by them. If not, decide endian by the member {\ttfamily endian}. On encoding, produce byte sequence according to {\ttfamily endian} with heading BOM.

1\+: On decoding, do not handle the first two bytes as BOM, and decide endian by {\ttfamily endian}. On encoding, produce byte sequence according to {\ttfamily endian} without BOM.

2\+: On decoding, handle the first two bytes as BOM and decide ending by them. On encoding, produce byte sequence according to {\ttfamily endian} with heading BOM.

If $<$code\+\_\+unit\+\_\+bits$>$ is 8, the value has no meaning. ~\newline
 \mbox{\label{structMCodingInfoUTF_ac0c8e457d17f8e5e4b7e19265c7c04d4}} 
\index{MCodingInfoUTF@{MCodingInfoUTF}!endian@{endian}}
\index{endian@{endian}!MCodingInfoUTF@{MCodingInfoUTF}}
\doxysubsubsection{\texorpdfstring{endian}{endian}}
{\footnotesize\ttfamily int MCoding\+Info\+UTF\+::endian}

Specify the endian type. The value must be 0 or 1. 0 means little endian, and 1 means big endian.

If $<$code\+\_\+unit\+\_\+bits$>$ is 8, the value has no meaning. ~\newline