plantuml/src/net/sourceforge/plantuml/baraye/CucaDiagram.java

754 lines
21 KiB
Java

/* ========================================================================
* PlantUML : a free UML diagram generator
* ========================================================================
*
* (C) Copyright 2009-2023, Arnaud Roques
*
* Project Info: http://plantuml.com
*
* If you like this project or if you find it useful, you can support us at:
*
* http://plantuml.com/patreon (only 1$ per month!)
* http://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.baraye;
import java.io.IOException;
import java.io.OutputStream;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Objects;
import java.util.Set;
import java.util.concurrent.atomic.AtomicInteger;
import net.sourceforge.plantuml.BackSlash;
import net.sourceforge.plantuml.FileFormat;
import net.sourceforge.plantuml.FileFormatOption;
import net.sourceforge.plantuml.StringUtils;
import net.sourceforge.plantuml.UmlDiagram;
import net.sourceforge.plantuml.UmlDiagramType;
import net.sourceforge.plantuml.api.ImageDataSimple;
import net.sourceforge.plantuml.command.CommandExecutionResult;
import net.sourceforge.plantuml.core.ImageData;
import net.sourceforge.plantuml.core.UmlSource;
import net.sourceforge.plantuml.cucadiagram.Display;
import net.sourceforge.plantuml.cucadiagram.EntityGender;
import net.sourceforge.plantuml.cucadiagram.EntityPortion;
import net.sourceforge.plantuml.cucadiagram.EntityPosition;
import net.sourceforge.plantuml.cucadiagram.GroupHierarchy;
import net.sourceforge.plantuml.cucadiagram.GroupType;
import net.sourceforge.plantuml.cucadiagram.HideOrShow2;
import net.sourceforge.plantuml.cucadiagram.ICucaDiagram;
import net.sourceforge.plantuml.cucadiagram.LeafType;
import net.sourceforge.plantuml.cucadiagram.Link;
import net.sourceforge.plantuml.cucadiagram.LinkConstraint;
import net.sourceforge.plantuml.cucadiagram.Magma;
import net.sourceforge.plantuml.cucadiagram.MagmaList;
import net.sourceforge.plantuml.cucadiagram.PortionShower;
import net.sourceforge.plantuml.cucadiagram.Together;
import net.sourceforge.plantuml.cucadiagram.dot.CucaDiagramTxtMaker;
import net.sourceforge.plantuml.elk.CucaDiagramFileMakerElk;
import net.sourceforge.plantuml.graphic.USymbol;
import net.sourceforge.plantuml.graphml.CucaDiagramGraphmlMaker;
import net.sourceforge.plantuml.sdot.CucaDiagramFileMakerSmetana;
import net.sourceforge.plantuml.security.SecurityUtils;
import net.sourceforge.plantuml.skin.VisibilityModifier;
import net.sourceforge.plantuml.statediagram.StateDiagram;
import net.sourceforge.plantuml.style.ClockwiseTopRightBottomLeft;
import net.sourceforge.plantuml.svek.CucaDiagramFileMaker;
import net.sourceforge.plantuml.svek.CucaDiagramFileMakerSvek;
import net.sourceforge.plantuml.xmi.CucaDiagramXmiMaker;
import net.sourceforge.plantuml.xmlsc.StateDiagramScxmlMaker;
public abstract class CucaDiagram extends UmlDiagram implements GroupHierarchy, PortionShower, ICucaDiagram {
private String namespaceSeparator = null;
private boolean namespaceSeparatorHasBeenSet = false;
public final boolean mergeIntricated() {
return false;
}
private final List<HideOrShow2> hides2 = new ArrayList<>();
private final List<HideOrShow2> removed = new ArrayList<>();
protected final EntityFactory entityFactory = new EntityFactory(hides2, removed, this);
private List<Quark> stacks = new ArrayList<>();
private boolean visibilityModifierPresent;
// private NamespaceStrategy lastNamespaceStrategy;
private Together currentTogether;
public CucaDiagram(UmlSource source, UmlDiagramType type, Map<String, String> orig) {
super(source, type, orig);
this.stacks.add(entityFactory.getPlasma().root());
}
public String getPortFor(String entString, Quark ident) {
final int x = entString.lastIndexOf("::");
if (x == -1)
return null;
if (entString.startsWith(ident.getName()))
return entString.substring(x + 2);
return null;
}
public Quark currentQuark() {
return this.stacks.get(stacks.size() - 1);
}
public String cleanIdForQuark(String id) {
if (id == null)
return null;
return StringUtils.eventuallyRemoveStartingAndEndingDoubleQuote(id);
}
final public void setNamespaceSeparator(String namespaceSeparator) {
this.namespaceSeparatorHasBeenSet = true;
this.namespaceSeparator = namespaceSeparator;
getPlasma().setSeparator(namespaceSeparator);
}
final public String getNamespaceSeparator() {
if (namespaceSeparatorHasBeenSet == false)
return ".";
return namespaceSeparator;
}
@Override
public boolean hasUrl() {
for (Quark quark : getPlasma().quarks()) {
final EntityImp ent = (EntityImp) quark.getData();
if (ent != null && ent.hasUrl())
return true;
}
return false;
}
final public void setLastEntity(EntityImp foo) {
this.lastEntity = (EntityImp) foo;
}
protected void updateLasts(EntityImp result) {
}
final public EntityImp reallyCreateLeaf(Quark ident, Display display, LeafType type, USymbol symbol) {
Objects.requireNonNull(type);
if (ident.getData() != null)
throw new IllegalStateException();
if (Display.isNull(display))
throw new IllegalArgumentException();
final EntityImp result = entityFactory.createLeaf(ident, display, type, getHides());
result.setUSymbol(symbol);
ident.setData(result);
this.lastEntity = result;
result.setTogether(currentTogether);
updateLasts(result);
// if (type == LeafType.OBJECT)
// ((EntityImp) parent.getData()).muteToType2(type);
return result;
}
final public Quark quarkInContext(String full, boolean specialForCreateClass) {
final String sep = getNamespaceSeparator();
if (sep == null) {
final Quark result = getPlasma().getIfExistsFromName(full);
if (result != null)
return result;
return currentQuark().child(full);
}
final Quark currentQuark = currentQuark();
if (full.startsWith(sep))
return getPlasma().root().child(full.substring(sep.length()));
final int x = full.indexOf(sep);
if (x == -1) {
if (specialForCreateClass == false && getPlasma().countByName(full) == 1) {
final Quark byName = getPlasma().getIfExistsFromName(full);
assert byName != null;
if (byName != currentQuark)
return byName;
}
return currentQuark.child(full);
}
final String first = full.substring(0, x);
final boolean firstPackageDoesExist = getPlasma().root().childIfExists(first) != null;
if (firstPackageDoesExist)
return getPlasma().root().child(full);
return currentQuark.child(full);
}
public String removePortId(String id) {
// To be kept
if ("::".equals(namespaceSeparator))
return id;
final int x = id.lastIndexOf("::");
if (x == -1)
return id;
return id.substring(0, x);
}
public String getPortId(String id) {
// To be kept
if ("::".equals(namespaceSeparator))
return null;
final int x = id.lastIndexOf("::");
if (x == -1)
return null;
return id.substring(x + 2);
}
public /* protected */ Plasma getPlasma() {
return entityFactory.getPlasma();
}
final public Collection<EntityImp> getChildrenGroups(EntityImp parent) {
final Collection<EntityImp> result = new ArrayList<>();
final Quark parent__;
if (parent.instanceofGroupRoot())
parent__ = getPlasma().root();
else
parent__ = ((EntityImp) parent).getQuark();
for (EntityImp gg : getGroups(false))
if (gg.getQuark().getParent() == parent__)
result.add(gg);
return Collections.unmodifiableCollection(result);
}
private void eventuallyBuildPhantomGroups() {
for (Quark quark : getPlasma().quarks()) {
if (quark.getData() != null)
continue;
int countChildren = quark.countChildren();
if (countChildren > 0) {
final Display display = Display.getWithNewlines(quark.getQualifiedName());
final EntityImp result = entityFactory.createGroup(quark, display, GroupType.PACKAGE, getHides());
quark.setData(result);
}
}
}
final public CommandExecutionResult gotoTogether() {
if (currentTogether != null)
return CommandExecutionResult.error("Cannot nest together");
this.currentTogether = new Together();
return CommandExecutionResult.ok();
}
final public CommandExecutionResult gotoGroup(Quark ident, Display display, GroupType type) {
if (currentTogether != null)
return CommandExecutionResult.error("Cannot be done inside 'together'");
if (ident.getData() == null) {
final EntityImp result = entityFactory.createGroup(ident, display, type, getHides());
ident.setData(result);
}
final EntityImp ent = (EntityImp) ident.getData();
ent.setDisplay(display);
ent.muteToType2(type);
this.stacks.add(ident);
return CommandExecutionResult.ok();
}
public boolean endGroup() {
if (this.currentTogether != null) {
this.currentTogether = null;
return true;
}
if (stacks.size() > 0) {
stacks.remove(stacks.size() - 1);
return true;
}
return false;
}
public final EntityImp getCurrentGroup() {
return (EntityImp) currentQuark().getData();
}
public final EntityImp getGroup(String code) {
final Quark quark = getPlasma().getIfExistsFromName(code);
if (quark == null)
return null;
return (EntityImp) quark.getData();
}
public final boolean isGroup(String code) {
final Quark quark = getPlasma().getIfExistsFromName(code);
if (quark == null)
return false;
return isGroup(quark);
}
public final boolean isGroup(final Quark quark) {
final EntityImp ent = (EntityImp) quark.getData();
if (ent == null)
return false;
return ent.isGroup();
}
public final Collection<EntityImp> getGroups(boolean withRootGroup) {
final List<EntityImp> result = new ArrayList<>();
for (Quark quark : getPlasma().quarks()) {
if (quark.isRoot()) {
if (withRootGroup)
result.add((EntityImp) quark.getData());
} else {
final EntityImp data = (EntityImp) quark.getData();
if (data != null && data.isGroup())
result.add(data);
}
}
return Collections.unmodifiableCollection(result);
}
public EntityImp getRootGroup() {
return (EntityImp) getPlasma().root().getData();
}
public final Collection<EntityImp> getLeafsvalues() {
final List<EntityImp> result = new ArrayList<>();
for (Quark quark : getPlasma().quarks()) {
if (quark.isRoot())
continue;
final EntityImp data = (EntityImp) quark.getData();
if (data != null && data.isGroup() == false)
result.add(data);
}
return Collections.unmodifiableCollection(result);
}
public final int getLeafssize() {
return getLeafsvalues().size();
}
final public void addLink(Link link) {
entityFactory.addLink(link);
}
final protected void removeLink(Link link) {
entityFactory.removeLink(link);
}
final public List<Link> getLinks() {
return entityFactory.getLinks();
}
abstract protected List<String> getDotStrings();
final public String[] getDotStringSkek() {
final List<String> result = new ArrayList<>();
for (String s : getDotStrings())
if (s.startsWith("nodesep") || s.startsWith("ranksep") || s.startsWith("layout"))
result.add(s);
String aspect = getPragma().getValue("aspect");
if (aspect != null) {
aspect = aspect.replace(',', '.');
result.add("aspect=" + aspect + ";");
}
final String ratio = getPragma().getValue("ratio");
if (ratio != null)
result.add("ratio=" + ratio + ";");
return result.toArray(new String[result.size()]);
}
// ::comment when WASM
private void createFilesGraphml(OutputStream suggestedFile) throws IOException {
final CucaDiagramGraphmlMaker maker = new CucaDiagramGraphmlMaker(this);
maker.createFiles(suggestedFile);
}
private void createFilesXmi(OutputStream suggestedFile, FileFormat fileFormat) throws IOException {
final CucaDiagramXmiMaker maker = new CucaDiagramXmiMaker(this, fileFormat);
maker.createFiles(suggestedFile);
}
private void createFilesScxml(OutputStream suggestedFile) throws IOException {
final StateDiagramScxmlMaker maker = new StateDiagramScxmlMaker((StateDiagram) this);
maker.createFiles(suggestedFile);
}
private void createFilesTxt(OutputStream os, int index, FileFormat fileFormat) throws IOException {
final CucaDiagramTxtMaker maker = new CucaDiagramTxtMaker(this, fileFormat);
maker.createFiles(os, index);
}
// ::done
@Override
protected ImageData exportDiagramInternal(OutputStream os, int index, FileFormatOption fileFormatOption)
throws IOException {
final FileFormat fileFormat = fileFormatOption.getFileFormat();
// ::comment when WASM
if (fileFormat == FileFormat.ATXT || fileFormat == FileFormat.UTXT) {
try {
createFilesTxt(os, index, fileFormat);
} catch (Throwable t) {
t.printStackTrace(SecurityUtils.createPrintStream(os));
}
return ImageDataSimple.ok();
}
if (fileFormat == FileFormat.GRAPHML) {
createFilesGraphml(os);
return ImageDataSimple.ok();
}
if (fileFormat.name().startsWith("XMI")) {
createFilesXmi(os, fileFormat);
return ImageDataSimple.ok();
}
if (fileFormat == FileFormat.SCXML) {
createFilesScxml(os);
return ImageDataSimple.ok();
}
// ::done
if (getUmlDiagramType() == UmlDiagramType.COMPOSITE) {
throw new UnsupportedOperationException();
}
this.eventuallyBuildPhantomGroups();
final CucaDiagramFileMaker maker;
// ::comment when WASM
if (this.isUseElk())
maker = new CucaDiagramFileMakerElk(this, fileFormatOption.getDefaultStringBounder(getSkinParam()));
else if (this.isUseSmetana())
// ::done
maker = new CucaDiagramFileMakerSmetana(this, fileFormatOption.getDefaultStringBounder(getSkinParam()));
// ::comment when WASM
else
maker = new CucaDiagramFileMakerSvek(this);
// ::done
final ImageData result = maker.createFile(os, getDotStrings(), fileFormatOption);
if (result == null)
return ImageDataSimple.error();
this.warningOrError = result.getWarningOrError();
return result;
}
private String warningOrError;
@Override
public String getWarningOrError() {
final String generalWarningOrError = super.getWarningOrError();
if (warningOrError == null)
return generalWarningOrError;
if (generalWarningOrError == null)
return warningOrError;
return generalWarningOrError + BackSlash.NEWLINE + warningOrError;
}
public boolean isAutarkic(EntityImp g) {
if (g.getGroupType() == GroupType.PACKAGE)
return false;
if (g.getGroupType() == GroupType.INNER_ACTIVITY)
return true;
if (g.getGroupType() == GroupType.CONCURRENT_ACTIVITY)
return true;
if (g.getGroupType() == GroupType.CONCURRENT_STATE)
return true;
if (getChildrenGroups(g).size() > 0)
return false;
for (Link link : getLinks())
if (EntityUtils.isPureInnerLink3(g, link) == false)
return false;
for (EntityImp leaf : g.getLeafsDirect())
if (leaf.getEntityPosition() != EntityPosition.NORMAL)
return false;
return true;
}
private static boolean isNumber(String s) {
return s.matches("[+-]?(\\.?\\d+|\\d+\\.\\d*)");
}
public void resetPragmaLabel() {
getPragma().undefine("labeldistance");
getPragma().undefine("labelangle");
}
public String getLabeldistance() {
if (getPragma().isDefine("labeldistance")) {
final String s = getPragma().getValue("labeldistance");
if (isNumber(s))
return s;
}
if (getPragma().isDefine("defaultlabeldistance")) {
final String s = getPragma().getValue("defaultlabeldistance");
if (isNumber(s))
return s;
}
// Default in dot 1.0
return "1.7";
}
public String getLabelangle() {
if (getPragma().isDefine("labelangle")) {
final String s = getPragma().getValue("labelangle");
if (isNumber(s))
return s;
}
if (getPragma().isDefine("defaultlabelangle")) {
final String s = getPragma().getValue("defaultlabelangle");
if (isNumber(s))
return s;
}
// Default in dot -25
return "25";
}
final public boolean isEmpty(EntityImp gToTest) {
for (EntityImp gg : getGroups(false)) {
if (gg == gToTest)
continue;
if (gg.getParentContainer() == gToTest)
return false;
}
return gToTest.size() == 0;
}
public final boolean isVisibilityModifierPresent() {
return visibilityModifierPresent;
}
public final void setVisibilityModifierPresent(boolean visibilityModifierPresent) {
this.visibilityModifierPresent = visibilityModifierPresent;
}
public final boolean showPortion(EntityPortion portion, EntityImp entity) {
if (getSkinParam().strictUmlStyle() && portion == EntityPortion.CIRCLED_CHARACTER)
return false;
boolean result = true;
for (HideOrShow cmd : hideOrShows)
if (cmd.portion == portion && cmd.gender.contains(entity))
result = cmd.show;
return result;
}
public final void hideOrShow(EntityGender gender, EntityPortion portions, boolean show) {
for (EntityPortion portion : portions.asSet())
this.hideOrShows.add(new HideOrShow(gender, portion, show));
}
public void hideOrShow(Set<VisibilityModifier> visibilities, boolean show) {
if (show)
hides.removeAll(visibilities);
else
hides.addAll(visibilities);
}
public void hideOrShow2(String what, boolean show) {
this.hides2.add(new HideOrShow2(what, show));
}
public void removeOrRestore(String what, boolean show) {
this.removed.add(new HideOrShow2(what, show));
}
private final List<HideOrShow> hideOrShows = new ArrayList<>();
private final Set<VisibilityModifier> hides = new HashSet<>();
static class HideOrShow {
private final EntityGender gender;
private final EntityPortion portion;
private final boolean show;
public HideOrShow(EntityGender gender, EntityPortion portion, boolean show) {
this.gender = gender;
this.portion = portion;
this.show = show;
}
}
public final Set<VisibilityModifier> getHides() {
return Collections.unmodifiableSet(hides);
}
final public boolean isStandalone(EntityImp ent) {
for (final Link link : getLinks())
if (link.getEntity1() == ent || link.getEntity2() == ent)
return false;
return true;
}
final public boolean isStandaloneForArgo(EntityImp ent) {
for (final Link link : getLinks()) {
if (link.isHidden() || link.isInvis())
continue;
if (link.getEntity1() == ent || link.getEntity2() == ent)
return false;
}
return true;
}
final public Link getLastLink() {
final List<Link> links = getLinks();
for (int i = links.size() - 1; i >= 0; i--) {
final Link link = links.get(i);
if (link.getEntity1().getLeafType() != LeafType.NOTE && link.getEntity2().getLeafType() != LeafType.NOTE)
return link;
}
return null;
}
final public List<Link> getTwoLastLinks() {
final List<Link> result = new ArrayList<>();
final List<Link> links = getLinks();
for (int i = links.size() - 1; i >= 0; i--) {
final Link link = links.get(i);
if (link.getEntity1().getLeafType() != LeafType.NOTE && link.getEntity2().getLeafType() != LeafType.NOTE) {
result.add(link);
if (result.size() == 2)
return Collections.unmodifiableList(result);
}
}
return null;
}
protected EntityImp lastEntity = null;
final public EntityImp getLastEntity() {
return lastEntity;
}
final public EntityFactory getEntityFactory() {
// throw new UnsupportedOperationException();
return entityFactory;
}
public void applySingleStrategy() {
final MagmaList magmaList = new MagmaList();
for (EntityImp g : getGroups(true)) {
final List<EntityImp> standalones = new ArrayList<>();
for (EntityImp ent : g.getLeafsDirect())
if (isStandalone(ent))
standalones.add(ent);
if (standalones.size() < 3)
continue;
final Magma magma = new Magma(this, standalones);
magma.putInSquare();
magmaList.add(magma);
}
for (EntityImp g : getGroups(true)) {
final MagmaList magmas = magmaList.getMagmas(g);
if (magmas.size() < 3)
continue;
magmas.putInSquare();
}
}
public boolean isHideEmptyDescriptionForState() {
return false;
}
protected void incRawLayout() {
entityFactory.incRawLayout();
}
public CommandExecutionResult constraintOnLinks(Link link1, Link link2, Display display) {
final LinkConstraint linkConstraint = new LinkConstraint(link1, link2, display);
link1.setLinkConstraint(linkConstraint);
link2.setLinkConstraint(linkConstraint);
return CommandExecutionResult.ok();
}
@Override
public ClockwiseTopRightBottomLeft getDefaultMargins() {
// Strange numbers here for backwards compatibility
return ClockwiseTopRightBottomLeft.topRightBottomLeft(0, 5, 5, 0);
}
private final AtomicInteger cpt = new AtomicInteger(1);
public int getUniqueSequence() {
return cpt.addAndGet(1);
}
public String getUniqueSequence(String prefix) {
return prefix + getUniqueSequence();
}
}