org.jsimpledb.parse.WordParser Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jsimpledb-parse Show documentation
JSimpleDB classes for parsing Java expressions.
The newest version!

/*
 * Copyright (C) 2015 Archie L. Cobbs. All rights reserved.
 */

package org.jsimpledb.parse;

import com.google.common.base.Preconditions;

import java.util.Collection;
import java.util.TreeSet;
import java.util.regex.Matcher;

import org.jsimpledb.util.ParseContext;

/**
 * Parses a word (one or more non-whitespace characters).
 */
public class WordParser implements Parser {

    private final Collection words;
    private final String description;

    /**
     * Constructor for when there's a fixed set of possibilities.
     *
     * @param words words to look for
     * @param description what to call words (e.g., "command")
     * @throws IllegalArgumentException if {@code words} is null
     * @throws IllegalArgumentException if {@code description} is null
     */
    public WordParser(Collection words, String description) {
        Preconditions.checkArgument(words != null, "null words");
        Preconditions.checkArgument(description != null, "null description");
        this.words = new TreeSet<>(words);
        this.description = description;
    }

    /**
     * Constructor when any word is acceptable.
     *
     * @throws IllegalArgumentException if {@code words} is null
     * @param description what to call words (e.g., "command")
     * @throws IllegalArgumentException if {@code description} is null
     */
    public WordParser(String description) {
        Preconditions.checkArgument(description != null, "null description");
        this.words = null;
        this.description = description;
    }

    /**
     * Get the set of valid words, if there is such a set.
     *
     * 
     * The implementation in {@link WordParser} returns the collection provided to the constructor, if any.
     *
     * @return collection of valid words, or null to not place any restriction
     */
    protected Collection getWords() {
        return this.words;
    }

    @Override
    public String parse(ParseSession session, ParseContext ctx, boolean complete) {

        // Get word
        final Matcher matcher = ctx.tryPattern("[^\\s;]*");
        if (matcher == null)
            throw new ParseException(ctx);
        final String word = matcher.group();

        // Check word
        final Collection validWords = this.getWords();
        if (validWords != null) {
            final TreeSet sortedWords = new TreeSet<>(validWords);
            if (!sortedWords.contains(word)) {
                throw new ParseException(ctx, "unknown " + this.description + " `" + word + "'")
                  .addCompletions(ParseUtil.complete(sortedWords, word));
            }
        } else if (word.length() == 0)
            throw new ParseException(ctx, "missing " + this.description);

        // Done
        return word;
    }
}