Typescript target (#4027)

* Fix CMake syntax for variable expansion When using variables to compare (like in if clause) the variable shouldn't be quoted. More details can be found at the link below: https://cmake.org/cmake/help/latest/command/if.html#variable-expansion Signed-off-by: HS <hs@apotell.com> Signed-off-by: Eric Vergnaud <eric.vergnaud@wanadoo.fr> * initial commit Signed-off-by: Eric Vergnaud <eric.vergnaud@wanadoo.fr> * renamed for clarity Signed-off-by: Eric Vergnaud <eric.vergnaud@wanadoo.fr> * renamed for clarity Signed-off-by: Eric Vergnaud <eric.vergnaud@wanadoo.fr> * able to locate antlr4 runtime using ts-node, missing types Signed-off-by: Eric Vergnaud <eric.vergnaud@wanadoo.fr> * progressing Signed-off-by: Eric Vergnaud <eric.vergnaud@wanadoo.fr> * able to 'run' a test. It fails but it compiles and resolves! Signed-off-by: Eric Vergnaud <eric.vergnaud@wanadoo.fr> * reflect refactored runtime Signed-off-by: Eric Vergnaud <eric.vergnaud@wanadoo.fr> * able to run RecursiveLexerRuleRefWithWildcardPlus_1 test locally Signed-off-by: Eric Vergnaud <eric.vergnaud@wanadoo.fr> * passes LexerExec tests in IntelliJ Signed-off-by: Eric Vergnaud <eric.vergnaud@wanadoo.fr> * make ATN private Signed-off-by: Eric Vergnaud <eric.vergnaud@wanadoo.fr> * ignore same tests as JavaScript Signed-off-by: Eric Vergnaud <eric.vergnaud@wanadoo.fr> * compiles Parser and Lexer bu local run fails Signed-off-by: Eric Vergnaud <eric.vergnaud@wanadoo.fr> * ParserExec.TokenOffset test successful in IntelliJ ! Signed-off-by: Eric Vergnaud <eric.vergnaud@wanadoo.fr> * Progressing, passing 131 of 348 tests Signed-off-by: Eric Vergnaud <eric.vergnaud@wanadoo.fr> * pass 327 tests out of 348 Signed-off-by: Eric Vergnaud <eric.vergnaud@wanadoo.fr> * more successful tests Signed-off-by: Eric Vergnaud <eric.vergnaud@wanadoo.fr> * 333 successful tests out of 348 Signed-off-by: Eric Vergnaud <eric.vergnaud@wanadoo.fr> * all tests pass except 7 caused by #3868 Signed-off-by: Eric Vergnaud <eric.vergnaud@wanadoo.fr> * update getting-started doc Signed-off-by: nicksxs <nicksxs@hotmail.com> Signed-off-by: Eric Vergnaud <eric.vergnaud@wanadoo.fr> * add blank github action file for hosted CI Signed-off-by: Terence Parr <parrt@antlr.org> Signed-off-by: Eric Vergnaud <eric.vergnaud@wanadoo.fr> * update getting started document to say java 11 Signed-off-by: Terence Parr <parrt@antlr.org> Signed-off-by: Eric Vergnaud <eric.vergnaud@wanadoo.fr> * Revert "update getting started document to say java 11" This reverts commit 1df58f7. Signed-off-by: Eric Vergnaud <eric.vergnaud@wanadoo.fr> * add C# book code links Signed-off-by: Terence Parr <parrt@antlr.org> Signed-off-by: Eric Vergnaud <eric.vergnaud@wanadoo.fr> * Add Jim/Ken to readme Signed-off-by: Terence Parr <parrt@antlr.org> Signed-off-by: Eric Vergnaud <eric.vergnaud@wanadoo.fr> * Update Swift Package to support static library Add static library distribution in SPM Signed-off-by: Hell_Ghost <dev.hellghost@gmail.com> Signed-off-by: Eric Vergnaud <eric.vergnaud@wanadoo.fr> * Update Package.swift Signed-off-by: Hell_Ghost dev.hellghost@gmail.com Signed-off-by: Hell_Ghost <dev.hellghost@gmail.com> Signed-off-by: Eric Vergnaud <eric.vergnaud@wanadoo.fr> * Add caching support for maven & dependencies. Also, include caching for cpp builds using actions/ccache. Builds are more reliable (avoids the archive.apache server which intermittently reports timeouts) and also significantly improves the overall builds times (down from 46 mins to 28 mins). The slowest part of the build now is the Windows+cpp builds because there is no reliable cache implementation yet. MacOS+cpp (65% cache hit) is also relatively slow compared to Ubuntu+cpp (99% cache hit). Signed-off-by: HS <hs@apotell.com> Signed-off-by: Terence Parr <parrt@antlr.org> # Conflicts: # .github/workflows/hosted.yml Signed-off-by: Eric Vergnaud <eric.vergnaud@wanadoo.fr> * use snap to install go 1.19 Signed-off-by: Terence Parr <parrt@antlr.org> Signed-off-by: Eric Vergnaud <eric.vergnaud@wanadoo.fr> * grr...install snap Signed-off-by: Terence Parr <parrt@antlr.org> Signed-off-by: Eric Vergnaud <eric.vergnaud@wanadoo.fr> * ugh. start snap Signed-off-by: Terence Parr <parrt@antlr.org> Signed-off-by: Eric Vergnaud <eric.vergnaud@wanadoo.fr> * ugh. start snap Signed-off-by: Terence Parr <parrt@antlr.org> Signed-off-by: Eric Vergnaud <eric.vergnaud@wanadoo.fr> * ugh. cant get snap to install go Signed-off-by: Terence Parr <parrt@antlr.org> Signed-off-by: Eric Vergnaud <eric.vergnaud@wanadoo.fr> * try downloading golang with curl Signed-off-by: Terence Parr <parrt@antlr.org> Signed-off-by: Eric Vergnaud <eric.vergnaud@wanadoo.fr> * Issue #3823: Temporarily disable a few tests on CI The tests are currently failing. The underlying issues have been fixed on dev and so the builds will be turned back with the next release. Signed-off-by: HS <hs@apotell.com> Signed-off-by: Eric Vergnaud <eric.vergnaud@wanadoo.fr> * update actions status badge Signed-off-by: Terence Parr <parrt@antlr.org> Signed-off-by: Eric Vergnaud <eric.vergnaud@wanadoo.fr> * update getting started document to say java 11 Signed-off-by: Terence Parr <parrt@antlr.org> Signed-off-by: Eric Vergnaud <eric.vergnaud@wanadoo.fr> * Revert "update getting started document to say java 11" This reverts commit 3591ee0. Signed-off-by: Eric Vergnaud <eric.vergnaud@wanadoo.fr> * update getting-started doc Signed-off-by: nicksxs <nicksxs@hotmail.com> Signed-off-by: Eric Vergnaud <eric.vergnaud@wanadoo.fr> * make getValue visible to external profiler tools. Signed-off-by: Terence Parr <parrt@antlr.org> Signed-off-by: Eric Vergnaud <eric.vergnaud@wanadoo.fr> * Fix #3508: Document the $parser attribute and its use in target-agnostic grammars. Signed-off-by: Ross Patterson <ross.patterson@gmail.com> Signed-off-by: Eric Vergnaud <eric.vergnaud@wanadoo.fr> * Add accessor to IntervalSet for intervals Signed-off-by: James Taylor <jamestaylor@apache.org> Signed-off-by: Eric Vergnaud <eric.vergnaud@wanadoo.fr> * Remove libuuid dependency from C++ runtime libuuid and its headers are not referenced anywhere, so remove it. Signed-off-by: Bryan Tan <bryantan@technius.net> Signed-off-by: Eric Vergnaud <eric.vergnaud@wanadoo.fr> * Add `@SuppressWarnings("CheckReturnValue")` to prevent error_prone lib errors. Signed-off-by: Terence Parr <parrt@antlr.org> Signed-off-by: Eric Vergnaud <eric.vergnaud@wanadoo.fr> * fix: Fixes for #3718 o Implement collections with generics to solve hash collisions o Fix type casting in LL start parser simulation optimization o General minor tidy ups Acknowledgements to @kaby76 for help with tracing errors Signed-off-by: Jim.Idle <jimi@gatherstars.com> Signed-off-by: Eric Vergnaud <eric.vergnaud@wanadoo.fr> * fix: #3718 Revert accidental keyboard error in Java target Signed-off-by: Jim.Idle <jimi@gatherstars.com> Signed-off-by: Eric Vergnaud <eric.vergnaud@wanadoo.fr> * fix: #3718 Correct DFAState index in Lexer ATN Simulator Signed-off-by: Jim.Idle <jimi@gatherstars.com> Signed-off-by: Eric Vergnaud <eric.vergnaud@wanadoo.fr> * fix: #3718 Fix go runtime test runners With older versions of go, there was no good way to tell the compiler to use your local development copy of a particular package instead of the one installed in GOPATH/src/... However, we are now using modules, which allows us to tell the compiler that instead of a module downloaded to GOPATH/pkg, to use a local copy on disk. Hence this change removes the need to copy the whole of the go installation to a tempoorary location, then put the antlr go runtime in to the go installation as if it was part of the compiler. Hence the execution time for the go tests is now faster than before. This works because when the generated code is placed in the temporary location, we create a go.mod file for it, tell the module to replace the online module for the go runtime with the local copy on disk, then ro a go mod tidy to add the dependencies from the code (which avoids network access, so it is instant), which adds the ANTLR dependency itself (which is then replaced at compile time). All go runtime tests now pass. Signed-off-by: Jim.Idle <jimi@gatherstars.com> Signed-off-by: Eric Vergnaud <eric.vergnaud@wanadoo.fr> * Rm remote github actions; hosted seems to work Signed-off-by: Terence Parr <parrt@antlr.org> Signed-off-by: Eric Vergnaud <eric.vergnaud@wanadoo.fr> * install golang with curl; go was missing from dev Signed-off-by: Terence Parr <parrt@antlr.org> Signed-off-by: Eric Vergnaud <eric.vergnaud@wanadoo.fr> * fix: Rework of all Hash() and Equals() methods - implement generic collections - Implement new collections using generics that implement the functionality required by the Java runtime in a more idiomatic Go way. - Fix Hash() and Equals() for all objects in the runtime - Fix getConflictingAlts so that it behaves the same way as Java, using a new generic collection - Replaces the use of the array2DHashSet, which was causing unneeded memory allocations. Replaced with generic collection that allocates minimally (though, I think I can improve on that with a little analysis). Jim Idle - jimi@idle.ws Signed-off-by: Jim.Idle <jimi@gatherstars.com> Signed-off-by: Eric Vergnaud <eric.vergnaud@wanadoo.fr> * fix: #3718 Correct DFAState index in Lexer ATN Simulator Signed-off-by: Jim.Idle <jimi@gatherstars.com> Signed-off-by: Eric Vergnaud <eric.vergnaud@wanadoo.fr> * feat: Reduce initial memory allocations for collections - Many small collections are created at runtime, the default allocation for maps, even though small, still requires memory. Specifying a very small initial allocation prevents unnecesary allocations and has no measurable effect on performance. A small incremental change. Signed-off-by: Jim.Idle <jimi@gatherstars.com> Signed-off-by: Eric Vergnaud <eric.vergnaud@wanadoo.fr> * fix: #3758 Allow for string being a keyword and fix go template to use escapedName - The go template was ignoring the use of escapedName in many places and was not consistenet with the Java version. - Added 'string' to the list of reserved words for the Go target Signed-off-by: Jim.Idle <jimi@gatherstars.com> Signed-off-by: Eric Vergnaud <eric.vergnaud@wanadoo.fr> * fix: #3758 Add go.sum to the repo Signed-off-by: Jim.Idle <jimi@gatherstars.com> Signed-off-by: Eric Vergnaud <eric.vergnaud@wanadoo.fr> * fix: #3758 Ensure that standard runtime extensions are included in go.mod Signed-off-by: Jim.Idle <jimi@gatherstars.com> Signed-off-by: Eric Vergnaud <eric.vergnaud@wanadoo.fr> * fix: #2826 Go template is incorrect for dynamic scopes closes #2826 obviates PR #3101 Signed-off-by: Jim.Idle <jimi@gatherstars.com> Signed-off-by: Eric Vergnaud <eric.vergnaud@wanadoo.fr> * fix: #2016 - Generate correct iGo code for lists in a grammar, such as `label+=arg+` Signed-off-by: Jim.Idle <jimi@gatherstars.com> Signed-off-by: Eric Vergnaud <eric.vergnaud@wanadoo.fr> * feat: Bump poms to use 4.11 Snapshot Signed-off-by: Jim.Idle <jimi@gatherstars.com> Signed-off-by: Eric Vergnaud <eric.vergnaud@wanadoo.fr> * turn off Golang test at circleci for now Signed-off-by: Terence Parr <parrt@antlr.org> Signed-off-by: Eric Vergnaud <eric.vergnaud@wanadoo.fr> * Replace smart-quote with single-quote in code examples Signed-off-by: Tim McCormack <cortex@brainonfire.net> Signed-off-by: Eric Vergnaud <eric.vergnaud@wanadoo.fr> * Augment error message during testing to include full cause of problem. Signed-off-by: Terence Parr <parrt@antlr.org> Signed-off-by: Eric Vergnaud <eric.vergnaud@wanadoo.fr> * Augment error message during testing to include full cause of problem. (round 2 to avoid null ptr) Signed-off-by: Terence Parr <parrt@antlr.org> Signed-off-by: Eric Vergnaud <eric.vergnaud@wanadoo.fr> * Cpp: Link to threads library As detailed in #3708, it is necessary to link against the (p)threads library in order to be able to use std::call_once without producing linker errors. Since this function is frequently used in ANTLR's cpp version, this commit ensures that the respective library is always linked against in order to avoid this error, even if downstream users are not explicitly linking against an appropriate threads library. Fixes #3708 Signed-off-by: Robert Adam <dev@robert-adam.de> Co-authored-by: Bryan Tan <Technius@users.noreply.github.com> Signed-off-by: Eric Vergnaud <eric.vergnaud@wanadoo.fr> * add test for #2016 and fix java. Signed-off-by: Terence Parr <parrt@antlr.org> Signed-off-by: Eric Vergnaud <eric.vergnaud@wanadoo.fr> * ensure all targets have the appropriate argument list for the template causing the problem. Signed-off-by: Terence Parr <parrt@antlr.org> Signed-off-by: Eric Vergnaud <eric.vergnaud@wanadoo.fr> * Fix other targets Signed-off-by: Terence Parr <parrt@antlr.org> Signed-off-by: Eric Vergnaud <eric.vergnaud@wanadoo.fr> * fix format Signed-off-by: Terence Parr <parrt@antlr.org> Signed-off-by: Eric Vergnaud <eric.vergnaud@wanadoo.fr> * add check that $args is a list Signed-off-by: Terence Parr <parrt@antlr.org> Signed-off-by: Eric Vergnaud <eric.vergnaud@wanadoo.fr> * change made by @lingyv-li to fix bug in DART exposed by this test. Signed-off-by: Terence Parr <parrt@antlr.org> Signed-off-by: Eric Vergnaud <eric.vergnaud@wanadoo.fr> * fix AssertIsList in multiple targets. Go doesn't pass test and has no AssertIsList so I'm dropping that test from the Go test suite. How did a comment to the C++ runnerFor my future reference as to how to build things from the command line. Signed-off-by: Terence Parr <parrt@antlr.org> Signed-off-by: Eric Vergnaud <eric.vergnaud@wanadoo.fr> * C++ gets an exception with this test so I'm turning it off. See #3845 Signed-off-by: Terence Parr <parrt@antlr.org> Signed-off-by: Eric Vergnaud <eric.vergnaud@wanadoo.fr> * feat: #3840 Move Go to version v4.11.0 Signed-off-by: Jim.Idle <jimi@gatherstars.com> Signed-off-by: Eric Vergnaud <eric.vergnaud@wanadoo.fr> * feat: #3840 Create the v4 version of the Go runtime Signed-off-by: Jim.Idle <jimi@gatherstars.com> Signed-off-by: Eric Vergnaud <eric.vergnaud@wanadoo.fr> * feat: Create the v4 runtime layout for the Go runtime, ready for release tagging Note that the vast majority of the changes here are just copying the runtime file in to the /v4 subdirectory so that we can support legacy projects that use GOPATH only, as well as users that can use go modules. At a later release, we will delete the default path, and move the v4 subdirectory back to the top level. But, we cannot do that on this release. Signed-off-by: Jim.Idle <jimi@gatherstars.com> Signed-off-by: Eric Vergnaud <eric.vergnaud@wanadoo.fr> * Reenable go tests on CircleCI Signed-off-by: Ivan Kochurkin <kvanttt@gmail.com> Signed-off-by: Eric Vergnaud <eric.vergnaud@wanadoo.fr> * Fold constants in generated code for all runtimes Go: getInlineTestSetWordSize 32 -> 64 Dart: get rid of BigInt Swift: optimize TestSetInline Python: fixes #3698 JavaScript: fixes #3699 Signed-off-by: Ivan Kochurkin <kvanttt@gmail.com> Signed-off-by: Eric Vergnaud <eric.vergnaud@wanadoo.fr> * Use int literals instead of refs for Python and JavaScript Update getMultiTokenAlternativeDescriptor test fixes #3703 Signed-off-by: Ivan Kochurkin <kvanttt@gmail.com> Signed-off-by: Eric Vergnaud <eric.vergnaud@wanadoo.fr> * update release doc for Go version numbers Signed-off-by: Terence Parr <parrt@antlr.org> Signed-off-by: Eric Vergnaud <eric.vergnaud@wanadoo.fr> * fix: #2016 Fix Go template list reference, go runtime and got test template for list labels Signed-off-by: Jim.Idle <jimi@gatherstars.com> Signed-off-by: Eric Vergnaud <eric.vergnaud@wanadoo.fr> * feat: Add a deprecation message to the existing v1 module Signed-off-by: Jim.Idle <jimi@gatherstars.com> Signed-off-by: Eric Vergnaud <eric.vergnaud@wanadoo.fr> * Split tool and runtime tests for GitHub workflow Build only necessary modules for tests Signed-off-by: Ivan Kochurkin <kvanttt@gmail.com> Signed-off-by: Eric Vergnaud <eric.vergnaud@wanadoo.fr> * Remove not used methods from FileUtils (runtime tests) Signed-off-by: Ivan Kochurkin <kvanttt@gmail.com> Signed-off-by: Eric Vergnaud <eric.vergnaud@wanadoo.fr> * Update dependencies of antlr4-maven-plugin Signed-off-by: Ivan Kochurkin <kvanttt@gmail.com> Signed-off-by: Eric Vergnaud <eric.vergnaud@wanadoo.fr> * Update jUnit: 5.8.2 -> 5.9.0 Signed-off-by: Ivan Kochurkin <kvanttt@gmail.com> Signed-off-by: Eric Vergnaud <eric.vergnaud@wanadoo.fr> * Fixes #3733; update ST4 so it uses proper ANTLR 3 Signed-off-by: Terence Parr <parrt@antlr.org> Signed-off-by: Eric Vergnaud <eric.vergnaud@wanadoo.fr> * tweak doc Signed-off-by: Terence Parr <parrt@antlr.org> Signed-off-by: Eric Vergnaud <eric.vergnaud@wanadoo.fr> * Set to 4.11.0 not 4.11 in poms Signed-off-by: Eric Vergnaud <eric.vergnaud@wanadoo.fr> * [maven-release-plugin] prepare release 4.11.0 Signed-off-by: Eric Vergnaud <eric.vergnaud@wanadoo.fr> * [maven-release-plugin] prepare for next development iteration Signed-off-by: Eric Vergnaud <eric.vergnaud@wanadoo.fr> * Damn. java target said 4.10.2 not 4.11.0 Signed-off-by: Terence Parr <parrt@antlr.org> Signed-off-by: Eric Vergnaud <eric.vergnaud@wanadoo.fr> * roll back to 4.11.0; made mistake Signed-off-by: Terence Parr <parrt@antlr.org> Signed-off-by: Eric Vergnaud <eric.vergnaud@wanadoo.fr> * roll back to 4.11.0; made mistake Signed-off-by: Terence Parr <parrt@antlr.org> Signed-off-by: Eric Vergnaud <eric.vergnaud@wanadoo.fr> * [maven-release-plugin] prepare release antlr4-master-4.11.0 Signed-off-by: Eric Vergnaud <eric.vergnaud@wanadoo.fr> * [maven-release-plugin] prepare for next development iteration Signed-off-by: Eric Vergnaud <eric.vergnaud@wanadoo.fr> * use build and twine to publish source and wheel Signed-off-by: Qijia Liu <liumeo@pku.edu.cn> Signed-off-by: Eric Vergnaud <eric.vergnaud@wanadoo.fr> * tweak doc Signed-off-by: Terence Parr <parrt@antlr.org> Signed-off-by: Eric Vergnaud <eric.vergnaud@wanadoo.fr> * tweak c++ build script to make Mac binaries with cmake/make Signed-off-by: Terence Parr <parrt@antlr.org> Signed-off-by: Eric Vergnaud <eric.vergnaud@wanadoo.fr> * tweak release doc Signed-off-by: Terence Parr <parrt@antlr.org> Signed-off-by: Eric Vergnaud <eric.vergnaud@wanadoo.fr> * tweak code / doc related to bad previous release Signed-off-by: Terence Parr <parrt@antlr.org> Signed-off-by: Eric Vergnaud <eric.vergnaud@wanadoo.fr> * [maven-release-plugin] prepare release 4.11.1 Signed-off-by: Eric Vergnaud <eric.vergnaud@wanadoo.fr> * [maven-release-plugin] prepare for next development iteration Signed-off-by: Eric Vergnaud <eric.vergnaud@wanadoo.fr> * clean up deploy c++ source script Signed-off-by: Terence Parr <parrt@antlr.org> Signed-off-by: Eric Vergnaud <eric.vergnaud@wanadoo.fr> * cleanup code generation Signed-off-by: Eric Vergnaud <eric.vergnaud@wanadoo.fr> * don't initialize default param values twice Signed-off-by: Eric Vergnaud <eric.vergnaud@wanadoo.fr> * add missing field Signed-off-by: Eric Vergnaud <eric.vergnaud@wanadoo.fr> * update codegen template for 4.11.1 Signed-off-by: Eric Vergnaud <eric.vergnaud@wanadoo.fr> * support new param: Parser Signed-off-by: Eric Vergnaud <eric.vergnaud@wanadoo.fr> * fix template for 4.11 Signed-off-by: Eric Vergnaud <eric.vergnaud@wanadoo.fr> * default export Listener and Visitor Signed-off-by: Eric Vergnaud <eric.vergnaud@wanadoo.fr> * also default export parser and lexer Signed-off-by: Eric Vergnaud <eric.vergnaud@wanadoo.fr> * all tests pass except 7 caused by #3868 Signed-off-by: Eric Vergnaud <eric.vergnaud@wanadoo.fr> * fix issues Signed-off-by: Eric Vergnaud <eric.vergnaud@wanadoo.fr> * make it easy to break Signed-off-by: Eric Vergnaud <eric.vergnaud@wanadoo.fr> * fix #3868 Signed-off-by: Eric Vergnaud <eric.vergnaud@wanadoo.fr> * ALL TESTS PASS!!!! Signed-off-by: Eric Vergnaud <eric.vergnaud@wanadoo.fr> * cross fingers with CI Signed-off-by: Eric Vergnaud <eric.vergnaud@wanadoo.fr> * try fixing broken go tests Signed-off-by: Eric Vergnaud <eric.vergnaud@wanadoo.fr> * Try fix typescript CI Signed-off-by: Eric Vergnaud <eric.vergnaud@wanadoo.fr> * disable cpp for now Signed-off-by: Eric Vergnaud <eric.vergnaud@wanadoo.fr> * fix broken config Signed-off-by: Eric Vergnaud <eric.vergnaud@wanadoo.fr> * try fix macos gh build Signed-off-by: Eric Vergnaud <eric.vergnaud@wanadoo.fr> * improve speed by caching node_modules Signed-off-by: Eric Vergnaud <eric.vergnaud@wanadoo.fr> * no longer using ts-node Signed-off-by: Eric Vergnaud <eric.vergnaud@wanadoo.fr> * fix all tsc warnings Signed-off-by: Eric Vergnaud <eric.vergnaud@wanadoo.fr> * try fix MacOS CI Signed-off-by: Eric Vergnaud <eric.vergnaud@wanadoo.fr> * CI errors seem random, reactivate ubuntu Signed-off-by: Eric Vergnaud <eric.vergnaud@wanadoo.fr> * Disable node_modules caching, which seems to randomly fail in CI Signed-off-by: Eric Vergnaud <eric.vergnaud@wanadoo.fr> * don't delete symlink contents on windows (java bug with is SymbolicLink ?) Signed-off-by: Eric Vergnaud <eric.vergnaud@wanadoo.fr> * fix broken windows CI Signed-off-by: ERIC-WINDOWS\ericv <eric.vergnaud@wanadoo.fr> Signed-off-by: Eric Vergnaud <eric.vergnaud@wanadoo.fr> * verify windows ci Signed-off-by: ERIC-WINDOWS\ericv <eric.vergnaud@wanadoo.fr> Signed-off-by: Eric Vergnaud <eric.vergnaud@wanadoo.fr> * Revert "verify windows ci" This reverts commit 770d821. Signed-off-by: Eric Vergnaud <eric.vergnaud@wanadoo.fr> * reinstate full CI Signed-off-by: Eric Vergnaud <eric.vergnaud@wanadoo.fr> * manually merged * manually merge * fix merge * fix broken template * add template for invoking context list * fix typo * fix test templates * Add code of conduct but with a different name since I do not like that name Signed-off-by: Terence Parr <parrt@antlr.org> * Update C# release instructions * Tweak code of conduct Signed-off-by: Terence Parr <parrt@antlr.org> * Bring back the Package.swift in the project's root Signed-off-by: Nikolay Edigaryev <edigaryev@gmail.com> * swift-target.md: fix SPM installation instructions Signed-off-by: Nikolay Edigaryev <edigaryev@gmail.com> * the scope (parser or lexer) in @parser::header was dropped, so keep track of it and only include @Header in Listener and Visitor code Signed-off-by: Eric Vergnaud <eric.vergnaud@wanadoo.fr> * drop workaround in favor of #3878 * drop cache usage since it fails in CI * #3878 was missing some scenarios * fix issue when deleting test folder * fix warnings * drop duplicate behavior * drop alien 'abstractRecognizer' property * drop alien property 'channels' * fix various codegen issues * change import * restore js extensions, see microsoft/TypeScript#50501 * use consistent inheritance * more API * more API stuff * fix typo * fix typescript exports * use ts-node to run typescript tests * webpack runtime before linking * fix exec paths on windows Signed-off-by: ERIC-WINDOWS\ericv <eric.vergnaud@wanadoo.fr> * fix failing tests * fix a few import issues * merge typescript-target with latest dev * runs Java and JavaScript tests after merging typescript-target * merge test template * skip unsupported test * fix template prototype * fix missing merge * bump typescript beta version after rebase * update docs * rollback unwanted changes Signed-off-by: HS <hs@apotell.com> Signed-off-by: Eric Vergnaud <eric.vergnaud@wanadoo.fr> Signed-off-by: nicksxs <nicksxs@hotmail.com> Signed-off-by: Terence Parr <parrt@antlr.org> Signed-off-by: Hell_Ghost <dev.hellghost@gmail.com> Signed-off-by: Hell_Ghost dev.hellghost@gmail.com Signed-off-by: Ross Patterson <ross.patterson@gmail.com> Signed-off-by: James Taylor <jamestaylor@apache.org> Signed-off-by: Bryan Tan <bryantan@technius.net> Signed-off-by: Jim.Idle <jimi@gatherstars.com> Signed-off-by: Tim McCormack <cortex@brainonfire.net> Signed-off-by: Ivan Kochurkin <kvanttt@gmail.com> Signed-off-by: Qijia Liu <liumeo@pku.edu.cn> Signed-off-by: ERIC-WINDOWS\ericv <eric.vergnaud@wanadoo.fr> Signed-off-by: Nikolay Edigaryev <edigaryev@gmail.com> Co-authored-by: HS <hs@apotell.com> Co-authored-by: nicksxs <nicksxs@hotmail.com> Co-authored-by: Terence Parr <parrt@antlr.org> Co-authored-by: Hell_Ghost <dev.hellghost@gmail.com> Co-authored-by: Ross Patterson <ross.patterson@gmail.com> Co-authored-by: James Taylor <jamestaylor@apache.org> Co-authored-by: Bryan Tan <bryantan@technius.net> Co-authored-by: Jim.Idle <jimi@gatherstars.com> Co-authored-by: Tim McCormack <cortex@brainonfire.net> Co-authored-by: Robert Adam <dev@robert-adam.de> Co-authored-by: Bryan Tan <Technius@users.noreply.github.com> Co-authored-by: Ivan Kochurkin <kvanttt@gmail.com> Co-authored-by: Qijia Liu <liumeo@pku.edu.cn> Co-authored-by: Nikolay Edigaryev <edigaryev@gmail.com>
antlr · Dec 21, 2022 · 2c75e64 · 2c75e64
1 parent 31bdd52
commit 2c75e64
Show file tree

Hide file tree

Showing 108 changed files with 3,687 additions and 1,623 deletions.
diff --git a/.github/workflows/hosted.yml b/.github/workflows/hosted.yml
@@ -167,6 +167,7 @@ jobs:
           go,
           java,
           javascript,
+          typescript,
           php,
           python2,
           python3,
@@ -242,7 +243,7 @@ jobs:
         architecture: 'x64'
 
     - name: Set up Node 14
-      if: matrix.target == 'javascript'
+      if: (matrix.target == 'javascript') || (matrix.target == 'typescript')
       uses: actions/setup-node@v3.5.1
       with:
         node-version: '14'

diff --git a/doc/javascript-target.md b/doc/javascript-target.md
@@ -195,14 +195,13 @@ antlr4.tree.ParseTreeWalker.DEFAULT.walk(printer, tree);
 
 ## What about TypeScript?
 
-We currently do not have a TypeScript target, but Sam Harwell is [working on a port](https://github.com/tunnelvisionlabs/antlr4ts). [Here](https://github.com/ChuckJonas/extract-interface-ts) is Section 4.3 of [ANTLR 4 book](http://a.co/5jUJYmh) converted to typescript.
+We have a [TypeScript target](typescript-target.md), based on the JavaScript target.
 
 ## How do I integrate my parser with ACE editor?
 
 This specific task is described in this [dedicated page](ace-javascript-target.md).
  
 ## How can I learn more about ANTLR?
- 
 
 Further information can be found from  "The definitive ANTLR 4 reference" book.
 

diff --git a/doc/targets.md b/doc/targets.md
@@ -6,6 +6,7 @@ This page lists the available and upcoming ANTLR runtimes. Please note that you
 * [C#](csharp-target.md)
 * [Python](python-target.md) (2 and 3)
 * [JavaScript](javascript-target.md)
+* [TypeScript](typescript-target.md)
 * [Go](go-target.md)
 * [C++](cpp-target.md)
 * [Swift](swift-target.md)

diff --git a/doc/typescript-target.md b/doc/typescript-target.md
@@ -0,0 +1,125 @@
+# TypeScript
+
+Antlr4 TypeScript runtime uses the JavaScript runtime and adds type files to it.
+This guarantees the same behaviour and performance across both target languages.
+Generated lexers, parsers, listeners and visitors are generated in TypeScript.
+
+The runtime is built using TypeScript v4.8.3, node 16.17 and webpack 5.66.
+It may work with older versions but they have not been tested and they will not be supported.
+
+
+## How to create a TypeScript lexer or parser?
+
+This is pretty much the same as creating a Java lexer or parser, except you need to specify the language target, for example:
+
+```bash
+$ antlr4 -Dlanguage=TypeScript MyGrammar.g4
+```
+
+For a full list of antlr4 tool options, please visit the [tool documentation page](tool-options.md).
+
+## Where can I get the runtime?
+
+Once you've generated the lexer and/or parser code, you need to download the runtime from [npm](https://www.npmjs.com/package/antlr4).
+
+We will not document here how to refer to the runtime from your project, since this would differ a lot depending on your project type and IDE. 
+
+## How do I get the runtime in my browser?
+
+The runtime is webpacked and sits in the dist folder. A .map file is also provided.
+
+## How do I run the generated lexer and/or parser?
+
+Let's suppose that your grammar is named, as above, "MyGrammar". Let's suppose this parser comprises a rule named "MyStartRule". The tool will have generated for you the following files:
+
+*   MyGrammarLexer.js
+*   MyGrammarParser.js
+*   MyGrammarListener.js (if you have not activated the -no-listener option)
+*   MyGrammarVisitor.js (if you have activated the -visitor option)
+
+There is no listener or visitor interface generated, instead the generated listener and visitor class methods are implemented using lambdas.
+
+Now a fully functioning script might look like the following:
+
+```typescript
+import { CharStream, CommonTokenStream }  from 'antlr4';
+import MyGrammarLexer from './MyGrammarLexer';
+import MyGrammarParser from './MyGrammarParser';
+
+const input = "your text to parse here"
+const chars = new CharStream(input); // replace this with a FileStream as required
+const lexer = new MyGrammarLexer(chars);
+const tokens = new CommonTokenStream(lexer);
+const parser = new MyGrammarParser(tokens);
+const tree = parser.MyStartRule();
+
+```
+
+Tha above program will work. But it won't be useful unless you do one of the following:
+
+* you visit the parse tree using a custom listener
+* you visit the parse tree using a custom visitor
+* your grammar contains production code (like AntLR3)
+
+(please note that production code is target specific, so you can't have multi target grammars that include production code)
+
+## How do I create and run a visitor?
+
+You need to create a custom visitor and use it to visit the parse tree, as follows:
+```typescript
+
+import { ParserRuleContext } from 'antlr4';
+import MyGrammarVisitor from './MyGrammarVisitor';
+
+class CustomVisitor extends MyGrammarVisitor {
+
+  visitChildren(ctx: ParserRuleContext) {
+    if (!ctx) {
+      return;
+    }
+    if (ctx.children) {
+      return ctx.children.map(child => {
+        if (child.children && child.children.length != 0) {
+          return child.accept(this);
+        } else {
+          return child.getText();
+        }
+      });
+    }
+  }
+}
+
+tree.accept(new Visitor());
+````
+
+## How do I create and run a custom listener?
+
+You need to create a custom listener and use it to visit the parse tree, as follows:
+
+```typescript
+
+import { ParseTreeWalker } from 'antlr4';
+import MyGrammarListener from './MyGrammarListener';
+
+class MyTreeWalker extends MyGrammarListener {
+
+    exitMyStartRule = (ctx: MyStartRuleContext) => {
+        console.log("In MyStartRule");
+    };
+    
+}
+
+const walker = new MyTreeWalker();
+ParseTreeWalker.DEFAULT.walk(walker, tree);
+
+```
+
+## How do I integrate my parser with ACE editor?
+
+This specific task is described in this [dedicated page](ace-javascript-target.md).
+
+## How can I learn more about ANTLR?
+
+Further information can be found from  "The definitive ANTLR 4 reference" book.
+
+The TypeScript implementation of ANTLR is based on the JavaScript implementation, which is as close as possible to the Java one, so you shouldn't find it difficult to adapt the book's examples to TypeScript.
diff --git a/...estsuite/resources/org/antlr/v4/test/runtime/descriptors/ParserErrors/ExtraneousInput.txt b/...estsuite/resources/org/antlr/v4/test/runtime/descriptors/ParserErrors/ExtraneousInput.txt
@@ -26,6 +26,7 @@ Cpp
 CSharp
 Go
 JavaScript
+TypeScript
 PHP
 Python2
 Python3
diff --git a/...urces/org/antlr/v4/test/runtime/descriptors/Performance/DropLoopEntryBranchInLRRule_4.txt b/...urces/org/antlr/v4/test/runtime/descriptors/Performance/DropLoopEntryBranchInLRRule_4.txt
@@ -54,5 +54,6 @@ between X1 and X2 or between X3 and X4
 Python2
 Python3
 JavaScript
+TypeScript
 PHP
 
diff --git a/...org/antlr/v4/test/runtime/descriptors/SemPredEvalParser/PredFromAltTestedInLoopBack_1.txt b/...org/antlr/v4/test/runtime/descriptors/SemPredEvalParser/PredFromAltTestedInLoopBack_1.txt
@@ -39,6 +39,7 @@ CSharp
 Dart
 Go
 JavaScript
+TypeScript
 PHP
 Python2
 Python3
diff --git a/runtime-testsuite/resources/org/antlr/v4/test/runtime/helpers/Test.ts.stg b/runtime-testsuite/resources/org/antlr/v4/test/runtime/helpers/Test.ts.stg
@@ -0,0 +1,63 @@
+import {
+	FileStream,
+	CommonTokenStream,
+	DiagnosticErrorListener,
+	Lexer,
+	ParseTreeListener,
+	ParseTreeWalker,
+	RuleContext,
+	ParserRuleContext,
+	RuleNode
+} from 'antlr4';
+import <lexerName> from './<lexerName>.js';
+<if(parserName)>
+import <parserName> from './<parserName>.js';
+<if(useListener)>
+import <grammarName>Listener from './<grammarName>Listener.js';
+<endif>
+<if(useVisitor)>
+import <grammarName>Visitor from './<grammarName>Visitor.js';
+<endif>
+
+class TreeShapeListener extends ParseTreeListener {
+    enterEveryRule(ctx: ParserRuleContext) {
+        for (let i = 0; i \< ctx.getChildCount(); i++) {
+            const child = ctx.getChild(i) as RuleContext;
+            const parent = child.parentCtx;
+            if (parent!.ruleContext !== ctx || !(parent instanceof RuleNode)) {
+                throw `Invalid parse tree shape detected.`;
+            }
+        }
+    }
+}
+<endif>
+
+function main(argv: string[]): void {
+    const input = new FileStream(argv[2], true);
+    const lexer = new <lexerName>(input);
+    const stream = new CommonTokenStream(lexer);
+<if(parserName)>
+    const parser = new <parserName>(stream);
+<if(showDiagnosticErrors)>
+    parser.addErrorListener(new DiagnosticErrorListener());
+<endif>
+    parser.buildParseTrees = true;
+    parser.printer = {
+        println : function(s: string) { console.log(s); },
+        print : function(s: string) { process.stdout.write(s); }
+    };
+    const tree = parser.<parserStartRuleName>();
+    ParseTreeWalker.DEFAULT.walk(new TreeShapeListener(), tree);
+<else>
+    stream.fill();
+    for(let i=0; i\<stream.tokens.length; i++) {
+        console.log(stream.tokens[i].toString());
+    }
+<if(showDFA)>
+    process.stdout.write(lexer._interp.decisionToDFA[Lexer.DEFAULT_MODE].toLexerString());
+<endif>
+<endif>
+}
+
+main(process.argv);
+
diff --git a/...ntlr/v4/test/runtime/helpers/package.json → ...r/v4/test/runtime/helpers/package_js.json b/...ntlr/v4/test/runtime/helpers/package.json → ...r/v4/test/runtime/helpers/package_js.json
diff --git a/runtime-testsuite/resources/org/antlr/v4/test/runtime/helpers/package_ts.json b/runtime-testsuite/resources/org/antlr/v4/test/runtime/helpers/package_ts.json
@@ -0,0 +1,9 @@
+{
+  "type": "module",
+   "devDependencies": {
+    "@types/node": "^18.0.5"
+   },
+  "dependencies": {
+    "antlr4": "^4.10.1"
+  }
+}
diff --git a/runtime-testsuite/resources/org/antlr/v4/test/runtime/helpers/tsconfig.json b/runtime-testsuite/resources/org/antlr/v4/test/runtime/helpers/tsconfig.json
@@ -0,0 +1,11 @@
+{
+  "compilerOptions": {
+    "module": "ES2020",
+    "moduleResolution": "node",
+    "target": "ES6",
+    "noImplicitAny": true,
+  },
+  "ts-node": {
+    "esm": true
+  }
+}