Enum cpclib_asm::parser::LocatedToken

source · [−]

pub enum LocatedToken {
Show 21 variants    Standard {
        token: Token,
        span: Z80Span,
    },
    Defb(Vec<LocatedExpr>, Z80Span),
    Defw(Vec<LocatedExpr>, Z80Span),
    CrunchedSection(CrunchType, LocatedListing, Z80Span),
    Str(Vec<LocatedExpr>, Z80Span),
    For {
        label: Z80Span,
        start: LocatedExpr,
        stop: LocatedExpr,
        step: Option<LocatedExpr>,
        listing: LocatedListing,
        span: Z80Span,
    },
    Function(Z80Span, Vec<Z80Span>, LocatedListing, Z80Span),
    Include(Z80Span, Option<Z80Span>, bool, Z80Span),
    Incbin {
        fname: Z80Span,
        offset: Option<LocatedExpr>,
        length: Option<LocatedExpr>,
        extended_offset: Option<LocatedExpr>,
        off: bool,
        transformation: BinaryTransformation,
        span: Z80Span,
    },
    If(Vec<(LocatedTestKind, LocatedListing)>, Option<LocatedListing>, Z80Span),
    Label(Z80Span),
    Macro {
        name: Z80Span,
        params: Vec<Z80Span>,
        content: Z80Span,
        span: Z80Span,
    },
    MacroCall(Z80Span, Vec<LocatedMacroParam>, Z80Span),
    Repeat(LocatedExpr, LocatedListing, Option<Z80Span>, Option<LocatedExpr>, Z80Span),
    Iterate(Z80Span, Either<Vec<LocatedExpr>, LocatedExpr>, LocatedListing, Z80Span),
    RepeatUntil(LocatedExpr, LocatedListing, Z80Span),
    Rorg(LocatedExpr, LocatedListing, Z80Span),
    Struct(Z80Span, Vec<(Z80Span, LocatedToken)>, Z80Span),
    Switch(LocatedExpr, Vec<(LocatedExpr, LocatedListing, bool)>, Option<LocatedListing>, Z80Span),
    While(LocatedExpr, LocatedListing, Z80Span),
    Module(Z80Span, LocatedListing, Z80Span),
}

Expand description

Add span information for a Token. This hierarchy is a mirror of the original token one

Variants

`Standard`

Fields

token: Token

The original token without any span information

span: Z80Span

The span that correspond to the token

A token without any listing embedding

`Defb(Vec<LocatedExpr>, Z80Span)`

`Defw(Vec<LocatedExpr>, Z80Span)`

`CrunchedSection(CrunchType, LocatedListing, Z80Span)`

`Str(Vec<LocatedExpr>, Z80Span)`

`For`

Fields

label: Z80Span

start: LocatedExpr

stop: LocatedExpr

step: Option<LocatedExpr>

listing: LocatedListing

span: Z80Span

`Function(Z80Span, Vec<Z80Span>, LocatedListing, Z80Span)`

`Include(Z80Span, Option<Z80Span>, bool, Z80Span)`

`Incbin`

Fields

fname: Z80Span

offset: Option<LocatedExpr>

length: Option<LocatedExpr>

extended_offset: Option<LocatedExpr>

off: bool

transformation: BinaryTransformation

span: Z80Span

`If(Vec<(LocatedTestKind, LocatedListing)>, Option<LocatedListing>, Z80Span)`

`Label(Z80Span)`

`Macro`

Fields

name: Z80Span

params: Vec<Z80Span>

content: Z80Span

span: Z80Span

`MacroCall(Z80Span, Vec<LocatedMacroParam>, Z80Span)`

Name, Parameters, FullSpan

`Repeat(LocatedExpr, LocatedListing, Option<Z80Span>, Option<LocatedExpr>, Z80Span)`

`Iterate(Z80Span, Either<Vec<LocatedExpr>, LocatedExpr>, LocatedListing, Z80Span)`

`RepeatUntil(LocatedExpr, LocatedListing, Z80Span)`

`Rorg(LocatedExpr, LocatedListing, Z80Span)`

`Struct(Z80Span, Vec<(Z80Span, LocatedToken)>, Z80Span)`

Name, Parameters, FullSpan

`Switch(LocatedExpr, Vec<(LocatedExpr, LocatedListing, bool)>, Option<LocatedListing>, Z80Span)`

