source/common/ulist.h

   1 // Copyright (C) 2016 and later: Unicode, Inc. and others.
   2 // License & terms of use: http://www.unicode.org/copyright.html
   3 /*
   4 ******************************************************************************
   5 *   Copyright (C) 2009-2016, International Business Machines
   6 *   Corporation and others.  All Rights Reserved.
   7 ******************************************************************************
   8 */
   9
  10 #ifndef ULIST_H
  11 #define ULIST_H
  12
  13 #include "unicode/utypes.h"
  14 #include "unicode/uenum.h"
  15
  16 struct UList;
  17 typedef struct UList UList;
  18
  19 U_CAPI UList * U_EXPORT2 ulist_createEmptyList(UErrorCode *status);
  20
  21 U_CAPI void U_EXPORT2 ulist_addItemEndList(UList *list, const void *data, UBool forceDelete, UErrorCode *status);
  22
  23 U_CAPI void U_EXPORT2 ulist_addItemBeginList(UList *list, const void *data, UBool forceDelete, UErrorCode *status);
  24
  25 U_CAPI UBool U_EXPORT2 ulist_containsString(const UList *list, const char *data, int32_t length);
  26
  27 U_CAPI UBool U_EXPORT2 ulist_removeString(UList *list, const char *data);
  28
  29 U_CAPI void *U_EXPORT2 ulist_getNext(UList *list);
  30
  31 U_CAPI int32_t U_EXPORT2 ulist_getListSize(const UList *list);
  32
  33 U_CAPI void U_EXPORT2 ulist_resetList(UList *list);
  34
  35 U_CAPI void U_EXPORT2 ulist_deleteList(UList *list);
  36
  37 /*
  38  * The following are for use when creating UEnumeration object backed by UList.
  39  */
  40 U_CAPI void U_EXPORT2 ulist_close_keyword_values_iterator(UEnumeration *en);
  41
  42 U_CAPI int32_t U_EXPORT2 ulist_count_keyword_values(UEnumeration *en, UErrorCode *status);
  43
  44 U_CAPI const char * U_EXPORT2 ulist_next_keyword_value(UEnumeration* en, int32_t *resultLength, UErrorCode* status);
  45
  46 U_CAPI void U_EXPORT2 ulist_reset_keyword_values_iterator(UEnumeration* en, UErrorCode* status);
  47
  48 U_CAPI UList * U_EXPORT2 ulist_getListFromEnum(UEnumeration *en);
  49
  50 #endif