nuclear@0: /***************************************************************************/ nuclear@0: /* */ nuclear@0: /* ftlist.h */ nuclear@0: /* */ nuclear@0: /* Generic list support for FreeType (specification). */ nuclear@0: /* */ nuclear@0: /* Copyright 1996-2001, 2003, 2007, 2010 by */ nuclear@0: /* David Turner, Robert Wilhelm, and Werner Lemberg. */ nuclear@0: /* */ nuclear@0: /* This file is part of the FreeType project, and may only be used, */ nuclear@0: /* modified, and distributed under the terms of the FreeType project */ nuclear@0: /* license, LICENSE.TXT. By continuing to use, modify, or distribute */ nuclear@0: /* this file you indicate that you have read the license and */ nuclear@0: /* understand and accept it fully. */ nuclear@0: /* */ nuclear@0: /***************************************************************************/ nuclear@0: nuclear@0: nuclear@0: /*************************************************************************/ nuclear@0: /* */ nuclear@0: /* This file implements functions relative to list processing. Its */ nuclear@0: /* data structures are defined in `freetype.h'. */ nuclear@0: /* */ nuclear@0: /*************************************************************************/ nuclear@0: nuclear@0: nuclear@0: #ifndef __FTLIST_H__ nuclear@0: #define __FTLIST_H__ nuclear@0: nuclear@0: nuclear@0: #include nuclear@0: #include FT_FREETYPE_H nuclear@0: nuclear@0: #ifdef FREETYPE_H nuclear@0: #error "freetype.h of FreeType 1 has been loaded!" nuclear@0: #error "Please fix the directory search order for header files" nuclear@0: #error "so that freetype.h of FreeType 2 is found first." nuclear@0: #endif nuclear@0: nuclear@0: nuclear@0: FT_BEGIN_HEADER nuclear@0: nuclear@0: nuclear@0: /*************************************************************************/ nuclear@0: /* */ nuclear@0: /*
*/ nuclear@0: /* list_processing */ nuclear@0: /* */ nuclear@0: /* */ nuclear@0: /* List Processing */ nuclear@0: /* */ nuclear@0: /* <Abstract> */ nuclear@0: /* Simple management of lists. */ nuclear@0: /* */ nuclear@0: /* <Description> */ nuclear@0: /* This section contains various definitions related to list */ nuclear@0: /* processing using doubly-linked nodes. */ nuclear@0: /* */ nuclear@0: /* <Order> */ nuclear@0: /* FT_List */ nuclear@0: /* FT_ListNode */ nuclear@0: /* FT_ListRec */ nuclear@0: /* FT_ListNodeRec */ nuclear@0: /* */ nuclear@0: /* FT_List_Add */ nuclear@0: /* FT_List_Insert */ nuclear@0: /* FT_List_Find */ nuclear@0: /* FT_List_Remove */ nuclear@0: /* FT_List_Up */ nuclear@0: /* FT_List_Iterate */ nuclear@0: /* FT_List_Iterator */ nuclear@0: /* FT_List_Finalize */ nuclear@0: /* FT_List_Destructor */ nuclear@0: /* */ nuclear@0: /*************************************************************************/ nuclear@0: nuclear@0: nuclear@0: /*************************************************************************/ nuclear@0: /* */ nuclear@0: /* <Function> */ nuclear@0: /* FT_List_Find */ nuclear@0: /* */ nuclear@0: /* <Description> */ nuclear@0: /* Find the list node for a given listed object. */ nuclear@0: /* */ nuclear@0: /* <Input> */ nuclear@0: /* list :: A pointer to the parent list. */ nuclear@0: /* data :: The address of the listed object. */ nuclear@0: /* */ nuclear@0: /* <Return> */ nuclear@0: /* List node. NULL if it wasn't found. */ nuclear@0: /* */ nuclear@0: FT_EXPORT( FT_ListNode ) nuclear@0: FT_List_Find( FT_List list, nuclear@0: void* data ); nuclear@0: nuclear@0: nuclear@0: /*************************************************************************/ nuclear@0: /* */ nuclear@0: /* <Function> */ nuclear@0: /* FT_List_Add */ nuclear@0: /* */ nuclear@0: /* <Description> */ nuclear@0: /* Append an element to the end of a list. */ nuclear@0: /* */ nuclear@0: /* <InOut> */ nuclear@0: /* list :: A pointer to the parent list. */ nuclear@0: /* node :: The node to append. */ nuclear@0: /* */ nuclear@0: FT_EXPORT( void ) nuclear@0: FT_List_Add( FT_List list, nuclear@0: FT_ListNode node ); nuclear@0: nuclear@0: nuclear@0: /*************************************************************************/ nuclear@0: /* */ nuclear@0: /* <Function> */ nuclear@0: /* FT_List_Insert */ nuclear@0: /* */ nuclear@0: /* <Description> */ nuclear@0: /* Insert an element at the head of a list. */ nuclear@0: /* */ nuclear@0: /* <InOut> */ nuclear@0: /* list :: A pointer to parent list. */ nuclear@0: /* node :: The node to insert. */ nuclear@0: /* */ nuclear@0: FT_EXPORT( void ) nuclear@0: FT_List_Insert( FT_List list, nuclear@0: FT_ListNode node ); nuclear@0: nuclear@0: nuclear@0: /*************************************************************************/ nuclear@0: /* */ nuclear@0: /* <Function> */ nuclear@0: /* FT_List_Remove */ nuclear@0: /* */ nuclear@0: /* <Description> */ nuclear@0: /* Remove a node from a list. This function doesn't check whether */ nuclear@0: /* the node is in the list! */ nuclear@0: /* */ nuclear@0: /* <Input> */ nuclear@0: /* node :: The node to remove. */ nuclear@0: /* */ nuclear@0: /* <InOut> */ nuclear@0: /* list :: A pointer to the parent list. */ nuclear@0: /* */ nuclear@0: FT_EXPORT( void ) nuclear@0: FT_List_Remove( FT_List list, nuclear@0: FT_ListNode node ); nuclear@0: nuclear@0: nuclear@0: /*************************************************************************/ nuclear@0: /* */ nuclear@0: /* <Function> */ nuclear@0: /* FT_List_Up */ nuclear@0: /* */ nuclear@0: /* <Description> */ nuclear@0: /* Move a node to the head/top of a list. Used to maintain LRU */ nuclear@0: /* lists. */ nuclear@0: /* */ nuclear@0: /* <InOut> */ nuclear@0: /* list :: A pointer to the parent list. */ nuclear@0: /* node :: The node to move. */ nuclear@0: /* */ nuclear@0: FT_EXPORT( void ) nuclear@0: FT_List_Up( FT_List list, nuclear@0: FT_ListNode node ); nuclear@0: nuclear@0: nuclear@0: /*************************************************************************/ nuclear@0: /* */ nuclear@0: /* <FuncType> */ nuclear@0: /* FT_List_Iterator */ nuclear@0: /* */ nuclear@0: /* <Description> */ nuclear@0: /* An FT_List iterator function which is called during a list parse */ nuclear@0: /* by @FT_List_Iterate. */ nuclear@0: /* */ nuclear@0: /* <Input> */ nuclear@0: /* node :: The current iteration list node. */ nuclear@0: /* */ nuclear@0: /* user :: A typeless pointer passed to @FT_List_Iterate. */ nuclear@0: /* Can be used to point to the iteration's state. */ nuclear@0: /* */ nuclear@0: typedef FT_Error nuclear@0: (*FT_List_Iterator)( FT_ListNode node, nuclear@0: void* user ); nuclear@0: nuclear@0: nuclear@0: /*************************************************************************/ nuclear@0: /* */ nuclear@0: /* <Function> */ nuclear@0: /* FT_List_Iterate */ nuclear@0: /* */ nuclear@0: /* <Description> */ nuclear@0: /* Parse a list and calls a given iterator function on each element. */ nuclear@0: /* Note that parsing is stopped as soon as one of the iterator calls */ nuclear@0: /* returns a non-zero value. */ nuclear@0: /* */ nuclear@0: /* <Input> */ nuclear@0: /* list :: A handle to the list. */ nuclear@0: /* iterator :: An iterator function, called on each node of the list. */ nuclear@0: /* user :: A user-supplied field which is passed as the second */ nuclear@0: /* argument to the iterator. */ nuclear@0: /* */ nuclear@0: /* <Return> */ nuclear@0: /* The result (a FreeType error code) of the last iterator call. */ nuclear@0: /* */ nuclear@0: FT_EXPORT( FT_Error ) nuclear@0: FT_List_Iterate( FT_List list, nuclear@0: FT_List_Iterator iterator, nuclear@0: void* user ); nuclear@0: nuclear@0: nuclear@0: /*************************************************************************/ nuclear@0: /* */ nuclear@0: /* <FuncType> */ nuclear@0: /* FT_List_Destructor */ nuclear@0: /* */ nuclear@0: /* <Description> */ nuclear@0: /* An @FT_List iterator function which is called during a list */ nuclear@0: /* finalization by @FT_List_Finalize to destroy all elements in a */ nuclear@0: /* given list. */ nuclear@0: /* */ nuclear@0: /* <Input> */ nuclear@0: /* system :: The current system object. */ nuclear@0: /* */ nuclear@0: /* data :: The current object to destroy. */ nuclear@0: /* */ nuclear@0: /* user :: A typeless pointer passed to @FT_List_Iterate. It can */ nuclear@0: /* be used to point to the iteration's state. */ nuclear@0: /* */ nuclear@0: typedef void nuclear@0: (*FT_List_Destructor)( FT_Memory memory, nuclear@0: void* data, nuclear@0: void* user ); nuclear@0: nuclear@0: nuclear@0: /*************************************************************************/ nuclear@0: /* */ nuclear@0: /* <Function> */ nuclear@0: /* FT_List_Finalize */ nuclear@0: /* */ nuclear@0: /* <Description> */ nuclear@0: /* Destroy all elements in the list as well as the list itself. */ nuclear@0: /* */ nuclear@0: /* <Input> */ nuclear@0: /* list :: A handle to the list. */ nuclear@0: /* */ nuclear@0: /* destroy :: A list destructor that will be applied to each element */ nuclear@0: /* of the list. */ nuclear@0: /* */ nuclear@0: /* memory :: The current memory object which handles deallocation. */ nuclear@0: /* */ nuclear@0: /* user :: A user-supplied field which is passed as the last */ nuclear@0: /* argument to the destructor. */ nuclear@0: /* */ nuclear@0: /* <Note> */ nuclear@0: /* This function expects that all nodes added by @FT_List_Add or */ nuclear@0: /* @FT_List_Insert have been dynamically allocated. */ nuclear@0: /* */ nuclear@0: FT_EXPORT( void ) nuclear@0: FT_List_Finalize( FT_List list, nuclear@0: FT_List_Destructor destroy, nuclear@0: FT_Memory memory, nuclear@0: void* user ); nuclear@0: nuclear@0: nuclear@0: /* */ nuclear@0: nuclear@0: nuclear@0: FT_END_HEADER nuclear@0: nuclear@0: #endif /* __FTLIST_H__ */ nuclear@0: nuclear@0: nuclear@0: /* END */