aboutsummaryrefslogtreecommitdiffhomepage
path: root/lib/sisu/v3/dal.rb
blob: 79e12e2dcbd85b1415ab36cc31dd23dbdc5c08bf (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
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
# encoding: utf-8
=begin

 * Name: SiSU

 * Description: a framework for document structuring, publishing and search

 * Author: Ralph Amissah

 * Copyright: (C) 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006,
   2007, 2008, 2009, 2010, 2011, 2012 Ralph Amissah, All Rights Reserved.

 * License: GPL 3 or later:

   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 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 <http://www.gnu.org/licenses/>.

   If you have Internet connection, the latest version of the GPL should be
   available at these locations:
   <http://www.fsf.org/licensing/licenses/gpl.html>
   <http://www.gnu.org/licenses/gpl.html>

   <http://www.sisudoc.org/sisu/en/manifest/gpl.fsf.html>

 * SiSU uses:
   * Standard SiSU markup syntax,
   * Standard SiSU meta-markup syntax, and the
   * Standard SiSU object citation numbering and system

 * Hompages:
   <http://www.jus.uio.no/sisu>
   <http://www.sisudoc.org>

 * Download:
   <http://www.sisudoc.org/sisu/en/SiSU/download.html>

 * Ralph Amissah
   <ralph@amissah.com>
   <ralph.amissah@gmail.com>

 ** Description: preprocessing, (document abstraction), data abstraction used
   in subsequent processing

=end
module SiSU_DAL
  require_relative 'defaults'                           # defaults.rb
    include SiSU_Viz
  require_relative 'sysenv'                             # sysenv.rb
    include SiSU_Env
  require_relative 'param'                              # param.rb
    include SiSU_Param
  require_relative 'dal_doc_objects'                    # dal_doc_objects.rb
  require_relative 'dal_syntax'                         # dal_syntax.rb
    include SiSU_DAL_Syntax
  require_relative 'dal_doc_str'                        # dal_doc_str.rb
  require_relative 'dal_idx'                            # dal_idx.rb
  require_relative 'dal_numbering'                      # dal_numbering.rb
  require_relative 'dal_hash_digest'                    # dal_hash_digest.rb
  require_relative 'dal_endnotes'                       # dal_endnotes.rb
  require_relative 'dal_images'                         # dal_images.rb
  require_relative 'dal_metadata'                       # dal_metadata.rb
  require_relative 'dal_character_check'                # dal_character_check.rb
  require_relative 'dal_substitutions_and_insertions'   # dal_substitutions_and_insertions.rb
  require_relative 'dal_expand_insertions'              # dal_expand_insertions.rb
  require_relative 'prog_text_translation'              # prog_text_translation.rb
  require_relative 'shared_sem'                         # shared_sem.rb
  class Instantiate < SiSU_Param::Parameters::Instructions
    def initialize
      @@flag_vocab=0
      @@line_mode=''
    end
  end
  class Source <Instantiate
    @@dal_array=[]
    @@idx_arr={ sst: [], tex: [], html: [], xhtml: [] }
    @@map_arr={ nametags: [], ocn_htmlseg: [] }
    @@fns=nil
    def initialize(opt,fnx=nil)
      @opt,@fnx=opt,fnx
      @@fns||@opt.fns
      @make_fns=if @fnx and @fnx =~/\.ss[tmi]$/
        SiSU_Env::InfoFile.new(@fnx)
      else
        SiSU_Env::InfoFile.new(@opt.fns)
      end
      @fnm=@make_fns.marshal.dal_metadata
      @fnc=@make_fns.marshal.dal_content
      @idx_sst=@make_fns.marshal.dal_idx_sst_rel_html_seg
      @idx_raw=@make_fns.marshal.dal_idx_sst_rel
      @idx_html=@make_fns.marshal.dal_idx_html
      @idx_xhtml=@make_fns.marshal.dal_idx_xhtml
      @map_nametags=@make_fns.marshal.dal_map_nametags
      @map_ocn_htmlseg=@make_fns.marshal.dal_map_ocn_htmlseg
      @env=SiSU_Env::InfoEnv.new
    end
    def read                                                                   #creates dal
      begin
        dal=[]
        @@dal_array=[]
        @@fns=(@fnx && @fnx =~/\.ss[tmi]$/) \
        ? @fnx
        : @opt.fns
        create_dal
      rescue
        SiSU_Errors::InfoError.new($!,$@,@opt.cmd,@@fns).error do
          __LINE__.to_s + ':' + __FILE__
        end
      ensure
        SiSU_DAL::Instantiate.new
      end
    end
    def get                                                                    #reads dal, unless does not exist then creates first
      begin
        dal=[]
        unless @@fns==@opt.fns \
        or @@fns==@fnx
          @@fns=(@fnx && @fnx =~/\.ss[tmi]$/) \
          ? @fnx
          : @opt.fns
          @@dal_array=[]
        end
        dal=(@@dal_array.empty?) \
        ? read_fnc
        : @@dal_array.dup
      rescue
        SiSU_Errors::InfoError.new($!,$@,@opt.cmd,@opt.fns).error do
          __LINE__.to_s + ':' + __FILE__
        end
      ensure
        SiSU_DAL::Instantiate.new
      end
    end
    def get_idx_sst                                                            #reads dal idx.sst, #unless does not exist then creates first
      begin
        dal=[]
        unless @@fns==@opt.fns \
        or @@fns==@fnx
          @@fns=(@fnx && @fnx =~/\.ss[tmi]$/) \
          ? @fnx
          : @opt.fns
          @@idx_arr[:sst]=[]
        end
        dal=(@@idx_arr[:sst].empty?) ? read_idx_sst : @@idx_arr[:sst].dup #check
      rescue
        SiSU_Errors::InfoError.new($!,$@,@opt.cmd,@opt.fns).error do
          __LINE__.to_s + ':' + __FILE__
        end
      ensure
        SiSU_DAL::Instantiate.new
      end
    end
    def get_idx_raw
      begin
        dal=[]
        unless @@fns==@opt.fns \
        or @@fns==@fnx
          @@fns=(@fnx && @fnx =~/\.ss[tmi]$/) \
          ? @fnx
          : @opt.fns
          @@idx_arr[:tex]=[]
        end
        dal=(@@idx_arr[:tex].empty?) ? read_idx_raw : @@idx_arr[:tex].dup #check
      rescue
        SiSU_Errors::InfoError.new($!,$@,@opt.cmd,@opt.fns).error do
          __LINE__.to_s + ':' + __FILE__
        end
      ensure
        SiSU_DAL::Instantiate.new
      end
    end
    def get_idx_html                                                           #reads dal idx.html, #unless does not exist then creates first
      begin
        dal=[]
        unless @@fns==@opt.fns \
        or @@fns==@fnx
          @@fns=(@fnx && @fnx =~/\.ss[tmi]$/) \
          ? @fnx
          : @opt.fns
          @@idx_arr[:html]=[]
        end
        dal=(@@idx_arr[:html].empty?) ? read_idx_html : @@idx_arr[:html].dup
      rescue
        SiSU_Errors::InfoError.new($!,$@,@opt.cmd,@opt.fns).error do
          __LINE__.to_s + ':' + __FILE__
        end
      ensure
        SiSU_DAL::Instantiate.new
      end
    end
    def get_idx_xhtml                                                          #reads dal idx.xhtml, #unless does not exist then creates first
      begin
        dal=[]
        unless @@fns==@opt.fns \
        or @@fns==@fnx
          @@fns=(@fnx && @fnx =~/\.ss[tmi]$/) \
          ? @fnx
          : @opt.fns
          @@idx_arr[:xthml]=[]
        end
        dal=(@@idx_arr[:xhtml].empty?) ? read_idx_xhtml : @@idx_arr[:xhtml].dup
      rescue
        SiSU_Errors::InfoError.new($!,$@,@opt.cmd,@opt.fns).error do
          __LINE__.to_s + ':' + __FILE__
        end
      ensure
        SiSU_DAL::Instantiate.new
      end
    end
    def get_map_nametags                                                       #reads dal map.nametags, #unless does not exist then creates first
      begin
        dal=[]
        unless @@fns==@opt.fns \
        or @@fns==@fnx
          @@fns=(@fnx && @fnx =~/\.ss[tmi]$/) \
          ? @fnx
          : @opt.fns
          @@map_arr[:nametags]=[]
        end
        dal=(@@map_arr[:nametags].empty?) ? read_map_nametags : @@map_arr[:nametags].dup
      rescue
        SiSU_Errors::InfoError.new($!,$@,@opt.cmd,@opt.fns).error do
          __LINE__.to_s + ':' + __FILE__
        end
      ensure
        SiSU_DAL::Instantiate.new
      end
    end
    def get_map_ocn_htmlseg                                                    #reads dal map.ocn_htmlseg, #unless does not exist then creates first
      begin
        dal=[]
        unless @@fns==@opt.fns \
        or @@fns==@fnx
          @@fns=(@fnx && @fnx =~/\.ss[tmi]$/) \
          ? @fnx
          : @opt.fns
          @@map_arr[:ocn_htmlseg]=[]
        end
        dal=(@@map_arr[:ocn_htmlseg].empty?) ? read_map_ocn_htmlseg : @@map_arr[:ocn_htmlseg].dup
      rescue
        SiSU_Errors::InfoError.new($!,$@,@opt.cmd,@opt.fns).error do
          __LINE__.to_s + ':' + __FILE__
        end
      ensure
        SiSU_DAL::Instantiate.new
      end
    end
  protected
    def create_dal
      dal_array=[]
      unless @opt.cmd =~/q/
        tell=(@opt.cmd=~/[vVM]/) \
        ? SiSU_Screen::Ansi.new(@opt.cmd,'Document Abstraction')
        : SiSU_Screen::Ansi.new(@opt.cmd,'Document Abstraction',"[#{@opt.f_pth[:lng_is]}] #{@opt.fno}")
        tell.grey_title_hi
      end
      fn=(@fnx && @fnx =~/\.ss[tmi]$/) \
      ? @fnx
      : @opt.fns
      if @opt.fno =~/\.txz$/
        Dir.chdir(@opt.f_pth[:pth])
      end
      file_array=@env.read_source_file(fn)
      file_array.each do |l|
        if l =~/\r\n/ then l.gsub!(/\r\n/,"\n")
        end
      end
      meta=file_array.dup
      meta=meta.join.split("\n\n") #check whether can be eliminated, some of these are large objects to have twice
      @md=SiSU_Param::Parameters::Instructions.new(meta,@opt).extract
      meta=nil
      dal=SiSU_DAL::Make.new(fn,@md,file_array).song
      if @opt.cmd =~/[vM]/
        cf=SiSU_Env::CreateFile.new(fn)
        SiSU_Screen::Ansi.new(@opt.cmd,@opt.fns,"~meta/#{@opt.fns}.meta").output if @opt.cmd =~/v/i
        SiSU_Screen::Ansi.new(@opt.cmd,"dal -> #{cf.meta}").txt_grey if @opt.cmd =~/M/
      end
      dal.each {|s| dal_array << s}
      dal_array
    end
    def read_fnm
      dal=[]
      dal=if FileTest.file?(@fnm)
        (RUBY_VERSION < '1.9') \
        ? (File.open(@fnm){ |f| dal=Marshal.load(f)})
        : (File.open(@fnm,'r:utf-8'){ |f| dal=Marshal.load(f)})
      else SiSU_DAL::Source.new(@opt).create_dal
      end
    end
    def read_fnc
      dal=[]
      dal=if FileTest.file?(@fnc)
        (RUBY_VERSION < '1.9') \
        ? (File.open(@fnc){ |f| dal=Marshal.load(f)})
        : (File.open(@fnc,'r:utf-8'){ |f| dal=Marshal.load(f)})
      else SiSU_DAL::Source.new(@opt).create_dal
      end
    end
    def read_idx_sst
      m=[]
      m=if FileTest.file?(@idx_sst)
        (RUBY_VERSION < '1.9') \
        ? (File.open(@idx_sst){ |f| m=Marshal.load(f)})
        : (File.open(@idx_sst,'r:utf-8'){ |f| m=Marshal.load(f)})
      else nil
      end
    end
    def read_idx_raw
      m=[]
      m=if FileTest.file?(@idx_raw)
        (RUBY_VERSION < '1.9') \
        ? (File.open(@idx_raw){ |f| m=Marshal.load(f)})
        : (File.open(@idx_raw,'r:utf-8'){ |f| m=Marshal.load(f)})
      else nil
      end
    end
    def read_idx_html
      m=[]
      m=if FileTest.file?(@idx_html)
        (RUBY_VERSION < '1.9') \
        ? (File.open(@idx_html){ |f| m=Marshal.load(f)})
        : (File.open(@idx_html,'r:utf-8'){ |f| m=Marshal.load(f)})
      else nil
      end
    end
    def read_idx_xhtml
      m=[]
      m=if FileTest.file?(@idx_xhtml)
        (RUBY_VERSION < '1.9') \
        ? (File.open(@idx_xhtml){ |f| m=Marshal.load(f)})
        : (File.open(@idx_xhtml,'r:utf-8'){ |f| m=Marshal.load(f)})
      else nil
      end
    end
    def read_map_nametags
      m=[]
      m=if FileTest.file?(@map_nametags)
        (RUBY_VERSION < '1.9') \
        ? (File.open(@map_nametags){ |f| m=Marshal.load(f)})
        : (File.open(@map_nametags,'r:utf-8'){ |f| m=Marshal.load(f)})
      else nil
      end
    end
    def read_map_ocn_htmlseg
      m=[]
      m=if FileTest.file?(@map_ocn_htmlseg)
        (RUBY_VERSION < '1.9') \
        ? (File.open(@map_ocn_htmlseg){ |f| m=Marshal.load(f)})
        : (File.open(@map_ocn_htmlseg,'r:utf-8'){ |f| m=Marshal.load(f)})
      else nil
      end
    end
  end
  class Output
    def initialize(fn,md,data)
      @fn,@md,@data=fn,md,data
      @cf=SiSU_Env::CreateFile.new(@fn)
      @make=SiSU_Env::InfoFile.new(@fn)
      @dir=SiSU_Env::InfoEnv.new(@fn)
    end
    def screen_dump(o)
      if defined? o.of
        print %{OF: #{o.of}; }
      end
      if defined? o.is
        print %{IS: #{o.is.to_s}; }
      end
      if defined? o.ocn
        print %{OCN: #{o.ocn}; }
      end
      if defined? o.node
        print %{NODE: #{o.node}; }
      end
      if defined? o.parent
        print %{Parent: #{o.parent}; }
      end
      if defined? o.obj and not o.obj.empty?
        puts %{\n#{o.obj}; }
      else "\n"
      end
    end
    def screen_print(t_o)
      if defined? t_o
        print ' ' + t_o.to_s
      end
    end
    def screen_output(data)
      data.each do |o|
        print o.class
        screen_print(o.ocn)
        screen_print(o.obj)
        puts "\n"
      end
    end
    def hard_output
      if @md.opt.cmd =~/M/
        filename_meta=@cf.metaverse.file_meta
        @data.each {|o| filename_meta.puts o.inspect.sub(/:0x[0-9a-f]{8}\s/,': ')} #to make diffing easier
        filename_txt=@cf.metaverse.file_txt
        @data.each do |o|
          if defined? o.ocn
            filename_txt.puts case o.is
            when :heading
              "[#{o.is.to_s} #{o.lv}~#{o.name} [#{o.ocn}]] #{o.obj}"
            else "[#{o.is.to_s} [#{o.ocn}]] #{o.obj}"
            end
          else
            filename_txt.puts case o.is
            when :meta
              "[m~#{o.tag}] #{o.obj}"
            else "[#{o.is.to_s}] #{o.obj}"
            end
          end
        end
        filename_debug=@cf.file_debug
        @data.each do |o|
          if defined? o.ocn
            case o.is
            when :heading
              filename_debug.puts "#{o.is.to_s} #{o.lv}~#{o.name} odv=#{o.odv} osp=#{o.osp} [#{o.ocn}] -->\n\t#{o.obj}"
            end
          end
        end
      else
        hard="#{@dir.processing_path.dal}/#{@md.fns}.meta"
        File.unlink(hard) if FileTest.file?(hard)
        hard="#{@dir.processing_path.dal}/#{@md.fns}.txt"
        File.unlink(hard) if FileTest.file?(hard)
        hard="#{@dir.processing_path.dal}/#{@md.fns}.debug.txt"
        File.unlink(hard) if FileTest.file?(hard)
      end
    end
    def make_marshal_content
      marshal_dal=@make.marshal.dal_content
      File.open(marshal_dal,'w'){|f| Marshal.dump(@data,f)} if @data.class==Array
    end
    def make_marshal_metadata
      marshal_dal=@make.marshal.dal_metadata
      File.open(marshal_dal,'w'){|f| Marshal.dump(@data,f)} if @data.class==Array
    end
    def idx_html_hard_output
      if @md.book_idx \
      and @md.opt.cmd =~/M/
        filename_meta=@cf.file_meta_idx_html
        unless @data.nil? #REMOVE earliest possible
          @data.each {|s| p s.inspect + "\n" unless s.class==String}
          @data.each {|s| filename_meta.puts s.strip + "\n" unless s.strip.empty?}
        end
      else
        hard_idx_html="#{@dir.processing_path.dal}/#{@md.fns}.idx.html"
        File.unlink(hard_idx_html) if FileTest.file?(hard_idx_html)
      end
    end
    def make_marshal_idx_sst_html_seg
      marshal_dal=@make.marshal.dal_idx_sst_rel_html_seg
      File.open(marshal_dal,'w'){|f| Marshal.dump(@data,f)} if @data.class==Array
    end
    def make_marshal_idx_sst_rel
      marshal_dal=@make.marshal.dal_idx_sst_rel
      File.open(marshal_dal,'w'){|f| Marshal.dump(@data,f)} if @data.class==Array
    end
    def make_marshal_idx_html
      marshal_dal=@make.marshal.dal_idx_html
      File.open(marshal_dal,'w'){|f| Marshal.dump(@data,f)} if @data.class==Array
    end
    def make_marshal_idx_xhtml
      marshal_dal=@make.marshal.dal_idx_xhtml
      File.open(marshal_dal,'w'){|f| Marshal.dump(@data,f)} if @data.class==Array
    end
    def make_marshal_map_nametags
      marshal_dal=@make.marshal.dal_map_nametags
      File.open(marshal_dal,'w'){|f| Marshal.dump(@data,f)} if @data.class==Hash
    end
    def make_marshal_map_name_ocn_htmlseg
      marshal_dal=@make.marshal.dal_map_ocn_htmlseg
      File.open(marshal_dal,'w'){|f| Marshal.dump(@data,f)} if @data.class==Hash
    end
  end
  class Make
    def initialize(fn,md,data)
      @fn,@md,@data=fn,md,data
      @env=SiSU_Env::InfoEnv.new(@md.fns)
    end
    def reset
      @@flag_vocab=0
      @@line_mode=''
    end
    def song
      reset
      data=@data
      data=data.join.split("\n\n")
      data=SiSU_DAL_Insertions::Insertions.new(@md,data).expand_insertions?                                              # dal_expand_insertions.rb
      data=SiSU_DAL_SubstituteAndInsert::SI.new(@md,data).substitutions_and_insertions?                                  # dal_substitutions_and_insertions.rb
      data,metadata=SiSU_DAL_DocumentStructureExtract::Build.new(@md,data).identify_parts                                # dal_doc_str.rb
      data=SiSU_DAL_Syntax::Markup.new(@md,data).songsheet                                                               # dal_syntax.rb
      data,endnote_array=SiSU_DAL_CharacterCheck::Check.new(data).character_check_and_oldstyle_endnote_array             # dal_character_check.rb
      data=SiSU_DAL_Images::Images.new(@md,data).images                                                                  # dal_images.rb
      data,tags_map,ocn_html_seg_map=SiSU_DAL_Numbering::Numbering.new(@md,data).numbering_song                          # dal_numbering.rb
      data,book_index_rel,book_index_rel_html_seg,html_idx,xhtml_idx=SiSU_DAL_BookIndex::BookIndex.new(@md,data,@env).indexing_song if @md.book_idx  # dal_idx.rb
      data=SiSU_DAL_Endnotes::Endnotes.new(@md,data,endnote_array).endnotes                                              # dal_endnotes.rb
      outputdata=data
      if @md.opt.cmd =~/[mM]/
        SiSU_DAL::Output.new(@fn,@md,outputdata).hard_output
        SiSU_DAL::Output.new(@fn,@md,outputdata).make_marshal_content
        SiSU_DAL::Output.new(@fn,@md,metadata).make_marshal_metadata
        SiSU_DAL::Output.new(@fn,@md,html_idx).idx_html_hard_output
        SiSU_DAL::Output.new(@fn,@md,book_index_rel_html_seg).make_marshal_idx_sst_html_seg
        SiSU_DAL::Output.new(@fn,@md,book_index_rel).make_marshal_idx_sst_rel
        SiSU_DAL::Output.new(@fn,@md,html_idx).make_marshal_idx_html
        SiSU_DAL::Output.new(@fn,@md,xhtml_idx).make_marshal_idx_xhtml
        SiSU_DAL::Output.new(@fn,@md,tags_map).make_marshal_map_nametags
        SiSU_DAL::Output.new(@fn,@md,ocn_html_seg_map).make_marshal_map_name_ocn_htmlseg
      end
      reset
      outputdata
    end
  protected
  end
end
__END__