antlr3-strings (3) - Linux Manuals

Command to display antlr3-strings manual in Linux: $ man 3 antlr3-strings

NAME

ANTLR3_STRING_FACTORY_struct -

Definition of the string factory interface, which creates and tracks strings for you of various shapes and sizes.

SYNOPSIS

Data Fields

void(* close )(struct ANTLR3_STRING_FACTORY_struct *factory)
Pointer to function that closes the factory.
void(* destroy )(struct ANTLR3_STRING_FACTORY_struct *factory, pANTLR3_STRING string)
Pointer to function that deletes the string altogether.
ANTLR3_UINT32 index

pANTLR3_STRING(* newPtr )(struct ANTLR3_STRING_FACTORY_struct *factory, pANTLR3_UINT8 string, ANTLR3_UINT32 size)
Pointer to function that manufactures a string from a given pointer and length.
pANTLR3_STRING(* newPtr8 )(struct ANTLR3_STRING_FACTORY_struct *factory, pANTLR3_UINT8 string, ANTLR3_UINT32 size)
Pointer to function that manufactures a string from a given pointer and length.
pANTLR3_STRING(* newRaw )(struct ANTLR3_STRING_FACTORY_struct *factory)
Pointer to function that manufactures an empty string.
pANTLR3_STRING(* newSize )(struct ANTLR3_STRING_FACTORY_struct *factory, ANTLR3_UINT32 size)
Pointer to function that manufactures a raw string with no text in it but space for size characters.
pANTLR3_STRING(* newStr )(struct ANTLR3_STRING_FACTORY_struct *factory, pANTLR3_UINT8 string)
Pointer to function that manufactures a string from a given pointer and works out the length.
pANTLR3_STRING(* newStr8 )(struct ANTLR3_STRING_FACTORY_struct *factory, pANTLR3_UINT8 string)
Pointer to function that manufactures a string from a given pointer and length.
pANTLR3_STRING(* printable )(struct ANTLR3_STRING_FACTORY_struct *factory, pANTLR3_STRING string)
Pointer to function that returns a copy of the string in printable form without any control characters in it.
pANTLR3_VECTOR strings
List of all the strings that have been allocated by the factory.

Detailed Description

Definition of the string factory interface, which creates and tracks strings for you of various shapes and sizes.

Field Documentation

void(* ANTLR3_STRING_FACTORY_struct::close)(struct ANTLR3_STRING_FACTORY_struct *factory)

Pointer to function that closes the factory.

Referenced by antlr3InputClose(), antlr3StringFactoryNew(), and antlr3UCS2StringFactoryNew().

void(* ANTLR3_STRING_FACTORY_struct::destroy)(struct ANTLR3_STRING_FACTORY_struct *factory, pANTLR3_STRING string)

Pointer to function that deletes the string altogether.

Referenced by antlr3StringFactoryNew(), and antlr3UCS2StringFactoryNew().

ANTLR3_UINT32 ANTLR3_STRING_FACTORY_struct::index

Referenced by antlr3StringFactoryNew(), destroy(), newRaw16(), and newRaw8().

pANTLR3_STRING(* ANTLR3_STRING_FACTORY_struct::newPtr)(struct ANTLR3_STRING_FACTORY_struct *factory, pANTLR3_UINT8 string, ANTLR3_UINT32 size)

Pointer to function that manufactures a string from a given pointer and length. The pointer is assumed to point to characters in the same encoding as the string type, hence if this is a 16 bit string the pointer should point to 16 bit characters.

Referenced by antlr3AsciiSubstr(), antlr3StringFactoryNew(), antlr3UCS2StringFactoryNew(), antlr3UCS2Substr(), createTokenFromToken(), newStr16_16(), subString16(), subString8(), toString(), and toUTF8_8().

pANTLR3_STRING(* ANTLR3_STRING_FACTORY_struct::newPtr8)(struct ANTLR3_STRING_FACTORY_struct *factory, pANTLR3_UINT8 string, ANTLR3_UINT32 size)

Pointer to function that manufactures a string from a given pointer and length. The pointer is assumed to point at 8 bit characters which must be converted on the fly to the encoding of the actual string.

Referenced by antlr3StringFactoryNew(), antlr3UCS2StringFactoryNew(), newStr16_8(), and newStr8().

pANTLR3_STRING(* ANTLR3_STRING_FACTORY_struct::newRaw)(struct ANTLR3_STRING_FACTORY_struct *factory)

Pointer to function that manufactures an empty string.

Referenced by antlr3StringFactoryNew(), antlr3UCS2StringFactoryNew(), newSize16(), newSize8(), toString(), toStringSS(), and toStringTree().

pANTLR3_STRING(* ANTLR3_STRING_FACTORY_struct::newSize)(struct ANTLR3_STRING_FACTORY_struct *factory, ANTLR3_UINT32 size)

Pointer to function that manufactures a raw string with no text in it but space for size characters.

Referenced by antlr3StringFactoryNew(), antlr3UCS2StringFactoryNew(), newPtr16_16(), newPtr16_8(), newPtr8(), printable16(), printable8(), serializeNode(), and serializeToken().

pANTLR3_STRING(* ANTLR3_STRING_FACTORY_struct::newStr)(struct ANTLR3_STRING_FACTORY_struct *factory, pANTLR3_UINT8 string)

Pointer to function that manufactures a string from a given pointer and works out the length. The pointer is assumed to point to characters in the same encoding as the string itself, i.e. 16 bit if a 16 bit string and so on.

Referenced by antlr3AsciiFileStreamNew(), antlr3NewAsciiStringCopyStream(), antlr3NewAsciiStringInPlaceStream(), antlr3NewUCS2StringInPlaceStream(), antlr3StringFactoryNew(), and antlr3UCS2StringFactoryNew().

pANTLR3_STRING(* ANTLR3_STRING_FACTORY_struct::newStr8)(struct ANTLR3_STRING_FACTORY_struct *factory, pANTLR3_UINT8 string)

Pointer to function that manufactures a string from a given pointer and length. The pointer should point to 8 bit characters regardless of the actual encoding of the string. The 8 bit characters will be converted to the actual string encoding on the fly.

Referenced by antlr3StringFactoryNew(), antlr3UCS2StringFactoryNew(), getText(), makeDot(), and toUTF8_16().

pANTLR3_STRING(* ANTLR3_STRING_FACTORY_struct::printable)(struct ANTLR3_STRING_FACTORY_struct *factory, pANTLR3_STRING string)

Pointer to function that returns a copy of the string in printable form without any control characters in it.