VisitorGeneratorHelper.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.codegen.cd2java.visitor;

import java.util.ArrayList;
import java.util.List;

import com.google.common.base.Joiner;

import de.monticore.codegen.GeneratorHelper;
import de.monticore.symboltable.GlobalScope;
import de.monticore.umlcd4a.cd4analysis._ast.ASTCDCompilationUnit;
import de.monticore.umlcd4a.symboltable.CDSymbol;
import de.se_rwth.commons.Joiners;
import de.se_rwth.commons.Names;

/**
 * TODO: Write me!
 *
 * @author (last commit) $Author$
 * @version $Revision$, $Date$
 */
public class VisitorGeneratorHelper extends GeneratorHelper {
  
  
  public VisitorGeneratorHelper(ASTCDCompilationUnit topAst, GlobalScope symbolTable) {
    super(topAst, symbolTable);
  }
  
  /**
   * @return the superinterfaces for the visitor
   */
  public List<String> getVisitorSuperInterfacesList() {
    List<String> superVisitors = new ArrayList<>();
    for (String superGrammar : getSuperGrammarCds()) {
      String superGrammarName = Names.getSimpleName(superGrammar);
      String visitorType = getVisitorType(superGrammarName);
      String visitorPackage = getPackageName(superGrammar.toLowerCase(), getVisitorPackageSuffix());
      superVisitors.add(visitorPackage + "." + visitorType);
    }
    return superVisitors;
  }
  
  public List<String> getDelegatorVisitorSuperInterfacesList() {
    List<String> superVisitors = new ArrayList<>();
    // delegators are always an inheritance visitor of the own language
    superVisitors.add(getInheritanceVisitorType());
    // and extend all direct superlanguages delegator visitors to inherit all
    // their setters for delegates.
    for (String superGrammar : getSuperGrammarCds()) {
      String visitorType = getDelegatorVisitorType(Names.getSimpleName(superGrammar));
      String visitorPackage = getPackageName(superGrammar.toLowerCase(), getVisitorPackageSuffix());
      superVisitors.add(Joiners.DOT.join(visitorPackage, visitorType));
    }
    return superVisitors;
  }
  
  /**
   * @return the superinterfaces for the visitor
   */
  public String getVisitorSuperInterfaces() {
    List<String> superVisitorInterfaces = getVisitorSuperInterfacesList();
    if (superVisitorInterfaces.isEmpty()) {
      return "";
    }
    return " extends " + Joiner.on(", ").join(superVisitorInterfaces);
  }
  
  /**
   * @return the superinterfaces for the delegator visitor
   */
  public String getDelegatorVisitorSuperInterfaces() {
    List<String> superVisitorInterfaces = getDelegatorVisitorSuperInterfacesList();
    if (superVisitorInterfaces.isEmpty()) {
      return "";
    }
    return " extends " + Joiner.on(", ").join(superVisitorInterfaces);
  }
  
  public String getVisitorPackage() {
    return getVisitorPackage(getPackageName());
  }
  
  /**
   * @return type name of the language's inheritance visitor interface
   * @see #getQualifiedVisitorType()
   */
  public String getInheritanceVisitorType() {
    return getInheritanceVisitorType(getCdName());
  }
  
  /**
   * @return type name of the language's delegator visitor interface
   * @see #getQualifiedVisitorType()
   */
  public String getDelegatorVisitorType() {
    return getDelegatorVisitorType(getCdName());
  }
  
  /**
   * @return the inheritance visitors of the super grammars separated by ","
   * starting with ","
   */
  public String getSuperInheritanceVisitorTypes() {
    StringBuilder s = new StringBuilder();
    for (String superGrammar : getSuperGrammarCds()) {
      String superGrammarName = Names.getSimpleName(superGrammar);
      String visitorType = getInheritanceVisitorType(superGrammarName);
      String visitorPackage = getPackageName(superGrammar.toLowerCase(), getVisitorPackageSuffix());
      s.append(", " + visitorPackage + "." + visitorType);
    }
    return s.toString();
  }
  
  /**
   * @return full-qualified name of the language's visitor interface
   * @see #getVisitorType()
   */
  public String getQualifiedVisitorType() {
    return getVisitorPackage() + "." + getVisitorType();
  }
  
  /**
   * @return type name of the language's visitor interface for the parent aware
   * version
   * @see #getQualifiedVisitorType()
   */
  public String getParentAwareVisitorType() {
    final String PARENT_AWARE_VISITOR_CLASS_PREFIX = "ParentAwareVisitor";
    return getCdName() + PARENT_AWARE_VISITOR_CLASS_PREFIX;
  }
  
  /**
   * @return the superinterfaces for the parent aware visitor
   */
  public String getParentAwareVisitorSuperInterfaces() {
    return " implements " + getVisitorType();
  }
  
  /**
   * @return type name of the language's visitor interface
   * @see #getQualifiedVisitorType()
   */
  public String getVisitorType() {
    return getVisitorType(getCdName());
  }
  
  /**
   * @param cDName
   * @return type name of the language's visitor interface
   * @see #getQualifiedVisitorType()
   */
  public static String getVisitorType(String cDName) {
    return cDName + "Visitor";
  }
  
  /**
   * @param cDName
   * @return type name of the language's inheritance visitor interface
   * @see #getQualifiedVisitorType()
   */
  public static String getInheritanceVisitorType(String cDName) {
    return cDName + "InheritanceVisitor";
  }
  
  /**
   * @param cDName
   * @return type name of the language's delegator visitor interface
   * @see #getQualifiedVisitorType()
   */
  public static String getDelegatorVisitorType(String cDName) {
    return cDName + "DelegatorVisitor";
  }
  
  /**
   * @param packageName
   * @param cdName
   * @return full-qualified name of the language's visitor interface
   * @see #getVisitorType()
   */
  public static String getQualifiedVisitorType(String packageName, String cdName) {
    return getPackageName(packageName, getVisitorPackageSuffix()) + "."
        + getVisitorType(cdName);
  }
  
  /**
   * Gets the full-qualified type of the languages visitor interface. For
   * example, input "a.b.c.D" results in output "a.b.c.d._visitor.DVisitor"
   * 
   * @param qualifiedLanguageName
   * @return the languages full-qualified visitor interface
   */
  public static String getQualifiedVisitorType(String qualifiedLanguageName) {
    String packageName = getCdPackage(qualifiedLanguageName);
    String cdName = getCdName(qualifiedLanguageName);
    return getQualifiedVisitorType(packageName, cdName);
  }
  
  /**
   * Gets the full-qualified name of the visitor interface with dots replaced by
   * underscores. E.g., input a cd with qualified name "a.b.c.D" the result is
   * "a_b_c_d__visitor_DVisitor".
   * 
   * @param cd the class diagram to get the visitor interface for
   * @return the qualified name of the visitor interface with dots replaced by
   * underscores.
   */
  public String getQualifiedVisitorNameAsJavaName(CDSymbol cd) {
    return qualifiedJavaTypeToName(getQualifiedVisitorType(cd));
  }
  
  /**
   * Gets the full-qualified java name of the visitor interface. E.g., input a
   * cd with qualified name "a.b.c.D" the result is "a.b.c.d._visitor.DVisitor".
   * 
   * @param cd the class diagram to get the visitor interface for.
   * @return the full-qualified java name of the visitor interface.
   */
  public String getQualifiedVisitorType(CDSymbol cd) {
    return getQualifiedVisitorType(cd.getFullName());
  }
  
}