`While(LocatedExpr, LocatedListing, Z80Span)`

`Module(Z80Span, LocatedListing, Z80Span)`

Implementations

impl LocatedToken

pub fn token(&self) -> Result<&Token, ()>

We can obtain a token only for “standard ones”. Those that rely on listing need to be handled differently

pub fn context(&self) -> &ParserContext

impl LocatedToken

pub fn to_token(&self) -> Cow<'_, Token>

Transform the located token in a raw token. Warning, this is quite costly when strings or vec are involved

pub fn parse_token(_value: &str) -> Result<(), String>

Trait Implementations

impl Clone for LocatedToken

fn clone(&self) -> Self

Returns a copy 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 LocatedToken

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

Formats the value using the given formatter. Read more

impl Display for LocatedToken

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

Formats the value using the given formatter. Read more

impl ListingElement for LocatedToken

type Expr = LocatedExpr

type MacroParam = LocatedMacroParam

type TestKind = LocatedTestKind

fn mnemonic(&self) -> Option<&Mnemonic>

fn mnemonic_arg1(&self) -> Option<&DataAccess>

fn mnemonic_arg2(&self) -> Option<&DataAccess>

fn mnemonic_arg1_mut(&mut self) -> Option<&mut DataAccess>

fn mnemonic_arg2_mut(&mut self) -> Option<&mut DataAccess>

fn is_directive(&self) -> bool

fn is_rorg(&self) -> bool

fn rorg_listing(&self) -> &[Self]ⓘNotable traits for &'_ [u8 ]`impl<'_> Read for &'_ [u8]impl<'_> Write for &'_ mut [u8]`

fn rorg_expr(&self) -> &Self::Expr

fn is_iterate(&self) -> bool

fn iterate_listing(&self) -> &[Self]ⓘNotable traits for &'_ [u8 ]`impl<'_> Read for &'_ [u8]impl<'_> Write for &'_ mut [u8]`

fn iterate_counter_name(&self) -> &str

fn iterate_values(&self) -> Either<&Vec<Self::Expr>, &Self::Expr>

fn is_for(&self) -> bool

fn for_listing(&self) -> &[Self]ⓘNotable traits for &'_ [u8 ]`impl<'_> Read for &'_ [u8]impl<'_> Write for &'_ mut [u8]`

fn for_label(&self) -> &str

fn for_start(&self) -> &Self::Expr

fn for_stop(&self) -> &Self::Expr

fn for_step(&self) -> Option<&Self::Expr>

fn is_repeat_until(&self) -> bool

fn repeat_until_listing(&self) -> &[Self]ⓘNotable traits for &'_ [u8 ]`impl<'_> Read for &'_ [u8]impl<'_> Write for &'_ mut [u8]`

fn repeat_until_condition(&self) -> &Self::Expr

fn is_repeat(&self) -> bool

fn repeat_listing(&self) -> &[Self]ⓘNotable traits for &'_ [u8 ]`impl<'_> Read for &'_ [u8]impl<'_> Write for &'_ mut [u8]`

fn repeat_count(&self) -> &Self::Expr

fn repeat_counter_name(&self) -> Option<&str>

fn repeat_counter_start(&self) -> Option<&Self::Expr>

fn is_macro_definition(&self) -> bool

fn macro_definition_name(&self) -> &str

fn macro_definition_arguments(&self) -> SmallVec<[&str ; 4]>

fn macro_definition_code(&self) -> &str

fn macro_call_name(&self) -> &str

fn macro_call_arguments(&self) -> &[Self::MacroParam ]

fn is_if(&self) -> bool

fn if_nb_tests(&self) -> usize

fn if_test(&self, idx: usize) -> (&Self::TestKind, &[Self])

fn if_else(&self) -> Option<&[Self]>

fn is_include(&self) -> bool

fn is_incbin(&self) -> bool

fn incbin_fname(&self) -> &str

fn incbin_offset(&self) -> Option<&Self::Expr>

fn incbin_length(&self) -> Option<&Self::Expr>

fn incbin_transformation(&self) -> &BinaryTransformation

fn include_fname(&self) -> &str

fn include_namespace(&self) -> Option<&str>

fn include_once(&self) -> bool

fn is_call_macro_or_build_struct(&self) -> bool

