1 /**************************************************************************** 2 * 3 * ftlzw.h 4 * 5 * LZW-compressed stream support. 6 * 7 * Copyright (C) 2004-2019 by 8 * David Turner, Robert Wilhelm, and Werner Lemberg. 9 * 10 * This file is part of the FreeType project, and may only be used, 11 * modified, and distributed under the terms of the FreeType project 12 * license, LICENSE.TXT. By continuing to use, modify, or distribute 13 * this file you indicate that you have read the license and 14 * understand and accept it fully. 15 * 16 */ 17 18 19 #ifndef FTLZW_H_ 20 #define FTLZW_H_ 21 22 #include <ft2build.h> 23 #include FT_FREETYPE_H 24 25 #ifdef FREETYPE_H 26 #error "freetype.h of FreeType 1 has been loaded!" 27 #error "Please fix the directory search order for header files" 28 #error "so that freetype.h of FreeType 2 is found first." 29 #endif 30 31 32 FT_BEGIN_HEADER 33 34 /************************************************************************** 35 * 36 * @section: 37 * lzw 38 * 39 * @title: 40 * LZW Streams 41 * 42 * @abstract: 43 * Using LZW-compressed font files. 44 * 45 * @description: 46 * This section contains the declaration of LZW-specific functions. 47 * 48 */ 49 50 /************************************************************************** 51 * 52 * @function: 53 * FT_Stream_OpenLZW 54 * 55 * @description: 56 * Open a new stream to parse LZW-compressed font files. This is mainly 57 * used to support the compressed `*.pcf.Z` fonts that come with XFree86. 58 * 59 * @input: 60 * stream :: 61 * The target embedding stream. 62 * 63 * source :: 64 * The source stream. 65 * 66 * @return: 67 * FreeType error code. 0~means success. 68 * 69 * @note: 70 * The source stream must be opened _before_ calling this function. 71 * 72 * Calling the internal function `FT_Stream_Close` on the new stream will 73 * **not** call `FT_Stream_Close` on the source stream. None of the 74 * stream objects will be released to the heap. 75 * 76 * The stream implementation is very basic and resets the decompression 77 * process each time seeking backwards is needed within the stream 78 * 79 * In certain builds of the library, LZW compression recognition is 80 * automatically handled when calling @FT_New_Face or @FT_Open_Face. 81 * This means that if no font driver is capable of handling the raw 82 * compressed file, the library will try to open a LZW stream from it and 83 * re-open the face with it. 84 * 85 * This function may return `FT_Err_Unimplemented_Feature` if your build 86 * of FreeType was not compiled with LZW support. 87 */ 88 FT_EXPORT( FT_Error ) 89 FT_Stream_OpenLZW( FT_Stream stream, 90 FT_Stream source ); 91 92 /* */ 93 94 95 FT_END_HEADER 96 97 #endif /* FTLZW_H_ */ 98 99 100 /* END */ 101