-
Notifications
You must be signed in to change notification settings - Fork 128
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.
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
Add support for using directive in java files #639
Merged
Merged
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
76ad193
Add support for using directive in java files
ghostbuster91 0d67b86
Extract ExtractedDirectives out from ScalaPreprocessor
ghostbuster91 5458111
Refactor: apply tell don't ask principle
ghostbuster91 a816d24
Make error more descriptive
ghostbuster91 1b56405
Update modules/build/src/test/scala/scala/build/tests/SourcesTests.scala
eb215fe
Improve error message when directive is not supported
ghostbuster91 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
7 changes: 5 additions & 2 deletions
7
modules/build/src/main/scala/scala/build/errors/DirectiveErrors.scala
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,5 +1,8 @@ | ||
| package scala.build.errors | ||
|
|
||
| final class DirectiveErrors(errors: ::[String]) extends BuildException( | ||
| "Directives errors: " + errors.mkString(", ") | ||
| import scala.build.Position | ||
|
|
||
| final class DirectiveErrors(errors: ::[String], positions: Seq[Position]) extends BuildException( | ||
| "Directives errors: " + errors.mkString(", "), | ||
| positions = positions | ||
| ) |
132 changes: 132 additions & 0 deletions
132
modules/build/src/main/scala/scala/build/preprocessing/ExtractedDirectives.scala
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,132 @@ | ||
| package scala.build.preprocessing | ||
|
|
||
| import com.virtuslab.using_directives.config.Settings | ||
| import com.virtuslab.using_directives.custom.model.{ | ||
| UsingDirectiveKind, | ||
| UsingDirectiveSyntax, | ||
| UsingDirectives | ||
| } | ||
| import com.virtuslab.using_directives.custom.utils.ast.{UsingDef, UsingDefs} | ||
| import com.virtuslab.using_directives.{Context, UsingDirectivesProcessor} | ||
|
|
||
| import scala.build.errors._ | ||
| import scala.build.preprocessing.directives.{DirectiveUtil, StrictDirective} | ||
| import scala.build.{Logger, Position} | ||
| import scala.collection.mutable | ||
| import scala.jdk.CollectionConverters._ | ||
|
|
||
| case class ExtractedDirectives( | ||
| offset: Int, | ||
| directives: Seq[StrictDirective] | ||
| ) | ||
|
|
||
| object ExtractedDirectives { | ||
|
|
||
| val changeToSpecialCommentMsg = | ||
| "Using directive using plain comments are deprecated. Please use a special comment syntax: '//> ...' or '/*> ... */'" | ||
|
|
||
| def from( | ||
| contentChars: Array[Char], | ||
| path: Either[String, os.Path], | ||
| logger: Logger, | ||
| supportedDirectives: Array[UsingDirectiveKind], | ||
| cwd: ScopePath | ||
| ): Either[BuildException, ExtractedDirectives] = { | ||
| val errors = new mutable.ListBuffer[Diagnostic] | ||
| val reporter = CustomDirectivesReporter.create(path) { diag => | ||
| if (diag.severity == Severity.Warning) | ||
| logger.log(Seq(diag)) | ||
| else | ||
| errors += diag | ||
| } | ||
| val processor = { | ||
| val settings = new Settings | ||
| settings.setAllowStartWithoutAt(true) | ||
| settings.setAllowRequire(false) | ||
| val context = new Context(reporter, settings) | ||
| new UsingDirectivesProcessor(context) | ||
| } | ||
| val all = processor.extract(contentChars, true, true).asScala | ||
| if (errors.isEmpty) { | ||
|
|
||
| def byKind(kind: UsingDirectiveKind) = all.find(_.getKind == kind).get | ||
|
|
||
| def getDirectives(directives: UsingDirectives) = | ||
| directives.getAst() match { | ||
| case ud: UsingDefs => | ||
| ud.getUsingDefs().asScala | ||
| case _ => | ||
| Nil | ||
| } | ||
|
|
||
| val codeDirectives = byKind(UsingDirectiveKind.Code) | ||
| val specialCommentDirectives = byKind(UsingDirectiveKind.SpecialComment) | ||
| val plainCommentDirectives = byKind(UsingDirectiveKind.PlainComment) | ||
|
|
||
| def reportWarning(msg: String, values: Seq[UsingDef], before: Boolean = true): Unit = | ||
| values.foreach { v => | ||
| val astPos = v.getPosition() | ||
| val (start, end) = | ||
| if (before) (0, astPos.getColumn()) | ||
| else (astPos.getColumn(), astPos.getColumn() + v.getSyntax.getKeyword.size) | ||
| val position = Position.File(path, (astPos.getLine(), start), (astPos.getLine(), end)) | ||
| logger.diagnostic(msg, positions = Seq(position)) | ||
| } | ||
|
|
||
| val usedDirectives = | ||
| if (!codeDirectives.getFlattenedMap().isEmpty()) { | ||
| val msg = | ||
| "This using directive is ignored. File contains directives outside comments and those have higher precedence." | ||
| reportWarning( | ||
| msg, | ||
| getDirectives(plainCommentDirectives) ++ getDirectives(specialCommentDirectives) | ||
| ) | ||
| codeDirectives | ||
| } | ||
| else if (!specialCommentDirectives.getFlattenedMap().isEmpty()) { | ||
| val msg = | ||
| s"This using directive is ignored. $changeToSpecialCommentMsg" | ||
| reportWarning(msg, getDirectives(plainCommentDirectives)) | ||
| specialCommentDirectives | ||
| } | ||
| else { | ||
| reportWarning(changeToSpecialCommentMsg, getDirectives(plainCommentDirectives)) | ||
| plainCommentDirectives | ||
| } | ||
|
|
||
| // All using directives should use just `using` keyword, no @using or require | ||
| reportWarning( | ||
| "Deprecated using directive syntax, please use keyword `using`.", | ||
| getDirectives(usedDirectives).filter(_.getSyntax() != UsingDirectiveSyntax.Using), | ||
| before = false | ||
| ) | ||
|
|
||
| val flattened = usedDirectives.getFlattenedMap.asScala.toSeq | ||
| val strictDirectives = | ||
| flattened.map { | ||
| case (k, l) => | ||
| StrictDirective(k.getPath.asScala.mkString("."), l.asScala.toSeq) | ||
| } | ||
|
|
||
| val offset = | ||
| if (usedDirectives.getKind() != UsingDirectiveKind.Code) 0 | ||
| else usedDirectives.getCodeOffset() | ||
| if (supportedDirectives.contains(usedDirectives.getKind())) | ||
| Right(ExtractedDirectives(offset, strictDirectives)) | ||
| else { | ||
| val directiveVales = | ||
| usedDirectives.getFlattenedMap.values().asScala.toList.flatMap(_.asScala) | ||
| val values = DirectiveUtil.stringValues(directiveVales, path, cwd) ++ | ||
| DirectiveUtil.numericValues(directiveVales, path, cwd) | ||
| Left(new DirectiveErrors( | ||
| ::(s"Directive '${usedDirectives.getKind}' is not supported in the given context'", Nil), | ||
| values.flatMap(_._1.positions) | ||
| )) | ||
| } | ||
| } | ||
| else { | ||
| val errors0 = errors.map(diag => new MalformedDirectiveError(diag.message, diag.positions)) | ||
| Left(CompositeBuildException(errors0.toSeq)) | ||
| } | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It would be nice if we could enrich the
DirectiveErrorhere with the information that it happened in the java context but theDirectiveErroris an opaque class.