net.sourceforge.plantuml.html.CucaDiagramHtmlMaker 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
PlantUML is a component that allows to quickly write diagrams from text.
There is a newer version: 1.2024.8
// 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.html;

import java.io.IOException;
import java.io.PrintWriter;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.List;

import net.atmp.CucaDiagram;
import net.sourceforge.plantuml.FileImageData;
import net.sourceforge.plantuml.StringUtils;
import net.sourceforge.plantuml.abel.Entity;
import net.sourceforge.plantuml.abel.LeafType;
import net.sourceforge.plantuml.abel.Link;
import net.sourceforge.plantuml.security.SFile;
import net.sourceforge.plantuml.stereo.Stereotype;

public final class CucaDiagramHtmlMaker {
	// ::remove folder when __CORE__

	private final CucaDiagram diagram;
	private final SFile dir;

	public CucaDiagramHtmlMaker(CucaDiagram diagram, SFile dir) {
		this.diagram = diagram;
		this.dir = dir;
	}

	public List create() throws IOException {
		dir.mkdirs();
		if (dir.exists() == false)
			throw new IOException("Cannot create " + dir);

		final SFile f = dir.file("index.html");
		final PrintWriter pw = f.createPrintWriter();
		pw.println("");
		printAllType(pw, LeafType.ENUM);
		printAllType(pw, LeafType.INTERFACE);
		printAllType(pw, LeafType.ANNOTATION);
		printAllType(pw, LeafType.ABSTRACT_CLASS);
		printAllType(pw, LeafType.CLASS);
		htmlClose(pw);
		return Arrays.asList(new FileImageData(dir, null));
	}

	private void printAllType(final PrintWriter pw, LeafType type) throws IOException {
		if (hasSome(type)) {
			pw.println("" + type.toHtml() + "");
			for (final Entity ent : diagram.leafs()) {
				if (ent.getLeafType() != type)
					continue;

				export(ent);
				pw.println("");
				pw.println(LinkHtmlPrinter.htmlLink(ent));
				pw.println("");
			}
			// for (Map.Entry ent : new TreeMap(diagram.getLeafs()).entrySet()) {
			// if (ent.getValue().getEntityType() != type) {
			// continue;
			// }
			// export(ent.getValue());
			// pw.println("");
			// pw.println(LinkHtmlPrinter.htmlLink(ent.getValue()));
			// pw.println("");
			// }
		}
	}

	private boolean hasSome(final LeafType type) {
		for (Entity ent : diagram.leafs())
			if (ent.getLeafType() == type)
				return true;

		return false;
	}

	private void export(Entity entity) throws IOException {
		final SFile f = dir.file(LinkHtmlPrinter.urlOf(entity));
		final PrintWriter pw = f.createPrintWriter();
		pw.println("");
		pw.println("" + StringUtils.unicodeForHtml(entity.getName()) + "");
		pw.println("" + entity.getLeafType().toHtml() + "");
		for (CharSequence s : entity.getDisplay()) {
			pw.println(StringUtils.unicodeForHtml(s.toString()));
			pw.println("
");
		}
		final Stereotype stereotype = entity.getStereotype();
		if (stereotype != null) {
			pw.println("");
			pw.println("Stereotype");
			for (String s : stereotype.getLabels(diagram.getSkinParam().guillemet())) {
				pw.println(s);
				pw.println("
");
			}
		}

		pw.println("");
		if (entity.getBodier().getFieldsToDisplay().size() == 0) {
			pw.println("No fields");
		} else {
			pw.println("Fields:");
			pw.println("");
			for (CharSequence m : entity.getBodier().getFieldsToDisplay()) {
				pw.println("");
				pw.println(StringUtils.unicodeForHtml(m.toString()));
				pw.println("");
			}
			pw.println("");
		}

		pw.println("");
		if (entity.getBodier().getMethodsToDisplay().size() == 0) {
			pw.println("No methods");
		} else {
			pw.println("Methods:");
			pw.println("");
			for (CharSequence m : entity.getBodier().getMethodsToDisplay()) {
				pw.println("");
				pw.println(StringUtils.unicodeForHtml(m.toString()));
				pw.println("");
			}
			pw.println("");
		}

		pw.println("");
		final Collection links = getLinksButNotes(entity);
		if (links.size() == 0) {
			pw.println("No links");
		} else {
			pw.println("Links:");
			pw.println("");
			for (Link l : links) {
				pw.println("");
				new LinkHtmlPrinter(l, entity).printLink(pw);
				pw.println("");
			}
			pw.println("");
		}

		final Collection notes = getNotes(entity);
		if (notes.size() > 0) {
			pw.println("");
			pw.println("Notes:");
			pw.println("");
			for (Entity note : notes) {
				pw.println("");
				for (CharSequence s : note.getDisplay()) {
					pw.println(StringUtils.unicodeForHtml(s.toString()));
					pw.println("
");
				}
				pw.println("");
			}
			pw.println("");

		}

		htmlClose(pw);
	}

	private void htmlClose(final PrintWriter pw) {
		pw.println("");
		pw.println("Back to index");
		pw.println("");
		pw.close();
	}

	private Collection getNotes(Entity ent) {
		final List result = new ArrayList<>();
		for (Link link : diagram.getLinks()) {
			if (link.contains(ent) == false)
				continue;

			if (link.getEntity1().getLeafType() == LeafType.NOTE || link.getEntity2().getLeafType() == LeafType.NOTE)
				result.add(link.getOther(ent));

		}
		return Collections.unmodifiableList(result);
	}

	private Collection getLinksButNotes(Entity ent) {
		final List result = new ArrayList<>();
		for (Link link : diagram.getLinks()) {
			if (link.contains(ent) == false)
				continue;

			if (link.getEntity1().getLeafType() == LeafType.NOTE || link.getEntity2().getLeafType() == LeafType.NOTE)
				continue;

			result.add(link);
		}
		return Collections.unmodifiableList(result);
	}
}