bitclust-core 0.5.0

data/tools/bc-preproc.rb

@@ -0,0 +1,42 @@
+#!/usr/bin/env ruby
+
+require 'pathname'
+
+bindir = Pathname.new(__FILE__).realpath.dirname
+$LOAD_PATH.unshift((bindir + '../lib').realpath)
+
+require 'bitclust/rrdparser'
+require 'optparse'
+
+def main
+  params = {"version" => "1.9.0"}
+  parser = OptionParser.new
+  parser.banner = "Usage: #{File.basename($0, '.*')} <file>..."
+  parser.on('--param=KVPAIR', 'Set parameter by key/value pair.') {|kv|
+    k, v = kv.split('=', 2)
+    params[k] = v
+  }
+  parser.on('--help', 'Prints this message and quit.') {
+    puts parser.help
+    exit
+  }
+  begin
+    parser.parse!
+  rescue OptionParser::ParseError => err
+    $stderr.puts err.message
+    exit 1
+  end
+
+  ARGV.each do |path|
+    File.open(path) {|f|
+      BitClust::Preprocessor.wrap(f, params).each do |line|
+        puts line
+      end
+    }
+  end
+rescue BitClust::WriterError => err
+  $stderr.puts err.message
+  exit 1
+end
+
+main

data/tools/bc-rdoc.rb

