Crate resymgen

Working with the resymgen YAML format

This crate contains utilities for working with the YAML configuration files of the resymgen (reverse engineering symbol table generator) command line tool.

The top-level library functions implement the subcommands of resymgen. That is, they take input files containing symbol data, process the file contents based on specified configuration parameters, and generate output related to the symbol data in the form of console output or files.

The data_formats module defines structures and methods related to parsing and manipulating raw symbol data in various formats.

Re-exports

pub use data_formats::symgen_yml::IntFormat;

pub use data_formats::symgen_yml::LoadParams;

pub use data_formats::symgen_yml::SymbolType;

pub use data_formats::InFormat;

pub use data_formats::OutFormat;

Modules

data_formats

This module contains structs and methods for reading, writing, and manipulating different symbol data formats.

Structs

CheckResult

The result of a Check run on resymgen YAML symbol tables.

MultiFileError

Encapsulates a collection of similar errors for different files.

Enums

Check

Checks that can be run on resymgen YAML symbol tables.

NamingConvention

Naming conventions for symbol names.

Functions

format_check_file

Checks the format of a given input_file, subject to the given int_format.

format_file

Formats a given input_file using the given int_format.

generate_symbol_tables

Generates symbol tables from a given input_file for multiple different output_formats and output_versions.

merge_symbols

Merges symbols from a collection of input_files of the format input_format into a given symgen_file.

persist_named_temp_file_safe

Persist the temporary file at the target path.

run_and_print_checks

Validates a given set of input_files under the specified checks, and prints a summary of the results.

run_checks

Validates a given input_file under the specified checks.

symgen_write_recursive

Recursively write a SymGen and all its subregions to files, starting with the top-level file path specified by top_path, and using the given int_format.