aboutsummaryrefslogtreecommitdiffhomepage
path: root/org/sdp.org
blob: 0b2fc53dc6214dce7c1f998932dcc10660c73692 (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
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
#+TITLE: sdp hub
#+AUTHOR: Ralph Amissah
#+EMAIL: ralph.amissah@gmail.com
#+STARTUP: indent
#+LANGUAGE: en
#+OPTIONS: H:3 num:nil toc:t \n:nil @:t ::t |:t ^:nil _:nil -:t f:t *:t <:t
#+OPTIONS: TeX:t LaTeX:t skip:nil d:nil todo:t pri:nil tags:not-in-toc
#+OPTIONS: author:nil email:nil creator:nil timestamp:nil
#+PROPERTY: header-args :padline no :exports code :noweb yes
#+EXPORT_SELECT_TAGS: export
#+EXPORT_EXCLUDE_TAGS: noexport
#+FILETAGS: :sdp:rel:hub:
#+TAGS: assert(a) class(c) debug(d) mixin(m) sdp(s) tangle(T) template(t) WEB(W) noexport(n)

[[../maker.org][maker.org makefile]]  [[./][org/]]

* sdp.d   sisu document parser                                       :sdp.d:
Deal with imports.
Take command line instructions and process files as instructed.

** TODO version.txt: set version                                    :version:

#+NAME: version_txt
#+BEGIN_SRC d  :tangle ../views/version.txt
/+ obt - org generated file +/
struct Version {
  int major;
  int minor;
  int patch;
}
enum ver = Version(0, 4, 0);
#+END_SRC

** pre loop init
*** imports                                                          :import:
[[./compile_time_info.org][compile time info]]
[[./ao_abstract_doc_source.org][ao_abstract_doc_source]]
[[./ao_ansi_colors.org][ao_ansi_colors]]
[[./ao_defaults.org][ao_defaults]]
[[./ao_output_debugs.org][ao_output_debugs]]
[[./ao_read_source_files.org][ao_read_source_files]]
[[./output_hub.org][output hub]]

**** sdp                                                      :import:sdp:
***** TODO src/sdp.d

├── src
│   ├── sdp.d
│   └── sdp
│       ├── ao_abstract_doc_source.d
│       ├── ...
│       └── compile_time_info.d
└── views
    └── version.txt

#+NAME: sdp_imports_use
#+BEGIN_SRC d
/+ sdp  sisu document parser http://sisudoc.org +/
import
  compile_time_info,          // sdp/compile_time_info.d
  ao_abstract_doc_source,     // sdp/ao_abstract_doc_source.d
  ao_defaults,                // sdp/ao_defaults.d
  ao_read_source_files,       // sdp/ao_read_source_files.d
  ao_output_debugs,           // sdp/ao_output_debugs.d
  output_hub,                 // output_hub.d
  ao_rgx,                     // sdp/ao_rgx.d
  ao_ansi_colors;             // sdp/ao_ansi_colors.d
  // std.conv;
#+END_SRC

**** std                                                         :import:std:
#+NAME: sdp_imports
#+BEGIN_SRC d
/+ sdp  sisu document parser +/
private import
  std.getopt,
  std.process,
  std.stdio,
  std.algorithm,
  std.array,
  std.container,
  std.exception,
  std.file,
  std.json,
  // std.path,
  std.range,
  std.regex,
  // std.stdio,
  std.string,
  std.traits,
  std.typecons,
  std.utf,
  // std.variant,
  std.conv : to;
#+END_SRC

**** version.txt                                                 :version:

#+NAME: sdp_version_mixin
#+BEGIN_SRC d
mixin(import("version.txt"));
#+END_SRC

*** mixin                                                             :mixin:

#+NAME: sdp_args
#+BEGIN_SRC d
mixin SiSUheader;
mixin SiSUbiblio;
mixin SiSUrgxInitFlags;
mixin SiSUmarkupRaw;
mixin SiSUdocAbstraction;
mixin SiSUoutputDebugs;
mixin SiSUoutputHub;
mixin ScreenTxtColors;
#+END_SRC

*** sdp output                                                      :output:
#+NAME: sdp_args
#+BEGIN_SRC d
struct SDPoutput {
  auto hub(S)(
    auto ref const S         contents,
    string[][string][string] bookindex_unordered_hashes,
    JSONValue[]              biblio,
    JSONValue[string]        dochead_make,
    JSONValue[string]        dochead_meta,
    string                   fn_src,
    bool[string]             opt_action_bool
  ) {
    mixin ScreenTxtColors;
    mixin RgxInit;
    mixin SiSUoutputHub;
    // mixin SiSUoutput;
    auto rgx = Rgx();
    uint return_ = 0;
    if (opt_action_bool["source"]) {
      writeln("sisupod source");
    }
    if (opt_action_bool["sisupod"]) {
      writeln("sisupod source");
    }
    if (opt_action_bool["text"]) {
      writeln("text processing");
      // auto text=SDPoutput_text();
      // text.scroll(contents, bookindex_unordered_hashes, biblio, fn_src, opt_action_bool);
      // // text.scroll(contents, bookindex_unordered_hashes, biblio, dochead_make, dochead_meta, fn_src, opt_action_bool);
    }
    if (opt_action_bool["html"]) {
      auto html=SDPoutputHTML();
      html.css_write;
      // html.scroll(contents, bookindex_unordered_hashes, biblio, fn_src, opt_action_bool);
      html.scroll(contents, bookindex_unordered_hashes, biblio, dochead_make, dochead_meta, fn_src, opt_action_bool);
    }
    if (opt_action_bool["epub"]) {
      writeln("epub processing");
    }
    if (opt_action_bool["pdf"]) {
      writeln("pdf processing");
    }
    if (opt_action_bool["odt"]) {
      writeln("odt processing");
    }
    if (opt_action_bool["sqlite"]) {
      writeln("sqlite processing");
    }
    if (opt_action_bool["postgresql"]) {
      writeln("pgsql processing");
    }
    return return_;
  }
}
#+END_SRC

*** init                                                               :init:

#+NAME: sdp_args
#+BEGIN_SRC d
auto raw = MarkupRaw();
auto abs = Abstraction();
auto dbg = SDPoutputDebugs();
auto output = SDPoutput();
/+
struct DocumentParts {
  string[string][] contents;
  JSONValue[string] metadata_json;
  JSONValue[string] make_json;
  string[][string][string] bookindex_unordered_hashes;
  JSONValue[] biblio;
}
+/
string[] fns_src;
string flag_action;
string arg_unrecognized;
auto rgx = Rgx();
#+END_SRC

*** scope                                                             :scope:

#+NAME: sdp_args
#+BEGIN_SRC d
scope(success) {
  debug(checkdoc) {
    writefln(
      "%s~ run complete, ok ~ %s (sdp-%s.%s.%s, %s v%s, %s %s)",
      scr_txt_color["cyan"], scr_txt_color["off"],
      ver.major, ver.minor, ver.patch,
      __VENDOR__, __VERSION__,
      bits, os,
    );
  }
  // stderr.writeln("0");
}
scope(failure) {
  debug(checkdoc) {
    stderr.writefln(
      "%s~ run failure ~%s",
       scr_txt_color["fuchsia"], scr_txt_color["off"],
    );
  }
}
#+END_SRC

*** getopt args for loop                                        :args:getopt:

look into using getopt
[[http://dlang.org/phobos/std_getopt.html][getopt]]
[[http://dlang.org/library/std/getopt.html][getopt]]

#+NAME: sdp_args
#+BEGIN_SRC d

bool[string] opt_action_bool = [
  "assertions"      : false,
  "concordance"     : false,
  "digest"          : false,
  "docbook"         : false,
  "epub"            : false,
  "html"            : false,
  "manifest"        : false,
  "no_ocn"          : false,
  "odt"             : false,
  "pdf"             : false,
  "postgresql"      : false,
  "qrcode"          : false,
  "sisupod"         : false,
  "source"          : false,
  "sqlite"          : false,
  "text"            : false,
  "verbose"         : false,
  "xhtml"           : false,
  "xml_dom"         : false,
  "xml_sax"         : false,
];
auto helpInfo = getopt(args,
  std.getopt.config.passThrough,
  "assert",         "--assert set optional assertions on",       &opt_action_bool["assertions"],
  "concordance",    "--concordance file for document",           &opt_action_bool["concordance"],
  "digest",         "--digest hash digest for each object",      &opt_action_bool["digest"],
  "docbook",        "--docbook process docbook output",          &opt_action_bool["docbook"],
  "epub",           "--epub process epub output",                &opt_action_bool["epub"],
  "html",           "--html process html output",                &opt_action_bool["html"],
  "manifest",       "--manifest process manifest output",        &opt_action_bool["manifest"],
  "no-ocn",         "--no-ocn suppress object cite numbers",     &opt_action_bool["no_ocn"],
  "odf",            "--odf process odf:odt output",              &opt_action_bool["odt"],
  "odt",            "--odt process odf:odt output",              &opt_action_bool["odt"],
  "pdf",            "--pdf process pdf output",                  &opt_action_bool["pdf"],
  "pg",             "--pg process postgresql output",            &opt_action_bool["postgresql"],
  "postgresql",     "--postgresql process postgresql output",    &opt_action_bool["postgresql"],
  "qrcode",         "--qrcode with document metadata",           &opt_action_bool["qrcode"],
  "sisupod",        "--sisupod sisupod source content bundled",  &opt_action_bool["sisupod"],
  "source",         "--source markup source text content",       &opt_action_bool["source"],
  "sqlite",         "--sqlite process sqlite output",            &opt_action_bool["sqlite"],
  "text",           "--text process text output",                &opt_action_bool["text"],
  "txt",            "--txt process text output",                 &opt_action_bool["text"],
  "verbose|v",      "--verbose output to terminal",              &opt_action_bool["verbose"],
  "xhtml",          "--xhtml process xhtml output",              &opt_action_bool["xhtml"],
  "xml-dom",        "--xml-dom process xml dom output",          &opt_action_bool["xml_dom"],
  "xml-sax",        "--xml-sax process xml sax output",          &opt_action_bool["xml_sax"],
);
if (helpInfo.helpWanted) {
  defaultGetoptPrinter("Some information about the program.", helpInfo.options);
}
foreach(arg; args) {
  if (match(arg, rgx.flag_action)) {
    flag_action ~= " " ~ arg;   // flags not taken by getopt
  } else if (match(arg, rgx.src_pth)) {
    fns_src ~= arg;             // gather input markup source file names for processing
  } else {                      // anything remaining, unused
    arg_unrecognized ~= " " ~ arg;
  }
}
#+END_SRC

** each file (loop) [+2]                                         :loop:files:
*** filename provided [+1]                                     :file:process:
**** loop scope                                                       :scope:
#+NAME: sdp_each_file_do
#+BEGIN_SRC d
scope(success) {
  debug(checkdoc) {
    writefln(
      "%s~ document complete, ok ~%s",
      scr_txt_color["green"], scr_txt_color["off"],
    );
  }
  // stderr.writeln("0");
}
scope(failure) {
  debug(checkdoc) {
    stderr.writefln(
      "%s~ document run failure ~%s (%s  v%s)\n\t%s",
      scr_txt_color["red"], scr_txt_color["off"],
      __VENDOR__, __VERSION__,
      fn_src
    );
  }
  // stderr.writeln("1");
}
enforce(
  match(fn_src, rgx.src_pth),
  "not a sisu markup filename"
);
#+END_SRC

**** [#A] read file                                               :file:read:
[[./ao_markup_source_raw.org][ao_markup_source_raw]]

#+NAME: sdp_each_file_do
#+BEGIN_SRC d
/+ ↓ read file +/
auto sourcefile_content =
  raw.sourceContent(fn_src);
#+END_SRC

**** [#A] processing: document abstraction, tuple                :processing:
#+NAME: sdp_each_file_do
#+BEGIN_SRC d
/+ ↓ porcess document, return abstraction as tuple +/
auto t = abs.abstract_doc_source(sourcefile_content);
static assert(!isTypeTuple!(t));
auto doc_ao_contents = t[0]; // contents ~ endnotes ~ bookindex;
// static assert(!isIterable!(doc_ao_contents));
auto doc_ao_metadata_json = t[1];
auto doc_ao_make_json = t[2];
auto doc_ao_bookindex_unordered_hashes = t[3];
auto doc_ao_biblio = t[4];
// destroy(t);
#+END_SRC

**** TODO debug                                                       :debug:
***** [#A] debug document parts (checkdoc)                         :checkdoc:
#+NAME: sdp_each_file_do
#+BEGIN_SRC d
/+ ↓ document parts +/
debug(checkdoc) { // checkbook & dumpdoc
  dbg.abstract_doc_source_debugs(
    doc_ao_contents,
    doc_ao_bookindex_unordered_hashes,
    doc_ao_biblio,
    doc_ao_make_json,
    doc_ao_metadata_json,
    fn_src,
    opt_action_bool
  );
}
#+END_SRC

**** TODO process outputs                                             :outputs:
***** [#A] html                                                        :html:
#+NAME: sdp_each_file_do
#+BEGIN_SRC d
/+ ↓ output hub +/
output.hub(
  doc_ao_contents,
  doc_ao_bookindex_unordered_hashes,
  doc_ao_biblio,
  doc_ao_make_json,
  doc_ao_metadata_json,
  fn_src,
  opt_action_bool
);
#+END_SRC

**** on exit                                                     :scope:exit:
#+NAME: sdp_each_file_do
#+BEGIN_SRC d
scope(exit) {
  debug(checkdoc) {
    writefln(
      "processed file: %s",
      fn_src
    );
  }
  destroy(sourcefile_content);
  destroy(t);
  destroy(doc_ao_contents);
  destroy(doc_ao_make_json);
  destroy(doc_ao_metadata_json);
  destroy(doc_ao_bookindex_unordered_hashes);
  destroy(doc_ao_biblio);
  destroy(fn_src);
}
#+END_SRC

*** no filename provided
#+NAME: sdp_no_filename_provided
#+BEGIN_SRC d
/+ no recognized filename provided +/
writeln("no recognized filename");
break;
// terminate, stop
#+END_SRC

* tangles (code structure)                                           :tangle:
** sdp                                                              :sdp.d:
*** TODO src/sdp.d

#+BEGIN_SRC d  :tangle ../src/sdp.d :shebang #!/usr/bin/env rdmd
/+
  sdp
  sdp.d
+/
<<sdp_imports_use>>
<<sdp_imports>>
<<sdp_version_mixin>>
mixin CompileTimeInfo;
mixin RgxInit;
void main(string[] args) {
  <<sdp_compilation>>
  <<sdp_args>>
  foreach(fn_src; fns_src) {
  // foreach(fn_src; fns_src) {
    if (!empty(fn_src)) {
      <<sdp_each_file_do>>
    } else {
      <<sdp_no_filename_provided>>
    }
  }
}
#+END_SRC

├── src
│   ├── sdp.d
│   └── sdp
│       ├── ao_abstract_doc_source.d
│       ├── ...
│       └── compile_time_info.d
├── views
│   └── version.txt

├── src
│   ├── sdp
│   │   ├── ao_abstract_doc_source.d
│   │   ├── ...
│   │   └── compile_time_info.d
│   └── sdp.d
├── views
│   └── version.txt

* TODO work on
** program dir structure
figure out best program dir structure for dub and compilers, issue with rdmd

** sisu file structure

|---------------------+------------------------------------------+------------------------+--------|
| header              | sisu /header markup/                       | markup                 |        |
| - metadata          |                                          |                        |        |
| - make instructions |                                          |                        |        |
|---------------------+------------------------------------------+------------------------+--------|
| table of contents   | markup of headings                       | (regular content)      | output |
|---------------------+------------------------------------------+------------------------+--------|
| substantive content | sisu /content markup/                      | markup                 | output |
|                     | headings (providing document structure), | (regular content)      |        |
|                     | paragraphs, blocks                       |                        |        |
|                     | blocks (code, poem, group, table)        |                        |        |
|---------------------+------------------------------------------+------------------------+--------|
| endnotes            | markup within substantive content        | markup                 | output |
|                     | (extracted from sisu /content markup/)     | (from regular content) |        |
|---------------------+------------------------------------------+------------------------+--------|
| glossary            | identify special section                 | markup                 | output |
|                     | regular /content markup/                   |                        |        |
|---------------------+------------------------------------------+------------------------+--------|
| bibliography        | identify section,                        | markup (special)       | output |
|                     | special /bibliography markup/              |                        |        |
|---------------------+------------------------------------------+------------------------+--------|
| book index          | extracted from markup attached to        | markup                 | output |
|                     | related substantive content objects      |                        |        |
|                     | (special tags in sisu /content markup/)    | (from regular content) |        |
|---------------------+------------------------------------------+------------------------+--------|
| metadata            |                                          | (from regular header)  | output |
|---------------------+------------------------------------------+------------------------+--------|