forgetest1
/
antlr
forked from jasder/antlr
1
0
Fork 0
Code Issues Pull Requests 1 Releases Wiki Activity
antlr/runtime/Cpp/README.md

55 lines
2.1 KiB
Markdown
Raw Normal View History

Added all changes done so far. Since we are here on a very old revision I cannot simply merge, so all files have manually been copied and we have no history for these changes.
2016-03-18 21:22:42 +08:00
# C++ target for ANTLR 4
Switching to current ANTLR revision, final part.
2016-05-01 18:41:32 +08:00
This folder contains the C++ runtime support for ANTLR. See [the canonical antlr4 repository](https://github.com/antlr/antlr4) for in depth detail about how to use ANTLR 4.
Added all changes done so far. Since we are here on a very old revision I cannot simply merge, so all files have manually been copied and we have no history for these changes.
2016-03-18 21:22:42 +08:00
## Authors and major contributors
ANTLR 4 is the result of substantial effort of the following people:
* [Terence Parr](http://www.cs.usfca.edu/~parrt/), parrt@cs.usfca.edu
ANTLR project lead and supreme dictator for life
[University of San Francisco](http://www.usfca.edu/)
* [Sam Harwell](http://tunnelvisionlabs.com/)
Tool co-author, Java and C# target)
The C++ target has been the work of the following people:
* Dan McLaughlin, dan.mclaughlin@gmail.com C++ Target project leader
* David Sisson, dsisson@google.com
* [Mike Lischke](www.soft-gems.net), mike@lischke-online.de
Moved Marcin to Other Contributors list.
2016-05-09 21:06:02 +08:00
## Other contributors
Added yet another possible code section + EOF rework. - @parser::context or @lexer::context are now also accepted for code that should be placed directly before the class declaration (e.g. additional types, like enums etc.) - Reverted the removal of explicit EOF handling. Thought we can just live with the EOF macro, but that doesn't work out, so we go with the same approach as the ANTLR3 C target: #undef EOF and use EOF member constants as in the original Java code. - Fixed a crash when trying to create a hash from a null parent in PredictionContext.cpp. - Generated token and rule enums are now placed in the lexer/parser classes which allows to use them without qualfication within those classes, making so actions in a grammar more language independent. Outside code still has to use e.g. TParser::ID to access them. - Made some lambda capture lists more explicit. Need to test yet if we can just use a default capture instead.
2016-05-09 20:09:00 +08:00
* Marcin Szalowicz, mszalowicz@mailplus.pl (cmake build setup)
Added all changes done so far. Since we are here on a very old revision I cannot simply merge, so all files have manually been copied and we have no history for these changes.
2016-03-18 21:22:42 +08:00
Moved Marcin to Other Contributors list.
2016-05-09 21:06:02 +08:00
## Project Status
Added all changes done so far. Since we are here on a very old revision I cannot simply merge, so all files have manually been copied and we have no history for these changes.
2016-03-18 21:22:42 +08:00
Rework of the include structure. In order to ease including the antlr runtime in other projects the include structure has been changed: - Removed precompiled header usage (only OSX, VS + cmake still need updates). - Created umbrella header antlr4-runtime.h that contains everything needed in a target application. - Changed all includes to use relative paths, so it is enough to add the src folder to the header search path in an application. - Also fixed a smaller issue in the C++ template wrt the serialized ATN storage for large grammars.
2016-05-16 00:37:56 +08:00
* Building on OS X, Windows, and Linux
Added all changes done so far. Since we are here on a very old revision I cannot simply merge, so all files have manually been copied and we have no history for these changes.
2016-03-18 21:22:42 +08:00
* No errors and warnings
* Library linking
The generation + runtime now uses std::string instead of std::wstring almost everywhere. - In order to support UTF-8 the input streams now support loading data from UTF-8 strings and convert them internally to UTF32. - Additionally, all the toString() functions that (unnecessarily) used wstring are now on string as well. Only some corner cases remain where we still have std::wstring (ATNSerializer). - The transition classes use size_t instead of int now for vocabulary matching. - The max char value in the lexer has been increased to 1FFFE, to allow matching the full Unicode range. This is also used in the Interval class to e.g. to negate sets. - Renamed Strings.h to StringUtils.h, to avoid a conflict with an OSX header (used with Obj-C compilation, e.g. in a project that uses the runtime).
2016-05-14 00:19:12 +08:00
* Some unit tests in the OSX project, for important base classes with almost 100% code coverage.
Simplified use of the demo project. - The needed ANTLR jar is provided now, so it's not needed to build it yourself. - The generate.sh script has been updated to use the new jar. - Small update of the readme too.
2016-04-21 23:57:33 +08:00
* All memory allocations checked
The generation + runtime now uses std::string instead of std::wstring almost everywhere. - In order to support UTF-8 the input streams now support loading data from UTF-8 strings and convert them internally to UTF32. - Additionally, all the toString() functions that (unnecessarily) used wstring are now on string as well. Only some corner cases remain where we still have std::wstring (ATNSerializer). - The transition classes use size_t instead of int now for vocabulary matching. - The max char value in the lexer has been increased to 1FFFE, to allow matching the full Unicode range. This is also used in the Interval class to e.g. to negate sets. - Renamed Strings.h to StringUtils.h, to avoid a conflict with an OSX header (used with Obj-C compilation, e.g. in a project that uses the runtime).
2016-05-14 00:19:12 +08:00
* Simple command line demo application working on all supported platforms.
Added all changes done so far. Since we are here on a very old revision I cannot simply merge, so all files have manually been copied and we have no history for these changes.
2016-03-18 21:22:42 +08:00
Rework of the include structure. In order to ease including the antlr runtime in other projects the include structure has been changed: - Removed precompiled header usage (only OSX, VS + cmake still need updates). - Created umbrella header antlr4-runtime.h that contains everything needed in a target application. - Changed all includes to use relative paths, so it is enough to add the src folder to the header search path in an application. - Also fixed a smaller issue in the C++ template wrt the serialized ATN storage for large grammars.
2016-05-16 00:37:56 +08:00
### Build + Usage Notes
The generation + runtime now uses std::string instead of std::wstring almost everywhere. - In order to support UTF-8 the input streams now support loading data from UTF-8 strings and convert them internally to UTF32. - Additionally, all the toString() functions that (unnecessarily) used wstring are now on string as well. Only some corner cases remain where we still have std::wstring (ATNSerializer). - The transition classes use size_t instead of int now for vocabulary matching. - The max char value in the lexer has been increased to 1FFFE, to allow matching the full Unicode range. This is also used in the Interval class to e.g. to negate sets. - Renamed Strings.h to StringUtils.h, to avoid a conflict with an OSX header (used with Obj-C compilation, e.g. in a project that uses the runtime).
2016-05-14 00:19:12 +08:00
The minimum C++ version to compile the ANTLR C++ runtime with is C++11. The supplied projects can built the runtime either as static or dynamic library, as both 32bit and 64bit arch. The OSX project contains a target for iOS and can also be built using cmake (instead of XCode).
Rework of the include structure. In order to ease including the antlr runtime in other projects the include structure has been changed: - Removed precompiled header usage (only OSX, VS + cmake still need updates). - Created umbrella header antlr4-runtime.h that contains everything needed in a target application. - Changed all includes to use relative paths, so it is enough to add the src folder to the header search path in an application. - Also fixed a smaller issue in the C++ template wrt the serialized ATN storage for large grammars.
2016-05-16 00:37:56 +08:00
Include the antlr4-runtime.h umbrella header in your target application to get everything needed to use the library.
Moved the library build instructions to the library readme.
2016-05-22 17:18:16 +08:00
#### Compiling on Windows
Simply open the VS solution (VS 2013+) and build it.
#### Compiling on OSX
Either open the included XCode project and build that or use the cmake compilation as described for linux.
#### Compiling on Linux
A few minor changes related to building via cmake.
2016-05-23 15:40:48 +08:00
- cd <antlr4-dir>/runtime/Cpp (this is where this readme is located)
Moved the library build instructions to the library readme.
2016-05-22 17:18:16 +08:00
- mkdir build && mkdir run && cd build
- cmake ..-DANTLR_JAR_LOCATION=full/path/to/antlr4-4.5.4-SNAPSHOT.jar -DWITH_DEMO=True
- make
- DESTDIR=<antlr4-dir>/runtime/Cpp/run make install
A few minor changes related to building via cmake.
2016-05-23 15:40:48 +08:00
If you don't want to build the demo then simply run cmake without parameters.