diff options
Diffstat (limited to 'src/3rdparty/harfbuzz-ng/src/hb-set.cc')
-rw-r--r-- | src/3rdparty/harfbuzz-ng/src/hb-set.cc | 372 |
1 files changed, 252 insertions, 120 deletions
diff --git a/src/3rdparty/harfbuzz-ng/src/hb-set.cc b/src/3rdparty/harfbuzz-ng/src/hb-set.cc index 10638a7e6d..a9386c5c91 100644 --- a/src/3rdparty/harfbuzz-ng/src/hb-set.cc +++ b/src/3rdparty/harfbuzz-ng/src/hb-set.cc @@ -30,19 +30,21 @@ /** * SECTION:hb-set * @title: hb-set - * @short_description: Object representing a set of integers + * @short_description: Objects representing a set of integers * @include: hb.h * * Set objects represent a mathematical set of integer values. They are - * used in non-shaping API to query certain set of characters or glyphs, + * used in non-shaping APIs to query certain sets of characters or glyphs, * or other integer values. **/ /** - * hb_set_create: (Xconstructor) + * hb_set_create: * - * Return value: (transfer full): + * Creates a new, initially empty set. + * + * Return value: (transfer full): The new #hb_set_t * * Since: 0.9.2 **/ @@ -54,29 +56,31 @@ hb_set_create () if (!(set = hb_object_create<hb_set_t> ())) return hb_set_get_empty (); - set->init_shallow (); - return set; } /** * hb_set_get_empty: * - * Return value: (transfer full): + * Fetches the singleton empty #hb_set_t. + * + * Return value: (transfer full): The empty #hb_set_t * * Since: 0.9.2 **/ hb_set_t * hb_set_get_empty () { - return const_cast<hb_set_t *> (&Null(hb_set_t)); + return const_cast<hb_set_t *> (&Null (hb_set_t)); } /** * hb_set_reference: (skip) - * @set: a set. + * @set: A set + * + * Increases the reference count on a set. * - * Return value: (transfer full): + * Return value: (transfer full): The set * * Since: 0.9.2 **/ @@ -88,7 +92,11 @@ hb_set_reference (hb_set_t *set) /** * hb_set_destroy: (skip) - * @set: a set. + * @set: A set + * + * Decreases the reference count on a set. When + * the reference count reaches zero, the set is + * destroyed, freeing all memory. * * Since: 0.9.2 **/ @@ -97,20 +105,20 @@ hb_set_destroy (hb_set_t *set) { if (!hb_object_destroy (set)) return; - set->fini_shallow (); - - free (set); + hb_free (set); } /** * hb_set_set_user_data: (skip) - * @set: a set. - * @key: - * @data: - * @destroy: - * @replace: + * @set: A set + * @key: The user-data key to set + * @data: A pointer to the user data to set + * @destroy: (nullable): A callback to call when @data is not needed anymore + * @replace: Whether to replace an existing data with the same key * - * Return value: + * Attaches a user-data key/data pair to the specified set. + * + * Return value: `true` if success, `false` otherwise * * Since: 0.9.2 **/ @@ -126,15 +134,18 @@ hb_set_set_user_data (hb_set_t *set, /** * hb_set_get_user_data: (skip) - * @set: a set. - * @key: + * @set: A set + * @key: The user-data key to query + * + * Fetches the user data associated with the specified key, + * attached to the specified set. * - * Return value: (transfer none): + * Return value: (transfer none): A pointer to the user data * * Since: 0.9.2 **/ void * -hb_set_get_user_data (hb_set_t *set, +hb_set_get_user_data (const hb_set_t *set, hb_user_data_key_t *key) { return hb_object_get_user_data (set, key); @@ -143,31 +154,53 @@ hb_set_get_user_data (hb_set_t *set, /** * hb_set_allocation_successful: - * @set: a set. + * @set: A set * - * + * Tests whether memory allocation for a set was successful. * - * Return value: + * Return value: `true` if allocation succeeded, `false` otherwise * * Since: 0.9.2 **/ hb_bool_t hb_set_allocation_successful (const hb_set_t *set) { - return set->successful; + return !set->in_error (); +} + +/** + * hb_set_copy: + * @set: A set + * + * Allocate a copy of @set. + * + * Return value: (transfer full): Newly-allocated set. + * + * Since: 2.8.2 + **/ +hb_set_t * +hb_set_copy (const hb_set_t *set) +{ + hb_set_t *copy = hb_set_create (); + if (unlikely (copy->in_error ())) + return hb_set_get_empty (); + + copy->set (*set); + return copy; } /** * hb_set_clear: - * @set: a set. + * @set: A set * - * + * Clears out the contents of a set. * * Since: 0.9.2 **/ void hb_set_clear (hb_set_t *set) { + /* Immutable-safe. */ set->clear (); } @@ -175,9 +208,9 @@ hb_set_clear (hb_set_t *set) * hb_set_is_empty: * @set: a set. * - * + * Tests whether a set is empty (contains no elements). * - * Return value: + * Return value: `true` if @set is empty * * Since: 0.9.7 **/ @@ -189,12 +222,12 @@ hb_set_is_empty (const hb_set_t *set) /** * hb_set_has: - * @set: a set. - * @codepoint: + * @set: A set + * @codepoint: The element to query * - * + * Tests whether @codepoint belongs to @set. * - * Return value: + * Return value: `true` if @codepoint is in @set, `false` otherwise * * Since: 0.9.2 **/ @@ -207,10 +240,10 @@ hb_set_has (const hb_set_t *set, /** * hb_set_add: - * @set: a set. - * @codepoint: + * @set: A set + * @codepoint: The element to add to @set * - * + * Adds @codepoint to @set. * * Since: 0.9.2 **/ @@ -218,16 +251,41 @@ void hb_set_add (hb_set_t *set, hb_codepoint_t codepoint) { + /* Immutable-safe. */ set->add (codepoint); } /** + * hb_set_add_sorted_array: + * @set: A set + * @sorted_codepoints: (array length=num_codepoints): Array of codepoints to add + * @num_codepoints: Length of @sorted_codepoints + * + * Adds @num_codepoints codepoints to a set at once. + * The codepoints array must be in increasing order, + * with size at least @num_codepoints. + * + * Since: 4.1.0 + */ +HB_EXTERN void +hb_set_add_sorted_array (hb_set_t *set, + const hb_codepoint_t *sorted_codepoints, + unsigned int num_codepoints) +{ + /* Immutable-safe. */ + set->add_sorted_array (sorted_codepoints, + num_codepoints, + sizeof(hb_codepoint_t)); +} + +/** * hb_set_add_range: - * @set: a set. - * @first: - * @last: + * @set: A set + * @first: The first element to add to @set + * @last: The final element to add to @set * - * + * Adds all of the elements from @first to @last + * (inclusive) to @set. * * Since: 0.9.7 **/ @@ -236,15 +294,16 @@ hb_set_add_range (hb_set_t *set, hb_codepoint_t first, hb_codepoint_t last) { + /* Immutable-safe. */ set->add_range (first, last); } /** * hb_set_del: - * @set: a set. - * @codepoint: + * @set: A set + * @codepoint: Removes @codepoint from @set * - * + * Removes @codepoint from @set. * * Since: 0.9.2 **/ @@ -252,16 +311,21 @@ void hb_set_del (hb_set_t *set, hb_codepoint_t codepoint) { + /* Immutable-safe. */ set->del (codepoint); } /** * hb_set_del_range: - * @set: a set. - * @first: - * @last: + * @set: A set + * @first: The first element to remove from @set + * @last: The final element to remove from @set + * + * Removes all of the elements from @first to @last + * (inclusive) from @set. * - * + * If @last is #HB_SET_VALUE_INVALID, then all values + * greater than or equal to @first are removed. * * Since: 0.9.7 **/ @@ -270,17 +334,19 @@ hb_set_del_range (hb_set_t *set, hb_codepoint_t first, hb_codepoint_t last) { + /* Immutable-safe. */ set->del_range (first, last); } /** * hb_set_is_equal: - * @set: a set. - * @other: other set. + * @set: A set + * @other: Another set * - * + * Tests whether @set and @other are equal (contain the same + * elements). * - * Return value: %TRUE if the two sets are equal, %FALSE otherwise. + * Return value: `true` if the two sets are equal, `false` otherwise. * * Since: 0.9.7 **/ @@ -288,17 +354,34 @@ hb_bool_t hb_set_is_equal (const hb_set_t *set, const hb_set_t *other) { - return set->is_equal (other); + return set->is_equal (*other); } /** - * hb_set_is_subset: - * @set: a set. - * @larger_set: other set. + * hb_set_hash: + * @set: A set * + * Creates a hash representing @set. * + * Return value: + * A hash of @set. * - * Return value: %TRUE if the @set is a subset of (or equal to) @larger_set, %FALSE otherwise. + * Since: 4.4.0 + **/ +HB_EXTERN unsigned int +hb_set_hash (const hb_set_t *set) +{ + return set->hash (); +} + +/** + * hb_set_is_subset: + * @set: A set + * @larger_set: Another set + * + * Tests whether @set is a subset of @larger_set. + * + * Return value: `true` if the @set is a subset of (or equal to) @larger_set, `false` otherwise. * * Since: 1.8.1 **/ @@ -306,15 +389,15 @@ hb_bool_t hb_set_is_subset (const hb_set_t *set, const hb_set_t *larger_set) { - return set->is_subset (larger_set); + return set->is_subset (*larger_set); } /** * hb_set_set: - * @set: a set. - * @other: + * @set: A set + * @other: Another set * - * + * Makes the contents of @set equal to the contents of @other. * * Since: 0.9.2 **/ @@ -322,15 +405,16 @@ void hb_set_set (hb_set_t *set, const hb_set_t *other) { - set->set (other); + /* Immutable-safe. */ + set->set (*other); } /** * hb_set_union: - * @set: a set. - * @other: + * @set: A set + * @other: Another set * - * + * Makes @set the union of @set and @other. * * Since: 0.9.2 **/ @@ -338,15 +422,16 @@ void hb_set_union (hb_set_t *set, const hb_set_t *other) { - set->union_ (other); + /* Immutable-safe. */ + set->union_ (*other); } /** * hb_set_intersect: - * @set: a set. - * @other: + * @set: A set + * @other: Another set * - * + * Makes @set the intersection of @set and @other. * * Since: 0.9.2 **/ @@ -354,15 +439,16 @@ void hb_set_intersect (hb_set_t *set, const hb_set_t *other) { - set->intersect (other); + /* Immutable-safe. */ + set->intersect (*other); } /** * hb_set_subtract: - * @set: a set. - * @other: + * @set: A set + * @other: Another set * - * + * Subtracts the contents of @other from @set. * * Since: 0.9.2 **/ @@ -370,15 +456,17 @@ void hb_set_subtract (hb_set_t *set, const hb_set_t *other) { - set->subtract (other); + /* Immutable-safe. */ + set->subtract (*other); } /** * hb_set_symmetric_difference: - * @set: a set. - * @other: + * @set: A set + * @other: Another set * - * + * Makes @set the symmetric difference of @set + * and @other. * * Since: 0.9.2 **/ @@ -386,33 +474,48 @@ void hb_set_symmetric_difference (hb_set_t *set, const hb_set_t *other) { - set->symmetric_difference (other); + /* Immutable-safe. */ + set->symmetric_difference (*other); } -#ifndef HB_DISABLE_DEPRECATED /** * hb_set_invert: - * @set: a set. - * - * + * @set: A set * - * Since: 0.9.10 + * Inverts the contents of @set. * - * Deprecated: 1.6.1 + * Since: 3.0.0 **/ void -hb_set_invert (hb_set_t *set HB_UNUSED) +hb_set_invert (hb_set_t *set) +{ + /* Immutable-safe. */ + set->invert (); +} + +/** + * hb_set_is_inverted: + * @set: A set + * + * Returns whether the set is inverted. + * + * Return value: `true` if the set is inverted, `false` otherwise + * + * Since: 7.0.0 + **/ +hb_bool_t +hb_set_is_inverted (const hb_set_t *set) { + return set->is_inverted (); } -#endif /** * hb_set_get_population: - * @set: a set. + * @set: A set * - * Returns the number of numbers in the set. + * Returns the number of elements in the set. * - * Return value: set population. + * Return value: The population of @set * * Since: 0.9.7 **/ @@ -424,11 +527,11 @@ hb_set_get_population (const hb_set_t *set) /** * hb_set_get_min: - * @set: a set. + * @set: A set * - * Finds the minimum number in the set. + * Finds the smallest element in the set. * - * Return value: minimum of the set, or %HB_SET_VALUE_INVALID if set is empty. + * Return value: minimum of @set, or #HB_SET_VALUE_INVALID if @set is empty. * * Since: 0.9.7 **/ @@ -440,11 +543,11 @@ hb_set_get_min (const hb_set_t *set) /** * hb_set_get_max: - * @set: a set. + * @set: A set * - * Finds the maximum number in the set. + * Finds the largest element in the set. * - * Return value: minimum of the set, or %HB_SET_VALUE_INVALID if set is empty. + * Return value: maximum of @set, or #HB_SET_VALUE_INVALID if @set is empty. * * Since: 0.9.7 **/ @@ -456,14 +559,15 @@ hb_set_get_max (const hb_set_t *set) /** * hb_set_next: - * @set: a set. - * @codepoint: (inout): + * @set: A set + * @codepoint: (inout): Input = Code point to query + * Output = Code point retrieved * - * Gets the next number in @set that is greater than current value of @codepoint. + * Fetches the next element in @set that is greater than current value of @codepoint. * - * Set @codepoint to %HB_SET_VALUE_INVALID to get started. + * Set @codepoint to #HB_SET_VALUE_INVALID to get started. * - * Return value: whether there was a next value. + * Return value: `true` if there was a next value, `false` otherwise * * Since: 0.9.2 **/ @@ -476,14 +580,15 @@ hb_set_next (const hb_set_t *set, /** * hb_set_previous: - * @set: a set. - * @codepoint: (inout): + * @set: A set + * @codepoint: (inout): Input = Code point to query + * Output = Code point retrieved * - * Gets the previous number in @set that is lower than current value of @codepoint. + * Fetches the previous element in @set that is lower than current value of @codepoint. * - * Set @codepoint to %HB_SET_VALUE_INVALID to get started. + * Set @codepoint to #HB_SET_VALUE_INVALID to get started. * - * Return value: whether there was a previous value. + * Return value: `true` if there was a previous value, `false` otherwise * * Since: 1.8.0 **/ @@ -496,16 +601,17 @@ hb_set_previous (const hb_set_t *set, /** * hb_set_next_range: - * @set: a set. - * @first: (out): output first codepoint in the range. - * @last: (inout): input current last and output last codepoint in the range. + * @set: A set + * @first: (out): The first code point in the range + * @last: (inout): Input = The current last code point in the range + * Output = The last code point in the range * - * Gets the next consecutive range of numbers in @set that + * Fetches the next consecutive range of elements in @set that * are greater than current value of @last. * - * Set @last to %HB_SET_VALUE_INVALID to get started. + * Set @last to #HB_SET_VALUE_INVALID to get started. * - * Return value: whether there was a next range. + * Return value: `true` if there was a next range, `false` otherwise * * Since: 0.9.7 **/ @@ -519,16 +625,17 @@ hb_set_next_range (const hb_set_t *set, /** * hb_set_previous_range: - * @set: a set. - * @first: (inout): input current first and output first codepoint in the range. - * @last: (out): output last codepoint in the range. + * @set: A set + * @first: (inout): Input = The current first code point in the range + * Output = The first code point in the range + * @last: (out): The last code point in the range * - * Gets the previous consecutive range of numbers in @set that - * are less than current value of @first. + * Fetches the previous consecutive range of elements in @set that + * are greater than current value of @last. * - * Set @first to %HB_SET_VALUE_INVALID to get started. + * Set @first to #HB_SET_VALUE_INVALID to get started. * - * Return value: whether there was a previous range. + * Return value: `true` if there was a previous range, `false` otherwise * * Since: 1.8.0 **/ @@ -539,3 +646,28 @@ hb_set_previous_range (const hb_set_t *set, { return set->previous_range (first, last); } + +/** + * hb_set_next_many: + * @set: A set + * @codepoint: Outputting codepoints starting after this one. + * Use #HB_SET_VALUE_INVALID to get started. + * @out: (array length=size): An array of codepoints to write to. + * @size: The maximum number of codepoints to write out. + * + * Finds the next element in @set that is greater than @codepoint. Writes out + * codepoints to @out, until either the set runs out of elements, or @size + * codepoints are written, whichever comes first. + * + * Return value: the number of values written. + * + * Since: 4.2.0 + **/ +unsigned int +hb_set_next_many (const hb_set_t *set, + hb_codepoint_t codepoint, + hb_codepoint_t *out, + unsigned int size) +{ + return set->next_many (codepoint, out, size); +} |