Struct Codebase

pub struct Codebase { /* private fields */ }

Codebase. A struct that holds all your code in memory (codespan forces this)

Implementations

impl Codebase

pub fn new() -> Self

Create a new codebase.

Examples found in repository

examples/simple_c_lexer.rs (line 12)

pub fn main() {
    let args = std::env::args().collect::<Vec<_>>();
    if args.len() != 2 {
        eprintln!("Usage: cargo run --example simple_c_lexer -- sample.c");
        return;
    }

    let code = std::fs::read_to_string(&args[1]).unwrap();
    let mut codebase = Codebase::new();
    let key = codebase.add(args[1].clone(), code);

    let mut reader = TokenReader::new(codebase.get(key).unwrap().source().clone());
    while let Some(char) = reader.next_char() {
        if chars::is_digit(char) {
            // * Number
            println!("Number {}", reader.next_token(chars::is_digit, char));
        } else if chars::is_ident_start(char) {
            // * Identifier
            println!(
                "Ident {}",
                reader.next_token(chars::is_ident_continue, char)
            );
        } else if char == '"' {
            // * String
            let mut string = String::new();
            loop {
                match reader.next_char() {
                    // Escape sequences
                    Some('\\') => match reader.next_char() {
                        Some('n') => string.push('\n'),
                        Some(char) => string.push(char),
                        None => codebase.emit( // Technically won't happen
                            Diagnostic::error()
                                .with_message("expected escape code")
                                .with_labels(vec![Label::primary(
                                    key,
                                    reader.cursor..reader.cursor + 1,
                                )
                                .with_message("here")]),
                        ),
                    },

                    // Quote
                    Some('"') => break,

                    // Char
                    Some(char) if char != '\n' => string.push(char),
                    _ => {
                        codebase.emit(
                            Diagnostic::error()
                                .with_message("unterminated string")
                                .with_labels(vec![Label::primary(
                                    key,
                                    reader.cursor..reader.cursor + 1,
                                )
                                .with_message("here")]),
                        );
                        break;
                    }
                }
            }
            println!("String {:?}", string);
        } else if ['(', ')', '{', '}', ';'].contains(&char) {
            // * Operator
            println!("Operator {}", char);
        }
    }
}

pub fn add(&mut self, name: String, source: String) -> usize

Add a file to the codebase, returning the handle that can be used to refer to it again.

Examples found in repository

examples/simple_c_lexer.rs (line 13)

pub fn main() {
    let args = std::env::args().collect::<Vec<_>>();
    if args.len() != 2 {
        eprintln!("Usage: cargo run --example simple_c_lexer -- sample.c");
        return;
    }

    let code = std::fs::read_to_string(&args[1]).unwrap();
    let mut codebase = Codebase::new();
    let key = codebase.add(args[1].clone(), code);

    let mut reader = TokenReader::new(codebase.get(key).unwrap().source().clone());
    while let Some(char) = reader.next_char() {
        if chars::is_digit(char) {
            // * Number
            println!("Number {}", reader.next_token(chars::is_digit, char));
        } else if chars::is_ident_start(char) {
            // * Identifier
            println!(
                "Ident {}",
                reader.next_token(chars::is_ident_continue, char)
            );
        } else if char == '"' {
            // * String
            let mut string = String::new();
            loop {
                match reader.next_char() {
                    // Escape sequences
                    Some('\\') => match reader.next_char() {
                        Some('n') => string.push('\n'),
                        Some(char) => string.push(char),
                        None => codebase.emit( // Technically won't happen
                            Diagnostic::error()
                                .with_message("expected escape code")
                                .with_labels(vec![Label::primary(
                                    key,
                                    reader.cursor..reader.cursor + 1,
                                )
                                .with_message("here")]),
                        ),
                    },

                    // Quote
                    Some('"') => break,

                    // Char
                    Some(char) if char != '\n' => string.push(char),
                    _ => {
                        codebase.emit(
                            Diagnostic::error()
                                .with_message("unterminated string")
                                .with_labels(vec![Label::primary(
                                    key,
                                    reader.cursor..reader.cursor + 1,
                                )
                                .with_message("here")]),
                        );
                        break;
                    }
                }
            }
            println!("String {:?}", string);
        } else if ['(', ')', '{', '}', ';'].contains(&char) {
            // * Operator
            println!("Operator {}", char);
        }
    }
}

pub fn get(&self, file_id: usize) -> Result<&SimpleFile<String, Rc<str>>, Error>

Get the file corresponding to the given id.

Examples found in repository

examples/simple_c_lexer.rs (line 15)

