io.joynr.generator.cpp.communicationmodel.StdEnumHTemplate Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of cpp-generator Show documentation
There is a newer version: 0.9.3
package io.joynr.generator.cpp.communicationmodel;

import com.google.inject.Inject;
import io.joynr.generator.cpp.util.CppStdTypeUtil;
import io.joynr.generator.cpp.util.JoynrCppGeneratorExtensions;
import io.joynr.generator.cpp.util.TemplateBase;
import io.joynr.generator.util.EnumTemplate;
import org.eclipse.emf.common.util.EList;
import org.eclipse.xtend2.lib.StringConcatenation;
import org.eclipse.xtext.xbase.lib.Extension;
import org.eclipse.xtext.xbase.lib.StringExtensions;
import org.franca.core.franca.FEnumerationType;
import org.franca.core.franca.FEnumerator;

@SuppressWarnings("all")
public class StdEnumHTemplate implements EnumTemplate {
  @Inject
  @Extension
  private TemplateBase _templateBase;
  
  @Inject
  @Extension
  private JoynrCppGeneratorExtensions _joynrCppGeneratorExtensions;
  
  @Inject
  @Extension
  private CppStdTypeUtil _cppStdTypeUtil;
  
  public CharSequence generate(final FEnumerationType type) {
    StringConcatenation _builder = new StringConcatenation();
    final String typeName = this._joynrCppGeneratorExtensions.joynrNameStd(type);
    _builder.newLineIfNotEmpty();
    String _packagePathWithJoynrPrefix = this._joynrCppGeneratorExtensions.getPackagePathWithJoynrPrefix(type, "_");
    String _plus = (_packagePathWithJoynrPrefix + "_");
    String _plus_1 = (_plus + typeName);
    String _plus_2 = (_plus_1 + "_h");
    final String headerGuard = _plus_2.toUpperCase();
    _builder.newLineIfNotEmpty();
    CharSequence _warning = this._templateBase.warning();
    _builder.append(_warning, "");
    _builder.newLineIfNotEmpty();
    _builder.append("#ifndef ");
    _builder.append(headerGuard, "");
    _builder.newLineIfNotEmpty();
    _builder.append("#define ");
    _builder.append(headerGuard, "");
    _builder.newLineIfNotEmpty();
    _builder.newLine();
    String _dllExportIncludeStatement = this._joynrCppGeneratorExtensions.getDllExportIncludeStatement();
    _builder.append(_dllExportIncludeStatement, "");
    _builder.newLineIfNotEmpty();
    _builder.append("#include ");
    _builder.newLine();
    _builder.append("#include ");
    _builder.newLine();
    _builder.append("#include ");
    _builder.newLine();
    _builder.newLine();
    {
      boolean _hasExtendsDeclaration = this._joynrCppGeneratorExtensions.hasExtendsDeclaration(type);
      if (_hasExtendsDeclaration) {
        _builder.append("#include \"");
        FEnumerationType _extendedType = this._joynrCppGeneratorExtensions.getExtendedType(type);
        String _includeOfStd = this._cppStdTypeUtil.getIncludeOfStd(_extendedType);
        _builder.append(_includeOfStd, "");
        _builder.append("\"");
        _builder.newLineIfNotEmpty();
        _builder.newLine();
      }
    }
    String _namespaceStarter = this._joynrCppGeneratorExtensions.getNamespaceStarter(type, true);
    _builder.append(_namespaceStarter, "");
    _builder.newLineIfNotEmpty();
    _builder.newLine();
    _builder.append("/** @brief Enumeration wrapper class ");
    _builder.append(typeName, "");
    _builder.append(" */");
    _builder.newLineIfNotEmpty();
    _builder.append("struct ");
    String _dllExportMacro = this._joynrCppGeneratorExtensions.getDllExportMacro();
    _builder.append(_dllExportMacro, "");
    _builder.append(typeName, "");
    _builder.append(" {");
    _builder.newLineIfNotEmpty();
    {
      boolean _hasExtendsDeclaration_1 = this._joynrCppGeneratorExtensions.hasExtendsDeclaration(type);
      if (_hasExtendsDeclaration_1) {
        _builder.append("\t");
        _builder.append("// This enum inherits enumeration values from ");
        FEnumerationType _extendedType_1 = this._joynrCppGeneratorExtensions.getExtendedType(type);
        String _typeNameStd = this._cppStdTypeUtil.getTypeNameStd(_extendedType_1);
        _builder.append(_typeNameStd, "\t");
        _builder.append(".");
        _builder.newLineIfNotEmpty();
      }
    }
    _builder.append("\t");
    _builder.append("/**");
    _builder.newLine();
    _builder.append("\t");
    CharSequence _appendDoxygenSummaryAndWriteSeeAndDescription = this._joynrCppGeneratorExtensions.appendDoxygenSummaryAndWriteSeeAndDescription(type, " *");
    _builder.append(_appendDoxygenSummaryAndWriteSeeAndDescription, "\t");
    _builder.newLineIfNotEmpty();
    _builder.append("\t ");
    _builder.append("*/");
    _builder.newLine();
    _builder.append("\t");
    _builder.append("enum ");
    String _nestedEnumName = this._joynrCppGeneratorExtensions.getNestedEnumName();
    _builder.append(_nestedEnumName, "\t");
    _builder.append(" : uint32_t {");
    _builder.newLineIfNotEmpty();
    _builder.append("\t\t");
    int ordinal = 0;
    _builder.newLineIfNotEmpty();
    {
      EList _enumElementsAndBaseEnumElements = this._joynrCppGeneratorExtensions.getEnumElementsAndBaseEnumElements(type);
      boolean _hasElements = false;
      for(final FEnumerator enumtype : _enumElementsAndBaseEnumElements) {
        if (!_hasElements) {
          _hasElements = true;
        } else {
          _builder.appendImmediate(",", "\t\t");
        }
        _builder.append("\t\t");
        _builder.append("/**");
        _builder.newLine();
        _builder.append("\t\t");
        _builder.append(" ");
        _builder.append("* @brief ");
        CharSequence _appendDoxygenComment = this._joynrCppGeneratorExtensions.appendDoxygenComment(enumtype, "* ");
        _builder.append(_appendDoxygenComment, "\t\t ");
        _builder.newLineIfNotEmpty();
        _builder.append("\t\t");
        _builder.append(" ");
        _builder.append("*/");
        _builder.newLine();
        _builder.append("\t\t");
        String _joynrName = this._joynrCppGeneratorExtensions.joynrName(enumtype);
        _builder.append(_joynrName, "\t\t");
        _builder.append(" = ");
        int _plusPlus = ordinal++;
        _builder.append(_plusPlus, "\t\t");
        _builder.newLineIfNotEmpty();
      }
    }
    _builder.append("\t");
    _builder.append("};");
    _builder.newLine();
    _builder.newLine();
    _builder.append("\t");
    _builder.append("/** @brief Constructor */");
    _builder.newLine();
    _builder.append("\t");
    _builder.append(typeName, "\t");
    _builder.append("() = delete;");
    _builder.newLineIfNotEmpty();
    _builder.newLine();
    _builder.append("\t");
    _builder.append("/**");
    _builder.newLine();
    _builder.append("\t ");
    _builder.append("* @brief Copy constructor");
    _builder.newLine();
    _builder.append("\t ");
    _builder.append("* @param o the object to copy from");
    _builder.newLine();
    _builder.append("\t ");
    _builder.append("*/");
    _builder.newLine();
    _builder.append("\t");
    _builder.append(typeName, "\t");
    _builder.append("(const ");
    _builder.append(typeName, "\t");
    _builder.append("& o) = delete;");
    _builder.newLineIfNotEmpty();
    _builder.newLine();
    _builder.append("\t");
    _builder.append("/**");
    _builder.newLine();
    _builder.append("\t ");
    _builder.append("* @brief Get the matching enum name for an ordinal number");
    _builder.newLine();
    _builder.append("\t ");
    _builder.append("* @param ");
    String _firstLower = StringExtensions.toFirstLower(typeName);
    _builder.append(_firstLower, "\t ");
    _builder.append("Value The ordinal number");
    _builder.newLineIfNotEmpty();
    _builder.append("\t ");
    _builder.append("* @return The string representing the enum for the given ordinal number");
    _builder.newLine();
    _builder.append("\t ");
    _builder.append("*/");
    _builder.newLine();
    _builder.append("\t");
    _builder.append("static std::string getLiteral(");
    _builder.append(typeName, "\t");
    _builder.append("::");
    String _nestedEnumName_1 = this._joynrCppGeneratorExtensions.getNestedEnumName();
    _builder.append(_nestedEnumName_1, "\t");
    _builder.append(" ");
    String _firstLower_1 = StringExtensions.toFirstLower(typeName);
    _builder.append(_firstLower_1, "\t");
    _builder.append("Value);");
    _builder.newLineIfNotEmpty();
    _builder.newLine();
    _builder.append("\t");
    _builder.append("/**");
    _builder.newLine();
    _builder.append("\t ");
    _builder.append("* @brief Get the matching ordinal number for an enum");
    _builder.newLine();
    _builder.append("\t ");
    _builder.append("* @param ");
    String _firstLower_2 = StringExtensions.toFirstLower(typeName);
    _builder.append(_firstLower_2, "\t ");
    _builder.append("Value The enum");
    _builder.newLineIfNotEmpty();
    _builder.append("\t ");
    _builder.append("* @return The ordinal number representing the enum");
    _builder.newLine();
    _builder.append("\t ");
    _builder.append("*/");
    _builder.newLine();
    _builder.append("\t");
    _builder.append("static uint32_t getOrdinal(");
    _builder.append(typeName, "\t");
    _builder.append("::");
    String _nestedEnumName_2 = this._joynrCppGeneratorExtensions.getNestedEnumName();
    _builder.append(_nestedEnumName_2, "\t");
    _builder.append(" ");
    String _firstLower_3 = StringExtensions.toFirstLower(typeName);
    _builder.append(_firstLower_3, "\t");
    _builder.append("Value);");
    _builder.newLineIfNotEmpty();
    _builder.append("};");
    _builder.newLine();
    _builder.newLine();
    _builder.append("// Printing ");
    _builder.append(typeName, "");
    _builder.append(" with google-test and google-mock.");
    _builder.newLineIfNotEmpty();
    _builder.append("/**");
    _builder.newLine();
    _builder.append(" ");
    _builder.append("* @brief Print values of MessagingQos object");
    _builder.newLine();
    _builder.append(" ");
    _builder.append("* @param messagingQos The current object instance");
    _builder.newLine();
    _builder.append(" ");
    _builder.append("* @param os The output stream to send the output to");
    _builder.newLine();
    _builder.append(" ");
    _builder.append("*/");
    _builder.newLine();
    _builder.append("void PrintTo(const ");
    _builder.append(typeName, "");
    _builder.append("::");
    String _nestedEnumName_3 = this._joynrCppGeneratorExtensions.getNestedEnumName();
    _builder.append(_nestedEnumName_3, "");
    _builder.append("& ");
    String _firstLower_4 = StringExtensions.toFirstLower(typeName);
    _builder.append(_firstLower_4, "");
    _builder.append("Value, ::std::ostream* os);");
    _builder.newLineIfNotEmpty();
    _builder.newLine();
    String _namespaceEnder = this._joynrCppGeneratorExtensions.getNamespaceEnder(type, true);
    _builder.append(_namespaceEnder, "");
    _builder.newLineIfNotEmpty();
    _builder.newLine();
    _builder.append("namespace std {");
    _builder.newLine();
    _builder.append("// Function object that implements a hash function for ");
    String _buildPackagePath = this._joynrCppGeneratorExtensions.buildPackagePath(type, "::", true);
    _builder.append(_buildPackagePath, "");
    _builder.append(typeName, "");
    _builder.append(".");
    _builder.newLineIfNotEmpty();
    _builder.append("// Used by the unordered associative containers std::unordered_set, std::unordered_multiset,");
    _builder.newLine();
    _builder.append("// std::unordered_map, std::unordered_multimap as default hash function.");
    _builder.newLine();
    _builder.newLine();
    _builder.append("/**");
    _builder.newLine();
    _builder.append(" ");
    _builder.append("* @brief Function object that implements a hash function for ");
    String _buildPackagePath_1 = this._joynrCppGeneratorExtensions.buildPackagePath(type, "::", true);
    _builder.append(_buildPackagePath_1, " ");
    _builder.append(typeName, " ");
    _builder.append(".");
    _builder.newLineIfNotEmpty();
    _builder.append(" ");
    _builder.append("*");
    _builder.newLine();
    _builder.append(" ");
    _builder.append("* Used by the unordered associative containers std::unordered_set, std::unordered_multiset,");
    _builder.newLine();
    _builder.append(" ");
    _builder.append("* std::unordered_map, std::unordered_multimap as default hash function.");
    _builder.newLine();
    _builder.append(" ");
    _builder.append("*/");
    _builder.newLine();
    _builder.append("template<>");
    _builder.newLine();
    _builder.append("struct hash<");
    String _buildPackagePath_2 = this._joynrCppGeneratorExtensions.buildPackagePath(type, "::", true);
    _builder.append(_buildPackagePath_2, "");
    _builder.append(typeName, "");
    _builder.append("::");
    String _nestedEnumName_4 = this._joynrCppGeneratorExtensions.getNestedEnumName();
    _builder.append(_nestedEnumName_4, "");
    _builder.append("> {");
    _builder.newLineIfNotEmpty();
    _builder.newLine();
    _builder.append("\t");
    _builder.append("/**");
    _builder.newLine();
    _builder.append("\t ");
    _builder.append("* @brief method overriding default implementation of operator ()");
    _builder.newLine();
    _builder.append("\t ");
    _builder.append("* @param ");
    String _firstLower_5 = StringExtensions.toFirstLower(typeName);
    _builder.append(_firstLower_5, "\t ");
    _builder.append("Value the operators argument");
    _builder.newLineIfNotEmpty();
    _builder.append("\t ");
    _builder.append("* @return the ordinal number representing the enum value");
    _builder.newLine();
    _builder.append("\t ");
    _builder.append("*/");
    _builder.newLine();
    _builder.append("\t");
    _builder.append("std::size_t operator()(const ");
    String _buildPackagePath_3 = this._joynrCppGeneratorExtensions.buildPackagePath(type, "::", true);
    _builder.append(_buildPackagePath_3, "\t");
    _builder.append(typeName, "\t");
    _builder.append("::");
    String _nestedEnumName_5 = this._joynrCppGeneratorExtensions.getNestedEnumName();
    _builder.append(_nestedEnumName_5, "\t");
    _builder.append("& ");
    String _firstLower_6 = StringExtensions.toFirstLower(typeName);
    _builder.append(_firstLower_6, "\t");
    _builder.append("Value) const {");
    _builder.newLineIfNotEmpty();
    _builder.append("\t\t");
    _builder.append("return ");
    String _buildPackagePath_4 = this._joynrCppGeneratorExtensions.buildPackagePath(type, "::", true);
    _builder.append(_buildPackagePath_4, "\t\t");
    _builder.append(typeName, "\t\t");
    _builder.append("::getOrdinal(");
    String _firstLower_7 = StringExtensions.toFirstLower(typeName);
    _builder.append(_firstLower_7, "\t\t");
    _builder.append("Value);");
    _builder.newLineIfNotEmpty();
    _builder.append("\t");
    _builder.append("}");
    _builder.newLine();
    _builder.append("};");
    _builder.newLine();
    _builder.append("} /* namespace std */");
    _builder.newLine();
    _builder.newLine();
    _builder.append("#endif // ");
    _builder.append(headerGuard, "");
    _builder.newLineIfNotEmpty();
    return _builder;
  }
}