w32tex
About: TeX Live provides a comprehensive TeX system including all the major TeX-related programs, macro packages, and fonts that are free software. Windows sources.
  Fossies Dox: w32tex-src.tar.xz  ("unofficial" and yet experimental doxygen-generated source code documentation)  

TECkit_Engine.h File Reference
#include "TECkit_Common.h"
Include dependency graph for TECkit_Engine.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros

#define kFlags_ExpectsNFC   0x00000001U /* expects fully composed text (NC) */
 
#define kFlags_ExpectsNFD   0x00000002U /* expects fully decomposed text (NCD) */
 
#define kFlags_GeneratesNFC   0x00000004U /* generates fully composed text (NC) */
 
#define kFlags_GeneratesNFD   0x00000008U /* generates fully decomposed text (NCD) */
 
#define kFlags_VisualOrder   0x00008000U /* visual rather than logical order */
 
#define kFlags_Unicode   0x00010000U /* this is Unicode rather than a byte encoding */
 
#define kNameID_LHS_Name   0 /* "source" or LHS encoding name, e.g. "SIL-EEG_URDU-2001" */
 
#define kNameID_RHS_Name   1 /* "destination" or RHS encoding name, e.g. "UNICODE-3-1" */
 
#define kNameID_LHS_Description   2 /* source encoding description, e.g. "SIL East Eurasia Group Extended Urdu (Mac OS)" */
 
#define kNameID_RHS_Description   3 /* destination description, e.g. "Unicode 3.1" */
 
#define kNameID_Version   4 /* "1.0b1" */
 
#define kNameID_Contact   5 /* "mailto:nrsi@sil.org" */
 
#define kNameID_RegAuthority   6 /* "SIL International" */
 
#define kNameID_RegName   7 /* "Greek (Galatia)" */
 
#define kNameID_Copyright   8 /* "(c)2002 SIL International" */
 
#define kForm_NormalizationMask   0x0F00
 
#define kForm_NFC   0x0100
 
#define kForm_NFD   0x0200
 
#define kEndOfText   0xffffffffUL
 
#define WINAPI
 
#define CALLBACK
 
#define EXPORTED
 
#define kOptionsMask_UnmappedBehavior   0x000F
 
#define kOptionsUnmapped_UseReplacementCharSilently   0x00
 
#define kOptionsUnmapped_UseReplacementCharWithWarning   0x01
 
#define kOptionsUnmapped_DontUseReplacementChar   0x02
 
#define kOptionsMask_InputComplete   0x0100
 
#define kOptionsComplete_InputIsComplete   0x0100
 

Typedefs

typedef struct Opaque_TECkit_Converter * TECkit_Converter
 

Functions

TECkit_Status TECkit_CreateConverter (Byte *mapping, UInt32 mappingSize, Byte mapForward, UInt16 sourceForm, UInt16 targetForm, TECkit_Converter *converter)
 
TECkit_Status TECkit_DisposeConverter (TECkit_Converter converter)
 
TECkit_Status TECkit_GetConverterName (TECkit_Converter converter, UInt16 nameID, Byte *nameBuffer, UInt32 bufferSize, UInt32 *nameLength)
 
TECkit_Status TECkit_GetConverterFlags (TECkit_Converter converter, UInt32 *sourceFlags, UInt32 *targetFlags)
 
TECkit_Status TECkit_ResetConverter (TECkit_Converter converter)
 
TECkit_Status TECkit_ConvertBuffer (TECkit_Converter converter, const Byte *inBuffer, UInt32 inLength, UInt32 *inUsed, Byte *outBuffer, UInt32 outLength, UInt32 *outUsed, Byte inputIsComplete)
 
TECkit_Status TECkit_Flush (TECkit_Converter converter, Byte *outBuffer, UInt32 outLength, UInt32 *outUsed)
 
TECkit_Status TECkit_GetMappingName (Byte *mapping, UInt32 mappingSize, UInt16 nameID, Byte *nameBuffer, UInt32 bufferSize, UInt32 *nameLength)
 
TECkit_Status TECkit_GetMappingFlags (Byte *mapping, UInt32 mappingSize, UInt32 *lhsFlags, UInt32 *rhsFlags)
 
UInt32 TECkit_GetVersion ()
 
