Enum cpclib_asm::preamble::Token

pub enum Token {
    Align(Expr, Option<Expr>),
    Assert(Expr, Option<String>),
    Bank(Expr),
    Bankset(Expr),
    Basic(Option<Vec<String>>, Option<Vec<u16>>, String),
    Break,
    Breakpoint(Option<Expr>),
    BuildCpr,
    BuildSna(SnapshotVersion),
    Comment(String),
    CrunchedBinary(CrunchType, String),
    CrunchedSection(CrunchType, BaseListing<Token>),
    Defb(Vec<Expr>),
    Defs(Expr, Option<Expr>),
    Defw(Vec<Expr>),
    Equ(String, Expr),
    If(Vec<(TestKind, BaseListing<Token>)>, Option<BaseListing<Token>>),
    Incbin(String, Option<Expr>, Option<Expr>, Option<Expr>, Option<Expr>, Option<Vec<u8>>, BinaryTransformation),
    Include(String, Option<BaseListing<Token>>),
    Label(String),
    Let(String, Expr),
    Limit(Expr),
    List,
    Macro(String, Vec<String>, String),
    MacroCall(String, Vec<Expr>),
    NoList,
    OpCode(Mnemonic, Option<DataAccess>, Option<DataAccess>),
    Org(Expr, Option<Expr>),
    Print(Vec<FormattedExpr>),
    Protect(Expr, Expr),
    Repeat(Expr, BaseListing<Token>, Option<String>),
    RepeatUntil(Expr, BaseListing<Token>),
    Rorg(Expr, BaseListing<Token>),
    Run(Expr, Option<Expr>),
    Save {
        filename: String,
        address: Expr,
        size: Expr,
        save_type: Option<SaveType>,
        dsk_filename: Option<String>,
        side: Option<Expr>,
    },
    SetCPC(Expr),
    SetCrtc(Expr),
    StableTicker(StableTickerAction),
    Str(Vec<u8>),
    Struct(String, Vec<(String, Token)>),
    Switch(Vec<(Expr, BaseListing<Token>)>),
    Undef(String),
    While(Expr, BaseListing<Token>),
}

Variants

Align(Expr, Option<Expr>)

Assert(Expr, Option<String>)

Bank(Expr)

Bankset(Expr)

Basic(Option<Vec<String>>, Option<Vec<u16>>, String)

Basic code which tokens will be included in the code (imported variables, lines to hide, code)

Break

Breakpoint(Option<Expr>)

BuildCpr

BuildSna(SnapshotVersion)

Comment(String)

CrunchedBinary(CrunchType, String)

CrunchedSection(CrunchType, BaseListing<Token>)

Defb(Vec<Expr>)

Defs(Expr, Option<Expr>)

Defw(Vec<Expr>)

Equ(String, Expr)

If(Vec<(TestKind, BaseListing<Token>)>, Option<BaseListing<Token>>)

Conditional expression. _0 contains all the expression and the appropriate code, _1 contains the else case

Incbin(String, Option<Expr>, Option<Expr>, Option<Expr>, Option<Expr>, Option<Vec<u8>>, BinaryTransformation)

Include of an asm file _0 contains the name of the file, _1 contains the content of the file. It is not loaded at the creation of the Token because there is not enough context to know where to load file

Include(String, Option<BaseListing<Token>>)

Label(String)

Let(String, Expr)

Limit(Expr)

List

Macro(String, Vec<String>, String)

MacroCall(String, Vec<Expr>)

NoList

OpCode(Mnemonic, Option<DataAccess>, Option<DataAccess>)

Org(Expr, Option<Expr>)

Print(Vec<FormattedExpr>)

Protect(Expr, Expr)

Repeat(Expr, BaseListing<Token>, Option<String>)

Duplicate the token stream

RepeatUntil(Expr, BaseListing<Token>)

Rorg(Expr, BaseListing<Token>)

Set the value of $ to Expr

Run(Expr, Option<Expr>)

Save

Fields of Save

filename: Stringaddress: Exprsize: Exprsave_type: Option<SaveType>dsk_filename: Option<String>side: Option<Expr>

SetCPC(Expr)

SetCrtc(Expr)

StableTicker(StableTickerAction)

Str(Vec<u8>)

Struct(String, Vec<(String, Token)>)

Switch(Vec<(Expr, BaseListing<Token>)>)

Undef(String)

While(Expr, BaseListing<Token>)

Methods

impl Token

pub fn is_opcode(&self) -> bool

pub fn label(&self) -> Option<&String>

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

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

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

pub fn org_expr(&self) -> Option<&Expr>

Deprecated since 0.1.1:

please use expr instead as other token need it

pub fn expr(&self) -> Option<&Expr>

Trait Implementations

impl Clone for Token

fn clone(&self) -> Token

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Token

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

Formats the value using the given formatter.

impl Display for Token

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

Formats the value using the given formatter.

impl Eq for Token

impl From<u8> for Token

fn from(byte: u8) -> Token

Performs the conversion.

impl ListingElement for Token

impl PartialEq<Token> for Token

fn eq(&self, other: &Token) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Token) -> bool

This method tests for !=.

impl StructuralEq for Token

impl StructuralPartialEq for Token

impl TokenExt for Token

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

Unroll the tokens when in a repetition loop TODO return an iterator in order to not produce the vector each time

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

Generate the listing of opcodes for directives that contain data Defb/defw/Defs in order to have mnemonics. Fails when some values are not opcodes

fn read_referenced_file(
    &mut self,
    ctx: &ParserContext
) -> Result<(), AssemblerError>

Modify the few tokens that need to read files TODO refactor file reading of filename search

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

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

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

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

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

Returns an estimation of the duration. This estimation may be wrong for instruction having several states.

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

Return the number of bytes of the token

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 is_valid(&self) -> bool

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

impl<'_> TokenTryFrom<&'_ str> for Token

fn try_from(value: &str) -> Result<Self, String>

impl TokenTryFrom<String> for Token

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