rdtool 0.6.38 → 0.6.39

data/bin/rdswap.rb

@@ -1,102 +1,151 @@
-#! /usr/bin/ruby1.9.1 -s
+#!/usr/bin/env ruby
 #######
 # rdswap.rb (c) C.Hintze <c.hintze@gmx.net> 30.08.1999
 #######
 
+require "optparse"
 
-require "ostruct";
-
-if ARGV.size < 2 and not ($h or $help)
-    print "Wrong # of paramter! Use `-h' for help.\n";
-    exit 1;
-elsif $h or $help
-    print eval('"'+DATA.read+'"');
-    exit 0;
-end   
-
-srcfile = ARGV.select{|fn| fn =~ /\.rb$/o};
-case srcfile.size
-when 0
-    $stderr.print "Warning: No `.rb' file given! Take first file as source.\n";
-    srcfile = ARGV[0];
-when 1
-    srcfile = srcfile[0];
-else
-    print "Sorry! Only one source file (`.rb') allowed!\n";
-    exit(1);
-end
+RDDocumentBlock = Struct.new(:kind, :lines)
 
-docs = {};
-srcs = {};
-
-rddoc, rddocs = nil, [];
-source, sources = [], [[]];
-
-while gets
-    lang = $1 if File::basename(String($<)) =~ /^.*?([^.]+)$/o;
-    if /^=begin/o .. /^=end/o
-        title = $2 if /^=begin(\s+(.*))?$/o;
-        unless rddoc.nil?
-            unless /^=end/o
-                rddoc.lines << $_;
-            else
-                rddocs << rddoc;
-            	sources << [];
-                rddoc = nil;
-            	title = nil;
-            end
-        else               # New RD block found! Instantiate data container.
-            rddoc = OpenStruct.new
-            rddoc.kind, rddoc.lines = title, [];
-        end
-    else                   # It is not a RD block means, it is a source line!
-        sources[-1] << $_;
+class RDSwap
+  def initialize(argv, stdout: $stdout, stderr: $stderr)
+    @argv = argv.dup
+    @stdout = stdout
+    @stderr = stderr
+    @verbose = false
+  end
+
+  def run
+    parse_options!
+
+    if @argv.size < 2
+      @stdout.print("Wrong # of paramter! Use `-h' for help.\n")
+      return 1
     end
-    if $<.eof?             # One file finished. Remember data and proceed.
-        docs[lang] = rddocs;
-        srcs[lang] = sources;
-        rddoc, rddocs = nil, [];
-        source, sources = [], [[]];
+
+    source_file = detect_source_file(@argv)
+    docs, srcs = load_documents(@argv)
+
+    source_blocks = srcs["rb"]
+    source_docs = docs["rb"]
+    raise "No source file content found." unless source_blocks && source_docs
+
+    (docs.keys - ["rb"]).each do |lang|
+      write_translation(source_file, lang, source_blocks, source_docs, docs[lang])
+    end
+
+    0
+  end
+
+  private
+
+  def parse_options!
+    OptionParser.new do |opts|
+      opts.on("-h", "--help") do
+        @stdout.print(help_text)
+        raise SystemExit.new(0)
+      end
+
+      opts.on("-v", "--verbose") do
+        @verbose = true
+      end
+    end.parse!(@argv)
+  end
+
+  def help_text
+    HELP_TEXT % { program_name: File.basename($PROGRAM_NAME) }
+  end
+
+  def detect_source_file(paths)
+    source_files = paths.select { |path| path.end_with?(".rb") }
+    case source_files.size
+    when 0
+      @stderr.print "Warning: No `.rb' file given! Take first file as source.\n"
+      paths.first
+    when 1
+      source_files.first
+    else
+      @stdout.print "Sorry! Only one source file (`.rb') allowed!\n"
+      raise SystemExit.new(1)
+    end
+  end
+
+  def load_documents(paths)
+    docs = {}
+    srcs = {}
+
+    paths.each do |path|
+      lang = File.basename(path).split(".").last
+      docs[lang], srcs[lang] = parse_file(path)
     end
-end
 