TECkit_Status TECkit_ConvertBufferOpt (TECkit_Converter converter, const Byte *inBuffer, UInt32 inLength, UInt32 *inUsed, Byte *outBuffer, UInt32 outLength, UInt32 *outUsed, UInt32 inOptions, UInt32 *lookaheadCount)
 
TECkit_Status TECkit_FlushOpt (TECkit_Converter converter, Byte *outBuffer, UInt32 outLength, UInt32 *outUsed, UInt32 inOptions, UInt32 *lookaheadCount)
 

Macro Definition Documentation

◆ CALLBACK

#define CALLBACK

Definition at line 96 of file TECkit_Engine.h.

◆ EXPORTED

#define EXPORTED

Definition at line 104 of file TECkit_Engine.h.

◆ kEndOfText

#define kEndOfText   0xffffffffUL

Definition at line 68 of file TECkit_Engine.h.

◆ kFlags_ExpectsNFC

#define kFlags_ExpectsNFC   0x00000001U /* expects fully composed text (NC) */

Definition at line 34 of file TECkit_Engine.h.

◆ kFlags_ExpectsNFD

#define kFlags_ExpectsNFD   0x00000002U /* expects fully decomposed text (NCD) */

Definition at line 35 of file TECkit_Engine.h.

◆ kFlags_GeneratesNFC

#define kFlags_GeneratesNFC   0x00000004U /* generates fully composed text (NC) */

Definition at line 36 of file TECkit_Engine.h.

◆ kFlags_GeneratesNFD

#define kFlags_GeneratesNFD   0x00000008U /* generates fully decomposed text (NCD) */

Definition at line 37 of file TECkit_Engine.h.

◆ kFlags_Unicode

#define kFlags_Unicode   0x00010000U /* this is Unicode rather than a byte encoding */

Definition at line 43 of file TECkit_Engine.h.

◆ kFlags_VisualOrder

#define kFlags_VisualOrder   0x00008000U /* visual rather than logical order */

Definition at line 40 of file TECkit_Engine.h.

◆ kForm_NFC

#define kForm_NFC   0x0100

Definition at line 62 of file TECkit_Engine.h.

◆ kForm_NFD

#define kForm_NFD   0x0200

Definition at line 63 of file TECkit_Engine.h.

◆ kForm_NormalizationMask

#define kForm_NormalizationMask   0x0F00

Definition at line 61 of file TECkit_Engine.h.

◆ kNameID_Contact

#define kNameID_Contact   5 /* "mailto:nrsi@sil.org" */

Definition at line 52 of file TECkit_Engine.h.

◆ kNameID_Copyright

#define kNameID_Copyright   8 /* "(c)2002 SIL International" */

Definition at line 55 of file TECkit_Engine.h.

◆ kNameID_LHS_Description

#define kNameID_LHS_Description   2 /* source encoding description, e.g. "SIL East Eurasia Group Extended Urdu (Mac OS)" */

Definition at line 48 of file TECkit_Engine.h.

◆ kNameID_LHS_Name

#define kNameID_LHS_Name   0 /* "source" or LHS encoding name, e.g. "SIL-EEG_URDU-2001" */

Definition at line 46 of file TECkit_Engine.h.

◆ kNameID_RegAuthority

#define kNameID_RegAuthority   6 /* "SIL International" */

Definition at line 53 of file TECkit_Engine.h.

◆ kNameID_RegName

#define kNameID_RegName   7 /* "Greek (Galatia)" */

Definition at line 54 of file TECkit_Engine.h.

◆ kNameID_RHS_Description

#define kNameID_RHS_Description   3 /* destination description, e.g. "Unicode 3.1" */

Definition at line 49 of file TECkit_Engine.h.

◆ kNameID_RHS_Name

#define kNameID_RHS_Name   1 /* "destination" or RHS encoding name, e.g. "UNICODE-3-1" */

Definition at line 47 of file TECkit_Engine.h.

◆ kNameID_Version

#define kNameID_Version   4 /* "1.0b1" */

Definition at line 51 of file TECkit_Engine.h.

◆ kOptionsComplete_InputIsComplete

#define kOptionsComplete_InputIsComplete   0x0100

Definition at line 232 of file TECkit_Engine.h.

◆ kOptionsMask_InputComplete

#define kOptionsMask_InputComplete   0x0100

