PDFlib Text Extraction Toolkit (TET) Manual

Bindings
C and C++ language bindings: If no more glyphs are available for the most recent text
chunk returned by TET_get_text( ), a NULL pointer will be returned. Otherwise, a pointer
to a TET_char_info structure containing information about a single glyph will be returned.
The members of the data structure are detailed in Table 10.15.
COM, Java, .NET, and Objective-C language bindings: -1 will be returned if no more
glyphs are available for the most recent text chunk returned by TET_get_text( ), otherwise
1. Individual glyph info can be retrieved from the TET properties/public fields according
to Table 10.15. All properties/fields contain the value -1 (the unknown field contains
false) if they are accessed although the function returned -1.
Perl and Python language bindings: 0 will be returned if no more glyphs are available
for the most recent text chunk returned by TET_get_text( ), otherwise a hash containing
the keys listed in Table 10.15. Individual glyph info can be retrieved with the keys in this
hash.
PHP language binding: an empty (null) object will be returned if no more glyphs are
available for the most recent text chunk returned by TET_get_text( ), otherwise an object
containing the fields listed in Table 10.15. Individual glyph info can be retrieved from
the member fields of this object. Integer fields in the glyph info object are implemented
as long in the PHP language binding.
REALbasic binding: nil will be returned if no more glyphs are available for the most recent
text chunk returned by TET_get_text( ), otherwise a TET_char_info object containing
the members listed in Table 10.15. Individual glyph info can be retrieved with the keys in
this object. The attributes field is called attrs in the REALbasic binding to work around a
REALbasic interface problem.
Ruby binding: nil (null object) will be returned if no more glyphs are available, and a
TET_char_info object otherwise.
Table 10.15 Members of the TET_char_info structure (C, C++, Ruby), equivalent public fields (Java, PHP, Objective-C), keys
(Perl) or properties (COM and .NET) with their type and meaning. See »Glyph metrics«, page 74, and Figure 6.3 for more
details.
property/
field name
uv
type
explanation
(Integer) UTF-32 Unicode value for the current glyph. For granularities other than glyph this may be an
artificial or intermediate value which has no relationship to the final text chunk. For granularity=glyph
the sequence of Unicode values for the glyphs is identical to the logical text, but for other granularities it
may be modified by various processing steps.
(Integer) Type of the character. The following types describe real characters which correspond to a glyph
on the page. The values of all other properties/fields are determined by the corresponding glyph:
0 Normal character which corresponds to exactly one glyph
1 Start of a sequence (e.g. ligature)
The following types describe artificial characters which do not correspond to a glyph on the page. The x
and y fields will specify the most recent real character’s endpoint, the width field will be 0, and all other
fields except uv will contain the values corresponding to the most recent real character:
10 Continuation of a sequence (e.g. ligature)
11 (Deprecated and unused)
12 Inserted word, line, or zone separator
10.9 Text and Metrics Retrieval Functions 179