RubyGems - bitclust-dev - Versions diffs - 0.5.0 - Mend

bitclust-dev 0.5.0

Files changed (19) hide show

data/tools/bc-tochm.rb ADDED Viewed

@@ -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

data/tools/bc-tohtml.rb ADDED Viewed

@@ -0,0 +1,125 @@
+#!/usr/bin/env ruby
+#
+# bc-tohtml.rb
+#
+# Copyright (c) 2006-2007 Minero Aoki
+#
+# This program is free software.
+# You can distribute/modify this program under the Ruby License.
+#
+require 'pathname'
+def srcdir_root
+  (Pathname.new(__FILE__).realpath.dirname + '..').cleanpath
+end
+$LOAD_PATH.unshift srcdir_root() + 'lib'
+$KCODE = 'UTF-8' unless Object.const_defined?(:Encoding)
+require 'bitclust'
+require 'optparse'
+def main
+  templatedir = srcdir_root() + 'data' + 'bitclust' + 'template.offline'
+  target = nil
+  baseurl = 'file://' + srcdir_root.to_s
+  parser = OptionParser.new
+  ver = '1.9.0'
+  parser.banner = "Usage: #{File.basename($0, '.*')} rdfile"
+  parser.on('--target=NAME', 'Compile NAME to HTML.') {|name|
+    target = name
+  }
+  parser.on('--force', '-f', 'Force to use rd_file template.') {|name|
+    @rd_file = true
+  }
+  parser.on('--ruby_version=VER', '--ruby=VER', 'Set Ruby version') {|v|
+    ver = v
+  }
+  parser.on('--db=DB', '--database=DB', 'Set database path') {|path|
+    db = BitClust::Database.new(path)
+  }
+  parser.on('--baseurl=URL', 'Base URL of generated HTML') {|url|
+    baseurl = url
+  }
+  parser.on('--templatedir=PATH', 'Template directory') {|path|
+    templatedir = path
+  }
+  parser.on('--help', 'Prints this message and quit.') {
+    puts parser.help
+    exit 0
+  }
+  parser.on('--capi', 'C API mode.') {
+    @capi = true
+  }
+  begin
+    parser.parse!
+  rescue OptionParser::ParseError => err
+    $stderr.puts err.message
+    $stderr.puts parser.help
+    exit 1
+  end
+  if ARGV.size > 1
+    $stderr.puts "too many arguments (expected 1)"
+    exit 1
+  end
+  db ||= BitClust::Database.dummy({'version' => ver})
+  manager = BitClust::ScreenManager.new(
+                                        :templatedir => templatedir,
+                                        :base_url => baseurl,
+                                        :cgi_url => baseurl,
+                                        :default_encoding => 'utf-8')
+  unless @rd_file
+    begin
+      if @capi
+        lib = BitClust::FunctionReferenceParser.parse_file(ARGV[0], {'version' => ver})
+        unless target
+          raise NotImplementedError, "generating a C API html without --target=NAME is not implemented yet."
+        end
+      else
+        lib = BitClust::RRDParser.parse_stdlib_file(ARGV[0], {'version' => ver})
+      end
+      entry = target ? lookup(lib, target) : lib
+      puts manager.entry_screen(entry, {:database => db}).body
+      return
+    rescue BitClust::ParseError => ex
+      $stderr.puts ex.message
+      $stderr.puts ex.backtrace[0], ex.backtrace[1..-1].map{|s| "\tfrom " + s}
+    end
+  end
+  ent = BitClust::DocEntry.new(db, ARGV[0])
+  ret = BitClust::Preprocessor.read(ARGV[0], {'version' => ver})
+  ent.source = ret
+  puts manager.doc_screen(ent, {:database => db} ).body
+  return
+rescue BitClust::WriterError => err
+  $stderr.puts err.message
+  exit 1
+end
+def lookup(lib, key)
+  case
+  when @capi && BitClust::NameUtils.functionname?(key)
+    lib.find {|func| func.name == key}
+  when BitClust::NameUtils.method_spec?(key)
+    spec = BitClust::MethodSpec.parse(key)
+    if spec.constant?
+      begin
+        lib.fetch_class(key)
+      rescue BitClust::UserError
+        lib.fetch_methods(spec)
+      end
+    else
+      lib.fetch_methods(spec)
+    end
+  when BitClust::NameUtils.classname?(key)
+    lib.fetch_class(key)
+  else
+    raise BitClust::InvalidKey, "wrong search key: #{key.inspect}"
+  end
+end
+main

