diff options
Diffstat (limited to 'org/sdp.org')
| -rw-r--r-- | org/sdp.org | 99 |
1 files changed, 51 insertions, 48 deletions
diff --git a/org/sdp.org b/org/sdp.org index c6d0ad1..9e38ed7 100644 --- a/org/sdp.org +++ b/org/sdp.org @@ -14,7 +14,7 @@ [[../maker.org][maker.org makefile]] [[./][org/]] * 0. Code Skeleton / Outline / Structure (tangles) :tangle: -** TODO version.txt: set version (sisu document parser) :version: +** TODO version.txt: set version (sisu document parser) :version: #+NAME: version_txt #+BEGIN_SRC d :tangle ../views/version.txt @@ -27,7 +27,7 @@ struct Version { enum ver = Version(0, 11, 0); #+END_SRC -** TODO sdp src/sdp.d :sdp.d: +** sdp src/sdp.d :sdp: #+BEGIN_SRC d :tangle ../src/sdp.d :shebang #!/usr/bin/env rdmd /+ @@ -37,8 +37,8 @@ enum ver = Version(0, 11, 0); <<imports_sdlang>> <<imports_std>> <<sdp_output_selection>> -<<sdp_version_mixin>> -<<std_mixins>> +<<mixin_sdp_version>> +<<mixin_pre_main>> /++ A SiSU document parser writen in D. +/ void main(string[] args) { <<sdp_mixin>> @@ -68,7 +68,7 @@ unittest { } #+END_SRC -* sdp.d sisu document parser :sdp.d: +* 1. sdp.d (sisu document parser) :sdp: - deal with imports - get options @@ -79,9 +79,10 @@ unittest { - proess file - output -** pre loop init :init: -*** imports :import: -**** sdp :import:sdp: +** 0. pre-loop init :init: +*** init +**** imports :import: +***** sdp :sdp: #+NAME: imports_sdp #+BEGIN_SRC d @@ -104,7 +105,7 @@ import source_sisupod; #+END_SRC -***** notes +****** notes ├── src │ ├── sdp.d │ └── sdp @@ -114,20 +115,16 @@ import └── views └── version.txt -[[./compile_time_info.org][compile time info]] [[./ao_abstract_doc_source.org][ao_abstract_doc_source]] -[[./ao_conf_make_meta.org][ao_onf_make_meta]] -[[./ao_conf_make_meta_native.org][ao_onf_make_meta_native]] -[[./ao_conf_make_meta_sdlang.org][ao_onf_make_meta_sdlang]] +[[./ao_conf_make_meta.org][ao_conf_make_meta]] [[./ao_defaults.org][ao_defaults]] [[./ao_output_debugs.org][ao_output_debugs]] -[[./ao_read_config_files.org][ao_read_config_files]] -[[./ao_read_source_files.org][ao_read_source_files]] [[./ao_read_source_files.org][ao_read_source_files]] -[[./ao_rgx.org][ao_rgx]] -[[./output_hub.org][output hub]] +[[./compile_time_info.org][compile time info]] +[[./output.org][output]] +[[./sdp.org][sdp]] -**** TODO sdlang :import:sdlang: +***** sdlang :sdlang: keep up to date, configuration in ../maker.org check: - http://github.com/Abscissa/SDLang-D @@ -139,12 +136,12 @@ check: import sdlang; // sdlang.d #+END_SRC -***** notes +****** notes -sdlang.parser, // sdlang/parser.d +sdlang.parser, sdlang.exceptions; -**** std :import:std: +***** std :std: #+NAME: imports_std #+BEGIN_SRC d @@ -169,28 +166,26 @@ private import std.conv : to; #+END_SRC -***** notes +****** notes std.conv, -std.path, -std.stdio, std.variant, -**** mixins -***** version.txt :version: +**** mixins :mixin: +***** version.txt :version: -#+NAME: sdp_version_mixin +#+NAME: mixin_sdp_version #+BEGIN_SRC d mixin(import("version.txt")); #+END_SRC -***** std mixins -#+NAME: std_mixins +***** pre main mixins +#+NAME: mixin_pre_main #+BEGIN_SRC d mixin CompileTimeInfo; mixin RgxInit; #+END_SRC -*** mixin :mixin: +***** sdp "main" mixins :sdp: #+NAME: sdp_mixin #+BEGIN_SRC d @@ -207,7 +202,7 @@ mixin SiSUoutputDebugs; mixin SiSUoutputHub; #+END_SRC -*** init :init: +**** init :init: #+NAME: sdp_args #+BEGIN_SRC d @@ -231,7 +226,7 @@ string arg_unrecognized; auto rgx = Rgx(); #+END_SRC -*** scope (run complete) :scope: +*** scope (run complete) :scope: #+NAME: sdp_args #+BEGIN_SRC d @@ -254,7 +249,8 @@ scope(failure) { } #+END_SRC -*** getopt args for loop :args:getopt: +*** config files and command line arguements +**** getopt args for loop :args:getopt: look into using getopt [[http://dlang.org/phobos/std_getopt.html][getopt]] @@ -346,7 +342,7 @@ foreach(arg; args) { } #+END_SRC -*** TODO config files (load & read) (so far only SDLang) :config:files: +**** TODO config files (load & read) (so far only SDLang) :config:files: #+NAME: sdp_conf_files #+BEGIN_SRC d @@ -358,9 +354,8 @@ auto conf_settings_aa = confsdl.configSettingsSDLangToAAmake(sdl_root_configurat auto conf_doc_make_aa = confsdl.documentMakeSDLangToAAmake(sdl_root_doc_make); #+END_SRC -** each file (loop) [+2] :loop:files: -*** filename provided [+1] :file:process: -**** scope (loop) :scope: +** _1a. processing: loop each file_ [+2] :loop:files: +*** scope (loop) :scope: #+NAME: sdp_each_file_do_scope #+BEGIN_SRC d @@ -388,8 +383,9 @@ enforce( ); #+END_SRC -**** _read in raw file_ (using filename with path) :file:read: -[[./ao_markup_source_raw.org][ao_markup_source_raw]] +*** 0. prepare document, _document abstraction_ +**** 0. _read in raw file_ (using filename with path) :file:read: +- [[./ao_read_source_files.org][ao_read_source_files]] #+NAME: sdp_each_file_do_read_sisu_markup_file #+BEGIN_SRC d @@ -397,7 +393,8 @@ enforce( auto read_in_file_string = raw.sourceContent(fn_src); #+END_SRC -**** split raw content file into: _doc header & doc content_ :file:read: +**** 1. split raw content file into: _doc header & doc content_ +- [[./ao_read_source_files.org][ao_read_source_files]] #+NAME: sdp_each_file_do_split_sisu_markup_file_content_into_header_and_body #+BEGIN_SRC d @@ -413,7 +410,8 @@ debug(header_and_body) { } #+END_SRC -**** split doc header into: _metadata & make_ :doc:header:metadata:make: +**** 2. split doc header into: _metadata & make_ :doc:header:metadata:make: +- [[./ao_conf_make_meta.org][ao_conf_make_meta]] #+NAME: sdp_each_file_do_split_sisu_markup_file_header_into_make_and_meta #+BEGIN_SRC d @@ -424,7 +422,8 @@ string[string][string] _dochead_make = header_make_and_meta_tuple[0]; string[string][string] _dochead_meta = header_make_and_meta_tuple[1]; #+END_SRC -**** [#A] processing: _document abstraction, tuple_ :processing: +**** 3. processing: _document abstraction, tuple_ :processing: +- [[./ao_abstract_doc_source.org][ao_abstract_doc_source]] #+NAME: sdp_each_file_do_document_abstraction #+BEGIN_SRC d @@ -435,7 +434,7 @@ auto doc_abstraction = t[0]; // head ~ toc ~ contents ~ endnotes_seg ~ glossary string[] doc_html_segnames = t[1]; #+END_SRC -**** document _section keys_ sequence +**** 4. document _section keys_ sequence #+NAME: sdp_each_file_do_document_abstraction #+BEGIN_SRC d @@ -474,7 +473,8 @@ if ((_opt_action_bool["html"]) } #+END_SRC -**** [#A] _document matters_ +**** 5. _document matters_ (compiled from various sources) + #+NAME: sdp_each_file_do_document_abstraction #+BEGIN_SRC d struct DocumentMatters { @@ -514,7 +514,9 @@ struct DocumentMatters { auto doc_matters = DocumentMatters(); #+END_SRC -**** TODO _debug_ (document parts, checkdoc) :debug:checkdoc: +*** 1. _output processing_ (post abstraction processing) +**** 0. _debug_ (document parts, checkdoc) :debug:checkdoc: +- [[./ao_output_debugs.org][ao_output_debugs]] #+NAME: sdp_each_file_do_debugs_checkdoc #+BEGIN_SRC d @@ -527,7 +529,8 @@ debug(checkdoc) { } #+END_SRC -**** TODO _process outputs_ :outputs: +**** 1. _process outputs_ :outputs: +- [[./output.org][output]] #+NAME: sdp_each_file_do_selected_output #+BEGIN_SRC d @@ -540,7 +543,7 @@ if (!(_opt_action_bool["skip_output"])) { } #+END_SRC -**** scope (on loop exit) :scope:exit: +*** scope (on loop exit) :scope:exit: #+NAME: sdp_each_file_do_scope_exit #+BEGIN_SRC d @@ -559,7 +562,7 @@ scope(exit) { } #+END_SRC -*** no filename provided +** 1b. no filename provided #+NAME: sdp_no_filename_provided #+BEGIN_SRC d /+ no recognized filename provided +/ |