hb-map.h 2.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124
  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. HB_BEGIN_DECLS
  33. /**
  34. * HB_MAP_VALUE_INVALID:
  35. *
  36. * Unset #hb_map_t value.
  37. *
  38. * Since: 1.7.7
  39. */
  40. #define HB_MAP_VALUE_INVALID ((hb_codepoint_t) -1)
  41. /**
  42. * hb_map_t:
  43. *
  44. * Data type for holding integer-to-integer hash maps.
  45. *
  46. **/
  47. typedef struct hb_map_t hb_map_t;
  48. HB_EXTERN hb_map_t *
  49. hb_map_create (void);
  50. HB_EXTERN hb_map_t *
  51. hb_map_get_empty (void);
  52. HB_EXTERN hb_map_t *
  53. hb_map_reference (hb_map_t *map);
  54. HB_EXTERN void
  55. hb_map_destroy (hb_map_t *map);
  56. HB_EXTERN hb_bool_t
  57. hb_map_set_user_data (hb_map_t *map,
  58. hb_user_data_key_t *key,
  59. void * data,
  60. hb_destroy_func_t destroy,
  61. hb_bool_t replace);
  62. HB_EXTERN void *
  63. hb_map_get_user_data (const hb_map_t *map,
  64. hb_user_data_key_t *key);
  65. /* Returns false if allocation has failed before */
  66. HB_EXTERN hb_bool_t
  67. hb_map_allocation_successful (const hb_map_t *map);
  68. HB_EXTERN hb_map_t *
  69. hb_map_copy (const hb_map_t *map);
  70. HB_EXTERN void
  71. hb_map_clear (hb_map_t *map);
  72. HB_EXTERN hb_bool_t
  73. hb_map_is_empty (const hb_map_t *map);
  74. HB_EXTERN unsigned int
  75. hb_map_get_population (const hb_map_t *map);
  76. HB_EXTERN hb_bool_t
  77. hb_map_is_equal (const hb_map_t *map,
  78. const hb_map_t *other);
  79. HB_EXTERN unsigned int
  80. hb_map_hash (const hb_map_t *map);
  81. HB_EXTERN void
  82. hb_map_set (hb_map_t *map,
  83. hb_codepoint_t key,
  84. hb_codepoint_t value);
  85. HB_EXTERN hb_codepoint_t
  86. hb_map_get (const hb_map_t *map,
  87. hb_codepoint_t key);
  88. HB_EXTERN void
  89. hb_map_del (hb_map_t *map,
  90. hb_codepoint_t key);
  91. HB_EXTERN hb_bool_t
  92. hb_map_has (const hb_map_t *map,
  93. hb_codepoint_t key);
  94. HB_END_DECLS
  95. #endif /* HB_MAP_H */