Delete all Trailing spaces in code.
[reactos.git] / reactos / dll / 3rdparty / freetype / include / freetype / ftsystem.h
index 59cd019..7cf0d34 100644 (file)
-/***************************************************************************/
-/*                                                                         */
-/*  ftsystem.h                                                             */
-/*                                                                         */
-/*    FreeType low-level system interface definition (specification).      */
-/*                                                                         */
-/*  Copyright 1996-2001, 2002, 2005 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 __FTSYSTEM_H__
-#define __FTSYSTEM_H__
-
-
-#include <ft2build.h>
-
-
-FT_BEGIN_HEADER
-
-
-  /*************************************************************************/
-  /*                                                                       */
-  /* <Section>                                                             */
-  /*   system_interface                                                    */
-  /*                                                                       */
-  /* <Title>                                                               */
-  /*   System Interface                                                    */
-  /*                                                                       */
-  /* <Abstract>                                                            */
-  /*   How FreeType manages memory and i/o.                                */
-  /*                                                                       */
-  /* <Description>                                                         */
-  /*   This section contains various definitions related to memory         */
-  /*   management and i/o access.  You need to understand this             */
-  /*   information if you want to use a custom memory manager or you own   */
-  /*   i/o streams.                                                        */
-  /*                                                                       */
-  /*************************************************************************/
-
-
-  /*************************************************************************/
-  /*                                                                       */
-  /*                  M E M O R Y   M A N A G E M E N T                    */
-  /*                                                                       */
-  /*************************************************************************/
-
-
-  /*************************************************************************
-   *
-   * @type:
-   *   FT_Memory
-   *
-   * @description:
-   *   A handle to a given memory manager object, defined with an
-   *   @FT_MemoryRec structure.
-   *
-   */
-  typedef struct FT_MemoryRec_*  FT_Memory;
-
-
-  /*************************************************************************
-   *
-   * @functype:
-   *   FT_Alloc_Func
-   *
-   * @description:
-   *   A function used to allocate `size' bytes from `memory'.
-   *
-   * @input:
-   *   memory ::
-   *     A handle to the source memory manager.
-   *
-   *   size ::
-   *     The size in bytes to allocate.
-   *
-   * @return:
-   *   Address of new memory block.  0 in case of failure.
-   *
-   */
-  typedef void*
-  (*FT_Alloc_Func)( FT_Memory  memory,
-                    long       size );
-
-
-  /*************************************************************************
-   *
-   * @functype:
-   *   FT_Free_Func
-   *
-   * @description:
-   *   A function used to release a given block of memory.
-   *
-   * @input:
-   *   memory ::
-   *     A handle to the source memory manager.
-   *
-   *   block ::
-   *     The address of the target memory block.
-   *
-   */
-  typedef void
-  (*FT_Free_Func)( FT_Memory  memory,
-                   void*      block );
-
-
-  /*************************************************************************
-   *
-   * @functype:
-   *   FT_Realloc_Func
-   *
-   * @description:
-   *   A function used to re-allocate a given block of memory.
-   *
-   * @input:
-   *   memory ::
-   *     A handle to the source memory manager.
-   *
-   *   cur_size ::
-   *     The block's current size in bytes.
-   *
-   *   new_size ::
-   *     The block's requested new size.
-   *
-   *   block ::
-   *     The block's current address.
-   *
-   * @return:
-   *   New block address.  0 in case of memory shortage.
-   *
-   * @note:
-   *   In case of error, the old block must still be available.
-   *
-   */
-  typedef void*
-  (*FT_Realloc_Func)( FT_Memory  memory,
-                      long       cur_size,
-                      long       new_size,
-                      void*      block );
-
-
-  /*************************************************************************
-   *
-   * @struct:
-   *   FT_MemoryRec
-   *
-   * @description:
-   *   A structure used to describe a given memory manager to FreeType 2.
-   *
-   * @fields:
-   *   user ::
-   *     A generic typeless pointer for user data.
-   *
-   *   alloc ::
-   *     A pointer type to an allocation function.
-   *
-   *   free ::
-   *     A pointer type to an memory freeing function.
-   *
-   *   realloc ::
-   *     A pointer type to a reallocation function.
-   *
-   */
-  struct  FT_MemoryRec_
-  {
-    void*            user;
-    FT_Alloc_Func    alloc;
-    FT_Free_Func     free;
-    FT_Realloc_Func  realloc;
-  };
-
-
-  /*************************************************************************/
-  /*                                                                       */
-  /*                       I / O   M A N A G E M E N T                     */
-  /*                                                                       */
-  /*************************************************************************/
-
-
-  /*************************************************************************
-   *
-   * @type:
-   *   FT_Stream
-   *
-   * @description:
-   *   A handle to an input stream.
-   *
-   */
-  typedef struct FT_StreamRec_*  FT_Stream;
-
-
-  /*************************************************************************
-   *
-   * @struct:
-   *   FT_StreamDesc
-   *
-   * @description:
-   *   A union type used to store either a long or a pointer.  This is used
-   *   to store a file descriptor or a `FILE*' in an input stream.
-   *
-   */
-  typedef union  FT_StreamDesc_
-  {
-    long   value;
-    void*  pointer;
-
-  } FT_StreamDesc;
-
-
-  /*************************************************************************
-   *
-   * @functype:
-   *   FT_Stream_IoFunc
-   *
-   * @description:
-   *   A function used to seek and read data from a given input stream.
-   *
-   * @input:
-   *   stream ::
-   *     A handle to the source stream.
-   *
-   *   offset ::
-   *     The offset of read in stream (always from start).
-   *
-   *   buffer ::
-   *     The address of the read buffer.
-   *
-   *   count ::
-   *     The number of bytes to read from the stream.
-   *
-   * @return:
-   *   The number of bytes effectively read by the stream.
-   *
-   * @note:
-   *   This function might be called to perform a seek or skip operation
-   *   with a `count' of 0.
-   *
-   */
-  typedef unsigned long
-  (*FT_Stream_IoFunc)( FT_Stream       stream,
-                       unsigned long   offset,
-                       unsigned char*  buffer,
-                       unsigned long   count );
-
-
-  /*************************************************************************
-   *
-   * @functype:
-   *   FT_Stream_CloseFunc
-   *
-   * @description:
-   *   A function used to close a given input stream.
-   *
-   * @input:
-   *  stream ::
-   *     A handle to the target stream.
-   *
-   */
-  typedef void
-  (*FT_Stream_CloseFunc)( FT_Stream  stream );
-
-
-  /*************************************************************************
-   *
-   * @struct:
-   *   FT_StreamRec
-   *
-   * @description:
-   *   A structure used to describe an input stream.
-   *
-   * @input:
-   *   base ::
-   *     For memory-based streams, this is the address of the first stream
-   *     byte in memory.  This field should always be set to NULL for
-   *     disk-based streams.
-   *
-   *   size ::
-   *     The stream size in bytes.
-   *
-   *   pos ::
-   *     The current position within the stream.
-   *
-   *   descriptor ::
-   *     This field is a union that can hold an integer or a pointer.  It is
-   *     used by stream implementations to store file descriptors or `FILE*'
-   *     pointers.
-   *
-   *   pathname ::
-   *     This field is completely ignored by FreeType.  However, it is often
-   *     useful during debugging to use it to store the stream's filename
-   *     (where available).
-   *
-   *   read ::
-   *     The stream's input function.
-   *
-   *   close ::
-   *     The stream;s close function.
-   *
-   *   memory ::
-   *     The memory manager to use to preload frames.  This is set
-   *     internally by FreeType and shouldn't be touched by stream
-   *     implementations.
-   *
-   *   cursor ::
-   *     This field is set and used internally by FreeType when parsing
-   *     frames.
-   *
-   *   limit ::
-   *     This field is set and used internally by FreeType when parsing
-   *     frames.
-   *
-   */
-  typedef struct  FT_StreamRec_
-  {
-    unsigned char*       base;
-    unsigned long        size;
-    unsigned long        pos;
-
-    FT_StreamDesc        descriptor;
-    FT_StreamDesc        pathname;
-    FT_Stream_IoFunc     read;
-    FT_Stream_CloseFunc  close;
-
-    FT_Memory            memory;
-    unsigned char*       cursor;
-    unsigned char*       limit;
-
-  } FT_StreamRec;
-
-
-  /* */
-
-
-FT_END_HEADER
-
-#endif /* __FTSYSTEM_H__ */
-
-
-/* END */
+/***************************************************************************/\r
+/*                                                                         */\r
+/*  ftsystem.h                                                             */\r
+/*                                                                         */\r
+/*    FreeType low-level system interface definition (specification).      */\r
+/*                                                                         */\r
+/*  Copyright 1996-2001, 2002, 2005 by                                     */\r
+/*  David Turner, Robert Wilhelm, and Werner Lemberg.                      */\r
+/*                                                                         */\r
+/*  This file is part of the FreeType project, and may only be used,       */\r
+/*  modified, and distributed under the terms of the FreeType project      */\r
+/*  license, LICENSE.TXT.  By continuing to use, modify, or distribute     */\r
+/*  this file you indicate that you have read the license and              */\r
+/*  understand and accept it fully.                                        */\r
+/*                                                                         */\r
+/***************************************************************************/\r
+\r
+\r
+#ifndef __FTSYSTEM_H__\r
+#define __FTSYSTEM_H__\r
+\r
+\r
+#include <ft2build.h>\r
+\r
+\r
+FT_BEGIN_HEADER\r
+\r
+\r
+  /*************************************************************************/\r
+  /*                                                                       */\r
+  /* <Section>                                                             */\r
+  /*   system_interface                                                    */\r
+  /*                                                                       */\r
+  /* <Title>                                                               */\r
+  /*   System Interface                                                    */\r
+  /*                                                                       */\r
+  /* <Abstract>                                                            */\r
+  /*   How FreeType manages memory and i/o.                                */\r
+  /*                                                                       */\r
+  /* <Description>                                                         */\r
+  /*   This section contains various definitions related to memory         */\r
+  /*   management and i/o access.  You need to understand this             */\r
+  /*   information if you want to use a custom memory manager or you own   */\r
+  /*   i/o streams.                                                        */\r
+  /*                                                                       */\r
+  /*************************************************************************/\r
+\r
+\r
+  /*************************************************************************/\r
+  /*                                                                       */\r
+  /*                  M E M O R Y   M A N A G E M E N T                    */\r
+  /*                                                                       */\r
+  /*************************************************************************/\r
+\r
+\r
+  /*************************************************************************\r
+   *\r
+   * @type:\r
+   *   FT_Memory\r
+   *\r
+   * @description:\r
+   *   A handle to a given memory manager object, defined with an\r
+   *   @FT_MemoryRec structure.\r
+   *\r
+   */\r
+  typedef struct FT_MemoryRec_*  FT_Memory;\r
+\r
+\r
+  /*************************************************************************\r
+   *\r
+   * @functype:\r
+   *   FT_Alloc_Func\r
+   *\r
+   * @description:\r
+   *   A function used to allocate `size' bytes from `memory'.\r
+   *\r
+   * @input:\r
+   *   memory ::\r
+   *     A handle to the source memory manager.\r
+   *\r
+   *   size ::\r
+   *     The size in bytes to allocate.\r
+   *\r
+   * @return:\r
+   *   Address of new memory block.  0 in case of failure.\r
+   *\r
+   */\r
+  typedef void*\r
+  (*FT_Alloc_Func)( FT_Memory  memory,\r
+                    long       size );\r
+\r
+\r
+  /*************************************************************************\r
+   *\r
+   * @functype:\r
+   *   FT_Free_Func\r
+   *\r
+   * @description:\r
+   *   A function used to release a given block of memory.\r
+   *\r
+   * @input:\r
+   *   memory ::\r
+   *     A handle to the source memory manager.\r
+   *\r
+   *   block ::\r
+   *     The address of the target memory block.\r
+   *\r
+   */\r
+  typedef void\r
+  (*FT_Free_Func)( FT_Memory  memory,\r
+                   void*      block );\r
+\r
+\r
+  /*************************************************************************\r
+   *\r
+   * @functype:\r
+   *   FT_Realloc_Func\r
+   *\r
+   * @description:\r
+   *   A function used to re-allocate a given block of memory.\r
+   *\r
+   * @input:\r
+   *   memory ::\r
+   *     A handle to the source memory manager.\r
+   *\r
+   *   cur_size ::\r
+   *     The block's current size in bytes.\r
+   *\r
+   *   new_size ::\r
+   *     The block's requested new size.\r
+   *\r
+   *   block ::\r
+   *     The block's current address.\r
+   *\r
+   * @return:\r
+   *   New block address.  0 in case of memory shortage.\r
+   *\r
+   * @note:\r
+   *   In case of error, the old block must still be available.\r
+   *\r
+   */\r
+  typedef void*\r
+  (*FT_Realloc_Func)( FT_Memory  memory,\r
+                      long       cur_size,\r
+                      long       new_size,\r
+                      void*      block );\r
+\r
+\r
+  /*************************************************************************\r
+   *\r
+   * @struct:\r
+   *   FT_MemoryRec\r
+   *\r
+   * @description:\r
+   *   A structure used to describe a given memory manager to FreeType 2.\r
+   *\r
+   * @fields:\r
+   *   user ::\r
+   *     A generic typeless pointer for user data.\r
+   *\r
+   *   alloc ::\r
+   *     A pointer type to an allocation function.\r
+   *\r
+   *   free ::\r
+   *     A pointer type to an memory freeing function.\r
+   *\r
+   *   realloc ::\r
+   *     A pointer type to a reallocation function.\r
+   *\r
+   */\r
+  struct  FT_MemoryRec_\r
+  {\r
+    void*            user;\r
+    FT_Alloc_Func    alloc;\r
+    FT_Free_Func     free;\r
+    FT_Realloc_Func  realloc;\r
+  };\r
+\r
+\r
+  /*************************************************************************/\r
+  /*                                                                       */\r
+  /*                       I / O   M A N A G E M E N T                     */\r
+  /*                                                                       */\r
+  /*************************************************************************/\r
+\r
+\r
+  /*************************************************************************\r
+   *\r
+   * @type:\r
+   *   FT_Stream\r
+   *\r
+   * @description:\r
+   *   A handle to an input stream.\r
+   *\r
+   */\r
+  typedef struct FT_StreamRec_*  FT_Stream;\r
+\r
+\r
+  /*************************************************************************\r
+   *\r
+   * @struct:\r
+   *   FT_StreamDesc\r
+   *\r
+   * @description:\r
+   *   A union type used to store either a long or a pointer.  This is used\r
+   *   to store a file descriptor or a `FILE*' in an input stream.\r
+   *\r
+   */\r
+  typedef union  FT_StreamDesc_\r
+  {\r
+    long   value;\r
+    void*  pointer;\r
+\r
+  } FT_StreamDesc;\r
+\r
+\r
+  /*************************************************************************\r
+   *\r
+   * @functype:\r
+   *   FT_Stream_IoFunc\r
+   *\r
+   * @description:\r
+   *   A function used to seek and read data from a given input stream.\r
+   *\r
+   * @input:\r
+   *   stream ::\r
+   *     A handle to the source stream.\r
+   *\r
+   *   offset ::\r
+   *     The offset of read in stream (always from start).\r
+   *\r
+   *   buffer ::\r
+   *     The address of the read buffer.\r
+   *\r
+   *   count ::\r
+   *     The number of bytes to read from the stream.\r
+   *\r
+   * @return:\r
+   *   The number of bytes effectively read by the stream.\r
+   *\r
+   * @note:\r
+   *   This function might be called to perform a seek or skip operation\r
+   *   with a `count' of 0.\r
+   *\r
+   */\r
+  typedef unsigned long\r
+  (*FT_Stream_IoFunc)( FT_Stream       stream,\r
+                       unsigned long   offset,\r
+                       unsigned char*  buffer,\r
+                       unsigned long   count );\r
+\r
+\r
+  /*************************************************************************\r
+   *\r
+   * @functype:\r
+   *   FT_Stream_CloseFunc\r
+   *\r
+   * @description:\r
+   *   A function used to close a given input stream.\r
+   *\r
+   * @input:\r
+   *  stream ::\r
+   *     A handle to the target stream.\r
+   *\r
+   */\r
+  typedef void\r
+  (*FT_Stream_CloseFunc)( FT_Stream  stream );\r
+\r
+\r
+  /*************************************************************************\r
+   *\r
+   * @struct:\r
+   *   FT_StreamRec\r
+   *\r
+   * @description:\r
+   *   A structure used to describe an input stream.\r
+   *\r
+   * @input:\r
+   *   base ::\r
+   *     For memory-based streams, this is the address of the first stream\r
+   *     byte in memory.  This field should always be set to NULL for\r
+   *     disk-based streams.\r
+   *\r
+   *   size ::\r
+   *     The stream size in bytes.\r
+   *\r
+   *   pos ::\r
+   *     The current position within the stream.\r
+   *\r
+   *   descriptor ::\r
+   *     This field is a union that can hold an integer or a pointer.  It is\r
+   *     used by stream implementations to store file descriptors or `FILE*'\r
+   *     pointers.\r
+   *\r
+   *   pathname ::\r
+   *     This field is completely ignored by FreeType.  However, it is often\r
+   *     useful during debugging to use it to store the stream's filename\r
+   *     (where available).\r
+   *\r
+   *   read ::\r
+   *     The stream's input function.\r
+   *\r
+   *   close ::\r
+   *     The stream;s close function.\r
+   *\r
+   *   memory ::\r
+   *     The memory manager to use to preload frames.  This is set\r
+   *     internally by FreeType and shouldn't be touched by stream\r
+   *     implementations.\r
+   *\r
+   *   cursor ::\r
+   *     This field is set and used internally by FreeType when parsing\r
+   *     frames.\r
+   *\r
+   *   limit ::\r
+   *     This field is set and used internally by FreeType when parsing\r
+   *     frames.\r
+   *\r
+   */\r
+  typedef struct  FT_StreamRec_\r
+  {\r
+    unsigned char*       base;\r
+    unsigned long        size;\r
+    unsigned long        pos;\r
+\r
+    FT_StreamDesc        descriptor;\r
+    FT_StreamDesc        pathname;\r
+    FT_Stream_IoFunc     read;\r
+    FT_Stream_CloseFunc  close;\r
+\r
+    FT_Memory            memory;\r
+    unsigned char*       cursor;\r
+    unsigned char*       limit;\r
+\r
+  } FT_StreamRec;\r
+\r
+\r
+  /* */\r
+\r
+\r
+FT_END_HEADER\r
+\r
+#endif /* __FTSYSTEM_H__ */\r
+\r
+\r
+/* END */\r