sms/ssc
1
0
Fork 0
Code Issues Pull requests Releases 2 Activity
A compiler API for the SunScript language. Forked from https://github.com/JoshuaMKW/ssc
249 commits 2 branches 9 tags 720 KiB
C# 98%
Lua 2%
Find a file
arookas aeb22bc4ed Major rewrite of relocation and point systems 
- Instead of two overloads for JNE and JMP, the relocation overload is
now implemented as an actual relocation (sunJumpNotEqualSite and
sunJumpSite, respectively).
- sunPoint is completely removed, replaced with simple uint.
- Relocations are now associated with a particular binary, instead of
specifying it per relocation.
- Break points and continue points are now relocations, rather than raw
offsets.
- Minor cleanup
2016-02-12 22:58:48 -05:00
frontend Minor cleanup 2016-02-12 22:53:51 -05:00
lib Removed arookas library files 2016-02-12 22:40:06 -05:00
sbdump Updated arookas library 2016-02-12 22:53:18 -05:00
ssc Major rewrite of relocation and point systems 2016-02-12 22:58:48 -05:00
stdlib Minor cleanup 2016-02-01 06:23:59 -05:00
.gitignore Added premake5 configuration. 2015-12-12 17:41:54 -05:00
extensions.md Added extension documentation 2016-02-07 19:02:39 -05:00
language.md Fixed: minor typo in code example 2016-02-02 19:17:29 -05:00
premake5.lua Added lib-dir premake option 2016-02-12 22:39:25 -05:00
readme.md Updated compilation documentation 2016-02-12 22:53:32 -05:00

readme.md

ssc

Summary

ssc is a basic, work-in-progress compiler for SunScript. It supports all of the byte-code functionality of Super Mario Sunshine's SPC interpreter. The compiler compiles to the SPC binary format (.sb files) used by Super Mario Sunshine.

This program utilizes the Grammatica library to generate an LL(k) parser using a grammar syntax file.

Usage

To use ssc, create an instance of the sunCompiler class. Use the sunCompiler.Compile method or any of its overloads to compile a script:

Parameter Description
name The name of the main script to compile. This is passed to the import resolver.
output The output stream into which the compiled binary file will be written.
binary The custom binary formatter to use for output. If not specified, the default SPC binary format will be used.
resolver An instance of the import resolver to use. If not specified, sunImportResolver.Default will be used.

ssc by default resolves imports by loading files on disk (see language.md for more information). To use a custom import resolver, create a new class inheriting from sunImportResolver and pass an instance of it to the sunCompiler.Compile method.

The result of compilation will be returned in a sunCompilerResults instance. Use the various properties on this type to gather the information of the compilation:

Property Description
Success Whether the script was compiled successfully. If not, the Error property will be non-null.
Error The fatal error which occured during compilation. If compilation was successful, this will be null.
CompileTime The time it took to compile, measured as a TimeSpan instance.
DataCount The total number of data-table entries created.
SymbolCount The total number of symbols (builtins, functions, and variables) created.
BuiltinCount The total number of builtin symbols created.
FunctionCount The total number of function symbols created.
VariableCount The total number of global-scope variable symbols created.

If the error is of the type sunSourceException, you can cast and retrieve the script name, line, and column of the error.

Compiling

Dependencies

There are several dependencies when building ssc. All dependencies must be placed in the lib-dir folder (see below), unless stated otherwise.

Dependency Notes
arookas library Preferably, the library should be built in the same configuration as ssc (e.g. debug, release).
Grammatica 1.6 Already included in the repository.

Note: A Java runtime compatible with JDK 1.5 is required for generating the Grammatica parser classes during compilation. For more information, see Grammatica's official installation documentation.

premake

This repository contains a premake5 configuration file. The script generates a solution with the following projects:

  • ssc, the base ssc API library
  • frontend, a basic command-line frontend
  • sbdump, a tool which dumps disassembly and other information on compiled SPC binaries

After setting up the dependencies, simply run the script through premake5 and build the resulting solution. There are also options which are able to be configured via the premake5 command line:

Option Description
lib-dir Sets the path to the dependencies. Defaults to the lib/ folder.
clean-symbols Cleans symbol table of unused symbols.

Language

For more information on the SunScript language and its syntax, see language.md.

Extending the compiler

ssc is designed to be extensible. For more information on extending ssc, see extensions.md.