[−][src]Struct syntect::parsing::SyntaxSetBuilder
A syntax set builder is used for loading syntax definitions from the file
system or by adding SyntaxDefinition
objects.
Once all the syntaxes have been added, call build
to turn the builder into
a SyntaxSet
that can be used for parsing or highlighting.
Implementations
impl SyntaxSetBuilder
[src]
pub fn new() -> SyntaxSetBuilder
[src]
pub fn add(&mut self, syntax: SyntaxDefinition)
[src]
Add a syntax to the set.
pub fn add_plain_text_syntax(&mut self)
[src]
Rarely useful method that loads in a syntax with no highlighting rules for plain text.
Exists mainly for adding the plain text syntax to syntax set dumps, because for some
reason the default Sublime plain text syntax is still in .tmLanguage
format.
pub fn add_from_folder<P: AsRef<Path>>(
&mut self,
folder: P,
lines_include_newline: bool
) -> Result<(), LoadingError>
[src]
&mut self,
folder: P,
lines_include_newline: bool
) -> Result<(), LoadingError>
Loads all the .sublime-syntax files in a folder into this builder.
The lines_include_newline
parameter is used to work around the fact that Sublime Text normally
passes line strings including newline characters (\n
) to its regex engine. This results in many
syntaxes having regexes matching \n
, which doesn't work if you don't pass in newlines.
It is recommended that if you can you pass in lines with newlines if you can and pass true
for this parameter.
If that is inconvenient pass false
and the loader will do some hacky find and replaces on the
match regexes that seem to work for the default syntax set, but may not work for any other syntaxes.
In the future I might include a "slow mode" that copies the lines passed in and appends a newline if there isn't one. but in the interest of performance currently this hacky fix will have to do.
pub fn build(self) -> SyntaxSet
[src]
Build a SyntaxSet
from the syntaxes that have been added to this
builder.
Linking
The contexts in syntaxes can reference other contexts in the same syntax or even other syntaxes. For example, a HTML syntax can reference a CSS syntax so that CSS blocks in HTML work as expected.
Those references work in various ways and involve one or two lookups. To avoid having to do these lookups during parsing/highlighting, the references are changed to directly reference contexts via index. That's called linking.
Linking is done in this build step. So in order to get the best
performance, you should try to avoid calling this too much. Ideally,
create a SyntaxSet
once and then use it many times. If you can,
serialize a SyntaxSet
for your program and when you run the program,
directly load the SyntaxSet
.
Trait Implementations
impl Clone for SyntaxSetBuilder
[src]
fn clone(&self) -> SyntaxSetBuilder
[src]
fn clone_from(&mut self, source: &Self)
1.0.0[src]
impl Default for SyntaxSetBuilder
[src]
fn default() -> SyntaxSetBuilder
[src]
Auto Trait Implementations
impl !RefUnwindSafe for SyntaxSetBuilder
impl Send for SyntaxSetBuilder
impl Sync for SyntaxSetBuilder
impl Unpin for SyntaxSetBuilder
impl UnwindSafe for SyntaxSetBuilder
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> ToOwned for T where
T: Clone,
[src]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
fn to_owned(&self) -> T
[src]
fn clone_into(&self, target: &mut T)
[src]
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
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>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,