moonstoneid / apg-java Goto Github PK

Version: 1.1.1

Note: Version 1.1.0 updates version 1.0 in a couple of ways. Primarily, the license is changed to the more permissive 2-Clause BSD license. Also, in the installation section below are instructions on how to include Java APG in a maven project. I want to thank Raviteja Lokineni (@bond-) for suggesting these changes and especially Stephen Sill II (@ssill2) for his friendly and expert nudging of me up the maven learning curve. (See issue #6.)

Description:

• Java APG is APG - an ABNF Parser Generator written completely in the Java language.
• generates parsers in Java
• generates language parsers and translators from a superset of the Augmented Backus-Naur Form (RFC5234 and RFC7405) grammar syntax
• accepts valid ABNF grammars
• accepts AND & NOT syntactic predicate operators for conditional parsing based on specified, look-ahead phrases
• accepts User-Defined Terminals (UDTs) which allow user-written, non-Context-Free phrase recognition operators
• user-written callback functions provide complete monitoring and flow control of the parser
• accept case-sensitive literal strings in single quotes
• accept multiple input ABNF grammar files
• optional generation of an Abstract Syntax Tree (AST)
• translation of the AST with user-written callback functions
• extensive tracing facilities
• statistics gathering for a full picture of parse tree node coverage
• extensive attribute generation for an overview of the grammar's characteristics

Installation:

git clone https://github.com/ldthomas/apg-java.git
cd apg-java
git checkout maven
mvn clean install

This will do the following:

• Build the library jar under target.
• Execute unit tests.
• Generate javadoc under target/site/apidocs
• Install the jar in the local maven repository for use by other projects that need apg-java as a dependency.

To use apg-java in your project just modify the project's pom.xml file to include the following dependency.

<dependencies>
    <dependency>
       <groupId>com.ldthomas.apg</groupId>
       <artifactId>apg-java</artifactId>
       <version>1.1.1</version>
    </dependency>
</dependencies>

See the maven.md for details on how to run the examples in a NetBeans maven project.

NOTE: A second branch, maven, has been added which is a complete maven project for apg and the examples. It was created by Stephen Sill II on his apg-java fork. It has updates to satisfy some of the security items flagged by Fortify security scans. The Fortify updates have not been integrated into the master branch.

To see the documentation open the following file in a web-browser.

target/site/apidocs/index.html

Or visit the APG website.

Copyright:
Copyright © 2021 Lowell D. Thomas, all rights reserved

License:
Java APG Version 1.1.0 is released under the 2-Clause BSD license.