fn is_function_definition(&self) -> bool

fn function_definition_name(&self) -> &str

fn function_definition_params(&self) -> SmallVec<[&str ; 4]>

fn function_definition_inner(&self) -> &[Self]ⓘNotable traits for &'_ [u8 ]`impl<'_> Read for &'_ [u8]impl<'_> Write for &'_ mut [u8]`

fn is_crunched_section(&self) -> bool

fn crunched_section_listing(&self) -> &[Self]ⓘNotable traits for &'_ [u8 ]`impl<'_> Read for &'_ [u8]impl<'_> Write for &'_ mut [u8]`

fn crunched_section_kind(&self) -> &CrunchType

impl MayHaveSpan for LocatedToken

fn span(&self) -> &Z80Span

Get the span of the current token

fn has_span(&self) -> bool

fn possible_span(&self) -> Option<&Z80Span>

impl ParsingStateVerified for LocatedToken

fn is_accepted(&self, state: &ParsingState) -> bool

impl ReturnExpr for LocatedToken

fn return_expr(&self) -> Option<&Expr>

impl ToSimpleToken for LocatedToken

fn as_simple_token(&self) -> Cow<'_, Token>

Convert the token in its simplest form

impl TokenExt for LocatedToken

fn estimated_duration(&self) -> Result<usize, AssemblerError>

fn unroll(&self, _env: &Env) -> Option<Result<Vec<&Self>, AssemblerError>>

Unroll the tokens when it represents a loop

fn disassemble_data(&self) -> Result<Listing, String>

Generate the listing of opcodes for directives that embed bytes

fn to_bytes_with_options(
&self,
_option: &AssemblingOptions
) -> Result<Vec<u8>, AssemblerError>

fn number_of_bytes(&self) -> Result<usize, String>

fn number_of_bytes_with_context(
&self,
table: &mut SymbolsTableCaseDependent
) -> Result<usize, String>

Return the number of bytes of the token given the provided context

fn to_bytes(&self) -> Result<Vec<u8>, AssemblerError>

Dummy version that assemble without taking into account the context TODO find a way to not build a symbol table each time Read more

fn to_bytes_with_context(
&self,
table: &mut SymbolsTableCaseDependent
) -> Result<Vec<u8>, AssemblerError>

Assemble the symbol taking into account some context, but never modify this context

fn is_valid(&self) -> bool

Check if the token is valid. We consider a token vlaid if it is possible to assemble it

impl Visited for LocatedToken

fn visited(&self, env: &mut Env) -> Result<(), AssemblerError>

Make all the necessary for the given token

Auto Trait Implementations

impl RefUnwindSafe for LocatedToken

impl Send for LocatedToken

impl Sync for LocatedToken

impl Unpin for LocatedToken

impl UnwindSafe for LocatedToken

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,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

impl<T> Conv for T

fn conv<T>(self) -> T where
Self: Into<T>,

Converts self into T using Into<T>. Read more

impl<T> FmtForward for T

fn fmt_binary(self) -> FmtBinary<Self> where
Self: Binary,

Causes self to use its Binary implementation when Debug-formatted. Read more

fn fmt_display(self) -> FmtDisplay<Self> where
Self: Display,

Causes self to use its Display implementation when Debug-formatted. Read more

fn fmt_lower_exp(self) -> FmtLowerExp<Self> where
Self: LowerExp,

Causes self to use its LowerExp implementation when Debug-formatted. Read more

fn fmt_lower_hex(self) -> FmtLowerHex<Self> where
Self: LowerHex,

Causes self to use its LowerHex implementation when Debug-formatted. Read more

fn fmt_octal(self) -> FmtOctal<Self> where
Self: Octal,

Causes self to use its Octal implementation when Debug-formatted. Read more

fn fmt_pointer(self) -> FmtPointer<Self> where
Self: Pointer,

Causes self to use its Pointer implementation when Debug-formatted. Read more

fn fmt_upper_exp(self) -> FmtUpperExp<Self> where
Self: UpperExp,

Causes self to use its UpperExp implementation when Debug-formatted. Read more

fn fmt_upper_hex(self) -> FmtUpperHex<Self> where
Self: UpperHex,

Causes self to use its UpperHex implementation when Debug-formatted. Read more

fn fmt_list(self) -> FmtList<Self> where
&'a Self: for<'a> IntoIterator,

