1049d6fea481044fcc000e7782e5bc7046fc70844The Android Open Source Project/***************************************************************************/ 2049d6fea481044fcc000e7782e5bc7046fc70844The Android Open Source Project/* */ 3049d6fea481044fcc000e7782e5bc7046fc70844The Android Open Source Project/* ftvalid.h */ 4049d6fea481044fcc000e7782e5bc7046fc70844The Android Open Source Project/* */ 5049d6fea481044fcc000e7782e5bc7046fc70844The Android Open Source Project/* FreeType validation support (specification). */ 6049d6fea481044fcc000e7782e5bc7046fc70844The Android Open Source Project/* */ 7727dee178a392d20eb050d0c446f2fcc29058fa1Victoria Lease/* Copyright 2004, 2013 by */ 8049d6fea481044fcc000e7782e5bc7046fc70844The Android Open Source Project/* David Turner, Robert Wilhelm, and Werner Lemberg. */ 9049d6fea481044fcc000e7782e5bc7046fc70844The Android Open Source Project/* */ 10049d6fea481044fcc000e7782e5bc7046fc70844The Android Open Source Project/* This file is part of the FreeType project, and may only be used, */ 11049d6fea481044fcc000e7782e5bc7046fc70844The Android Open Source Project/* modified, and distributed under the terms of the FreeType project */ 12049d6fea481044fcc000e7782e5bc7046fc70844The Android Open Source Project/* license, LICENSE.TXT. By continuing to use, modify, or distribute */ 13049d6fea481044fcc000e7782e5bc7046fc70844The Android Open Source Project/* this file you indicate that you have read the license and */ 14049d6fea481044fcc000e7782e5bc7046fc70844The Android Open Source Project/* understand and accept it fully. */ 15049d6fea481044fcc000e7782e5bc7046fc70844The Android Open Source Project/* */ 16049d6fea481044fcc000e7782e5bc7046fc70844The Android Open Source Project/***************************************************************************/ 17049d6fea481044fcc000e7782e5bc7046fc70844The Android Open Source Project 18049d6fea481044fcc000e7782e5bc7046fc70844The Android Open Source Project 19049d6fea481044fcc000e7782e5bc7046fc70844The Android Open Source Project#ifndef __FTVALID_H__ 20049d6fea481044fcc000e7782e5bc7046fc70844The Android Open Source Project#define __FTVALID_H__ 21049d6fea481044fcc000e7782e5bc7046fc70844The Android Open Source Project 22049d6fea481044fcc000e7782e5bc7046fc70844The Android Open Source Project#include <ft2build.h> 23049d6fea481044fcc000e7782e5bc7046fc70844The Android Open Source Project#include FT_CONFIG_STANDARD_LIBRARY_H /* for ft_setjmp and ft_longjmp */ 24049d6fea481044fcc000e7782e5bc7046fc70844The Android Open Source Project 25049d6fea481044fcc000e7782e5bc7046fc70844The Android Open Source Project 26049d6fea481044fcc000e7782e5bc7046fc70844The Android Open Source ProjectFT_BEGIN_HEADER 27049d6fea481044fcc000e7782e5bc7046fc70844The Android Open Source Project 28049d6fea481044fcc000e7782e5bc7046fc70844The Android Open Source Project 29049d6fea481044fcc000e7782e5bc7046fc70844The Android Open Source Project /*************************************************************************/ 30049d6fea481044fcc000e7782e5bc7046fc70844The Android Open Source Project /*************************************************************************/ 31049d6fea481044fcc000e7782e5bc7046fc70844The Android Open Source Project /*************************************************************************/ 32049d6fea481044fcc000e7782e5bc7046fc70844The Android Open Source Project /**** ****/ 33049d6fea481044fcc000e7782e5bc7046fc70844The Android Open Source Project /**** ****/ 34049d6fea481044fcc000e7782e5bc7046fc70844The Android Open Source Project /**** V A L I D A T I O N ****/ 35049d6fea481044fcc000e7782e5bc7046fc70844The Android Open Source Project /**** ****/ 36049d6fea481044fcc000e7782e5bc7046fc70844The Android Open Source Project /**** ****/ 37049d6fea481044fcc000e7782e5bc7046fc70844The Android Open Source Project /*************************************************************************/ 38049d6fea481044fcc000e7782e5bc7046fc70844The Android Open Source Project /*************************************************************************/ 39049d6fea481044fcc000e7782e5bc7046fc70844The Android Open Source Project /*************************************************************************/ 40049d6fea481044fcc000e7782e5bc7046fc70844The Android Open Source Project 41049d6fea481044fcc000e7782e5bc7046fc70844The Android Open Source Project /* handle to a validation object */ 42049d6fea481044fcc000e7782e5bc7046fc70844The Android Open Source Project typedef struct FT_ValidatorRec_ volatile* FT_Validator; 43049d6fea481044fcc000e7782e5bc7046fc70844The Android Open Source Project 44049d6fea481044fcc000e7782e5bc7046fc70844The Android Open Source Project 45049d6fea481044fcc000e7782e5bc7046fc70844The Android Open Source Project /*************************************************************************/ 46049d6fea481044fcc000e7782e5bc7046fc70844The Android Open Source Project /* */ 47049d6fea481044fcc000e7782e5bc7046fc70844The Android Open Source Project /* There are three distinct validation levels defined here: */ 48049d6fea481044fcc000e7782e5bc7046fc70844The Android Open Source Project /* */ 49049d6fea481044fcc000e7782e5bc7046fc70844The Android Open Source Project /* FT_VALIDATE_DEFAULT :: */ 50049d6fea481044fcc000e7782e5bc7046fc70844The Android Open Source Project /* A table that passes this validation level can be used reliably by */ 51049d6fea481044fcc000e7782e5bc7046fc70844The Android Open Source Project /* FreeType. It generally means that all offsets have been checked to */ 52049d6fea481044fcc000e7782e5bc7046fc70844The Android Open Source Project /* prevent out-of-bound reads, that array counts are correct, etc. */ 53049d6fea481044fcc000e7782e5bc7046fc70844The Android Open Source Project /* */ 54049d6fea481044fcc000e7782e5bc7046fc70844The Android Open Source Project /* FT_VALIDATE_TIGHT :: */ 55049d6fea481044fcc000e7782e5bc7046fc70844The Android Open Source Project /* A table that passes this validation level can be used reliably and */ 56049d6fea481044fcc000e7782e5bc7046fc70844The Android Open Source Project /* doesn't contain invalid data. For example, a charmap table that */ 57049d6fea481044fcc000e7782e5bc7046fc70844The Android Open Source Project /* returns invalid glyph indices will not pass, even though it can */ 58049d6fea481044fcc000e7782e5bc7046fc70844The Android Open Source Project /* be used with FreeType in default mode (the library will simply */ 59049d6fea481044fcc000e7782e5bc7046fc70844The Android Open Source Project /* return an error later when trying to load the glyph). */ 60049d6fea481044fcc000e7782e5bc7046fc70844The Android Open Source Project /* */ 61049d6fea481044fcc000e7782e5bc7046fc70844The Android Open Source Project /* It also checks that fields which must be a multiple of 2, 4, or 8, */ 62049d6fea481044fcc000e7782e5bc7046fc70844The Android Open Source Project /* don't have incorrect values, etc. */ 63049d6fea481044fcc000e7782e5bc7046fc70844The Android Open Source Project /* */ 64049d6fea481044fcc000e7782e5bc7046fc70844The Android Open Source Project /* FT_VALIDATE_PARANOID :: */ 65049d6fea481044fcc000e7782e5bc7046fc70844The Android Open Source Project /* Only for font debugging. Checks that a table follows the */ 66049d6fea481044fcc000e7782e5bc7046fc70844The Android Open Source Project /* specification by 100%. Very few fonts will be able to pass this */ 67049d6fea481044fcc000e7782e5bc7046fc70844The Android Open Source Project /* level anyway but it can be useful for certain tools like font */ 68049d6fea481044fcc000e7782e5bc7046fc70844The Android Open Source Project /* editors/converters. */ 69049d6fea481044fcc000e7782e5bc7046fc70844The Android Open Source Project /* */ 70049d6fea481044fcc000e7782e5bc7046fc70844The Android Open Source Project typedef enum FT_ValidationLevel_ 71049d6fea481044fcc000e7782e5bc7046fc70844The Android Open Source Project { 72049d6fea481044fcc000e7782e5bc7046fc70844The Android Open Source Project FT_VALIDATE_DEFAULT = 0, 73049d6fea481044fcc000e7782e5bc7046fc70844The Android Open Source Project FT_VALIDATE_TIGHT, 74049d6fea481044fcc000e7782e5bc7046fc70844The Android Open Source Project FT_VALIDATE_PARANOID 75049d6fea481044fcc000e7782e5bc7046fc70844The Android Open Source Project 76049d6fea481044fcc000e7782e5bc7046fc70844The Android Open Source Project } FT_ValidationLevel; 77049d6fea481044fcc000e7782e5bc7046fc70844The Android Open Source Project 78049d6fea481044fcc000e7782e5bc7046fc70844The Android Open Source Project 79727dee178a392d20eb050d0c446f2fcc29058fa1Victoria Lease#if defined( _MSC_VER ) /* Visual C++ (and Intel C++) */ 80727dee178a392d20eb050d0c446f2fcc29058fa1Victoria Lease /* We disable the warning `structure was padded due to */ 81727dee178a392d20eb050d0c446f2fcc29058fa1Victoria Lease /* __declspec(align())' in order to compile cleanly with */ 82727dee178a392d20eb050d0c446f2fcc29058fa1Victoria Lease /* the maximum level of warnings. */ 83727dee178a392d20eb050d0c446f2fcc29058fa1Victoria Lease#pragma warning( push ) 84727dee178a392d20eb050d0c446f2fcc29058fa1Victoria Lease#pragma warning( disable : 4324 ) 85727dee178a392d20eb050d0c446f2fcc29058fa1Victoria Lease#endif /* _MSC_VER */ 86727dee178a392d20eb050d0c446f2fcc29058fa1Victoria Lease 87049d6fea481044fcc000e7782e5bc7046fc70844The Android Open Source Project /* validator structure */ 88049d6fea481044fcc000e7782e5bc7046fc70844The Android Open Source Project typedef struct FT_ValidatorRec_ 89049d6fea481044fcc000e7782e5bc7046fc70844The Android Open Source Project { 90049d6fea481044fcc000e7782e5bc7046fc70844The Android Open Source Project const FT_Byte* base; /* address of table in memory */ 91049d6fea481044fcc000e7782e5bc7046fc70844The Android Open Source Project const FT_Byte* limit; /* `base' + sizeof(table) in memory */ 92049d6fea481044fcc000e7782e5bc7046fc70844The Android Open Source Project FT_ValidationLevel level; /* validation level */ 93049d6fea481044fcc000e7782e5bc7046fc70844The Android Open Source Project FT_Error error; /* error returned. 0 means success */ 94049d6fea481044fcc000e7782e5bc7046fc70844The Android Open Source Project 95049d6fea481044fcc000e7782e5bc7046fc70844The Android Open Source Project ft_jmp_buf jump_buffer; /* used for exception handling */ 96049d6fea481044fcc000e7782e5bc7046fc70844The Android Open Source Project 97049d6fea481044fcc000e7782e5bc7046fc70844The Android Open Source Project } FT_ValidatorRec; 98049d6fea481044fcc000e7782e5bc7046fc70844The Android Open Source Project 99727dee178a392d20eb050d0c446f2fcc29058fa1Victoria Lease#if defined( _MSC_VER ) 100727dee178a392d20eb050d0c446f2fcc29058fa1Victoria Lease#pragma warning( pop ) 101727dee178a392d20eb050d0c446f2fcc29058fa1Victoria Lease#endif 102049d6fea481044fcc000e7782e5bc7046fc70844The Android Open Source Project 103727dee178a392d20eb050d0c446f2fcc29058fa1Victoria Lease#define FT_VALIDATOR( x ) ( (FT_Validator)( x ) ) 104049d6fea481044fcc000e7782e5bc7046fc70844The Android Open Source Project 105049d6fea481044fcc000e7782e5bc7046fc70844The Android Open Source Project 106049d6fea481044fcc000e7782e5bc7046fc70844The Android Open Source Project FT_BASE( void ) 107049d6fea481044fcc000e7782e5bc7046fc70844The Android Open Source Project ft_validator_init( FT_Validator valid, 108049d6fea481044fcc000e7782e5bc7046fc70844The Android Open Source Project const FT_Byte* base, 109049d6fea481044fcc000e7782e5bc7046fc70844The Android Open Source Project const FT_Byte* limit, 110049d6fea481044fcc000e7782e5bc7046fc70844The Android Open Source Project FT_ValidationLevel level ); 111049d6fea481044fcc000e7782e5bc7046fc70844The Android Open Source Project 112049d6fea481044fcc000e7782e5bc7046fc70844The Android Open Source Project /* Do not use this. It's broken and will cause your validator to crash */ 113049d6fea481044fcc000e7782e5bc7046fc70844The Android Open Source Project /* if you run it on an invalid font. */ 114049d6fea481044fcc000e7782e5bc7046fc70844The Android Open Source Project FT_BASE( FT_Int ) 115049d6fea481044fcc000e7782e5bc7046fc70844The Android Open Source Project ft_validator_run( FT_Validator valid ); 116049d6fea481044fcc000e7782e5bc7046fc70844The Android Open Source Project 117049d6fea481044fcc000e7782e5bc7046fc70844The Android Open Source Project /* Sets the error field in a validator, then calls `longjmp' to return */ 118049d6fea481044fcc000e7782e5bc7046fc70844The Android Open Source Project /* to high-level caller. Using `setjmp/longjmp' avoids many stupid */ 119049d6fea481044fcc000e7782e5bc7046fc70844The Android Open Source Project /* error checks within the validation routines. */ 120049d6fea481044fcc000e7782e5bc7046fc70844The Android Open Source Project /* */ 121049d6fea481044fcc000e7782e5bc7046fc70844The Android Open Source Project FT_BASE( void ) 122049d6fea481044fcc000e7782e5bc7046fc70844The Android Open Source Project ft_validator_error( FT_Validator valid, 123049d6fea481044fcc000e7782e5bc7046fc70844The Android Open Source Project FT_Error error ); 124049d6fea481044fcc000e7782e5bc7046fc70844The Android Open Source Project 125049d6fea481044fcc000e7782e5bc7046fc70844The Android Open Source Project 126049d6fea481044fcc000e7782e5bc7046fc70844The Android Open Source Project /* Calls ft_validate_error. Assumes that the `valid' local variable */ 127049d6fea481044fcc000e7782e5bc7046fc70844The Android Open Source Project /* holds a pointer to the current validator object. */ 128049d6fea481044fcc000e7782e5bc7046fc70844The Android Open Source Project /* */ 129049d6fea481044fcc000e7782e5bc7046fc70844The Android Open Source Project /* Use preprocessor prescan to pass FT_ERR_PREFIX. */ 130049d6fea481044fcc000e7782e5bc7046fc70844The Android Open Source Project /* */ 131049d6fea481044fcc000e7782e5bc7046fc70844The Android Open Source Project#define FT_INVALID( _prefix, _error ) FT_INVALID_( _prefix, _error ) 132049d6fea481044fcc000e7782e5bc7046fc70844The Android Open Source Project#define FT_INVALID_( _prefix, _error ) \ 133049d6fea481044fcc000e7782e5bc7046fc70844The Android Open Source Project ft_validator_error( valid, _prefix ## _error ) 134049d6fea481044fcc000e7782e5bc7046fc70844The Android Open Source Project 135049d6fea481044fcc000e7782e5bc7046fc70844The Android Open Source Project /* called when a broken table is detected */ 136049d6fea481044fcc000e7782e5bc7046fc70844The Android Open Source Project#define FT_INVALID_TOO_SHORT \ 137049d6fea481044fcc000e7782e5bc7046fc70844The Android Open Source Project FT_INVALID( FT_ERR_PREFIX, Invalid_Table ) 138049d6fea481044fcc000e7782e5bc7046fc70844The Android Open Source Project 139049d6fea481044fcc000e7782e5bc7046fc70844The Android Open Source Project /* called when an invalid offset is detected */ 140049d6fea481044fcc000e7782e5bc7046fc70844The Android Open Source Project#define FT_INVALID_OFFSET \ 141049d6fea481044fcc000e7782e5bc7046fc70844The Android Open Source Project FT_INVALID( FT_ERR_PREFIX, Invalid_Offset ) 142049d6fea481044fcc000e7782e5bc7046fc70844The Android Open Source Project 143049d6fea481044fcc000e7782e5bc7046fc70844The Android Open Source Project /* called when an invalid format/value is detected */ 144049d6fea481044fcc000e7782e5bc7046fc70844The Android Open Source Project#define FT_INVALID_FORMAT \ 145049d6fea481044fcc000e7782e5bc7046fc70844The Android Open Source Project FT_INVALID( FT_ERR_PREFIX, Invalid_Table ) 146049d6fea481044fcc000e7782e5bc7046fc70844The Android Open Source Project 147049d6fea481044fcc000e7782e5bc7046fc70844The Android Open Source Project /* called when an invalid glyph index is detected */ 148049d6fea481044fcc000e7782e5bc7046fc70844The Android Open Source Project#define FT_INVALID_GLYPH_ID \ 149049d6fea481044fcc000e7782e5bc7046fc70844The Android Open Source Project FT_INVALID( FT_ERR_PREFIX, Invalid_Glyph_Index ) 150049d6fea481044fcc000e7782e5bc7046fc70844The Android Open Source Project 151049d6fea481044fcc000e7782e5bc7046fc70844The Android Open Source Project /* called when an invalid field value is detected */ 152049d6fea481044fcc000e7782e5bc7046fc70844The Android Open Source Project#define FT_INVALID_DATA \ 153049d6fea481044fcc000e7782e5bc7046fc70844The Android Open Source Project FT_INVALID( FT_ERR_PREFIX, Invalid_Table ) 154049d6fea481044fcc000e7782e5bc7046fc70844The Android Open Source Project 155049d6fea481044fcc000e7782e5bc7046fc70844The Android Open Source Project 156049d6fea481044fcc000e7782e5bc7046fc70844The Android Open Source ProjectFT_END_HEADER 157049d6fea481044fcc000e7782e5bc7046fc70844The Android Open Source Project 158049d6fea481044fcc000e7782e5bc7046fc70844The Android Open Source Project#endif /* __FTVALID_H__ */ 159049d6fea481044fcc000e7782e5bc7046fc70844The Android Open Source Project 160049d6fea481044fcc000e7782e5bc7046fc70844The Android Open Source Project 161049d6fea481044fcc000e7782e5bc7046fc70844The Android Open Source Project/* END */ 162