BeginTokenVisitor.java

/**
 * Copyright (C) 2010-2011 STMicroelectronics
 *
 * This file is part of "Mind Compiler" 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 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 Lesser General Public License for more
 * details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 * Contact: mind@ow2.org
 *
 * Authors: Matthieu Leclercq
 * Contributors: 
 */

package org.ow2.mind.adl.parser;

import org.ow2.mind.adl.jtb.syntaxtree.ADLFile;
import org.ow2.mind.adl.jtb.syntaxtree.AnnotationAnnotationValue;
import org.ow2.mind.adl.jtb.syntaxtree.AnnotationParameters;
import org.ow2.mind.adl.jtb.syntaxtree.AnnotationValue;
import org.ow2.mind.adl.jtb.syntaxtree.AnnotationValuePair;
import org.ow2.mind.adl.jtb.syntaxtree.AnnotationValuePairs;
import org.ow2.mind.adl.jtb.syntaxtree.Annotations;
import org.ow2.mind.adl.jtb.syntaxtree.ArchitectureDefinition;
import org.ow2.mind.adl.jtb.syntaxtree.Argument;
import org.ow2.mind.adl.jtb.syntaxtree.ArgumentAssignement;
import org.ow2.mind.adl.jtb.syntaxtree.ArgumentList;
import org.ow2.mind.adl.jtb.syntaxtree.ArrayAnnotationValue;
import org.ow2.mind.adl.jtb.syntaxtree.AttributeDefinition;
import org.ow2.mind.adl.jtb.syntaxtree.AttributeType;
import org.ow2.mind.adl.jtb.syntaxtree.AttributeValue;
import org.ow2.mind.adl.jtb.syntaxtree.BindingComponentName;
import org.ow2.mind.adl.jtb.syntaxtree.BindingDefinition;
import org.ow2.mind.adl.jtb.syntaxtree.BooleanValue;
import org.ow2.mind.adl.jtb.syntaxtree.CompositeAnonymousDefinition;
import org.ow2.mind.adl.jtb.syntaxtree.CompositeAnonymousExtension;
import org.ow2.mind.adl.jtb.syntaxtree.CompositeDefinition;
import org.ow2.mind.adl.jtb.syntaxtree.CompositeDefinitionBody;
import org.ow2.mind.adl.jtb.syntaxtree.CompositeDefinitionElement;
import org.ow2.mind.adl.jtb.syntaxtree.CompositeDefinitionReference;
import org.ow2.mind.adl.jtb.syntaxtree.CompoundAttributeValue;
import org.ow2.mind.adl.jtb.syntaxtree.CompoundAttributeValueField;
import org.ow2.mind.adl.jtb.syntaxtree.CompoundFieldName;
import org.ow2.mind.adl.jtb.syntaxtree.DataDefinition;
import org.ow2.mind.adl.jtb.syntaxtree.ExtendedCompositeDefinitions;
import org.ow2.mind.adl.jtb.syntaxtree.ExtendedPrimitiveDefinitions;
import org.ow2.mind.adl.jtb.syntaxtree.ExtendedTypeDefinitions;
import org.ow2.mind.adl.jtb.syntaxtree.FlowInterfaceDefinition;
import org.ow2.mind.adl.jtb.syntaxtree.FlowType;
import org.ow2.mind.adl.jtb.syntaxtree.FormalParameterDeclaration;
import org.ow2.mind.adl.jtb.syntaxtree.FormalParameterDeclarationList;
import org.ow2.mind.adl.jtb.syntaxtree.FormalTypeParameterDeclaration;
import org.ow2.mind.adl.jtb.syntaxtree.FormalTypeParameterDeclarationList;
import org.ow2.mind.adl.jtb.syntaxtree.FullyQualifiedName;
import org.ow2.mind.adl.jtb.syntaxtree.FunctionalInterfaceDefinition;
import org.ow2.mind.adl.jtb.syntaxtree.IDTType;
import org.ow2.mind.adl.jtb.syntaxtree.ImplementationDefinition;
import org.ow2.mind.adl.jtb.syntaxtree.ImportDefinition;
import org.ow2.mind.adl.jtb.syntaxtree.IntegerValue;
import org.ow2.mind.adl.jtb.syntaxtree.InterfaceDefinition;
import org.ow2.mind.adl.jtb.syntaxtree.NodeList;
import org.ow2.mind.adl.jtb.syntaxtree.NodeListOptional;
import org.ow2.mind.adl.jtb.syntaxtree.NodeOptional;
import org.ow2.mind.adl.jtb.syntaxtree.NodeSequence;
import org.ow2.mind.adl.jtb.syntaxtree.NodeToken;
import org.ow2.mind.adl.jtb.syntaxtree.NullValue;
import org.ow2.mind.adl.jtb.syntaxtree.Path;
import org.ow2.mind.adl.jtb.syntaxtree.PathValue;
import org.ow2.mind.adl.jtb.syntaxtree.PrimitiveAnonymousDefinition;
import org.ow2.mind.adl.jtb.syntaxtree.PrimitiveAnonymousExtension;
import org.ow2.mind.adl.jtb.syntaxtree.PrimitiveDefinition;
import org.ow2.mind.adl.jtb.syntaxtree.PrimitiveDefinitionBody;
import org.ow2.mind.adl.jtb.syntaxtree.PrimitiveDefinitionElement;
import org.ow2.mind.adl.jtb.syntaxtree.PrimitiveDefinitionReference;
import org.ow2.mind.adl.jtb.syntaxtree.ReferenceValue;
import org.ow2.mind.adl.jtb.syntaxtree.SimpleSubComponentReference;
import org.ow2.mind.adl.jtb.syntaxtree.StringValue;
import org.ow2.mind.adl.jtb.syntaxtree.SubComponentDefinition;
import org.ow2.mind.adl.jtb.syntaxtree.TypeArgument;
import org.ow2.mind.adl.jtb.syntaxtree.TypeArgumentAssignement;
import org.ow2.mind.adl.jtb.syntaxtree.TypeArgumentList;
import org.ow2.mind.adl.jtb.syntaxtree.TypeDefinition;
import org.ow2.mind.adl.jtb.syntaxtree.TypeDefinitionBody;
import org.ow2.mind.adl.jtb.syntaxtree.TypeDefinitionElement;
import org.ow2.mind.adl.jtb.syntaxtree.TypeDefinitionReference;
import org.ow2.mind.adl.jtb.visitor.GJNoArguDepthFirst;

