diff options
| author | Ralph Amissah <ralph.amissah@gmail.com> | 2026-09-24 16:33:53 -0400 |
|---|---|---|
| committer | Ralph Amissah <ralph.amissah@gmail.com> | 2026-09-24 16:33:53 -0400 |
| commit | bbe505c8d48e822c012c9820dfe93b83dc61bcab (patch) | |
| tree | 3385f5420959ff20af295c3125a080297555a72b /src/main.d | |
| parent | dealing with six properties including .is_of_type (diff) | |
--validate, and a second reader, in Gleam
--validate: the specification, executed. A validator written from
ssp-format-specification.md and from nothing else, so that a file can
be held against the document rather than against an implementation.
Each finding names the specification section it comes from, so a
disagreement can be taken back to the text.
It checks the version banner and its major part, the file shape and
the order of the preamble blocks and the nine sections, the two
spaces of a preamble pair, the object declaration and its sixteen
kinds and eight heading levels, that a property is one of the 42 and
in the emitted order, that text lines carry their prefix, the ten
keys of doc_has, and that no line is of a shape the specification
does not define.
Every .ssp of the markup document samples validates clean. Five
classes of deliberate breakage are caught: an unknown major version, a
property that is not one of the 42, a property out of order, a kind
that is not one of the sixteen, and a block that is neither preamble
nor section. Writing it found two rules the specification implied
and did not state (repeated properties are consecutive; no property
follows the text), and both were written into it.
One repository, a reader per language. The readers are not separate
tools that share a name. They are the same specification implemented
more than once, and the interesting thing about them is that they
agree, so they are published as one thing with that claim at the top
of it. The D reader moves to dlang/; the Gleam reader arrives at
gleam/. The language directory is named for the language and not
for the tool: gleam refuses a hyphenated package name, so ssp-reader
cannot be a gleam package and must be ssp_reader.
A .gitignore for the repository, denying everything and whitelisting
what belongs, covering both languages.
Both build under nix, sandboxed and without network. There is no gleam
builder in nixpkgs and gleam build fetches from Hex, so the Gleam build
uses nix-gleam's builder, kept in gleam/nix-gleam/ (MIT), which fetches
each Hex package by the checksum manifest.toml already carries, with no
hash to maintain; the result is an escript wrapped with erlang. The D
reader depends on nothing beyond phobos, so --skip-registry=all is the
whole of what it takes: ldc by default, dmd available as ssp-reader-dmd
(given gcc14, GCC 15 having introduced nullptr in headers dmd's ImportC
does not yet parse).
(assisted by Claude-Code)
Diffstat (limited to 'src/main.d')
| -rw-r--r-- | src/main.d | 148 |
1 files changed, 0 insertions, 148 deletions
diff --git a/src/main.d b/src/main.d deleted file mode 100644 index 78ceb69..0000000 --- a/src/main.d +++ /dev/null @@ -1,148 +0,0 @@ -import std.getopt; -import std.stdio : writeln, stderr; -import ssp_parser; -import ssp_types; -import output_tree; -import output_html; -import output_llm_breadcrumbs; -import output_llm_jsonl; -import output_images; -import verify_images; -import report_unknown; - -int main(string[] args) { - bool do_tree = false; - bool do_html = false; - bool do_llm_text = false; - bool do_llm_jsonl = false; - bool do_images = false; - bool do_verify = false; - bool do_report_unknown = false; - bool any_version = false; - string image_dir = ""; - string output_file = ""; - - auto helpInfo = getopt(args, - "tree", "output document tree outline", &do_tree, - "html", "output HTML scroll", &do_html, - "llm-text", "output plain text with heading breadcrumbs", &do_llm_text, - "llm-jsonl", "output JSONL with embeddings-ready chunks", &do_llm_jsonl, - "images", "output image manifest (digest, size, pixels)", &do_images, - "verify", "verify .image records against --image-dir", &do_verify, - "image-dir", "image directory to verify against", &image_dir, - "output", "output file (default: stdout)", &output_file, - "report-unknown", "list what was read and not understood", &do_report_unknown, - "any-version", "read a format major version this reader does not know", &any_version, - ); - - if (helpInfo.helpWanted || args.length < 2) { - defaultGetoptPrinter( - "ssp-reader - reads .ssp files and produces output\n\n" - ~ "Usage: ssp-reader [options] <file.ssp>\n", - helpInfo.options, - ); - return 0; - } - - string input_file = args[1]; - - SspDocument doc; - try { - doc = parseSspFile(input_file); - } catch (Exception e) { - stderr.writeln("Error reading ", input_file, ": ", e.msg); - return 2; - } - - /+ ↓ the version gate. A reader checks the major part and refuses what it - does not know: an unknown major means a property may have changed - meaning or gone away, and loading it half populated in silence is the - failure this exists to prevent. --any-version overrides, for looking - at a file rather than trusting one. - +/ - if (doc.format_version.length == 0) { - stderr.writeln("warning: ", input_file, - " declares no format version (no \"% SiSU Document Abstraction v\" line)"); - } else if (doc.formatVersionMajor != ssp_format_major_read) { - if (any_version) { - stderr.writeln("warning: ", input_file, " is format v", doc.format_version, - ", this reader knows v", ssp_format_major_read, ".x; reading anyway"); - } else { - stderr.writeln("error: ", input_file, " is format v", doc.format_version, - ", this reader knows v", ssp_format_major_read, ".x"); - stderr.writeln(" a major version differs: a property may have", - " changed meaning or gone away."); - stderr.writeln(" --any-version reads it regardless."); - return 3; - } - } - - writeln("Parsed: ", input_file); - if (doc.format_version.length > 0) { - writeln(" Format: v", doc.format_version); - } - if (auto _lang = "language" in doc.source) { - writeln(" Source: ", *_lang, - ("languages" in doc.source) ? " of " ~ doc.source["languages"] : "", - ("digest" in doc.source) ? ", markup digest " ~ doc.source["digest"][0 .. 16] ~ "..." : ""); - } - writeln(" Title: ", doc.meta("title.main")); - writeln(" Author: ", doc.meta("creator.author")); - writeln(" Sections: head=", doc.head.length, - " toc=", doc.toc.length, - " body=", doc.body.length, - " endnotes=", doc.endnotes.length, - " glossary=", doc.glossary.length, - " bibliography=", doc.bibliography.length, - " bookindex=", doc.bookindex.length, - " blurb=", doc.blurb.length, - " tail=", doc.tail.length); - auto image_records = imageRecordCount(doc); - if (image_records > 0) { - writeln(" Images: ", image_records, " record", - (image_records == 1) ? "" : "s"); - } - - if (do_tree) { - outputTree(doc, output_file); - } - - if (do_html) { - outputHtmlScroll(doc, output_file); - } - - if (do_llm_text) { - outputLlmBreadcrumbs(doc, output_file); - } - - if (do_llm_jsonl) { - outputLlmJsonl(doc, output_file); - } - - if (do_images) { - outputImages(doc, output_file); - } - - - int _verify_failures = 0; - if (do_verify) { - if (image_dir.length == 0) { - stderr.writeln("--verify needs --image-dir=<path to the pod's media/image>"); - return 2; - } - _verify_failures = verifyImages(doc, image_dir, output_file); - } - - if (do_report_unknown) { - reportUnknown(doc); - } - - if (!do_tree && !do_html && !do_llm_text && !do_llm_jsonl && !do_images - && !do_verify && !do_report_unknown) { - writeln("\nUse --tree, --html, --llm-text, --llm-jsonl, --images," - ~ " --verify --image-dir=<dir>" - ~ " or --report-unknown to produce output."); - } - - return (_verify_failures > 0) ? 1 : 0; -} |
