summaryrefslogtreecommitdiffhomepage
path: root/dlang/src/read/validate.d
blob: 8a2cc4d24a4099800d01229a9e1eff5e6f2cc70b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
/+
- Name: SisuDoc Spine, Doc Reform [a part of]
  - Description: documents, structuring, processing, publishing, search
    - static content generator

  - Author: Ralph Amissah
    [ralph.amissah@gmail.com]

  - Copyright: (C) 2015 (continuously updated, current 2026) Ralph Amissah, All Rights Reserved.

  - License: AGPL 3 or later:

    Spine (SiSU), a framework for document structuring, publishing and
    search

    Copyright (C) Ralph Amissah

    This program is free software: you can redistribute it and/or modify it
    under the terms of the GNU AFERO General Public License as published by the
    Free Software Foundation, either version 3 of the License, or (at your
    option) any later version.

    This program is 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 program. If not, see [https://www.gnu.org/licenses/].

    If you have Internet connection, the latest version of the AGPL should be
    available at these locations:
    [https://www.fsf.org/licensing/licenses/agpl.html]
    [https://www.gnu.org/licenses/agpl.html]

  - Spine (by Doc Reform, related to SiSU) uses standard:
    - docReform markup syntax
      - standard SiSU markup syntax with modified headers and minor modifications
    - docReform object numbering
      - standard SiSU object citation numbering & system

  - Homepages:
    [https://www.sisudoc.org]
    [https://www.doc-reform.org]

  - Git
    [https://git.sisudoc.org/]

+/
module read.validate;

/+ ↓ check a .ssp against the format specification.
     .
     Written from specs/sisudoc-abstraction-format/ssp-format-specification.md
     and from nothing else: the point of it is to be what the specification
     says, executed, so that a file can be held against the document rather
     than against an implementation. Each check names the section it comes
     from, so a disagreement can be taken back to the text.
+/

import std.algorithm : canFind, startsWith;
import std.array : array, split;
import std.conv : to;
import std.file : readText;
import std.stdio : writeln, writefln;
import std.string : indexOf, strip;

struct SspFinding {
  size_t line;      // 1-based
  string section;   // the specification section the rule is from
  string detail;
}

/+ ↓ specification section 6.3: the properties, in the order they are
     emitted. A reader may rely on the order, so a validator can check it +/
private immutable string[] property_order = [
  "identifier", "part", "section", "parent", "last_descendant", "ocn_range",
  "children",
  "ancestors", "ancestors_collapsed", "dom_status", "dom_status_collapsed",
  "heading_lev_collapsed", "parent_lev", "dummy", "ocn_off", "is_of_type",
  "attrib", "meta_lang", "meta_syntax", "sha256", "image", "indent",
  "bullet", "lang", "has", "table_cols", "table_widths", "table_aligns",
  "table_header", "code_linenumbers", "stow_link", "segment", "anchor",
  "segment_prev", "segment_next", "heading_lev_anchor", "segment_epub",
  "segment_html_is", "segment_epub_is", "segment_lv4_is",
  "heading_ancestors_text", "lev4_subtoc", "anchor_tag",
];

/+ ↓ section 6.1: the sixteen kinds +/
private immutable string[] kinds = [
  "para", "heading", "toc", "bookindex", "endnote", "code", "bibliography",
  "comment", "verse", "glossary", "quote", "poem", "block", "table",
  "blurb", "group",
];

/+ ↓ section 4: the nine sections, in the order they appear +/
private immutable string[] section_order = [
  "head", "toc", "body", "endnotes", "glossary", "bibliography",
  "bookindex", "blurb", "tail",
];

/+ ↓ section 4: the four preamble blocks, in the order they appear +/
private immutable string[] preamble_order = ["source", "meta", "make", "doc_has"];

/+ ↓ section 6.1: the heading levels +/
private immutable string[] levels = ["A", "B", "C", "D", "1", "2", "3", "4"];

private int propertyRank(string name) {
  foreach (i, p; property_order) { if (p == name) { return cast(int) i; } }
  return -1;
}

SspFinding[] validateSspFile(string filename, string major_known) {
  SspFinding[] found;
  auto lines = readText(filename).split("\n");

  bool   seen_banner = false;
  bool   seen_source_line = false;
  string block = "";          // the block currently open, "" when none
  int    preamble_at = -1;    // how far through the preamble order
  int    section_at = -1;     // how far through the section order
  bool   in_object = false;
  int    prev_rank = -1;
  size_t doc_has_keys = 0;
  bool   in_text = false;     // text lines come after properties

  foreach (i, line; lines) {
    size_t no = i + 1;

    /+ ↓ section 2: the version, on the first line +/
    if (no == 1) {
      enum banner = "% SiSU Document Abstraction v";
      if (!line.startsWith(banner)) {
        found ~= SspFinding(no, "2", "first line is not the version banner");
      } else {
        seen_banner = true;
        string v = line[banner.length .. $].strip;
        auto dot = v.indexOf('.');
        string major = (dot > 0) ? v[0 .. dot] : v;
        if (major != major_known) {
          found ~= SspFinding(no, "2.1",
            "format major v" ~ major ~ ", this validator knows v" ~ major_known);
        }
      }
      continue;
    }
    if (no == 2) {
      if (!line.startsWith("% Source: ")) {
        found ~= SspFinding(no, "4", "second line is not \"% Source: \"");
      } else { seen_source_line = true; }
      continue;
    }

    if (line.length == 0) { in_object = false; in_text = false; prev_rank = -1; continue; }

    /+ ↓ section 3: a comment is the file header only +/
    if (line[0] == '%') {
      found ~= SspFinding(no, "3", "a comment outside the two header lines");
      continue;
    }

    /+ ↓ block open +/
    if (line[0] == '@') {
      auto brace = line.indexOf(" {");
      if (brace < 1 || line[$ - 1] != '{') {
        found ~= SspFinding(no, "3", "block open is not \"@name {\"");
        continue;
      }
      string name = line[1 .. brace];
      if (preamble_order.canFind(name)) {
        int at = 0;
        foreach (k, p; preamble_order) { if (p == name) { at = cast(int) k; } }
        if (at <= preamble_at) {
          found ~= SspFinding(no, "4", "preamble block @" ~ name ~ " out of order");
        }
        preamble_at = at;
        if (section_at >= 0) {
          found ~= SspFinding(no, "4", "preamble block @" ~ name ~ " after a section");
        }
      } else if (section_order.canFind(name)) {
        int at = 0;
        foreach (k, sname; section_order) { if (sname == name) { at = cast(int) k; } }
        if (at <= section_at) {
          found ~= SspFinding(no, "4", "section @" ~ name ~ " out of order");
        }
        section_at = at;
      } else {
        found ~= SspFinding(no, "4", "@" ~ name ~ " is neither a preamble block nor a section");
      }
      block = name;
      doc_has_keys = 0;
      continue;
    }

    if (line[0] == '}') {
      if (line.length != 1) {
        found ~= SspFinding(no, "3", "block close carries more than \"}\"");
      }
      /+ ↓ section 5.4: ten keys, always +/
      if (block == "doc_has" && doc_has_keys != 10) {
        found ~= SspFinding(no, "5.4",
          "@doc_has has " ~ doc_has_keys.to!string ~ " keys, the specification says ten");
      }
      block = "";
      in_object = false;
      prev_rank = -1;
      continue;
    }

    /+ ↓ section 5: inside a preamble block, "  key: value" +/
    if (preamble_order.canFind(block)) {
      if (!line.startsWith("  ") || line.indexOf(": ") < 3) {
        found ~= SspFinding(no, "5", "not \"  key: value\" inside @" ~ block);
      } else if (block == "doc_has") {
        doc_has_keys++;
      }
      continue;
    }

    /+ ↓ section 6.1: the object declaration line +/
    if (line[0] == '[') {
      auto close = line.indexOf("] ");
      if (close < 2) {
        found ~= SspFinding(no, "6.1", "declaration is not \"[ocn] ...\"");
        continue;
      }
      string ocn = line[1 .. close];
      foreach (c; ocn) {
        if (c < '0' || c > '9') {
          found ~= SspFinding(no, "6.1", "ocn \"" ~ ocn ~ "\" is not a number");
          break;
        }
      }
      auto rest = line[close + 2 .. $].split(" ");
      if (rest.length == 0 || !kinds.canFind(rest[0])) {
        found ~= SspFinding(no, "6.1",
          "\"" ~ ((rest.length > 0) ? rest[0] : "") ~ "\" is not one of the sixteen kinds");
      } else if (rest[0] == "heading") {
        if (rest.length < 2 || rest[1].length < 2 || rest[1][0] != ':') {
          found ~= SspFinding(no, "6.1", "a heading declaration carries no \":level\"");
        } else if (!levels.canFind(rest[1][1 .. $])) {
          found ~= SspFinding(no, "6.1", "level \"" ~ rest[1][1 .. $] ~ "\" is not one of the eight");
        }
      }
      in_object = true;
      in_text = false;
      prev_rank = -1;
      continue;
    }

    /+ ↓ section 6.3: properties, known and in order +/
    if (line[0] == '.') {
      if (!in_object) {
        found ~= SspFinding(no, "6", "a property outside an object record");
        continue;
      }
      if (in_text) {
        found ~= SspFinding(no, "6", "a property after the object text began");
      }
      auto colon = line.indexOf(": ");
      if (colon < 2) {
        found ~= SspFinding(no, "3", "property is not \".name: value\"");
        continue;
      }
      string name = line[1 .. colon];
      int rank = propertyRank(name);
      if (rank < 0) {
        found ~= SspFinding(no, "6.3", "." ~ name ~ " is not one of the " ~ property_order.length.to!string ~ " properties");
      } else {
        /+ ↓ the four repeatable properties may recur at the same rank +/
        if (rank < prev_rank) {
          found ~= SspFinding(no, "6.3", "." ~ name ~ " is out of the emitted order");
        }
        prev_rank = rank;
      }
      continue;
    }

    /+ ↓ section 6.2: text lines +/
    if (line[0] == '|') {
      if (!in_object) {
        found ~= SspFinding(no, "6.2", "a text line outside an object record");
      }
      if (line.length < 2 || line[1] != ' ') {
        found ~= SspFinding(no, "6.2", "a text line is not \"| \" then the text");
      }
      in_text = true;
      continue;
    }

    found ~= SspFinding(no, "3", "line of no shape the specification defines");
  }

  if (!seen_banner) { found ~= SspFinding(0, "2", "no version banner"); }
  if (!seen_source_line) { found ~= SspFinding(0, "4", "no \"% Source:\" line"); }
  return found;
}

void reportValidation(string filename, SspFinding[] found) {
  if (found.length == 0) {
    writeln("\nvalid: ", filename,
      " conforms to the .ssp specification as this validator reads it");
    return;
  }
  writefln("\n%d finding%s against the specification:",
    found.length, (found.length == 1) ? "" : "s");
  foreach (f; found) {
    if (f.line > 0) {
      writefln("  line %-7d [%-4s] %s", f.line, f.section, f.detail);
    } else {
      writefln("  %-13s [%-4s] %s", "(file)", f.section, f.detail);
    }
  }
}