1ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov/***************************************************************************/ 2ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov/* */ 3ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov/* ftvalid.h */ 4ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov/* */ 5ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov/* FreeType validation support (specification). */ 6ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov/* */ 7ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov/* Copyright 2004, 2013 by */ 8ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov/* David Turner, Robert Wilhelm, and Werner Lemberg. */ 9ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov/* */ 10ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov/* This file is part of the FreeType project, and may only be used, */ 11ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov/* modified, and distributed under the terms of the FreeType project */ 12ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov/* license, LICENSE.TXT. By continuing to use, modify, or distribute */ 13ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov/* this file you indicate that you have read the license and */ 14ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov/* understand and accept it fully. */ 15ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov/* */ 16ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov/***************************************************************************/ 17ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov 18ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov 19ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov#ifndef __FTVALID_H__ 20ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov#define __FTVALID_H__ 21ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov 22ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov#include "../../ft2build.h" 23ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov#include "../config/ftstdlib.h" /* for ft_setjmp and ft_longjmp */ 24ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov 25ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov 26ee451cb395940862dad63c85adfe8f2fd55e864cSvet GanovFT_BEGIN_HEADER 27ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov 28ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov 29ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov /*************************************************************************/ 30ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov /*************************************************************************/ 31ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov /*************************************************************************/ 32ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov /**** ****/ 33ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov /**** ****/ 34ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov /**** V A L I D A T I O N ****/ 35ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov /**** ****/ 36ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov /**** ****/ 37ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov /*************************************************************************/ 38ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov /*************************************************************************/ 39ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov /*************************************************************************/ 40ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov 41ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov /* handle to a validation object */ 42ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov typedef struct FT_ValidatorRec_ volatile* FT_Validator; 43ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov 44ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov 45ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov /*************************************************************************/ 46ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov /* */ 47ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov /* There are three distinct validation levels defined here: */ 48ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov /* */ 49ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov /* FT_VALIDATE_DEFAULT :: */ 50ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov /* A table that passes this validation level can be used reliably by */ 51ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov /* FreeType. It generally means that all offsets have been checked to */ 52ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov /* prevent out-of-bound reads, that array counts are correct, etc. */ 53ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov /* */ 54ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov /* FT_VALIDATE_TIGHT :: */ 55ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov /* A table that passes this validation level can be used reliably and */ 56ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov /* doesn't contain invalid data. For example, a charmap table that */ 57ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov /* returns invalid glyph indices will not pass, even though it can */ 58ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov /* be used with FreeType in default mode (the library will simply */ 59ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov /* return an error later when trying to load the glyph). */ 60ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov /* */ 61ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov /* It also checks that fields which must be a multiple of 2, 4, or 8, */ 62ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov /* don't have incorrect values, etc. */ 63ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov /* */ 64ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov /* FT_VALIDATE_PARANOID :: */ 65ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov /* Only for font debugging. Checks that a table follows the */ 66ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov /* specification by 100%. Very few fonts will be able to pass this */ 67ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov /* level anyway but it can be useful for certain tools like font */ 68ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov /* editors/converters. */ 69ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov /* */ 70ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov typedef enum FT_ValidationLevel_ 71ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov { 72ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov FT_VALIDATE_DEFAULT = 0, 73ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov FT_VALIDATE_TIGHT, 74ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov FT_VALIDATE_PARANOID 75ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov 76ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov } FT_ValidationLevel; 77ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov 78ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov 79ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov#if defined( _MSC_VER ) /* Visual C++ (and Intel C++) */ 80ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov /* We disable the warning `structure was padded due to */ 81ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov /* __declspec(align())' in order to compile cleanly with */ 82ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov /* the maximum level of warnings. */ 83ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov#pragma warning( push ) 84ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov#pragma warning( disable : 4324 ) 85ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov#endif /* _MSC_VER */ 86ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov 87ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov /* validator structure */ 88ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov typedef struct FT_ValidatorRec_ 89ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov { 90ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov const FT_Byte* base; /* address of table in memory */ 91ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov const FT_Byte* limit; /* `base' + sizeof(table) in memory */ 92ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov FT_ValidationLevel level; /* validation level */ 93ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov FT_Error error; /* error returned. 0 means success */ 94ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov 95ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov ft_jmp_buf jump_buffer; /* used for exception handling */ 96ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov 97ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov } FT_ValidatorRec; 98ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov 99ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov#if defined( _MSC_VER ) 100ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov#pragma warning( pop ) 101ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov#endif 102ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov 103ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov#define FT_VALIDATOR( x ) ( (FT_Validator)( x ) ) 104ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov 105ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov 106ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov FT_BASE( void ) 107ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov ft_validator_init( FT_Validator valid, 108ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov const FT_Byte* base, 109ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov const FT_Byte* limit, 110ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov FT_ValidationLevel level ); 111ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov 112ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov /* Do not use this. It's broken and will cause your validator to crash */ 113ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov /* if you run it on an invalid font. */ 114ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov FT_BASE( FT_Int ) 115ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov ft_validator_run( FT_Validator valid ); 116ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov 117ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov /* Sets the error field in a validator, then calls `longjmp' to return */ 118ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov /* to high-level caller. Using `setjmp/longjmp' avoids many stupid */ 119ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov /* error checks within the validation routines. */ 120ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov /* */ 121ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov FT_BASE( void ) 122ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov ft_validator_error( FT_Validator valid, 123ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov FT_Error error ); 124ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov 125ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov 126ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov /* Calls ft_validate_error. Assumes that the `valid' local variable */ 127ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov /* holds a pointer to the current validator object. */ 128ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov /* */ 129ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov /* Use preprocessor prescan to pass FT_ERR_PREFIX. */ 130ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov /* */ 131ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov#define FT_INVALID( _prefix, _error ) FT_INVALID_( _prefix, _error ) 132ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov#define FT_INVALID_( _prefix, _error ) \ 133ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov ft_validator_error( valid, _prefix ## _error ) 134ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov 135ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov /* called when a broken table is detected */ 136ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov#define FT_INVALID_TOO_SHORT \ 137ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov FT_INVALID( FT_ERR_PREFIX, Invalid_Table ) 138ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov 139ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov /* called when an invalid offset is detected */ 140ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov#define FT_INVALID_OFFSET \ 141ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov FT_INVALID( FT_ERR_PREFIX, Invalid_Offset ) 142ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov 143ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov /* called when an invalid format/value is detected */ 144ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov#define FT_INVALID_FORMAT \ 145ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov FT_INVALID( FT_ERR_PREFIX, Invalid_Table ) 146ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov 147ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov /* called when an invalid glyph index is detected */ 148ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov#define FT_INVALID_GLYPH_ID \ 149ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov FT_INVALID( FT_ERR_PREFIX, Invalid_Glyph_Index ) 150ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov 151ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov /* called when an invalid field value is detected */ 152ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov#define FT_INVALID_DATA \ 153ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov FT_INVALID( FT_ERR_PREFIX, Invalid_Table ) 154ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov 155ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov 156ee451cb395940862dad63c85adfe8f2fd55e864cSvet GanovFT_END_HEADER 157ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov 158ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov#endif /* __FTVALID_H__ */ 159ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov 160ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov 161ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov/* END */ 162