public class BeginTokenVisitor extends GJNoArguDepthFirst<NodeToken> {

  // ---------------------------------------------------------------------------
  // Generic nodes
  // ---------------------------------------------------------------------------

  @Override
  public NodeToken visit(final NodeList n) {
    for (int i = 0; i < n.size(); i++) {
      final NodeToken t = n.elementAt(i).accept(this);
      if (t != null) return t;
    }
    return null;
  }

  @Override
  public NodeToken visit(final NodeSequence n) {
    for (int i = 0; i < n.size(); i++) {
      final NodeToken t = n.elementAt(i).accept(this);
      if (t != null) return t;
    }
    return null;
  }

  @Override
  public NodeToken visit(final NodeListOptional n) {
    for (int i = 0; i < n.size(); i++) {
      final NodeToken t = n.elementAt(i).accept(this);
      if (t != null) return t;
    }
    return null;
  }

  @Override
  public NodeToken visit(final NodeOptional n) {
    if (n.present()) {
      return n.node.accept(this);
    }
    return null;
  }

  @Override
  public NodeToken visit(final NodeToken n) {
    return n;
  }

  // ---------------------------------------------------------------------------
  // FQN
  // ---------------------------------------------------------------------------

  @Override
  public NodeToken visit(final FullyQualifiedName n) {
    return n.f0;
  }

  // ---------------------------------------------------------------------------
  // File level grammar
  // ---------------------------------------------------------------------------

