-
Notifications
You must be signed in to change notification settings - Fork 17
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #34 from DarthKipsu/lang-syntax
Language syntax parser plugin
- Loading branch information
Showing
7 changed files
with
222 additions
and
22 deletions.
There are no files selected for viewing
173 changes: 173 additions & 0 deletions
173
tmc-langs-framework/src/main/java/fi/helsinki/cs/tmc/langs/domain/CommentSyntax.java
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,173 @@ | ||
| package fi.helsinki.cs.tmc.langs.domain; | ||
|
|
||
| import java.util.regex.Pattern; | ||
|
|
||
| /** | ||
| * Information about a language comment syntax used to parse solution and stub | ||
| * files with ExerciseBuilder. | ||
| * | ||
| * <p>Use CommentSyntaxBuilder for easy setup. | ||
| */ | ||
| public class CommentSyntax { | ||
|
|
||
| private final String beginSolutionRegex; | ||
| private final String capturingGroups; | ||
| private final String endSolutionRegex; | ||
| private final String solutionFileRegex; | ||
| private final String stubRegex; | ||
| private final Pattern stubReplacePattern; | ||
|
|
||
| private CommentSyntax( | ||
| String beginSolutionRegex, | ||
| String capturingGroups, | ||
| String endSolutionRegex, | ||
| String solutionFileRegex, | ||
| String stubRegex) { | ||
| this.beginSolutionRegex = beginSolutionRegex; | ||
| this.capturingGroups = capturingGroups; | ||
| this.endSolutionRegex = endSolutionRegex; | ||
| this.solutionFileRegex = solutionFileRegex; | ||
| this.stubRegex = stubRegex; | ||
|
|
||
| this.stubReplacePattern = Pattern.compile(stubRegex); | ||
| } | ||
|
|
||
| /** | ||
| * Will create a new Comment syntax with the specified comment syntaxes. | ||
| * | ||
| * <p>If no syntax is specified, will use single line comment syntax from | ||
| * Java. | ||
| */ | ||
| public static Builder newBuilder() { | ||
| return new Builder(); | ||
| } | ||
|
|
||
| public String getBeginSolution() { | ||
| return beginSolutionRegex; | ||
| } | ||
|
|
||
| public String getCapturingGroups() { | ||
| return capturingGroups; | ||
| } | ||
|
|
||
| public String getEndSolution() { | ||
| return endSolutionRegex; | ||
| } | ||
|
|
||
| public String getSolutionFile() { | ||
| return solutionFileRegex; | ||
| } | ||
|
|
||
| public String getStub() { | ||
| return stubRegex; | ||
| } | ||
|
|
||
| public Pattern getStubReplacePattern() { | ||
| return stubReplacePattern; | ||
| } | ||
|
|
||
| /** | ||
| * Creates a new CommnetSyntax with the specifies language syntaxes. | ||
| */ | ||
| public static class Builder { | ||
|
|
||
| private static final String BEGIN_SOLUTION = "BEGIN[ \\t]+SOLUTION"; | ||
| private static final String END_SOLUTION = "END[ \\t]+SOLUTION"; | ||
| private static final String SOLUTION_FILE = "SOLUTION[ \\t]+FILE"; | ||
| private static final String SPACES = "[ \\t]*"; | ||
| private static final String STUB = "STUB:[ \\t]*"; | ||
|
|
||
| private String beginCapturingGroups; | ||
| private String beginSolutionRegex; | ||
| private int capturingIndex; | ||
| private String endCapturingGroups; | ||
| private String endSolutionRegex; | ||
| private String solutionFileRegex; | ||
| private String stubRegex; | ||
|
|
||
| /** | ||
| * Creates a new CommentSyntac Builder. | ||
| */ | ||
| public Builder() { | ||
| beginCapturingGroups = ""; | ||
| beginSolutionRegex = ""; | ||
| capturingIndex = 2; | ||
| endCapturingGroups = ""; | ||
| endSolutionRegex = ""; | ||
| solutionFileRegex = ""; | ||
| stubRegex = ""; | ||
| } | ||
|
|
||
| /** | ||
| * Adds a single line comment to the comment syntax. | ||
| * @param singleLine Single line comment tag in Java regex format. | ||
| */ | ||
| public Builder addSingleLineComment(String singleLine) { | ||
| if (!beginSolutionRegex.isEmpty()) { | ||
| addOrPunctuations(); | ||
| } | ||
| String lineStart = "((" + SPACES + ")" + singleLine + SPACES; | ||
|
|
||
| beginSolutionRegex += lineStart + BEGIN_SOLUTION + "(.*))"; | ||
| endSolutionRegex += lineStart + END_SOLUTION + "(.*))"; | ||
| solutionFileRegex += lineStart + SOLUTION_FILE + "(.*))"; | ||
| stubRegex += lineStart + STUB + "(.*))"; | ||
|
|
||
| increaseCapturingGroups(); | ||
| return this; | ||
| } | ||
|
|
||
| /** | ||
| * Adds a multi line comment to the comment syntax. | ||
| * @param beginning Beginning tag for the multi line comment as Java | ||
| * regex. | ||
| * @param end End tag for the multi line comment as Java regex. | ||
| */ | ||
| public Builder addMultiLineComment(String beginning, | ||
| String end) { | ||
| if (!beginSolutionRegex.isEmpty()) { | ||
| addOrPunctuations(); | ||
| } | ||
| String beginComment = "((" + SPACES + ")" + beginning + SPACES; | ||
| String endComment = SPACES + end + SPACES + ".*)"; | ||
|
|
||
| beginSolutionRegex += beginComment + BEGIN_SOLUTION + endComment; | ||
| endSolutionRegex += beginComment + END_SOLUTION + endComment; | ||
| solutionFileRegex += beginComment + SOLUTION_FILE + endComment; | ||
| stubRegex += beginComment + STUB + "(.*[^ \\t])" + endComment; | ||
|
|
||
| increaseCapturingGroups(); | ||
| return this; | ||
| } | ||
|
|
||
| /** | ||
| * Builds the CommentSyntax once all syntax tags have been given. | ||
| */ | ||
| public CommentSyntax build() { | ||
| if (beginSolutionRegex.isEmpty()) { | ||
| return new Builder() | ||
| .addSingleLineComment("\\/\\/") | ||
| .build(); | ||
| } | ||
| return new CommentSyntax( | ||
| beginSolutionRegex, | ||
| beginCapturingGroups + endCapturingGroups, | ||
| endSolutionRegex, | ||
| solutionFileRegex, | ||
| stubRegex); | ||
| } | ||
|
|
||
| private void increaseCapturingGroups() { | ||
| beginCapturingGroups += "$" + capturingIndex++; | ||
| endCapturingGroups += "$" + capturingIndex++; | ||
| capturingIndex++; | ||
| } | ||
|
|
||
| private void addOrPunctuations() { | ||
| beginSolutionRegex += "|"; | ||
| endSolutionRegex += "|"; | ||
| solutionFileRegex += "|"; | ||
| stubRegex += "|"; | ||
| } | ||
| } | ||
| } |
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
3 changes: 3 additions & 0 deletions
3
...ngs-framework/src/test/resources/arith_funcs_solution_file/src/MultilineSolutionFile.java
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,3 @@ | ||
| public class SolutionFile { | ||
| /* SOLUTION FILE */ | ||
| } |
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