1 /***************************************************************************/
5 /* TrueTypeGX/AAT common tables validation (body). */
7 /* Copyright 2004, 2005, 2009, 2010, 2013 */
8 /* 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_gxvcommon
41 /*************************************************************************/
42 /*************************************************************************/
44 /***** 16bit offset sorter *****/
46 /*************************************************************************/
47 /*************************************************************************/
50 gxv_compare_ushort_offset( FT_UShort* a,
63 gxv_set_length_by_ushort_offset( FT_UShort* offset,
68 GXV_Validator gxvalid )
73 for ( i = 0; i < nmemb; i++ )
76 for ( i = 0; i < nmemb; i++ )
80 ft_qsort( buff, ( nmemb + 1 ), sizeof ( FT_UShort ),
81 ( int(*)(const void*, const void*) )gxv_compare_ushort_offset );
83 if ( buff[nmemb] > limit )
86 for ( i = 0; i < nmemb; i++ )
91 for ( j = 0; j < nmemb; j++ )
92 if ( buff[j] == offset[i] )
98 *(length[i]) = (FT_UShort)( buff[j + 1] - buff[j] );
100 if ( 0 != offset[i] && 0 == *(length[i]) )
106 /*************************************************************************/
107 /*************************************************************************/
109 /***** 32bit offset sorter *****/
111 /*************************************************************************/
112 /*************************************************************************/
115 gxv_compare_ulong_offset( FT_ULong* a,
128 gxv_set_length_by_ulong_offset( FT_ULong* offset,
133 GXV_Validator gxvalid)
138 for ( i = 0; i < nmemb; i++ )
141 for ( i = 0; i < nmemb; i++ )
145 ft_qsort( buff, ( nmemb + 1 ), sizeof ( FT_ULong ),
146 ( int(*)(const void*, const void*) )gxv_compare_ulong_offset );
148 if ( buff[nmemb] > limit )
151 for ( i = 0; i < nmemb; i++ )
156 for ( j = 0; j < nmemb; j++ )
157 if ( buff[j] == offset[i] )
163 *(length[i]) = buff[j + 1] - buff[j];
165 if ( 0 != offset[i] && 0 == *(length[i]) )
171 /*************************************************************************/
172 /*************************************************************************/
174 /***** scan value array and get min & max *****/
176 /*************************************************************************/
177 /*************************************************************************/
181 gxv_array_getlimits_byte( FT_Bytes table,
185 GXV_Validator gxvalid )
198 GXV_LIMIT_CHECK( 1 );
199 val = FT_NEXT_BYTE( p );
201 *min = (FT_Byte)FT_MIN( *min, val );
202 *max = (FT_Byte)FT_MAX( *max, val );
205 gxvalid->subtable_length = p - table;
210 gxv_array_getlimits_ushort( FT_Bytes table,
214 GXV_Validator gxvalid )
227 GXV_LIMIT_CHECK( 2 );
228 val = FT_NEXT_USHORT( p );
230 *min = (FT_Byte)FT_MIN( *min, val );
231 *max = (FT_Byte)FT_MAX( *max, val );
234 gxvalid->subtable_length = p - table;
238 /*************************************************************************/
239 /*************************************************************************/
241 /***** BINSEARCHHEADER *****/
243 /*************************************************************************/
244 /*************************************************************************/
246 typedef struct GXV_BinSrchHeader_
250 FT_UShort searchRange;
251 FT_UShort entrySelector;
252 FT_UShort rangeShift;
258 gxv_BinSrchHeader_check_consistency( GXV_BinSrchHeader* binSrchHeader,
259 GXV_Validator gxvalid )
261 FT_UShort searchRange;
262 FT_UShort entrySelector;
263 FT_UShort rangeShift;
266 if ( binSrchHeader->unitSize == 0 )
269 if ( binSrchHeader->nUnits == 0 )
271 if ( binSrchHeader->searchRange == 0 &&
272 binSrchHeader->entrySelector == 0 &&
273 binSrchHeader->rangeShift == 0 )
279 for ( searchRange = 1, entrySelector = 1;
280 ( searchRange * 2 ) <= binSrchHeader->nUnits &&
281 searchRange < 0x8000U;
282 searchRange *= 2, entrySelector++ )
286 searchRange = (FT_UShort)( searchRange * binSrchHeader->unitSize );
287 rangeShift = (FT_UShort)( binSrchHeader->nUnits * binSrchHeader->unitSize
290 if ( searchRange != binSrchHeader->searchRange ||
291 entrySelector != binSrchHeader->entrySelector ||
292 rangeShift != binSrchHeader->rangeShift )
294 GXV_TRACE(( "Inconsistency found in BinSrchHeader\n" ));
295 GXV_TRACE(( "originally: unitSize=%d, nUnits=%d, "
296 "searchRange=%d, entrySelector=%d, "
298 binSrchHeader->unitSize, binSrchHeader->nUnits,
299 binSrchHeader->searchRange, binSrchHeader->entrySelector,
300 binSrchHeader->rangeShift ));
301 GXV_TRACE(( "calculated: unitSize=%d, nUnits=%d, "
302 "searchRange=%d, entrySelector=%d, "
304 binSrchHeader->unitSize, binSrchHeader->nUnits,
305 searchRange, entrySelector, rangeShift ));
307 GXV_SET_ERR_IF_PARANOID( FT_INVALID_DATA );
313 * parser & validator of BinSrchHeader
314 * which is used in LookupTable format 2, 4, 6.
316 * Essential parameters (unitSize, nUnits) are returned by
317 * given pointer, others (searchRange, entrySelector, rangeShift)
318 * can be calculated by essential parameters, so they are just
319 * validated and discarded.
321 * However, wrong values in searchRange, entrySelector, rangeShift
322 * won't cause fatal errors, because these parameters might be
323 * only used in old m68k font driver in MacOS.
324 * -- suzuki toshiya <mpsuzuki@hiroshima-u.ac.jp>
328 gxv_BinSrchHeader_validate( FT_Bytes table,
330 FT_UShort* unitSize_p,
332 GXV_Validator gxvalid )
335 GXV_BinSrchHeader binSrchHeader;
338 GXV_NAME_ENTER( "BinSrchHeader validate" );
340 if ( *unitSize_p == 0 )
342 GXV_LIMIT_CHECK( 2 );
343 binSrchHeader.unitSize = FT_NEXT_USHORT( p );
346 binSrchHeader.unitSize = *unitSize_p;
348 if ( *nUnits_p == 0 )
350 GXV_LIMIT_CHECK( 2 );
351 binSrchHeader.nUnits = FT_NEXT_USHORT( p );
354 binSrchHeader.nUnits = *nUnits_p;
356 GXV_LIMIT_CHECK( 2 + 2 + 2 );
357 binSrchHeader.searchRange = FT_NEXT_USHORT( p );
358 binSrchHeader.entrySelector = FT_NEXT_USHORT( p );
359 binSrchHeader.rangeShift = FT_NEXT_USHORT( p );
360 GXV_TRACE(( "nUnits %d\n", binSrchHeader.nUnits ));
362 gxv_BinSrchHeader_check_consistency( &binSrchHeader, gxvalid );
364 if ( *unitSize_p == 0 )
365 *unitSize_p = binSrchHeader.unitSize;
367 if ( *nUnits_p == 0 )
368 *nUnits_p = binSrchHeader.nUnits;
370 gxvalid->subtable_length = p - table;
375 /*************************************************************************/
376 /*************************************************************************/
378 /***** LOOKUP TABLE *****/
380 /*************************************************************************/
381 /*************************************************************************/
383 #define GXV_LOOKUP_VALUE_LOAD( P, SIGNSPEC ) \
384 ( P += 2, gxv_lookup_value_load( P - 2, SIGNSPEC ) )
386 static GXV_LookupValueDesc
387 gxv_lookup_value_load( FT_Bytes p,
390 GXV_LookupValueDesc v;
393 if ( signspec == GXV_LOOKUPVALUE_UNSIGNED )
394 v.u = FT_NEXT_USHORT( p );
396 v.s = FT_NEXT_SHORT( p );
402 #define GXV_UNITSIZE_VALIDATE( FORMAT, UNITSIZE, NUNITS, CORRECTSIZE ) \
404 if ( UNITSIZE != CORRECTSIZE ) \
406 FT_ERROR(( "unitSize=%d differs from" \
407 " expected unitSize=%d" \
408 " in LookupTable %s\n", \
409 UNITSIZE, CORRECTSIZE, FORMAT )); \
410 if ( UNITSIZE != 0 && NUNITS != 0 ) \
412 FT_ERROR(( " cannot validate anymore\n" )); \
416 FT_ERROR(( " forcibly continues\n" )); \
421 /* ================= Simple Array Format 0 Lookup Table ================ */
423 gxv_LookupTable_fmt0_validate( FT_Bytes table,
425 GXV_Validator gxvalid )
430 GXV_LookupValueDesc value;
433 GXV_NAME_ENTER( "LookupTable format 0" );
435 GXV_LIMIT_CHECK( 2 * gxvalid->face->num_glyphs );
437 for ( i = 0; i < gxvalid->face->num_glyphs; i++ )
439 GXV_LIMIT_CHECK( 2 );
440 if ( p + 2 >= limit ) /* some fonts have too-short fmt0 array */
442 GXV_TRACE(( "too short, glyphs %d - %d are missing\n",
443 i, gxvalid->face->num_glyphs ));
444 GXV_SET_ERR_IF_PARANOID( FT_INVALID_GLYPH_ID );
448 value = GXV_LOOKUP_VALUE_LOAD( p, gxvalid->lookupval_sign );
449 gxvalid->lookupval_func( i, &value, gxvalid );
452 gxvalid->subtable_length = p - table;
457 /* ================= Segment Single Format 2 Loolup Table ============== */
461 * To guarantee that a binary search terminates, you must include one or
462 * more special `end of search table' values at the end of the data to
463 * be searched. The number of termination values that need to be
464 * included is table-specific. The value that indicates binary search
465 * termination is 0xFFFF.
467 * The problem is that nUnits does not include this end-marker. It's
468 * quite difficult to discriminate whether the following 0xFFFF comes from
469 * the end-marker or some next data.
471 * -- suzuki toshiya <mpsuzuki@hiroshima-u.ac.jp>
474 gxv_LookupTable_fmt2_skip_endmarkers( FT_Bytes table,
476 GXV_Validator gxvalid )
481 while ( ( p + 4 ) < gxvalid->root->limit )
483 if ( p[0] != 0xFF || p[1] != 0xFF || /* lastGlyph */
484 p[2] != 0xFF || p[3] != 0xFF ) /* firstGlyph */
489 gxvalid->subtable_length = p - table;
494 gxv_LookupTable_fmt2_validate( FT_Bytes table,
496 GXV_Validator gxvalid )
505 FT_UShort firstGlyph;
506 GXV_LookupValueDesc value;
509 GXV_NAME_ENTER( "LookupTable format 2" );
511 unitSize = nUnits = 0;
512 gxv_BinSrchHeader_validate( p, limit, &unitSize, &nUnits, gxvalid );
513 p += gxvalid->subtable_length;
515 GXV_UNITSIZE_VALIDATE( "format2", unitSize, nUnits, 6 );
517 for ( unit = 0, gid = 0; unit < nUnits; unit++ )
519 GXV_LIMIT_CHECK( 2 + 2 + 2 );
520 lastGlyph = FT_NEXT_USHORT( p );
521 firstGlyph = FT_NEXT_USHORT( p );
522 value = GXV_LOOKUP_VALUE_LOAD( p, gxvalid->lookupval_sign );
524 gxv_glyphid_validate( firstGlyph, gxvalid );
525 gxv_glyphid_validate( lastGlyph, gxvalid );
527 if ( lastGlyph < gid )
529 GXV_TRACE(( "reverse ordered segment specification:"
530 " lastGlyph[%d]=%d < lastGlyph[%d]=%d\n",
531 unit, lastGlyph, unit - 1 , gid ));
532 GXV_SET_ERR_IF_PARANOID( FT_INVALID_GLYPH_ID );
535 if ( lastGlyph < firstGlyph )
537 GXV_TRACE(( "reverse ordered range specification at unit %d:",
538 " lastGlyph %d < firstGlyph %d ",
539 unit, lastGlyph, firstGlyph ));
540 GXV_SET_ERR_IF_PARANOID( FT_INVALID_GLYPH_ID );
542 if ( gxvalid->root->level == FT_VALIDATE_TIGHT )
543 continue; /* ftxvalidator silently skips such an entry */
545 FT_TRACE4(( "continuing with exchanged values\n" ));
547 firstGlyph = lastGlyph;
551 for ( gid = firstGlyph; gid <= lastGlyph; gid++ )
552 gxvalid->lookupval_func( gid, &value, gxvalid );
555 gxv_LookupTable_fmt2_skip_endmarkers( p, unitSize, gxvalid );
556 p += gxvalid->subtable_length;
558 gxvalid->subtable_length = p - table;
563 /* ================= Segment Array Format 4 Lookup Table =============== */
565 gxv_LookupTable_fmt4_validate( FT_Bytes table,
567 GXV_Validator gxvalid )
576 FT_UShort firstGlyph;
577 GXV_LookupValueDesc base_value;
578 GXV_LookupValueDesc value;
581 GXV_NAME_ENTER( "LookupTable format 4" );
583 unitSize = nUnits = 0;
584 gxv_BinSrchHeader_validate( p, limit, &unitSize, &nUnits, gxvalid );
585 p += gxvalid->subtable_length;
587 GXV_UNITSIZE_VALIDATE( "format4", unitSize, nUnits, 6 );
589 for ( unit = 0, gid = 0; unit < nUnits; unit++ )
591 GXV_LIMIT_CHECK( 2 + 2 );
592 lastGlyph = FT_NEXT_USHORT( p );
593 firstGlyph = FT_NEXT_USHORT( p );
595 gxv_glyphid_validate( firstGlyph, gxvalid );
596 gxv_glyphid_validate( lastGlyph, gxvalid );
598 if ( lastGlyph < gid )
600 GXV_TRACE(( "reverse ordered segment specification:"
601 " lastGlyph[%d]=%d < lastGlyph[%d]=%d\n",
602 unit, lastGlyph, unit - 1 , gid ));
603 GXV_SET_ERR_IF_PARANOID( FT_INVALID_GLYPH_ID );
606 if ( lastGlyph < firstGlyph )
608 GXV_TRACE(( "reverse ordered range specification at unit %d:",
609 " lastGlyph %d < firstGlyph %d ",
610 unit, lastGlyph, firstGlyph ));
611 GXV_SET_ERR_IF_PARANOID( FT_INVALID_GLYPH_ID );
613 if ( gxvalid->root->level == FT_VALIDATE_TIGHT )
614 continue; /* ftxvalidator silently skips such an entry */
616 FT_TRACE4(( "continuing with exchanged values\n" ));
618 firstGlyph = lastGlyph;
622 GXV_LIMIT_CHECK( 2 );
623 base_value = GXV_LOOKUP_VALUE_LOAD( p, GXV_LOOKUPVALUE_UNSIGNED );
625 for ( gid = firstGlyph; gid <= lastGlyph; gid++ )
627 value = gxvalid->lookupfmt4_trans( (FT_UShort)( gid - firstGlyph ),
632 gxvalid->lookupval_func( gid, &value, gxvalid );
636 gxv_LookupTable_fmt2_skip_endmarkers( p, unitSize, gxvalid );
637 p += gxvalid->subtable_length;
639 gxvalid->subtable_length = p - table;
644 /* ================= Segment Table Format 6 Lookup Table =============== */
646 gxv_LookupTable_fmt6_skip_endmarkers( FT_Bytes table,
648 GXV_Validator gxvalid )
653 while ( p < gxvalid->root->limit )
655 if ( p[0] != 0xFF || p[1] != 0xFF )
660 gxvalid->subtable_length = p - table;
665 gxv_LookupTable_fmt6_validate( FT_Bytes table,
667 GXV_Validator gxvalid )
671 FT_UShort prev_glyph;
676 GXV_LookupValueDesc value;
679 GXV_NAME_ENTER( "LookupTable format 6" );
681 unitSize = nUnits = 0;
682 gxv_BinSrchHeader_validate( p, limit, &unitSize, &nUnits, gxvalid );
683 p += gxvalid->subtable_length;
685 GXV_UNITSIZE_VALIDATE( "format6", unitSize, nUnits, 4 );
687 for ( unit = 0, prev_glyph = 0; unit < nUnits; unit++ )
689 GXV_LIMIT_CHECK( 2 + 2 );
690 glyph = FT_NEXT_USHORT( p );
691 value = GXV_LOOKUP_VALUE_LOAD( p, gxvalid->lookupval_sign );
693 if ( gxv_glyphid_validate( glyph, gxvalid ) )
694 GXV_TRACE(( " endmarker found within defined range"
695 " (entry %d < nUnits=%d)\n",
698 if ( prev_glyph > glyph )
700 GXV_TRACE(( "current gid 0x%04x < previous gid 0x%04x\n",
701 glyph, prev_glyph ));
702 GXV_SET_ERR_IF_PARANOID( FT_INVALID_GLYPH_ID );
706 gxvalid->lookupval_func( glyph, &value, gxvalid );
709 gxv_LookupTable_fmt6_skip_endmarkers( p, unitSize, gxvalid );
710 p += gxvalid->subtable_length;
712 gxvalid->subtable_length = p - table;
717 /* ================= Trimmed Array Format 8 Lookup Table =============== */
719 gxv_LookupTable_fmt8_validate( FT_Bytes table,
721 GXV_Validator gxvalid )
726 GXV_LookupValueDesc value;
727 FT_UShort firstGlyph;
728 FT_UShort glyphCount;
731 GXV_NAME_ENTER( "LookupTable format 8" );
733 /* firstGlyph + glyphCount */
734 GXV_LIMIT_CHECK( 2 + 2 );
735 firstGlyph = FT_NEXT_USHORT( p );
736 glyphCount = FT_NEXT_USHORT( p );
738 gxv_glyphid_validate( firstGlyph, gxvalid );
739 gxv_glyphid_validate( (FT_UShort)( firstGlyph + glyphCount ), gxvalid );
742 for ( i = 0; i < glyphCount; i++ )
744 GXV_LIMIT_CHECK( 2 );
745 value = GXV_LOOKUP_VALUE_LOAD( p, gxvalid->lookupval_sign );
746 gxvalid->lookupval_func( (FT_UShort)( firstGlyph + i ), &value, gxvalid );
749 gxvalid->subtable_length = p - table;
755 gxv_LookupTable_validate( FT_Bytes table,
757 GXV_Validator gxvalid )
762 GXV_Validate_Func fmt_funcs_table[] =
764 gxv_LookupTable_fmt0_validate, /* 0 */
766 gxv_LookupTable_fmt2_validate, /* 2 */
768 gxv_LookupTable_fmt4_validate, /* 4 */
770 gxv_LookupTable_fmt6_validate, /* 6 */
772 gxv_LookupTable_fmt8_validate, /* 8 */
775 GXV_Validate_Func func;
778 GXV_NAME_ENTER( "LookupTable" );
780 /* lookuptbl_head may be used in fmt4 transit function. */
781 gxvalid->lookuptbl_head = table;
784 GXV_LIMIT_CHECK( 2 );
785 format = FT_NEXT_USHORT( p );
786 GXV_TRACE(( " (format %d)\n", format ));
791 func = fmt_funcs_table[format];
795 func( p, limit, gxvalid );
796 p += gxvalid->subtable_length;
798 gxvalid->subtable_length = p - table;
804 /*************************************************************************/
805 /*************************************************************************/
807 /***** Glyph ID *****/
809 /*************************************************************************/
810 /*************************************************************************/
812 FT_LOCAL_DEF( FT_Int )
813 gxv_glyphid_validate( FT_UShort gid,
814 GXV_Validator gxvalid )
819 if ( gid == 0xFFFFU )
825 face = gxvalid->face;
826 if ( face->num_glyphs < gid )
828 GXV_TRACE(( " gxv_glyphid_check() gid overflow: num_glyphs %d < %d\n",
829 face->num_glyphs, gid ));
830 GXV_SET_ERR_IF_PARANOID( FT_INVALID_GLYPH_ID );
837 /*************************************************************************/
838 /*************************************************************************/
840 /***** CONTROL POINT *****/
842 /*************************************************************************/
843 /*************************************************************************/
846 gxv_ctlPoint_validate( FT_UShort gid,
848 GXV_Validator gxvalid )
858 face = gxvalid->face;
860 error = FT_Load_Glyph( face,
862 FT_LOAD_NO_BITMAP | FT_LOAD_IGNORE_TRANSFORM );
867 outline = glyph->outline;
868 n_points = outline.n_points;
871 if ( !( ctl_point < n_points ) )
876 /*************************************************************************/
877 /*************************************************************************/
879 /***** SFNT NAME *****/
881 /*************************************************************************/
882 /*************************************************************************/
885 gxv_sfntName_validate( FT_UShort name_index,
888 GXV_Validator gxvalid )
895 GXV_NAME_ENTER( "sfntName" );
897 if ( name_index < min_index || max_index < name_index )
900 nnames = FT_Get_Sfnt_Name_Count( gxvalid->face );
901 for ( i = 0; i < nnames; i++ )
903 if ( FT_Get_Sfnt_Name( gxvalid->face, i, &name ) != FT_Err_Ok )
906 if ( name.name_id == name_index )
910 GXV_TRACE(( " nameIndex = %d (UNTITLED)\n", name_index ));
912 goto Exit; /* make compiler happy */
915 FT_TRACE1(( " nameIndex = %d (", name_index ));
916 GXV_TRACE_HEXDUMP_SFNTNAME( name );
917 FT_TRACE1(( ")\n" ));
924 /*************************************************************************/
925 /*************************************************************************/
927 /***** STATE TABLE *****/
929 /*************************************************************************/
930 /*************************************************************************/
932 /* -------------------------- Class Table --------------------------- */
935 * highestClass specifies how many classes are defined in this
936 * Class Subtable. Apple spec does not mention whether undefined
937 * holes in the class (e.g.: 0-3 are predefined, 4 is unused, 5 is used)
938 * are permitted. At present, holes in a defined class are not checked.
939 * -- suzuki toshiya <mpsuzuki@hiroshima-u.ac.jp>
943 gxv_ClassTable_validate( FT_Bytes table,
946 FT_Byte* maxClassID_p,
947 GXV_Validator gxvalid )
950 FT_Bytes limit = table + *length_p;
951 FT_UShort firstGlyph;
955 GXV_NAME_ENTER( "ClassTable" );
957 *maxClassID_p = 3; /* Classes 0, 2, and 3 are predefined */
959 GXV_LIMIT_CHECK( 2 + 2 );
960 firstGlyph = FT_NEXT_USHORT( p );
961 nGlyphs = FT_NEXT_USHORT( p );
963 GXV_TRACE(( " (firstGlyph = %d, nGlyphs = %d)\n", firstGlyph, nGlyphs ));
968 gxv_glyphid_validate( (FT_UShort)( firstGlyph + nGlyphs ), gxvalid );
971 FT_Byte nGlyphInClass[256];
976 ft_memset( nGlyphInClass, 0, 256 );
979 for ( i = 0; i < nGlyphs; i++ )
981 GXV_LIMIT_CHECK( 1 );
982 classID = FT_NEXT_BYTE( p );
985 /* following classes should not appear in class array */
986 case 0: /* end of text */
987 case 2: /* out of bounds */
988 case 3: /* end of line */
992 case 1: /* out of bounds */
993 default: /* user-defined: 4 - ( stateSize - 1 ) */
994 if ( classID >= stateSize )
995 FT_INVALID_DATA; /* assign glyph to undefined state */
997 nGlyphInClass[classID]++;
1001 *length_p = (FT_UShort)( p - table );
1003 /* scan max ClassID in use */
1004 for ( i = 0; i < stateSize; i++ )
1005 if ( ( 3 < i ) && ( nGlyphInClass[i] > 0 ) )
1006 *maxClassID_p = (FT_Byte)i; /* XXX: Check Range? */
1010 GXV_TRACE(( "Declared stateSize=0x%02x, Used maxClassID=0x%02x\n",
1011 stateSize, *maxClassID_p ));
1016 /* --------------------------- State Array ----------------------------- */
1019 gxv_StateArray_validate( FT_Bytes table,
1020 FT_UShort* length_p,
1022 FT_UShort stateSize,
1023 FT_Byte* maxState_p,
1024 FT_Byte* maxEntry_p,
1025 GXV_Validator gxvalid )
1028 FT_Bytes limit = table + *length_p;
1032 FT_UNUSED( stateSize ); /* for the non-debugging case */
1035 GXV_NAME_ENTER( "StateArray" );
1037 GXV_TRACE(( "parse %d bytes by stateSize=%d maxClassID=%d\n",
1038 (int)(*length_p), stateSize, (int)(maxClassID) ));
1041 * 2 states are predefined and must be described in StateArray:
1042 * state 0 (start of text), 1 (start of line)
1044 GXV_LIMIT_CHECK( ( 1 + maxClassID ) * 2 );
1049 /* read if enough to read another state */
1050 while ( p + ( 1 + maxClassID ) <= limit )
1053 for ( clazz = 0; clazz <= maxClassID; clazz++ )
1055 entry = FT_NEXT_BYTE( p );
1056 *maxEntry_p = (FT_Byte)FT_MAX( *maxEntry_p, entry );
1059 GXV_TRACE(( "parsed: maxState=%d, maxEntry=%d\n",
1060 *maxState_p, *maxEntry_p ));
1062 *length_p = (FT_UShort)( p - table );
1068 /* --------------------------- Entry Table ----------------------------- */
1071 gxv_EntryTable_validate( FT_Bytes table,
1072 FT_UShort* length_p,
1074 FT_UShort stateArray,
1075 FT_UShort stateArray_length,
1077 FT_Bytes statetable_table,
1078 FT_Bytes statetable_limit,
1079 GXV_Validator gxvalid )
1082 FT_Bytes limit = table + *length_p;
1085 FT_Int entrySize = 2 + 2 + GXV_GLYPHOFFSET_SIZE( statetable );
1087 GXV_XStateTable_GlyphOffsetDesc glyphOffset;
1090 GXV_NAME_ENTER( "EntryTable" );
1092 GXV_TRACE(( "maxEntry=%d entrySize=%d\n", maxEntry, entrySize ));
1094 if ( ( maxEntry + 1 ) * entrySize > *length_p )
1096 GXV_SET_ERR_IF_PARANOID( FT_INVALID_TOO_SHORT );
1098 /* ftxvalidator and FontValidator both warn and continue */
1099 maxEntry = (FT_Byte)( *length_p / entrySize - 1 );
1100 GXV_TRACE(( "too large maxEntry, shrinking to %d fit EntryTable length\n",
1104 for ( entry = 0; entry <= maxEntry; entry++ )
1110 GXV_LIMIT_CHECK( 2 + 2 );
1111 newState = FT_NEXT_USHORT( p );
1112 flags = FT_NEXT_USHORT( p );
1115 if ( newState < stateArray ||
1116 stateArray + stateArray_length < newState )
1118 GXV_TRACE(( " newState offset 0x%04x is out of stateArray\n",
1120 GXV_SET_ERR_IF_PARANOID( FT_INVALID_OFFSET );
1124 if ( 0 != ( ( newState - stateArray ) % ( 1 + maxClassID ) ) )
1126 GXV_TRACE(( " newState offset 0x%04x is not aligned to %d-classes\n",
1127 newState, 1 + maxClassID ));
1128 GXV_SET_ERR_IF_PARANOID( FT_INVALID_OFFSET );
1132 state = (FT_Byte)( ( newState - stateArray ) / ( 1 + maxClassID ) );
1134 switch ( GXV_GLYPHOFFSET_FMT( statetable ) )
1136 case GXV_GLYPHOFFSET_NONE:
1137 glyphOffset.uc = 0; /* make compiler happy */
1140 case GXV_GLYPHOFFSET_UCHAR:
1141 glyphOffset.uc = FT_NEXT_BYTE( p );
1144 case GXV_GLYPHOFFSET_CHAR:
1145 glyphOffset.c = FT_NEXT_CHAR( p );
1148 case GXV_GLYPHOFFSET_USHORT:
1149 glyphOffset.u = FT_NEXT_USHORT( p );
1152 case GXV_GLYPHOFFSET_SHORT:
1153 glyphOffset.s = FT_NEXT_SHORT( p );
1156 case GXV_GLYPHOFFSET_ULONG:
1157 glyphOffset.ul = FT_NEXT_ULONG( p );
1160 case GXV_GLYPHOFFSET_LONG:
1161 glyphOffset.l = FT_NEXT_LONG( p );
1165 GXV_SET_ERR_IF_PARANOID( FT_INVALID_FORMAT );
1169 if ( NULL != gxvalid->statetable.entry_validate_func )
1170 gxvalid->statetable.entry_validate_func( state,
1179 *length_p = (FT_UShort)( p - table );
1185 /* =========================== State Table ============================= */
1187 FT_LOCAL_DEF( void )
1188 gxv_StateTable_subtable_setup( FT_UShort table_size,
1189 FT_UShort classTable,
1190 FT_UShort stateArray,
1191 FT_UShort entryTable,
1192 FT_UShort* classTable_length_p,
1193 FT_UShort* stateArray_length_p,
1194 FT_UShort* entryTable_length_p,
1195 GXV_Validator gxvalid )
1205 l[0] = classTable_length_p;
1206 l[1] = stateArray_length_p;
1207 l[2] = entryTable_length_p;
1209 gxv_set_length_by_ushort_offset( o, l, buff, 3, table_size, gxvalid );
1213 FT_LOCAL_DEF( void )
1214 gxv_StateTable_validate( FT_Bytes table,
1216 GXV_Validator gxvalid )
1218 FT_UShort stateSize;
1219 FT_UShort classTable; /* offset to Class(Sub)Table */
1220 FT_UShort stateArray; /* offset to StateArray */
1221 FT_UShort entryTable; /* offset to EntryTable */
1223 FT_UShort classTable_length;
1224 FT_UShort stateArray_length;
1225 FT_UShort entryTable_length;
1230 GXV_StateTable_Subtable_Setup_Func setup_func;
1235 GXV_NAME_ENTER( "StateTable" );
1237 GXV_TRACE(( "StateTable header\n" ));
1239 GXV_LIMIT_CHECK( 2 + 2 + 2 + 2 );
1240 stateSize = FT_NEXT_USHORT( p );
1241 classTable = FT_NEXT_USHORT( p );
1242 stateArray = FT_NEXT_USHORT( p );
1243 entryTable = FT_NEXT_USHORT( p );
1245 GXV_TRACE(( "stateSize=0x%04x\n", stateSize ));
1246 GXV_TRACE(( "offset to classTable=0x%04x\n", classTable ));
1247 GXV_TRACE(( "offset to stateArray=0x%04x\n", stateArray ));
1248 GXV_TRACE(( "offset to entryTable=0x%04x\n", entryTable ));
1250 if ( stateSize > 0xFF )
1253 if ( gxvalid->statetable.optdata_load_func != NULL )
1254 gxvalid->statetable.optdata_load_func( p, limit, gxvalid );
1256 if ( gxvalid->statetable.subtable_setup_func != NULL)
1257 setup_func = gxvalid->statetable.subtable_setup_func;
1259 setup_func = gxv_StateTable_subtable_setup;
1261 setup_func( (FT_UShort)( limit - table ),
1270 GXV_TRACE(( "StateTable Subtables\n" ));
1272 if ( classTable != 0 )
1273 gxv_ClassTable_validate( table + classTable,
1279 maxClassID = (FT_Byte)( stateSize - 1 );
1281 if ( stateArray != 0 )
1282 gxv_StateArray_validate( table + stateArray,
1292 maxState = 1; /* 0:start of text, 1:start of line are predefined */
1297 if ( maxEntry > 0 && entryTable == 0 )
1300 if ( entryTable != 0 )
1301 gxv_EntryTable_validate( table + entryTable,
1315 /* ================= eXtended State Table (for morx) =================== */
1317 FT_LOCAL_DEF( void )
1318 gxv_XStateTable_subtable_setup( FT_ULong table_size,
1319 FT_ULong classTable,
1320 FT_ULong stateArray,
1321 FT_ULong entryTable,
1322 FT_ULong* classTable_length_p,
1323 FT_ULong* stateArray_length_p,
1324 FT_ULong* entryTable_length_p,
1325 GXV_Validator gxvalid )
1335 l[0] = classTable_length_p;
1336 l[1] = stateArray_length_p;
1337 l[2] = entryTable_length_p;
1339 gxv_set_length_by_ulong_offset( o, l, buff, 3, table_size, gxvalid );
1344 gxv_XClassTable_lookupval_validate( FT_UShort glyph,
1345 GXV_LookupValueCPtr value_p,
1346 GXV_Validator gxvalid )
1350 if ( value_p->u >= gxvalid->xstatetable.nClasses )
1352 if ( value_p->u > gxvalid->xstatetable.maxClassID )
1353 gxvalid->xstatetable.maxClassID = value_p->u;
1358 +===============+ --------+
1365 | firstGlyph[0] | | head of lookup table
1366 +---------------+ | +
1367 | offset[0] | -> | offset [byte]
1368 +===============+ | +
1369 | lastGlyph[1] | | (glyphID - firstGlyph) * 2 [byte]
1383 static GXV_LookupValueDesc
1384 gxv_XClassTable_lookupfmt4_transit( FT_UShort relative_gindex,
1385 GXV_LookupValueCPtr base_value_p,
1386 FT_Bytes lookuptbl_limit,
1387 GXV_Validator gxvalid )
1392 GXV_LookupValueDesc value;
1394 /* XXX: check range? */
1395 offset = (FT_UShort)( base_value_p->u +
1396 relative_gindex * sizeof ( FT_UShort ) );
1398 p = gxvalid->lookuptbl_head + offset;
1399 limit = lookuptbl_limit;
1401 GXV_LIMIT_CHECK ( 2 );
1402 value.u = FT_NEXT_USHORT( p );
1409 gxv_XStateArray_validate( FT_Bytes table,
1411 FT_UShort maxClassID,
1413 FT_UShort* maxState_p,
1414 FT_UShort* maxEntry_p,
1415 GXV_Validator gxvalid )
1418 FT_Bytes limit = table + *length_p;
1422 FT_UNUSED( stateSize ); /* for the non-debugging case */
1425 GXV_NAME_ENTER( "XStateArray" );
1427 GXV_TRACE(( "parse % 3d bytes by stateSize=% 3d maxClassID=% 3d\n",
1428 (int)(*length_p), stateSize, (int)(maxClassID) ));
1431 * 2 states are predefined and must be described:
1432 * state 0 (start of text), 1 (start of line)
1434 GXV_LIMIT_CHECK( ( 1 + maxClassID ) * 2 * 2 );
1439 /* read if enough to read another state */
1440 while ( p + ( ( 1 + maxClassID ) * 2 ) <= limit )
1443 for ( clazz = 0; clazz <= maxClassID; clazz++ )
1445 entry = FT_NEXT_USHORT( p );
1446 *maxEntry_p = (FT_UShort)FT_MAX( *maxEntry_p, entry );
1449 GXV_TRACE(( "parsed: maxState=%d, maxEntry=%d\n",
1450 *maxState_p, *maxEntry_p ));
1452 *length_p = p - table;
1459 gxv_XEntryTable_validate( FT_Bytes table,
1462 FT_ULong stateArray_length,
1463 FT_UShort maxClassID,
1464 FT_Bytes xstatetable_table,
1465 FT_Bytes xstatetable_limit,
1466 GXV_Validator gxvalid )
1469 FT_Bytes limit = table + *length_p;
1472 FT_Int entrySize = 2 + 2 + GXV_GLYPHOFFSET_SIZE( xstatetable );
1475 GXV_NAME_ENTER( "XEntryTable" );
1476 GXV_TRACE(( "maxEntry=%d entrySize=%d\n", maxEntry, entrySize ));
1478 if ( ( p + ( maxEntry + 1 ) * entrySize ) > limit )
1479 FT_INVALID_TOO_SHORT;
1481 for (entry = 0; entry <= maxEntry ; entry++ )
1483 FT_UShort newState_idx;
1485 GXV_XStateTable_GlyphOffsetDesc glyphOffset;
1488 GXV_LIMIT_CHECK( 2 + 2 );
1489 newState_idx = FT_NEXT_USHORT( p );
1490 flags = FT_NEXT_USHORT( p );
1492 if ( stateArray_length < (FT_ULong)( newState_idx * 2 ) )
1494 GXV_TRACE(( " newState index 0x%04x points out of stateArray\n",
1496 GXV_SET_ERR_IF_PARANOID( FT_INVALID_OFFSET );
1499 state = (FT_UShort)( newState_idx / ( 1 + maxClassID ) );
1500 if ( 0 != ( newState_idx % ( 1 + maxClassID ) ) )
1502 FT_TRACE4(( "-> new state = %d (supposed)\n"
1503 "but newState index 0x%04x is not aligned to %d-classes\n",
1504 state, newState_idx, 1 + maxClassID ));
1505 GXV_SET_ERR_IF_PARANOID( FT_INVALID_OFFSET );
1508 switch ( GXV_GLYPHOFFSET_FMT( xstatetable ) )
1510 case GXV_GLYPHOFFSET_NONE:
1511 glyphOffset.uc = 0; /* make compiler happy */
1514 case GXV_GLYPHOFFSET_UCHAR:
1515 glyphOffset.uc = FT_NEXT_BYTE( p );
1518 case GXV_GLYPHOFFSET_CHAR:
1519 glyphOffset.c = FT_NEXT_CHAR( p );
1522 case GXV_GLYPHOFFSET_USHORT:
1523 glyphOffset.u = FT_NEXT_USHORT( p );
1526 case GXV_GLYPHOFFSET_SHORT:
1527 glyphOffset.s = FT_NEXT_SHORT( p );
1530 case GXV_GLYPHOFFSET_ULONG:
1531 glyphOffset.ul = FT_NEXT_ULONG( p );
1534 case GXV_GLYPHOFFSET_LONG:
1535 glyphOffset.l = FT_NEXT_LONG( p );
1539 GXV_SET_ERR_IF_PARANOID( FT_INVALID_FORMAT );
1543 if ( NULL != gxvalid->xstatetable.entry_validate_func )
1544 gxvalid->xstatetable.entry_validate_func( state,
1553 *length_p = p - table;
1559 FT_LOCAL_DEF( void )
1560 gxv_XStateTable_validate( FT_Bytes table,
1562 GXV_Validator gxvalid )
1564 /* StateHeader members */
1565 FT_ULong classTable; /* offset to Class(Sub)Table */
1566 FT_ULong stateArray; /* offset to StateArray */
1567 FT_ULong entryTable; /* offset to EntryTable */
1569 FT_ULong classTable_length;
1570 FT_ULong stateArray_length;
1571 FT_ULong entryTable_length;
1575 GXV_XStateTable_Subtable_Setup_Func setup_func;
1580 GXV_NAME_ENTER( "XStateTable" );
1582 GXV_TRACE(( "XStateTable header\n" ));
1584 GXV_LIMIT_CHECK( 4 + 4 + 4 + 4 );
1585 gxvalid->xstatetable.nClasses = FT_NEXT_ULONG( p );
1586 classTable = FT_NEXT_ULONG( p );
1587 stateArray = FT_NEXT_ULONG( p );
1588 entryTable = FT_NEXT_ULONG( p );
1590 GXV_TRACE(( "nClasses =0x%08x\n", gxvalid->xstatetable.nClasses ));
1591 GXV_TRACE(( "offset to classTable=0x%08x\n", classTable ));
1592 GXV_TRACE(( "offset to stateArray=0x%08x\n", stateArray ));
1593 GXV_TRACE(( "offset to entryTable=0x%08x\n", entryTable ));
1595 if ( gxvalid->xstatetable.nClasses > 0xFFFFU )
1598 GXV_TRACE(( "StateTable Subtables\n" ));
1600 if ( gxvalid->xstatetable.optdata_load_func != NULL )
1601 gxvalid->xstatetable.optdata_load_func( p, limit, gxvalid );
1603 if ( gxvalid->xstatetable.subtable_setup_func != NULL )
1604 setup_func = gxvalid->xstatetable.subtable_setup_func;
1606 setup_func = gxv_XStateTable_subtable_setup;
1608 setup_func( limit - table,
1617 if ( classTable != 0 )
1619 gxvalid->xstatetable.maxClassID = 0;
1620 gxvalid->lookupval_sign = GXV_LOOKUPVALUE_UNSIGNED;
1621 gxvalid->lookupval_func = gxv_XClassTable_lookupval_validate;
1622 gxvalid->lookupfmt4_trans = gxv_XClassTable_lookupfmt4_transit;
1623 gxv_LookupTable_validate( table + classTable,
1624 table + classTable + classTable_length,
1627 if ( gxvalid->subtable_length < classTable_length )
1628 classTable_length = gxvalid->subtable_length;
1633 /* XXX: check range? */
1634 gxvalid->xstatetable.maxClassID =
1635 (FT_UShort)( gxvalid->xstatetable.nClasses - 1 );
1638 if ( stateArray != 0 )
1639 gxv_XStateArray_validate( table + stateArray,
1641 gxvalid->xstatetable.maxClassID,
1642 gxvalid->xstatetable.nClasses,
1649 maxState = 1; /* 0:start of text, 1:start of line are predefined */
1654 if ( maxEntry > 0 && entryTable == 0 )
1657 if ( entryTable != 0 )
1658 gxv_XEntryTable_validate( table + entryTable,
1662 gxvalid->xstatetable.maxClassID,
1671 /*************************************************************************/
1672 /*************************************************************************/
1674 /***** Table overlapping *****/
1676 /*************************************************************************/
1677 /*************************************************************************/
1680 gxv_compare_ranges( FT_Bytes table1_start,
1681 FT_ULong table1_length,
1682 FT_Bytes table2_start,
1683 FT_ULong table2_length )
1685 if ( table1_start == table2_start )
1687 if ( ( table1_length == 0 || table2_length == 0 ) )
1690 else if ( table1_start < table2_start )
1692 if ( ( table1_start + table1_length ) <= table2_start )
1695 else if ( table1_start > table2_start )
1697 if ( ( table1_start >= table2_start + table2_length ) )
1707 FT_LOCAL_DEF( void )
1708 gxv_odtect_add_range( FT_Bytes start,
1710 const FT_String* name,
1711 GXV_odtect_Range odtect )
1713 odtect->range[odtect->nRanges].start = start;
1714 odtect->range[odtect->nRanges].length = length;
1715 odtect->range[odtect->nRanges].name = (FT_String*)name;
1720 FT_LOCAL_DEF( void )
1721 gxv_odtect_validate( GXV_odtect_Range odtect,
1722 GXV_Validator gxvalid )
1727 GXV_NAME_ENTER( "check overlap among multi ranges" );
1729 for ( i = 0; i < odtect->nRanges; i++ )
1730 for ( j = 0; j < i; j++ )
1731 if ( 0 != gxv_compare_ranges( odtect->range[i].start,
1732 odtect->range[i].length,
1733 odtect->range[j].start,
1734 odtect->range[j].length ) )
1736 #ifdef FT_DEBUG_LEVEL_TRACE
1737 if ( odtect->range[i].name || odtect->range[j].name )
1738 GXV_TRACE(( "found overlap between range %d and range %d\n",
1741 GXV_TRACE(( "found overlap between `%s' and `%s\'\n",
1742 odtect->range[i].name,
1743 odtect->range[j].name ));