mirror of
https://github.com/github/codeql.git
synced 2026-03-31 20:58:16 +02:00
348 lines
13 KiB
C++
348 lines
13 KiB
C++
#ifndef TREE_SITTER_ARRAY_H_
|
|
#define TREE_SITTER_ARRAY_H_
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
#include "./alloc.h"
|
|
|
|
#include <assert.h>
|
|
#include <stdbool.h>
|
|
#include <stdint.h>
|
|
#include <stdlib.h>
|
|
#include <string.h>
|
|
|
|
#ifdef _MSC_VER
|
|
#pragma warning(push)
|
|
#pragma warning(disable : 4101)
|
|
#elif defined(__GNUC__) || defined(__clang__)
|
|
#pragma GCC diagnostic push
|
|
#pragma GCC diagnostic ignored "-Wunused-variable"
|
|
#endif
|
|
|
|
#define Array(T) \
|
|
struct { \
|
|
T *contents; \
|
|
uint32_t size; \
|
|
uint32_t capacity; \
|
|
}
|
|
|
|
/// Initialize an array.
|
|
#define array_init(self) \
|
|
((self)->size = 0, (self)->capacity = 0, (self)->contents = NULL)
|
|
|
|
/// Create an empty array.
|
|
#define array_new() \
|
|
{ NULL, 0, 0 }
|
|
|
|
/// Get a pointer to the element at a given `index` in the array.
|
|
#define array_get(self, _index) \
|
|
(assert((uint32_t)(_index) < (self)->size), &(self)->contents[_index])
|
|
|
|
/// Get a pointer to the first element in the array.
|
|
#define array_front(self) array_get(self, 0)
|
|
|
|
/// Get a pointer to the last element in the array.
|
|
#define array_back(self) array_get(self, (self)->size - 1)
|
|
|
|
/// Clear the array, setting its size to zero. Note that this does not free any
|
|
/// memory allocated for the array's contents.
|
|
#define array_clear(self) ((self)->size = 0)
|
|
|
|
/// Reserve `new_capacity` elements of space in the array. If `new_capacity` is
|
|
/// less than the array's current capacity, this function has no effect.
|
|
#define array_reserve(self, new_capacity) \
|
|
((self)->contents = _array__reserve( \
|
|
(void *)(self)->contents, &(self)->capacity, \
|
|
array_elem_size(self), new_capacity) \
|
|
)
|
|
|
|
/// Free any memory allocated for this array. Note that this does not free any
|
|
/// memory allocated for the array's contents.
|
|
#define array_delete(self) _array__delete((self), (void *)(self)->contents, sizeof(*self))
|
|
|
|
/// Push a new `element` onto the end of the array.
|
|
#define array_push(self, element) \
|
|
do { \
|
|
(self)->contents = _array__grow( \
|
|
(void *)(self)->contents, (self)->size, &(self)->capacity, \
|
|
1, array_elem_size(self) \
|
|
); \
|
|
(self)->contents[(self)->size++] = (element); \
|
|
} while(0)
|
|
|
|
/// Increase the array's size by `count` elements.
|
|
/// New elements are zero-initialized.
|
|
#define array_grow_by(self, count) \
|
|
do { \
|
|
if ((count) == 0) break; \
|
|
(self)->contents = _array__grow( \
|
|
(self)->contents, (self)->size, &(self)->capacity, \
|
|
count, array_elem_size(self) \
|
|
); \
|
|
memset((self)->contents + (self)->size, 0, (count) * array_elem_size(self)); \
|
|
(self)->size += (count); \
|
|
} while (0)
|
|
|
|
/// Append all elements from one array to the end of another.
|
|
#define array_push_all(self, other) \
|
|
array_extend((self), (other)->size, (other)->contents)
|
|
|
|
/// Append `count` elements to the end of the array, reading their values from the
|
|
/// `contents` pointer.
|
|
#define array_extend(self, count, other_contents) \
|
|
(self)->contents = _array__splice( \
|
|
(void*)(self)->contents, &(self)->size, &(self)->capacity, \
|
|
array_elem_size(self), (self)->size, 0, count, other_contents \
|
|
)
|
|
|
|
/// Remove `old_count` elements from the array starting at the given `index`. At
|
|
/// the same index, insert `new_count` new elements, reading their values from the
|
|
/// `new_contents` pointer.
|
|
#define array_splice(self, _index, old_count, new_count, new_contents) \
|
|
(self)->contents = _array__splice( \
|
|
(void *)(self)->contents, &(self)->size, &(self)->capacity, \
|
|
array_elem_size(self), _index, old_count, new_count, new_contents \
|
|
)
|
|
|
|
/// Insert one `element` into the array at the given `index`.
|
|
#define array_insert(self, _index, element) \
|
|
(self)->contents = _array__splice( \
|
|
(void *)(self)->contents, &(self)->size, &(self)->capacity, \
|
|
array_elem_size(self), _index, 0, 1, &(element) \
|
|
)
|
|
|
|
/// Remove one element from the array at the given `index`.
|
|
#define array_erase(self, _index) \
|
|
_array__erase((void *)(self)->contents, &(self)->size, array_elem_size(self), _index)
|
|
|
|
/// Pop the last element off the array, returning the element by value.
|
|
#define array_pop(self) ((self)->contents[--(self)->size])
|
|
|
|
/// Assign the contents of one array to another, reallocating if necessary.
|
|
#define array_assign(self, other) \
|
|
(self)->contents = _array__assign( \
|
|
(void *)(self)->contents, &(self)->size, &(self)->capacity, \
|
|
(const void *)(other)->contents, (other)->size, array_elem_size(self) \
|
|
)
|
|
|
|
/// Swap one array with another
|
|
#define array_swap(self, other) \
|
|
do { \
|
|
struct Swap swapped_contents = _array__swap( \
|
|
(void *)(self)->contents, &(self)->size, &(self)->capacity, \
|
|
(void *)(other)->contents, &(other)->size, &(other)->capacity \
|
|
); \
|
|
(self)->contents = swapped_contents.self_contents; \
|
|
(other)->contents = swapped_contents.other_contents; \
|
|
} while (0)
|
|
|
|
/// Get the size of the array contents
|
|
#define array_elem_size(self) (sizeof *(self)->contents)
|
|
|
|
/// Search a sorted array for a given `needle` value, using the given `compare`
|
|
/// callback to determine the order.
|
|
///
|
|
/// If an existing element is found to be equal to `needle`, then the `index`
|
|
/// out-parameter is set to the existing value's index, and the `exists`
|
|
/// out-parameter is set to true. Otherwise, `index` is set to an index where
|
|
/// `needle` should be inserted in order to preserve the sorting, and `exists`
|
|
/// is set to false.
|
|
#define array_search_sorted_with(self, compare, needle, _index, _exists) \
|
|
_array__search_sorted(self, 0, compare, , needle, _index, _exists)
|
|
|
|
/// Search a sorted array for a given `needle` value, using integer comparisons
|
|
/// of a given struct field (specified with a leading dot) to determine the order.
|
|
///
|
|
/// See also `array_search_sorted_with`.
|
|
#define array_search_sorted_by(self, field, needle, _index, _exists) \
|
|
_array__search_sorted(self, 0, _compare_int, field, needle, _index, _exists)
|
|
|
|
/// Insert a given `value` into a sorted array, using the given `compare`
|
|
/// callback to determine the order.
|
|
#define array_insert_sorted_with(self, compare, value) \
|
|
do { \
|
|
unsigned _index, _exists; \
|
|
array_search_sorted_with(self, compare, &(value), &_index, &_exists); \
|
|
if (!_exists) array_insert(self, _index, value); \
|
|
} while (0)
|
|
|
|
/// Insert a given `value` into a sorted array, using integer comparisons of
|
|
/// a given struct field (specified with a leading dot) to determine the order.
|
|
///
|
|
/// See also `array_search_sorted_by`.
|
|
#define array_insert_sorted_by(self, field, value) \
|
|
do { \
|
|
unsigned _index, _exists; \
|
|
array_search_sorted_by(self, field, (value) field, &_index, &_exists); \
|
|
if (!_exists) array_insert(self, _index, value); \
|
|
} while (0)
|
|
|
|
// Private
|
|
|
|
// Pointers to individual `Array` fields (rather than the entire `Array` itself)
|
|
// are passed to the various `_array__*` functions below to address strict aliasing
|
|
// violations that arises when the _entire_ `Array` struct is passed as `Array(void)*`.
|
|
//
|
|
// The `Array` type itself was not altered as a solution in order to avoid breakage
|
|
// with existing consumers (in particular, parsers with external scanners).
|
|
|
|
/// This is not what you're looking for, see `array_delete`.
|
|
static inline void _array__delete(void *self, void *contents, size_t self_size) {
|
|
if (contents) ts_free(contents);
|
|
if (self) memset(self, 0, self_size);
|
|
}
|
|
|
|
/// This is not what you're looking for, see `array_erase`.
|
|
static inline void _array__erase(void* self_contents, uint32_t *size,
|
|
size_t element_size, uint32_t index) {
|
|
assert(index < *size);
|
|
char *contents = (char *)self_contents;
|
|
memmove(contents + index * element_size, contents + (index + 1) * element_size,
|
|
(*size - index - 1) * element_size);
|
|
(*size)--;
|
|
}
|
|
|
|
/// This is not what you're looking for, see `array_reserve`.
|
|
static inline void *_array__reserve(void *contents, uint32_t *capacity,
|
|
size_t element_size, uint32_t new_capacity) {
|
|
void *new_contents = contents;
|
|
if (new_capacity > *capacity) {
|
|
if (contents) {
|
|
new_contents = ts_realloc(contents, new_capacity * element_size);
|
|
} else {
|
|
new_contents = ts_malloc(new_capacity * element_size);
|
|
}
|
|
*capacity = new_capacity;
|
|
}
|
|
return new_contents;
|
|
}
|
|
|
|
/// This is not what you're looking for, see `array_assign`.
|
|
static inline void *_array__assign(void* self_contents, uint32_t *self_size, uint32_t *self_capacity,
|
|
const void *other_contents, uint32_t other_size, size_t element_size) {
|
|
void *new_contents = _array__reserve(self_contents, self_capacity, element_size, other_size);
|
|
*self_size = other_size;
|
|
memcpy(new_contents, other_contents, *self_size * element_size);
|
|
return new_contents;
|
|
}
|
|
|
|
struct Swap {
|
|
void *self_contents;
|
|
void *other_contents;
|
|
};
|
|
|
|
/// This is not what you're looking for, see `array_swap`.
|
|
// static inline void _array__swap(Array *self, Array *other) {
|
|
static inline struct Swap _array__swap(void *self_contents, uint32_t *self_size, uint32_t *self_capacity,
|
|
void *other_contents, uint32_t *other_size, uint32_t *other_capacity) {
|
|
void *new_self_contents = other_contents;
|
|
uint32_t new_self_size = *other_size;
|
|
uint32_t new_self_capacity = *other_capacity;
|
|
|
|
void *new_other_contents = self_contents;
|
|
*other_size = *self_size;
|
|
*other_capacity = *self_capacity;
|
|
|
|
*self_size = new_self_size;
|
|
*self_capacity = new_self_capacity;
|
|
|
|
struct Swap out = {
|
|
.self_contents = new_self_contents,
|
|
.other_contents = new_other_contents,
|
|
};
|
|
return out;
|
|
}
|
|
|
|
/// This is not what you're looking for, see `array_push` or `array_grow_by`.
|
|
static inline void *_array__grow(void *contents, uint32_t size, uint32_t *capacity,
|
|
uint32_t count, size_t element_size) {
|
|
void *new_contents = contents;
|
|
uint32_t new_size = size + count;
|
|
if (new_size > *capacity) {
|
|
uint32_t new_capacity = *capacity * 2;
|
|
if (new_capacity < 8) new_capacity = 8;
|
|
if (new_capacity < new_size) new_capacity = new_size;
|
|
new_contents = _array__reserve(contents, capacity, element_size, new_capacity);
|
|
}
|
|
return new_contents;
|
|
}
|
|
|
|
/// This is not what you're looking for, see `array_splice`.
|
|
static inline void *_array__splice(void *self_contents, uint32_t *size, uint32_t *capacity,
|
|
size_t element_size,
|
|
uint32_t index, uint32_t old_count,
|
|
uint32_t new_count, const void *elements) {
|
|
uint32_t new_size = *size + new_count - old_count;
|
|
uint32_t old_end = index + old_count;
|
|
uint32_t new_end = index + new_count;
|
|
assert(old_end <= *size);
|
|
|
|
void *new_contents = _array__reserve(self_contents, capacity, element_size, new_size);
|
|
|
|
char *contents = (char *)new_contents;
|
|
if (*size > old_end) {
|
|
memmove(
|
|
contents + new_end * element_size,
|
|
contents + old_end * element_size,
|
|
(*size - old_end) * element_size
|
|
);
|
|
}
|
|
if (new_count > 0) {
|
|
if (elements) {
|
|
memcpy(
|
|
(contents + index * element_size),
|
|
elements,
|
|
new_count * element_size
|
|
);
|
|
} else {
|
|
memset(
|
|
(contents + index * element_size),
|
|
0,
|
|
new_count * element_size
|
|
);
|
|
}
|
|
}
|
|
*size += new_count - old_count;
|
|
|
|
return new_contents;
|
|
}
|
|
|
|
/// A binary search routine, based on Rust's `std::slice::binary_search_by`.
|
|
/// This is not what you're looking for, see `array_search_sorted_with` or `array_search_sorted_by`.
|
|
#define _array__search_sorted(self, start, compare, suffix, needle, _index, _exists) \
|
|
do { \
|
|
*(_index) = start; \
|
|
*(_exists) = false; \
|
|
uint32_t size = (self)->size - *(_index); \
|
|
if (size == 0) break; \
|
|
int comparison; \
|
|
while (size > 1) { \
|
|
uint32_t half_size = size / 2; \
|
|
uint32_t mid_index = *(_index) + half_size; \
|
|
comparison = compare(&((self)->contents[mid_index] suffix), (needle)); \
|
|
if (comparison <= 0) *(_index) = mid_index; \
|
|
size -= half_size; \
|
|
} \
|
|
comparison = compare(&((self)->contents[*(_index)] suffix), (needle)); \
|
|
if (comparison == 0) *(_exists) = true; \
|
|
else if (comparison < 0) *(_index) += 1; \
|
|
} while (0)
|
|
|
|
/// Helper macro for the `_sorted_by` routines below. This takes the left (existing)
|
|
/// parameter by reference in order to work with the generic sorting function above.
|
|
#define _compare_int(a, b) ((int)*(a) - (int)(b))
|
|
|
|
#ifdef _MSC_VER
|
|
#pragma warning(pop)
|
|
#elif defined(__GNUC__) || defined(__clang__)
|
|
#pragma GCC diagnostic pop
|
|
#endif
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif // TREE_SITTER_ARRAY_H_
|