1 /***************************************************************************/
5 /* TrueTypeGX/AAT morx table validation */
6 /* body for type2 (Ligature Substitution) subtable. */
8 /* Copyright 2005 by suzuki toshiya, Masatake YAMATO, Red Hat K.K., */
9 /* David Turner, Robert Wilhelm, and Werner Lemberg. */
11 /* This file is part of the FreeType project, and may only be used, */
12 /* modified, and distributed under the terms of the FreeType project */
13 /* license, LICENSE.TXT. By continuing to use, modify, or distribute */
14 /* this file you indicate that you have read the license and */
15 /* understand and accept it fully. */
17 /***************************************************************************/
19 /***************************************************************************/
21 /* gxvalid is derived from both gxlayout module and otvalid module. */
22 /* Development of gxlayout is supported by the Information-technology */
23 /* Promotion Agency(IPA), Japan. */
25 /***************************************************************************/
31 /*************************************************************************/
33 /* The macro FT_COMPONENT is used in trace mode. It is an implicit */
34 /* parameter of the FT_TRACE() and FT_ERROR() macros, used to print/log */
35 /* messages during execution. */
38 #define FT_COMPONENT trace_gxvmorx
41 typedef struct GXV_morx_subtable_type2_StateOptRec_
43 FT_ULong ligActionTable
;
44 FT_ULong componentTable
;
45 FT_ULong ligatureTable
;
46 FT_ULong ligActionTable_length
;
47 FT_ULong componentTable_length
;
48 FT_ULong ligatureTable_length
;
50 } GXV_morx_subtable_type2_StateOptRec
,
51 *GXV_morx_subtable_type2_StateOptRecData
;
54 #define GXV_MORX_SUBTABLE_TYPE2_HEADER_SIZE \
55 ( GXV_XSTATETABLE_HEADER_SIZE + 4 + 4 + 4 )
59 gxv_morx_subtable_type2_opttable_load( FT_Bytes table
,
65 GXV_morx_subtable_type2_StateOptRecData optdata
=
66 (GXV_morx_subtable_type2_StateOptRecData
)valid
->xstatetable
.optdata
;
69 GXV_LIMIT_CHECK( 4 + 4 + 4 );
70 optdata
->ligActionTable
= FT_NEXT_ULONG( p
);
71 optdata
->componentTable
= FT_NEXT_ULONG( p
);
72 optdata
->ligatureTable
= FT_NEXT_ULONG( p
);
74 GXV_TRACE(( "offset to ligActionTable=0x%08x\n",
75 optdata
->ligActionTable
));
76 GXV_TRACE(( "offset to componentTable=0x%08x\n",
77 optdata
->componentTable
));
78 GXV_TRACE(( "offset to ligatureTable=0x%08x\n",
79 optdata
->ligatureTable
));
84 gxv_morx_subtable_type2_subtable_setup( FT_ULong table_size
,
88 FT_ULong
* classTable_length_p
,
89 FT_ULong
* stateArray_length_p
,
90 FT_ULong
* entryTable_length_p
,
97 GXV_morx_subtable_type2_StateOptRecData optdata
=
98 (GXV_morx_subtable_type2_StateOptRecData
)valid
->xstatetable
.optdata
;
101 GXV_NAME_ENTER( "subtable boundaries setup" );
106 o
[3] = optdata
->ligActionTable
;
107 o
[4] = optdata
->componentTable
;
108 o
[5] = optdata
->ligatureTable
;
109 l
[0] = classTable_length_p
;
110 l
[1] = stateArray_length_p
;
111 l
[2] = entryTable_length_p
;
112 l
[3] = &(optdata
->ligActionTable_length
);
113 l
[4] = &(optdata
->componentTable_length
);
114 l
[5] = &(optdata
->ligatureTable_length
);
116 gxv_set_length_by_ulong_offset( o
, l
, buff
, 6, table_size
, valid
);
118 GXV_TRACE(( "classTable: offset=0x%08x length=0x%08x\n",
119 classTable
, *classTable_length_p
));
120 GXV_TRACE(( "stateArray: offset=0x%08x length=0x%08x\n",
121 stateArray
, *stateArray_length_p
));
122 GXV_TRACE(( "entryTable: offset=0x%08x length=0x%08x\n",
123 entryTable
, *entryTable_length_p
));
124 GXV_TRACE(( "ligActionTable: offset=0x%08x length=0x%08x\n",
125 optdata
->ligActionTable
,
126 optdata
->ligActionTable_length
));
127 GXV_TRACE(( "componentTable: offset=0x%08x length=0x%08x\n",
128 optdata
->componentTable
,
129 optdata
->componentTable_length
));
130 GXV_TRACE(( "ligatureTable: offset=0x%08x length=0x%08x\n",
131 optdata
->ligatureTable
,
132 optdata
->ligatureTable_length
));
138 #define GXV_MORX_LIGACTION_ENTRY_SIZE 4
142 gxv_morx_subtable_type2_ligActionIndex_validate(
144 FT_UShort ligActionIndex
,
145 GXV_Validator valid
)
147 /* access ligActionTable */
148 GXV_morx_subtable_type2_StateOptRecData optdata
=
149 (GXV_morx_subtable_type2_StateOptRecData
)valid
->xstatetable
.optdata
;
151 FT_Bytes lat_base
= table
+ optdata
->ligActionTable
;
152 FT_Bytes p
= lat_base
+
153 ligActionIndex
* GXV_MORX_LIGACTION_ENTRY_SIZE
;
154 FT_Bytes lat_limit
= lat_base
+ optdata
->ligActionTable
;
159 GXV_TRACE(( "p < lat_base (%d byte rewind)\n", lat_base
- p
));
162 else if ( lat_limit
< p
)
164 GXV_TRACE(( "lat_limit < p (%d byte overrun)\n", p
- lat_limit
));
169 /* validate entry in ligActionTable */
171 #ifdef GXV_LOAD_UNUSED_VARS
179 lig_action
= FT_NEXT_ULONG( p
);
180 #ifdef GXV_LOAD_UNUSED_VARS
181 last
= (FT_UShort
)( ( lig_action
>> 31 ) & 1 );
182 store
= (FT_UShort
)( ( lig_action
>> 30 ) & 1 );
185 offset
= lig_action
& 0x3FFFFFFFUL
;
187 /* this offset is 30-bit signed value to add to GID */
188 /* it is different from the location offset in mort */
189 if ( ( offset
& 0x3FFF0000UL
) == 0x3FFF0000UL
)
190 { /* negative offset */
191 gid_limit
= valid
->face
->num_glyphs
- ( offset
& 0x0000FFFFUL
);
195 GXV_TRACE(( "ligature action table includes"
196 " too negative offset moving all GID"
197 " below defined range: 0x%04x\n",
199 GXV_SET_ERR_IF_PARANOID( FT_INVALID_OFFSET
);
201 else if ( ( offset
& 0x3FFF0000UL
) == 0x0000000UL
)
202 { /* positive offset */
203 if ( (FT_Long
)offset
< valid
->face
->num_glyphs
)
206 GXV_TRACE(( "ligature action table includes"
207 " too large offset moving all GID"
208 " over defined range: 0x%04x\n",
210 GXV_SET_ERR_IF_PARANOID( FT_INVALID_OFFSET
);
213 GXV_TRACE(( "ligature action table includes"
214 " invalid offset to add to 16-bit GID:"
215 " 0x%08x\n", offset
));
216 GXV_SET_ERR_IF_PARANOID( FT_INVALID_OFFSET
);
222 gxv_morx_subtable_type2_entry_validate(
225 GXV_StateTable_GlyphOffsetCPtr glyphOffset_p
,
228 GXV_Validator valid
)
230 #ifdef GXV_LOAD_UNUSED_VARS
231 FT_UShort setComponent
;
232 FT_UShort dontAdvance
;
233 FT_UShort performAction
;
236 FT_UShort ligActionIndex
;
242 #ifdef GXV_LOAD_UNUSED_VARS
243 setComponent
= (FT_UShort
)( ( flags
>> 15 ) & 1 );
244 dontAdvance
= (FT_UShort
)( ( flags
>> 14 ) & 1 );
245 performAction
= (FT_UShort
)( ( flags
>> 13 ) & 1 );
248 reserved
= (FT_UShort
)( flags
& 0x1FFF );
249 ligActionIndex
= glyphOffset_p
->u
;
252 GXV_TRACE(( " reserved 14bit is non-zero\n" ));
254 if ( 0 < ligActionIndex
)
255 gxv_morx_subtable_type2_ligActionIndex_validate(
256 table
, ligActionIndex
, valid
);
261 gxv_morx_subtable_type2_ligatureTable_validate( FT_Bytes table
,
262 GXV_Validator valid
)
264 GXV_morx_subtable_type2_StateOptRecData optdata
=
265 (GXV_morx_subtable_type2_StateOptRecData
)valid
->xstatetable
.optdata
;
267 FT_Bytes p
= table
+ optdata
->ligatureTable
;
268 FT_Bytes limit
= table
+ optdata
->ligatureTable
269 + optdata
->ligatureTable_length
;
272 GXV_NAME_ENTER( "morx chain subtable type2 - substitutionTable" );
274 if ( 0 != optdata
->ligatureTable
)
276 /* Apple does not give specification of ligatureTable format */
282 GXV_LIMIT_CHECK( 2 );
283 lig_gid
= FT_NEXT_USHORT( p
);
284 if ( lig_gid
< valid
->face
->num_glyphs
)
285 GXV_SET_ERR_IF_PARANOID( FT_INVALID_GLYPH_ID
);
294 gxv_morx_subtable_type2_validate( FT_Bytes table
,
296 GXV_Validator valid
)
300 GXV_morx_subtable_type2_StateOptRec lig_rec
;
303 GXV_NAME_ENTER( "morx chain subtable type2 (Ligature Substitution)" );
305 GXV_LIMIT_CHECK( GXV_MORX_SUBTABLE_TYPE2_HEADER_SIZE
);
307 valid
->xstatetable
.optdata
=
309 valid
->xstatetable
.optdata_load_func
=
310 gxv_morx_subtable_type2_opttable_load
;
311 valid
->xstatetable
.subtable_setup_func
=
312 gxv_morx_subtable_type2_subtable_setup
;
313 valid
->xstatetable
.entry_glyphoffset_fmt
=
314 GXV_GLYPHOFFSET_USHORT
;
315 valid
->xstatetable
.entry_validate_func
=
316 gxv_morx_subtable_type2_entry_validate
;
318 gxv_XStateTable_validate( p
, limit
, valid
);
320 p
+= valid
->subtable_length
;
321 gxv_morx_subtable_type2_ligatureTable_validate( table
, valid
);