minhngoc25a
/
freetype2
mirror of git://git.savannah.gnu.org/freetype/freetype2.git
2
1
Fork 2
Code Issues 4 Releases Wiki Activity

Formatting.

This commit is contained in:
Werner Lemberg 2001-06-19 09:11:18 +00:00
parent 3d2be25ba1
commit 8ec0b130d8
1 changed files with 192 additions and 166 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

358
include/freetype/ftsystem.h
View File

@ -25,22 +25,25 @@
FT_BEGIN_HEADER FT_BEGIN_HEADER
/************************************************************************** /*************************************************************************/
* /* */
* <Section> system_interface /* <Section> */
* /* system_interface */
* <Title> System Interface /* */
* /* <Title> */
* <Abstract> /* System Interface */
* How FreeType manages memory and i/o /* */
* /* <Abstract> */
* <Description> /* How FreeType manages memory and i/o. */
* This section contains various definitions related to memory /* */
* management and i/o access. You'll need to understand this /* <Description> */
* information if you want to use a custom memory manager or /* This section contains various definitions related to memory */
* you own input i/o streams /* management and i/o access. You need to understand this */
* /* information if you want to use a custom memory manager or you own */
*/ /* input i/o streams. */
/* */
/*************************************************************************/
/*************************************************************************/ /*************************************************************************/
/* */ /* */
@ -48,89 +51,103 @@ FT_BEGIN_HEADER
/* */ /* */
/*************************************************************************/ /*************************************************************************/
/**********************************************************************
* /*************************************************************************/
* @type: FT_Memory /* */
* /* @type: */
* @description: /* FT_Memory */
* a handle to a given memory manager object, defined with a /* */
* @FT_MemoryRec structure. /* @description: */
*/ /* A handle to a given memory manager object, defined with a */
/* @FT_MemoryRec structure. */
/* */
typedef struct FT_MemoryRec_* FT_Memory; typedef struct FT_MemoryRec_* FT_Memory;
/********************************************************************** /*************************************************************************/
* /* */
* @functype: FT_Alloc_Func /* @functype: */
* /* FT_Alloc_Func */
* @description: /* */
* a function used to allocate "size" bytes from "memory" /* @description: */
* /* A function used to allocate `size' bytes from `memory'. */
* @input: /* */
* memory :: handle to source memory manager /* @input: */
* size :: size in bytes to allocate /* memory :: A handle to the source memory manager. */
* /* */
* @return: /* size :: The size in bytes to allocate. */
* address of new memory block. 0 in case of failure /* */
*/ /* @return: */
/* Address of new memory block. 0 in case of failure. */
/* */
typedef void* (*FT_Alloc_Func)( FT_Memory memory, typedef void* (*FT_Alloc_Func)( FT_Memory memory,
long size ); long size );
/********************************************************************** /*************************************************************************/
* /* */
* @functype: FT_Free_Func /* @functype: */
* /* FT_Free_Func */
* @description: /* */
* a function used to release a given block of memory /* @description: */
* /* A function used to release a given block of memory. */
* @input: /* */
* memory :: handle to source memory manager /* @input: */
* block :: address of target memory block /* memory :: A handle to the source memory manager. */
*/ /* */
/* block :: The address of the target memory block. */
/* */
typedef void (*FT_Free_Func)( FT_Memory memory, typedef void (*FT_Free_Func)( FT_Memory memory,
void* block ); void* block );
/**********************************************************************
* /*************************************************************************/
* @functype: FT_Realloc_Func /* */
* /* @functype: */
* @description: /* FT_Realloc_Func */
* a function used to re-allocate a given block of memory /* */
* /* @description: */
* @input: /* a function used to re-allocate a given block of memory. */
* memory :: handle to source memory manager /* */
* cur_size :: the block's current size in bytes /* @input: */
* new_size :: the block's requested new size /* memory :: A handle to the source memory manager. */
* block :: the block's current address /* */
* /* cur_size :: The block's current size in bytes. */
* @return: /* */
* new block address. 0 in case of memory shortage. /* new_size :: The block's requested new size. */
* /* */
* @note: /* block :: The block's current address. */
* note that in case of error, the old block must still be available /* */
*/ /* @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, typedef void* (*FT_Realloc_Func)( FT_Memory memory,
long cur_size, long cur_size,
long new_size, long new_size,
void* block ); void* block );
/********************************************************************** /*************************************************************************/
* /* */
* @struct: FT_MemoryRec /* @struct: */
* /* FT_MemoryRec */
* @description: /* */
* a structure used to describe a given memory manager to FreeType 2 /* @description: */
* /* A structure used to describe a given memory manager to FreeType 2. */
* @fields: /* */
* user :: /* @fields: */
* alloc :: /* user :: A generic typeless pointer for user data. */
* free :: /* */
* realloc :: /* alloc :: A pointer type to an allocation function. */
* /* */
*/ /* free :: A pointer type to an memory freeing function. */
struct FT_MemoryRec_ /* */
/* realloc :: A pointer type to a reallocation function. */
/* */
struct FT_MemoryRec_
{ {
void* user; void* user;
FT_Alloc_Func alloc; FT_Alloc_Func alloc;
@ -146,26 +163,26 @@ FT_BEGIN_HEADER
/*************************************************************************/ /*************************************************************************/
/************************************************************************ /*************************************************************************/
* /* */
* @type: FT_Stream /* @type: */
* /* FT_Stream */
* @description: /* */
* a handle to an input stream. /* @description: */
*/ /* A handle to an input stream. */
/* */
typedef struct FT_StreamRec_* FT_Stream; typedef struct FT_StreamRec_* FT_Stream;
/*************************************************************************/
/************************************************************************ /* */
* /* @struct: */
* @struct: FT_StreamDesc /* FT_StreamDesc */
* /* */
* @description: /* @description: */
* a union type used to store either a long or a pointer. This is /* 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 /* used to store a file descriptor or a FILE* in an input stream. */
* /* */
*/
typedef union FT_StreamDesc_ typedef union FT_StreamDesc_
{ {
long value; long value;
@ -174,80 +191,89 @@ FT_BEGIN_HEADER
} FT_StreamDesc; } FT_StreamDesc;
/************************************************************************ /*************************************************************************/
* /* */
* @functype: FT_Stream_IO /* @functype: */
* /* FT_Stream_IO */
* @description: /* */
* a function used to seek and read data from a given input stream /* @description: */
* /* A function used to seek and read data from a given input stream. */
* @input: /* */
* stream :: handle to source stream /* @input: */
* offset :: offset of read in stream (always from start) /* stream :: A handle to the source stream. */
* buffer :: address of read buffer /* */
* count :: number of bytes to read from the stream /* offset :: The offset of read in stream (always from start). */
* /* */
* @return: /* buffer :: The address of the read buffer. */
* number of bytes effectively read by the stream /* */
* /* count :: The number of bytes to read from the stream. */
* @note: /* */
* this function might be called to perform seek / skip with /* @return: */
* a "count" of 0 /* 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_IO)( FT_Stream stream, typedef unsigned long (*FT_Stream_IO)( FT_Stream stream,
unsigned long offset, unsigned long offset,
unsigned char* buffer, unsigned char* buffer,
unsigned long count ); unsigned long count );
/************************************************************************
* /*************************************************************************/
* @functype: FT_Stream_Close /* */
* /* @functype: */
* @description: /* FT_Stream_Close */
* a function used to close a given input stream /* */
* /* @description: */
* @input: /* A function used to close a given input stream. */
* stream :: handle to target stream /* */
*/ /* @input: */
/* stream :: A handle to the target stream. */
/* */
typedef void (*FT_Stream_Close)( FT_Stream stream ); typedef void (*FT_Stream_Close)( FT_Stream stream );
/************************************************************************ /*************************************************************************/
* /* */
* @struct: FT_StreamRec /* @struct: */
* /* FT_StreamRec */
* @description: /* */
* a structure used to describe an input stream /* @description: */
* /* A structure used to describe an input stream. */
* @input: /* */
* base :: for memory-based stream, this is the address of the first /* @input: */
* stream byte in memory. this field should always be set to /* base :: For memory-based streams, this is the address of the */
* NULL for disk-based streams. /* 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 /* size :: The stream size in bytes. */
* /* */
* descriptor :: this field is a union that can hold an integer or a pointer /* pos :: The current position within the stream. */
* it is used by stream implementations to store file /* */
* descriptors or FILE* pointers.. /* descriptor :: This field is a union that can hold an integer or a */
* /* pointer. It is used by stream implementations to */
* pathname :: this field is completely ignored by FreeType, however, /* store file descriptors or FILE* pointers. */
* it's often useful during debugging to use it to store /* */
* the stream's filename, where available /* pathname :: This field is completely ignored by FreeType. */
* /* However, it is often useful during debugging to use */
* read :: the stream's input function /* it to store the stream's filename (where available). */
* close :: the stream close function /* */
* /* read :: The stream's input function. */
* memory :: memory manager to use to preload frames. this is set /* */
* internally by FreeType and shouldn't be touched by /* close :: The stream;s close function. */
* stream implementations /* */
* /* memory :: The memory manager to use to preload frames. This is */
* cursor :: this field is set and used internally by FreeType /* set internally by FreeType and shouldn't be touched */
* when parsing frames. /* by stream implementations. */
* /* */
* limit :: this field is set and used internally by FreeType /* cursor :: This field is set and used internally by FreeType */
* when parsing frames. /* when parsing frames. */
*/ /* */
/* limit :: This field is set and used internally by FreeType */
/* when parsing frames. */
/* */
struct FT_StreamRec_ struct FT_StreamRec_
{ {
unsigned char* base; unsigned char* base;