epoc32/include/stdapis/libxml2/libxml2_list.h
branchSymbian3
changeset 4 837f303aceeb
     1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/epoc32/include/stdapis/libxml2/libxml2_list.h	Wed Mar 31 12:33:34 2010 +0100
     1.3 @@ -0,0 +1,117 @@
     1.4 +/*
     1.5 + * Summary: lists interfaces
     1.6 + * Description: this module implement the list support used in
     1.7 + * various place in the library.
     1.8 + *
     1.9 + * Copy: See Copyright for the status of this software.
    1.10 + *
    1.11 + * Author: Gary Pennington <Gary.Pennington@uk.sun.com>
    1.12 + * Portion Copyright © 2009 Nokia Corporation and/or its subsidiary(-ies). All rights reserved. 
    1.13 + */
    1.14 +
    1.15 +/** @file
    1.16 +@publishedAll
    1.17 +@released
    1.18 +*/
    1.19 +
    1.20 +#ifndef XML_LIST_H
    1.21 +#define XML_LIST_H
    1.22 +
    1.23 +#include <stdapis/libxml2/libxml2_xmlversion.h>
    1.24 +
    1.25 +#ifdef __cplusplus
    1.26 +extern "C" {
    1.27 +#endif
    1.28 +
    1.29 +typedef struct _xmlLink xmlLink;
    1.30 +typedef xmlLink *xmlLinkPtr;
    1.31 +
    1.32 +typedef struct _xmlList xmlList;
    1.33 +typedef xmlList *xmlListPtr;
    1.34 +
    1.35 +/**
    1.36 + * xmlListDeallocator:
    1.37 + * @param lk the data to deallocate
    1.38 + *
    1.39 + * Callback function used to free data from a list.
    1.40 + */
    1.41 +typedef void (*xmlListDeallocator) (xmlLinkPtr lk);
    1.42 +/**
    1.43 + * xmlListDataCompare:
    1.44 + * @param data0 the first data
    1.45 + * @param data1 the second data
    1.46 + *
    1.47 + * Callback function used to compare 2 data.
    1.48 + *
    1.49 + * Returns 0 is equality, -1 or 1 otherwise depending on the ordering.
    1.50 + */
    1.51 +typedef int  (*xmlListDataCompare) (const void *data0, const void *data1);
    1.52 +/**
    1.53 + * xmlListWalker:
    1.54 + * @param data the data found in the list
    1.55 + * @param user extra user provided data to the walker
    1.56 + *
    1.57 + * Callback function used when walking a list with xmlListWalk().
    1.58 + *
    1.59 + * Returns 0 to stop walking the list, 1 otherwise.
    1.60 + */
    1.61 +typedef int (*xmlListWalker) (const void *data, const void *user);
    1.62 +
    1.63 +/* Creation/Deletion */
    1.64 +XMLPUBFUN xmlListPtr XMLCALL
    1.65 +        xmlListCreate       (xmlListDeallocator deallocator, xmlListDataCompare compare);
    1.66 +XMLPUBFUN void XMLCALL
    1.67 +        xmlListDelete       (xmlListPtr l);
    1.68 +
    1.69 +/* Basic Operators */
    1.70 +XMLPUBFUN int XMLCALL
    1.71 +        xmlListInsert       (xmlListPtr l, void *data) ;
    1.72 +XMLPUBFUN int XMLCALL
    1.73 +        xmlListAppend       (xmlListPtr l, void *data) ;
    1.74 +XMLPUBFUN int XMLCALL
    1.75 +        xmlListRemoveFirst  (xmlListPtr l, void *data);
    1.76 +XMLPUBFUN void XMLCALL
    1.77 +        xmlListClear        (xmlListPtr l);
    1.78 +XMLPUBFUN int XMLCALL
    1.79 +        xmlListEmpty        (xmlListPtr l);
    1.80 +XMLPUBFUN xmlLinkPtr XMLCALL
    1.81 +        xmlListFront        (xmlListPtr l);
    1.82 +
    1.83 +#ifndef XMLENGINE_EXCLUDE_UNUSED
    1.84 +XMLPUBFUN xmlLinkPtr XMLCALL xmlListEnd     (xmlListPtr l);
    1.85 +XMLPUBFUN void  XMLCALL xmlListReverse      (xmlListPtr l);
    1.86 +XMLPUBFUN void  XMLCALL xmlListPopBack      (xmlListPtr l);
    1.87 +XMLPUBFUN void  XMLCALL xmlListSort         (xmlListPtr l);
    1.88 +#endif /* ifndef XMLENGINE_EXCLUDE_UNUSED */
    1.89 +
    1.90 +XMLPUBFUN void* XMLCALL xmlListSearch       (xmlListPtr l, void *data);
    1.91 +
    1.92 +#ifndef XMLENGINE_EXCLUDE_UNUSED
    1.93 +XMLPUBFUN void* XMLCALL xmlListReverseSearch(xmlListPtr l, void *data);
    1.94 +XMLPUBFUN int   XMLCALL xmlListRemoveLast   (xmlListPtr l, void *data);
    1.95 +XMLPUBFUN int   XMLCALL xmlListRemoveAll    (xmlListPtr l, void *data);
    1.96 +XMLPUBFUN int   XMLCALL xmlListPushBack     (xmlListPtr l, void *data);
    1.97 +XMLPUBFUN void  XMLCALL xmlListReverseWalk  (xmlListPtr l,
    1.98 +                                             xmlListWalker walker,
    1.99 +                                             const void *user);
   1.100 +#endif /* ifndef XMLENGINE_EXCLUDE_UNUSED */
   1.101 +
   1.102 +XMLPUBFUN xmlListPtr XMLCALL xmlListDup (const xmlListPtr old);
   1.103 +XMLPUBFUN int   XMLCALL xmlListSize     (xmlListPtr l);
   1.104 +XMLPUBFUN void  XMLCALL xmlListPopFront (xmlListPtr l);
   1.105 +XMLPUBFUN int   XMLCALL xmlListPushFront(xmlListPtr l, void *data);
   1.106 +XMLPUBFUN void  XMLCALL xmlListWalk     (xmlListPtr l, xmlListWalker walker, const void *user);
   1.107 +XMLPUBFUN void  XMLCALL xmlListMerge    (xmlListPtr l1, xmlListPtr l2);
   1.108 +XMLPUBFUN int   XMLCALL xmlListCopy     (xmlListPtr cur, const xmlListPtr old);
   1.109 +/* Link operators */
   1.110 +XMLPUBFUN void* XMLCALL xmlLinkGetData  (xmlLinkPtr lk);
   1.111 +
   1.112 +/* xmlListUnique() */
   1.113 +/* xmlListSwap */
   1.114 +
   1.115 +#ifdef __cplusplus
   1.116 +}
   1.117 +#endif
   1.118 +
   1.119 +#endif /* __XML_LIST_H */
   1.120 +