list.h

Go to the documentation of this file.

/*
 * Summary: lists interfaces
 * Description: this module implement the list support used in
 * various place in the library.
 *
 * Copy: See Copyright for the status of this software.
 *
 * Author: Gary Pennington <Gary.Pennington@uk.sun.com>
 */
 
#ifndef __XML_LINK_INCLUDE__
#define __XML_LINK_INCLUDE__
 
#include <libxml/xmlversion.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef struct _xmlLink xmlLink;
typedef xmlLink *xmlLinkPtr;
 
typedef struct _xmlList xmlList;
typedef xmlList *xmlListPtr;
 
typedef void (*xmlListDeallocator) (xmlLinkPtr lk);
typedef int  (*xmlListDataCompare) (const void *data0, const void *data1);
typedef int (*xmlListWalker) (const void *data, void *user);
 
/* Creation/Deletion */
XMLPUBFUN xmlListPtr
        xmlListCreate       (xmlListDeallocator deallocator,
                                     xmlListDataCompare compare);
XMLPUBFUN void
        xmlListDelete       (xmlListPtr l);
 
/* Basic Operators */
XMLPUBFUN void *
        xmlListSearch       (xmlListPtr l,
                     void *data);
XMLPUBFUN void *
        xmlListReverseSearch    (xmlListPtr l,
                     void *data);
XMLPUBFUN int
        xmlListInsert       (xmlListPtr l,
                     void *data) ;
XMLPUBFUN int
        xmlListAppend       (xmlListPtr l,
                     void *data) ;
XMLPUBFUN int
        xmlListRemoveFirst  (xmlListPtr l,
                     void *data);
XMLPUBFUN int
        xmlListRemoveLast   (xmlListPtr l,
                     void *data);
XMLPUBFUN int
        xmlListRemoveAll    (xmlListPtr l,
                     void *data);
XMLPUBFUN void
        xmlListClear        (xmlListPtr l);
XMLPUBFUN int
        xmlListEmpty        (xmlListPtr l);
XMLPUBFUN xmlLinkPtr
        xmlListFront        (xmlListPtr l);
XMLPUBFUN xmlLinkPtr
        xmlListEnd      (xmlListPtr l);
XMLPUBFUN int
        xmlListSize     (xmlListPtr l);
 
XMLPUBFUN void
        xmlListPopFront     (xmlListPtr l);
XMLPUBFUN void
        xmlListPopBack      (xmlListPtr l);
XMLPUBFUN int
        xmlListPushFront    (xmlListPtr l,
                     void *data);
XMLPUBFUN int
        xmlListPushBack     (xmlListPtr l,
                     void *data);
 
/* Advanced Operators */
XMLPUBFUN void
        xmlListReverse      (xmlListPtr l);
XMLPUBFUN void
        xmlListSort     (xmlListPtr l);
XMLPUBFUN void
        xmlListWalk     (xmlListPtr l,
                     xmlListWalker walker,
                     void *user);
XMLPUBFUN void
        xmlListReverseWalk  (xmlListPtr l,
                     xmlListWalker walker,
                     void *user);
XMLPUBFUN void
        xmlListMerge        (xmlListPtr l1,
                     xmlListPtr l2);
XMLPUBFUN xmlListPtr
        xmlListDup      (const xmlListPtr old);
XMLPUBFUN int
        xmlListCopy     (xmlListPtr cur,
                     const xmlListPtr old);
/* Link operators */
XMLPUBFUN void *
        xmlLinkGetData          (xmlLinkPtr lk);
 
/* xmlListUnique() */
/* xmlListSwap */
 
#ifdef __cplusplus
}
#endif
 
#endif /* __XML_LINK_INCLUDE__ */