freetype2/freetype/fterrdef.h

0001 /****************************************************************************
0002  *
0003  * fterrdef.h
0004  *
0005  *   FreeType error codes (specification).
0006  *
0007  * Copyright (C) 2002-2023 by
0008  * David Turner, Robert Wilhelm, and Werner Lemberg.
0009  *
0010  * This file is part of the FreeType project, and may only be used,
0011  * modified, and distributed under the terms of the FreeType project
0012  * license, LICENSE.TXT.  By continuing to use, modify, or distribute
0013  * this file you indicate that you have read the license and
0014  * understand and accept it fully.
0015  *
0016  */
0017
0018
0019   /**************************************************************************
0020    *
0021    * @section:
0022    *  error_code_values
0023    *
0024    * @title:
0025    *  Error Code Values
0026    *
0027    * @abstract:
0028    *  All possible error codes returned by FreeType functions.
0029    *
0030    * @description:
0031    *  The list below is taken verbatim from the file `fterrdef.h` (loaded
0032    *  automatically by including `FT_FREETYPE_H`).  The first argument of the
0033    *  `FT_ERROR_DEF_` macro is the error label; by default, the prefix
0034    *  `FT_Err_` gets added so that you get error names like
0035    *  `FT_Err_Cannot_Open_Resource`.  The second argument is the error code,
0036    *  and the last argument an error string, which is not used by FreeType.
0037    *
0038    *  Within your application you should **only** use error names and
0039    *  **never** its numeric values!  The latter might (and actually do)
0040    *  change in forthcoming FreeType versions.
0041    *
0042    *  Macro `FT_NOERRORDEF_` defines `FT_Err_Ok`, which is always zero.  See
0043    *  the 'Error Enumerations' subsection how to automatically generate a
0044    *  list of error strings.
0045    *
0046    */
0047
0048
0049   /**************************************************************************
0050    *
0051    * @enum:
0052    *   FT_Err_XXX
0053    *
0054    */
0055
0056   /* generic errors */
0057
0058   FT_NOERRORDEF_( Ok,                                        0x00,
0059                   "no error" )
0060
0061   FT_ERRORDEF_( Cannot_Open_Resource,                        0x01,
0062                 "cannot open resource" )
0063   FT_ERRORDEF_( Unknown_File_Format,                         0x02,
0064                 "unknown file format" )
0065   FT_ERRORDEF_( Invalid_File_Format,                         0x03,
0066                 "broken file" )
0067   FT_ERRORDEF_( Invalid_Version,                             0x04,
0068                 "invalid FreeType version" )
0069   FT_ERRORDEF_( Lower_Module_Version,                        0x05,
0070                 "module version is too low" )
0071   FT_ERRORDEF_( Invalid_Argument,                            0x06,
0072                 "invalid argument" )
0073   FT_ERRORDEF_( Unimplemented_Feature,                       0x07,
0074                 "unimplemented feature" )
0075   FT_ERRORDEF_( Invalid_Table,                               0x08,
0076                 "broken table" )
0077   FT_ERRORDEF_( Invalid_Offset,                              0x09,
0078                 "broken offset within table" )
0079   FT_ERRORDEF_( Array_Too_Large,                             0x0A,
0080                 "array allocation size too large" )
0081   FT_ERRORDEF_( Missing_Module,                              0x0B,
0082                 "missing module" )
0083   FT_ERRORDEF_( Missing_Property,                            0x0C,
0084                 "missing property" )
0085
0086   /* glyph/character errors */
0087
0088   FT_ERRORDEF_( Invalid_Glyph_Index,                         0x10,
0089                 "invalid glyph index" )
0090   FT_ERRORDEF_( Invalid_Character_Code,                      0x11,
0091                 "invalid character code" )
0092   FT_ERRORDEF_( Invalid_Glyph_Format,                        0x12,
0093                 "unsupported glyph image format" )
0094   FT_ERRORDEF_( Cannot_Render_Glyph,                         0x13,
0095                 "cannot render this glyph format" )
0096   FT_ERRORDEF_( Invalid_Outline,                             0x14,
0097                 "invalid outline" )
0098   FT_ERRORDEF_( Invalid_Composite,                           0x15,
0099                 "invalid composite glyph" )
0100   FT_ERRORDEF_( Too_Many_Hints,                              0x16,
0101                 "too many hints" )
0102   FT_ERRORDEF_( Invalid_Pixel_Size,                          0x17,
0103                 "invalid pixel size" )
0104   FT_ERRORDEF_( Invalid_SVG_Document,                        0x18,
0105                 "invalid SVG document" )
0106
0107   /* handle errors */
0108
0109   FT_ERRORDEF_( Invalid_Handle,                              0x20,
0110                 "invalid object handle" )
0111   FT_ERRORDEF_( Invalid_Library_Handle,                      0x21,
0112                 "invalid library handle" )
0113   FT_ERRORDEF_( Invalid_Driver_Handle,                       0x22,
0114                 "invalid module handle" )
0115   FT_ERRORDEF_( Invalid_Face_Handle,                         0x23,
0116                 "invalid face handle" )
0117   FT_ERRORDEF_( Invalid_Size_Handle,                         0x24,
0118                 "invalid size handle" )
0119   FT_ERRORDEF_( Invalid_Slot_Handle,                         0x25,
0120                 "invalid glyph slot handle" )
0121   FT_ERRORDEF_( Invalid_CharMap_Handle,                      0x26,
0122                 "invalid charmap handle" )
0123   FT_ERRORDEF_( Invalid_Cache_Handle,                        0x27,
0124                 "invalid cache manager handle" )
0125   FT_ERRORDEF_( Invalid_Stream_Handle,                       0x28,
0126                 "invalid stream handle" )
0127
0128   /* driver errors */
0129
0130   FT_ERRORDEF_( Too_Many_Drivers,                            0x30,
0131                 "too many modules" )
0132   FT_ERRORDEF_( Too_Many_Extensions,                         0x31,
0133                 "too many extensions" )
0134
0135   /* memory errors */
0136
0137   FT_ERRORDEF_( Out_Of_Memory,                               0x40,
0138                 "out of memory" )
0139   FT_ERRORDEF_( Unlisted_Object,                             0x41,
0140                 "unlisted object" )
0141
0142   /* stream errors */
0143
0144   FT_ERRORDEF_( Cannot_Open_Stream,                          0x51,
0145                 "cannot open stream" )
0146   FT_ERRORDEF_( Invalid_Stream_Seek,                         0x52,
0147                 "invalid stream seek" )
0148   FT_ERRORDEF_( Invalid_Stream_Skip,                         0x53,
0149                 "invalid stream skip" )
0150   FT_ERRORDEF_( Invalid_Stream_Read,                         0x54,
0151                 "invalid stream read" )
0152   FT_ERRORDEF_( Invalid_Stream_Operation,                    0x55,
0153                 "invalid stream operation" )
0154   FT_ERRORDEF_( Invalid_Frame_Operation,                     0x56,
0155                 "invalid frame operation" )
0156   FT_ERRORDEF_( Nested_Frame_Access,                         0x57,
0157                 "nested frame access" )
0158   FT_ERRORDEF_( Invalid_Frame_Read,                          0x58,
0159                 "invalid frame read" )
0160
0161   /* raster errors */
0162
0163   FT_ERRORDEF_( Raster_Uninitialized,                        0x60,
0164                 "raster uninitialized" )
0165   FT_ERRORDEF_( Raster_Corrupted,                            0x61,
0166                 "raster corrupted" )
0167   FT_ERRORDEF_( Raster_Overflow,                             0x62,
0168                 "raster overflow" )
0169   FT_ERRORDEF_( Raster_Negative_Height,                      0x63,
0170                 "negative height while rastering" )
0171
0172   /* cache errors */
0173
0174   FT_ERRORDEF_( Too_Many_Caches,                             0x70,
0175                 "too many registered caches" )
0176
0177   /* TrueType and SFNT errors */
0178
0179   FT_ERRORDEF_( Invalid_Opcode,                              0x80,
0180                 "invalid opcode" )
0181   FT_ERRORDEF_( Too_Few_Arguments,                           0x81,
0182                 "too few arguments" )
0183   FT_ERRORDEF_( Stack_Overflow,                              0x82,
0184                 "stack overflow" )
0185   FT_ERRORDEF_( Code_Overflow,                               0x83,
0186                 "code overflow" )
0187   FT_ERRORDEF_( Bad_Argument,                                0x84,
0188                 "bad argument" )
0189   FT_ERRORDEF_( Divide_By_Zero,                              0x85,
0190                 "division by zero" )
0191   FT_ERRORDEF_( Invalid_Reference,                           0x86,
0192                 "invalid reference" )
0193   FT_ERRORDEF_( Debug_OpCode,                                0x87,
0194                 "found debug opcode" )
0195   FT_ERRORDEF_( ENDF_In_Exec_Stream,                         0x88,
0196                 "found ENDF opcode in execution stream" )
0197   FT_ERRORDEF_( Nested_DEFS,                                 0x89,
0198                 "nested DEFS" )
0199   FT_ERRORDEF_( Invalid_CodeRange,                           0x8A,
0200                 "invalid code range" )
0201   FT_ERRORDEF_( Execution_Too_Long,                          0x8B,
0202                 "execution context too long" )
0203   FT_ERRORDEF_( Too_Many_Function_Defs,                      0x8C,
0204                 "too many function definitions" )
0205   FT_ERRORDEF_( Too_Many_Instruction_Defs,                   0x8D,
0206                 "too many instruction definitions" )
0207   FT_ERRORDEF_( Table_Missing,                               0x8E,
0208                 "SFNT font table missing" )
0209   FT_ERRORDEF_( Horiz_Header_Missing,                        0x8F,
0210                 "horizontal header (hhea) table missing" )
0211   FT_ERRORDEF_( Locations_Missing,                           0x90,
0212                 "locations (loca) table missing" )
0213   FT_ERRORDEF_( Name_Table_Missing,                          0x91,
0214                 "name table missing" )
0215   FT_ERRORDEF_( CMap_Table_Missing,                          0x92,
0216                 "character map (cmap) table missing" )
0217   FT_ERRORDEF_( Hmtx_Table_Missing,                          0x93,
0218                 "horizontal metrics (hmtx) table missing" )
0219   FT_ERRORDEF_( Post_Table_Missing,                          0x94,
0220                 "PostScript (post) table missing" )
0221   FT_ERRORDEF_( Invalid_Horiz_Metrics,                       0x95,
0222                 "invalid horizontal metrics" )
0223   FT_ERRORDEF_( Invalid_CharMap_Format,                      0x96,
0224                 "invalid character map (cmap) format" )
0225   FT_ERRORDEF_( Invalid_PPem,                                0x97,
0226                 "invalid ppem value" )
0227   FT_ERRORDEF_( Invalid_Vert_Metrics,                        0x98,
0228                 "invalid vertical metrics" )
0229   FT_ERRORDEF_( Could_Not_Find_Context,                      0x99,
0230                 "could not find context" )
0231   FT_ERRORDEF_( Invalid_Post_Table_Format,                   0x9A,
0232                 "invalid PostScript (post) table format" )
0233   FT_ERRORDEF_( Invalid_Post_Table,                          0x9B,
0234                 "invalid PostScript (post) table" )
0235   FT_ERRORDEF_( DEF_In_Glyf_Bytecode,                        0x9C,
0236                 "found FDEF or IDEF opcode in glyf bytecode" )
0237   FT_ERRORDEF_( Missing_Bitmap,                              0x9D,
0238                 "missing bitmap in strike" )
0239   FT_ERRORDEF_( Missing_SVG_Hooks,                           0x9E,
0240                 "SVG hooks have not been set" )
0241
0242   /* CFF, CID, and Type 1 errors */
0243
0244   FT_ERRORDEF_( Syntax_Error,                                0xA0,
0245                 "opcode syntax error" )
0246   FT_ERRORDEF_( Stack_Underflow,                             0xA1,
0247                 "argument stack underflow" )
0248   FT_ERRORDEF_( Ignore,                                      0xA2,
0249                 "ignore" )
0250   FT_ERRORDEF_( No_Unicode_Glyph_Name,                       0xA3,
0251                 "no Unicode glyph name found" )
0252   FT_ERRORDEF_( Glyph_Too_Big,                               0xA4,
0253                 "glyph too big for hinting" )
0254
0255   /* BDF errors */
0256
0257   FT_ERRORDEF_( Missing_Startfont_Field,                     0xB0,
0258                 "`STARTFONT' field missing" )
0259   FT_ERRORDEF_( Missing_Font_Field,                          0xB1,
0260                 "`FONT' field missing" )
0261   FT_ERRORDEF_( Missing_Size_Field,                          0xB2,
0262                 "`SIZE' field missing" )
0263   FT_ERRORDEF_( Missing_Fontboundingbox_Field,               0xB3,
0264                 "`FONTBOUNDINGBOX' field missing" )
0265   FT_ERRORDEF_( Missing_Chars_Field,                         0xB4,
0266                 "`CHARS' field missing" )
0267   FT_ERRORDEF_( Missing_Startchar_Field,                     0xB5,
0268                 "`STARTCHAR' field missing" )
0269   FT_ERRORDEF_( Missing_Encoding_Field,                      0xB6,
0270                 "`ENCODING' field missing" )
0271   FT_ERRORDEF_( Missing_Bbx_Field,                           0xB7,
0272                 "`BBX' field missing" )
0273   FT_ERRORDEF_( Bbx_Too_Big,                                 0xB8,
0274                 "`BBX' too big" )
0275   FT_ERRORDEF_( Corrupted_Font_Header,                       0xB9,
0276                 "Font header corrupted or missing fields" )
0277   FT_ERRORDEF_( Corrupted_Font_Glyphs,                       0xBA,
0278                 "Font glyphs corrupted or missing fields" )
0279
0280   /* */
0281
0282
0283 /* END */