langhelp 0.9.8

data/lib/langhelp/lh_lua.rb

@@ -0,0 +1,25 @@
+#
+#  lh_lua.rb - Create langhelp index of Lua language
+#  Copyright (C) 2005 rubikitch <rubikitch@ruby-lang.org>
+#  Version: $Id: lh_lua.rb 1364 2006-09-04 01:31:11Z rubikitch $
+
+#  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 2 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, write to the Free Software
+#  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+
+require 'langhelp/langhelp-base'
+class LuaHelp < AbstractIndex
+  def to_e(out)
+    `luahelp index`.split.sort.each do |idx|
+      out << format(%Q[# (lh-luahelp "%s")\n], idx)
+    end
+  end
+end

data/lib/langhelp/lh_perl.rb

@@ -0,0 +1,112 @@
+#  
+#  lh_perl.rb - Create langhelp index of Perl language
+#  Copyright (C) 2005 rubikitch <rubikitch@ruby-lang.org>
+#  Version: $Id: lh_perl.rb 1190 2006-02-08 09:32:55Z rubikitch $
+
+#  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 2 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, write to the Free Software
+#  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+
+
+require 'langhelp/langhelp-base'
+
+class PodSections < AbstractIndex
+  def init(x={})
+    @perl_pod = x[:perl_pod]
+    normalize_filename! @perl_pod
+  end
+
+  def process_pod(pod_source)
+    @sections = []
+
+    heads = {}
+    head_order = []
+    head = nil
+    pod_source.split(/\n/).each do |line|
+      case line
+      when /^=head\d (.+)$/
+        head = $1
+        heads[head] = []
+        head_order << head
+      when /^\s+(perl\w+)\t+(.+)$/
+        heads[head] << [$1, $2]
+      end
+    end
+
+    head_order.each do |head|
+      heads[head].each do |pod, desc|
+        #printf "%-20s %s\n", pod, desc
+        @sections << [head, pod, desc]
+      end
+    end
+  end
+
+  def to_e(out)
+    process_pod(File.read(@perl_pod))
+    @sections.each do |head, pod, desc|
+      out << format("# %-15s : %s / %-40s#{SPACES}(lh-podsections %s)\n",
+                    pod, head, desc, lisp_dump_string(pod))
+    end
+  end
+end
+
+class PerlFunc < AbstractIndex
+  def init(x={})
+    @perlfunc_pod = x[:perlfunc_pod]
+    normalize_filename! @perlfunc_pod
+  end
+
+  FUNCLIST_BEGINS_FROM = /Alphabetical Listing of Perl Functions/
+  REJECT_REGEXP = /^\*$/
+  def extract_funcs(pod_source)
+    _, text = pod_source.split(FUNCLIST_BEGINS_FROM, 2)
+    @funcs = text.scan(/^=item (.+)$/).flatten.reject{|func| func =~ REJECT_REGEXP }.map {|usage|
+      name = usage.split(/[\s\(]/)[0]
+      name.sub!(/\/.+$/,'')
+      [ name, usage ]
+    }
+  end
+
+  def to_e(out)
+    extract_funcs File.read(@perlfunc_pod)
+    @funcs.each do |name, usage|
+      out << format("# %-30s#{SPACES}(lh-perlfunc %s)\n", usage, lisp_dump_string(name))
+    end  
+  end
+
+end
+
+class PerlDoc < AbstractIndex
+  def init(x={})
+    @perl_path = x[:perl_path]
+    normalize_filename! *@perl_path
+  end
+
+  def collect_files
+    @modules = @perl_path.map {|dir|
+      modules = []
+      Dir.chdir(dir) do
+        [ Dir["**/*.pod"]+Dir["**/*.pm"]+Dir["**/*.pl"] ].flatten.each do |pod|
+          next if pod =~ /^pod\//
+          modules << pod.gsub(/\//, '::').gsub(/\.[^\.]+$/,'')
+        end
+      end
+      modules
+    }.flatten.sort.uniq
+  end
+
+  def to_e(out)
+    collect_files
+    @modules.each do |mod|
+      out << format("# %-30s#{SPACES}(lh-perldoc %s)\n", mod, lisp_dump_string(mod))
+    end
+  end
+end

data/lib/langhelp/lh_php.rb

@@ -0,0 +1,34 @@
+#  
+#  lh_php.rb - Create langhelp index of PHP language
+#  Copyright (C) 2005 rubikitch <rubikitch@ruby-lang.org>
+#  Version: $Id: lh_php.rb 1190 2006-02-08 09:32:55Z rubikitch $
+
+#  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 2 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, write to the Free Software
+#  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+
+class PHPManual < AbstractIndex
+  def init(x={})
+    @dir = arg1
+    @glob = x[:glob]
+    normalize_filename! @dir
+  end
+
+  def to_e(out)
+    Dir[File.join(@dir, @glob)].each do |fullpath|
+      basename = File.basename fullpath
+      node = basename.sub(/\.html$/, '')
+      section, function = node.split(/\./,2)
+      function.gsub!(/-/, '_')
+      out << %Q!# #{function}#{SPACES}(lh-w3m "" #{lisp_dump_string(fullpath)})\n!
+    end
+  end
+end

data/lib/langhelp/lh_python.rb

@@ -0,0 +1,31 @@
+#  
+#  lh_python.rb - Create langhelp index of Python language
+#  Copyright (C) 2005 rubikitch <rubikitch@ruby-lang.org>
+#  Version: $Id: lh_python.rb 1190 2006-02-08 09:32:55Z rubikitch $
+
+#  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 2 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, write to the Free Software
+#  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+require 'langhelp/langhelp-base'
+require 'langhelp/langhelp-sub'
+
+class PythonLib < HTMLIndex
+  def untable_html(src=File.read(@index_page))
+    ut = UnTable.new
+    ut.untable(src)
+  end
+
+  def pre_process(src)
+    untable_html(src).gsub( %r!<dt><a href="(.+?)">(.+)</a>! ) {
+      %Q!<dt>#{$2}#{space}(lh-w3m nil "file://#{@dir}/#{$1}")\n!
+    }
+  end
+end

data/lib/langhelp/lh_ruby.rb

@@ -0,0 +1,400 @@
+#  
+#  lh_ruby.rb - Create langhelp index of Ruby language
+#  Copyright (C) 2005 rubikitch <rubikitch@ruby-lang.org>
+#  Version: $Id: lh_ruby.rb 1347 2006-08-20 15:26:37Z rubikitch $
+
+#  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 2 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, write to the Free Software
+#  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+require 'kconv'
+require 'langhelp/langhelp-base'
+List = Struct.new(:source, :methods, :arg)
+
+class << List
+  include LocalVariables
+  def methods_list_file(source, filename)
+    methods = File.read(filename).split(/\n/) rescue []
+    new(source, methods)
+  end
+
+  def methods_from_anchor(source, filename)
+    methods = File.read(filename).scan(/#{ANCHOR_BEGIN}(.+)#{ANCHOR_END}/).flatten
+    new(source, methods, filename)
+  end
+end
+
+
+# Abstract class representing Index
+class RubyIndex < AbstractIndex
+
+  # for debug purpose
+  def init(x={})
+    @x = x
+  end
+
+  # To adjust sort order.
+  # . -> \001, :: -> \002, # -> \003
+  def pack_method(name)
+    name.gsub(/\./){"\001"}.gsub(/::/){"\002"}.gsub(/#/){"\003"}
+  end
+
+  def unpack_method(name)
+    name.gsub(/\001/){"."}.gsub(/\002/){"::"}.gsub(/\003/){"#"}
+  end
+
+  # 
+  def prepare
+    @lists = @x[:lists]
+    if @x[:sources]
+      @lists = @x[:sources].map{|source|
+        [ List.methods_list_file(source, "#{source}_methods.lst"),
+          List.methods_list_file(source, "#{source}_classes.lst"),
+        ]
+      }.flatten
+    end
+  end
+
+  # Contents of Index by Array
+  def contents
+    prepare
+    _contents
+  end
+
+  def _contents
+    find_func = {}
+    args = {}
+    @lists.each do |list|
+      list.methods.each do |m|
+        m = pack_method(m)      # To sort class_method -> instance_method order.
+        find_func[m]="lh-#{list.source}"
+        args[m] = list.arg
+      end
+    end
+    
+    packed_methods = find_func.keys
+    packed_methods.sort.map{|packed|
+      m = unpack_method(packed)
+#      m = m.sub(/\./, '::') if find_func[packed] == 'lh-ri'
+      [find_func[packed], m, args[packed]].compact
+    }
+
+  end
+
+  # Output into e-script form
+  def to_e(out)
+    contents.each do |func, meth, arg|
+      out << format(%Q[# (%s "%s"], func, meth)
+      if arg
+        abbreviate_filename! arg
+        out << format(%Q[#{SPACES}"%s"], arg)
+      end
+      out << ")\n"
+    end
+  end
+end
+
+module RefeCommon
+  def set_refe_root_dir(rootdir)
+    require 'refe/config'
+    if rootdir
+      @rootdir = rootdir
+    elsif ENV['REFE_DATA_DIR']
+      @rootdir = ENV['REFE_DATA_DIR']
+    elsif defined?(ReFe::REFE_DATA_DIR)
+      @rootdir = ReFe::REFE_DATA_DIR
+    else
+      raise ArgumentError, 'ReFe database directory not given'
+    end
+  end
+end
+# Index by lh-refe 
+class Refe < RubyIndex
+  include RefeCommon
+
+  def init(x={})
+    @classes_lst = "refe_classes.lst"
+    @methods_lst = "refe_methods.lst"
+    set_refe_root_dir x[:root_dir]
+    normalize_filename! @rootdir
+    @class_document_comp = x[:class_document_comp] ||
+      "#{@rootdir}/class_document_comp"
+    @method_document_comp = x[:method_document_comp] ||
+      "#{@rootdir}/method_document_comp"
+  end
+  
+  def prepare
+    generate_methods_and_classes
+    @lists = [
+      List.methods_list_file("refe", @classes_lst),
+      List.methods_list_file("refe", @methods_lst)
+    ]
+  end
+
+  def generate_methods_and_classes(methods=@methods_lst, classes=@classes_lst, class_document_comp=@class_document_comp, method_document_comp=@method_document_comp)
+    File.readlines(method_document_comp).select{|line|
+      line !~ /^man.pack$|^man.sprintf$/ and line !~ /^@/
+    }.writef(methods)
+
+    File.readlines(class_document_comp).select{|line|
+      line !~ /^fatal$|^man$/
+    }.writef(classes)
+    
+  end
+
+end
+
+class RefeC < AbstractIndex
+  include RefeCommon
+  def init(x={})
+    set_refe_root_dir x[:root_dir]
+    normalize_filename! @rootdir
+    @function_document_comp = "#{@rootdir}/function_document_comp"
+  end
+
+  def to_e(out)
+    File.read(@function_document_comp).split(/\n/).sort.each do |func|
+      out << format(%Q[# (lh-refec "%s")\n], func)
+    end
+  end
+end
+
+# Index by lh-ri
+require 'rdoc/ri/ri_paths'
+class Ri < RubyIndex
+  def init(x={})
+    @ri_all = x[:ri_all] || "ri_all.lst"
+    @classes_lst = x[:classes_lst] || "ri_classes.lst"
+    @methods_lst = x[:methods_lst] || "ri_methods.lst"
+    @ri_path = x[:ri_path] || RI::Paths::PATH
+    normalize_filename! *@ri_path
+  end
+  
+  def prepare
+    generate_ri_all
+    generate_methods_and_classes
+    @lists = [
+      List.methods_list_file("ri", @classes_lst),
+      List.methods_list_file("ri", @methods_lst)
+    ]
+  end
+
+  def generate_ri_all(filename=@ri_all)
+    files = @ri_path.map{|dir| Dir["#{dir}/**/*"]}.flatten.select{|f|
+      File.file?(f)
+    }
+    methods = files.collect!{|f|
+      File.read(f).grep(/^full_name:/).map{|line|
+        pack_method(line.split(/:/,2)[1].to_s[1..-1].gsub(/\"/,""))
+      }
+    }
+    methods.flatten!
+    methods.compact!
+    methods.sort!
+    methods.uniq!
+    methods.collect!{|m| convert_colons2dot(unpack_method(m))}
+    methods.writef(filename)
+  end
+
+=begin
+FNAME           : OPERATION
+                | `|' | `^' | `&' | `<=>' | `==' | `===' | `=~'
+                | `>' | `>=' | `<' | `<='
+                | `+' | `-' | `*' | `/' | `%' | `**'
+                | `<<' | `>>' | `~' | ``'
+                | `+@' | `-@' | `[]' | `[]='
+=end
+  METHOD_NAME_FIRST_CHARS = 'a-z|^&<=>+*/%*~`\\-\\[\\]_'
+  def convert_colons2dot(method_name)
+    method_name.sub(/::([#{METHOD_NAME_FIRST_CHARS}][^:#]+)$/,'.\1')    
+  end
+
+  
+  def generate_methods_and_classes(methods=@methods_lst, classes=@classes_lst, ri_all=@ri_all)
+    open(methods, "w") do |meth|
+      open(classes, "w") do |klass|
+        File.read(ri_all).each do |line|
+          case line
+          when /[\.#]/
+              meth.puts line
+          else
+            klass.puts line
+          end
+        end
+      end
+    end
+  end
+end
+
+class AnchorIndex < RubyIndex
+  def init(x={})
+    init_converter                        # initialize by subclass
+    input_filename = arg1.dup
+    @body_e = x[:body] || generate_output_filename(input_filename)
+    normalize_filename! arg1, @body_e
+  end
+
+  def generate_output_filename(input_filename)
+    input_filename.sub(/~\//,'').gsub(/[\/\\\.]/,'_')+".txt"
+  end
+
+  def prepare
+    @conv = @Converter.new(File.read(arg1))
+    @conv.conf = conf
+    @conv.to_e(@body_e)
+    @lists = [List.methods_from_anchor("anchor", @body_e)]
+  end
+
+  def contents
+    prepare
+
+    list = @lists[0]
+    find_func = "lh-#{list.source}"
+    list.methods.map do |m|
+      [find_func, m, list.arg].compact
+    end
+
+  end
+
+end
+
+class MoonWolfRubyDoc < AnchorIndex
+  def init_converter() @Converter = MoonWolfRubyDocConverter end
+end
+
+# class RD < AnchorIndex
+#   def init_converter() @Converter = RDConverter end
+# end
+
+class RD < Grep
+  def init(x={})
+    @regexp = /^(=+|\s*:|\s*---)/
+    @src = arg1
+    @exclude = ["=begin", "=end"] + mkarray(x[:exclude])
+    normalize_filename! @src
+  end
+end
+
+
+class MoonWolfRubyDocConverter
+  def initialize(htmlsrc)
+    @input = htmlsrc.toeuc
+  end
+  attr_accessor :conf
+
+  def create_anchor
+    klass = nil
+    method_type = ""
+    output = ""
+    @input.each do |line|
+      case line
+      when /^#([A-Z].*)$/
+        klass = $1
+        line = "#" + "{{" + klass + "}}\n"
+      when /<h3>���饹�᥽�å�/
+        method_type = "."
+      when /<h3>�᥽�å�/
+        method_type = "#"
+      when /^(.*)(<dt[^>]*>)(self\[(.+)\]=(.+))$/ # self[]=
+        line = "#{$1}#{$2}{{#{klass}#{method_type}[]=}} #{$3}\n"
+      when /^(.*)(<dt[^>]*>)(self\[(.+)\])$/ # self[]
+        line = "#{$1}#{$2}{{#{klass}#{method_type}[]}} #{$3}\n"
+      when /^(.*)(<dt[^>]*>)(\w+)(.*)$/
+        line = "#{$1}#{$2}{{#{klass}#{method_type}#{$3}}}#{$4}\n"
+      end
+      output << line
+    end
+    output
+  end
+
+  include LocalVariables
+  include GeneratedMessage
+  def html2e(es_file)
+    IO.popen("#{conf[:HTML2TXT]} > #{es_file}", "w") do |w3m|
+      w3m.print self.create_anchor
+    end
+    essrc = File.read(es_file)
+    open(es_file, "w") do |es|
+      es << essrc.gsub(/\{\{/, ANCHOR_BEGIN).gsub(/\}\}/, ANCHOR_END)
+      insert_local_variables es
+    end
+    generated es_file
+  end
+
+  alias :to_e :html2e
+end
+
+
+class RDConverter
+  def initialize(rdsrc)
+    @input = rdsrc
+  end
+  attr_accessor :conf
+
+  def create_anchor
+    @input.gsub(/^(\-\-\- +)([\w\.:#]+)/) { $1+ANCHOR_BEGIN+$2+ANCHOR_END }
+  end
+
+  include LocalVariables
+  include GeneratedMessage
+  def to_e(es_file)
+    open(es_file, "w") do |es|
+      es << create_anchor
+      insert_local_variables es
+    end
+    generated es_file
+  end
+end
+
+# Ruby Reference Manual HTML version.
+# (browse-url "http://elbereth-hp.hp.infoseek.co.jp/ruby.html")
+class RubyRefm < HTMLIndex
+  def init_filename(x)
+    if File.directory?(dir = File.expand_path(arg1))
+      @dir = dir
+      index_file = File.read(File.join(dir, "index.html"))[ %r!<a href="(\S+?.html)">INDEX</a>!, 1 ]
+      @index_page = File.join(dir, index_file)
+      normalize_filename! @index_page
+    else
+      super
+    end
+  end
+
+
+  def pre_process(src)
+    src.gsub( %r!^<li><a href="(.+\.html)">(.+)</a>! ) {
+      %Q!<li>#{$2}#{space}(lh-w3m nil "file://#{@dir}/#{$1}" t)\n!
+    }
+  end
+end
+
+
+#### for backward compatibility
+def ri_all(filename)
+  Ri.new.generate_ri_all(filename)
+end
+
+def ri_generate_methods_and_classes(methods="ri_methods.lst", classes="ri_classes.lst", ri_all="ri_all.lst")
+  Ri.new.generate_method_and_classes(methods, classes, ri_all)
+end
+
+
+
+def refe_generate_methods_and_classes(methods="refe_methods.lst", classes="refe_classes.lst", class_document_comp="/usr/local/share/refe/class_document_comp", method_document_comp="/usr/local/share/refe/method_document_comp")
+  Refe.new.generate_method_and_classes(methods, classes, class_document_comp, method_document_comp)
+end
+
+def make_rubyhelp(lists, output_file)
+  RubyHelp.new(lists).to_e(output_file)
+end
+
+# Local Variables:
+# test-script: "../../test/test-ruby.rb"
+# End: