diff --git a/src/net/sourceforge/plantuml/FileFormat.java b/src/net/sourceforge/plantuml/FileFormat.java index bff8ddeb9..00b4ea339 100644 --- a/src/net/sourceforge/plantuml/FileFormat.java +++ b/src/net/sourceforge/plantuml/FileFormat.java @@ -73,6 +73,7 @@ public enum FileFormat { XMI_STANDARD("application/vnd.xmi+xml"), // XMI_STAR("application/vnd.xmi+xml"), // XMI_ARGO("application/vnd.xmi+xml"), // + XMI_SCRIPT("application/vnd.xmi+xml"), // SCXML("application/scxml+xml"), // GRAPHML("application/graphml+xml"), // PDF("application/pdf"), // diff --git a/src/net/sourceforge/plantuml/Option.java b/src/net/sourceforge/plantuml/Option.java index cf810f740..60b9258cf 100644 --- a/src/net/sourceforge/plantuml/Option.java +++ b/src/net/sourceforge/plantuml/Option.java @@ -157,6 +157,9 @@ public class Option { } else if (s.equalsIgnoreCase("-txmi:argo") || s.equalsIgnoreCase("-xmi:argo")) { setFileFormatOption(new FileFormatOption(FileFormat.XMI_ARGO)); + } else if (s.equalsIgnoreCase("-txmi:script") || s.equalsIgnoreCase("-xmi:script")) { + setFileFormatOption(new FileFormatOption(FileFormat.XMI_SCRIPT)); + } else if (s.equalsIgnoreCase("-txmi:star") || s.equalsIgnoreCase("-xmi:star")) { setFileFormatOption(new FileFormatOption(FileFormat.XMI_STAR)); diff --git a/src/net/sourceforge/plantuml/abel/Link.java b/src/net/sourceforge/plantuml/abel/Link.java index 7e4ddb378..de91e3898 100644 --- a/src/net/sourceforge/plantuml/abel/Link.java +++ b/src/net/sourceforge/plantuml/abel/Link.java @@ -204,6 +204,14 @@ public class Link extends WithLinkType implements Hideable, Removeable { return cl2; } + public String getPortName1() { + return port1; + } + + public String getPortName2() { + return port2; + } + public EntityPort getEntityPort1(Bibliotekon bibliotekon) { return getEntityPort(cl1, port1, bibliotekon); } diff --git a/src/net/sourceforge/plantuml/ant/PlantUmlTask.java b/src/net/sourceforge/plantuml/ant/PlantUmlTask.java index 31d40c564..95aa6043f 100644 --- a/src/net/sourceforge/plantuml/ant/PlantUmlTask.java +++ b/src/net/sourceforge/plantuml/ant/PlantUmlTask.java @@ -312,6 +312,9 @@ public class PlantUmlTask extends Task { if ("xmi:argo".equalsIgnoreCase(s)) { option.setFileFormatOption(new FileFormatOption(FileFormat.XMI_ARGO)); } + if ("xmi:script".equalsIgnoreCase(s)) { + option.setFileFormatOption(new FileFormatOption(FileFormat.XMI_SCRIPT)); + } if ("xmi:start".equalsIgnoreCase(s)) { option.setFileFormatOption(new FileFormatOption(FileFormat.XMI_STAR)); } diff --git a/src/net/sourceforge/plantuml/xmi/CucaDiagramXmiMaker.java b/src/net/sourceforge/plantuml/xmi/CucaDiagramXmiMaker.java index 8a04be109..ce51b30c0 100644 --- a/src/net/sourceforge/plantuml/xmi/CucaDiagramXmiMaker.java +++ b/src/net/sourceforge/plantuml/xmi/CucaDiagramXmiMaker.java @@ -71,15 +71,12 @@ public final class CucaDiagramXmiMaker { if (diagram instanceof StateDiagram) xmi = new XmiStateDiagram((StateDiagram) diagram); else if (diagram instanceof DescriptionDiagram) - xmi = new XmiDescriptionDiagram((DescriptionDiagram) diagram); - else if (fileFormat == FileFormat.XMI_STANDARD) - xmi = new XmiClassDiagramStandard((ClassDiagram) diagram); - else if (fileFormat == FileFormat.XMI_ARGO) - xmi = new XmiClassDiagramArgo((ClassDiagram) diagram); - else if (fileFormat == FileFormat.XMI_STAR) - xmi = new XmiClassDiagramStar((ClassDiagram) diagram); + xmi = new XmiDescriptionDiagramScript((DescriptionDiagram) diagram); + else if (diagram instanceof ClassDiagram) + xmi = createClassDiagram(); else - throw new UnsupportedOperationException(); + throw new UnsupportedOperationException( + "Diagram type " + diagram.getUmlDiagramType() + " is not supported in XMI"); xmi.transformerXml(fos); } catch (ParserConfigurationException e) { @@ -93,4 +90,17 @@ public final class CucaDiagramXmiMaker { } } + private XmlDiagramTransformer createClassDiagram() throws ParserConfigurationException { + if (fileFormat == FileFormat.XMI_STANDARD) + return new XmiClassDiagramStandard((ClassDiagram) diagram); + else if (fileFormat == FileFormat.XMI_ARGO) + return new XmiClassDiagramArgo((ClassDiagram) diagram); + else if (fileFormat == FileFormat.XMI_SCRIPT) + return new XmiClassDiagramScript((ClassDiagram) diagram); + else if (fileFormat == FileFormat.XMI_STAR) + return new XmiClassDiagramStar((ClassDiagram) diagram); + else + throw new UnsupportedOperationException(); + } + } diff --git a/src/net/sourceforge/plantuml/xmi/UMLAggregationKind.java b/src/net/sourceforge/plantuml/xmi/UMLAggregationKind.java new file mode 100644 index 000000000..9a05fe2a9 --- /dev/null +++ b/src/net/sourceforge/plantuml/xmi/UMLAggregationKind.java @@ -0,0 +1,11 @@ +package net.sourceforge.plantuml.xmi; + +public enum UMLAggregationKind { + None(""), Aggregation("ak_aggregate"), Composite("ak_composite"); + + public final String name; + + private UMLAggregationKind(String umlName) { + this.name = umlName; + } +} diff --git a/src/net/sourceforge/plantuml/xmi/XmiClassDiagramScript.java b/src/net/sourceforge/plantuml/xmi/XmiClassDiagramScript.java new file mode 100644 index 000000000..ff466a52b --- /dev/null +++ b/src/net/sourceforge/plantuml/xmi/XmiClassDiagramScript.java @@ -0,0 +1,292 @@ +/* ======================================================================== + * PlantUML : a free UML diagram generator + * ======================================================================== + * + * (C) Copyright 2009-2024, Arnaud Roques + * + * Project Info: https://plantuml.com + * + * If you like this project or if you find it useful, you can support us at: + * + * https://plantuml.com/patreon (only 1$ per month!) + * https://plantuml.com/paypal + * + * This file is part of PlantUML. + * + * PlantUML is free software; you can redistribute it and/or modify it + * under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * PlantUML 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 General Public + * License for more details. + * + * You should have received a copy of the GNU General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, + * USA. + * + * + * Original Author: Arnaud Roques + * + * + */ +package net.sourceforge.plantuml.xmi; + +import java.util.ArrayList; +import java.util.HashMap; +import java.util.List; +import java.util.Map; + +import javax.xml.parsers.ParserConfigurationException; + +import org.w3c.dom.Element; +import org.w3c.dom.NodeList; + +import net.sourceforge.plantuml.abel.Entity; +import net.sourceforge.plantuml.abel.Link; +import net.sourceforge.plantuml.classdiagram.ClassDiagram; +import net.sourceforge.plantuml.decoration.LinkDecor; +import net.sourceforge.plantuml.klimt.creole.Display; +import net.sourceforge.plantuml.utils.Log; + +public class XmiClassDiagramScript extends XmiClassDiagramAbstract implements XmlDiagramTransformer { + + + private static class MemberData { + public final String name; + public final String id; + public final String kind; + + public MemberData(String name, String id, String kind) { + super(); + this.name = name; + this.id = id; + this.kind = kind; + } + + } + + protected final Map> members = new HashMap<>(); + + public XmiClassDiagramScript(ClassDiagram classDiagram) throws ParserConfigurationException { + super(classDiagram); + + addPackage(ownedElementRoot, classDiagram.getRootGroup()); + + for (final Link link : classDiagram.getLinks()) + addLink(link); + + } + + final protected Element createElementPackage(Entity group) { + final Element umlPackage = document.createElement("UML:Package"); + + umlPackage.setAttribute("xmi.id", group.getUid()); + umlPackage.setAttribute("name", group.getDisplay().get(0).toString()); + + final Element namespaceOwnedElement = document.createElement("UML:Namespace.ownedElement"); + umlPackage.appendChild(namespaceOwnedElement); + + addPackage(namespaceOwnedElement, group); + + return umlPackage; + + } + + private void addPackage(Element element, Entity group) { + for (final Entity ent : group.leafs()) { + final Element cla = createEntityNode(ent); + if (cla == null) + continue; + + element.appendChild(cla); + members.computeIfAbsent(ent.getUid(), (e) -> new ArrayList<>()); + NodeList attrs = cla.getElementsByTagName("UML:Attribute"); + for (int i = 0; i < attrs.getLength(); i++) { + Element child = (Element) attrs.item(i); + members.get(ent.getUid()).add( + new MemberData(child.getAttribute("name"), child.getAttribute("xmi.id"), child.getTagName())); + } + NodeList ops = cla.getElementsByTagName("UML:Operation"); + for (int i = 0; i < ops.getLength(); i++) { + Element child = (Element) ops.item(i); + members.get(ent.getUid()).add( + new MemberData(child.getAttribute("name"), child.getAttribute("xmi.id"), child.getTagName())); + } + done.add(ent); + } + + for (final Entity childGroup : group.groups()) { + final Element result = createElementPackage(childGroup); + element.appendChild(result); + done.add(childGroup); + } + + } + + private void addLink(Link link) { + if (link.isHidden() || link.isInvis()) + return; + if (!link.getType().getStyle().isNormal()) { + // this is some kind of dashed line, which means it is a dependency + Element dependency = createDependency(link); + ownedElementRoot.appendChild(dependency); + return; + } + + final String assId = "ass" + classDiagram.getUniqueSequence(); + if (link.getType().getDecor1() == LinkDecor.EXTENDS || link.getType().getDecor2() == LinkDecor.EXTENDS) { + addExtension(link, assId); + return; + } + + UMLAggregationKind aggregation = UMLAggregationKind.None; + if (link.getType().getDecor1() == LinkDecor.COMPOSITION) { + aggregation = UMLAggregationKind.Composite; + } + if (link.getType().getDecor2() == LinkDecor.COMPOSITION) { + aggregation = UMLAggregationKind.Composite; + } + if (link.getType().getDecor1() == LinkDecor.AGREGATION) { + aggregation = UMLAggregationKind.Aggregation; + } + if (link.getType().getDecor2() == LinkDecor.AGREGATION) { + aggregation = UMLAggregationKind.Aggregation; + } + + final Element association = document.createElement("UML:Association"); + association.setAttribute("xmi.id", assId); + // association.setAttribute("namespace", + // CucaDiagramXmiMaker.getModel(classDiagram)); + if (Display.isNull(link.getLabel()) == false) + association.setAttribute("name", forXMI(link.getLabel())); + + final Element connection = document.createElement("UML:Association.connection"); + final Element end1 = createAssociationEnd(assId, link.getType().getDecor2(), link.getQuantifier1(), + link.getEntity1(), aggregation); + + connection.appendChild(end1); + final Element end2 = createAssociationEnd(assId, link.getType().getDecor1(), link.getQuantifier2(), + link.getEntity2(), aggregation); + connection.appendChild(end2); + + association.appendChild(connection); + + ownedElementRoot.appendChild(association); + } + + private Element createAssociationEnd(final String assId, final LinkDecor decor, final String quantifier, + Entity entity, UMLAggregationKind aggregation) { + final Element end = document.createElement("UML:AssociationEnd"); + end.setAttribute("xmi.id", "end" + classDiagram.getUniqueSequence()); + end.setAttribute("association", assId); + +// end1.setAttribute("type", link.getEntity1().getUid()); + if (quantifier != null) + end.setAttribute("name", forXMI(quantifier)); + // TODO this is the multiplicity, handle that correctly + + end.setAttribute("participant", entity.getUid()); + + if (aggregation != UMLAggregationKind.None) + end.setAttribute("aggregation", aggregation.name); + + boolean navigable = decor != LinkDecor.NOT_NAVIGABLE && decor != LinkDecor.NONE; + end.setAttribute("isNavigable", Boolean.toString(navigable)); + + return end; + } + + private void addExtension(Link link, String assId) { + final Element association = document.createElement("UML:Generalization"); + association.setAttribute("xmi.id", assId); + if (link.getLabel() != null) + association.setAttribute("name", forXMI(link.getLabel())); + + if (link.getType().getDecor1() == LinkDecor.EXTENDS) + generalizationChildParent(association, link.getEntity1().getUid(), link.getEntity2().getUid()); + else if (link.getType().getDecor2() == LinkDecor.EXTENDS) + generalizationChildParent(association, link.getEntity2().getUid(), link.getEntity1().getUid()); + else + throw new IllegalStateException(); + + ownedElementRoot.appendChild(association); + } + + private Element createDependency(Link link) { + // determine kind and direction + if (link.isInverted()) { + return createDependencyClientSupplier(link.getEntity2(), link.getPortName2(), link.getEntity1(), + link.getPortName1()); + } else { + return createDependencyClientSupplier(link.getEntity1(), link.getPortName1(), link.getEntity2(), + link.getPortName2()); + } + } + + private Element createRef(Entity entity, String member) { + if (member == null) { + // directly to entity + Element ref = document.createElement("UML:Class"); + ref.setAttribute("xmi.idref", entity.getUid()); + return ref; + } + List mbers = members.get(entity.getUid()); + if (mbers == null) { + Log.info(String.format("Could not find entity %s in member list", entity.getName())); + return null; + } + for (MemberData m : mbers) { + if (m.name.contains(member)) { + Element ref = document.createElement(m.kind); + ref.setAttribute("xmi.idref", m.id); + return ref; + } + } + // All members must have been added to the map + Log.error(String.format("Could not find the member %s in the object %s", member, entity.getName())); + return null; + } + + private Element createDependencyClientSupplier(Entity clientEntity, String clientPort, Entity supplierEntity, + String supplierPort) { + String depID = classDiagram.getUniqueSequence("dep"); + Element dependency = document.createElement("UML:Dependency"); + dependency.setAttribute("xmi.id", depID); + Element client = document.createElement("UML:Dependency.client"); + Element supplier = document.createElement("UML:Dependency.supplier"); + Element clientRef = createRef(clientEntity, clientPort); + if (clientRef != null) + client.appendChild(clientRef); + Element supplierRef = createRef(supplierEntity, supplierPort); + if (supplierRef != null) + supplier.appendChild(supplierRef); + dependency.appendChild(client); + dependency.appendChild(supplier); + return dependency; + } + + private void generalizationChildParent(Element association, String uidChild, String uidParent) { + final Element child = document.createElement("UML:Generalization.child"); + final Element parent = document.createElement("UML:Generalization.parent"); + + final Element classChild = document.createElement("UML:Class"); + classChild.setAttribute("xmi.idref", uidChild); + final Element classParent = document.createElement("UML:Class"); + classParent.setAttribute("xmi.idref", uidParent); + + parent.appendChild(classParent); + child.appendChild(classChild); + + association.appendChild(child); + association.appendChild(parent); +// association.setAttribute("child", uidChild); +// association.setAttribute("parent", uidParent); + + } + + +} diff --git a/test/nonreg/xmi/XmiTest.java b/test/nonreg/xmi/XmiTest.java index 760a2ae6a..696a86621 100644 --- a/test/nonreg/xmi/XmiTest.java +++ b/test/nonreg/xmi/XmiTest.java @@ -39,17 +39,24 @@ public class XmiTest { final String argoExpected = readStringFromSourceFile(getDiagramFile(), "{{{argo", "}}}argo"); assertXMIEqual(argo, argoExpected); + + final String script = removeVersion(runPlantUML(expectedDescription, FileFormat.XMI_SCRIPT)); + final String scriptExpected = readStringFromSourceFile(getDiagramFile(), "{{{script", "}}}script"); + + assertXMIEqual(script, scriptExpected); } private void assertXMIEqual(final String actual, final String expected) { // XMI is XML, so we can just use the xmlunit diffbuilder // Compare elements with the same xmi ID // checkForSimilar required to ignore order - Diff diff = DiffBuilder.compare(Input.fromString(actual)).withTest(Input.fromString(expected)) + Diff diff = DiffBuilder.compare(Input.fromString(expected)).withTest(Input.fromString(actual)) .ignoreWhitespace().ignoreComments().checkForSimilar() .withNodeMatcher(new DefaultNodeMatcher(ElementSelectors.byNameAndAttributes("xmi.id"))).build(); if (diff.hasDifferences()) { + System.out.println("Generated XMI: "); + System.out.println(actual); assertTrue(false, diff.fullDescription()); } } diff --git a/test/nonreg/xmi/clazz/XMI0000_Test.java b/test/nonreg/xmi/clazz/XMI0000_Test.java index fdde5f0c9..d5fc4ae6c 100644 --- a/test/nonreg/xmi/clazz/XMI0000_Test.java +++ b/test/nonreg/xmi/clazz/XMI0000_Test.java @@ -69,6 +69,30 @@ Expected result MUST be put between triple brackets }}}argo +{{{script + + + + PlantUML + + + + + + + + + + + + + + + + +}}}script + + */ public class XMI0000_Test extends XmiTest { diff --git a/test/nonreg/xmi/clazz/XMI0002_Test.java b/test/nonreg/xmi/clazz/XMI0002_Test.java index c0c3a04a7..66cbfbabf 100644 --- a/test/nonreg/xmi/clazz/XMI0002_Test.java +++ b/test/nonreg/xmi/clazz/XMI0002_Test.java @@ -96,6 +96,37 @@ Expected result MUST be put between triple brackets }}}argo +{{{script + + + + PlantUML + + + + + + + + + + + + + + + + + + + + + + + +}}}script + + */ public class XMI0002_Test extends XmiTest { diff --git a/test/nonreg/xmi/clazz/XMI0003_Test.java b/test/nonreg/xmi/clazz/XMI0003_Test.java index ef183ffbd..f78328fc5 100644 --- a/test/nonreg/xmi/clazz/XMI0003_Test.java +++ b/test/nonreg/xmi/clazz/XMI0003_Test.java @@ -88,6 +88,34 @@ Expected result MUST be put between triple brackets }}}argo +{{{script + + + + PlantUML + + + + + + + + + + + + + + + + + + + + + + +}}}script */ public class XMI0003_Test extends XmiTest { diff --git a/test/nonreg/xmi/clazz/XMI0004_Test.java b/test/nonreg/xmi/clazz/XMI0004_Test.java new file mode 100644 index 000000000..e5a7c92f7 --- /dev/null +++ b/test/nonreg/xmi/clazz/XMI0004_Test.java @@ -0,0 +1,140 @@ +package nonreg.xmi.clazz; + +import java.io.IOException; + +import org.junit.jupiter.api.Test; + +import nonreg.xmi.XmiTest; + +/* + + +https://forum.plantuml.net/12972/only-the-first-line-any-component-description-exported-file + + +Test diagram MUST be put between triple quotes + +""" +@startuml +class A { +} + +class B{ +} + +A .> B +@enduml +""" + +Expected result MUST be put between triple brackets + +{{{star + + + + PlantUML + + + + + + + + + + + + + + + + + + + + + + + + + + + +}}}star + +{{{argo + + + + PlantUML + + + + + + + + + + + + + + + + + + + + + + + + + + + +}}}argo + +{{{script + + + + PlantUML + + + + + + + + + + + + + + + + + + + + + + + + + +}}}script + + + */ +public class XMI0004_Test extends XmiTest { + + @Test + void testSimple() throws IOException { + checkXmlAndDescription("(2 entities)"); + } + +}