@@ -0,0 +1,343 @@
+#!/usr/bin/env ruby
+#
+# bc-rdoc.rb -- handle rdoc (ri) database.
+#
+# "bc-rdoc history" code is derived from bc-history.rb, posted in
+# [ruby-reference-manual:150] by moriq.
+#
+
+require 'pathname'
+
+srcdir_root = Pathname.new(__FILE__).realpath.dirname.parent.cleanpath
+$LOAD_PATH.unshift srcdir_root + 'lib'
+
+require 'bitclust'
+require 'bitclust/ridatabase'
+require 'rdoc/ri/ri_reader'
+require 'rdoc/ri/ri_cache'
+require 'rdoc/ri/ri_paths'
+require 'rdoc/markup/simple_markup/fragments'
+require 'stringio'
+require 'pp'
+require 'optparse'
+
+class ApplicationError < StandardError; end
+class RiClassNotFound < ApplicationError; end
+
+def main
+  Signal.trap(:PIPE) { exit 1 } rescue nil   # Win32 does not have SIGPIPE
+  Signal.trap(:INT) { exit 1 }
+
+  parser = OptionParser.new
+  parser.banner = <<-EndUsage
+Usage: #{File.basename($0)} (list|diff|history) [options]
+
+Subcommands:
+    list        List methods stored in ri database.
+    diff        Compare between BitClust and ri database.
+    history     Show class/method history stored in ri database.
+
+Global Options:
+EndUsage
+  parser.on('--help', 'Prints this message and quit.') {
+    puts parser.help
+    exit 0
+  }
+  begin
+    parser.order!
+  rescue OptionParser::ParseError => err
+    $stderr.puts err.message
+    $stderr.puts parser.help
+    exit 1
+  end
+
+  subcommands = {
+    'list'    => ListCommand.new,
+    'diff'    => DiffCommand.new,
+    'history' => HistoryCommand.new
+  }
+  subcommands['hist'] = subcommands['history']
+  unless ARGV[0]
+    $stderr.puts 'no subcommand given'
+    $stderr.puts parser.help
+    exit 1
+  end
+  unless subcommands.key?(ARGV[0])
+    $stderr.puts "unknown subcommand: #{ARGV[0].inspect}"
+    $stderr.puts parser.help
+    exit 1
+  end
+  sub = subcommands[ARGV.shift]
+  begin
+    sub.parse ARGV
+  rescue OptionParser::ParseError => err
+    $stderr.puts err.message
+    $stderr.puts sub.parser.help
+    exit 1
+  end
+  sub.exec
+rescue Errno::EPIPE
+  exit 1
+rescue ApplicationError, BitClust::UserError => err
+  $stderr.puts err.message
+  exit 1
+end
+
+
+class Subcommand
+
+  def open_ri_database(prefix)
+    if prefix
+      RiDatabase.open(prefix, nil)
+    else
+      RiDatabase.open_system_db
+    end
+  end
+
+end
+
+
+class ListCommand < Subcommand
+
+  def initialize
+    @prefix = nil
+    @type = :name
+    @parser = OptionParser.new
+    @parser.banner = "Usage: #{File.basename($0, '.*')} list"
+    @parser.on('--ri-database=PREFIX', 'Ri database prefix') {|path|
+      @prefix = path
+    }
+    @parser.on('-c', '--content', 'Prints method description') {
+      @type = :content
+    }
+    @parser.on('--help', 'Prints this message and quit.') {
+      puts @parser.help
+      exit 0
+    }
+  end
+
+  attr_reader :parser
+
+  def parse(argv)
+    @parser.parse! argv
+    unless argv.size == 1
+      $stderr.puts "class name not given"
+      exit 1
+    end
+    @classname = argv[0]
+    @ri = open_ri_database(@prefix)
+  end
+
+  def exec
+    c = @ri.lookup_class(@classname)
+    case @type
+    when :name
+      c.method_entries.each do |m|
+        puts m.fullname
+      end
+    when :content
+      fmt = Formatter.new
+      c.method_entries.each do |m|
+        puts fmt.method_info(@ri.get_method(m))
+      end
+    end
+  end
+
+end
+
+
+class DiffCommand < Subcommand
+
+  def initialize
+    @bcprefix = nil
+    @riprefix = nil
+    @type = :name
+    @parser = OptionParser.new
+    @parser.banner = "Usage: #{File.basename($0, '.*')} diff --bc=PATH --ri=PATH <classname>"
+    @parser.on('--bc-database=PREFIX', 'BitClust database prefix') {|path|
+      @bcprefix = path
+    }
+    @parser.on('--ri-database=PREFIX', 'Ri database prefix') {|path|
+      @riprefix = path
+    }
+    @parser.on('-c', '--content', 'Prints method description') {
+      @type = :content
+    }
+    @parser.on('--help', 'Prints this message and quit.') {
+      puts @parser.help
+      exit 0
+    }
+  end
+
+  attr_reader :parser
+
+  def parse(argv)
+    @parser.parse! argv
+    unless @bcprefix
+      $stderr.puts 'missing BitClust database prefix.  Use --bc option'
+      exit 1
+    end
+    @bc = BitClust::MethodDatabase.new(@bcprefix)
+    @ri = open_ri_database(@riprefix)
+    unless argv.size == 1
+      $stderr.puts "wrong number of arguments (#{argv.size} for 1)"
+      $stderr.puts @parser.help
+      exit 1
+    end
+    @classname = argv[0]
+  end
+
+  def exec
+    @ri.current_class = @classname
+    win, lose = *diff_class(bc_lookup_class(@classname), @ri)
+    case @type
+    when :name
+      win.each do |m|
+        puts "+ #{m.id}"
+      end
+      lose.each do |m|
+        puts "- #{m.fullname}"
+      end
+    when :content
+      fmt = Formatter.new
+      lose.each do |m|
+#        puts "\#@\# bc-rdoc: detected missing name: #{m.name}"
+        puts fmt.method_info(m.entry)
+      end
+    end
+  end
+
+  def bc_lookup_class(classname)
+    @bc.fetch_class(classname)
+  rescue BitClust::ClassNotFound
+    $stderr.puts "warning: class #{classname} not exist in BitClust database"
+    @bc.get_class(classname)
+  end
+
+  def diff_class(bc, ri)
+    unzip(diff_entries(bc, bc_wrap(bc.singleton_methods), ri.singleton_methods),
+          diff_entries(bc, bc_wrap(bc.instance_methods),  ri.instance_methods))\
+        .map {|list| list.flatten }
+  end
+
+  def bc_wrap(ents)
+    ents.map {|m|
+      m.names.map {|name| BCMethodEntry.new(name, m) }
+    }.flatten.uniq
+  end
+
+  def unzip(*tuples)
+    [tuples.map {|s, i| s }, tuples.map {|s, i| i }]
+  end
+
+  def diff_entries(bc_class, bc, ri)
+    bc = bc.sort
+    ri = ri.sort
+    [bc - ri, (ri - bc).reject {|m| true_exist?(bc_class, m) }]
+  end
+
+  def true_exist?(c, m)
+    if m.singleton_method?
+      c.singleton_method?(m.name, true)
+    else
+      c.instance_method?(m.name, true)
+    end
+  end
+
+end
+
+
+class HistoryCommand < Subcommand
+
+  def initialize
+    @riprefix = nil
+    @parser = OptionParser.new
+    @parser.banner = "Usage: #{File.basename($0, '.*')} history --ri=PATH <classname>"
+    @parser.on('--ri-database=PREFIX', 'Ri database prefix') {|path|
+      @riprefix = path
+    }
+    @parser.on('--help', 'Prints this message and quit.') {
+      puts @parser.help
+      exit 0
+    }
+  end
+
+  attr_reader :parser
+
+  def parse(argv)
+    @parser.parse! argv
+    unless @riprefix
+      $stderr.puts 'ri database not given; use --ri option'
+      exit 1
+    end
+    @ris = Dir.glob("#{@riprefix}/1.*").map {|dir|
+      RiDatabase.open(dir, File.basename(dir))
+    }
+    if @ris.empty?
+      $stderr.puts 'wrong ri database directory; directories like <path>/1.8.3/, <path>/1.8.4/, ... must exist'
+      exit 1
+    end
+    unless argv.size == 1
+      $stderr.puts "wrong number of arguments (#{argv.size} for 1)"
+      $stderr.puts @parser.help
+      exit 1
+    end
+    @classname = argv[0]
+  end
+
+  def exec
+    @ris.each do |ri|
+      ri.current_class = @classname
+    end
+    s = {}
+    i = {}
+    @ris.each do |ri|
+      ri.singleton_methods.each do |m|
+        (s[m] ||= []).push ri.version
+      end
+      ri.instance_methods.each do |m|
+        (i[m] ||= []).push ri.version
+      end
+    end
+    namecols = calculate_n_namecols(s.keys + i.keys)
+    versions = @ris.map {|ri| ri.version }
+    print_header namecols, versions
+    print_records namecols, versions, (s.to_a + i.to_a)
+  end
+
+  def calculate_n_namecols(ms)
+    tabstop = 8
+    maxnamelen = ms.map {|m| m.fullname.size }.max
+    (maxnamelen / tabstop + 1) * tabstop
+  end
+
+  def print_header(namecols, versions)
+    print ' ' * namecols
+    versions.each do |ver|
+      printf '%4s', ver.tr('.', '')
+    end
+    puts
+  end
+
+  def print_records(namecols, versions, records)
+    veridx = {}
+    versions.each_with_index do |ver, idx|
+      veridx[ver] = idx
+    end
+    records.sort_by {|m, vers| m.fullname }.each do |m, vers|
+      printf "%-#{namecols}s", m.fullname
+
+      fmt = '%4s' * versions.size
+      cols = ['-'] * versions.size
+      vers.each do |ver|
+        cols[veridx[ver]] = 'o'
+      end
+      printf fmt, *cols
+      puts
+    end
+  end
+
+end
+
+
+main

