diff options
Diffstat (limited to 'dice-lang/src/bjc/dicelang/scl')
| -rw-r--r-- | dice-lang/src/bjc/dicelang/scl/StreamControlConsole.java | 38 | ||||
| -rw-r--r-- | dice-lang/src/bjc/dicelang/scl/StreamControlEngine.java | 216 | ||||
| -rw-r--r-- | dice-lang/src/bjc/dicelang/scl/StreamEngine.java | 34 |
3 files changed, 122 insertions, 166 deletions
diff --git a/dice-lang/src/bjc/dicelang/scl/StreamControlConsole.java b/dice-lang/src/bjc/dicelang/scl/StreamControlConsole.java index 8ace8ad..649c6fa 100644 --- a/dice-lang/src/bjc/dicelang/scl/StreamControlConsole.java +++ b/dice-lang/src/bjc/dicelang/scl/StreamControlConsole.java @@ -8,21 +8,43 @@ import java.util.Scanner; import java.util.function.Supplier; +/** + * Implement a SCL REPL + * + * @author Ben Culkin + */ public class StreamControlConsole { + /* + * @TODO 10/08/17 :SCLArgs + * Do something useful with the CLI args. + * + */ + /** + * Main method + * + * @param args + * Unused CLI args. + */ public static void main(String[] args) { - /* Initialize vars. */ - /* We're not using the DiceLangEngine in the streams yet. */ - StreamEngine sengine = new StreamEngine(null); + /* + * Initialize vars. + * + * We can get away with passing the null, because StreamEngine + * doesn't reference any parts of DiceLangEngine. + */ + StreamEngine sengine = new StreamEngine(null); StreamControlEngine sclengine = new StreamControlEngine(sengine); - Scanner scn = new Scanner(System.in); + Scanner scn = new Scanner(System.in); /* Get input from the user. */ System.out.print("Enter a SCL command string (blank to exit): "); + /* Process it. */ while (scn.hasNextLine()) { - String ln = scn.nextLine(); + String ln = scn.nextLine().trim(); - if (ln.trim().equals("")) { + if (ln.equals("")) { + /* Ignore empty lines. */ break; } @@ -32,16 +54,16 @@ public class StreamControlConsole { /* Run the stream engine on the tokens. */ boolean succ = sengine.doStreams(tokens, res); - if (!succ) { + System.out.printf("ERROR: Stream engine failed for line '%s'\n", ln); continue; } /* Run the command through SCL. */ tokens = res.toArray(new String[res.getSize()]); succ = sclengine.runProgram(tokens); - if (!succ) { + System.out.printf("ERROR: SCL engine failed for line '%s'\n", ln); continue; } diff --git a/dice-lang/src/bjc/dicelang/scl/StreamControlEngine.java b/dice-lang/src/bjc/dicelang/scl/StreamControlEngine.java index 2952a89..d5e8b72 100644 --- a/dice-lang/src/bjc/dicelang/scl/StreamControlEngine.java +++ b/dice-lang/src/bjc/dicelang/scl/StreamControlEngine.java @@ -1,37 +1,5 @@ package bjc.dicelang.scl; -import static bjc.dicelang.Errors.ErrorKey.EK_SCL_INVARG; -import static bjc.dicelang.Errors.ErrorKey.EK_SCL_INVTOKEN; -import static bjc.dicelang.Errors.ErrorKey.EK_SCL_MMQUOTE; -import static bjc.dicelang.Errors.ErrorKey.EK_SCL_SUNDERFLOW; -import static bjc.dicelang.Errors.ErrorKey.EK_SCL_UNWORD; -import static bjc.dicelang.scl.StreamControlEngine.Token.Type.ARRAY; -import static bjc.dicelang.scl.StreamControlEngine.Token.Type.BLIT; -import static bjc.dicelang.scl.StreamControlEngine.Token.Type.DELETESTREAM; -import static bjc.dicelang.scl.StreamControlEngine.Token.Type.DQUOTE; -import static bjc.dicelang.scl.StreamControlEngine.Token.Type.DROP; -import static bjc.dicelang.scl.StreamControlEngine.Token.Type.FLIT; -import static bjc.dicelang.scl.StreamControlEngine.Token.Type.ILIT; -import static bjc.dicelang.scl.StreamControlEngine.Token.Type.LEFTSTREAM; -import static bjc.dicelang.scl.StreamControlEngine.Token.Type.MAKEARRAY; -import static bjc.dicelang.scl.StreamControlEngine.Token.Type.MAKEEXEC; -import static bjc.dicelang.scl.StreamControlEngine.Token.Type.MAKEUNEXEC; -import static bjc.dicelang.scl.StreamControlEngine.Token.Type.MERGESTREAM; -import static bjc.dicelang.scl.StreamControlEngine.Token.Type.NDROP; -import static bjc.dicelang.scl.StreamControlEngine.Token.Type.NEWSTREAM; -import static bjc.dicelang.scl.StreamControlEngine.Token.Type.NIP; -import static bjc.dicelang.scl.StreamControlEngine.Token.Type.NNIP; -import static bjc.dicelang.scl.StreamControlEngine.Token.Type.OBRACE; -import static bjc.dicelang.scl.StreamControlEngine.Token.Type.OBRACKET; -import static bjc.dicelang.scl.StreamControlEngine.Token.Type.RIGHTSTREAM; -import static bjc.dicelang.scl.StreamControlEngine.Token.Type.SLIT; -import static bjc.dicelang.scl.StreamControlEngine.Token.Type.SQUOTE; -import static bjc.dicelang.scl.StreamControlEngine.Token.Type.STACKCOUNT; -import static bjc.dicelang.scl.StreamControlEngine.Token.Type.STACKEMPTY; -import static bjc.dicelang.scl.StreamControlEngine.Token.Type.SYMBOL; -import static bjc.dicelang.scl.StreamControlEngine.Token.Type.WORD; -import static bjc.dicelang.scl.StreamControlEngine.Token.Type.WORDS; - import java.util.HashMap; import java.util.Map; @@ -42,117 +10,118 @@ import bjc.utils.funcdata.FunctionalList; import bjc.utils.funcdata.IList; import bjc.utils.parserutils.TokenUtils; +import static bjc.dicelang.Errors.ErrorKey.*; +import static bjc.dicelang.scl.StreamControlEngine.Token.Type.*; + +/* + * @TODO 10/08/17 Ben Culkin :SCLReorg + * This is a large enough class that it should maybe be split into + * subclasses. + */ /** * Runs a Stream Control Language (SCL) program. * * SCL is a stack-based concatenative language based mostly off of Postscript * and Factor, with inspiration from various other languages. + * + * @author Ben Culkin */ public class StreamControlEngine { - static class Token { + /* + * @TODO 10/08/17 Ben Culkin :TokenSplit + * Again with the multiple subclasses in one class. Split it so + * that each subclass only has the fields it needs. + */ + public static class Token { public static enum Type { - /* - * Natural tokens. These come directly from strings - */ + /* Natural tokens. These come directly from strings */ ILIT, FLIT, BLIT, SQUOTE, DQUOTE, OBRACKET, OBRACE, SYMBOL, WORD, - /* - * Synthetic tokens. These are produced from special - * tokens. - */ + /* Synthetic tokens. These are produced from special tokens. */ SLIT, WORDS, ARRAY, + /* Word tokens These are subordinate to WORD tokens */ /* - * Word tokens These are subordinate to WORD tokens - */ - /* - * Array manipulation + * @NOTE + * These should really be in their own enum. */ + /* Array manipulation */ MAKEARRAY, MAKEEXEC, MAKEUNEXEC, - /* - * Stream manipulation - */ + /* Stream manipulation */ NEWSTREAM, LEFTSTREAM, RIGHTSTREAM, DELETESTREAM, MERGESTREAM, - /* - * Stack manipulation - */ + /* Stack manipulation */ STACKCOUNT, STACKEMPTY, DROP, NDROP, NIP, NNIP, } - /* - * The type of this token - */ + /* The type of this token */ public Type type; - /* - * Used for ILIT - */ + /* Used for ILIT */ public long intVal; - /* - * Used for FLIT - */ + /* Used for FLIT */ public double floatVal; - /* - * Used for BLIT - */ + /* Used for BLIT */ public boolean boolVal; - /* - * Used for SYMBOL SLIT - */ + /* Used for SYMBOL & SLIT */ public String stringVal; - /* - * Used for WORD - */ + /* Used for WORD */ public Token tokenVal; - /* - * Used for WORDS ARRAY - */ + /* Used for WORDS & ARRAY */ public IList<Token> tokenVals; + /* Create a new token. */ public Token(final Type typ) { type = typ; } + /* Create a new token. */ public Token(final Type typ, final long iVal) { this(typ); intVal = iVal; } + /* Create a new token. */ public Token(final Type typ, final double dVal) { this(typ); floatVal = dVal; } + /* Create a new token. */ public Token(final Type typ, final boolean bVal) { this(typ); boolVal = bVal; } + /* Create a new token. */ public Token(final Type typ, final String sVal) { this(typ); stringVal = sVal; } + /* Create a new token. */ public Token(final Type typ, final Token tVal) { this(typ); tokenVal = tVal; } + /* Create a new token. */ public Token(final Type typ, final Token.Type tVal) { this(typ, new Token(tVal)); } + /* Create a new token. */ public Token(final Type typ, final IList<Token> tVals) { this(typ); tokenVals = tVals; } + /* Convert a string into a token. */ public static Token tokenizeString(final String token) { if (litTokens.containsKey(token)) { return new Token(litTokens.get(token)); @@ -174,10 +143,13 @@ public class StreamControlEngine { } } + /* The literal tokens. */ private static final Map<String, Token.Type> litTokens; + /* The builtin words. */ private static final Map<String, Token.Type> builtinWords; static { + /* Init literal tokens. */ litTokens = new HashMap<>(); litTokens.put("'", SQUOTE); @@ -185,6 +157,7 @@ public class StreamControlEngine { litTokens.put("[", OBRACKET); litTokens.put("{", OBRACE); + /* Init builtin words. */ builtinWords = new HashMap<>(); builtinWords.put("makearray", MAKEARRAY); @@ -204,11 +177,13 @@ public class StreamControlEngine { } } + /* The stream engine we're hooked to. */ private final StreamEngine eng; + /* The current stack state. */ private final Stack<Token> curStack; - @SuppressWarnings("unused") + /* Map of user defined words. */ private final Map<String, Token> words; /** @@ -234,48 +209,49 @@ public class StreamControlEngine { */ public boolean runProgram(final String[] tokens) { for (int i = 0; i < tokens.length; i++) { + /* Tokenize each token. */ final String token = tokens[i]; - final Token tok = Token.tokenizeString(token); + final Token tok = Token.tokenizeString(token); if (tok == null) { + System.out.printf("ERROR: Tokenization failed for '%s'\n", token); return false; } + /* Handle token types. */ switch (tok.type) { case SQUOTE: + /* Handle single-quotes. */ i = handleSingleQuote(i, tokens); - if (i == -1) { return false; } - break; - case OBRACKET: + /* Handle delimited brackets. */ i = handleDelim(i, tokens, "]"); - if (i == -1) { return false; } - break; - case OBRACE: + /* Handle delimited braces. */ i = handleDelim(i, tokens, "}"); - if (i == -1) { return false; } - final Token brak = curStack.pop(); curStack.push(new Token(ARRAY, brak.tokenVals)); break; case WORD: - handleWord(tok); + /* Handle words. */ + if(!handleWord(tok)) { + System.out.printf("WARNING: Execution of word '%s' failed\n", tok); + } break; - default: + /* Put it onto the stack. */ curStack.push(tok); break; } @@ -287,118 +263,90 @@ public class StreamControlEngine { private boolean handleWord(final Token tk) { boolean succ = true; + /* Handle each type of word. */ + /* + * @NOTE + * This should probably use something other than a switch + * statement. + */ switch (tk.tokenVal.type) { case NEWSTREAM: eng.newStream(); break; - case LEFTSTREAM: succ = eng.leftStream(); - if (!succ) { return false; } - break; - case RIGHTSTREAM: succ = eng.rightStream(); - if (!succ) { return false; } - break; - case DELETESTREAM: succ = eng.deleteStream(); - if (!succ) { return false; } - break; - case MERGESTREAM: succ = eng.mergeStream(); - if (!succ) { return false; } - break; - case MAKEARRAY: succ = makeArray(); - if (!succ) { return false; } - break; - case MAKEEXEC: succ = toggleExec(true); - if (!succ) { return false; } - break; - case MAKEUNEXEC: succ = toggleExec(false); - if (!succ) { return false; } - break; - case STACKCOUNT: curStack.push(new Token(ILIT, curStack.size())); break; - case STACKEMPTY: curStack.push(new Token(BLIT, curStack.empty())); break; - case DROP: if (curStack.size() == 0) { Errors.inst.printError(EK_SCL_SUNDERFLOW, tk.tokenVal.type.toString()); return false; } - curStack.drop(); break; - case NDROP: succ = handleNDrop(); - if (!succ) { return false; } - break; - case NIP: if (curStack.size() < 2) { Errors.inst.printError(EK_SCL_SUNDERFLOW, tk.tokenVal.type.toString()); return false; } - curStack.nip(); break; - case NNIP: succ = handleNNip(); - if (!succ) { return false; } - break; - default: Errors.inst.printError(EK_SCL_UNWORD, tk.tokenVal.type.toString()); return false; @@ -407,6 +355,7 @@ public class StreamControlEngine { return true; } + /* Handle nipping a specified number of items. */ private boolean handleNNip() { final Token num = curStack.pop(); @@ -426,6 +375,7 @@ public class StreamControlEngine { return true; } + /* Handle dropping a specified number of items. */ private boolean handleNDrop() { final Token num = curStack.pop(); @@ -445,6 +395,7 @@ public class StreamControlEngine { return true; } + /* Handle toggling the executable flag on an array. */ private boolean toggleExec(final boolean exec) { final Token top = curStack.top(); @@ -467,6 +418,7 @@ public class StreamControlEngine { return true; } + /* Handle creating an array. */ private boolean makeArray() { final Token num = curStack.pop(); @@ -485,6 +437,7 @@ public class StreamControlEngine { return true; } + /* Handle a delimited series of tokens. */ private int handleDelim(final int i, final String[] tokens, final String delim) { final IList<Token> toks = new FunctionalList<>(); @@ -503,42 +456,31 @@ public class StreamControlEngine { switch (ntok.type) { case SQUOTE: n = handleSingleQuote(n, tokens); - if (n == -1) { return -1; } - toks.add(curStack.pop()); break; - case OBRACKET: n = handleDelim(n, tokens, "]"); - if (n == -1) { return -1; } - toks.add(curStack.pop()); break; - case OBRACE: n = handleDelim(i, tokens, "}"); - if (n == -1) { return -1; } - final Token brak = curStack.pop(); toks.add(new Token(ARRAY, brak.tokenVals)); break; - default: toks.add(ntok); } - /* - * Move to the next token - */ + /* Move to the next token */ n += 1; if (n >= tokens.length) { @@ -549,16 +491,18 @@ public class StreamControlEngine { tok = tokens[n]; } - /* - * Skip the closing bracket - */ + /* Skip the closing bracket */ n += 1; + /* @NOTE + * Instead of being hardcoded, this should be a parameter. + */ curStack.push(new Token(WORDS, toks)); return n; } + /* Handle a single-quoted string. */ private int handleSingleQuote(final int i, final String[] tokens) { final StringBuilder sb = new StringBuilder(); @@ -573,17 +517,13 @@ public class StreamControlEngine { while (!tok.equals("'")) { if (tok.matches("\\\\+'")) { - /* - * Handle escaped quotes. - */ + /* Handle escaped quotes. */ sb.append(tok.substring(1)); } else { sb.append(tok); } - /* - * Move to the next token - */ + /* Move to the next token */ n += 1; if (n >= tokens.length) { diff --git a/dice-lang/src/bjc/dicelang/scl/StreamEngine.java b/dice-lang/src/bjc/dicelang/scl/StreamEngine.java index 2082c9b..6e970b7 100644 --- a/dice-lang/src/bjc/dicelang/scl/StreamEngine.java +++ b/dice-lang/src/bjc/dicelang/scl/StreamEngine.java @@ -103,15 +103,18 @@ public class StreamEngine { for (final String tk : toks) { /* Process stream commands. */ if (tk.startsWith("{@S") && !quoteMode) { - if (tk.equals("{@SQ}")) { + if (tk.equals("{@SQ}")) { + /* Start quoting. */ quoteMode = true; } else if (!processCommand(tk)) { return false; } } else { if (tk.equals("{@SU}")) { + /* Stop quoting. */ quoteMode = false; } else if (tk.startsWith("\\") && tk.endsWith("{@SU}")) { + /* Unquote quoted end. */ currStream.add(tk.substring(1)); } else { currStream.add(tk); @@ -120,15 +123,14 @@ public class StreamEngine { } for (final String tk : currStream) { + /* Collect tokens from the current stream. */ dest.add(tk); } return true; } - /** - * Create a new stream. - */ + /** Create a new stream. */ public void newStream() { streams.insertAfter(new FunctionalList<>()); } @@ -202,65 +204,57 @@ public class StreamEngine { char[] comms = null; if (tk.length() > 5) { + /* Pull off {@S and closing } */ comms = tk.substring(3, tk.length() - 1).toCharArray(); } else { + /* Its a single char. command. */ comms = new char[1]; comms[0] = tk.charAt(3); } boolean succ; + /* Process each command. */ + /* + * @TODO 10/09/17 Ben Culkin :StreamCommands + * This should probably be refactored in some way, so as to + * make it easier to add new commands. + */ for (final char comm : comms) { switch (comm) { case '+': newStream(); break; - case '>': succ = rightStream(); - if (!succ) { return false; } - break; - case '<': succ = leftStream(); - if (!succ) { return false; } - break; - case '-': succ = deleteStream(); - if (!succ) { return false; } - break; - case 'M': succ = mergeStream(); - if (!succ) { return false; } - break; - case 'L': succ = scleng.runProgram(currStream.toArray(new String[0])); - if (!succ) { return false; } - break; - default: Errors.inst.printError(EK_STRM_INVCOM, tk); return false; |