Skip to content

Latest commit

 

History

History
432 lines (410 loc) · 12.4 KB

readme.md

File metadata and controls

432 lines (410 loc) · 12.4 KB

Jai Parser

Handwritten Jai parser in Jai. The parser has not been tested on larger projects so there may be some serious bugs and stuff. Currently, it's able to parse itself including all the Jai modules used in it.

The current plan for this parser is to provide information about Jai programs for Jails and Jai Autodoc together with information provided by the compiler.

Try

The cmd folder contains an example program that parses the entry file and follows all #import and #load. The program generates an out folder with JSON files each representing each parsed file.

Example

demo_command_line_arguments :: () {
    args :=  get_command_line_arguments();
    defer array_reset(*args); // get_command_line_arguments() creates a new array so we release it here. The strings themselves are not copies, however!

    print("Number of command line arguments: %\n", args.count);
    for args {
         print("Argument %: %\n", it_index+1, it);
    }
}

Will generate:

example.json
[
  {
    "kind": "DECLARATION",
    "location": {
      "l0": 1,
      "c0": 1,
      "l1": 9,
      "c1": 1,
      "file": "./tests/example.jai"
    },
    "name": "demo_command_line_arguments",
    "const": true,
    "has_elsewhere": false,
    "elsewhere": "",
    "type_inst": null,
    "expression": {
      "kind": "PROCEDURE",
      "location": {
        "l0": 1,
        "c0": 32,
        "l1": 9,
        "c1": 1,
        "file": "./tests/example.jai"
      },
      "foreign_lib": "",
      "foreign_alias": "",
      "elsewhere": "",
      "intrinsic": "",
      "deprecated_note": "",
      "flags": "0",
      "arguments": [
        
      ],
      "returns": [
        
      ],
      "modify_block": null,
      "body": {
        "kind": "BLOCK",
        "location": {
          "l0": 1,
          "c0": 35,
          "l1": 9,
          "c1": 1,
          "file": "./tests/example.jai"
        },
        "members": [
          {
            "kind": "DECLARATION",
            "location": {
              "l0": 2,
              "c0": 4,
              "l1": 2,
              "c1": 42,
              "file": "./tests/example.jai"
            },
            "name": "args",
            "const": false,
            "has_elsewhere": false,
            "elsewhere": "",
            "type_inst": null,
            "expression": {
              "kind": "PROCEDURE_CALL",
              "location": {
                "l0": 2,
                "c0": 13,
                "l1": 2,
                "c1": 41,
                "file": "./tests/example.jai"
              },
              "inlined": false,
              "backticked": false,
              "procedure": {
                "kind": "IDENTIFIER",
                "location": {
                  "l0": 2,
                  "c0": 13,
                  "l1": 2,
                  "c1": 39,
                  "file": "./tests/example.jai"
                },
                "backticked": false,
                "name": "get_command_line_arguments"
              },
              "arguments": [
                
              ]
            },
            "backticked": false,
            "notes": [
              
            ]
          },
          {
            "kind": "DEFER",
            "location": {
              "l0": 3,
              "c0": 4,
              "l1": 3,
              "c1": 28,
              "file": "./tests/example.jai"
            },
            "expression": {
              "kind": "PROCEDURE_CALL",
              "location": {
                "l0": 3,
                "c0": 10,
                "l1": 3,
                "c1": 28,
                "file": "./tests/example.jai"
              },
              "inlined": false,
              "backticked": false,
              "procedure": {
                "kind": "IDENTIFIER",
                "location": {
                  "l0": 3,
                  "c0": 10,
                  "l1": 3,
                  "c1": 21,
                  "file": "./tests/example.jai"
                },
                "backticked": false,
                "name": "array_reset"
              },
              "arguments": [
                {
                  "kind": "UNARY_OPERATION",
                  "location": {
                    "l0": 3,
                    "c0": 22,
                    "l1": 3,
                    "c1": 27,
                    "file": "./tests/example.jai"
                  },
                  "operation": "POINTER",
                  "expression": {
                    "kind": "IDENTIFIER",
                    "location": {
                      "l0": 3,
                      "c0": 23,
                      "l1": 3,
                      "c1": 27,
                      "file": "./tests/example.jai"
                    },
                    "backticked": false,
                    "name": "args"
                  }
                }
              ]
            },
            "backticked": false
          },
          {
            "kind": "COMMENT",
            "location": {
              "l0": 3,
              "c0": 30,
              "l1": 4,
              "c1": 0,
              "file": "./tests/example.jai"
            },
            "value": " get_command_line_arguments() creates a new array so we release it here. The strings themselves are not copies, however!"
          },
          {
            "kind": "PROCEDURE_CALL",
            "location": {
              "l0": 5,
              "c0": 4,
              "l1": 5,
              "c1": 62,
              "file": "./tests/example.jai"
            },
            "inlined": false,
            "backticked": false,
            "procedure": {
              "kind": "IDENTIFIER",
              "location": {
                "l0": 5,
                "c0": 4,
                "l1": 5,
                "c1": 9,
                "file": "./tests/example.jai"
              },
              "backticked": false,
              "name": "print"
            },
            "arguments": [
              {
                "kind": "LITERAL",
                "location": {
                  "l0": 5,
                  "c0": 10,
                  "l1": 5,
                  "c1": 49,
                  "file": "./tests/example.jai"
                },
                "value_type": "STRING",
                "here_string_cr": false,
                "values": "Number of command line arguments: %n"
              },
              {
                "kind": "BINARY_OPERATION",
                "location": {
                  "l0": 5,
                  "c0": 51,
                  "l1": 5,
                  "c1": 61,
                  "file": "./tests/example.jai"
                },
                "left": {
                  "kind": "IDENTIFIER",
                  "location": {
                    "l0": 5,
                    "c0": 51,
                    "l1": 5,
                    "c1": 61,
                    "file": "./tests/example.jai"
                  },
                  "backticked": false,
                  "name": "args"
                },
                "operation": "DOT",
                "right": {
                  "kind": "IDENTIFIER",
                  "location": {
                    "l0": 5,
                    "c0": 56,
                    "l1": 5,
                    "c1": 61,
                    "file": "./tests/example.jai"
                  },
                  "backticked": false,
                  "name": "count"
                }
              }
            ]
          },
          {
            "kind": "FOR",
            "location": {
              "l0": 6,
              "c0": 4,
              "l1": 8,
              "c1": 5,
              "file": "./tests/example.jai"
            },
            "by_pointer": false,
            "reversed": false,
            "no_abc": false,
            "value": null,
            "index": null,
            "iterator": {
              "kind": "IDENTIFIER",
              "location": {
                "l0": 6,
                "c0": 8,
                "l1": 6,
                "c1": 12,
                "file": "./tests/example.jai"
              },
              "backticked": false,
              "name": "args"
            },
            "body": {
              "kind": "BLOCK",
              "location": {
                "l0": 6,
                "c0": 13,
                "l1": 8,
                "c1": 5,
                "file": "./tests/example.jai"
              },
              "members": [
                {
                  "kind": "PROCEDURE_CALL",
                  "location": {
                    "l0": 7,
                    "c0": 9,
                    "l1": 7,
                    "c1": 49,
                    "file": "./tests/example.jai"
                  },
                  "inlined": false,
                  "backticked": false,
                  "procedure": {
                    "kind": "IDENTIFIER",
                    "location": {
                      "l0": 7,
                      "c0": 9,
                      "l1": 7,
                      "c1": 14,
                      "file": "./tests/example.jai"
                    },
                    "backticked": false,
                    "name": "print"
                  },
                  "arguments": [
                    {
                      "kind": "LITERAL",
                      "location": {
                        "l0": 7,
                        "c0": 15,
                        "l1": 7,
                        "c1": 32,
                        "file": "./tests/example.jai"
                      },
                      "value_type": "STRING",
                      "here_string_cr": false,
                      "values": "Argument %: %n"
                    },
                    {
                      "kind": "BINARY_OPERATION",
                      "location": {
                        "l0": 7,
                        "c0": 34,
                        "l1": 7,
                        "c1": 44,
                        "file": "./tests/example.jai"
                      },
                      "left": {
                        "kind": "IDENTIFIER",
                        "location": {
                          "l0": 7,
                          "c0": 34,
                          "l1": 7,
                          "c1": 44,
                          "file": "./tests/example.jai"
                        },
                        "backticked": false,
                        "name": "it_index"
                      },
                      "operation": "ADDITION",
                      "right": {
                        "kind": "LITERAL",
                        "location": {
                          "l0": 7,
                          "c0": 43,
                          "l1": 7,
                          "c1": 44,
                          "file": "./tests/example.jai"
                        },
                        "value_type": "INT",
                        "here_string_cr": false,
                        "values": "1"
                      }
                    },
                    {
                      "kind": "IDENTIFIER",
                      "location": {
                        "l0": 7,
                        "c0": 46,
                        "l1": 7,
                        "c1": 48,
                        "file": "./tests/example.jai"
                      },
                      "backticked": false,
                      "name": "it"
                    }
                  ]
                }
              ]
            }
          }
        ]
      },
      "notes": [
        
      ]
    },
    "backticked": false,
    "notes": [
      
    ]
  }
]

To generate this run:

cd cmd
jai build.jai && ./bin/jai_parser ../tests/example.jai

Dependencies

The parser itself depends only on the modules included with the Jai compiler, but the CMD example has the following dependencies:

TODO:

  • Create automatic tests
  • Switch to Lexer from Jai Modules?
  • Refactor parsing of compound and comma seperated stuff (it's very naive right now!)
  • Remove unnecessary heap allocations
  • Measure performance with Tracy and improve it (it's probably quite slow now)
  • Refactor data structures (maybe use linked list etc)
  • Rename stuff to their correct names (binary_operation vs binary_expression etc...)
  • Rename to Jaiser?