Enum texlang::types::CatCode

pub enum CatCode {
    Escape = 0,
    BeginGroup = 1,
    EndGroup = 2,
    MathShift = 3,
    AlignmentTab = 4,
    EndOfLine = 5,
    Parameter = 6,
    Superscript = 7,
    Subscript = 8,
    Ignored = 9,
    Space = 10,
    Letter = 11,
    Other = 12,
    Active = 13,
    Comment = 14,
    Invalid = 15,
}

Enum representing all 16 category codes in TeX.

Each variant’s documentation contains an example character which is mapped to that category code in plainTeX.

Variants

Escape = 0

Marks the beginning of a control sequence. Example: \.

This category code is never seen outside of the lexer.

BeginGroup = 1

Begins a new group. Example: {.

EndGroup = 2

Ends an existing new group. Example: }.

MathShift = 3

Starts or ends math mode. Example: $.

AlignmentTab = 4

Used in typesetting tables to align cells. Example: &.

EndOfLine = 5

Marks a new line in the input. Example: \n.

This code behaves similarly to Space, but has two additional properties. First, two or more consecutive new lines, modulo intervening Space characters, create a \par control sequence instead of a regular space. Second, this code terminates a comment that started with a Comment character.

This category code is never seen outside of the lexer.

Parameter = 6

Marks the beginning of a parameter number. It must generally be followed by a digit. Example: #.

Superscript = 7

Puts following character or group in a superscript. Example: ^.

Subscript = 8

Puts following character or group in a subscript. Example: _.

Ignored = 9

Character that is ignored by the lexer. Example: ASCII null (0).

This category code is never seen outside of the lexer.

Space = 10

Whitespace. Example: .

Letter = 11

A character that can be used as a control sequence name. Examples: [a-zA-z].

Other = 12

A character than cannot be used as a control sequence name. Example: @.

Active = 13

A single character that behaves like a control sequence. Example: ~.

Comment = 14

Marks the beginning of a comment. All characters until the next EndOfLine are ignored. Example: %.

This category code is never seen outside of the lexer.

Invalid = 15

An invalid character. If this is encountered in the input, the lexer will return an error. Example: ASCII delete (127).

This category code is never seen outside of the lexer.

Implementations

impl CatCode

pub const INITEX_DEFAULTS: [CatCode; 128] = _

Default category codes in INITEX for all ASCII characters.

To find the category code for an ASCII character, convert it to an integer and use it as an index for the array.

This list was compiled by reading the source code TeX ’82, specifically section 232 in the “TeX: the program”. These defaults are also described in the TeXBook p343.

pub const PLAIN_TEX_DEFAULTS: [CatCode; 128] = _

Default category codes in plainTeX for all ASCII characters.

To find the category code for an ASCII character, convert it to an integer and use it as an index for the array.

This list was compiled by starting with INITEX_DEFAULTS and then applying all category code changes in the plainTeX format. These changes are described on p343 of the TeXBook.

Trait Implementations

impl Clone for CatCode

fn clone(&self) -> CatCode

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CatCode

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

Formats the value using the given formatter.

impl Default for CatCode

fn default() -> CatCode

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for CatCode

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for CatCode

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

Formats the value using the given formatter.

impl<S: TexlangState> Parsable<S> for CatCode

fn parse_impl(input: &mut ExpandedStream<S>) -> Result<Self>

Parses a value from the vm::ExpandedStream.

fn parse<I>(input: &mut I) -> Result<Self>

where I: AsMut<ExpandedStream<S>>,

Parses a value from an input stream.

impl PartialEq for CatCode

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

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl SupportedType for CatCode

fn new_command<S>( ref_fn: RefFn<S, Self>, ref_mut_fn: MutRefFn<S, Self>, index_resolver: Option<IndexResolver<S>>, ) -> Command<S>

Create a new command of this type with the provided reference functions and index resolver.

fn update_save_stack<S>( input: &mut ExecutionInput<S>, variable: &TypedVariable<S, Self>, scope: Scope, overwritten_value: Self, )

Update the VM’s save stack after a variable assignment.

fn new_typed_variable<S>( command: &Command<S>, index: Index, ) -> Option<TypedVariable<S, Self>>

Create a new typed variable of this type from the getters in the command and the provided index.

fn try_cast<S>( command: &Command<S>, ) -> Option<(RefFn<S, Self>, MutRefFn<S, Self>)>

Try to cast a variable command to this type.

fn recycle<S>(input: &mut ExecutionInput<S>, overwritten_value: Self)

Recycle a value that’s about to be dropped.

impl TryFrom<u8> for CatCode

type Error = ()

The type returned in the event of a conversion error.

fn try_from(value: u8) -> Result<Self, Self::Error>

Performs the conversion.

impl Copy for CatCode

impl Eq for CatCode

impl StructuralPartialEq for CatCode