ruk33 / vrjass2 Goto Github PK

Programming language that compiles down to JASS (language used by Warcraft 3 maps)

License: MIT License

Java 54.54% ANTLR 1.47% Objective-J 43.99%

jass antlr warcraft java programming-language

vrjass2's Introduction

vrJASS2

This is the new version of my compiler vrJASS. It aims to have a very high percentage of compatibility with vJASS. In fact, that is the primary goal of this project.

Goals

100% compatibility with vJASS
LanguageServer (service to provide autocompletes, errors, etc. in editors)

How to manually compile grammar?

ANTLR Version: 4.5.3

cd path/to/vrj
./gradlew buildGrammar

How to compile?

Does not requires the compiled grammar (it will do it automatically).

cd path/to/vrj
./gradlew build

How to use it?

cd path/to/vrj/builds/libs
java -jar vrjc.jar file1.j file2.j ...

For the moment, it will only translate or throw errors in the console (stdout).

Keep in mind that this is a very unstable version and many features are not implemented yet.

Project structure

src/main/java/ruke/vrj/antlr: All related to ANTLR (lexer, parser, etc.).
src/main/java/ruke/vrj/compiler: Compile, run phases, store results.
src/main/java/ruke/vrj/phase: Phases of the compiler. That is definition, typechecking & translation.
src/main/java/ruke/vrj/translator: Classes that handle how each expession will be translated.
src/main/java/ruke/vrj/util

Code style

Google Java Style

Code style check

./gradlew check

Code style auto fix

java -jar bin/google-java-format.java --relace path/to/vrj/**/*.java

Symbol

It will contain information (for example, where it was declared) about an specific element (meaning variables, functions, structs, libraries, etc.).

SymbolTable

Maps a name (string) to a symbol. It will also provide functionality to fetch these symbols.

Definition phase

It will handle the declaration of symbols (for example variables, functions, etc.) and it will catch already defined errors.

TypeCheck phase

It will handle the checking of the program (for example if a variable is used it will check that it is in fact declared).

Translation phase

It will handle the translation of the program, from vrJASS to raw JASS.

Want to contribute?

Great!, here are a few steps:

Fork the project
Open an issue describing what are you going to be working on (so we don't duplicate efforts)
Create a new branch from master to work on your feature (git checkout -b ISSUE_ID/breaf-feature-description).
Create tests that ensure the code does what it must
Finish the feature
Pull request!

If you're not sure of your code, don't worry, send a pull request and we will check it together ^^

Want to suggest a feature?

Great!, here are a few steps:

Create an issue
Describe the feature
Describe the problem that solves
Write a few usage examples
Describe how could it be translated into raw JASS (optional)

Please keep in mind that not all feature suggestions are going to be implemented or that it could take a while to do so.

Important: your feature cannot change or break the behavior of vJASS code (remember, vrJASS2' primary goal is to achieve full compatibility with vJASS).

Licence

MIT

vrjass2's People

Contributors

Stargazers

Watchers

Forkers

lediegue

vrjass2's Issues

Resolve library member

The compiler must be able to resolve public members of libraries and check for private ones.

Example:
someLibrary_somePublicMember

Private members must only be usable inside of the library where declared. If used from outside, an error must be logged.

Example:

library Foo
  private function bar takes ... returns ...
  endfunction
endlibrary

function baz takes ... returns ...
  call Foo_bar() // <-- Error
endfunction

Debug preprocessor

Each statement must allow a debug keyword in the beginning.

Example:

debug call BJDebugMsg("Foo")

Result:

If debug mode enabled: call BJDebugMsg("Foo")
If debug mode disabled: // call BJDebugMsg("Foo")

Struct initializers

Static methods onInit will be taken as struct initializers.

Struct initializers must not take any parameters and return nothing.

Like libraries initializers, struct initializers must be injected in the main function and be called using ExecuteFunc.

Global block declaration

The compiler must be able to translate several global blocks and merge them into one.

Example:

globals
  int foo
endglobals
globals
  int bar
endglobals

Result:

globals
  int foo
  int bar
endglobals

Check for circular library dependency

The compiler must log an error if a circular dependency between libraries is detected.

Example:

library Foo requires Bar
endlibrary
library Bar requires Baz
endlibrary
library Baz requires Foo
endlibrary

Interface validations

Structs implementing interfaces must:

Implement all methods
Match arguments
Match return type

Library declaration

Example:

library Foo
  globals
    int bar
  endglobals
  public function baz takes ... returns ...
  endfunction
endlibrary

Must be translated to:

globals
  int Foo_bar
endglobals
function Foo_baz takes ... returns ...
endfunction

Library initializers

Library initializers must be injected into the main function using ExecuteFunc.

Example:

library Foo initializer Init
  private function Init takes ... returns ...
  endfunction
endlibrary

Must be translated to:

function Foo_Init takes ... returns ...
endfunction
function main takes ... returns ...
  call ExecuteFunc("Foo_Init")
endfunction

Structs not extending from array must automatically include the static methods allocate and create. Both methods must return an instance and only ´createcan be overwritten.allocatemust beprivate`.

Example to allocate: someStruct.create()

Given the following example:

struct Foo
  integer bar
endstruct
function baz takes ... returns ...
  local Foo foo = Foo.create()
endfunction

The translation must be:

globals
  integer array Foo_vrj_instances
  integer array Foo_bar
endglobals
function Foo_allocate takes nothing returns integer
  local integer instance = Foo_vrj_instances[0]
  if (Foo_vrj_instances[instance] == 0) then
    set Foo_vrj_instances[0] = instance + 1
  else
    set Foo_vrj_instances[0] = Foo_vrj_instances[instace]
  endif
  return instance
endfunction

More info about the allocating algorithm: https://www.hiveworkshop.com/threads/allocation-with-one-variable.253320/

ruk33 / vrjass2 Goto Github PK

vrjass2's Introduction

vrJASS2

Goals

How to manually compile grammar?

How to compile?

How to use it?

Project structure

Code style

Code style check

Code style auto fix

Symbol

SymbolTable

Definition phase

TypeCheck phase

Translation phase

Want to contribute?

Want to suggest a feature?

Licence

vrjass2's People

Contributors

Stargazers

Watchers

Forkers

vrjass2's Issues

Recommend Projects

Recommend Topics

Recommend Org