vrshoot

annotate libs/ft2static/freetype/ftlist.h @ 0:b2f14e535253

find changesets by author, revision, files, or words in the commit message
initial commit
author John Tsiombikas <nuclear@member.fsf.org>
date Sat, 01 Feb 2014 19:58:19 +0200
parents
children
rev   line source
nuclear@0 1 /***************************************************************************/
nuclear@0 2 /* */
nuclear@0 3 /* ftlist.h */
nuclear@0 4 /* */
nuclear@0 5 /* Generic list support for FreeType (specification). */
nuclear@0 6 /* */
nuclear@0 7 /* Copyright 1996-2001, 2003, 2007, 2010 by */
nuclear@0 8 /* David Turner, Robert Wilhelm, and Werner Lemberg. */
nuclear@0 9 /* */
nuclear@0 10 /* This file is part of the FreeType project, and may only be used, */
nuclear@0 11 /* modified, and distributed under the terms of the FreeType project */
nuclear@0 12 /* license, LICENSE.TXT. By continuing to use, modify, or distribute */
nuclear@0 13 /* this file you indicate that you have read the license and */
nuclear@0 14 /* understand and accept it fully. */
nuclear@0 15 /* */
nuclear@0 16 /***************************************************************************/
nuclear@0 17
nuclear@0 18
nuclear@0 19 /*************************************************************************/
nuclear@0 20 /* */
nuclear@0 21 /* This file implements functions relative to list processing. Its */
nuclear@0 22 /* data structures are defined in `freetype.h'. */
nuclear@0 23 /* */
nuclear@0 24 /*************************************************************************/
nuclear@0 25
nuclear@0 26
nuclear@0 27 #ifndef __FTLIST_H__
nuclear@0 28 #define __FTLIST_H__
nuclear@0 29
nuclear@0 30
nuclear@0 31 #include <ft2build.h>
nuclear@0 32 #include FT_FREETYPE_H
nuclear@0 33
nuclear@0 34 #ifdef FREETYPE_H
nuclear@0 35 #error "freetype.h of FreeType 1 has been loaded!"
nuclear@0 36 #error "Please fix the directory search order for header files"
nuclear@0 37 #error "so that freetype.h of FreeType 2 is found first."
nuclear@0 38 #endif
nuclear@0 39
nuclear@0 40
nuclear@0 41 FT_BEGIN_HEADER
nuclear@0 42
nuclear@0 43
nuclear@0 44 /*************************************************************************/
nuclear@0 45 /* */
nuclear@0 46 /* <Section> */
nuclear@0 47 /* list_processing */
nuclear@0 48 /* */
nuclear@0 49 /* <Title> */
nuclear@0 50 /* List Processing */
nuclear@0 51 /* */
nuclear@0 52 /* <Abstract> */
nuclear@0 53 /* Simple management of lists. */
nuclear@0 54 /* */
nuclear@0 55 /* <Description> */
nuclear@0 56 /* This section contains various definitions related to list */
nuclear@0 57 /* processing using doubly-linked nodes. */
nuclear@0 58 /* */
nuclear@0 59 /* <Order> */
nuclear@0 60 /* FT_List */
nuclear@0 61 /* FT_ListNode */
nuclear@0 62 /* FT_ListRec */
nuclear@0 63 /* FT_ListNodeRec */
nuclear@0 64 /* */
nuclear@0 65 /* FT_List_Add */
nuclear@0 66 /* FT_List_Insert */
nuclear@0 67 /* FT_List_Find */
nuclear@0 68 /* FT_List_Remove */
nuclear@0 69 /* FT_List_Up */
nuclear@0 70 /* FT_List_Iterate */
nuclear@0 71 /* FT_List_Iterator */
nuclear@0 72 /* FT_List_Finalize */
nuclear@0 73 /* FT_List_Destructor */
nuclear@0 74 /* */
nuclear@0 75 /*************************************************************************/
nuclear@0 76
nuclear@0 77
nuclear@0 78 /*************************************************************************/
nuclear@0 79 /* */
nuclear@0 80 /* <Function> */
nuclear@0 81 /* FT_List_Find */
nuclear@0 82 /* */
nuclear@0 83 /* <Description> */
nuclear@0 84 /* Find the list node for a given listed object. */
nuclear@0 85 /* */
nuclear@0 86 /* <Input> */
nuclear@0 87 /* list :: A pointer to the parent list. */
nuclear@0 88 /* data :: The address of the listed object. */
nuclear@0 89 /* */
nuclear@0 90 /* <Return> */
nuclear@0 91 /* List node. NULL if it wasn't found. */
nuclear@0 92 /* */
nuclear@0 93 FT_EXPORT( FT_ListNode )
nuclear@0 94 FT_List_Find( FT_List list,
nuclear@0 95 void* data );
nuclear@0 96
nuclear@0 97
nuclear@0 98 /*************************************************************************/
nuclear@0 99 /* */
nuclear@0 100 /* <Function> */
nuclear@0 101 /* FT_List_Add */
nuclear@0 102 /* */
nuclear@0 103 /* <Description> */
nuclear@0 104 /* Append an element to the end of a list. */
nuclear@0 105 /* */
nuclear@0 106 /* <InOut> */
nuclear@0 107 /* list :: A pointer to the parent list. */
nuclear@0 108 /* node :: The node to append. */
nuclear@0 109 /* */
nuclear@0 110 FT_EXPORT( void )
nuclear@0 111 FT_List_Add( FT_List list,
nuclear@0 112 FT_ListNode node );
nuclear@0 113
nuclear@0 114
nuclear@0 115 /*************************************************************************/
nuclear@0 116 /* */
nuclear@0 117 /* <Function> */
nuclear@0 118 /* FT_List_Insert */
nuclear@0 119 /* */
nuclear@0 120 /* <Description> */
nuclear@0 121 /* Insert an element at the head of a list. */
nuclear@0 122 /* */
nuclear@0 123 /* <InOut> */
nuclear@0 124 /* list :: A pointer to parent list. */
nuclear@0 125 /* node :: The node to insert. */
nuclear@0 126 /* */
nuclear@0 127 FT_EXPORT( void )
nuclear@0 128 FT_List_Insert( FT_List list,
nuclear@0 129 FT_ListNode node );
nuclear@0 130
nuclear@0 131
nuclear@0 132 /*************************************************************************/
nuclear@0 133 /* */
nuclear@0 134 /* <Function> */
nuclear@0 135 /* FT_List_Remove */
nuclear@0 136 /* */
nuclear@0 137 /* <Description> */
nuclear@0 138 /* Remove a node from a list. This function doesn't check whether */
nuclear@0 139 /* the node is in the list! */
nuclear@0 140 /* */
nuclear@0 141 /* <Input> */
nuclear@0 142 /* node :: The node to remove. */
nuclear@0 143 /* */
nuclear@0 144 /* <InOut> */
nuclear@0 145 /* list :: A pointer to the parent list. */
nuclear@0 146 /* */
nuclear@0 147 FT_EXPORT( void )
nuclear@0 148 FT_List_Remove( FT_List list,
nuclear@0 149 FT_ListNode node );
nuclear@0 150
nuclear@0 151
nuclear@0 152 /*************************************************************************/
nuclear@0 153 /* */
nuclear@0 154 /* <Function> */
nuclear@0 155 /* FT_List_Up */
nuclear@0 156 /* */
nuclear@0 157 /* <Description> */
nuclear@0 158 /* Move a node to the head/top of a list. Used to maintain LRU */
nuclear@0 159 /* lists. */
nuclear@0 160 /* */
nuclear@0 161 /* <InOut> */
nuclear@0 162 /* list :: A pointer to the parent list. */
nuclear@0 163 /* node :: The node to move. */
nuclear@0 164 /* */
nuclear@0 165 FT_EXPORT( void )
nuclear@0 166 FT_List_Up( FT_List list,
nuclear@0 167 FT_ListNode node );
nuclear@0 168
nuclear@0 169
nuclear@0 170 /*************************************************************************/
nuclear@0 171 /* */
nuclear@0 172 /* <FuncType> */
nuclear@0 173 /* FT_List_Iterator */
nuclear@0 174 /* */
nuclear@0 175 /* <Description> */
nuclear@0 176 /* An FT_List iterator function which is called during a list parse */
nuclear@0 177 /* by @FT_List_Iterate. */
nuclear@0 178 /* */
nuclear@0 179 /* <Input> */
nuclear@0 180 /* node :: The current iteration list node. */
nuclear@0 181 /* */
nuclear@0 182 /* user :: A typeless pointer passed to @FT_List_Iterate. */
nuclear@0 183 /* Can be used to point to the iteration's state. */
nuclear@0 184 /* */
nuclear@0 185 typedef FT_Error
nuclear@0 186 (*FT_List_Iterator)( FT_ListNode node,
nuclear@0 187 void* user );
nuclear@0 188
nuclear@0 189
nuclear@0 190 /*************************************************************************/
nuclear@0 191 /* */
nuclear@0 192 /* <Function> */
nuclear@0 193 /* FT_List_Iterate */
nuclear@0 194 /* */
nuclear@0 195 /* <Description> */
nuclear@0 196 /* Parse a list and calls a given iterator function on each element. */
nuclear@0 197 /* Note that parsing is stopped as soon as one of the iterator calls */
nuclear@0 198 /* returns a non-zero value. */
nuclear@0 199 /* */
nuclear@0 200 /* <Input> */
nuclear@0 201 /* list :: A handle to the list. */
nuclear@0 202 /* iterator :: An iterator function, called on each node of the list. */
nuclear@0 203 /* user :: A user-supplied field which is passed as the second */
nuclear@0 204 /* argument to the iterator. */
nuclear@0 205 /* */
nuclear@0 206 /* <Return> */
nuclear@0 207 /* The result (a FreeType error code) of the last iterator call. */
nuclear@0 208 /* */
nuclear@0 209 FT_EXPORT( FT_Error )
nuclear@0 210 FT_List_Iterate( FT_List list,
nuclear@0 211 FT_List_Iterator iterator,
nuclear@0 212 void* user );
nuclear@0 213
nuclear@0 214
nuclear@0 215 /*************************************************************************/
nuclear@0 216 /* */
nuclear@0 217 /* <FuncType> */
nuclear@0 218 /* FT_List_Destructor */
nuclear@0 219 /* */
nuclear@0 220 /* <Description> */
nuclear@0 221 /* An @FT_List iterator function which is called during a list */
nuclear@0 222 /* finalization by @FT_List_Finalize to destroy all elements in a */
nuclear@0 223 /* given list. */
nuclear@0 224 /* */
nuclear@0 225 /* <Input> */
nuclear@0 226 /* system :: The current system object. */
nuclear@0 227 /* */
nuclear@0 228 /* data :: The current object to destroy. */
nuclear@0 229 /* */
nuclear@0 230 /* user :: A typeless pointer passed to @FT_List_Iterate. It can */
nuclear@0 231 /* be used to point to the iteration's state. */
nuclear@0 232 /* */
nuclear@0 233 typedef void
nuclear@0 234 (*FT_List_Destructor)( FT_Memory memory,
nuclear@0 235 void* data,
nuclear@0 236 void* user );
nuclear@0 237
nuclear@0 238
nuclear@0 239 /*************************************************************************/
nuclear@0 240 /* */
nuclear@0 241 /* <Function> */
nuclear@0 242 /* FT_List_Finalize */
nuclear@0 243 /* */
nuclear@0 244 /* <Description> */
nuclear@0 245 /* Destroy all elements in the list as well as the list itself. */
nuclear@0 246 /* */
nuclear@0 247 /* <Input> */
nuclear@0 248 /* list :: A handle to the list. */
nuclear@0 249 /* */
nuclear@0 250 /* destroy :: A list destructor that will be applied to each element */
nuclear@0 251 /* of the list. */
nuclear@0 252 /* */
nuclear@0 253 /* memory :: The current memory object which handles deallocation. */
nuclear@0 254 /* */
nuclear@0 255 /* user :: A user-supplied field which is passed as the last */
nuclear@0 256 /* argument to the destructor. */
nuclear@0 257 /* */
nuclear@0 258 /* <Note> */
nuclear@0 259 /* This function expects that all nodes added by @FT_List_Add or */
nuclear@0 260 /* @FT_List_Insert have been dynamically allocated. */
nuclear@0 261 /* */
nuclear@0 262 FT_EXPORT( void )
nuclear@0 263 FT_List_Finalize( FT_List list,
nuclear@0 264 FT_List_Destructor destroy,
nuclear@0 265 FT_Memory memory,
nuclear@0 266 void* user );
nuclear@0 267
nuclear@0 268
nuclear@0 269 /* */
nuclear@0 270
nuclear@0 271
nuclear@0 272 FT_END_HEADER
nuclear@0 273
nuclear@0 274 #endif /* __FTLIST_H__ */
nuclear@0 275
nuclear@0 276
nuclear@0 277 /* END */