Clean-up, document and rename some attributes.

• Structured analysis file to better find attributes, and documented some of the attributes
• Added one error test case for a role being already declared (see Errors and ErrorsLeft)
• Removed unused attributes
• Renamed attributes to better match their purpose
• Effectively removed LeftDirection from analysis, as it is now parsed as an inversed RightDirection (as we do not have round-trip parse-print-parse tests, this is not a problem)

src/main/jastadd/Analysis.jrag

@@ -4,95 +4,103 @@ import java.util.*;
 aspect TypeAnalysis {
   public abstract TypeUse Component.getTypeUse();
 
+  //--- lookupType ---
   syn TypeDecl TypeUse.decl() = lookupType(getID());
   inh TypeDecl TypeUse.lookupType(String name);
+  inh TypeDecl TypeDecl.lookupType(String name);
   eq Program.getChild().lookupType(String name) {
-    for (TypeDecl td: getTypeDecls()) {
+    for (TypeDecl td : getTypeDecls()) {
       if (td.getID().equals(name)) {
         return td;
       }
     }
     return null;
   }
-  syn boolean TypeDecl.isAlreadyDeclared()
-    = lookupType(getID()) != this;
-  inh TypeDecl TypeDecl.lookupType(String name);
 
-  syn TypeDecl TypeDecl.mostGeneralSuperType() {
-    if (!hasSuper()) {
-      return this;
-    } else {
-      return getSuper().decl().mostGeneralSuperType();
-    }
-  }
+  //--- isAlreadyDeclared ---
+  syn boolean TypeDecl.isAlreadyDeclared() = lookupType(getID()) != this;
 }
 
 aspect ComponentAnalysis {
-  syn boolean Component.isTargetOfDirectedRelation() = false;
-  eq RelationComponent.isTargetOfDirectedRelation() = isTargetOfRightDirection() | isTargetOfLeftDirection();
-  inh boolean RelationComponent.isTargetOfRightDirection();
-  eq Relation.getRight().isTargetOfRightDirection()
-    = getDirection() instanceof RightDirection;
-  eq Program.getChild().isTargetOfRightDirection() = false;
-  inh boolean RelationComponent.isTargetOfLeftDirection();
-  eq Relation.getLeft().isTargetOfLeftDirection()
-    = getDirection() instanceof LeftDirection;
-  eq Program.getChild().isTargetOfLeftDirection() = false;
+  //--- isTargetOfDirectedRelation ---
+  inh boolean Component.isTargetOfDirectedRelation();
+  eq Relation.getRight().isTargetOfDirectedRelation() = getDirection() instanceof RightDirection;
+  eq Program.getChild().isTargetOfDirectedRelation() = false;
 
+  //--- name ---
   syn String Component.name() = getID();
 
+  //--- toTypeDecl ---
+  /** @return enclosing type */
   syn TypeDecl Component.toTypeDecl() = enclosingTypeDecl();
+  /** @return type of nonterminal relation role is defined for */
   eq RelationComponent.toTypeDecl() = getTypeUse().decl();
+
+  //--- enclosingTypeDecl ---
   inh TypeDecl Component.enclosingTypeDecl();
   eq TypeDecl.getChild().enclosingTypeDecl() = this;
   eq Program.getChild().enclosingTypeDecl() = null;
 
+  //--- otherSide ---
   inh RelationComponent RelationComponent.otherSide();
   eq Relation.getLeft().otherSide() = getRight();
   eq Relation.getRight().otherSide() = getLeft();
   eq Program.getChild().otherSide() = null;
 
+  //--- ofTypeDecl ---
   syn TypeDecl RelationComponent.ofTypeDecl() = otherSide().toTypeDecl();
 
-  syn boolean Component.isAlreadyDeclared()
-    = !isTargetOfDirectedRelation()
-      && toTypeDecl() != null
-      && lookupComponent(toTypeDecl(), name()) != this;
-  inh Component Component.lookupComponent(TypeDecl td, String name);
-  eq Program.getChild().lookupComponent(TypeDecl td, String name)
-    = lookupComponentSyn(td, name);
-  syn Component Program.lookupComponentSyn(TypeDecl td, String name) {
+  //--- isAlreadyDeclared ---
+  /**
+   * Check, if role with the same name is already declared on the same nonterminal
+   */
+  syn boolean RelationComponent.isAlreadyDeclared()
+    = !isTargetOfDirectedRelation()                     /* if unnamed in relation, there is no role name, so no error */
+      && toTypeDecl() != null                           /* nonterminal type of role is defined */
+      && findComponent(toTypeDecl(), name()) != this;   /* there is another role defined previously with the same name */
+
+  //--- findComponent ---
+  /** Search for either a component on the RHS of the given type with the given name,
+   *   or a relation part for the given type and a role with the given name */
+  inh Component Component.findComponent(TypeDecl td, String name);
+  eq Program.getChild().findComponent(TypeDecl td, String name)
+    = findComponentSyn(td, name);
+  syn Component Program.findComponentSyn(TypeDecl td, String name) {
     for (Component c: td.getComponents()) {
       if (c.name().equals(name)) {
         return c;
       }
     }
 
-    for (Relation r: getRelations()) {
-      Component c = r.getLeft().lookup(td, name);
-      if (c != null) return c;
-      c = r.getRight().lookup(td, name);
-      if (c != null) return c;
+    for (Relation r : getRelations()) {
+      if (r.getLeft().matches(td, name))
+        return r.getLeft();
+      if (r.getRight().matches(td, name))
+        return r.getRight();
     }
 
     return null;
   }
 
+  //--- isInvalidRedefinition ---
+  /**
+   * Check, if a component with the same name is already declared in some supertype
+   */
   syn boolean Component.isInvalidRedefinition() {
-    if (toTypeDecl() == null) return false;
-
     TypeDecl td = toTypeDecl();
+    if (td == null) return false;
 
     while (td.hasSuper() && td.getSuper().decl() != null) {
       td = td.getSuper().decl();
-      Component c = lookupComponent(td, getID());
-      if (c != null && isTargetOfDirectedRelation()) return true;
+      // find a matching component on the RHS of the (current) super type
+      Component c = findComponent(td, getID());
 
       if (c != null && !this.isEqual(c)) return true;
     }
     return false;
   }
 
+  //--- isEqual ---
   syn boolean Component.isEqual(Component c) = this.getClass() == c.getClass() && getTypeUse().isEqual(c.getTypeUse());
 
   syn boolean TypeUse.isEqual(TypeUse u);
@@ -108,12 +116,14 @@ aspect ComponentAnalysis {
     return true;
   }
 
-  syn RelationComponent RelationComponent.lookup(TypeDecl td, String name)
-    = !isTargetOfDirectedRelation() && toTypeDecl() == td && name().equals(name)
-    ? this
-    : null;
-
+  //--- matches ---
+  /**
+   * @return true, if the component has both type and role, its type matches the given typeDecl and its name matches the given name
+   */
+  syn boolean RelationComponent.matches(TypeDecl td, String name)
+    = !isTargetOfDirectedRelation() && toTypeDecl() == td && name().equals(name);
 
+  //--- relationComponents ---
   coll Set<RelationComponent> TypeDecl.relationComponents()
     [new HashSet<RelationComponent>()]
     root Program;
@@ -122,6 +132,7 @@ aspect ComponentAnalysis {
     to TypeDecl.relationComponents()
     for toTypeDecl();
 
+  //--- relationComponentsTransitive ---
   syn Collection<RelationComponent> TypeDecl.relationComponentsTransitive() {
     ArrayList<RelationComponent> list = new ArrayList<>();
     if (hasSuper() && getSuper().decl() != null) {
@@ -131,6 +142,7 @@ aspect ComponentAnalysis {
     return list;
   }
 
+  //--- oneRelationComponents ---
   syn Set<OneRelationComponent> TypeDecl.oneRelationComponents() {
     Set<OneRelationComponent> set = new HashSet<>();
     for (RelationComponent rc: relationComponents()) {
@@ -141,27 +153,33 @@ aspect ComponentAnalysis {
     return set;
   }
 
+  //--- needUnresolvedClass ---
   syn boolean TypeDecl.needUnresolvedClass() {
     // a TypeDecl needs an unresolved class, if it can appear in a relation
     // TODO
     return true;
   }
 
+  //--- isList ---
   syn boolean Component.isList() = false;
   eq ListComponent.isList() = true;
 
+  //--- isOpt ---
   syn boolean Component.isOpt() = false;
   eq OptComponent.isOpt() = true;
 
+  //--- isNullable ---
   syn boolean Component.isNullable() = false;
   eq TokenComponent.isNullable() = !"float double int short long char byte boolean".contains(getTypeUse().getID());
 }
 
 aspect InstanceSupplier {
 
+  //--- program ---
   inh Program TypeDecl.program();
   eq Program.getTypeDecl(int i).program() = this;
 
+  //--- subTypeDecls ---
   syn Collection<TypeDecl> TypeDecl.subTypeDecls() {
     java.util.List<TypeDecl> subDecls = new ArrayList();
     for (TypeDecl decl : program().getTypeDeclList()) {
@@ -172,6 +190,7 @@ aspect InstanceSupplier {
     return subDecls;
   }
 
+  //--- instantiableSubType ---
   syn TypeDecl TypeDecl.instantiableSubType() {
     if (getAbstract() == false) {
       return this;
@@ -192,6 +211,7 @@ aspect InstanceSupplier {
 }
 
 aspect Constructors {
+  //--- componentsTransitive ---
   syn Collection<Component> TypeDecl.componentsTransitive() {
     ArrayList<Component> list = new ArrayList<>();
     if (hasSuper() && getSuper().decl() != null) {
@@ -205,6 +225,7 @@ aspect Constructors {
     return list;
   }
 
+  //--- needsConstructor ---
   syn boolean TypeDecl.needsConstructor() {
     if (componentsTransitive().isEmpty()) {
       return false;
@@ -217,30 +238,37 @@ aspect Constructors {
       && getSuper().decl().needsConstructor();
   }
 
+  //--- inConstructor ---
   /**
    * @return true, if the component should be added to the constructor (i.e., is not an NTA)
    */
   syn boolean Component.inConstructor() = true;
   eq NTAComponent.inConstructor() = false;
+  eq NTAOptComponent.inConstructor() = false;
+  eq NTAListComponent.inConstructor() = false;
 }
 
 aspect Utils {
 
+  //--- isMany ---
   syn boolean RelationComponent.isMany() = false;
   eq ManyRelationComponent.isMany() = true;
 
+  //--- toString ---
   public String SimpleTypeUse.toString() {
     return getID();
   }
   public String ParameterizedTypeUse.toString() {
     StringBuilder sb = new StringBuilder();
     sb.append(getID()).append("<");
-    int i = 0;
+    boolean first = true;
     for (TypeUse u: getTypeUses()) {
-      sb.append(u.toString());
-      if (++i < getNumTypeUse()) {
+      if (first) {
+        first = false;
+      } else {
         sb.append(", ");
       }
+      sb.append(u.toString());
     }
     sb.append(">");
     return sb.toString();