net.sourceforge.plantuml.yaml.YamlLines Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of plantuml-mit Show documentation
Show all versions of plantuml-mit Show documentation
PlantUML is a component that allows to quickly write diagrams from text.
// THIS FILE HAS BEEN GENERATED BY A PREPROCESSOR.
/* +=======================================================================
* |
* | 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/liberapay (only 1€ per month!)
* https://plantuml.com/paypal
*
*
* PlantUML is free software; you can redistribute it and/or modify it
* under the terms of the MIT License.
*
* See http://opensource.org/licenses/MIT
*
* Permission is hereby granted, free of charge, to any person obtaining
* a copy of this software and associated documentation files (the "Software"),
* to deal in the Software without restriction, including without limitation
* the rights to use, copy, modify, merge, publish, distribute, sublicense,
* and/or sell copies of the Software, and to permit persons to whom the
* Software is furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included
* in all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
* OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
* WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR
* IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*
* PlantUML can occasionally display sponsored or advertising messages. Those
* messages are usually generated on welcome or error images and never on
* functional diagrams.
* See https://plantuml.com/professional if you want to remove them
*
* Images (whatever their format : PNG, SVG, EPS...) generated by running PlantUML
* are owned by the author of their corresponding sources code (that is, their
* textual description in PlantUML language). Those images are not covered by
* this MIT license.
*
* The generated images can then be used without any reference to the MIT license.
* It is not even necessary to stipulate that they have been generated with PlantUML,
* although this will be appreciated by the PlantUML team.
*
* There is an exception : if the textual description in PlantUML language is also covered
* by any license, then the generated images are logically covered
* by the very same license.
*
* This is the IGY distribution (Install GraphViz by Yourself).
* You have to install GraphViz and to setup the GRAPHVIZ_DOT environment variable
* (see https://plantuml.com/graphviz-dot )
*
* Icons provided by OpenIconic : https://useiconic.com/open
* Archimate sprites provided by Archi : http://www.archimatetool.com
* Stdlib AWS provided by https://github.com/milo-minderbinder/AWS-PlantUML
* Stdlib Icons provided https://github.com/tupadr3/plantuml-icon-font-sprites
* ASCIIMathML (c) Peter Jipsen http://www.chapman.edu/~jipsen
* ASCIIMathML (c) David Lippman http://www.pierce.ctc.edu/dlippman
* CafeUndZopfli ported by Eugene Klyuchnikov https://github.com/eustas/CafeUndZopfli
* Brotli (c) by the Brotli Authors https://github.com/google/brotli
* Themes (c) by Brett Schwarz https://github.com/bschwarz/puml-themes
* Twemoji (c) by Twitter at https://twemoji.twitter.com/
*
*/
package net.sourceforge.plantuml.yaml;
import java.util.ArrayList;
import java.util.Collections;
import java.util.Iterator;
import java.util.List;
import java.util.ListIterator;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
public class YamlLines implements Iterable {
public static final String KEY = "([^:]+)";
private List lines = new ArrayList<>();
public YamlLines(List rawLines) {
for (String s : rawLines) {
if (s.startsWith("#"))
continue;
s = removeDiese(s);
if (s.trim().length() == 0)
continue;
lines.add(s);
}
mergeMultiline();
manageSpaceTwoPoints();
manageList();
final int startingEmptyCols = startingEmptyCols();
removeFirstCols(startingEmptyCols);
}
private void manageSpaceTwoPoints() {
for (ListIterator it = lines.listIterator(); it.hasNext();) {
String s = it.next();
if (s.contains("\"") == false && s.contains("'") == false && s.contains(":")
&& s.indexOf(':') == s.lastIndexOf(':') && s.contains(": ") == false) {
s = s.replace(":", ": ");
it.set(s);
}
}
}
private String removeDiese(String s) {
final int idx = s.indexOf(" #");
if (idx == -1)
return s;
return s.substring(0, idx);
}
private void manageList() {
final List result = new ArrayList<>();
for (String s : lines) {
final Pattern p1 = Pattern.compile("^(\\s*[-])(\\s*\\S.*)$");
final Matcher m1 = p1.matcher(s);
if (s.contains(": ") && m1.matches()) {
result.add(m1.group(1));
result.add(s.replaceFirst("[-]", " "));
} else if (m1.matches()) {
result.add(" " + s);
} else {
result.add(s);
}
}
this.lines = result;
}
private void removeFirstCols(int startingEmptyCols) {
if (startingEmptyCols == 0)
return;
for (ListIterator it = lines.listIterator(); it.hasNext();) {
final String s = it.next().substring(startingEmptyCols);
it.set(s);
}
}
private int startingEmptyCols() {
int result = Integer.MAX_VALUE;
for (String s : lines) {
result = Math.min(result, startingSpaces(s));
if (result == 0)
return 0;
}
return result;
}
private static int startingSpaces(String s) {
final Pattern p1 = Pattern.compile("^(\\s*).*");
final Matcher m1 = p1.matcher(s);
if (m1.matches())
return m1.group(1).length();
return 0;
}
private void mergeMultiline() {
final List result = new ArrayList<>();
for (int i = 0; i < lines.size(); i++) {
final String init = isMultilineStart(i);
if (init != null) {
final StringBuilder sb = new StringBuilder(init);
while (i + 1 < lines.size() && textOnly(lines.get(i + 1))) {
sb.append(" " + lines.get(i + 1).trim());
i++;
}
result.add(sb.toString());
} else {
result.add(lines.get(i));
}
}
this.lines = result;
}
private String isMultilineStart(int i) {
if (nameOnly(lines.get(i)) != null && textOnly(lines.get(i + 1))) {
final int idx = lines.get(i).indexOf(':');
return lines.get(i).substring(0, idx + 1);
}
return null;
}
public static String nameOnly(String s) {
final Pattern p1 = Pattern.compile("^\\s*" + KEY + "\\s*:\\s*[|>]?\\s*$");
final Matcher m1 = p1.matcher(s);
if (m1.matches()) {
final String name = m1.group(1);
return name;
}
return null;
}
private boolean textOnly(String s) {
if (isList(s))
return false;
return s.indexOf(':') == -1;
}
private boolean isList(String s) {
return s.trim().startsWith("-");
}
public Iterator iterator() {
return Collections.unmodifiableList(lines).iterator();
}
}