Struct texlang::vm::VM

pub struct VM<S> {
    pub state: S,
    pub commands_map: Map<S>,
    pub working_directory: Option<PathBuf>,
    /* private fields */
}

The Texlang virtual machine.

Fields

state: S

The state

commands_map: Map<S>

The commands map

working_directory: Option<PathBuf>

The working directory which is used as the root for relative file paths

This is None if the working directory could not be determined.

Implementations

impl<S: TexlangState> VM<S>

pub fn run<H: Handlers<S>>(&mut self) -> Result<(), Box<Error>>

Run the VM.

It is assumed that the VM has been preloaded with TeX source code using the VM::push_source method.

impl<S: Default> VM<S>

pub fn new_with_built_in_commands( built_in_commands: HashMap<&str, BuiltIn<S>> ) -> VM<S>

Create a new VM with the provided built-in commands.

If the state type satisfies the HasDefaultBuiltInCommands trait, and you are using the default built-ins, use the VM::new method instead.

impl<S: Default + HasDefaultBuiltInCommands> VM<S>

pub fn new() -> VM<S>

Create a new VM.

impl<'de, S: Deserialize<'de>> VM<S>

Deserialize a Texlang VM using the provided built-in commands.

If the state type satisfies the HasDefaultBuiltInCommands trait, and you are deserializing using the default built-ins, you don’t need to use this function. You can use the serde deserialize trait directly. See the serde submodule for more information on deserialization.

pub fn deserialize_with_built_in_commands<D: Deserializer<'de>>( deserializer: D, built_in_commands: HashMap<&str, BuiltIn<S>> ) -> Result<Self, D::Error>

impl<S: TexlangState> VM<S>

pub fn push_source<T1: Into<PathBuf>, T2: Into<String>>( &mut self, file_name: T1, source_code: T2 ) -> Result<(), Box<Error>>

Add new source code to the VM.

TeX input source code is organized as a stack. Pushing source code onto the stack will mean it is executed first.

impl<S> VM<S>

pub fn clear_sources(&mut self)

Clear all source code from the VM.

pub fn get_commands_as_map_slow(&self) -> HashMap<String, BuiltIn<S>>

Return a regular hash map with all the commands as they are currently defined.

This function is extremely slow and is only intended to be invoked on error paths.

pub fn cs_name_interner(&self) -> &CsNameInterner

Return a reference to the control sequence name string interner.

This interner can be used to resolve CsName types into regular strings.

pub fn trace(&self, token: Token) -> SourceCodeTrace

pub fn trace_end_of_input(&self) -> SourceCodeTrace

pub fn num_current_sources(&self) -> usize

Returns the number of current sources on the source stack

Trait Implementations

impl<S: Default + HasDefaultBuiltInCommands> Default for VM<S>

fn default() -> Self

Returns the “default value” for a type.

impl<'de, S: Deserialize<'de> + HasDefaultBuiltInCommands> Deserialize<'de> for VM<S>

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

Deserialize this value from the given Serde deserializer.

impl<State: Serialize> Serialize for VM<State>

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

Serialize this value into the given Serde serializer.