kc3-lang/freetype/include/ftgzip.h

• Show log

  Commit

• Hash : f57fc59e
  Author :
  Date : 2015-01-17T20:41:43
  

  Run `src/tools/update-copyright'.

Download

• include/ftgzip.h

• /***************************************************************************/
  /*                                                                         */
  /*  ftgzip.h                                                               */
  /*                                                                         */
  /*    Gzip-compressed stream support.                                      */
  /*                                                                         */
  /*  Copyright 2002-2015 by                                                 */
  /*  David Turner, Robert Wilhelm, and Werner Lemberg.                      */
  /*                                                                         */
  /*  This file is part of the FreeType project, and may only be used,       */
  /*  modified, and distributed under the terms of the FreeType project      */
  /*  license, LICENSE.TXT.  By continuing to use, modify, or distribute     */
  /*  this file you indicate that you have read the license and              */
  /*  understand and accept it fully.                                        */
  /*                                                                         */
  /***************************************************************************/
  
  
  #ifndef __FTGZIP_H__
  #define __FTGZIP_H__
  
  #include <ft2build.h>
  #include FT_FREETYPE_H
  
  #ifdef FREETYPE_H
  #error "freetype.h of FreeType 1 has been loaded!"
  #error "Please fix the directory search order for header files"
  #error "so that freetype.h of FreeType 2 is found first."
  #endif
  
  
  FT_BEGIN_HEADER
  
    /*************************************************************************/
    /*                                                                       */
    /* <Section>                                                             */
    /*    gzip                                                               */
    /*                                                                       */
    /* <Title>                                                               */
    /*    GZIP Streams                                                       */
    /*                                                                       */
    /* <Abstract>                                                            */
    /*    Using gzip-compressed font files.                                  */
    /*                                                                       */
    /* <Description>                                                         */
    /*    This section contains the declaration of Gzip-specific functions.  */
    /*                                                                       */
    /*************************************************************************/
  
  
   /************************************************************************
    *
    * @function:
    *   FT_Stream_OpenGzip
    *
    * @description:
    *   Open a new stream to parse gzip-compressed font files.  This is
    *   mainly used to support the compressed `*.pcf.gz' fonts that come
    *   with XFree86.
    *
    * @input:
    *   stream ::
    *     The target embedding stream.
    *
    *   source ::
    *     The source stream.
    *
    * @return:
    *   FreeType error code.  0~means success.
    *
    * @note:
    *   The source stream must be opened _before_ calling this function.
    *
    *   Calling the internal function `FT_Stream_Close' on the new stream will
    *   *not* call `FT_Stream_Close' on the source stream.  None of the stream
    *   objects will be released to the heap.
    *
    *   The stream implementation is very basic and resets the decompression
    *   process each time seeking backwards is needed within the stream.
    *
    *   In certain builds of the library, gzip compression recognition is
    *   automatically handled when calling @FT_New_Face or @FT_Open_Face.
    *   This means that if no font driver is capable of handling the raw
    *   compressed file, the library will try to open a gzipped stream from
    *   it and re-open the face with it.
    *
    *   This function may return `FT_Err_Unimplemented_Feature' if your build
    *   of FreeType was not compiled with zlib support.
    */
    FT_EXPORT( FT_Error )
    FT_Stream_OpenGzip( FT_Stream  stream,
                        FT_Stream  source );
  
  
   /************************************************************************
    *
    * @function:
    *   FT_Gzip_Uncompress
    *
    * @description:
    *   Decompress a zipped input buffer into an output buffer.  This function
    *   is modeled after zlib's `uncompress' function.
    *
    * @input:
    *   memory ::
    *     A FreeType memory handle.
    *
    *   input ::
    *     The input buffer.
    *
    *   input_len ::
    *     The length of the input buffer.
    *
    * @output:
    *   output::
    *     The output buffer.
    *
    * @inout:
    *   output_len ::
    *     Before calling the function, this is the the total size of the
    *     output buffer, which must be large enough to hold the entire
    *     uncompressed data (so the size of the uncompressed data must be
    *     known in advance).  After calling the function, `output_len' is the
    *     size of the used data in `output'.
    *
    * @return:
    *   FreeType error code.  0~means success.
    *
    * @note:
    *   This function may return `FT_Err_Unimplemented_Feature' if your build
    *   of FreeType was not compiled with zlib support.
    */
    FT_EXPORT( FT_Error )
    FT_Gzip_Uncompress( FT_Memory       memory,
                        FT_Byte*        output,
                        FT_ULong*       output_len,
                        const FT_Byte*  input,
                        FT_ULong        input_len );
  
    /* */
  
  
  FT_END_HEADER
  
  #endif /* __FTGZIP_H__ */
  
  
  /* END */
  

Download