summaryrefslogtreecommitdiff
path: root/clformat/src
diff options
context:
space:
mode:
authorBen Culkin <scorpress@gmail.com>2020-12-03 19:28:15 -0500
committerBen Culkin <scorpress@gmail.com>2020-12-03 19:28:15 -0500
commitf3814a84f8471684cd483347db4fb7b107c2e635 (patch)
tree7ed1061ee69ef50cd1494cfacc866b271b8d1163 /clformat/src
parenta2c7425458f645802a352abc4783e0afc73dba13 (diff)
Rename interfaces to match Java style
Rename several interfaces that were in the style IWhatever, which Java doesn't use
Diffstat (limited to 'clformat/src')
-rw-r--r--clformat/src/main/java/bjc/utils/ioutils/format/CLFormatter.java6
-rw-r--r--clformat/src/main/java/bjc/utils/ioutils/format/CLTokenizer.java36
-rw-r--r--clformat/src/main/java/bjc/utils/ioutils/format/ClauseDecree.java16
-rw-r--r--clformat/src/main/java/bjc/utils/ioutils/format/Decree.java131
-rw-r--r--clformat/src/main/java/bjc/utils/ioutils/format/GroupDecree.java10
-rw-r--r--clformat/src/main/java/bjc/utils/ioutils/format/IDecree.java14
-rw-r--r--clformat/src/main/java/bjc/utils/ioutils/format/SimpleDecree.java129
-rw-r--r--clformat/src/main/java/bjc/utils/ioutils/format/directives/CompileContext.java4
-rw-r--r--clformat/src/main/java/bjc/utils/ioutils/format/directives/FormatParameters.java4
-rw-r--r--clformat/src/main/java/bjc/utils/ioutils/format/directives/InflectDirective.java8
-rw-r--r--clformat/src/main/java/bjc/utils/ioutils/format/directives/IterationDirective.java8
-rw-r--r--clformat/src/test/java/bjc/utils/test/ioutils/CLTokenizerTest.java2
12 files changed, 184 insertions, 184 deletions
diff --git a/clformat/src/main/java/bjc/utils/ioutils/format/CLFormatter.java b/clformat/src/main/java/bjc/utils/ioutils/format/CLFormatter.java
index 6908773..c55fda4 100644
--- a/clformat/src/main/java/bjc/utils/ioutils/format/CLFormatter.java
+++ b/clformat/src/main/java/bjc/utils/ioutils/format/CLFormatter.java
@@ -299,7 +299,7 @@ public class CLFormatter {
boolean isToplevel) throws IOException {
try {
while (cltok.hasNext()) {
- Decree decr = cltok.next();
+ SimpleDecree decr = cltok.next();
if (decr.isLiteral) {
rw.write(decr.name);
@@ -411,7 +411,7 @@ public class CLFormatter {
*
* @return A set of edicts compiled from the decrees.
*/
- public List<Edict> compile(Iterable<Decree> decrees) {
+ public List<Edict> compile(Iterable<SimpleDecree> decrees) {
// If we have no decrees, there are no edicts.
if (decrees == null) return new ArrayList<>();
@@ -444,7 +444,7 @@ public class CLFormatter {
List<Edict> result = new ArrayList<>();
while (cltok.hasNext()) {
- Decree decr = cltok.next();
+ SimpleDecree decr = cltok.next();
String nam = decr.name;
CompileContext compCTX = new CompileContext(cltok, this, decr);
diff --git a/clformat/src/main/java/bjc/utils/ioutils/format/CLTokenizer.java b/clformat/src/main/java/bjc/utils/ioutils/format/CLTokenizer.java
index 94437ee..7ed76d2 100644
--- a/clformat/src/main/java/bjc/utils/ioutils/format/CLTokenizer.java
+++ b/clformat/src/main/java/bjc/utils/ioutils/format/CLTokenizer.java
@@ -9,7 +9,7 @@ import java.util.regex.*;
* @author bjculkin
*
*/
-public class CLTokenizer implements Iterator<Decree> {
+public class CLTokenizer implements Iterator<SimpleDecree> {
/**
* Whether or not the tokenizer is in debug mode or not.
*/
@@ -19,13 +19,13 @@ public class CLTokenizer implements Iterator<Decree> {
* Internal class for a tokenizer that returns a specific set of tokens.
*/
private static class SetCLTokenizer extends CLTokenizer {
- private Iterator<Decree> body;
+ private Iterator<SimpleDecree> body;
- public SetCLTokenizer(Iterator<Decree> bod) {
+ public SetCLTokenizer(Iterator<SimpleDecree> bod) {
body = bod;
}
- public SetCLTokenizer(Iterable<Decree> bod) {
+ public SetCLTokenizer(Iterable<SimpleDecree> bod) {
body = bod.iterator();
}
@@ -35,14 +35,14 @@ public class CLTokenizer implements Iterator<Decree> {
}
@Override
- public Decree next() {
+ public SimpleDecree next() {
return body.next();
}
}
private Matcher mat;
- private Decree dir;
+ private SimpleDecree dir;
/**
* Empty constructor that should only be invoked if you are a subclass who
@@ -70,7 +70,7 @@ public class CLTokenizer implements Iterator<Decree> {
*
* @return A tokenizer yielding the given set of decrees.
*/
- public static CLTokenizer fromTokens(Iterator<Decree> bod) {
+ public static CLTokenizer fromTokens(Iterator<SimpleDecree> bod) {
return new SetCLTokenizer(bod);
}
@@ -82,7 +82,7 @@ public class CLTokenizer implements Iterator<Decree> {
*
* @return A tokenizer yielding the given set of decrees.
*/
- public static CLTokenizer fromTokens(Iterable<Decree> bod) {
+ public static CLTokenizer fromTokens(Iterable<SimpleDecree> bod) {
return new SetCLTokenizer(bod);
}
@@ -92,15 +92,15 @@ public class CLTokenizer implements Iterator<Decree> {
}
@Override
- public Decree next() {
+ public SimpleDecree next() {
return getNext();
}
- private Decree getNext() {
+ private SimpleDecree getNext() {
if (!hasNext()) throw new NoSuchElementException("No possible decrees remaining");
if (dir != null) {
- Decree tmp = dir;
+ SimpleDecree tmp = dir;
dir = null;
@@ -125,25 +125,25 @@ public class CLTokenizer implements Iterator<Decree> {
boolean isUser = directiveName == null && directiveFunction != null;
- dir = new Decree(directiveName, isUser,
+ dir = new SimpleDecree(directiveName, isUser,
CLParameters.fromDirective(directiveParameterString),
CLModifiers.fromString(directiveModifierString));
}
if (tmp.equals("")) {
- Decree dcr = dir;
+ SimpleDecree dcr = dir;
dir = null;
return dcr;
}
- return new Decree(sb.toString());
+ return new SimpleDecree(sb.toString());
}
mat.appendTail(sb);
- return new Decree(sb.toString());
+ return new SimpleDecree(sb.toString());
}
/**
@@ -157,7 +157,7 @@ public class CLTokenizer implements Iterator<Decree> {
*
* @return A group decree with the given properties.
*/
- public GroupDecree nextGroup(Decree openedWith, String desiredClosing) {
+ public GroupDecree nextGroup(SimpleDecree openedWith, String desiredClosing) {
return nextGroup(openedWith, desiredClosing, null);
}
@@ -177,7 +177,7 @@ public class CLTokenizer implements Iterator<Decree> {
*
* @return A group decree with the given properties.
*/
- public GroupDecree nextGroup(Decree openedWith, String desiredClosing,
+ public GroupDecree nextGroup(SimpleDecree openedWith, String desiredClosing,
String clauseSep) {
GroupDecree newGroup = new GroupDecree();
newGroup.opening = openedWith;
@@ -188,7 +188,7 @@ public class CLTokenizer implements Iterator<Decree> {
int nestingLevel = 1;
- Decree curDecree;
+ SimpleDecree curDecree;
do {
curDecree = next();
diff --git a/clformat/src/main/java/bjc/utils/ioutils/format/ClauseDecree.java b/clformat/src/main/java/bjc/utils/ioutils/format/ClauseDecree.java
index 9db248c..db38eca 100644
--- a/clformat/src/main/java/bjc/utils/ioutils/format/ClauseDecree.java
+++ b/clformat/src/main/java/bjc/utils/ioutils/format/ClauseDecree.java
@@ -13,16 +13,16 @@ import bjc.utils.ioutils.ReportWriter;
*
* @author Ben Culkin
*/
-public class ClauseDecree implements IDecree {
+public class ClauseDecree implements Decree {
/**
* The decrees that make up the body of this clause.
*/
- public List<Decree> body;
+ public List<SimpleDecree> body;
/**
* The decree that terminated this clause.
*/
- public Decree terminator;
+ public SimpleDecree terminator;
/**
* Create a new blank clause decree.
@@ -38,10 +38,10 @@ public class ClauseDecree implements IDecree {
* @param children
* The decrees to form the body of the clause.
*/
- public ClauseDecree(Decree... children) {
+ public ClauseDecree(SimpleDecree... children) {
this();
- for (Decree child : children) body.add(child);
+ for (SimpleDecree child : children) body.add(child);
}
/**
@@ -53,7 +53,7 @@ public class ClauseDecree implements IDecree {
* @param children
* The decrees that form the body of the clause.
*/
- public ClauseDecree(Decree term, Decree... children) {
+ public ClauseDecree(SimpleDecree term, SimpleDecree... children) {
this(children);
this.terminator = term;
@@ -65,7 +65,7 @@ public class ClauseDecree implements IDecree {
* @param child
* The decree to add to this clause.
*/
- public void addChild(Decree child) {
+ public void addChild(SimpleDecree child) {
body.add(child);
}
@@ -96,7 +96,7 @@ public class ClauseDecree implements IDecree {
writer.write("\n");
int idx = 0;
- for (Decree kid : body)
+ for (SimpleDecree kid : body)
writer.writef("Child %d: %s\n", idx, kid.toString());
writer.dedent();
diff --git a/clformat/src/main/java/bjc/utils/ioutils/format/Decree.java b/clformat/src/main/java/bjc/utils/ioutils/format/Decree.java
index 115ef0d..e06caf0 100644
--- a/clformat/src/main/java/bjc/utils/ioutils/format/Decree.java
+++ b/clformat/src/main/java/bjc/utils/ioutils/format/Decree.java
@@ -1,129 +1,14 @@
package bjc.utils.ioutils.format;
/**
- * A decree is the building blocks of what we need to pick and call a directive.
+ * Interface for all decrees.
+ *
+ * At the moment, this is just a marker interface, but there may be things added
+ * here.
+ *
+ * @author Ben Culkin
*
- * Namely, it is the name of the directive, any modifiers attached to the
- * directive, and any prefix parameters that are also attached to the directive.
- *
- * @author Ben Culkin.
*/
-public class Decree implements IDecree {
- /**
- * The name of the directive.
- */
- public String name;
-
- /**
- * Is this directive an actual directive, or just a literal string?
- */
- public boolean isLiteral;
-
- /**
- * Is this directive a user function call?
- */
- public boolean isUserCall;
-
- /**
- * The prefix parameters for this directive.
- */
- public CLParameters parameters;
-
- /**
- * The modifiers for this directive.
- */
- public CLModifiers modifiers;
-
- /**
- * Create a new blank decree.
- */
- public Decree() {
-
- }
-
- /**
- * Create a new literal text directive.
- *
- * @param txt
- * The text of the directive.
- */
- public Decree(String txt) {
- this.name = txt;
-
- this.isLiteral = true;
- }
-
- /**
- * Create a new directive.
- *
- * @param name
- * The name of the directive. Whether or not it is an actual
- * directive will be auto-determined (if it starts with a ~, it's
- * a directive.)
- *
- * @param params
- * The prefix parameters to the directive.
- *
- * @param mods
- * The modifiers to the directive.
- */
- public Decree(String name, CLParameters params, CLModifiers mods) {
- this.name = name;
-
- this.parameters = params;
-
- this.modifiers = mods;
-
- this.isLiteral = false;
- }
-
- /**
- * Create a new directive that may be a user function.
- *
- * @param name
- * The name of the directive. Whether or not it is an actual
- * directive will be auto-determined (if it starts with a ~ and is
- * not a user function, it's a directive.)
- *
- * @param isUser
- * Is this directive a user function?
- *
- * @param params
- * The prefix parameters to the directive.
- *
- * @param mods
- * The modifiers to the directive.
- */
- public Decree(String name, boolean isUser, CLParameters params, CLModifiers mods) {
- this.name = name;
-
- this.parameters = params;
-
- this.modifiers = mods;
-
- this.isUserCall = isUser;
-
- this.isLiteral = isUser;
- }
-
- /**
- * Check if this decree is a non-literal, with a particular name.
- *
- * @param nam
- * The name to see if we have.
- *
- * @return Whether or not the provided name equals our name.
- */
- public boolean isNamed(String nam) {
- // Literals don't have a meaningful name
- if (isLiteral) return false;
- else return name.equals(nam);
- }
-
- @Override
- public String toString() {
- return String.format(
- "Decree [name='%s', isLiteral=%s, isUserCall=%s, parameters=%s, modifiers='%s']",
- name, isLiteral, isUserCall, parameters, modifiers);
- }
+public interface Decree {
+ // Marker interface, for now
}
diff --git a/clformat/src/main/java/bjc/utils/ioutils/format/GroupDecree.java b/clformat/src/main/java/bjc/utils/ioutils/format/GroupDecree.java
index 7095aa5..c1c5c7b 100644
--- a/clformat/src/main/java/bjc/utils/ioutils/format/GroupDecree.java
+++ b/clformat/src/main/java/bjc/utils/ioutils/format/GroupDecree.java
@@ -13,16 +13,16 @@ import bjc.utils.ioutils.ReportWriter;
*
* @author Ben Culkin
*/
-public class GroupDecree implements Iterable<ClauseDecree>, IDecree {
+public class GroupDecree implements Iterable<ClauseDecree>, Decree {
/**
* The decree that opened this group.
*/
- public Decree opening;
+ public SimpleDecree opening;
/**
* The decree that closed this group.
*/
- public Decree closing;
+ public SimpleDecree closing;
/**
* The clauses that make up the body of this group.
@@ -60,7 +60,7 @@ public class GroupDecree implements Iterable<ClauseDecree>, IDecree {
* @param children
* The decree making up the body of the group.
*/
- public GroupDecree(Decree opening, Decree closing, ClauseDecree... children) {
+ public GroupDecree(SimpleDecree opening, SimpleDecree closing, ClauseDecree... children) {
this(children);
this.opening = opening;
@@ -103,7 +103,7 @@ public class GroupDecree implements Iterable<ClauseDecree>, IDecree {
*
* @return The decrees that make up the body of the first clause.
*/
- public List<Decree> unwrap() {
+ public List<SimpleDecree> unwrap() {
return body.get(0).body;
}
diff --git a/clformat/src/main/java/bjc/utils/ioutils/format/IDecree.java b/clformat/src/main/java/bjc/utils/ioutils/format/IDecree.java
deleted file mode 100644
index 17b9ecf..0000000
--- a/clformat/src/main/java/bjc/utils/ioutils/format/IDecree.java
+++ /dev/null
@@ -1,14 +0,0 @@
-package bjc.utils.ioutils.format;
-
-/**
- * Interface for all decrees.
- *
- * At the moment, this is just a marker interface, but there may be things added
- * here.
- *
- * @author Ben Culkin
- *
- */
-public interface IDecree {
- // Marker interface, for now
-}
diff --git a/clformat/src/main/java/bjc/utils/ioutils/format/SimpleDecree.java b/clformat/src/main/java/bjc/utils/ioutils/format/SimpleDecree.java
new file mode 100644
index 0000000..a7db42f
--- /dev/null
+++ b/clformat/src/main/java/bjc/utils/ioutils/format/SimpleDecree.java
@@ -0,0 +1,129 @@
+package bjc.utils.ioutils.format;
+
+/**
+ * A decree is the building blocks of what we need to pick and call a directive.
+ *
+ * Namely, it is the name of the directive, any modifiers attached to the
+ * directive, and any prefix parameters that are also attached to the directive.
+ *
+ * @author Ben Culkin.
+ */
+public class SimpleDecree implements Decree {
+ /**
+ * The name of the directive.
+ */
+ public String name;
+
+ /**
+ * Is this directive an actual directive, or just a literal string?
+ */
+ public boolean isLiteral;
+
+ /**
+ * Is this directive a user function call?
+ */
+ public boolean isUserCall;
+
+ /**
+ * The prefix parameters for this directive.
+ */
+ public CLParameters parameters;
+
+ /**
+ * The modifiers for this directive.
+ */
+ public CLModifiers modifiers;
+
+ /**
+ * Create a new blank decree.
+ */
+ public SimpleDecree() {
+
+ }
+
+ /**
+ * Create a new literal text directive.
+ *
+ * @param txt
+ * The text of the directive.
+ */
+ public SimpleDecree(String txt) {
+ this.name = txt;
+
+ this.isLiteral = true;
+ }
+
+ /**
+ * Create a new directive.
+ *
+ * @param name
+ * The name of the directive. Whether or not it is an actual
+ * directive will be auto-determined (if it starts with a ~, it's
+ * a directive.)
+ *
+ * @param params
+ * The prefix parameters to the directive.
+ *
+ * @param mods
+ * The modifiers to the directive.
+ */
+ public SimpleDecree(String name, CLParameters params, CLModifiers mods) {
+ this.name = name;
+
+ this.parameters = params;
+
+ this.modifiers = mods;
+
+ this.isLiteral = false;
+ }
+
+ /**
+ * Create a new directive that may be a user function.
+ *
+ * @param name
+ * The name of the directive. Whether or not it is an actual
+ * directive will be auto-determined (if it starts with a ~ and is
+ * not a user function, it's a directive.)
+ *
+ * @param isUser
+ * Is this directive a user function?
+ *
+ * @param params
+ * The prefix parameters to the directive.
+ *
+ * @param mods
+ * The modifiers to the directive.
+ */
+ public SimpleDecree(String name, boolean isUser, CLParameters params, CLModifiers mods) {
+ this.name = name;
+
+ this.parameters = params;
+
+ this.modifiers = mods;
+
+ this.isUserCall = isUser;
+
+ this.isLiteral = isUser;
+ }
+
+ /**
+ * Check if this decree is a non-literal, with a particular name.
+ *
+ * @param nam
+ * The name to see if we have.
+ *
+ * @return Whether or not the provided name equals our name.
+ */
+ public boolean isNamed(String nam) {
+ // Literals don't have a meaningful name
+ if (isLiteral) return false;
+ else return name.equals(nam);
+ }
+
+ @Override
+ public String toString() {
+ return String.format(
+ "Decree [name='%s', isLiteral=%s, isUserCall=%s, parameters=%s, modifiers='%s']",
+ name, isLiteral, isUserCall, parameters, modifiers);
+ }
+}
diff --git a/clformat/src/main/java/bjc/utils/ioutils/format/directives/CompileContext.java b/clformat/src/main/java/bjc/utils/ioutils/format/directives/CompileContext.java
index 3c5f692..77c8402 100644
--- a/clformat/src/main/java/bjc/utils/ioutils/format/directives/CompileContext.java
+++ b/clformat/src/main/java/bjc/utils/ioutils/format/directives/CompileContext.java
@@ -21,7 +21,7 @@ public class CompileContext {
/**
* The decree that is currently being parsed.
*/
- public Decree decr;
+ public SimpleDecree decr;
/**
* Create a new compilation context.
@@ -35,7 +35,7 @@ public class CompileContext {
* @param dcr
* The decree currently being compiled.
*/
- public CompileContext(CLTokenizer dirs, CLFormatter fmt, Decree dcr) {
+ public CompileContext(CLTokenizer dirs, CLFormatter fmt, SimpleDecree dcr) {
directives = dirs;
formatter = fmt;
diff --git a/clformat/src/main/java/bjc/utils/ioutils/format/directives/FormatParameters.java b/clformat/src/main/java/bjc/utils/ioutils/format/directives/FormatParameters.java
index d206d17..e2884d3 100644
--- a/clformat/src/main/java/bjc/utils/ioutils/format/directives/FormatParameters.java
+++ b/clformat/src/main/java/bjc/utils/ioutils/format/directives/FormatParameters.java
@@ -28,7 +28,7 @@ public class FormatParameters {
/**
* The current decree.
*/
- public Decree decr;
+ public SimpleDecree decr;
/**
* The current format parameters.
@@ -66,7 +66,7 @@ public class FormatParameters {
* @param formatter
* The formatter we are using
*/
- public FormatParameters(ReportWriter writer, Object item, Decree decr,
+ public FormatParameters(ReportWriter writer, Object item, SimpleDecree decr,
Tape<Object> tParams, CLTokenizer dirIter, CLFormatter formatter) {
this.writer = writer;
diff --git a/clformat/src/main/java/bjc/utils/ioutils/format/directives/InflectDirective.java b/clformat/src/main/java/bjc/utils/ioutils/format/directives/InflectDirective.java
index c4b2edb..937bd9d 100644
--- a/clformat/src/main/java/bjc/utils/ioutils/format/directives/InflectDirective.java
+++ b/clformat/src/main/java/bjc/utils/ioutils/format/directives/InflectDirective.java
@@ -15,13 +15,13 @@ import bjc.utils.ioutils.format.*;
public class InflectDirective implements Directive {
@Override
public Edict compile(CompileContext compCTX) {
- List<Decree> body = new ArrayList<>();
+ List<SimpleDecree> body = new ArrayList<>();
int nestLevel = 1;
- Iterator<Decree> dirIter = compCTX.directives;
+ Iterator<SimpleDecree> dirIter = compCTX.directives;
while (dirIter.hasNext()) {
- Decree decr = dirIter.next();
+ SimpleDecree decr = dirIter.next();
if (decr.isLiteral) {
body.add(decr);
@@ -62,7 +62,7 @@ public class InflectDirective implements Directive {
class InflectEdict implements Edict {
private CLString body;
- public InflectEdict(List<Decree> body, CLFormatter fmt) {
+ public InflectEdict(List<SimpleDecree> body, CLFormatter fmt) {
this.body = new CLString(fmt.compile(body));
}
diff --git a/clformat/src/main/java/bjc/utils/ioutils/format/directives/IterationDirective.java b/clformat/src/main/java/bjc/utils/ioutils/format/directives/IterationDirective.java
index 4b3b193..34f815d 100644
--- a/clformat/src/main/java/bjc/utils/ioutils/format/directives/IterationDirective.java
+++ b/clformat/src/main/java/bjc/utils/ioutils/format/directives/IterationDirective.java
@@ -16,12 +16,12 @@ public class IterationDirective implements Directive {
public Edict compile(CompileContext compCTX) {
IterationEdict.Mode mode;
- List<Decree> body = new ArrayList<>();
+ List<SimpleDecree> body = new ArrayList<>();
- Iterator<Decree> dirIter = compCTX.directives;
+ Iterator<SimpleDecree> dirIter = compCTX.directives;
// :GroupDecree
while (dirIter.hasNext()) {
- Decree decr = dirIter.next();
+ SimpleDecree decr = dirIter.next();
if (decr.isLiteral) {
body.add(decr);
} else {
@@ -73,7 +73,7 @@ class IterationEdict implements Edict {
private CLValue maxItrVal;
- public IterationEdict(Mode mode, List<Decree> body, CLFormatter fmt, CLValue maxItr) {
+ public IterationEdict(Mode mode, List<SimpleDecree> body, CLFormatter fmt, CLValue maxItr) {
this.mode = mode;
this.body = new CLString(fmt.compile(body));
diff --git a/clformat/src/test/java/bjc/utils/test/ioutils/CLTokenizerTest.java b/clformat/src/test/java/bjc/utils/test/ioutils/CLTokenizerTest.java
index 429c089..20d64b0 100644
--- a/clformat/src/test/java/bjc/utils/test/ioutils/CLTokenizerTest.java
+++ b/clformat/src/test/java/bjc/utils/test/ioutils/CLTokenizerTest.java
@@ -18,7 +18,7 @@ public class CLTokenizerTest {
CLTokenizer tokenzer = new CLTokenizer("");
assertTrue("Empty tokenizer has a decree", tokenzer.hasNext());
- Decree dec = tokenzer.next();
+ SimpleDecree dec = tokenzer.next();
assertFalse("Empty tokenizer has only one decree", tokenzer.hasNext());
assertTrue("Decree from empty tokenizer is a literal", dec.isLiteral);