  @Override
  public NodeToken visit(final ADLFile n) {
    final NodeToken t = n.f0.accept(this);
    if (t != null) return t;

    return n.f1.accept(this);
  }

  @Override
  public NodeToken visit(final ImportDefinition n) {
    return n.f1;
  }

  @Override
  public NodeToken visit(final ArchitectureDefinition n) {
    return n.f0.accept(this);
  }

  // ---------------------------------------------------------------------------
  // Definition prototypes grammar
  // ---------------------------------------------------------------------------

  @Override
  public NodeToken visit(final TypeDefinition n) {
    return n.f1;
  }

  @Override
  public NodeToken visit(final ExtendedTypeDefinitions n) {
    return n.f0;
  }

  @Override
  public NodeToken visit(final TypeDefinitionReference n) {
    return n.f0.accept(this);
  }

  @Override
  public NodeToken visit(final TypeDefinitionBody n) {
    return n.f0.accept(this);
  }

  @Override
  public NodeToken visit(final TypeDefinitionElement n) {
    return n.f0.accept(this);
  }

  // ---------------------------------------------------------------------------

  @Override
  public NodeToken visit(final PrimitiveDefinition n) {
    final NodeToken t = n.f1.accept(this);
    if (t != null) return t;

    return n.f2;
  }

  @Override
  public NodeToken visit(final FormalParameterDeclarationList n) {
    return n.f0;
  }

  @Override
  public NodeToken visit(final FormalParameterDeclaration n) {
    return n.f0;
  }

  @Override
  public NodeToken visit(final ExtendedPrimitiveDefinitions n) {
    return n.f0;
  }

  @Override
  public NodeToken visit(final PrimitiveDefinitionReference n) {
    return n.f0.accept(this);
  }

  @Override
  public NodeToken visit(final ArgumentList n) {
    return n.f0;
  }

  @Override
  public NodeToken visit(final ArgumentAssignement n) {
    return n.f0;
  }

  @Override
  public NodeToken visit(final Argument n) {
    return n.f0.accept(this);
  }

  @Override
  public NodeToken visit(final PrimitiveDefinitionBody n) {
    return n.f0.accept(this);
  }

  @Override
  public NodeToken visit(final PrimitiveDefinitionElement n) {
    return n.f0.accept(this);
  }

  // ---------------------------------------------------------------------------

  @Override
  public NodeToken visit(final CompositeDefinition n) {
    return n.f1;
  }

  @Override
  public NodeToken visit(final FormalTypeParameterDeclarationList n) {
    return n.f0;
  }

  @Override
  public NodeToken visit(final FormalTypeParameterDeclaration n) {
    return n.f0;
  }

  @Override
  public NodeToken visit(final CompositeDefinitionReference n) {
    return n.f0.accept(this);
  }

  @Override
  public NodeToken visit(final TypeArgumentList n) {
    return n.f0;
  }

  @Override
  public NodeToken visit(final TypeArgumentAssignement n) {
    return n.f0;
  }

  @Override
  public NodeToken visit(final TypeArgument n) {
    return n.f0.accept(this);
  }

  @Override
  public NodeToken visit(final ExtendedCompositeDefinitions n) {
    return n.f0;
  }

  @Override
  public NodeToken visit(final CompositeDefinitionBody n) {
    return n.f0.accept(this);
  }

  @Override
  public NodeToken visit(final CompositeDefinitionElement n) {
    return n.f0.accept(this);
  }

  // ---------------------------------------------------------------------------
  // Content grammar
  // ---------------------------------------------------------------------------

  @Override
  public NodeToken visit(final InterfaceDefinition n) {
    return n.f1.accept(this);
  }

  @Override
  public NodeToken visit(final FlowInterfaceDefinition n) {
    return n.f0.accept(this);
  }

  @Override
  public NodeToken visit(final FunctionalInterfaceDefinition n) {
    return n.f0.accept(this);
  }

  @Override
  public NodeToken visit(final FlowType n) {
    return n.f0.accept(this);
  }

