hb-map.h 3.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143
  1. /*
  2. * Copyright © 2018 Google, Inc.
  3. *
  4. * This is part of HarfBuzz, a text shaping library.
  5. *
  6. * Permission is hereby granted, without written agreement and without
  7. * license or royalty fees, to use, copy, modify, and distribute this
  8. * software and its documentation for any purpose, provided that the
  9. * above copyright notice and the following two paragraphs appear in
  10. * all copies of this software.
  11. *
  12. * IN NO EVENT SHALL THE COPYRIGHT HOLDER BE LIABLE TO ANY PARTY FOR
  13. * DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
  14. * ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN
  15. * IF THE COPYRIGHT HOLDER HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
  16. * DAMAGE.
  17. *
  18. * THE COPYRIGHT HOLDER SPECIFICALLY DISCLAIMS ANY WARRANTIES, INCLUDING,
  19. * BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
  20. * FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE PROVIDED HEREUNDER IS
  21. * ON AN "AS IS" BASIS, AND THE COPYRIGHT HOLDER HAS NO OBLIGATION TO
  22. * PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
  23. *
  24. * Google Author(s): Behdad Esfahbod
  25. */
  26. #if !defined(HB_H_IN) && !defined(HB_NO_SINGLE_HEADER_ERROR)
  27. #error "Include <hb.h> instead."
  28. #endif
  29. #ifndef HB_MAP_H
  30. #define HB_MAP_H
  31. #include "hb-common.h"
  32. #include "hb-set.h"
  33. HB_BEGIN_DECLS
  34. /**
  35. * HB_MAP_VALUE_INVALID:
  36. *
  37. * Unset #hb_map_t value.
  38. *
  39. * Since: 1.7.7
  40. */
  41. #define HB_MAP_VALUE_INVALID HB_CODEPOINT_INVALID
  42. /**
  43. * hb_map_t:
  44. *
  45. * Data type for holding integer-to-integer hash maps.
  46. *
  47. **/
  48. typedef struct hb_map_t hb_map_t;
  49. HB_EXTERN hb_map_t *
  50. hb_map_create (void);
  51. HB_EXTERN hb_map_t *
  52. hb_map_get_empty (void);
  53. HB_EXTERN hb_map_t *
  54. hb_map_reference (hb_map_t *map);
  55. HB_EXTERN void
  56. hb_map_destroy (hb_map_t *map);
  57. HB_EXTERN hb_bool_t
  58. hb_map_set_user_data (hb_map_t *map,
  59. hb_user_data_key_t *key,
  60. void * data,
  61. hb_destroy_func_t destroy,
  62. hb_bool_t replace);
  63. HB_EXTERN void *
  64. hb_map_get_user_data (const hb_map_t *map,
  65. hb_user_data_key_t *key);
  66. /* Returns false if allocation has failed before */
  67. HB_EXTERN hb_bool_t
  68. hb_map_allocation_successful (const hb_map_t *map);
  69. HB_EXTERN hb_map_t *
  70. hb_map_copy (const hb_map_t *map);
  71. HB_EXTERN void
  72. hb_map_clear (hb_map_t *map);
  73. HB_EXTERN hb_bool_t
  74. hb_map_is_empty (const hb_map_t *map);
  75. HB_EXTERN unsigned int
  76. hb_map_get_population (const hb_map_t *map);
  77. HB_EXTERN hb_bool_t
  78. hb_map_is_equal (const hb_map_t *map,
  79. const hb_map_t *other);
  80. HB_EXTERN unsigned int
  81. hb_map_hash (const hb_map_t *map);
  82. HB_EXTERN void
  83. hb_map_set (hb_map_t *map,
  84. hb_codepoint_t key,
  85. hb_codepoint_t value);
  86. HB_EXTERN hb_codepoint_t
  87. hb_map_get (const hb_map_t *map,
  88. hb_codepoint_t key);
  89. HB_EXTERN void
  90. hb_map_del (hb_map_t *map,
  91. hb_codepoint_t key);
  92. HB_EXTERN hb_bool_t
  93. hb_map_has (const hb_map_t *map,
  94. hb_codepoint_t key);
  95. HB_EXTERN void
  96. hb_map_update (hb_map_t *map,
  97. const hb_map_t *other);
  98. /* Pass -1 in for idx to get started. */
  99. HB_EXTERN hb_bool_t
  100. hb_map_next (const hb_map_t *map,
  101. int *idx,
  102. hb_codepoint_t *key,
  103. hb_codepoint_t *value);
  104. HB_EXTERN void
  105. hb_map_keys (const hb_map_t *map,
  106. hb_set_t *keys);
  107. HB_EXTERN void
  108. hb_map_values (const hb_map_t *map,
  109. hb_set_t *values);
  110. HB_END_DECLS
  111. #endif /* HB_MAP_H */