Merge pull request #443 from Systems-Modeling/ST6RI-637

ST6RI-637: FeatureChains starting with subsetting or redefining features are not properly rendered (PlantUML)

Author: seidewitz

org.omg.sysml.plantuml/src/org/omg/sysml/plantuml/CompartmentEntry.java

@@ -91,7 +91,7 @@ public String getTitle() {
             return "values";
         }
         if (om instanceof SubjectMembership) {
-            return "subjects";
+            return "subject";
         }
         if (om instanceof ActorMembership) {
             return "actors";

org.omg.sysml.plantuml/src/org/omg/sysml/plantuml/InheritKey.java

@@ -35,8 +35,13 @@
 import org.omg.sysml.lang.sysml.Redefinition;
 import org.omg.sysml.lang.sysml.Type;
 
+
+/* InheritKey identifies a feature or a membership with the context of inheriting.
+ * The target feature to be identified must be "connectors" owning ends
+ * or "types" owning features referring to others. */
 class InheritKey {
     public final Type[] keys;
+    /* If isDirect, the last key directly owns the target feature. */
     private final boolean isDirect;
 
     private static boolean containsWithRedefined(List<Feature> fs, Feature ft) {

org.omg.sysml.plantuml/src/org/omg/sysml/plantuml/PRelation.java

@@ -111,7 +111,7 @@ public PRelation(InheritKey ik, Element src, Element dest, Element rel, String d
         this.description = description;
     }
 
-    public PRelation(Object src, Object dest, Element rel, String description) {
+    public PRelation(InheritKey ik, Object src, Object dest, Element rel, String description) {
         this.ik = null;
         this.src = src;
         this.dest = dest;

org.omg.sysml.plantuml/src/org/omg/sysml/plantuml/SysML2PlantUMLStyle.java

@@ -111,6 +111,10 @@ public String caseConnector(Connector object) {
                  public String caseBindingConnector(BindingConnector object) {
                      return " -[thickness=5,#red]- ";
                  }
+                 @Override
+                 public String caseFeatureValue(FeatureValue fv) {
+                     return " -[thickness=5,#red]- ";
+                 }
              }, null),
              "decoratedRedefined", "true");
         addp("PLANTUML",

org.omg.sysml.plantuml/src/org/omg/sysml/plantuml/VCase.java

@@ -67,7 +67,7 @@ protected VTree newVTree(Namespace namespace, Membership membership) {
     }
 
     private String addCase(Type typ) {
-        String name = getNameAnyway(typ);
+        String name = extractTitleName(typ);
         int id = addRecLine(name, typ, true);
         addSpecializations(id, typ);
 
@@ -99,7 +99,7 @@ public String caseObjectiveMembership(ObjectiveMembership om) {
 
     @Override
     public String caseSubjectMembership(SubjectMembership sm) {
-        addSubjectMembership(sm, true);
+        addSubjectMembership(sm, false);
         return "";
     }
 

org.omg.sysml.plantuml/src/org/omg/sysml/plantuml/VCompartment.java

@@ -496,9 +496,6 @@ private void addCompartmentEntries(List<CompartmentEntry> es, int level) {
                 append(' ');
             }
             append(ce.getParameterPrefix());
-            if (ce.isInherited) {
-                append('^');
-            }
             if (ce.prefix != null) {
                 append(ce.prefix);
             }
@@ -543,7 +540,7 @@ private void addDocumentations() {
     	if (documentations == null) return;
 
         boolean flag = false;
-        append("##//documentations//##\n");
+        append("##//doc//##\n");
         for (Documentation doc: documentations) {
             String name = doc.getName();
             if (name != null && !name.isEmpty()) {

org.omg.sysml.plantuml/src/org/omg/sysml/plantuml/VComposite.java

@@ -73,6 +73,7 @@ public String caseUsage(Usage f) {
         String featureText = getFeatureText(f);
         if (featureText.isEmpty()) return "";
         int id = addPUMLLine(f, "rec usage ", featureText);
+        addFeatureValueBindings(f);
 
         VComposite vc = new VComposite(this);
         vc.traverse(f);

org.omg.sysml.plantuml/src/org/omg/sysml/plantuml/VDefault.java

@@ -48,8 +48,8 @@
 import org.omg.sysml.lang.sysml.Import;
 import org.omg.sysml.lang.sysml.ItemFlow;
 import org.omg.sysml.lang.sysml.ItemFlowEnd;
-import org.omg.sysml.lang.sysml.Membership;
 import org.omg.sysml.lang.sysml.MetadataFeature;
+import org.omg.sysml.lang.sysml.Namespace;
 import org.omg.sysml.lang.sysml.OwningMembership;
 import org.omg.sysml.lang.sysml.Relationship;
 import org.omg.sysml.lang.sysml.Specialization;
@@ -108,24 +108,35 @@ Use getName() instead. */
     }
 
     protected void addFeatureValueBindings(Type typ) {
-        for (Membership m: typ.getOwnedMembership()) {
-            if (m instanceof FeatureValue) {
-                FeatureValue fv = (FeatureValue) m;
+        // To properly process inheritings, use VTraverser.
+        VTraverser vt = new VTraverser(this) {
+            @Override
+            public String caseFeatureValue(FeatureValue fv) {
                 Expression v = fv.getValue();
                 Element tgt = resolveReference(v);
                 if (tgt != null) {
                     addPRelation(typ, tgt, fv, "=");
                 }
+                return "";
             }
-        }
+            @Override
+            public String caseNamespace(Namespace ns) {
+                return "";
+            }
+        };
+        vt.traverse(typ);
     }
 
     protected void addSpecializations(int typId, Type typ) {
         if (typId < 0) return;
+        InheritKey ik = null;
         for (Specialization s: typ.getOwnedSpecialization()) {
             Type gt = s.getGeneral();
             if (gt == null) continue;
-            PRelation pr = new PRelation(typId, gt, s, null);
+            if (ik != null && typ instanceof Feature) {
+            	ik = makeInheritKey((Feature) typ);
+            }
+            PRelation pr = new PRelation(ik, typId, gt, s, null);
             addPRelation(pr);
         }
     }

org.omg.sysml.plantuml/src/org/omg/sysml/plantuml/VPath.java

@@ -284,6 +284,18 @@ public PCTerminal(PC prev) {
         }
     }
 
+    /* It makes an inherit key of the feature owning feature
+       (such as connector and subsetting feature) */
+    private InheritKey makeInheritKeyOfOwner(Feature f) {
+        Type owningType = f.getOwningType();
+        if (owningType instanceof Feature) {
+            return makeInheritKey((Feature) owningType);
+        } else {
+            /* non-feature types cannot be inherited and it returns null */
+            return null;
+        }
+    }
+
     /*
       ife : ItemFlowEnd :> baseTarget (e.g. action) {
            // ReferenceUsage
@@ -305,7 +317,7 @@ public RefPC makeRefPCItemFlowEnd(ItemFlowEnd ife) {
         if (pc == null) return null;
         Feature ioTarget = getIOTarget(ife);
         pc = new PCItemFlowEnd(ife, pc, ioTarget);
-        InheritKey ik = getInheritKey(ife);
+        InheritKey ik = makeInheritKeyOfOwner(ife);
         return new RefPC(pc, ik);
     }
 
@@ -444,25 +456,6 @@ private void putPathIdMap(Integer id, InheritKey ik, Element pt) {
 
     private List<RefPC> current = new ArrayList<RefPC>();
 
-    private InheritKey getInheritKey(List<FeatureChaining> fcs) {
-        FeatureChaining fc = fcs.get(0);
-        Feature ref = fc.getChainingFeature();
-        return makeInheritKey(ref);
-    }
-
-    private InheritKey getInheritKey(Feature f) {
-        for (Subsetting ss: f.getOwnedSubsetting()) {
-            Feature sf = ss.getSubsettedFeature();
-            List<FeatureChaining> fcs = sf.getOwnedFeatureChaining();
-            if (fcs.isEmpty()) {
-                return makeInheritKey(sf);
-            } else {
-                return getInheritKey(fcs);
-            }
-        }
-        return null;
-    }
-
     private PC makeSubsettedFeaturePC(Feature f) {
         for (Subsetting ss: f.getOwnedSubsetting()) {
             Feature sf = ss.getSubsettedFeature();
@@ -478,7 +471,7 @@ private PC makeSubsettedFeaturePC(Feature f) {
 
     private RefPC makeRefPC(Feature f, PC pc) {
         if (pc == null) return null;
-        InheritKey ik = getInheritKey(f);
+        InheritKey ik = makeInheritKeyOfOwner(f);
         return new RefPC(pc, ik);
     }
 
@@ -511,22 +504,8 @@ private String addContext(ItemFlowEnd ife) {
         return "";
     }
 
-    private static Feature head(FeatureChainExpression fce) {
-        List<Expression> ops = fce.getOperand();
-        if (ops.isEmpty()) {
-            return null;
-        } else {
-            Expression ex = ops.get(0);
-            if (!(ex instanceof FeatureReferenceExpression)) return null;
-            FeatureReferenceExpression fre = (FeatureReferenceExpression) ex;
-            return fre.getReferent();
-        }
-    }
-
     private String addContext(FeatureChainExpression fce) {
-        Feature ref = head(fce);
-        if (ref == null) return null;
-        InheritKey ik = getInheritKey(ref);
+        InheritKey ik = makeInheritKey(fce);
         PC pc = new PCFeatureChainExpression(fce);
         RefPC rpc = new RefPC(pc, ik);
         addRefPC(rpc);

org.omg.sysml.plantuml/src/org/omg/sysml/plantuml/VStructure.java

@@ -163,7 +163,7 @@ private Feature getRedefinedFeature(Feature f) {
     private String redefinedFeatureText(Feature f) {
         Feature rf = getRedefinedFeature(f);
         if (rf == null) return null;
-        return getNameWithNamespace(rf);
+        return getRefName(rf);
     }
 
     private boolean addRedefinedFeatureText(Feature f) {
@@ -177,9 +177,6 @@ private boolean addRedefinedFeatureText(Feature f) {
     }
 
     private void addFeatureTextInternal(Feature f, String name, boolean isInherited) {
-        if (isInherited) {
-            append('^');
-        }
         append(name);
         addFeatureTypeAndSubsettedText(f);
         addFeatureMembershipText(f);