Skip to content

[SBT-013] Provide an option to users to instruct antlr to treat warnings as errors when generating the parser. #23

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ihji merged 3 commits into from
Mar 11, 2019
Merged

[SBT-013] Provide an option to users to instruct antlr to treat warnings as errors when generating the parser. #23

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4216985
Add argument to instruct antlr to report error on warnings
dilipbiswal Mar 9, 2019
15edeb2
README
dilipbiswal Mar 9, 2019
d70f466
Update Antlr4Plugin.scala
ihji Mar 11, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,11 +19,13 @@ And, add `antlr4Settings` to your `build.sbt` file.

antlr4PackageName in Antlr4 := Some("com.simplytyped")

You can also adjust `-listener`, `-no-listener`, `-visitor`, `-no-visitor` options:
You can also adjust `-listener`, `-no-listener`, `-visitor`, `-no-visitor`, `-Werror` options:

antlr4GenListener in Antlr4 := true // default: true

antlr4GenVisitor in Antlr4 := false // default: false

antlr4TreatWarningsAsErrors := true // default : false

## License

Expand Down
13 changes: 9 additions & 4 deletions src/main/scala/com/simplytyped/Antlr4Plugin.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ object Antlr4Plugin extends Plugin {
val antlr4PackageName = SettingKey[Option[String]]("Name of the package for generated classes")
val antlr4GenListener = SettingKey[Boolean]("Generate listener")
val antlr4GenVisitor = SettingKey[Boolean]("Generate visitor")
val antlr4TreatWarningsAsErrors = SettingKey[Boolean]("Treat warnings as errors when generating parser")

private val antlr4BuildDependency = SettingKey[ModuleID]("Build dependency required for parsing grammars, scoped to plugin")

Expand All @@ -26,7 +27,8 @@ object Antlr4Plugin extends Plugin {
log = streams.value.log,
packageName = (antlr4PackageName in Antlr4).value,
listenerOpt = (antlr4GenListener in Antlr4).value,
visitorOpt = (antlr4GenVisitor in Antlr4).value
visitorOpt = (antlr4GenVisitor in Antlr4).value,
warningsAsErrorOpt = (antlr4TreatWarningsAsErrors in Antlr4).value
)
}
cachedCompile(((sourceDirectory in Antlr4).value ** "*.g4").get.toSet).toSeq
Expand All @@ -39,14 +41,16 @@ object Antlr4Plugin extends Plugin {
log: Logger,
packageName: Option[String],
listenerOpt: Boolean,
visitorOpt: Boolean) = {
visitorOpt: Boolean,
warningsAsErrorOpt: Boolean) = {
val targetDir = packageName.map{_.split('.').foldLeft(targetBaseDir){_/_}}.getOrElse(targetBaseDir)
val baseArgs = Seq("-cp", Path.makeString(classpath), "org.antlr.v4.Tool", "-o", targetDir.toString)
val packageArgs = packageName.toSeq.flatMap{p => Seq("-package",p)}
val listenerArgs = if(listenerOpt) Seq("-listener") else Seq("-no-listener")
val visitorArgs = if(visitorOpt) Seq("-visitor") else Seq("-no-visitor")
val sourceArgs = srcFiles.map{_.toString}
val args = baseArgs ++ packageArgs ++ listenerArgs ++ visitorArgs ++ sourceArgs
val warningAsErrorArgs = if (warningsAsErrorOpt) Seq("-Werror") else Seq.empty
val args = baseArgs ++ packageArgs ++ listenerArgs ++ visitorArgs ++ warningAsErrorArgs ++ sourceArgs
val exitCode = Process("java", args) ! log
if(exitCode != 0) sys.error(s"Antlr4 failed with exit code $exitCode")
(targetDir ** "*.java").get.toSet
Expand All @@ -63,7 +67,8 @@ object Antlr4Plugin extends Plugin {
antlr4BuildDependency := antlr4Dependency.value % Antlr4.name,
antlr4PackageName := None,
antlr4GenListener := true,
antlr4GenVisitor := false
antlr4GenVisitor := false,
antlr4TreatWarningsAsErrors := false
)) ++ Seq(
ivyConfigurations += Antlr4,
managedSourceDirectories in Compile <+= (javaSource in Antlr4),
Expand Down