Remove unused APIs, expand docs for predicate API

This commit is contained in:
Max Brunsfeld 2019-09-16 15:00:32 -07:00
parent b79839b599
commit 1af85dc3f7
2 changed files with 17 additions and 40 deletions

View file

@ -664,12 +664,27 @@ TSQuery *ts_query_new(
void ts_query_delete(TSQuery *);
/**
* Get the number of patterns in the query.
* Get the number of patterns, captures, or string literals in the query.
*/
uint32_t ts_query_pattern_count(const TSQuery *);
uint32_t ts_query_capture_count(const TSQuery *);
uint32_t ts_query_string_count(const TSQuery *);
/**
* Get the predicates for the given pattern in the query.
* Get all of the predicates for the given pattern in the query.
*
* The predicates are represented as a single array of steps. There are three
* types of steps in this array, which correspond to the three legal values for
* the `type` field:
* - `TSQueryPredicateStepTypeCapture` - Steps with this type represent names
* of captures. Their `value_id` can be used with the
* `ts_query_capture_name_for_id` function to obtain the name of the capture.
* - `TSQueryPredicateStepTypeString` - Steps with this type represent literal
* strings. Their `value_id` can be used with the
* `ts_query_string_value_for_id` function to obtain their string value.
* - `TSQueryPredicateStepTypeDone` - Steps with this type are *sentinels*
* that represent the end of an individual predicate. If a pattern has two
* predicates, then there will be two steps with this `type` in the array.
*/
const TSQueryPredicateStep *ts_query_predicates_for_pattern(
const TSQuery *self,
@ -677,13 +692,6 @@ const TSQueryPredicateStep *ts_query_predicates_for_pattern(
uint32_t *length
);
/**
* Get the number of distinct capture names in the query, or the number of
* distinct string literals in the query.
*/
uint32_t ts_query_capture_count(const TSQuery *);
uint32_t ts_query_string_count(const TSQuery *);
/**
* Get the name and length of one of the query's captures, or one of the
* query's string literals. Each capture and string is associated with a
@ -700,21 +708,6 @@ const char *ts_query_string_value_for_id(
uint32_t *length
);
/**
* Get the numeric id of the capture with the given name, or string with the
* given value.
*/
int ts_query_capture_id_for_name(
const TSQuery *self,
const char *name,
uint32_t length
);
int ts_query_string_id_for_value(
const TSQuery *self,
const char *value,
uint32_t length
);
/**
* Create a new cursor for executing a given query.
*

View file

@ -817,22 +817,6 @@ const char *ts_query_string_value_for_id(
return symbol_table_name_for_id(&self->predicate_values, index, length);
}
int ts_query_capture_id_for_name(
const TSQuery *self,
const char *name,
uint32_t length
) {
return symbol_table_id_for_name(&self->captures, name, length);
}
int ts_query_string_id_for_value(
const TSQuery *self,
const char *value,
uint32_t length
) {
return symbol_table_id_for_name(&self->predicate_values, value, length);
}
const TSQueryPredicateStep *ts_query_predicates_for_pattern(
const TSQuery *self,
uint32_t pattern_index,