Rewrite lexer to comply with CQL spec
[cql-java-moved-to-github.git] / src / main / java / org / z3950 / zing / cql / CQLLexer.java
index 293b45a..2247fd0 100644 (file)
-
+/*
+ * Copyright (c) 1995-2014, Index Datassss
+ * All rights reserved.
+ * See the file LICENSE for details.
+ */
 package org.z3950.zing.cql;
-import java.io.InputStream;
-import java.io.Reader;
-import java.io.StreamTokenizer;
-import java.io.StringReader;
-
-
-// This is a semi-trivial subclass for java.io.StreamTokenizer that:
-//     * Has a halfDecentPushBack() method that actually works
-//     * Includes a render() method
-//     * Knows about the multi-character tokens "<=", ">=" and "<>"
-//     * Recognises a set of keywords as tokens in their own right
-//     * Includes some primitive debugging-output facilities
-// It's used only by CQLParser.
-//
-class CQLLexer extends StreamTokenizer {
-    // New publicly visible token-types
-    public final static int TT_LE        = 1000;       // The "<=" relation
-    public final static int TT_GE        = 1001;       // The ">=" relation
-    public final static int TT_NE        = 1002;       // The "<>" relation
-    public final static int TT_EQEQ      = 1003;       // The "==" relation
-    public final static int TT_AND       = 1004;       // The "and" boolean
-    public final static int TT_OR        = 1005;       // The "or" boolean
-    public final static int TT_NOT       = 1006;       // The "not" boolean
-    public final static int TT_PROX      = 1007;       // The "prox" boolean
-    public final static int TT_SORTBY     = 1008;      // The "sortby" operator
-
-    // Support for keywords.  It would be nice to compile this linear
-    // list into a Hashtable, but it's hard to store ints as hash
-    // values, and next to impossible to use them as hash keys.  So
-    // we'll just scan the (very short) list every time we need to do
-    // a lookup.
-    private class Keyword {
-       int token;
-       String keyword;
-       Keyword(int token, String keyword) {
-           this.token = token;
-           this.keyword = keyword;
-       }
-    }
-    // This should logically be static, but Java won't allow it  :-P
-    private Keyword[] keywords = {
-       new Keyword(TT_AND, "and"),
-       new Keyword(TT_OR,  "or"),
-       new Keyword(TT_NOT, "not"),
-       new Keyword(TT_PROX, "prox"),
-       new Keyword(TT_SORTBY, "sortby"),
-    };
-
-    // For halfDecentPushBack() and the code at the top of nextToken()
-    private static int TT_UNDEFINED = -1000;
-    private int saved_ttype = TT_UNDEFINED;
-    private double saved_nval;
-    private String saved_sval;
-
-    // Controls debugging output
-    private static boolean DEBUG;
-
-    CQLLexer(String cql, boolean lexdebug) {
-        this(new StringReader(cql), lexdebug);
-    }
-    
-    CQLLexer(Reader cql, boolean lexdebug) {
-       super(cql);
-       wordChars('!', '@');    // ASCII-dependency!
-       wordChars('[', '`');    // ASCII-dependency!
-       quoteChar('"');
-       ordinaryChar('=');
-       ordinaryChar('<');
-       ordinaryChar('>');
-       ordinaryChar('/');
-       ordinaryChar('(');
-       ordinaryChar(')');
-        ordinaryChar('.');
-        wordChars('.', '.');
-       wordChars('\'', '\''); // prevent this from introducing strings
-       //parseNumbers();
-       ordinaryChar('-');
-       wordChars('-', '-');
-       ordinaryChars('0', '9');
-       wordChars('0', '9');
-       DEBUG = lexdebug;
-    }
-
-    private static void debug(String str) {
-       if (DEBUG)
-           System.err.println("LEXDEBUG: " + str);
-    }
-
-    // I don't honestly understand why we need this, but the
-    // documentation for java.io.StreamTokenizer.pushBack() is pretty
-    // vague about its semantics, and it seems to me that they could
-    // be summed up as "it doesn't work".  This version has the very
-    // clear semantics "pretend I didn't call nextToken() just then".
-    //
-    private void halfDecentPushBack() {
-       saved_ttype = ttype;
-       saved_nval = nval;
-       saved_sval = sval;
-    }
-
-    @Override
-    public int nextToken() throws java.io.IOException {
-       if (saved_ttype != TT_UNDEFINED) {
-           ttype = saved_ttype;
-           nval = saved_nval;
-           sval = saved_sval;
-           saved_ttype = TT_UNDEFINED;
-           debug("using saved ttype=" + ttype + ", " +
-                 "nval=" + nval + ", sval='" + sval + "'");
-           return ttype;
-       }
-
-       underlyingNextToken();
-       if (ttype == '<') {
-           debug("token starts with '<' ...");
-           underlyingNextToken();
-           if (ttype == '=') {
-               debug("token continues with '=' - it's '<='");
-               ttype = TT_LE;
-           } else if (ttype == '>') {
-               debug("token continues with '>' - it's '<>'");
-               ttype = TT_NE;
-           } else {
-               debug("next token is " + render() + " (pushed back)");
-               halfDecentPushBack();
-               ttype = '<';
-               debug("AFTER: ttype is now " + ttype + " - " + render());
-           }
-       } else if (ttype == '>') {
-           debug("token starts with '>' ...");
-           underlyingNextToken();
-           if (ttype == '=') {
-               debug("token continues with '=' - it's '>='");
-               ttype = TT_GE;
-           } else {
-               debug("next token is " + render() + " (pushed back)");
-               halfDecentPushBack();
-               ttype = '>';
-               debug("AFTER: ttype is now " + ttype + " - " + render());
-           }
-       } else if (ttype == '=') {
-           debug("token starts with '=' ...");
-           underlyingNextToken();
-           if (ttype == '=') {
-               debug("token continues with '=' - it's '=='");
-               ttype = TT_EQEQ;
-           } else {
-               debug("next token is " + render() + " (pushed back)");
-               halfDecentPushBack();
-               ttype = '=';
-               debug("AFTER: ttype is now " + ttype + " - " + render());
-           }
-       }
-
-       debug("done nextToken(): ttype=" + ttype + ", " +
-             "nval=" + nval + ", " + "sval='" + sval + "'" +
-             " (" + render() + ")");
-
-       return ttype;
-    }
-
-    // It's important to do keyword recognition here at the lowest
-    // level, otherwise when one of these words follows "<" or ">"
-    // (which can be the beginning of multi-character tokens) it gets
-    // pushed back as a string, and its keywordiness is not
-    // recognised.
-    //
-    public int underlyingNextToken() throws java.io.IOException {
-       super.nextToken();
-       if (ttype == TT_WORD)
-           for (int i = 0; i < keywords.length; i++)
-               if (sval.equalsIgnoreCase(keywords[i].keyword))
-                   ttype = keywords[i].token;
-
-       return ttype;
-    }
-
-    // Simpler interface for the usual case: current token with quoting
-    String render() {
-       return render(ttype, true);
-    }
-
-    String render(int token, boolean quoteChars) {
-       if (token == TT_EOF) {
-           return "EOF";
-       } else if (token == TT_NUMBER) {
-           if ((double) nval == (int) nval) {
-               return new Integer((int) nval).toString();
-           } else {
-               return new Double((double) nval).toString();
-           }
-       } else if (token == TT_WORD) {
-           return "word: " + sval;
-       } else if (token == '"') {
-           return "string: \"" + sval + "\"";
-       } else if (token == TT_LE) {
-           return "<=";
-       } else if (token == TT_GE) {
-           return ">=";
-       } else if (token == TT_NE) {
-           return "<>";
-       } else if (token == TT_EQEQ) {
-           return "==";
-       }
-
-       // Check whether its associated with one of the keywords
-       for (int i = 0; i < keywords.length; i++)
-           if (token == keywords[i].token)
-               return keywords[i].keyword;
-
-       // Otherwise it must be a single character, such as '(' or '/'.
-       String res = String.valueOf((char) token);
-       if (quoteChars) res = "'" + res + "'";
-        return res;
-    }
-
-    public static void main(String[] args) throws Exception {
-       if (args.length > 1) {
-           System.err.println("Usage: CQLLexer [<CQL-query>]");
-           System.err.println("If unspecified, query is read from stdin");
-           System.exit(1);
-       }
-
-       String cql;
-       if (args.length == 1) {
-           cql = args[0];
-       } else {
-           byte[] bytes = new byte[10000];
-           try {
-               // Read in the whole of standard input in one go
-               int nbytes = System.in.read(bytes);
-           } catch (java.io.IOException ex) {
-               System.err.println("Can't read query: " + ex.getMessage());
-               System.exit(2);
-           }
-           cql = new String(bytes);
-       }
 
-       CQLLexer lexer = new CQLLexer(cql, true);
-       int token;
-       while ((token = lexer.nextToken()) != TT_EOF) {
-           // Nothing to do: debug() statements render tokens for us
-       }
-    }
+/**
+ *
+ * @author jakub
+ */
+public interface CQLLexer {
+  
+  public static final int TT_EOF  = -1;
+  public static final int TT_WORD = -3;
+  public static final int TT_NOTHING = -4;
+  
+  public final static int TT_LE     = 1000;    // The "<=" relation
+  public final static int TT_GE     = 1001;    // The ">=" relation
+  public final static int TT_NE     = 1002;    // The "<>" relation
+  public final static int TT_EQEQ   = 1003;    // The "==" relation
+  public final static int TT_AND    = 1004;    // The "and" boolean
+  public final static int TT_OR     = 1005;    // The "or" boolean
+  public final static int TT_NOT    = 1006;    // The "not" boolean
+  public final static int TT_PROX   = 1007;    // The "prox" boolean
+  public final static int TT_SORTBY = 1008;    // The "sortby" operator
+  
+  public void move();
+  
+  public String value();
+  
+  public int what();
+  
+  public String render();
+  
+  public String render(int what, boolean quote);
+  
+  public int pos();
+  
 }