pub fn main() {
    let args = std::env::args().collect::<Vec<_>>();
    if args.len() != 2 {
        eprintln!("Usage: cargo run --example simple_c_lexer -- sample.c");
        return;
    }

    let code = std::fs::read_to_string(&args[1]).unwrap();
    let mut codebase = Codebase::new();
    let key = codebase.add(args[1].clone(), code);

    let mut reader = TokenReader::new(codebase.get(key).unwrap().source().clone());
    while let Some(char) = reader.next_char() {
        if chars::is_digit(char) {
            // * Number
            println!("Number {}", reader.next_token(chars::is_digit, char));
        } else if chars::is_ident_start(char) {
            // * Identifier
            println!(
                "Ident {}",
                reader.next_token(chars::is_ident_continue, char)
            );
        } else if char == '"' {
            // * String
            let mut string = String::new();
            loop {
                match reader.next_char() {
                    // Escape sequences
                    Some('\\') => match reader.next_char() {
                        Some('n') => string.push('\n'),
                        Some(char) => string.push(char),
                        None => codebase.emit( // Technically won't happen
                            Diagnostic::error()
                                .with_message("expected escape code")
                                .with_labels(vec![Label::primary(
                                    key,
                                    reader.cursor..reader.cursor + 1,
                                )
                                .with_message("here")]),
                        ),
                    },

                    // Quote
                    Some('"') => break,

                    // Char
                    Some(char) if char != '\n' => string.push(char),
                    _ => {
                        codebase.emit(
                            Diagnostic::error()
                                .with_message("unterminated string")
                                .with_labels(vec![Label::primary(
                                    key,
                                    reader.cursor..reader.cursor + 1,
                                )
                                .with_message("here")]),
                        );
                        break;
                    }
                }
            }
            println!("String {:?}", string);
        } else if ['(', ')', '{', '}', ';'].contains(&char) {
            // * Operator
            println!("Operator {}", char);
        }
    }
}

pub fn emit(&mut self, diagnostic: Diagnostic<usize>)

Emit a diagnostic

Examples found in repository

examples/simple_c_lexer.rs (lines 35-43)

pub fn main() {
    let args = std::env::args().collect::<Vec<_>>();
    if args.len() != 2 {
        eprintln!("Usage: cargo run --example simple_c_lexer -- sample.c");
        return;
    }

    let code = std::fs::read_to_string(&args[1]).unwrap();
    let mut codebase = Codebase::new();
    let key = codebase.add(args[1].clone(), code);

    let mut reader = TokenReader::new(codebase.get(key).unwrap().source().clone());
    while let Some(char) = reader.next_char() {
        if chars::is_digit(char) {
            // * Number
            println!("Number {}", reader.next_token(chars::is_digit, char));
        } else if chars::is_ident_start(char) {
            // * Identifier
            println!(
                "Ident {}",
                reader.next_token(chars::is_ident_continue, char)
            );
        } else if char == '"' {
            // * String
            let mut string = String::new();
            loop {
                match reader.next_char() {
                    // Escape sequences
                    Some('\\') => match reader.next_char() {
                        Some('n') => string.push('\n'),
                        Some(char) => string.push(char),
                        None => codebase.emit( // Technically won't happen
                            Diagnostic::error()
                                .with_message("expected escape code")
                                .with_labels(vec![Label::primary(
                                    key,
                                    reader.cursor..reader.cursor + 1,
                                )
                                .with_message("here")]),
                        ),
                    },

                    // Quote
                    Some('"') => break,

                    // Char
                    Some(char) if char != '\n' => string.push(char),
                    _ => {
                        codebase.emit(
                            Diagnostic::error()
                                .with_message("unterminated string")
                                .with_labels(vec![Label::primary(
                                    key,
                                    reader.cursor..reader.cursor + 1,
                                )
                                .with_message("here")]),
                        );
                        break;
                    }
                }
            }
            println!("String {:?}", string);
        } else if ['(', ')', '{', '}', ';'].contains(&char) {
            // * Operator
            println!("Operator {}", char);
        }
    }
}

pub fn files(&self) -> &Vec<SimpleFile<String, Rc<str>>>

pub fn errors(&self) -> usize

Get the number of errors emitted

pub fn warnings(&self) -> usize

Get the number of warnings emitted

Trait Implementations

impl Debug for Codebase

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

Formats the value using the given formatter.

impl Default for Codebase

fn default() -> Codebase

Returns the “default value” for a type.

impl<'a> Files<'a> for Codebase

type FileId = usize

A unique identifier for files in the file provider. This will be used for rendering diagnostic::Labels in the corresponding source files.

type Name = String

The user-facing name of a file, to be displayed in diagnostics.

type Source = &'a str

The source code of a file.

fn name(&self, file_id: usize) -> Result<String, Error>

The user-facing name of a file.

fn source(&self, file_id: usize) -> Result<&str, Error>

The source code of a file.

fn line_index(&self, file_id: usize, byte_index: usize) -> Result<usize, Error>

The index of the line at the given byte index. If the byte index is past the end of the file, returns the maximum line index in the file. This means that this function only fails if the file is not present.

fn line_range( &self, file_id: usize, line_index: usize, ) -> Result<Range<usize>, Error>

The byte range of line in the source of the file.

fn line_number( &'a self, id: Self::FileId, line_index: usize, ) -> Result<usize, Error>

The user-facing line number at the given line index. It is not necessarily checked that the specified line index is actually in the file.

fn column_number( &'a self, id: Self::FileId, line_index: usize, byte_index: usize, ) -> Result<usize, Error>

The user-facing column number at the given line index and byte index.

fn location( &'a self, id: Self::FileId, byte_index: usize, ) -> Result<Location, Error>

Convenience method for returning line and column number at the given byte index in the file.