anheuermann/metamodelica-language-vscode

Extension for Visual Studio Code that adds language support for MetaModelica and Susan

metamodelica-language-vscode's Issues

Fix MetaModelica and add tests

Example examples/MetaModelica.mo isn't highlighted correctly any more.

Documentation strings for variables not recognized

Not all types of documentation strings for variables are recognized as comment.line(green) but as string.quoted.double (orange):

Enumeration type definition not parsed correctly

Enumeration type definition containing strings not parsed correctly:

type PortFlowDirection = enumeration(Entering "Fluid flow is only entering", Leaving "Fluid flow is only leaving", Bidirectional "No restrictions on fluid flow (flow reversal possible)") "Enumeration to define whether flow reversal is allowed";

Multi-line docstring MetaModelica breaking highlighting

public function createFMISimulationFlags
  "Function reads FMI simulation flags from user input --fmiFlags
   and creates FmiSimulationFlags record for code generation.
   Author: AnHeuermann"
  input Boolean printWarning = true;
  output Option<SimCode.FmiSimulationFlags> fmiSimulationFlags;
// [...]
end createFMISimulationFlags;

Documentation string of classes not detected correctly after newline

The documentation string "Documentation" is only recognized when no newline is between it and the end of model M:

It's possible to use a begin and end rule key to find the model M and end M; parts. Then a way to catch the first string in between is needed to tell, that it is a documentation string.

Add Base Modelica support

Base Modelica (described in MCP 0031 draft) isn't highlighted yet.

It shouldn't be too hard to add highlighting for it. It's a subset of Modelica and files (at least from OpenModelica) start with //! base and have the file extension .mo.

baseModelica.mo

//! base 0.1.0
package 'A'
  record 'R1.R2'
    Real 'x';
  end 'R1.R2';

  model 'M'
    'R1.R2' 'r' = 'R1.R2'(1.0);
  end 'M';
end 'A';

or not highlighted in metamodelica

or is not highlighted as keyword in the following mwe:

  if inPosition < 0 or inPosition > listLength(inList) then
    print("function split ERROR:\n");
    print("Out of bounds error for input argument inPosition: " + intString(inPosition) + "\n");
  end if;

Correctly detect Modelica or MetaModelica language from '.mo' files.

Description

When opening .mo files correctly identify if it is a Modelica or a MetaModelica file. Default to Modelica if it can't be decided.

Examples

model M
end M;

Detect modelica since MetaModelica doesn't has keyword model.

uniontype Real
end Real;

Detect metamodelica since uniontype is not a Modelica keyword.

[Susan] else not highlighted in match

In the following example else should be highlighted as keyword:

match x
  case X1(__) then 'x1'
  else 'other'
end match

Highlight end class

While the beginning of a class is highlighted correctly, the end statement isn't:

@phannebohm found a solution for this:

https://macromates.com/manual/en/language_grammars

Captures from the begin pattern can be referenced in the end pattern by using normal regular expression back-references.

In begin, end rules we can use the name of the class in the end capture.

Highlight annotations

Annotations have general allowed values as well as vendor annotations. Highlight at least some of them as keywords.

package Modelica
  package Units
      function from_bar "Convert from bar to Pascal"
        extends Modelica.Units.Icons.Conversion;
        annotation(Inline = true);
      end from_bar;
    end Conversions;
  end Units;
  annotation(version = "4.0.0", versionDate = "2020-06-04", dateModified = "2020-06-04 11:00:00Z");
end Modelica;

model DrumBoiler_total  "Complete drum boiler model, including evaporator and supplementary components"
  extends Modelica.Fluid.Examples.DrumBoiler.DrumBoiler;
  annotation(experiment(StopTime = 5400));
end DrumBoiler_total;

Enumeration MetaModelica with docstring

Issue

type FunctionStatus = enumeration(
  BUILTIN    "A builtin function.",
  INITIAL    "The initial status.",
  EVALUATED  "Constants in the function has been evaluated by EvalConstants.",
  SIMPLIFIED "The function has been simplified by SimplifyModel.",
  COLLECTED  "The function has been added to the function tree."
);

Publish package to open-vsx for VSCodium

In addition to the Microsoft marketplace publish the package to the VSCodium market place. See:

• https://open-vsx.org/
• https://github.com/VSCodium/vscodium/blob/master/docs/index.md#extensions-marketplace