-langs = docs.keys;
-langs.delete("rb");        # `rb' is not a language but the script!
-source = srcs["rb"];       # Assign it for preventing later look-ups
-srcdoc = docs["rb"];
-sourcesize = source.size;  # Do not recalculate size again and again.
-srcdocsize = srcdoc.size;
-
-for lang in langs
-    docblk = docs[lang];
-	max = [sourcesize, srcdocsize, docblk.size].max;
-    filename = File.join(srcfile+"."+lang);
-    open(filename, "w+") do |fd|
-        j = 0;
-        for i in 0...max   # Goto every block; be it source or RD.
-            fd.print source[i].join unless source[i].nil? || source[i].empty?;
-            sblk, dblk = srcdoc[i], docblk[j];
-            blk = (dblk and (dblk.kind == sblk.kind)) ? dblk : sblk;
-			next unless blk;
-            j += 1 if blk == dblk;
-            fd.print "=begin #{blk && blk.kind}\n", blk.lines.join, "=end\n";
+    [docs, srcs]
+  end
+
+  def parse_file(path)
+    rddocs = []
+    sources = [[]]
+    current_doc = nil
+
+    File.foreach(path) do |line|
+      if current_doc
+        if line.start_with?("=end")
+          rddocs << current_doc
+          sources << []
+          current_doc = nil
+        else
+          current_doc.lines << line
         end
+        next
+      end
+
+      if (match = /\A=begin(?:\s+(.*))?\s*\z/.match(line))
+        current_doc = RDDocumentBlock.new(match[1], [])
+      else
+        sources[-1] << line
+      end
     end
-    print "File `#{filename}' created.\n" if $v;
-end
 
-exit(0);
+    [rddocs, sources]
+  end
+
+  def write_translation(source_file, lang, source_blocks, source_docs, translated_docs)
+    max = [source_blocks.size, source_docs.size, translated_docs.size].max
+    output_path = "#{source_file}.#{lang}"
+
+    File.open(output_path, "w") do |fd|
+      translated_index = 0
+
+      (0...max).each do |i|
+        fd.print(source_blocks[i].join) if source_blocks[i] && !source_blocks[i].empty?
+
+        source_doc = source_docs[i]
+        translated_doc = translated_docs[translated_index]
+        block = if source_doc && translated_doc && translated_doc.kind == source_doc.kind
+                  translated_index += 1
+                  translated_doc
+                else
+                  source_doc
+                end
+        next unless block
+
+        fd.print "=begin #{block.kind}\n", block.lines.join, "=end\n"
+      end
+    end
 
-__END__
+    @stdout.print "File `#{output_path}' created.\n" if @verbose
+  end
+end
 
+HELP_TEXT = <<~TEXT
 Purpose:
    This tool is written to support you to write multi-language documents
    using the Ruby-Document-Format (RD).
 
    The idea for such a tool was originated by
-   
-   		Minero Aoki <aamine@dp.u-netsurf.ne.jp>,
-		
+
+                Minero Aoki <aamine@dp.u-netsurf.ne.jp>,
+
    how has thought about, how to make life easier for developers who have to
    write and maintain scripts in more than one language.
 
@@ -142,10 +191,10 @@ How does it work?
          blub blub
         =end
         :
-   
+
    the first block would be of type `nil' and the second one of type `whatever
    or not'.
-   
+
    Block types are important for the translation. If a source will be
    generated from a script and a translation file, only these blocks are taken
    from the translation files, that comes in the right sequence *and* contains
@@ -188,9 +237,9 @@ How does it work?
 
    That means, if the first block of `sample.de' would be of type e.g. `Never
    match', then no block would ever be taken to replace anyone of `sample.rb'.
-   
+
 Syntax:
-   #{File::basename $0} [-h|-v] <filename>...
+   %{program_name} [-h|-v] <filename>...
 
 Whereby:
    -h  shows this help text.
@@ -198,10 +247,17 @@ Whereby:
    <filename>  Means a file, that contains RD and/or Ruby code.
 
 Examples:
-   #{File::basename $0} -v sample.rb sample.ja sample.de
-   #{File::basename $0} -v sample.ja sample.rb sample.de
-   #{File::basename $0} -v sample.ja sample.de sample.rb
-   #{File::basename $0} -v sample.??
+   %{program_name} -v sample.rb sample.ja sample.de
+   %{program_name} -v sample.ja sample.rb sample.de
+   %{program_name} -v sample.ja sample.de sample.rb
+   %{program_name} -v sample.??
 
 Author:
    Clemens Hintze <c.hintze@gmx.net>.
+TEXT
+
+begin
+  exit(RDSwap.new(ARGV).run)
+rescue SystemExit => e
+  raise e
+end

data/lib/rd/filter.rb

@@ -192,7 +192,7 @@ module RD
     
     alias tell pos
     
-    def << (arg)
+    def <<(arg)
       begin
 	@content << arg.to_s
 	self

data/lib/rd/rd2html-ext-opt.rb

@@ -7,7 +7,7 @@ Licence: Ruby's License or GPL-2+
 =end
 require 'rd/rd2html-opt'
 
-q = ARGV.options
+q = $RD2_OptionParser || ARGV.options
 
 q.on_tail("--ref-extension") do
   $Visitor.opt_ref_extension = true

