MCConcreteParser.java

/*
 * ******************************************************************************
 * MontiCore Language Workbench
 * Copyright (c) 2015, MontiCore, All rights reserved.
 *
 * This project is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 3.0 of the License, or (at your option) any later version.
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this project. If not, see <http://www.gnu.org/licenses/>.
 * ******************************************************************************
 */

package de.monticore.antlr4;

import java.io.IOException;
import java.io.Reader;
import java.util.Optional;

import de.monticore.ast.ASTNode;

/**
 * A MCConcreteParser is used for every single language. MCConcreteParser wrap
 * around an antlr parser, for having a parse method for a specific rule and
 * access in a type safe way
 * 
 * @author krahn
 */
public abstract class MCConcreteParser {
      
  protected boolean hasErrors = false;
  
  /**
   * Creates a MCConcreteParser with a certain name
   * 
   * @param name
   */
  public MCConcreteParser() {
  }
  
  /**
   * Implement this method to call top rule of parser. This method will be
   * overridden in generated classes with covariant return type.
   *
   * @param fileName The name of the file to be parsed
   * @return An Optional of the created AST
   * @throws IOException Errors during file handling
   */
  public abstract Optional<? extends ASTNode> parse(String fileName) throws IOException;
  
  /**
   * Implement this method to call top rule of parser. This method will be
   * overridden in generated classes with covariant return type.
   * 
   * @param reader The reader containing the input to be parsed
   * @return An Optional of the created AST
   * @throws IOException Errors during reader handling
   */
  public abstract Optional<? extends ASTNode> parse(Reader reader) throws IOException;

  /**
   * Returns true, if errors occured while parsing
   * 
   * @return
   */
  public boolean hasErrors() {
    return hasErrors;
  }
  
  public void setError(boolean value) {
    hasErrors = value;
  }
  
  /**
   * Indicates what should be parsed: The Rule or the rule followed by an EOF
   * (End Of File)
   */
  public enum ParserExecution {
    NORMAL, EOF
  }
  
  // Default is normal
  ParserExecution parserTarget = ParserExecution.NORMAL;
  
  /**
   * Returns if parser parses Rule or Rule followed by EOF
   * 
   * @return Parser.EOF iff rule is parsed with followed EOF
   */
  public ParserExecution getParserTarget() {
    return parserTarget;
  }
  
  /**
   * Sets if parser parses Rule or Rule followed by EOF
   * 
   * @param parserTarget
   */
  public void setParserTarget(ParserExecution parserTarget) {
    this.parserTarget = parserTarget;
  }
  
}