summaryrefslogtreecommitdiffhomepage
path: root/dlang/src/read/tree.d
blob: 5715d243796c944e15de9fcbc9dd5a69313958fa (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
/+
- 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.tree;

import std.conv : to;
import std.stdio : writeln, writef, writefln, File;
import std.array : replicate;
import ocda.model;

void outputTree(OcdaDocument doc, string output_file) {
  string[] lines;

  lines ~= "Document: " ~ doc.meta("title.main");
  if (doc.meta("title.subtitle").length > 0)
    lines ~= "  " ~ doc.meta("title.subtitle");
  lines ~= "Author: " ~ doc.meta("creator.author");
  lines ~= "";

  /+ ↓ build OCN -> object lookup for body headings +/
  OcdaObject[int] headings;
  foreach (obj; doc.body) {
    if (obj.is_a == "heading" && obj.ocn > 0) {
      headings[obj.ocn] = obj;
    }
  }

  /+ ↓ find root heading (from head section, or first body heading) +/
  if (doc.head.length > 0 && doc.head[0].is_a == "heading") {
    auto root = doc.head[0];
    lines ~= formatHeading(root, 0);
    walkChildren(root, headings, lines, 1);
  }

  /+ ↓ write output +/
  if (output_file.length > 0) {
    auto f = File(output_file, "w");
    foreach (line; lines) f.writeln(line);
  } else {
    foreach (line; lines) writeln(line);
  }
}

private void walkChildren(OcdaObject parent, ref OcdaObject[int] headings, ref string[] lines, int depth) {
  foreach (child_ocn; parent.children) {
    if (auto p = child_ocn in headings) {
      lines ~= formatHeading(*p, depth);
      walkChildren(*p, headings, lines, depth + 1);
    }
  }
}

private string formatHeading(OcdaObject obj, int depth) {
  string indent = replicate("  ", depth);
  string level_tag = (obj.heading_level.length > 0) ? obj.heading_level : "?";
  string ocn_str = (obj.ocn > 0) ? " [" ~ obj.ocn.to!string ~ "]" : "";
  /+ ↓ strip internal markup from heading text for clean display +/
  string text = stripInternalMarkup(obj.text);
  return indent ~ level_tag ~ "~" ~ ocn_str ~ " " ~ text;
}

private string stripInternalMarkup(string text) {
  /+ ↓ simple removal of common internal markers for display +/
  import std.regex : replaceAll, regex;
  import std.array : replace;
  string result = text;
  result = result.replace("⑆*", "").replace("⑆!", "").replace("⑆/", "")
                 .replace("⑆_", "").replace("⑆^", "").replace("⑆,", "")
                 .replace("┨", "").replace("┣", "")
                 .replace("┙", " ").replace("┘", "\n");
  return result;
}