Parser.java

// Copyright (c) 2015-2016 K Team. All Rights Reserved.
package org.kframework;

import org.kframework.attributes.Source;
import org.kframework.definition.*;
import org.kframework.kore.K;
import org.kframework.kore.Sort;
import org.kframework.parser.concrete2kore.ParseInModule;
import org.kframework.parser.concrete2kore.generator.RuleGrammarGenerator;
import org.kframework.utils.errorsystem.ParseFailedException;
import scala.Option;
import scala.Tuple2;
import scala.util.Either;
import scala.util.control.Exception;

import java.io.IOException;
import java.util.HashSet;
import java.util.Set;

/**
 * Parses a string with a particular start symbol/sort.
 * Constructed via the static {@link #from methods}
 */
@API
public class Parser {
    private final ParseInModule parseInModule;

    private Parser(Module module) {
        // TODO: remove hack once the frontend is cleaner; also remove the IOException once the hack is cleared
        if (module.name().endsWith(RuleGrammarGenerator.RULE_CELLS)) {
            org.kframework.definition.Definition definitionWithBuiltins = Definition.from("require \"domians.k\"", "K");
            this.parseInModule = RuleGrammarGenerator.getCombinedGrammar(module, true);
        } else {
            this.parseInModule = new ParseInModule(module);
        }
    }

    /**
     * Parses a string with a particular start symbol/sort.
     *
     * @param startSymbol the start symbol/sort
     * @param toParse     the String to parse
     * @param fromSource  the Source of the String toParse
     * @return a pair: the left projection is a parsed string as a K, if successful;
     * the right projection is the set of issues encountered while parsing
     */
    @SuppressWarnings("unchecked")
    public Tuple2<Option<K>, Set<Warning>> apply(Sort startSymbol, String toParse, Source fromSource) {
        Tuple2<Either<Set<ParseFailedException>, K>, Set<ParseFailedException>> res = parseInModule.parseString(toParse, startSymbol, fromSource);

        Set<Warning> problemSet = new HashSet<>();
        problemSet.addAll((Set<Warning>) (Object) res._2());
        if (res._1().isLeft())
            problemSet.addAll((Set<Warning>) (Object) res._1().left().get());
        return Tuple2.apply(res._1().right().toOption(), problemSet);
    }

    /**
     * Parses a string with a particular start symbol/sort.
     *
     * @param startSymbol the start symbol/sort
     * @param toParse     the String to parse
     * @return a pair: the left projection is a parsed string as a K, if successful;
     * the right projection is the set of issues encountered while parsing
     */
    public Tuple2<Option<K>, Set<Warning>> apply(Sort startSymbol, String toParse) {
        return apply(startSymbol, toParse, Source.apply("generated"));
    }

    public static Parser from(Module module) {
        return new Parser(module);
    }
}