Struct TSLanguage

pub struct TSLanguage { /* private fields */ }

Implementations

impl Language

pub fn field_count(&self) -> u16

pub fn field_id_for_name(&self, field_name: impl AsRef<[u8]>) -> Option<u16>

pub fn field_name_for_id(&self, field_id: u16) -> Option<Cow<'_, str>>

pub fn id_for_node_kind(&self, kind: &str, named: bool) -> u16

pub fn node_kind_count(&self) -> u16

pub fn node_kind_for_id(&self, id: u16) -> Option<Cow<'_, str>>

pub fn node_kind_is_named(&self, id: u16) -> bool

pub fn node_kind_is_visible(&self, id: u16) -> bool

pub fn abi_version(&self) -> u32

Trait Implementations

impl Clone for Language

fn clone(&self) -> Language

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Language

fn fmt(&self, fmt: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl From<Language> for Language

fn from(inner: Language) -> Language

Converts to this type from the input type.

impl From<LanguageFn> for Language

fn from(inner: LanguageFn) -> Language

Converts to this type from the input type.

impl Language for TSLanguage

fn get_ts_language(&self) -> TSLanguage

tree sitter language to parse the source

fn from_path<P: AsRef<Path>>(_path: P) -> Option<Self>

Return the file language from path. Return None if the file type is not supported.

fn ast_grep<S: AsRef<str>>(&self, source: S) -> AstGrep<StrDoc<Self>>

Create an AstGrep instance for the language

fn skippable_kind_ids(&self) -> &'static [u16]

ignore trivial tokens in language matching

fn pre_process_pattern<'q>(&self, query: &'q str) -> Cow<'q, str>

normalize pattern code before matching e.g. remove expression_statement, or prefer parsing {} to object over block

fn meta_var_char(&self) -> char

Configure meta variable special character By default $ is the metavar char, but in PHP it can be #

fn expando_char(&self) -> char

Some language does not accept $ as the leading char for identifiers. We need to change $ to other char at run-time to make parser happy, thus the name expando. By default this is the same as meta_var char so replacement is done at runtime.

fn extract_meta_var(&self, source: &str) -> Option<MetaVariable>

extract MetaVariable from a given source string At runtime we need to use expand_char

fn injectable_languages(&self) -> Option<&'static [&'static str]>

fn extract_injections<D: Doc>( &self, _root: Node<'_, D>, ) -> HashMap<String, Vec<TSRange>>

get injected language regions in the root document. e.g. get JavaScripts in HTML it will return a list of tuples of (language, regions). The first item is the embedded region language, e.g. javascript The second item is a list of regions in tree_sitter. also see https://tree-sitter.github.io/tree-sitter/using-parsers#multi-language-documents

impl PartialEq for Language

fn eq(&self, other: &Language) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for Language

impl RefUnwindSafe for Language

impl Send for Language

impl StructuralPartialEq for Language

impl Sync for Language

impl Unpin for Language

impl UnwindSafe for Language