data/lib/rd/rd2html-opt.rb

@@ -4,7 +4,7 @@ sub-OptionParser for rd2html-lib.rb.
 =end
 require "optparse"
 
-q = ARGV.options
+q = $RD2_OptionParser || ARGV.options
 
 q.on_tail("rd2html-lib options:")
 
@@ -63,5 +63,3 @@ q.on_tail("--html-link-rev=REV",
   end
 end
 
-
-

data/lib/rd/rd2html5-lib.rb

@@ -0,0 +1,118 @@
+=begin
+= rd2html5-lib.rb
+=end
+
+require "rd/rd2html-lib"
+
+module RD
+  class RD2HTML5Visitor < RD2HTMLVisitor
+    SYSTEM_NAME = "RDtool -- RD2HTML5Visitor"
+    SYSTEM_VERSION = "$Version: " + RD::VERSION + "$"
+    VERSION = Version.new_from_version_string(SYSTEM_NAME, SYSTEM_VERSION)
+
+    def self.version
+      VERSION
+    end
+
+    def xml_decl
+      nil
+    end
+    private :xml_decl
+
+    def apply_to_DocumentElement(element, content)
+      ret = ""
+      ret << doctype_decl + "\n"
+      ret << html_open_tag + "\n"
+      ret << html_head + "\n"
+      ret << html_body(content) + "\n"
+      ret << "</html>\n"
+      ret
+    end
+
+    def doctype_decl
+      "<!DOCTYPE html>"
+    end
+    private :doctype_decl
+
+    def html_open_tag
+      lang_attr = %[ lang="#{@lang}"] if @lang
+      %|<html#{lang_attr}>|
+    end
+    private :html_open_tag
+
+    def html_content_type
+      %Q[<meta charset="#{@charset}">] if @charset
+    end
+    private :html_content_type
+
+    def apply_to_Headline(element, title)
+      anchor = get_anchor(element)
+      label = hyphen_escape(element.label)
+      title = title.join("")
+      %Q[<h#{element.level} id="#{anchor}">#{title}</h#{element.level}>] +
+        %Q[<!-- RDLabel: "#{label}" -->]
+    end
+
+    def apply_to_DescListItem(element, term, description)
+      anchor = get_anchor(element.term)
+      label = hyphen_escape(element.label)
+      term = term.join("")
+      if description.empty?
+        %Q[<dt id="#{anchor}">#{term}</dt><!-- RDLabel: "#{label}" -->]
+      else
+        %Q[<dt id="#{anchor}">#{term}</dt><!-- RDLabel: "#{label}" -->\n] +
+          %Q[<dd>\n#{description.join("\n").chomp}\n</dd>]
+      end
+    end
+
+    def apply_to_MethodListItem(element, term, description)
+      term = parse_method(term)
+      anchor = get_anchor(element.term)
+      label = hyphen_escape(element.label)
+      if description.empty?
+        %Q[<dt id="#{anchor}"><code>#{term}</code></dt><!-- RDLabel: "#{label}" -->]
+      else
+        %Q[<dt id="#{anchor}"><code>#{term}</code></dt><!-- RDLabel: "#{label}" -->\n] +
+          %Q[<dd>\n#{description.join("\n")}</dd>]
+      end
+    end
+
+    def apply_to_Index(element, content)
+      tmp = []
+      element.each do |i|
+        tmp.push(i) if i.is_a?(String)
+      end
+      key = meta_char_escape(tmp.join(""))
+      if @index.has_key?(key)
+        %Q[<!-- Index, but conflict -->#{content.join("")}<!-- Index end -->]
+      else
+        num = @index[key] = @index.size
+        anchor = a_name("index", num)
+        %Q[<span id="#{anchor}">#{content.join("")}</span>]
+      end
+    end
+
+    def apply_to_Footnote(element, content)
+      num = get_footnote_num(element)
+      raise ArgumentError, "[BUG?] #{element} is not registered." unless num
+
+      add_foottext(num, content)
+      anchor = a_name("footmark", num)
+      href = a_name("foottext", num)
+      %Q|<a id="#{anchor}" href="##{href}"><sup><small>*#{num}</small></sup></a>|
+    end
+
+    def apply_to_Foottext(element, content)
+      num = get_footnote_num(element)
+      raise ArgumentError, "[BUG] #{element} isn't registered." unless num
+      anchor = a_name("foottext", num)
+      href = a_name("footmark", num)
+      content = content.join("")
+      %|<a id="#{anchor}" href="##{href}"><sup><small>*#{num}</small></sup></a>| +
+        %|<small>#{content}</small><br>|
+    end
+  end
+end
+
+$Visitor_Class = RD::RD2HTML5Visitor
+$RD2_Sub_OptionParser = "rd/rd2html-opt"

data/lib/rd/rd2man-lib.rb

@@ -28,10 +28,13 @@ module RD
     OUTPUT_SUFFIX = "1"
     INCLUDE_SUFFIX = ["1"]
 
+    attr_accessor :man_section
+
     def initialize
       @enumcounter = 0
       @index = {}
       @filename = nil
+      @man_section = OUTPUT_SUFFIX
     end
 
     def visit(tree)
@@ -45,7 +48,7 @@ module RD
       title = title.sub(/\.rd$/i, '').upcase
       <<"EOT"
 .\\" DO NOT MODIFY THIS FILE! it was generated by rd2
-.TH #{title} 1 "#{Time.now.strftime '%B %Y'}"
+.TH #{title} #{output_suffix} "#{Time.now.strftime '%Y-%m-%d'}"
 #{content}
 EOT
     end # "
@@ -60,13 +63,25 @@ EOT
     def apply_to_TextBlock(element, content)
       if RD::DescListItem === element.parent ||
           RD::ItemListItem === element.parent ||
-          RD::EnumListItem === element.parent
+          RD::EnumListItem === element.parent ||
+          first_textblock_in_section?(element)
         return content.join
       else
         return ".PP\n" + content.join
       end
     end
 
+    def first_textblock_in_section?(element)
+      parent = element.parent
+      return false unless parent.respond_to?(:children)
+
+      index = parent.children.index(element)
+      return false unless index && index > 0
+
+      parent.children[index - 1].is_a?(Headline)
+    end
+    private :first_textblock_in_section?
+
     def apply_to_Verbatim(element)
       content = []
       element.each_line do |i|
@@ -105,21 +120,21 @@ EOT
     end
 
     def apply_to_DescListItem(element, term, description)
-      anchor = refer(element)
+      refer(element)
       if description.empty?
-        ".TP\n.fi\n.B\n#{term.join(" ")}"
+        ".TP\n.B\n#{term.join(" ")}"
       else
-        %[.TP\n.fi\n.B\n#{term.join(" ")}\n#{description.join("\n")}].chomp
+        %[.TP\n.B\n#{term.join(" ")}\n#{description.join("\n")}].chomp
       end
     end
 
     def apply_to_MethodListItem(element, term, description)
       term = parse_method(term)  # maybe: term -> element.term
-      anchor = refer(element)
+      refer(element)
       if description.empty?
-        ".TP\n.fi\n.B\n#{term.join(" ")}"
+        ".TP\n.B\n#{term.join(" ")}"
       else
-        %[.TP\n.fi\n.B\n#{term.join(" ")}\n#{description.join("\n")}]
+        %[.TP\n.B\n#{term.join(" ")}\n#{description.join("\n")}]
       end
     end
 
@@ -181,7 +196,7 @@ EOT
         # warning?
         ""
       else
-        num = @index[key] = @index.size
+        @index[key] = @index.size
         %{\\&\\fB#{content.join.sub(/\./, '\\.')}\\fP}
       end
     end
@@ -230,17 +245,27 @@ EOT
     private :meta_char_escape
 
     def guess_title
-      return @input_filename unless @input_filename == "-"
-      return @filename if @filename
-      "Untitled"
+      path = if @input_filename != "-"
+               @input_filename
+             elsif @filename
+               @filename
+             end
+      return "Untitled" unless path
+
+      File.basename(path).sub(/\.[^.]+\z/, "")
     end
     private :guess_title
 
+    def output_suffix
+      @man_section || OUTPUT_SUFFIX
+    end
+
 
   end # RD2MANVisitor
 end # RD
 
 $Visitor_Class = RD::RD2MANVisitor
+$RD2_Sub_OptionParser = "rd/rd2man-opt"
 
 =begin
 == script info.

data/lib/rd/rd2man-opt.rb

@@ -0,0 +1,16 @@
+=begin
+= rd2man-opt.rb
+sub-OptionParser for rd2man-lib.rb.
+=end
+
+require "optparse"
+
+q = $RD2_OptionParser || ARGV.options
+
+q.on_tail("rd2man-lib options:")
+
+q.on_tail("--man-section=SECTION",
+          String,
+          "use SECTION as the man page section") do |section|
+  $Visitor.man_section = section
+end

data/lib/rd/rdblockparser.ry

@@ -466,7 +466,6 @@ end
 private :set_term_to_element
 
 def on_error( et, ev, _values )
-  line = @src[@i]
   prv, cur, nxt = format_line_num(@i, @i+1, @i+2)
   
   raise ParseError, <<Msg