AbstractParser.java

Go to the documentation of this file.

/*
 * Turró i Cutiller Foundation. License notice.
 * Copyright (C) 2020 Lluis Turró Cutiller <http://www.turro.org/>
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program 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 Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
 
package org.turro.parser;
 
import java.io.File;
import java.io.IOException;
import java.io.PrintWriter;
import java.util.logging.Level;
import java.util.logging.Logger;
import org.turro.elephant.context.IConstructor;
import org.turro.elephant.impl.util.FileUtil;
import org.turro.elephant.impl.util.Files;
import org.turro.marker.ElephantMarker;
 
public abstract class AbstractParser implements IParser {
  
  protected IConstructor constructor;
  protected String[] tokens;
  protected PrintWriter out;
  protected String parserName;
  protected ParserMacroSet parserMacros = new ParserMacroSet();
  //protected KeyValueMap values = new KeyValueMap(Collections.EMPTY_MAP);
 
  public AbstractParser() {
    initParser();
  }
 
  public ParserMacroSet getParserMacros() {
    return parserMacros;
  }
 
  @Override
  public boolean execute(IConstructor constructor, PrintWriter out, String[] tokens) {
    this.constructor = constructor;
    this.out = out;
    this.tokens = tokens;
    // escaped double dots
    for(int i = 1; i < tokens.length; i++) {
      tokens[i] = tokens[i].replaceAll("/:", ":");
    }
    if(tokens.length > 0) {
      return doExecute();
    }
    return false;
  }
  
  public abstract String getParserName();
  protected abstract boolean doExecute();
  protected abstract void explainMacros(ParserMacroSet macros);
  
  protected String getMacroName() {
    return getToken(0);
  }
  
  protected String getToken(String name) {
    return getToken(name, true);
  }
  
  protected String getToken(String name, boolean defParameter) {
    ParserParameter pp = getParameter(name);
    return pp != null ? tokens[pp.getOrder()] : pp.getDefaultValue();
  }
  
  protected String getToken(String name, String def) {
    ParserParameter pp = getParameter(name);
    return pp != null ? tokens[pp.getOrder()] : def;
  }
  
  protected String getToken(int index) {
    return getToken(index, true);
  }
 
  protected String getToken(int index, boolean defParameter) {
    if(tokens.length > index) {
      return tokens[index];
    }
    return defParameter ? getDefaultFor(index) : null;
  }
 
  protected String getToken(int index, String def) {
    if(tokens.length > index) {
      return tokens[index];
    }
    return def;
  }
 
  protected int getTokenSize() {
    return tokens.length;
  }
  
  protected String getDefaultFor(int index) {
    ParserParameter pp = getParameter(index);
    return pp != null ? pp.getDefaultValue() : null;
  }
 
  protected void prepareProperties(ElephantMarker marker, String properties) {
    try {
      File file = Files.file(marker.getConstructor(), properties + ".properties");
      if(file.exists()) {
        marker.put("props", FileUtil.getOrderedProperties(file));
      }
    } catch (IOException ex) {
      Logger.getLogger(DocumentationParser.class.getName()).log(Level.SEVERE, null, ex);
    }
  }
 
  private void initParser() {
    explainMacros(parserMacros);
  }
 
  private ParserParameter getParameter(String name) {
    for(ParserMacro pm : parserMacros) {
      if(pm.getMacroName().equals(tokens[0])) {
        for(ParserParameter pp : pm.getParameters()) {
          if(pp.getName().equals(name)) {
            return pp;
          }
        }
      }
    }
    return null;
  }
  
  private ParserParameter getParameter(int index) {
    for(ParserMacro pm : parserMacros) {
      if(pm.getMacroName().equals(tokens[0])) {
        for(ParserParameter pp : pm.getParameters()) {
          if(pp.getOrder() == index) {
            return pp;
          }
        }
      }
    }
    return null;
  }
  
}