  @Override
  public NodeToken visit(final IDTType n) {
    return n.f0.accept(this);
  }

  @Override
  public NodeToken visit(final AttributeDefinition n) {
    return n.f1;
  }

  @Override
  public NodeToken visit(final AttributeType n) {
    return n.f0.accept(this);
  }

  @Override
  public NodeToken visit(final AttributeValue n) {
    return n.f0.accept(this);
  }

  @Override
  public NodeToken visit(final CompoundAttributeValue n) {
    return n.f0.accept(this);
  }

  @Override
  public NodeToken visit(final CompoundAttributeValueField n) {
    final NodeToken t = n.f0.accept(this);
    if (t != null) return t;

    return n.f1.accept(this);
  }

  @Override
  public NodeToken visit(final CompoundFieldName n) {
    return n.f0.accept(this);
  }

  @Override
  public NodeToken visit(final DataDefinition n) {
    return n.f1;
  }

  @Override
  public NodeToken visit(final ImplementationDefinition n) {
    return n.f1;
  }

  @Override
  public NodeToken visit(final Path n) {
    NodeToken t = n.f0.accept(this);
    if (t != null) return t;

    t = n.f1.accept(this);
    if (t != null) return t;

    t = n.f2.accept(this);
    if (t != null) return t;

    return n.f3;
  }

  @Override
  public NodeToken visit(final BindingDefinition n) {
    return n.f1;
  }

  @Override
  public NodeToken visit(final BindingComponentName n) {
    return n.f0.accept(this);
  }

  @Override
  public NodeToken visit(final SubComponentDefinition n) {
    return n.f1;
  }

  @Override
  public NodeToken visit(final SimpleSubComponentReference n) {
    final NodeToken t = n.f0.accept(this);
    if (t != null) return t;

    return n.f1;
  }

  @Override
  public NodeToken visit(final CompositeAnonymousDefinition n) {
    return n.f1;
  }

  @Override
  public NodeToken visit(final PrimitiveAnonymousDefinition n) {
    return n.f1;
  }

  @Override
  public NodeToken visit(final PrimitiveAnonymousExtension n) {
    return n.f1;
  }

  @Override
  public NodeToken visit(final CompositeAnonymousExtension n) {
    return n.f1;
  }

  // ---------------------------------------------------------------------------
  // Annotation grammar
  // ---------------------------------------------------------------------------

  @Override
  public NodeToken visit(final Annotations n) {
    return n.f0.accept(this);
  }

  @Override
  public NodeToken visit(final org.ow2.mind.adl.jtb.syntaxtree.Annotation n) {
    return n.f0;
  }

  @Override
  public NodeToken visit(final AnnotationParameters n) {
    return n.f0;
  }

  @Override
  public NodeToken visit(final AnnotationValuePairs n) {
    return n.f0.accept(this);
  }

  @Override
  public NodeToken visit(final AnnotationValuePair n) {
    return n.f0;
  }

  @Override
  public NodeToken visit(final AnnotationValue n) {
    return n.f0.accept(this);
  }

  @Override
  public NodeToken visit(final AnnotationAnnotationValue n) {
    return n.f0.accept(this);
  }

  @Override
  public NodeToken visit(final ArrayAnnotationValue n) {
    return n.f0;
  }

  // ---------------------------------------------------------------------------
  // Value grammar
  // ---------------------------------------------------------------------------

  @Override
  public NodeToken visit(final StringValue n) {
    return n.f0;
  }

  @Override
  public NodeToken visit(final IntegerValue n) {
    final NodeToken t = n.f0.accept(this);
    if (t != null) return t;

    return n.f1;
  }

  @Override
  public NodeToken visit(final BooleanValue n) {
    return n.f0;
  }

  @Override
  public NodeToken visit(final ReferenceValue n) {
    return n.f0;
  }

  @Override
  public NodeToken visit(final NullValue n) {
    return n.f0;
  }

  @Override
  public NodeToken visit(final PathValue n) {
    return n.f0.accept(this);
  }

}