Definition at line 231 of file TECkit_Engine.h.

◆ kOptionsMask_UnmappedBehavior

#define kOptionsMask_UnmappedBehavior   0x000F

Definition at line 226 of file TECkit_Engine.h.

◆ kOptionsUnmapped_DontUseReplacementChar

#define kOptionsUnmapped_DontUseReplacementChar   0x02

Definition at line 229 of file TECkit_Engine.h.

◆ kOptionsUnmapped_UseReplacementCharSilently

#define kOptionsUnmapped_UseReplacementCharSilently   0x00

Definition at line 227 of file TECkit_Engine.h.

◆ kOptionsUnmapped_UseReplacementCharWithWarning

#define kOptionsUnmapped_UseReplacementCharWithWarning   0x01

Definition at line 228 of file TECkit_Engine.h.

◆ WINAPI

#define WINAPI

Definition at line 95 of file TECkit_Engine.h.

Typedef Documentation

◆ TECkit_Converter

typedef struct Opaque_TECkit_Converter* TECkit_Converter

Definition at line 73 of file TECkit_Engine.h.

Function Documentation

◆ TECkit_ConvertBuffer()

TECkit_Status TECkit_ConvertBuffer ( TECkit_Converter  converter,
const Byte inBuffer,
UInt32  inLength,
UInt32 inUsed,
Byte outBuffer,
UInt32  outLength,
UInt32 outUsed,
Byte  inputIsComplete 
)

◆ TECkit_ConvertBufferOpt()

TECkit_Status TECkit_ConvertBufferOpt ( TECkit_Converter  converter,
const Byte inBuffer,
UInt32  inLength,
UInt32 inUsed,
Byte outBuffer,
UInt32  outLength,
UInt32 outUsed,
UInt32  inOptions,
UInt32 lookaheadCount 
)

◆ TECkit_CreateConverter()

TECkit_Status TECkit_CreateConverter ( Byte mapping,
UInt32  mappingSize,
Byte  mapForward,
UInt16  sourceForm,
UInt16  targetForm,
TECkit_Converter converter 
)

Definition at line 1925 of file Engine.cpp.

References cnv, e, kStatus_Exception, kStatus_NoError, mapping, and status.

Referenced by apply_normalization(), load_mapping_file(), and main().

◆ TECkit_DisposeConverter()

TECkit_Status TECkit_DisposeConverter ( TECkit_Converter  converter)

Definition at line 1955 of file Engine.cpp.

References cnv, kStatus_InvalidConverter, kStatus_NoError, status, and Converter::Validate().

Referenced by main().

◆ TECkit_Flush()

TECkit_Status TECkit_Flush ( TECkit_Converter  converter,
Byte outBuffer,
UInt32  outLength,
UInt32 outUsed 
)

Definition at line 2083 of file Engine.cpp.

References kOptionsUnmapped_UseReplacementCharSilently, and TECkit_FlushOpt().

◆ TECkit_FlushOpt()

TECkit_Status TECkit_FlushOpt ( TECkit_Converter  converter,
Byte outBuffer,
UInt32  outLength,
UInt32 outUsed,
UInt32  inOptions,
UInt32 lookaheadCount 
)

◆ TECkit_GetConverterFlags()

TECkit_Status TECkit_GetConverterFlags ( TECkit_Converter  converter,
UInt32 sourceFlags,
UInt32 targetFlags 
)

Definition at line 1995 of file Engine.cpp.

References cnv, kStatus_InvalidConverter, kStatus_NoError, status, and Converter::Validate().

◆ TECkit_GetConverterName()

TECkit_Status TECkit_GetConverterName ( TECkit_Converter  converter,
UInt16  nameID,
Byte nameBuffer,
UInt32  bufferSize,
UInt32 nameLength 
)

◆ TECkit_GetMappingFlags()

◆ TECkit_GetMappingName()

◆ TECkit_GetVersion()

UInt32 TECkit_GetVersion ( )

Definition at line 2190 of file Engine.cpp.

References kCurrentTECkitVersion.

Referenced by main().

◆ TECkit_ResetConverter()

TECkit_Status TECkit_ResetConverter ( TECkit_Converter  converter)

Definition at line 2011 of file Engine.cpp.

References cnv, kStatus_InvalidConverter, kStatus_NoError, status, and Converter::Validate().