Skip to main content

Html

thread_language

Struct Html

pub struct Html;

Expand description

HTML language implementation with language injection capabilities.

Uses z as the expando character for metavariables since HTML attributes and tag names have specific character restrictions.

§Language Injection

Automatically detects and extracts embedded languages:

JavaScript in <script> elements (default when no lang attribute)
CSS in <style> elements (default when no lang attribute)
Other languages when specified via lang attribute

§Examples

use thread_language::Html;
use thread_ast_engine::{Language, LanguageExt};

let html = Html;
let source = r#"
<script>console.log('hello');</script>
<style>.class { color: red; }</style>
<script lang="ts">const x: number = 42;</script>
"#;

let tree = html.ast_grep(source);
let injections = html.extract_injections(tree.root());
// injections contains JavaScript, CSS, and TypeScript ranges

§Note

tree-sitter-html uses locale-dependent iswalnum for tag names. See: https://github.com/tree-sitter/tree-sitter-html/blob/b5d9758e22b4d3d25704b72526670759a9e4d195/src/scanner.c#L194

Trait Implementations§

impl Alias for Html

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

impl Clone for Html

fn clone(&self) -> Html

Returns a duplicate of the value. Read more

1.0.0 · Source§

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

Performs copy-assignment from source. Read more

impl Debug for Html

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

Formats the value using the given formatter. Read more

impl<'de> Deserialize<'de> for Html

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more

impl Display for Html

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

Formats the value using the given formatter. Read more

impl From<Html> for SupportLang

fn from(_: Html) -> Self

Converts to this type from the input type.

impl Language for Html

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

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

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 Html

fn get_ts_language(&self) -> TSLanguage

Get the tree-sitter language object for parsing. Read more

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

List of languages that can be injected into this language. Read more

fn extract_injections<L: LanguageExt>( &self, root: Node<'_, StrDoc<L>>, ) -> RapidMap<String, Vec<TSRange>>

Extract language injection regions from a parsed document. Read more

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

Create an AstGrep instance for parsing and pattern matching. Read more

impl Copy for Html

Auto Trait Implementations§

impl Freeze for Html

impl RefUnwindSafe for Html

impl Send for Html

impl Sync for Html

impl Unpin for Html

impl UnsafeUnpin for Html

impl UnwindSafe for Html

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> CloneToUninit for T
where T: Clone,

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dest. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T, U> Into<U> for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> Pointable for T

const ALIGN: usize

The alignment of pointer.

type Init = T

The type for initializers.

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T> ToString for T
where T: Display + ?Sized,

fn to_string(&self) -> String

Converts the given value to a String. Read more

impl<T, U> TryFrom<U> for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,