Formats each item in a sequence. Read more

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

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

const: unstable · source

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> Pipe for T where
T: ?Sized,

fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> R

Pipes by value. This is generally the method you want to use. Read more

fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> R where
R: 'a,

Borrows self and passes that borrow into the pipe function. Read more

fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> R where
R: 'a,

Mutably borrows self and passes that borrow into the pipe function. Read more

fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R where
    Self: Borrow<B>,
    B: 'a + ?Sized,
    R: 'a,

Borrows self, then passes self.borrow() into the pipe function. Read more

fn pipe_borrow_mut<'a, B, R>(
    &'a mut self,
    func: impl FnOnce(&'a mut B) -> R
) -> R where
    Self: BorrowMut<B>,
    B: 'a + ?Sized,
    R: 'a,

Mutably borrows self, then passes self.borrow_mut() into the pipe function. Read more

fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R where
    Self: AsRef<U>,
    U: 'a + ?Sized,
    R: 'a,

Borrows self, then passes self.as_ref() into the pipe function.

fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R where
    Self: AsMut<U>,
    U: 'a + ?Sized,
    R: 'a,

Mutably borrows self, then passes self.as_mut() into the pipe function. Read more

fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R where
    Self: Deref<Target = T>,
    T: 'a + ?Sized,
    R: 'a,

Borrows self, then passes self.deref() into the pipe function.

fn pipe_deref_mut<'a, T, R>(
    &'a mut self,
    func: impl FnOnce(&'a mut T) -> R
) -> R where
    Self: DerefMut<Target = T> + Deref,
    T: 'a + ?Sized,
    R: 'a,

Mutably borrows self, then passes self.deref_mut() into the pipe function. Read more

impl<T> Pointable for T

const ALIGN: usize = mem::align_of::()

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> Tap for T

fn tap(self, func: impl FnOnce(&Self)) -> Self

Immutable access to a value. Read more

fn tap_mut(self, func: impl FnOnce(&mut Self)) -> Self

Mutable access to a value. Read more

fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self where
Self: Borrow<B>,
B: ?Sized,

Immutable access to the Borrow<B> of a value. Read more

fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self where
Self: BorrowMut<B>,
B: ?Sized,

Mutable access to the BorrowMut<B> of a value. Read more

fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self where
Self: AsRef<R>,
R: ?Sized,

Immutable access to the AsRef<R> view of a value. Read more

fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self where
Self: AsMut<R>,
R: ?Sized,

Mutable access to the AsMut<R> view of a value. Read more

fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self where
Self: Deref<Target = T>,
T: ?Sized,

Immutable access to the Deref::Target of a value. Read more

fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self where
Self: DerefMut<Target = T> + Deref,
T: ?Sized,

Mutable access to the Deref::Target of a value. Read more

fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self

Calls .tap() only in debug builds, and is erased in release builds.

fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self

Calls .tap_mut() only in debug builds, and is erased in release builds. Read more

fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self where
Self: Borrow<B>,
B: ?Sized,

Calls .tap_borrow() only in debug builds, and is erased in release builds. Read more

fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self where
Self: BorrowMut<B>,
B: ?Sized,

Calls .tap_borrow_mut() only in debug builds, and is erased in release builds. Read more

fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self where
Self: AsRef<R>,
R: ?Sized,

Calls .tap_ref() only in debug builds, and is erased in release builds. Read more

fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self where
Self: AsMut<R>,
R: ?Sized,

Calls .tap_ref_mut() only in debug builds, and is erased in release builds. Read more

fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self where
Self: Deref<Target = T>,
T: ?Sized,

Calls .tap_deref() only in debug builds, and is erased in release builds. Read more

fn tap_deref_mut_dbg<T>(self, func: impl FnOnce(&mut T)) -> Self where
Self: DerefMut<Target = T> + Deref,
T: ?Sized,

Calls .tap_deref_mut() only in debug builds, and is erased in release builds. 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)

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

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

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

default fn to_string(&self) -> String

Converts the given value to a String. Read more

impl<T> TryConv for T

fn try_conv<T>(self) -> Result<T, Self::Error> where
Self: TryInto<T>,

Attempts to convert self into T using TryInto<T>. 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.

const: unstable · source

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.

const: unstable · source

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

Performs the conversion.