mapfile-parser 2.0.0

Map file parser library focusing decompilation projects

mapfile_parser

Map file parser library focusing decompilation projects.

Installing

The recommended way to install is using from the PyPi release, via pip:

pip install mapfile-parser

In case you want to mess with the latest development version without wanting to clone the repository, then you could use the following command:

pip uninstall mapfile-parser
pip install git+https://github.com/Decompollaborate/mapfile_parser.git@develop

NOTE: Installing the development version is not recommended. Proceed at your own risk.

Examples

Various cli examples are provided in the frontends folder. Most of them are re-implementations of already existing tools using this library to show how to use this library and inspire new ideas.

The list can be checked in runtime with python3 -m mapfile_parser --help.

Each one of them can be executed with python3 -m mapfile_parser utilityname, for example python3 -m mapfile_parser pj64_syms.

• first_diff: Find the first difference(s) between the built ROM and the base ROM.
• jsonify: Converts a mapfile into a json format.
• pj64_syms: Produce a PJ64 compatible symbol map.
• progress: Computes current progress of the matched functions. Relies on a splat folder structure and matched functions not longer having a file.
• sym_info: Display various information about a symbol or address.
• symbol_sizes_csv: Produces a csv summarizing the files sizes by parsing a map file.
• upload_frogress: Uploads current progress (calculated by the progress utility) of the matched functions to frogress.

None of the provided cli utilities are meant to be used directly on a command line, because they need a large number of long parameters to them and every repo has their own quirks which would need them to be adapted. Those have been written mostly to facilitate people to write those utilities in a way which accomodates their own repo.