modsplan-compiler/ReadMe.txt
ModSPLan - Modular Specification of Programming Languages
Modsplan implements a universal compiler, driven by language specifications.

Please read the introduction to this project at modsplan.com


Version 0.2.8 of the Modsplan compiler is 1932 lines of pure Python, 
plus 84 lines of specifications used internally. It uses no external libraries.

Modsplan requires Python 2.7
Run "python modsplan/compiler.py" on your command line for usage information.


Simple calculator example

  See modspecs/calc.* for specifications
  
  Compare with Lex & Yacc example at 
    https://web.archive.org/web/20161222154149/http://pltplp.net:80/lex-yacc/example.html.en
    or
    https://www.ibm.com/support/knowledgecenter/en/ssw_aix_72/com.ibm.aix.genprogc/ie_prog_4lex_yacc.htm

    $ cat sample_source/example.calc
    4 + 2 * -1.5

    $ python modsplan/compiler.py sample_source/example.calc -ot

    Tokens from sample_source/example.calc:

    INTEGER(4)
    ADD_OP(+)
    INTEGER(2)
    MUL_OP(*)
    ADD_OP(-)
    FLOAT(1.5)


    Tree:

    expr
       term
          factor
          |  atom
          |     number
          |     |  INTEGER(4)
          multiplication*
       addition*
          addition
          |  ADD_OP(+)
          |  term
          |     factor
          |     |  atom
          |     |     number
          |     |     |  INTEGER(2)
          |     multiplication*
          |     |  multiplication
          |     |     MUL_OP(*)
          |     |     factor
          |     |     |  ADD_OP(-)
          |     |     |  atom
          |     |     |     number
          |     |     |     |  FLOAT(1.5)


    const 4
    const 2
    const 0
    const 1.5
    sub
    mul
    add


Files:

ReadMe.txt          This file

License.txt         License terms

sample_source/      Source code examples for testing compiler
                        *.sbil files are generated SBIL code

modspecs/           Modsplan specification files (.tokens, .syntax, .defn)
    
    *.metagrammar document the syntax of Modsplan grammars
    
    calc is a simple calculator example
        See sample_source/example.calc and example.calc.sbil generated code
    
    L0 is a small statically-typed language with Python-like syntax
    c1 is a working subset of C
    base, expr, constants, float: specs shared between languages
    
    sbil is Stack-Based Intermediate Language (based on LLVM), our target code
    llvm is an attempt to specify the syntax of LLVM Assembly Language
    irtypes is the type system shared by LLVM and SBIL

legispecs/     Attempt to specify the syntax of Wisconsin legislative documents

defn_grammar/       Specs for the Modsplan defn language, used to parse it
                        (Modifications require changes to compiler code)

modsplan/           Python source code of the Modsplan compiler
    
    compiler.py     Compiles source text to target code
    syntax.py       Parses source text into parse tree
    tokenize.py     Tokenizes source text
    grammar.py      Loads grammar specifications
    defn.py         Loads semantic definitions
    parsetree.py    Handles parse trees
    lineparsers.py  Reads lines of source, handles imports, tracks location

test.py             Test suite

linecounts.txt      Line counts of Python code

mycount.py          Line counting scripts
linecount.py

Modsplan To Do List.txt