Skip to content

About

Standalone Julia parser for Modelica based on ANTLR

Resources

Stars

4 stars

Watchers

16 watching

Forks

Latest commit

 

History

69 Commits

Folders and files

Repository files navigation

OMParser.jl

A Modelica parser written in Julia. It reads Modelica (and MetaModelica, ParModelica, Optimica and PDEModelica) into Absyn trees, the abstract syntax of the OpenModelica compiler, which OMFrontend.jl instantiates. Pure Julia: nothing to build.

Two modules: OMParser.Absyn, the syntax tree records (formerly the package Absyn.jl), and OMParser.Parser, the lexer and parser. parseFile, parseString and ParseError are also OMParser.parseFile etc. Modelica"..." takes Modelica source written in a Julia file.

Install

OMParser is in the OpenModelica registry:

import Pkg
Pkg.Registry.add(Pkg.RegistrySpec(url = "https://github.com/OpenModelica/OpenModelicaRegistry.git"))
Pkg.add("OMParser")

Use

import OMParser
program = OMParser.parseFile("HelloWorld.mo")
program = OMParser.parseString("model M Real x; equation x = 1; end M;", "M.mo")

parseFile(fileName, acceptedGram = 1, languageStandard = 9999) and parseString(contents, fileName = "<default>", acceptedGram = 1, languageStandard = 1000; firstLine = 1) return an Absyn.Program. acceptedGram: 1 Modelica, 2 MetaModelica, 3 ParModelica, 4 Optimica, 5 PDEModelica. languageStandard: 10, 20, 30, 31, 32, 33, 34, 35 (1.x to 3.5), 1000 (latest), 9999 (experimental). firstLine: the number of the text's first line, for a text that is part of a file.

The records keep their names under import OMParser.Absyn:

import OMParser.Absyn
program isa Absyn.PROGRAM
Absyn.dumpPath(Absyn.QUALIFIED("Modelica", Absyn.IDENT("Blocks")))   # "Modelica.Blocks"

A syntax error throws an OMParser.ParseError with the file, line and column:

M.mo:2:9: Expected ';' after the element but found 'equation' on line 3
    Real x
          ^

Modelica in a Julia file

Modelica"""...""" (exported) gives the Absyn.Program of Modelica source written in a Julia file:

using OMParser
program = Modelica"""
  model Decay
    Real x(start = 1.0);
  equation
    der(x) = -x;
  end Decay;
  """
  • The text is parsed when the macro is expanded: a syntax error is a ParseError when the file is loaded, and the program is a constant of the code (nothing is parsed when the code runs, each evaluation gives the same object).
  • The text is taken as written, as in a Modelica file: $ and backslashes stay. The one exception is Julia's rule for string macros: a quote escaped in a Modelica string takes two backslashes (\\"). Line ends are line feeds, also in a Julia file with CRLF line ends.
  • Positions and error messages name the Julia file and its lines. Julia gives a macro the line of its call only: a text of several lines is taken to start on the line after the call (as above), a text of one line on the line of the call.
  • @Modelica (exported) is the form with interpolation, for a text built from values: @Modelica "model $name end $name;" is put together and parsed each time the code runs. Its text is a Julia string, so Julia's escapes apply first (a backslash of the Modelica text is written \\, a dollar sign \$).
  • The grammar is Modelica of the latest standard. Other grammars, and a text held in a variable: parseString.
  • Tested on the 278 example models of the Modelica Standard Library 3.2.1, each written in both forms: every one gives the class of the library, positions included. 177 are written as they are in the library; the 101 with escaped quotes in their documentation take the two backslashes, and are a ParseError when the file is loaded if pasted unchanged (test/README.md).

How it works

A lexer (src/Parser/Lexer.jl) and a recursive-descent parser (src/Parser/Rules.jl) with one function per rule of omc's grammar (OMCompiler/Parser/Modelica.g in the OpenModelica repository). The trees are the ones omc's ANTLR parser builds, source positions and comments included: test/Differential compares the two (OMParser 0.2, the ANTLR/C parser, loaded from its library; its trees are built from the Absyn.jl package's records, compared by name) over directory trees, and they agree on the Modelica Standard Library, the OpenModelica testsuite, the OpenModelica compiler's MetaModelica sources and the Buildings library.

Compile with JuliaC

The parser has no dynamic dispatch (tested), so programs that use it can be compiled with JuliaC and --trim=safe. bin/omparse.jl is an example (the build command is in the file): a 2.4 MB executable that parses MSL 4.1.0 in 0.13 s.

License

GPL version 3 (COPYING) or the OSMC Public License (OSMC-PL), according to the recipient's choice: see LICENSE.md.

test/msl.mo is test data under another license: the Modelica Standard Library 3.2.1, licensed by the Modelica Association under the Modelica License 2 (the license text is in the file). See test/README.md.

About

Standalone Julia parser for Modelica based on ANTLR

Resources

Stars

4 stars

Watchers

16 watching

Forks

Releases

Packages

Used by

Contributors

Languages