jasder
/
antlr
1
0
Fork 1
Code Issues Pull Requests Releases 1 Wiki Activity

Merge pull request #635 from sharwell/relax-versioning 

Relax versioning
This commit is contained in:
Terence Parr 2014-06-18 17:11:18 -07:00
parent 6701202f66 6949e832d9
commit db1f8e6499
2 changed files with 118 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

136
runtime/Java/src/org/antlr/v4/runtime/RuntimeMetaData.java
View File

@ -56,13 +56,29 @@ import java.util.concurrent.CopyOnWriteArraySet;
* By default, the {@link DefaultListener#INSTANCE} listener is automatically
* registered. As long as the default listener is registered, it will always be
* the last listener notified in the event of a version mismatch. This behavior
* ensures the exception it throws will not prevent {@link #checkVersion} from
* notifying custom listeners registered by a user. This default listener may be
* removed by calling {@link #removeListener} for
* ensures that custom listeners registered by a user will be notified even in
* the event the default listener throws an exception. This default listener may
* be removed by calling {@link #removeListener} for
* {@link DefaultListener#INSTANCE} or {@link #clearListeners}. If required, it
* may be re-registered by calling {@link #addListener}.</p>
*/
public class RuntimeMetaData {
/**
* A compile-time constant containing the current version of the ANTLR 4
* runtime library.
*
* <p>
* This compile-time constant value allows generated parsers and other
* libraries to include a literal reference to the version of the ANTLR 4
* runtime library the code was compiled against.</p>
*
* <p>
* During development (between releases), this value contains the
* <em>expected</em> next release version. For official releases, the value
* will be the actual published version of the library.</p>
*/
public static final String VERSION = "4.3";
/**
* This class provides detailed information about a mismatch between the
* version of the tool a parser was generated with, the version of the
@ -128,9 +144,9 @@ public class RuntimeMetaData {
* block.</li>
* <li>No additional registered listeners will be notified about the
* version mismatch. Since the default {@link DefaultListener} instance
* is always the last listener called (unless it is unregistered), the
* exception it throws will not affect the execution of any other
* registered listeners.</li>
* is always the last listener called (unless it is unregistered), it
* will not affect the execution of any other registered listeners, even
* in the case where it throws an exception.</li>
* </ul>
*
* @param ex a {@link VersionMismatchException} instance containing
@ -143,7 +159,36 @@ public class RuntimeMetaData {
/**
* This class provides a default implementation of {@link Listener} which
* responds to mismatched versions by throwing the provided
* {@link VersionMismatchException}.
* {@link VersionMismatchException} if the reported version mismatch
* indicates the versions differ by more than the <em>major</em> and
* <em>minor</em> version components.
*
* <p>
* For example, version strings x.y and x.y.z are considered "compatible",
* and this listener will not throw an exception. Likewise, version strings
* x.y-SNAPSHOT and x.y.z are considered "compatible" because the major and
* minor components x.y are the same in each.</p>
*
* <p>
* For the purposes of this listener, version numbers are assumed to have
* the form
* <em>major</em>.<em>minor</em>.<em>patch</em>.<em>revision</em>-<em>suffix</em>,
* with the individual components defined as follows.</p>
*
* <ul>
* <li><em>major</em> is a required non-negative integer, and is equal to
* {@code 4} for ANTLR 4.</li>
* <li><em>minor</em> is a required non-negative integer.</li>
* <li><em>patch</em> is an optional non-negative integer. When
* <em>patch</em> is omitted, the {@code .} (dot) appearing before it is
* also omitted.</li>
* <li><em>revision</em> is an optional non-negative integer, and may only
* be included when <em>patch</em> is also included. When <em>revision</em>
* is omitted, the {@code .} (dot) appearing before it is also omitted.</li>
* <li><em>suffix</em> is an optional string. When <em>suffix</em> is
* omitted, the {@code -} (hyphen-minus) appearing before it is also
* omitted.</li>
* </ul>
*/
public static class DefaultListener implements Listener {
/**
@ -154,10 +199,66 @@ public class RuntimeMetaData {
/**
* {@inheritDoc}
*
* <p>
* The default implementation only throws an exception when the reported
* version mismatch contains a mismatched <em>major</em> or
* <em>minor</em> version component. For details about the syntax of the
* input {@code version}, see the documentation for
* {@link DefaultListener}.</p>
*/
@Override
public void reportVersionMismatch(@NotNull VersionMismatchException ex) throws VersionMismatchException {
throw ex;
if (!isMinorVersionMatch(ex)) {
throw ex;
}
}
/**
* Determines if the reported version mismatch are a match when
* considering only the <em>major</em> and <em>minor</em> version
* components of the version strings.
*
* @param ex a {@link VersionMismatchException} instance containing
* detailed information about the specific version mismatch detected
* @return {@code true} if the <em>major</em> and <em>minor</em> version
* components of the version strings match; otherwise, {@code false}.
*/
protected boolean isMinorVersionMatch(@NotNull VersionMismatchException ex) {
String generatingToolVersion = ex.generatingToolVersion;
if (generatingToolVersion != null) {
if (!getMajorMinorVersion(VERSION).equals(getMajorMinorVersion(generatingToolVersion))) {
return false;
}
}
return getMajorMinorVersion(VERSION).equals(getMajorMinorVersion(ex.compileTimeRuntimeVersion));
}
/**
* Gets the major and minor version numbers from a version string. For
* details about the syntax of the input {@code version}, see the
* documentation for {@link DefaultListener}.
*
* @param version The complete version string.
* @return A string of the form <em>major</em>.<em>minor</em> containing
* only the major and minor components of the version string.
*/
@NotNull
protected String getMajorMinorVersion(@NotNull String version) {
int firstDot = version.indexOf('.');
int secondDot = firstDot >= 0 ? version.indexOf('.', firstDot + 1) : -1;
int firstDash = version.indexOf('-');
int referenceLength = version.length();
if (secondDot >= 0) {
referenceLength = Math.min(referenceLength, secondDot);
}
if (firstDash >= 0) {
referenceLength = Math.min(referenceLength, firstDash);
}
return version.substring(0, referenceLength);
}
}
@ -210,22 +311,6 @@ public class RuntimeMetaData {
listeners.clear();
}
/**
* A compile-time constant containing the current version of the ANTLR 4
* runtime library.
*
* <p>
* This compile-time constant value allows generated parsers and other
* libraries to include a literal reference to the version of the ANTLR 4
* runtime library the code was compiled against.</p>
*
* <p>
* During development (between releases), this value contains the
* <em>expected</em> next release version. For official releases, the value
* will be the actual published version of the library.</p>
*/
public static final String VERSION = "4.3";
/**
* Gets the currently executing version of the ANTLR 4 runtime library.
*
@ -270,7 +355,8 @@ public class RuntimeMetaData {
* This method does not perform any detection or filtering of semantic
* changes between tool and runtime versions. It simply checks for a simple
* version match and notifies the registered listeners any time a difference
* is detected.</p>
* is detected. A default instance of {@link DefaultListener} is notified
* unless it is explicitly removed.</p>
*
* <p>
* Note that some breaking changes between releases could result in other

8
tool/src/org/antlr/v4/Tool.java
View File

@ -48,6 +48,7 @@ import org.antlr.v4.parse.GrammarTreeVisitor;
import org.antlr.v4.parse.ToolANTLRLexer;
import org.antlr.v4.parse.ToolANTLRParser;
import org.antlr.v4.parse.v3TreeGrammarException;
import org.antlr.v4.runtime.RuntimeMetaData;
import org.antlr.v4.runtime.misc.LogManager;
import org.antlr.v4.runtime.misc.Nullable;
import org.antlr.v4.semantics.SemanticPipeline;
@ -87,7 +88,12 @@ import java.util.Map;
import java.util.concurrent.CopyOnWriteArrayList;
public class Tool {
public static final String VERSION = "4.3";
public static final String VERSION;
static {
// Assigned in a static{} block to prevent the field from becoming a
// compile-time constant
VERSION = RuntimeMetaData.VERSION;
}
public static final String GRAMMAR_EXTENSION = ".g4";
public static final String LEGACY_GRAMMAR_EXTENSION = ".g";