Skip to content

Bring the free canvas fragments onto one shape #96

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ctgnz merged 5 commits into from
Sep 24, 2026
Merged

Bring the free canvas fragments onto one shape #96

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
3f41964
Normalise the free canvas fragments edited in Inkscape
ctgnz Sep 24, 2026
12ab454
Bring the free canvas fragments onto one shape (#78)
ctgnz Sep 24, 2026
a59ee8e
Call 25200600's grey backdrop an example, not a template (#78)
ctgnz Sep 24, 2026
2af52eb
Write down the free canvas composition rule (#78)
ctgnz Sep 24, 2026
b452818
Fail the build when a free canvas fragment is off its shape (#78)
ctgnz Sep 24, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 29 additions & 3 deletions jmsfx-generator/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -115,9 +115,19 @@
</configuration>
</plugin>
<!--
Checks that the SVG fragments are still normalised, and fails naming the files if not,
the way Spotless does for Java. It reports only and never writes; the normaliser's apply
mode is the fix, and the failure message spells out the command.
Two checks over the SVG fragments, both of which report only and never write, and both
of which fail naming the files, the way Spotless does for Java.

The first checks they are still normalised. The normaliser's apply mode is the fix, and
the failure message spells out the command.

The second checks the free canvas fragments still hold the shape described in
svg/README.md - one main group, an optional template, any number of examples - because
injecting fragments into the generated classes needs a rule for "which element is the
content" and that is the rule. A fragment drifts off it easily: an editor leaves a group
anonymous, or a new icon arrives with its content loose at the root. Catching that here
costs nothing; catching it during injection means finding construction scaffolding
rendered as though it were the drawing.

Bound to verify rather than written as a test, so skipping tests cannot skip it, and at
verify for the same reason Spotless is there: late enough not to slow the inner loop,
Expand Down Expand Up @@ -151,6 +161,22 @@
</arguments>
</configuration>
</execution>
<execution>
<id>check-fragment-shape</id>
<phase>verify</phase>
<goals>
<goal>java</goal>
</goals>
<configuration>
<mainClass>io.github.ctgnz.jmsfx.generator.FragmentShapeChecker</mainClass>
<arguments>
<argument>--dir</argument>
<argument>${project.basedir}/../jmsfx-standard/src/main/resources/svg</argument>
<argument>--model</argument>
<argument>/model-standard.yml</argument>
</arguments>
</configuration>
</execution>
</executions>
</plugin>
</plugins>
Expand Down
82 changes: 13 additions & 69 deletions jmsfx-generator/src/main/java/io/github/ctgnz/jmsfx/generator/FragmentMeasurer.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,16 +23,11 @@
import io.github.ctgnz.jmsfx.generator.model.AmplifierListModel;
import io.github.ctgnz.jmsfx.generator.model.BoundsModel;
import io.github.ctgnz.jmsfx.generator.model.DimensionModel;
import io.github.ctgnz.jmsfx.generator.model.EntityModel;
import io.github.ctgnz.jmsfx.generator.model.EntitySubTypeModel;
import io.github.ctgnz.jmsfx.generator.model.EntityTypeModel;
import io.github.ctgnz.jmsfx.generator.model.GraphicType;
import io.github.ctgnz.jmsfx.generator.model.HqtfDummyModel;
import io.github.ctgnz.jmsfx.generator.model.LibraryModel;
import io.github.ctgnz.jmsfx.generator.model.StandardIdentityGroupModel;
import io.github.ctgnz.jmsfx.generator.model.StandardIdentityModel;
import io.github.ctgnz.jmsfx.generator.model.StatusModel;
import io.github.ctgnz.jmsfx.generator.model.SymbolSetModel;
import io.github.ctgnz.jmsfx.generator.yaml.JmsfxParser;

/**
Expand Down Expand Up @@ -251,55 +246,27 @@ private void measureFrames(LibraryModel model) throws InterruptedException {
}

/**
* Main icons that carry {@code FREE_CANVAS}, at {@code /svg/Appendices/{graphicLocation}/{graphicIdentifier}.svg}.
* The extent of every {@code FREE_CANVAS} main icon, which is the only kind that has to be measured.
* <p>
* Every other main icon's extent follows from its graphic type - the octagon, or the frame for a {@code FULL_FRAME} one - so only these need measuring. APP-6E 8.1.3 exempts
* Control Measures from the composition rules, and a few Cyberspace path and terrain graphics are the same kind of thing.
* <p>
* The identifier is derived the same three ways {@code MainElement.getGraphicIdentifier()} derives it. jmsfx#52 is a caution against duplicating that kind of derivation, so
* every derived path is checked against the disk and anything missing is reported rather than quietly skipped.
* Every other main icon's extent follows from its graphic type - the octagon, or the frame for a {@code FULL_FRAME} one - so only these need a number recorded. Which icons
* those are, and which fragment each draws, is {@link FreeCanvasIcons}. A fragment that resolves nowhere is reported rather than quietly skipped, because the identifier is
* derived rather than read, so a path going nowhere means either the derivation or the model is wrong. See jmsfx#52.
*/
private void measureIcons(LibraryModel model) throws Exception {
Map<String, BoundsModel> measured = new TreeMap<>();
List<String> missing = new ArrayList<>();
int free = 0;
for (SymbolSetModel symbolSet : model.getSymbolSets()) {
Map<String, String> identifiers = new LinkedHashMap<>();
for (EntityModel entity : symbolSet.getEntities()) {
if (entity.getGraphicType() == GraphicType.FREE_CANVAS) {
identifiers.put(baseCode(model, symbolSet, entity) + entity.getCode() + "0000", entity.getLabel());
}
}
for (EntityTypeModel entityType : symbolSet.getEntityTypes()) {
if (entityType.getGraphicType() == GraphicType.FREE_CANVAS) {
EntityModel entity = entityType.getEntity();
String identifier = entityType.getGraphic() != null ? entityType.getGraphic()
: baseCode(model, symbolSet, entity) + entity.getCode() + entityType.getCode() + "00";
identifiers.put(identifier, entityType.getLabel());
}
}
for (EntitySubTypeModel subType : symbolSet.getEntitySubTypes()) {
if (subType.getGraphicType() == GraphicType.FREE_CANVAS) {
EntityTypeModel entityType = subType.getEntityType();
EntityModel entity = entityType.getEntity();
String identifier = subType.getGraphic() != null ? subType.getGraphic()
: baseCode(model, symbolSet, entity) + entity.getCode() + entityType.getCode() + subType.getCode();
identifiers.put(identifier, subType.getLabel());
}
}
for (Map.Entry<String, String> entry : identifiers.entrySet()) {
free++;
Path file = svg("Appendices", graphicLocation(model, symbolSet) + "/" + entry.getKey() + ".svg");
Bounds bounds = boundsOf(file);
if (bounds == null) {
missing.add(String.format("%s / %s (%s)", symbolSet.getLabel(), entry.getValue(), entry.getKey()));
continue;
}
measured.put(entry.getKey(), rectangle(bounds));
List<FreeCanvasIcons.Icon> icons = FreeCanvasIcons.collect(model, config.getResourceDir()
.resolve("svg"));
for (FreeCanvasIcons.Icon icon : icons) {
Bounds bounds = boundsOf(icon.fragment());
if (bounds == null) {
missing.add(String.format("%s / %s (%s)", icon.symbolSet(), icon.label(), icon.identifier()));
continue;
}
measured.put(icon.identifier(), rectangle(bounds));
}
model.setIconBounds(measured.isEmpty() ? null : measured);
System.out.format(" %-24s %d free-canvas icons, %d measured, %d unreadable or absent%n", "main icons", free, measured.size(), missing.size());
System.out.format(" %-24s %d free-canvas icons, %d measured, %d unreadable or absent%n", "main icons", icons.size(), measured.size(), missing.size());
missing.forEach(name -> System.out.format(" no fragment for %s%n", name));
}

Expand Down Expand Up @@ -373,20 +340,6 @@ private Path svg(String directory, String fileName) {
.resolve(fileName);
}

/** The symbol set an element's fragment is filed under, which is its own unless the entity borrows another set's numbering. */
private String baseCode(LibraryModel model, SymbolSetModel symbolSet, EntityModel entity) {
if (entity.getBaseSymbolSet() == null) {
return symbolSet.getCode();
}
return model.getSymbolSets()
.stream()
.filter(candidate -> entity.getBaseSymbolSet()
.equals(candidate.getId()))
.findFirst()
.map(SymbolSetModel::getCode)
.orElse(symbolSet.getCode());
}

/** Measured bounds for a fragment, or null when the file is absent or draws nothing. */
private Bounds boundsOf(Path file) throws InterruptedException {
if (!Files.exists(file)) {
Expand All @@ -413,15 +366,6 @@ private Path fragmentFor(AmplifierListModel list, AmplifierListItemModel item, S
.resolve(name);
}

/** Where a symbol set's fragments live, which falls back to the dimension's directory when the set does not name its own - as {@code SymbolSetEnum} does. */
private String graphicLocation(LibraryModel model, SymbolSetModel symbolSet) {
if (symbolSet.getGraphicLocation() != null) {
return symbolSet.getGraphicLocation();
}
DimensionModel dimension = model.getDimension(symbolSet.getDimensionId());
return dimension == null ? null : dimension.getGraphicLocation();
}

private Bounds measureFile(Path file) {
// parseFile(File), not parseFile(String) - the String overload resolves against the classpath,
// and the fragments live in another module's source tree. Every overload swallows failures and
Expand Down
Loading
Loading