Struct Php

pub struct Php;

Trait Implementations

impl Alias for Php

const ALIAS: &'static [&'static str]

impl Clone for Php

fn clone(&self) -> Php

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Php

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Php

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Php

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

Formats the value using the given formatter.

impl From<Php> for SupportLang

fn from(_: Php) -> Self

Converts to this type from the input type.

impl Language for Php

fn kind_to_id(&self, kind: &str) -> u16

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

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

fn meta_var_char(&self) -> char

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

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 from_path<P>(_path: P) -> Option<Self>

where P: AsRef<Path>,

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

impl LanguageExt for Php

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 Copy for Php