Struct DynamicLang

pub struct DynamicLang { /* private fields */ }

Represents a tree-sitter language loaded as dynamic lib.

Implementations

impl DynamicLang

pub fn all_langs() -> Vec<Self>

pub fn file_types(&self) -> Types

impl DynamicLang

pub unsafe fn register(regs: Vec<Registration>) -> Result<(), DynamicLangError>

Safety

the register function should be called exactly once before use. It relies on a global mut static variable to be initialized.

pub fn name(&self) -> &str

Trait Implementations

impl Clone for DynamicLang

fn clone(&self) -> DynamicLang

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'de> Deserialize<'de> for DynamicLang

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl FromStr for DynamicLang

type Err = String

The associated error which can be returned from parsing.

fn from_str(name: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for DynamicLang

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Language for DynamicLang

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 kind_to_id(&self, kind: &str) -> u16

fn field_to_id(&self, field: &str) -> Option<u16>

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 build_pattern( &self, builder: &PatternBuilder<'_>, ) -> Result<Pattern, PatternError>

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

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

impl LanguageExt for DynamicLang

fn get_ts_language(&self) -> TSLanguage

tree sitter language to parse the source

fn ast_grep<S>(&self, source: S) -> Root<StrDoc<Self>>

where S: AsRef<str>,

Create an AstGrep instance for the language

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

fn extract_injections<L>( &self, _root: Node<'_, StrDoc<L>>, ) -> HashMap<String, Vec<Range>>

where L: LanguageExt,

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 DynamicLang

fn eq(&self, other: &DynamicLang) -> 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 Serialize for DynamicLang

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for DynamicLang

impl Eq for DynamicLang

impl StructuralPartialEq for DynamicLang