data/tools/bc-tochm.rb

@@ -0,0 +1,301 @@
+#!/usr/bin/env ruby
+# -*- coding: utf-8 -*-
+require 'pathname'
+def srcdir_root
+  (Pathname.new(__FILE__).realpath.dirname + '..').cleanpath
+end
+
+$LOAD_PATH.unshift srcdir_root() + 'lib'
+
+#def srcdir_root
+#  #Pathname.new(__FILE__).realpath.dirname.parent.cleanpath
+#  Pathname.new(__FILE__).dirname.parent.cleanpath
+#end
+#$LOAD_PATH.unshift srcdir_root + 'lib'
+
+require 'bitclust'
+require 'erb'
+require 'fileutils'
+require 'kconv'
+require 'optparse'
+begin
+  require 'progressbar'
+rescue LoadError
+  class ProgressBar
+    def initialize(title, total, out = STDERR)
+      @title, @total, @out = title, total, out
+    end
+    attr_reader :title
+
+    def inc(step = 1)
+    end
+
+    def finish
+    end
+  end
+end
+
+HHP_SKEL = <<EOS
+[OPTIONS]
+Compatibility=1.1 or later
+Compiled file=refm.chm
+Contents file=refm.hhc
+Default Window=titlewindow
+Default topic=doc/index.html
+Display compile progress=No
+Error log file=refm.log
+Full-text search=Yes
+Index file=refm.hhk
+Language=0x411 日本語 (日本)
+Title=Rubyリファレンスマニュアル
+
+[WINDOWS]
+titlewindow="Rubyリファレンスマニュアル","refm.hhc","refm.hhk","doc/index.html","doc/index.html",,,,,0x21420,,0x387e,,,,,,,,0
+
+[FILES]
+<%= @html_files.join("\n") %>
+EOS
+
+HHC_SKEL = <<EOS
+<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML//EN">
+<HTML>
+<HEAD>
+</HEAD>
+<BODY>
+<UL><% [:library].each do |k| %>
+<%= @sitemap[k].to_html %>
+<% end %></UL>
+</BODY>
+</HTML>
+EOS
+
+HHK_SKEL = <<EOS
+<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML//EN">
+<HTML>
+<HEAD>
+</HEAD>
+<BODY>
+<UL><% @index_contents.sort.each do |content| %>
+<%= content.to_html %>
+<% end %></UL>
+</BODY>
+</HTML>
+EOS
+
+class Sitemap
+  def initialize(name, local = nil)
+    @name = name
+    @contents = Content.new(name, local)
+  end
+
+  def method_missing(name, *args, &block)
+    @contents.send(name, *args, &block)
+  end
+
+  class Content
+    include Enumerable
+    include ERB::Util
+
+    def initialize(name, local = nil)
+      @name = name
+      @local = local
+      @contents = []
+    end
+    attr_reader :name, :local, :contents
+
+    def [](index)
+      @contents[index]
+    end
+
+    def <<(content)
+      @contents << content
+    end
+
+    def <=>(other)
+      @name <=> other.name
+    end
+
+    def each
+      @contents.each do |content|
+        yield content
+      end
+    end
+
+    def to_html
+      str = "<LI> <OBJECT type=\"text/sitemap\">\n"
+      str << "        <param name=\"Name\" value=\"<%=h @name%>\">\n"
+      if @local
+        str << "        <param name=\"Local\" value=\"<%=@local%>\">\n"
+      end
+      str << "        </OBJECT>\n"
+      unless contents.empty?
+        str << "<UL>\n"
+        @contents.each do |content|
+          str << content.to_html
+        end
+        str << "</UL>\n"
+      end
+      ERB.new(str).result(binding)
+    end
+  end
+end
+
+module BitClust
+
+  class URLMapperEx < URLMapper
+    def library_url(name)
+      if name == '/'
+        "/library/index.html"
+      else
+        "/library/#{encodename_fs(name)}.html"
+      end
+    end
+
+    def class_url(name)
+      "/class/#{encodename_fs(name)}.html"
+    end
+
+    def method_url(spec)
+      cname, tmark, mname = *split_method_spec(spec)
+      "/method/#{encodename_fs(cname)}/#{typemark2char(tmark)}/#{encodename_fs(mname)}.html"
+    end
+
+    def document_url(name)
+      "/doc/#{encodename_fs(name)}.html"
+    end
+  end
+end
+
+def main
+  @sitemap = {
+    :library => Sitemap.new('ライブラリ', 'library/index.html'),
+  }
+  @sitemap[:library] << Sitemap::Content.new('標準ライブラリ', 'library/_builtin.html')
+  @sitemap[:library] << Sitemap::Content.new('添付ライブラリ')
+  @stdlibs = {}
+  @index_contents = []
+  prefix = Pathname.new('./db')
+  outputdir = Pathname.new('./chm')
+  manager_config = {
+    :baseurl => 'http://example.com/',
+    :suffix => '.html',
+    :templatedir => srcdir_root + 'data'+ 'bitclust' + 'template',
+    :themedir => srcdir_root + 'theme' + 'default',
+    :css_url => 'style.css',
+    :cgi_url => '',
+    :tochm_mode => true
+  }
+  manager_config[:urlmapper] = BitClust::URLMapperEx.new(manager_config)
+  
+  parser = OptionParser.new
+  parser.on('-d', '--database=PATH', 'Database prefix') do |path|
+    prefix = Pathname.new(path).realpath
+  end
+  parser.on('-o', '--outputdir=PATH', 'Output directory') do |path|
+    begin
+      outputdir = Pathname.new(path).realpath
+    rescue Errno::ENOENT
+      FileUtils.mkdir_p(path, :verbose => true)
+      retry
+    end
+  end
+  parser.on('--help', 'Prints this message and quit') do
+    puts(parser.help)
+    exit(0)
+  end
+  begin
+    parser.parse!
+  rescue OptionParser::ParseError => err
+    STDERR.puts(err.message)
+    STDERR.puts(parser.help)
+    exit(1)
+  end
+
+  db = BitClust::MethodDatabase.new(prefix.to_s)
+  manager = BitClust::ScreenManager.new(manager_config)
+  @html_files = []
+  db.transaction do
+    methods = {}
+    pb = ProgressBar.new('method', db.methods.size)
+    db.methods.each_with_index do |entry, i|
+      method_name = entry.klass.name + entry.typemark + entry.name
+      (methods[method_name] ||= []) << entry
+      pb.inc
+    end
+    pb.finish
+    entries = db.docs + db.libraries.sort + db.classes.sort + methods.values.sort 
+    pb = ProgressBar.new('entry', entries.size)
+    entries.each_with_index do |c, i|
+      filename = create_html_file(c, manager, outputdir, db)
+      @html_files << filename
+      e = c.is_a?(Array) ? c.sort.first : c
+      case e.type_id
+      when :library
+        content = Sitemap::Content.new(e.name.to_s, filename)
+        if e.name.to_s != '_builtin'
+          @sitemap[:library][1] << content
+          @stdlibs[e.name.to_s] = content
+        end
+        @index_contents << Sitemap::Content.new(e.name.to_s, filename)
+      when :class
+        content = Sitemap::Content.new(e.name.to_s, filename)
+        if e.library.name.to_s == '_builtin'
+          @sitemap[:library][0] << content
+        else
+          @stdlibs[e.library.name.to_s] << content
+        end
+        @index_contents << Sitemap::Content.new("#{e.name} (#{e.library.name})", filename)
+      when :method
+        e.names.each do |e_name|
+          name = e.typename == :special_variable ? "$#{e_name}" : e_name
+          @index_contents <<
+            Sitemap::Content.new("#{name} (#{e.library.name} - #{e.klass.name})", filename)
+          @index_contents <<
+            Sitemap::Content.new("#{e.klass.name}#{e.typemark}#{name} (#{e.library.name})", filename)
+        end
+      end
+      pb.title.replace(e.name)
+      pb.inc
+    end
+    pb.finish
+  end
+  @html_files.sort!
+  create_file(outputdir + 'refm.hhp', HHP_SKEL, true)
+  create_file(outputdir + 'refm.hhc', HHC_SKEL, true)
+  create_file(outputdir + 'refm.hhk', HHK_SKEL, true)
+  create_file(outputdir + 'library/index.html', manager.library_index_screen(db.libraries.sort, {:database => db}).body)
+  create_file(outputdir + 'class/index.html', manager.class_index_screen(db.classes.sort, {:database => db}).body)
+  FileUtils.cp(manager_config[:themedir] + manager_config[:css_url],
+               outputdir.to_s, {:verbose => true, :preserve => true})
+end
+
+def create_html_file(entry, manager, outputdir, db)
+  html = manager.entry_screen(entry, {:database => db}).body
+  e = entry.is_a?(Array) ? entry.sort.first : entry
+  path = case e.type_id
+         when :library, :class, :doc
+           outputdir + e.type_id.to_s + (BitClust::NameUtils.encodename_fs(e.name) + '.html')
+         when :method
+           outputdir + e.type_id.to_s + BitClust::NameUtils.encodename_fs(e.klass.name) +
+             e.typechar + (BitClust::NameUtils.encodename_fs(e.name) + '.html')
+         else
+           raise
+         end
+  FileUtils.mkdir_p(path.dirname) unless path.dirname.directory?
+  path.open('w') do |f|
+    f.write(html)
+  end
+  path.relative_path_from(outputdir).to_s
+end
+
+def create_file(path, skel, sjis_flag = false)
+  STDERR.print("creating #{path} ...")
+  str = ERB.new(skel).result(binding)
+  str = str.tosjis if sjis_flag
+  path.open('w') do |f|
+    f.write(str)
+  end
+  STDERR.puts(" done.")
+end
+
+main