data/tools/bc-tohtmlpackage.rb ADDED Viewed

@@ -0,0 +1,241 @@
+#!/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'
+require 'bitclust'
+require 'fileutils'
+require 'optparse'
+if Object.const_defined?(:Encoding)
+  Encoding.default_external = 'utf-8'
+end
+module BitClust
+  class URLMapperEx < URLMapper
+    def library_url(name)
+      if name == '/'
+        $bitclust_html_base + "/library/index.html"
+      else
+        $bitclust_html_base + "/library/#{encodename_package(name)}.html"
+      end
+    end
+    def class_url(name)
+      $bitclust_html_base + "/class/#{encodename_package(name)}.html"
+    end
+    def method_url(spec)
+      cname, tmark, mname = *split_method_spec(spec)
+      $bitclust_html_base +
+        "/method/#{encodename_package(cname)}/#{typemark2char(tmark)}/#{encodename_package(mname)}.html"
+    end
+    def function_url(name)
+      $bitclust_html_base + "/function/#{name.empty? ? 'index' : name}.html"
+    end
+    def document_url(name)
+      $bitclust_html_base + "/doc/#{encodename_package(name)}.html"
+    end
+    def css_url
+      $bitclust_html_base + "/" + @css_url
+    end
+    def favicon_url
+      $bitclust_html_base + "/" + @favicon_url
+    end
+    def library_index_url
+      $bitclust_html_base + "/library/index.html"
+    end
+    def function_index_url
+      $bitclust_html_base + "/function/index.html"
+    end
+  end
+end
+def main
+  prefix = Pathname.new('./db')
+  outputdir = Pathname.new('./doc')
+  templatedir = srcdir_root + 'data'+ 'bitclust' + 'template'
+  catalogdir = nil
+  verbose = true
+  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 => verbose)
+      retry
+    end
+  end
+  parser.on('--catalog=PATH', 'Catalog directory') do |path|
+    catalogdir = Pathname.new(path).realpath
+  end
+  parser.on('--templatedir=PATH', 'Template directory') do |path|
+    templatedir = Pathname.new(path).realpath
+  end
+  parser.on('--fs-casesensitive', 'Filesystem is case-sensitive') do
+    $fs_casesensitive = true
+  end
+  parser.on('--[no-]quiet', 'Be quiet') do |quiet|
+    verbose = !quiet
+  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
+  manager_config = {
+    :catalogdir => catalogdir,
+    :suffix => '.html',
+    :templatedir => templatedir,
+    :themedir => srcdir_root + 'theme' + 'default',
+    :css_url => 'style.css',
+    :favicon_url => 'rurema.png',
+    :cgi_url => '',
+    :tochm_mode => true
+  }
+  manager_config[:urlmapper] = BitClust::URLMapperEx.new(manager_config)
+  db = BitClust::MethodDatabase.new(prefix.to_s)
+  fdb = BitClust::FunctionDatabase.new(prefix.to_s)
+  manager = BitClust::ScreenManager.new(manager_config)
+  db.transaction do
+    methods = {}
+    db.methods.each_with_index do |entry, i|
+      method_name = entry.klass.name + entry.typemark + entry.name
+      (methods[method_name] ||= []) << entry
+    end
+    entries = db.docs + db.libraries.sort + db.classes.sort + methods.values
+    entries.each_with_index do |c, i|
+      create_html_file(c, manager, outputdir, db)
+      $stderr.puts("#{i}/#{entries.size} done") if i % 100 == 0 and verbose
+    end
+  end
+  fdb.transaction do
+    functions = {}
+    fdb.functions.each_with_index do |entry, i|
+      create_html_file(entry, manager, outputdir, fdb)
+      $stderr.puts("#{i} done") if i % 100 == 0 and verbose
+    end
+  end
+  $bitclust_html_base = '..'
+  create_file(outputdir + 'library/index.html',
+              manager.library_index_screen(db.libraries.sort, {:database => db}).body,
+              :verbose => verbose)
+  create_file(outputdir + 'class/index.html',
+              manager.class_index_screen(db.classes.sort, {:database => db}).body,
+              :verbose => verbose)
+  create_file(outputdir + 'function/index.html',
+              manager.function_index_screen(fdb.functions.sort, { :database => fdb }).body,
+              :verbose => verbose)
+  create_index_html(outputdir)
+  FileUtils.cp(manager_config[:themedir] + manager_config[:css_url],
+               outputdir.to_s, {:verbose => verbose, :preserve => true})
+  FileUtils.cp(manager_config[:themedir] + manager_config[:favicon_url],
+               outputdir.to_s, {:verbose => verbose, :preserve => true})
+  Dir.mktmpdir do |tmpdir|
+    FileUtils.cp_r(manager_config[:themedir] + 'images', tmpdir,
+                   {:verbose => verbose, :preserve => true})
+    Dir.glob(File.join(tmpdir, 'images', '/**/.svn')).each do |d|
+      FileUtils.rm_r(d, {:verbose => verbose})
+    end
+    FileUtils.cp_r(File.join(tmpdir, 'images'), outputdir.to_s,
+                   {:verbose => verbose, :preserve => true})
+  end
+end
+def encodename_package(str)
+  if $fs_casesensitive
+    BitClust::NameUtils.encodename_url(str)
+  else
+    BitClust::NameUtils.encodename_fs(str)
+  end
+end
+def create_index_html(outputdir)
+  path = outputdir + 'index.html'
+  File.open(path, 'w'){|io|
+    io.write <<HERE
+<meta http-equiv="refresh" content="0; URL=doc/index.html">
+<a href="doc/index.html">Go</a>
+HERE
+  }
+end
+def create_html_file(entry, manager, outputdir, db)
+  e = entry.is_a?(Array) ? entry.sort.first : entry
+  case e.type_id
+  when :library, :class, :doc
+    $bitclust_html_base = '..'
+    path = outputdir + e.type_id.to_s + (encodename_package(e.name) + '.html')
+    create_html_file_p(entry, manager, path, db)
+    path.relative_path_from(outputdir).to_s
+  when :method
+    create_html_method_file(entry, manager, outputdir, db)
+  when :function
+    create_html_function_file(entry, manager, outputdir, db)
+  else
+    raise
+  end
+  e.unload
+end
+def create_html_method_file(entry, manager, outputdir, db)
+  path = nil
+  $bitclust_html_base = '../../..'
+  e = entry.is_a?(Array) ? entry.sort.first : entry
+  e.names.each{|name|
+    path = outputdir + e.type_id.to_s + encodename_package(e.klass.name) +
+           e.typechar + (encodename_package(name) + '.html')
+    create_html_file_p(entry, manager, path, db)
+  }
+  path.relative_path_from(outputdir).to_s
+end
+def create_html_function_file(entry, manager, outputdir, db)
+  path = nil
+  $bitclust_html_base = '..'
+  path = outputdir + entry.type_id.to_s + (entry.name + '.html')
+  create_html_file_p(entry, manager, path, db)
+  path.relative_path_from(outputdir).to_s
+end
+def create_html_file_p(entry, manager, path, db)
+    FileUtils.mkdir_p(path.dirname) unless path.dirname.directory?
+    html = manager.entry_screen(entry, {:database => db}).body
+    path.open('w') do |f|
+      f.write(html)
+    end
+end
+def create_file(path, str, options={})
+  verbose = options[:verbose]
+  STDERR.print("creating #{path} ...") if verbose
+  path.open('w') do |f|
+    f.write(str)
+  end
+  STDERR.puts(" done.") if verbose
+end
+main