diff options
| -rw-r--r-- | org/ao_read_source_files.org | 133 | ||||
| -rw-r--r-- | org/sdp.org | 716 | ||||
| -rwxr-xr-x | src/sdp.d | 93 | ||||
| -rw-r--r-- | src/sdp/abstraction.d | 121 | ||||
| -rw-r--r-- | src/sdp/ao_read_config_files.d | 160 | ||||
| -rw-r--r-- | src/sdp/ao_read_source_files.d | 9 | ||||
| -rw-r--r-- | views/version.txt | 2 |
7 files changed, 441 insertions, 793 deletions
diff --git a/org/ao_read_source_files.org b/org/ao_read_source_files.org index c362f9a..f537e6a 100644 --- a/org/ao_read_source_files.org +++ b/org/ao_read_source_files.org @@ -23,17 +23,10 @@ - read config files<BR> ao_config_files.d +/ -template SiSUconfigIn() { - private import - std.exception, - std.stdio, - std.utf, - std.conv : to; - private - struct ConfigIn { - private import std.file; - <<ao_config_file_in>> - } +template ConfigIn() { + <<imports_std>> + import std.file; + <<ao_config_file_in>> } #+END_SRC @@ -43,25 +36,10 @@ template SiSUconfigIn() { /+ +/ -template SiSUconfigSDLang() { - struct ConfigSDLangRootTag { - <<ao_config_file_sdlang>> - } -} -#+END_SRC - -*** config files hub - -#+BEGIN_SRC d :tangle ../src/sdp/ao_read_config_files.d -/+ - -+/ -template SiSUconfigSDLangHub() { - mixin SiSUconfigIn; - mixin SiSUconfigSDLang; - struct ConfigHub { - <<ao_config_file_sdlang_hub>> - } +template ConfigSDLang() { + import sdlang; + <<imports_std>> + <<ao_config_file_sdlang>> } #+END_SRC @@ -76,16 +54,7 @@ template SiSUconfigSDLangHub() { template SiSUmarkupRaw() { private import ao_rgx; - private import - std.array, - std.exception, - std.path, - std.regex, - std.stdio, - std.traits, - std.typecons, - std.utf, - std.conv : to; + <<imports_std>> mixin SiSUrgxInit; auto rgx = Rgx(); auto rawsrc = MarkupRaw(); @@ -125,7 +94,6 @@ template SiSUmarkupRaw() { return t; } } - private struct MarkupRawUnit { private import std.file; <<ao_markup_source_raw_read_file_source_string>> @@ -168,10 +136,10 @@ template SiSUmarkupRaw() { #+name: ao_config_file_in #+BEGIN_SRC d -final private string readInConfigFile(string conf_sdl) { - string dot_pwd = chainPath(to!string(environment["PWD"]), ".sisu").array; - string underscore_pwd = chainPath(to!string(environment["PWD"]), "_sisu").array; - string dot_home = chainPath(to!string(environment["HOME"]), ".sisu").array; +final string ConfigIn(C,E)(C conf_sdl, E env) { + string dot_pwd = chainPath(to!string(env["pwd"]), ".sisu").array; + string underscore_pwd = chainPath(to!string(env["pwd"]), "_sisu").array; + string dot_home = chainPath(to!string(env["home"]), ".sisu").array; string[] possible_config_path_locations = [ dot_pwd, underscore_pwd, @@ -207,7 +175,7 @@ final private string readInConfigFile(string conf_sdl) { #+name: ao_config_file_sdlang #+BEGIN_SRC d -private auto configSDLangRootTag(string configuration, string conf_sdl_filename) { +auto ConfigSDLang(string configuration, string conf_sdl_filename) { Tag sdl_root_conf; try { sdl_root_conf = parseSource(configuration); @@ -228,14 +196,55 @@ private auto configSDLangRootTag(string configuration, string conf_sdl_filename) #+END_SRC ** config file (conf.sdl & sisu_document_make) :file:config:hub: +*** config hub template + +#+BEGIN_SRC d :tangle ../src/sdp/ao_read_config_files.d +/+ + ++/ +template ConfigHub() { + <<imports_std>> + <<ao_config_file_import_sdlang>> + <<ao_config_file_sdlang_hub>> +} +#+END_SRC + +*** imports + +#+name: imports_std +#+BEGIN_SRC d +private import + std.algorithm, + std.array, + std.container, + std.exception, + std.stdio, + std.file, + std.path, + std.range, + std.regex, + std.string, + std.traits, + std.typecons, + std.uni, + std.utf, + std.conv : to; +#+END_SRC + + +*** config hub import sdlang +#+name: ao_config_file_import_mixin +#+BEGIN_SRC d +private import sdlang; +#+END_SRC + +*** config hub function #+name: ao_config_file_sdlang_hub #+BEGIN_SRC d -final private auto configSDLang(string conf_sdl) { - auto conf_get = ConfigIn(); - auto configuration = conf_get.readInConfigFile(conf_sdl); - auto conf = ConfigSDLangRootTag(); - auto sdl_root = conf.configSDLangRootTag(configuration, conf_sdl); +final auto ConfigHub(C,E)(C conf_sdl, E env) { + auto configuration = ConfigIn!()(conf_sdl, env); + auto sdl_root = ConfigSDLang!()(configuration, conf_sdl); return sdl_root; } #+END_SRC @@ -549,25 +558,3 @@ auto t = tuple( ); return t; #+END_SRC - -* figure out -** break up file here to sisu markup content and header - -break up file here to sisu markup content and header - -*** header -take master and single sst file, read in as header until the required header 0~ -keep separate (from content) for extraction of header metadata & make detail -also now may be sdlang or old sisu markup! - -*** content -from 0~ read in as content - -** what -# #+NAME: sdp_each_file_do -# #+BEGIN_SRC d -/+ ↓ read file +/ -auto conf = ConfigIn(); -auto configfile_content = - conf.sourceConfig(fn_src); -# #+END_SRC diff --git a/org/sdp.org b/org/sdp.org index 86f0c98..5077df9 100644 --- a/org/sdp.org +++ b/org/sdp.org @@ -13,8 +13,7 @@ #+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/]] -* 0. Code Skeleton / Outline / Structure (tangles) :tangle: -** TODO version.txt: set version (sisu document parser) :version: +* 0. version.txt: set version (sisu document parser) :version: #+NAME: version_txt #+BEGIN_SRC d :tangle ../views/version.txt @@ -24,15 +23,29 @@ struct Version { int minor; int patch; } -enum ver = Version(0, 12, 0); +enum ver = Version(0, 12, 1); #+END_SRC -** sdp src/sdp.d :sdp: +* 1. sdp.d (sisu document parser) :sdp: + +- deal with imports +- get options + - get command line instructions + - read config instructions +- process files as instructed by options + - read in file + - proess file + - output + +** 0. sdp src/sdp.d :sdp: #+BEGIN_SRC d :tangle ../src/sdp.d :shebang #!/usr/bin/env rdmd /+ sdp +/ +import + compile_time_info, + abstraction; <<imports_sdp>> <<imports_sdlang>> <<imports_std>> @@ -43,13 +56,12 @@ enum ver = Version(0, 12, 0); void main(string[] args) { <<sdp_mixin>> <<sdp_args>> + <<sdp_env>> <<sdp_conf_files>> foreach(fn_src; fns_src) { if (!empty(fn_src)) { <<sdp_each_file_do_scope>> - <<sdp_each_file_do_read_and_split_sisu_markup_file_content_into_header_and_body>> - <<sdp_each_file_do_split_sisu_markup_file_header_into_make_and_meta>> - <<sdp_each_file_do_document_abstraction>> + <<sdp_abstraction>> <<sdp_each_file_do_debugs_checkdoc>> <<sdp_each_file_do_selected_output>> <<sdp_each_file_do_scope_exit>> @@ -67,18 +79,7 @@ unittest { } #+END_SRC -* 1. sdp.d (sisu document parser) :sdp: - -- deal with imports -- get options - - get command line instructions - - read config instructions -- process files as instructed by options - - read in file - - proess file - - output - -** 0. pre-loop init :init: +** 1. pre-loop init :init: *** init **** imports :import: ***** sdp :sdp: @@ -87,7 +88,6 @@ unittest { #+BEGIN_SRC d /+ sdp: sisu document parser, see http://sisudoc.org +/ import - compile_time_info, ao_abstract_doc_source, ao_conf_make_meta, ao_conf_make_meta_native, @@ -189,7 +189,6 @@ mixin SiSUheaderExtractSDLang; mixin SiSUnode; mixin SiSUbiblio; mixin SiSUrgxInitFlags; -mixin SiSUconfigSDLangHub; mixin outputHub; #+END_SRC @@ -328,19 +327,28 @@ foreach(arg; args) { } #+END_SRC +**** environment :environment: + +#+NAME: sdp_env +#+BEGIN_SRC d +auto env = [ + "pwd" : environment["PWD"], + "home" : environment["HOME"], +]; +#+END_SRC + **** TODO config files (load & read) (so far only SDLang) :config:files: #+NAME: sdp_conf_files #+BEGIN_SRC d -auto conf = ConfigHub(); -auto sdl_root_configuration = conf.configSDLang("conf.sdl"); -auto sdl_root_doc_make = conf.configSDLang("sisu_document_make"); +auto sdl_root_configuration = ConfigHub!()("conf.sdl", env); +auto sdl_root_doc_make = ConfigHub!()("sisu_document_make", env); auto confsdl = HeaderExtractSDL(); auto conf_settings_aa = confsdl.configSettingsSDLangToAAmake(sdl_root_configuration); auto conf_doc_make_aa = confsdl.documentMakeSDLangToAAmake(sdl_root_doc_make); #+END_SRC -** _1a. processing: loop each file_ [+2] :loop:files: +** _2a. processing: loop each file_ [+2] :loop:files: *** scope (loop) :scope: #+NAME: sdp_each_file_do_scope @@ -369,8 +377,95 @@ enforce( ); #+END_SRC -*** 0. prepare document, _document abstraction_ -**** 0. (a) _read in raw file_ & (b) split content into: _doc header & doc content_ +*** 0. _document abstraction_ + +#+NAME: sdp_abstraction +#+BEGIN_SRC d +auto t = + SiSUabstraction!()(fn_src, _opt_action_bool, env); +static assert(!isTypeTuple!(t)); +static assert(t.length==2); +auto doc_abstraction = t[0]; +auto doc_matters = t[1]; +#+END_SRC + +*** 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 +/+ ↓ debugs +/ +debug(checkdoc) { + SiSUdebugs!()(doc_abstraction, doc_matters); +} +#+END_SRC + +**** 1. _process outputs_ :outputs: +- [[./output.org][output]] + +#+NAME: sdp_each_file_do_selected_output +#+BEGIN_SRC d +/+ ↓ output hub +/ +if (!(_opt_action_bool["skip_output"])) { + outputHub!()(doc_abstraction, doc_matters); +} +#+END_SRC + +*** scope (on loop exit) :scope:exit: + +#+NAME: sdp_each_file_do_scope_exit +#+BEGIN_SRC d +scope(exit) { + debug(checkdoc) { + writefln( + "processed file: %s", + fn_src + ); + } + // destroy(_0_header_1_body_content_2_insert_filelist_tuple); + // destroy(t); + // destroy(doc_abstraction); + // // destroy(doc_ao_make_aa); + // // destroy(doc_ao_meta_aa); + // destroy(_doc_html_segnames); + destroy(fn_src); +} +#+END_SRC + +** 2b. no filename provided +#+NAME: sdp_no_filename_provided +#+BEGIN_SRC d +/+ no recognized filename provided +/ +writeln("no recognized filename"); +break; // terminate, stop +#+END_SRC + +* 2. _document abstraction_ +** 0. abstraction + +#+BEGIN_SRC d :tangle ../src/sdp/abstraction.d +template SiSUabstraction() { + <<imports_sdp>> + <<imports_sdlang>> + <<imports_std>> + <<sdp_mixin>> + // <<sdp_conf_files>> + auto rgx = Rgx(); + auto SiSUabstraction(Fn,O,E)(Fn fn_src, O opts, E env){ + <<sdp_conf_files>> + <<sdp_each_file_do_read_and_split_sisu_markup_file_content_into_header_and_body>> + <<sdp_each_file_do_split_sisu_markup_file_header_into_make_and_meta>> + <<sdp_each_file_do_document_abstraction>> + <<sdp_each_file_do_document_matters>> + auto t = tuple(doc_abstraction, doc_matters); + static assert(t.length==2); + return t; + } +} +#+END_SRC + +** 1. (a) _read in raw file_ & (b) split content into: _doc header & doc content_ - [[./ao_read_source_files.org][ao_read_source_files]] - [[./ao_read_source_files.org][ao_read_source_files]] @@ -389,7 +484,7 @@ debug(header_and_body) { } #+END_SRC -**** 1. 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 @@ -401,28 +496,28 @@ static assert(!isTypeTuple!(_0_make_1_dochead_meta_tuple)); static assert(_0_make_1_dochead_meta_tuple.length==2); #+END_SRC -**** 2. processing: _document abstraction, tuple_ :processing: +** 3. pre-processing: _document abstraction, tuple_ :processing: - [[./ao_abstract_doc_source.org][ao_abstract_doc_source]] #+NAME: sdp_each_file_do_document_abstraction #+BEGIN_SRC d /+ ↓ document abstraction: process document, return abstraction as tuple +/ -auto t = SiSUdocAbstraction!()( +auto da = SiSUdocAbstraction!()( (_0_header_1_body_content_2_insert_filelist_tuple[1]), (_0_make_1_dochead_meta_tuple[0]), (_0_make_1_dochead_meta_tuple[1]), - _opt_action_bool + opts ); -static assert(!isTypeTuple!(t)); -static assert(t.length==3); -auto doc_abstraction = t[0]; // head ~ toc ~ contents ~ endnotes_seg ~ glossary ~ bibliography ~ bookindex ~blurb; -string[][string] _document_section_keys_sequenced = t[1]; -string[] _doc_html_segnames = t[2]; +static assert(!isTypeTuple!(da)); +static assert(da.length==3); +auto doc_abstraction = da[0]; // head ~ toc ~ contents ~ endnotes_seg ~ glossary ~ bibliography ~ bookindex ~blurb; +string[][string] _document_section_keys_sequenced = da[1]; +string[] _doc_html_segnames = da[2]; #+END_SRC -**** 3. _document matters_ (compiled from various sources) +** 4. _document matters_ (compiled from various sources) -#+NAME: sdp_each_file_do_document_abstraction +#+NAME: sdp_each_file_do_document_matters #+BEGIN_SRC d struct DocumentMatters { string[] keys_seq_seg() { @@ -454,552 +549,9 @@ struct DocumentMatters { return _k; } auto opt_action_bool() { - bool[string] _k = _opt_action_bool; + bool[string] _k = opts; return _k; } } auto doc_matters = DocumentMatters(); #+END_SRC - -*** 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 -/+ ↓ debugs +/ -debug(checkdoc) { - SiSUdebugs!()(doc_abstraction, doc_matters); -} -#+END_SRC - -**** 1. _process outputs_ :outputs: -- [[./output.org][output]] - -#+NAME: sdp_each_file_do_selected_output -#+BEGIN_SRC d -/+ ↓ output hub +/ -if (!(_opt_action_bool["skip_output"])) { - outputHub!()(doc_abstraction, doc_matters); -} -#+END_SRC - -*** scope (on loop exit) :scope:exit: - -#+NAME: sdp_each_file_do_scope_exit -#+BEGIN_SRC d -scope(exit) { - debug(checkdoc) { - writefln( - "processed file: %s", - fn_src - ); - } - destroy(_0_header_1_body_content_2_insert_filelist_tuple); - destroy(t); - destroy(doc_abstraction); - destroy(_doc_html_segnames); - destroy(fn_src); -} -#+END_SRC - -** 1b. no filename provided -#+NAME: sdp_no_filename_provided -#+BEGIN_SRC d -/+ no recognized filename provided +/ -writeln("no recognized filename"); -break; -#+END_SRC - -* Notes -** directory structure -*** program file arrangement - -#+BEGIN_SRC shell -├── 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 -#+END_SRC - -*** markup files - -#+BEGIN_SRC shell -#+END_SRC - -*** source file bundles - -#+BEGIN_SRC shell -dir structure -/tmp/_sisu_processing_/ralph/en/sisupod - ├── doc - │ └── en - └── image -#+END_SRC - -*** src dir structure & files -#+BEGIN_SRC txt :tangle no -tree /home/ralph/sisu_www/current/src/democratizing_innovation.eric_von_hippel.sst - -/home/ralph/sisu_www/current/src/ -democratizing_innovation.eric_von_hippel.sst -└── sisupod - ├── doc - │ ├── en - │ │ └── democratizing_innovation.eric_von_hippel.sst - │ └── _sisu - │ └── sisu_document_make // [interesting as part of larger conf.sdl] - └── image - ├── di_evh_f10-1.png - ├── di_evh_f11-1.png - ├── di_evh_f11-2.png - ├── di_evh_f1-1.png - ├── di_evh_f5-1.png - └── di_evh.png - -#+END_SRC - - -** document abstraction -*** terminology / glossary - -- header - - document header, containing document specific - - (i) metadata information or - - (ii) make instructions - -- (document) structure - - relationship between headings and sub-headings, and the objects they - contain. - - Document structure is extracted from - - heading levels, which are either: - - explicitly marked up, or; - - determined from a make regex provided in the document header. - Use of document structure allow for the meaningful representation of - documents in alternative ways and the use of ocn permits easy reference - across different output formats. - -- heading - - document heading, each heading is marked indicating its level (in relation - to other headings), and this is used as basis for determininge document - structure. There are 8 levels, which are can be distinguesed as being one of - three types: (i) 1 title level (marked up A or numeric 0); (ii) 3 optional - document division levels, above text separating headings (marked up B - D, - or numeric 1 to 3); (iii) 4 text headings (marked up 1 - 4, or numeric 4 - to 7) - -- levels == heading levels - - document heading level, see heading and structure - -- marked up headings / mark up level - -- collapsed headings / collapsed levels - -- numeric levels - -- dummy heading - - a markup level 1 / dummy level 4 that does not exist in the original text - that is manually inserted to maintain the documents structure rule that text - follows a heading of markup level 1 (rather than A to D) (numeric level 4 - rather than 0 to 3) - -- relatives? relations - - ancestors - - headings preceding current level under which it occurs - - decendants - - sub-headings contained beneath current level - - range of objects contained by a heading (ocn ranges for each heading in document body) - see ancestors and decendants - -- document ... - -- ancestors - - heading levels above the current heading level which it logically falls - under and to which it belongs (headings preceding current level under which - it occurs) - -- decendants - - decendant headings are sub-headings beneath the current heading level, - heading levels below the current heading level which are derived from it and - belong to it (sub-headings contained beneath current level); decendant - objects are the range of objects contained by a heading (ocn ranges for each - heading in document body) - -- (document) sections - - a document can be divided into 3 parts: front; body and; back. Front matter - includes the table of contents (which is generated from headings) and any - parts of the document that are presented before the document body (this - might include a copyright notice for example). The document body, the - substantive part of the document, all its substantive objects, including: - headings, paragraphs, tables, verse etc. This is followed by optional - backmatter: endnotes, generated from inline markup; glossary, from section - using a subset of regular markup, with an indication that section is to be - treated as glossary. Note two things glossary might do that it does not, - there is: no automatic (sorting) alphabetisation of listing; no creation of - term anchor tags (perhaps it should); bibliography, created from a specially - marked up section, with indication that section is to be treated as - bibliography; bookindex generated from dedicated markup appended to objects - providing index terms and the relevant range; blurb made up of ordinary - markup, with indication that section is to be treated as blurb - -|-----------------------+------------------------------------------+------------------------+--------| -| _header_ | | | | -|-----------------------+------------------------------------------+------------------------+--------| -| - metadata | sisu /header markup/ | markup | | -| - make instructions | | | | -|-----------------------+------------------------------------------+------------------------+--------| -| _front matter_ | | | | -|-----------------------+------------------------------------------+------------------------+--------| -| - table of contents | markup of headings | (regular content) | output | -|-----------------------+------------------------------------------+------------------------+--------| -| _body_ | | | | -|-----------------------+------------------------------------------+------------------------+--------| -| - substantive content | sisu /content markup/ | markup | output | -| | headings (providing document structure), | (regular content) | | -| | paragraphs, blocks | | | -| | blocks (code, poem, group, table) | | | -|-----------------------+------------------------------------------+------------------------+--------| -| _backmatter_ | | | | -|-----------------------+------------------------------------------+------------------------+--------| -| - 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) | | -|-----------------------+------------------------------------------+------------------------+--------| -| - blurb | | | | -|-----------------------+------------------------------------------+------------------------+--------| -| - metadata | | (from regular header) | output | -|-----------------------+------------------------------------------+------------------------+--------| - -- segment, segmented text - - certain forms of output are conveniently segmented, e.g. epub and segmented - html. The document is broken into chunks indicated by markup level 1 heading - (numeric level 4 headings) as the significant level at which the document - should be segmented, and including all decendant objects of that level. For - a longer text/book this will usually the chapter level. (this is significant - in e.g. for epub and segmented html, which are broken by segment, usually - chosen to be chapter) - -- scroll - - the document as a "scroll", e.g. as a single text file, or continuous html - document - -- object - - a unit of text. Objects include: - - headings; - - paragraphs; - - code blocks; - - grouped text; - - verse of poems; - - tables. - - Each substantive object is given an object number, that should make it citable. - -- ocn (object citation number / citation number) - - numbers assigned sequentially to each substantive object of a document. - - An ocn has the characteristic of remaining identical across output - formats. - - Translations should be prepared so number remains identical across objects - in different languages - -- citation number (see ocn / object citation number) - -- document abstraction (== internal representation) intermediate step, - - preprocessing of document, into abstraction / representation that is used by - all downstream processing, i.e. for all output formats. This allows - normalisation, reducing alternative markup options to common - representations, e.g. code blocks (open and close), tables, ways of - instructing that text be bold, shortuct way of providing and endnote - reference to a link - -- (document) internal representation (== document abstraction) - - see document abstraction - -- node representation - -- attribute (object attributes) - - when the document is abstracted attributes associated with an object, for - example for a: - - paragraph, - - indent (hang ... check & add), - - bulleted, - - code block, - - the language syntax, - - whether the block is numbered - -- inline markup - - when the document is abstracted, markup that remains embedded in the text, - such as its - - font face - - bold, - - italic, - - emphasis, - - underscore, - - strike, - - superscript, - - subscript, - - links, - - endnotes - -- sequential all objects backkeeping number? - -*** configuration (flies and command line) -**** alternative config sources - -- ./_sisu/conf.sdl -- ./_sisu/sisu_document_make -- markup document header, make section -- command line options - -**** conf.sdl -(site wide make instruction contained in same file as site configuration file) - -#+BEGIN_SRC shell -/* - name "SiSU sdl config" - author email="ralph@amissah.com" - description "site or directory wide environment defaults set here using sdlang see http://sdlang.org system environment info / resource configuration file, for sisu" - license "GPL v3 or later" - this file should be configured and live in - /etc/sisu #per environment settings, overridden by: - ~/.sisu #per user settings, overridden by: - ./_sisu/config #per local directory settings -*/ - -/* presentation/web directory, main path and subdirectories (most subdirectories are created automatically based on markup directory name) */ -// webserv \ -// url_root 'http://www.sisudoc.org' // without dir stub, e.g. this dir would map to http://www.sisudoc.org/samples -// path '~/sisu_www' // /srv/www #either (i) / [full path from root] or (ii) ~/ [home] or (iii) ./ [pwd] or (iv) will be made from home -// #path './tested' // either (i) / [full path from root] or (ii) ~/ [home] or (iii) ./ [pwd] or (iv) will be made from home -// #images 'sisu/image' -// #man 'man' -// #cgi '/usr/local/lib/sisu-cgi' -// show_output_on 'filesystem' // for -v and -u url information, alternatives: 'filesystem','webserver','remote_webserver','local:8111','localhost','localhost:8080','webrick','path' -//// show_output_on 'filesystem_url' - -// webserv_cgi \ -// host: localhost -// base_path: ~ -// port: '8081' -// user: ~ -// file_links: www.sisudoc.org - -/* processing directories, main path and subdirectories */ -// processing \ -// path= "~" \ -// dir= "_sisu_processing~" \ -// // metaverse= 'metaverse' \ -// // tune= 'tune' \ -// // latex= 'tex' \ -// // texinfo= 'texinfo' \ -// // concord_max= 400000 - -/* output_dir_structure_by: language (language_and_filetype); filetype; or filename (original v1 & v2) */ -output_dir_structure_by "language" - -/* flag - set (non-default) processing flag shortcuts -1, -2 etc. (here adding color and verbosity as default) - making color default -c is toggle, and will now toggle color off */ -flag \ - color= true \ - act0= "--digest --qrcode --text --html --epub --concordance --pdf --odf --docbook --xhtml --xml-sax --xml-dom --sqlite --manifest --verbose" \ - act1= "--digest --text --html --manifest" \ - act2= "--digest --text --html --epub --pdf --manifest" \ - act3= "--digest --qrcode --text --html --epub --concordance --pdf --manifest" \ - act4= "--digest --qrcode --text --html --epub --concordance --pdf --odf --docbook --manifest" \ - act5= "--digest --qrcode --text --html --epub --concordance --pdf --odf --docbook --sqlite --manifest" \ - act6= "--digest --qrcode --text --html --epub --concordance --pdf --odf --docbook --xhtml --xml-sax --xml-dom --sqlite --manifest" \ - act7= "--digest --qrcode --text --html --epub --concordance --pdf --odf --docbook --xhtml --xml-sax --xml-dom --sqlite --source --sisupod --manifest" \ - act8= "--digest --qrcode --text --html --epub --concordance --pdf --odf --docbook --xhtml --xml-sax --xml-dom --pg --update --manifest" \ - act9= "--digest --qrcode --text --html --epub --concordance --pdf --odf --docbook --xhtml --xml-sax --xml-dom --pg --update --source --sisupod --manifest" - -/* papersize, (LaTeX/pdf) available values: A4, US_letter, book_b5, book_a5, US_legal */ -default \ - papersize= "a4,letter" // 'a4,letter,b5,a5,legal' - -// texpdf_font 'Liberation Sans' -// texpdf_font_sans 'Liberation Sans' -// texpdf_font_serif 'Liberation Serif' -// texpdf_font_mono 'Liberation Mono' #'Inconsolata' -// text_wrap: 78 -// emphasis: 'bold' #make *{emphasis}* 'bold', 'italics' or 'underscore', default if not configured is 'bold' -// language: 'fr' -// language: 'en' -// digest: 'sha' #sha is sha256, default is md5 - -/* settings used by ssh scp */ -// remote \ -// user 'ralph' \ -// host 'www.sisudoc.org' \ -// path '/srv/www' // '/srv/sisudoc/web' // '.' #no trailing slash eg 'sisu/www' - -/* webrick information */ - -/* sql database info, postgresql */ -// db -// engine -// default 'postgresql' -// # share_source: true -// postgresql \ -// port '5432' \ -// user 'ralph' \\ '[provide username]' -// #host 'sisudoc.org' - -/* search */ -// search \ -// sisu -// flag false -// action "http://www.sisudoc.org/cgi-bin/sisu_lng_pgsql.cgi" -// #action "http://www.sisudoc.org/cgi-bin/sisu_pgsql.cgi" -// #action "http://search.sisudoc.org" -// db "current" -// title 'SiSU search form (sample)' -// html -// minitoc true -// manifest -// minitoc true -make \ - breaks="break=1" \ - home_button_text="{SiSU}http://sisudoc.org; {sources / git}http://git.sisudoc.org/gitweb/" -// footer="{SiSU}http://sisudoc.org; {sources / git}http://git.sisudoc.org/gitweb/" -// home_button_image="{sisu.png }http://sisudoc.org" - -link "{SiSU}http://sisudoc.org" -link "{sources / git}http://git.sisudoc.org/gitweb/" -#+END_SRC - -**** sisu_document_make -(site wide make instruction) - -sample -#+BEGIN_SRC shell -make \ - breaks="break=1" \ - home_button_text="{SiSU}http://sisudoc.org; {sources / git}http://git.sisudoc.org/gitweb/" -// footer="{SiSU}http://sisudoc.org; {sources / git}http://git.sisudoc.org/gitweb/" \ -// home_button_text="{sisu.png }http://sisudoc.org" \ - -links \ - link="{SiSU}http://sisudoc.org" \ - link="{sources / git}http://git.sisudoc.org/gitweb/" -#+END_SRC - -**** markup document header, make section -(document specific make instructions) - -sample - -#+BEGIN_SRC shell -% SiSU 8.0 - -title "The Wealth of Networks" \ - sub="How Social Production Transforms Markets and Freedom" \ - language="US" - -creator \ - author="Benkler, Yochai" - -date \ - published="2006-04-03" \ - created="2006-04-03" \ - issued="2006-04-03" \ - available="2006-04-03" \ - modified="2006-04-03" \ - valid="2006-04-03" - -rights \ - copyright="Copyright (C) 2006 Yochai Benkler." \ - license="All rights reserved. Subject to the exception immediately following, this book may not be reproduced, in whole or in part, including illustrations, in any form (beyond that copying permitted by Sections 107 and 108 of the U.S. Copyright Law and except by reviewers for the public press), without written permission from the publishers. http://creativecommons.org/licenses/by-nc-sa/2.5/ The author has made an online version of the book available under a Creative Commons Noncommercial Sharealike license; it can be accessed through the author's website at http://www.benkler.org." - -classify \ - topic_register="SiSU markup sample:book:discourse;networks;Internet;intellectual property:patents|copyright;intellectual property:copyright:creative commons;economics;society;copyright;patents;book:subject:information society|information networks|economics|public policy|society|copyright|patents" - -make \ - breaks="new=:B; break=1" \ - home_button_image="{won_benkler.png }http://cyber.law.harvard.edu/wealth_of_networks/Main_Page" \ - footer="{The Wealth of Networks}http://cyber.law.harvard.edu/wealth_of_networks/Main_Page; {Yochai Benkler}http://http://www.doctorow.com" -#+END_SRC - -**** hierarchy - -#+BEGIN_SRC text -./.sisu ./_sisu ~/.sisu /etc/.sisu -#+END_SRC - -*** links -**** internal -**** configure -site url base, needed e.g. for pdf documents that do not use relative links - -*** substitutions -**** configure -substitutions to occur within a document - -*** source -**** sisupod - -*** abstract document structure - -** TODO work on -*** sisu document structure - -- header - -- table of contents - - scroll #[ocn] - - seg ../[fn]/#[ocn] -- substantive contents - contents - footnotes - - seg #[ocn] - internal links - - scroll #[ocn] - - seg ../[fn]/#[ocn] -- endnotes - - scroll - - seg ../[fn]/#[ocn] -- glossary -- bibliography -- book index - - scroll #[ocn] - - seg ../[fn]/#[ocn] -- metadata - -*** read markup files -**** regular .sst -relatively straight forward -**** master .ssm -master files have been able to read in inser files .ssi and regular files .sst -***** reading in .ssi files is straightforward -***** reading in .sst files is more problematic -.sst files have their own root (structure) -either -- the root needs to be disabled - not used -or -- the root tree needs to be demoted, which is only possible if markup from - heading D is not reached then A - C could be demoted to B - D -- the other issue there is that it is common not to write out heading level A - text but to rely on the metadata for title and author, the issue there is that - at present the header for .sst files that are imported is just lopped off and - thrown away. At least the title and author information for each imported .sst - file would have to read and available for use in its header A that is demoted - to B @@ -2,9 +2,11 @@ /+ sdp +/ -/+ sdp: sisu document parser, see http://sisudoc.org +/ import compile_time_info, + abstraction; +/+ sdp: sisu document parser, see http://sisudoc.org +/ +import ao_abstract_doc_source, ao_conf_make_meta, ao_conf_make_meta_native, @@ -47,7 +49,6 @@ void main(string[] args) { mixin SiSUnode; mixin SiSUbiblio; mixin SiSUrgxInitFlags; - mixin SiSUconfigSDLangHub; mixin outputHub; /+ struct DocumentParts { @@ -161,9 +162,12 @@ void main(string[] args) { arg_unrecognized ~= " " ~ arg; } } - auto conf = ConfigHub(); - auto sdl_root_configuration = conf.configSDLang("conf.sdl"); - auto sdl_root_doc_make = conf.configSDLang("sisu_document_make"); + auto env = [ + "pwd" : environment["PWD"], + "home" : environment["HOME"], + ]; + auto sdl_root_configuration = ConfigHub!()("conf.sdl", env); + auto sdl_root_doc_make = ConfigHub!()("sisu_document_make", env); auto confsdl = HeaderExtractSDL(); auto conf_settings_aa = confsdl.configSettingsSDLangToAAmake(sdl_root_configuration); auto conf_doc_make_aa = confsdl.documentMakeSDLangToAAmake(sdl_root_doc_make); @@ -191,69 +195,12 @@ void main(string[] args) { match(fn_src, rgx.src_pth), "not a sisu markup filename" ); - /+ ↓ read file (filename with path) +/ - /+ ↓ file tuple of header and content +/ - auto _0_header_1_body_content_2_insert_filelist_tuple = - SiSUmarkupRaw!()(fn_src); - static assert(!isTypeTuple!(_0_header_1_body_content_2_insert_filelist_tuple)); - static assert(_0_header_1_body_content_2_insert_filelist_tuple.length==3); - debug(header_and_body) { - writeln(header); - writeln(_0_header_1_body_content_2_insert_filelist_tuple.length); - writeln(_0_header_1_body_content_2_insert_filelist_tuple.length[1][0]); - } - /+ ↓ split header into make and meta +/ - auto _0_make_1_dochead_meta_tuple = - SiSUheaderExtractHub!()(_0_header_1_body_content_2_insert_filelist_tuple[0], conf_doc_make_aa); - static assert(!isTypeTuple!(_0_make_1_dochead_meta_tuple)); - static assert(_0_make_1_dochead_meta_tuple.length==2); - /+ ↓ document abstraction: process document, return abstraction as tuple +/ - auto t = SiSUdocAbstraction!()( - (_0_header_1_body_content_2_insert_filelist_tuple[1]), - (_0_make_1_dochead_meta_tuple[0]), - (_0_make_1_dochead_meta_tuple[1]), - _opt_action_bool - ); + auto t = + SiSUabstraction!()(fn_src, _opt_action_bool, env); static assert(!isTypeTuple!(t)); - static assert(t.length==3); - auto doc_abstraction = t[0]; // head ~ toc ~ contents ~ endnotes_seg ~ glossary ~ bibliography ~ bookindex ~blurb; - string[][string] _document_section_keys_sequenced = t[1]; - string[] _doc_html_segnames = t[2]; - struct DocumentMatters { - string[] keys_seq_seg() { - string[] _k = _document_section_keys_sequenced["seg"]; - return _k; - } - string[] keys_seq_scroll() { - string[] _k = _document_section_keys_sequenced["scroll"]; - return _k; - } - string[] segnames() { - string[] _k = _doc_html_segnames; - return _k; - } - auto dochead_make() { - string[string][string] _k = _0_make_1_dochead_meta_tuple[0]; - return _k; - } - auto dochead_meta() { - string[string][string] _k = _0_make_1_dochead_meta_tuple[1]; - return _k; - } - auto source_filename() { - string _k = fn_src; - return _k; - } - auto file_insert_list() { - string[] _k = _0_header_1_body_content_2_insert_filelist_tuple[2]; - return _k; - } - auto opt_action_bool() { - bool[string] _k = _opt_action_bool; - return _k; - } - } - auto doc_matters = DocumentMatters(); + static assert(t.length==2); + auto doc_abstraction = t[0]; + auto doc_matters = t[1]; /+ ↓ debugs +/ debug(checkdoc) { SiSUdebugs!()(doc_abstraction, doc_matters); @@ -269,16 +216,18 @@ void main(string[] args) { fn_src ); } - destroy(_0_header_1_body_content_2_insert_filelist_tuple); - destroy(t); - destroy(doc_abstraction); - destroy(_doc_html_segnames); + // destroy(_0_header_1_body_content_2_insert_filelist_tuple); + // destroy(t); + // destroy(doc_abstraction); + // // destroy(doc_ao_make_aa); + // // destroy(doc_ao_meta_aa); + // destroy(_doc_html_segnames); destroy(fn_src); } } else { /+ no recognized filename provided +/ writeln("no recognized filename"); - break; + break; // terminate, stop } } } diff --git a/src/sdp/abstraction.d b/src/sdp/abstraction.d new file mode 100644 index 0000000..d91618e --- /dev/null +++ b/src/sdp/abstraction.d @@ -0,0 +1,121 @@ +template SiSUabstraction() { + /+ sdp: sisu document parser, see http://sisudoc.org +/ + import + ao_abstract_doc_source, + ao_conf_make_meta, + ao_conf_make_meta_native, + ao_conf_make_meta_sdlang, + ao_defaults, + ao_output_debugs, + ao_read_config_files, + ao_read_source_files, + ao_rgx, + output_hub; + /+ sdlang http://sdlang.org +/ + import sdlang; // sdlang.d + /+ std +/ + private import + std.algorithm, + std.array, + std.container, + std.exception, + std.getopt, + std.json, + std.process, + std.stdio, + std.file, + std.path, + std.range, + std.regex, + std.string, + std.traits, + std.typecons, + std.utf, + std.conv : to; + mixin SiSUrgxInit; + mixin SiSUregisters; + mixin SiSUheaderExtractSDLang; + mixin SiSUnode; + mixin SiSUbiblio; + mixin SiSUrgxInitFlags; + mixin outputHub; + // auto sdl_root_configuration = ConfigHub!()("conf.sdl", env); + // auto sdl_root_doc_make = ConfigHub!()("sisu_document_make", env); + // auto confsdl = HeaderExtractSDL(); + // auto conf_settings_aa = confsdl.configSettingsSDLangToAAmake(sdl_root_configuration); + // auto conf_doc_make_aa = confsdl.documentMakeSDLangToAAmake(sdl_root_doc_make); + auto rgx = Rgx(); + auto SiSUabstraction(Fn,O,E)(Fn fn_src, O opts, E env){ + auto sdl_root_configuration = ConfigHub!()("conf.sdl", env); + auto sdl_root_doc_make = ConfigHub!()("sisu_document_make", env); + auto confsdl = HeaderExtractSDL(); + auto conf_settings_aa = confsdl.configSettingsSDLangToAAmake(sdl_root_configuration); + auto conf_doc_make_aa = confsdl.documentMakeSDLangToAAmake(sdl_root_doc_make); + /+ ↓ read file (filename with path) +/ + /+ ↓ file tuple of header and content +/ + auto _0_header_1_body_content_2_insert_filelist_tuple = + SiSUmarkupRaw!()(fn_src); + static assert(!isTypeTuple!(_0_header_1_body_content_2_insert_filelist_tuple)); + static assert(_0_header_1_body_content_2_insert_filelist_tuple.length==3); + debug(header_and_body) { + writeln(header); + writeln(_0_header_1_body_content_2_insert_filelist_tuple.length); + writeln(_0_header_1_body_content_2_insert_filelist_tuple.length[1][0]); + } + /+ ↓ split header into make and meta +/ + auto _0_make_1_dochead_meta_tuple = + SiSUheaderExtractHub!()(_0_header_1_body_content_2_insert_filelist_tuple[0], conf_doc_make_aa); + static assert(!isTypeTuple!(_0_make_1_dochead_meta_tuple)); + static assert(_0_make_1_dochead_meta_tuple.length==2); + /+ ↓ document abstraction: process document, return abstraction as tuple +/ + auto da = SiSUdocAbstraction!()( + (_0_header_1_body_content_2_insert_filelist_tuple[1]), + (_0_make_1_dochead_meta_tuple[0]), + (_0_make_1_dochead_meta_tuple[1]), + opts + ); + static assert(!isTypeTuple!(da)); + static assert(da.length==3); + auto doc_abstraction = da[0]; // head ~ toc ~ contents ~ endnotes_seg ~ glossary ~ bibliography ~ bookindex ~blurb; + string[][string] _document_section_keys_sequenced = da[1]; + string[] _doc_html_segnames = da[2]; + struct DocumentMatters { + string[] keys_seq_seg() { + string[] _k = _document_section_keys_sequenced["seg"]; + return _k; + } + string[] keys_seq_scroll() { + string[] _k = _document_section_keys_sequenced["scroll"]; + return _k; + } + string[] segnames() { + string[] _k = _doc_html_segnames; + return _k; + } + auto dochead_make() { + string[string][string] _k = _0_make_1_dochead_meta_tuple[0]; + return _k; + } + auto dochead_meta() { + string[string][string] _k = _0_make_1_dochead_meta_tuple[1]; + return _k; + } + auto source_filename() { + string _k = fn_src; + return _k; + } + auto file_insert_list() { + string[] _k = _0_header_1_body_content_2_insert_filelist_tuple[2]; + return _k; + } + auto opt_action_bool() { + bool[string] _k = opts; + return _k; + } + } + auto doc_matters = DocumentMatters(); + auto t = tuple(doc_abstraction, doc_matters); + static assert(t.length==2); + return t; + } +} diff --git a/src/sdp/ao_read_config_files.d b/src/sdp/ao_read_config_files.d index 6308df2..2e1bca6 100644 --- a/src/sdp/ao_read_config_files.d +++ b/src/sdp/ao_read_config_files.d @@ -3,88 +3,122 @@ - read config files<BR> ao_config_files.d +/ -template SiSUconfigIn() { +template ConfigIn() { private import + std.algorithm, + std.array, + std.container, std.exception, std.stdio, + std.file, + std.path, + std.range, + std.regex, + std.string, + std.traits, + std.typecons, + std.uni, std.utf, std.conv : to; - private - struct ConfigIn { - private import std.file; - final private string readInConfigFile(string conf_sdl) { - string dot_pwd = chainPath(to!string(environment["PWD"]), ".sisu").array; - string underscore_pwd = chainPath(to!string(environment["PWD"]), "_sisu").array; - string dot_home = chainPath(to!string(environment["HOME"]), ".sisu").array; - string[] possible_config_path_locations = [ - dot_pwd, - underscore_pwd, - dot_home, - "/etc/sisu" - ]; - string config_file_str; - foreach(pth; possible_config_path_locations) { - auto conf_file = format( - "%s/%s", - pth, - conf_sdl, - ); - try { - if (exists(conf_file)) { - debug(configfile) { - writeln(conf_file); - } - config_file_str = readText(conf_file); - break; + import std.file; + final string ConfigIn(C,E)(C conf_sdl, E env) { + string dot_pwd = chainPath(to!string(env["pwd"]), ".sisu").array; + string underscore_pwd = chainPath(to!string(env["pwd"]), "_sisu").array; + string dot_home = chainPath(to!string(env["home"]), ".sisu").array; + string[] possible_config_path_locations = [ + dot_pwd, + underscore_pwd, + dot_home, + "/etc/sisu" + ]; + string config_file_str; + foreach(pth; possible_config_path_locations) { + auto conf_file = format( + "%s/%s", + pth, + conf_sdl, + ); + try { + if (exists(conf_file)) { + debug(configfile) { + writeln(conf_file); } - } - catch (ErrnoException ex) { - } - catch (FileException ex) { + config_file_str = readText(conf_file); + break; } } - return config_file_str; + catch (ErrnoException ex) { + } + catch (FileException ex) { + } } + return config_file_str; } } /+ +/ -template SiSUconfigSDLang() { - struct ConfigSDLangRootTag { - private auto configSDLangRootTag(string configuration, string conf_sdl_filename) { - Tag sdl_root_conf; - try { - sdl_root_conf = parseSource(configuration); - } - catch(ParseException e) { - stderr.writeln("SDLang problem with content for ", conf_sdl_filename); - stderr.writeln(e.msg); - } - debug(sdlang) { - Value output_dir_structure_by = sdl_root_conf.tags["output_dir_structure_by"][0].values[0]; - assert(output_dir_structure_by.type == typeid(string)); - writeln(output_dir_structure_by); - writeln("conf SDL:"); - writeln(sdl_root_conf.toSDLDocument()); - } - return sdl_root_conf; +template ConfigSDLang() { + import sdlang; + private import + std.algorithm, + std.array, + std.container, + std.exception, + std.stdio, + std.file, + std.path, + std.range, + std.regex, + std.string, + std.traits, + std.typecons, + std.uni, + std.utf, + std.conv : to; + auto ConfigSDLang(string configuration, string conf_sdl_filename) { + Tag sdl_root_conf; + try { + sdl_root_conf = parseSource(configuration); } + catch(ParseException e) { + stderr.writeln("SDLang problem with content for ", conf_sdl_filename); + stderr.writeln(e.msg); + } + debug(sdlang) { + Value output_dir_structure_by = sdl_root_conf.tags["output_dir_structure_by"][0].values[0]; + assert(output_dir_structure_by.type == typeid(string)); + writeln(output_dir_structure_by); + writeln("conf SDL:"); + writeln(sdl_root_conf.toSDLDocument()); + } + return sdl_root_conf; } } /+ +/ -template SiSUconfigSDLangHub() { - mixin SiSUconfigIn; - mixin SiSUconfigSDLang; - struct ConfigHub { - final private auto configSDLang(string conf_sdl) { - auto conf_get = ConfigIn(); - auto configuration = conf_get.readInConfigFile(conf_sdl); - auto conf = ConfigSDLangRootTag(); - auto sdl_root = conf.configSDLangRootTag(configuration, conf_sdl); - return sdl_root; - } +template ConfigHub() { + private import + std.algorithm, + std.array, + std.container, + std.exception, + std.stdio, + std.file, + std.path, + std.range, + std.regex, + std.string, + std.traits, + std.typecons, + std.uni, + std.utf, + std.conv : to; + + final auto ConfigHub(C,E)(C conf_sdl, E env) { + auto configuration = ConfigIn!()(conf_sdl, env); + auto sdl_root = ConfigSDLang!()(configuration, conf_sdl); + return sdl_root; } } diff --git a/src/sdp/ao_read_source_files.d b/src/sdp/ao_read_source_files.d index c7616a2..a6c0199 100644 --- a/src/sdp/ao_read_source_files.d +++ b/src/sdp/ao_read_source_files.d @@ -7,13 +7,19 @@ template SiSUmarkupRaw() { private import ao_rgx; private import + std.algorithm, std.array, + std.container, std.exception, + std.stdio, + std.file, std.path, + std.range, std.regex, - std.stdio, + std.string, std.traits, std.typecons, + std.uni, std.utf, std.conv : to; mixin SiSUrgxInit; @@ -55,7 +61,6 @@ template SiSUmarkupRaw() { return t; } } - private struct MarkupRawUnit { private import std.file; final private string readInMarkupSource(in char[] fn_src) { diff --git a/views/version.txt b/views/version.txt index e07f5c1..5c49588 100644 --- a/views/version.txt +++ b/views/version.txt @@ -4,4 +4,4 @@ struct Version { int minor; int patch; } -enum ver = Version(0, 12, 0); +enum ver = Version(0, 12, 1); |