bitclust-core 1.2.1 → 1.2.6

data/lib/bitclust/lineinput.rb

@@ -9,6 +9,7 @@
 #
 
 require 'stringio'
+require 'bitclust/parseutils'
 
 # Utility class for line-wise file parsing
 class LineInput
@@ -34,7 +35,7 @@ class LineInput
   end
 
   def path
-    @input.path
+    @input.path if @input.respond_to?(:path)
   end
 
   def name
@@ -52,12 +53,15 @@ class LineInput
   def gets
     unless @buf.empty?
       @lineno += 1
-      return @buf.pop
+      line = @buf.pop
+      line&.location ||= BitClust::Location.new(path, @lineno)
+      return line
     end
     return nil if @eof_p   # to avoid ARGF blocking.
     line = @input.gets
     @eof_p = true unless line
     @lineno += 1
+    line&.location ||= BitClust::Location.new(path, @lineno)
     line
   end
 

data/lib/bitclust/methoddatabase.rb

@@ -175,14 +175,17 @@ module BitClust
     end
 
     def copy_doc
+      root_path = Pathname.new(@root).expand_path
       Dir.glob("#{@root}/../../doc/**/*.rd").each do |f|
         if %r!\A#{Regexp.escape(@root)}/\.\./\.\./doc/([-\./\w]+)\.rd\z! =~ f
           id = libname2id($1)
           se = DocEntry.new(self, id)
           s = Preprocessor.read(f, properties)
           title, source = RRDParser.split_doc(s)
+          relative_path = Pathname.new(f).expand_path(@root).relative_path_from(root_path)
           se.title = title
           se.source = source
+          se.source_location = Location.new(relative_path, 1)
           se.save
         end
       end

data/lib/bitclust/methodentry.rb

@@ -29,6 +29,7 @@ module BitClust
     attr_reader :id
 
     def ==(other)
+      return false if self.class != other.class
       @id == other.id
     end
 
@@ -94,14 +95,15 @@ module BitClust
     attr_writer :klass
 
     persistent_properties {
-      property :names,      '[String]'
-      property :visibility, 'Symbol'   # :public | :private | :protected
-      property :kind,       'Symbol'   # :defined | :added | :redefined
-      property :source,     'String'
+      property :names,           '[String]'
+      property :visibility,      'Symbol'   # :public | :private | :protected
+      property :kind,            'Symbol'   # :defined | :added | :redefined
+      property :source,          'String'
+      property :source_location, 'Location'
     }
 
     def inspect
-      c, t, m, lib = methodid2specparts(@id)
+      c, t, _m, _lib = methodid2specparts(@id)
       "\#<method #{c}#{t}#{names().join(',')}>"
     end
 
@@ -114,12 +116,12 @@ module BitClust
     end
 
     def label
-      c, t, m, lib = methodid2specparts(@id)
+      c, t, m, _lib = methodid2specparts(@id)
       "#{t == '$' ? '' : c}#{t}#{m}"
     end
 
     def short_label
-      c, t, m, lib = methodid2specparts(@id)
+      _c, t, m, _lib = methodid2specparts(@id)
       "#{t == '#' ? '' : t}#{m}"
     end
 
@@ -128,7 +130,7 @@ module BitClust
     end
 
     def labels
-      c, t, m, lib = methodid2specparts(@id)
+      c, t, _m, _lib = methodid2specparts(@id)
       names().map {|name| "#{c}#{t}#{name}" }
     end
 

data/lib/bitclust/methodid.rb

@@ -93,6 +93,7 @@ module BitClust
     end
 
     def ==(other)
+      return false if self.class != other.class
       @klass == other.klass and
       @type == other.type and
       @method == other.method

data/lib/bitclust/nameutils.rb

@@ -19,8 +19,8 @@ module BitClust
     LIBNAME_RE     = %r<[\w\-]+(/[\w\-]+)*>
     CONST_RE       = /[A-Z]\w*/
     CONST_PATH_RE  = /#{CONST_RE}(?:::#{CONST_RE})*/
-    CLASS_NAME_RE  = /(?:#{CONST_RE}(?:::compatible)?|fatal|ARGF.class|main)/
-    CLASS_PATH_RE  = /(?:#{CONST_PATH_RE}(?:::compatible)?|fatal|ARGF.class|main)/
+    CLASS_NAME_RE  = /(?:#{CONST_RE}(?:::compatible)?|fatal|ARGF\.class|main)/
+    CLASS_PATH_RE  = /(?:#{CONST_PATH_RE}(?:::compatible)?|fatal|ARGF\.class|main)/
     METHOD_NAME_RE = /\w+[?!=]?|===|==|=~|<=>|<=|>=|!=|!~|!@|!|\[\]=|\[\]|\*\*|>>|<<|\+@|\-@|[~+\-*\/%&|^<>`]/
     TYPEMARK_RE    = /(?:\.|\#|\.\#|::|\$)/
     METHOD_SPEC_RE = /#{CLASS_PATH_RE}#{TYPEMARK_RE}#{METHOD_NAME_RE}/
@@ -67,7 +67,7 @@ module BitClust
     end
 
     def methodid2specstring(id)
-      c, t, m, lib = *split_method_id(id)
+      c, t, m, _lib = *split_method_id(id)
       classid2name(c) + typechar2mark(t) + decodename_url(m)
     end
 
@@ -77,32 +77,32 @@ module BitClust
     end
 
     def methodid2libid(id)
-      c, t, m, lib = *split_method_id(id)
+      _c, _t, _m, lib = *split_method_id(id)
       lib
     end
 
     def methodid2classid(id)
-      c, t, m, lib = *split_method_id(id)
+      c, _t, _m, _lib = *split_method_id(id)
       c
     end
 
     def methodid2typechar(id)
-      c, t, m, lib = *split_method_id(id)
+      _c, t, _m, _lib = *split_method_id(id)
       t
     end
 
     def methodid2typename(id)
-      c, t, m, lib = *split_method_id(id)
+      _c, t, _m, _lib = *split_method_id(id)
       typechar2name(t)
     end
 
     def methodid2typemark(id)
-      c, t, m, lib = *split_method_id(id)
+      _c, t, _m, _lib = *split_method_id(id)
       typechar2mark(t)
     end
 
     def methodid2mname(id)
-      c, t, m, lib = *split_method_id(id)
+      _c, _t, m, _lib = *split_method_id(id)
       decodename_url(m)
     end
 
@@ -120,10 +120,14 @@ module BitClust
       "#{cid}/#{typename2char(t)}.#{encodename_url(name)}.#{libid}"
     end
 
+    @@split_method_id = {}
+
     # private module function
     def split_method_id(id)
-      c, rest = id.split("/")
-      return *[c, *rest.split(%r<[/\.]>, 3)]
+      @@split_method_id[id] ||= begin
+        c, rest = id.split("/")
+        [c, *rest.split(%r<[/\.]>, 3)]
+      end
     end
 
     NAME_TO_MARK = {

data/lib/bitclust/preprocessor.rb

@@ -71,11 +71,20 @@ module BitClust
       cond_init
     end
 
+    def path
+      @f.path if @f.respond_to?(:path)
+    end
+
     private
 
     def next_line(f)
       while line = f.gets
         case line
+        when /\A(?!\#@)/
+          if current_cond.processing?
+            @buf.push line
+            break
+          end
         when /\A\#@\#/   # preprocessor comment
           ;
         when /\A\#@todo/i
@@ -86,7 +95,7 @@ module BitClust
             file = $1.strip
             basedir = File.dirname(line.location.file)
             @buf.concat Preprocessor.process("#{basedir}/#{file}", @params)
-          rescue Errno::ENOENT => err
+          rescue Errno::ENOENT => _err
             raise WrongInclude, "#{line.location}: \#@include'ed file not exist: #{file}"
           end
         when /\A\#@since\b/
@@ -107,13 +116,8 @@ module BitClust
             parse_error "no matching \#@if", line  if cond_toplevel?
             cond_pop
           end
-        when /\A\#@/
-          parse_error "unknown preprocessor directive", line
         else
-          if current_cond.processing?
-            @buf.push line
-            break
-          end
+          parse_error "unknown preprocessor directive", line
         end
       end
       if @buf.empty?
@@ -149,7 +153,7 @@ module BitClust
     end
 
     def cond_init
-      @state_stack = [State.new(nil, :toplevel)]
+      @state_stack = [State.new(true, :toplevel)]
     end
 
     def cond_toplevel?
@@ -158,13 +162,13 @@ module BitClust
 
     def cond_push(bool)
       last = @state_stack.last
-      @state_stack.push(State.new(last.current, bool))
+      @state_stack.push(last.next(bool, :condition))
     end
 
     def cond_invert
       b = @state_stack.pop.processing?
       last = @state_stack.last
-      @state_stack.push(State.new(last.current, !b))
+      @state_stack.push(last.next(!b, :condition))
     end
 
     def cond_pop
@@ -254,7 +258,7 @@ module BitClust
 
     def samplecode_push(description)
       last = @state_stack.last
-      @state_stack.push(State.new(last.current, :samplecode))
+      @state_stack.push(last.next(true, :samplecode))
     end
 
     def samplecode_pop
@@ -276,24 +280,25 @@ module BitClust
     class State
       attr_reader :current
 
-      def initialize(previous, current)
-        @previous = previous
-        @current = current
+      def initialize(is_processing, label)
+        @is_processing = is_processing
+        @label = label
+      end
+
+      def next(is_processing, label)
+        State.new(@is_processing && is_processing, label)
       end
 
       def toplevel?
-        @current == :toplevel
+        @label == :toplevel
       end
 
       def processing?
-        toplevel? ||
-          (@current == true && @previous != false) ||
-          (@current == :samplecode && @previous == true) ||
-          (@current == :samplecode && @previous == :toplevel)
+        @is_processing
       end
 
       def samplecode?
-        @current == :samplecode
+        @label == :samplecode
       end
     end
   end
@@ -320,7 +325,7 @@ module BitClust
             file = $1.strip
             basedir = File.dirname(line.location.file)
             @buf.concat LineCollector.process("#{basedir}/#{file}")
-          rescue Errno::ENOENT => err
+          rescue Errno::ENOENT => _err
             raise WrongInclude, "#{line.location}: \#@include'ed file not exist: #{file}"
           end
         else

data/lib/bitclust/rdcompiler.rb

@@ -229,11 +229,9 @@ module BitClust
         case @f.peek
         when /\A$/
           @f.gets
-        when  /\A[ \t\z]/
+        when  /\A[ \t]/
           line '<p>'
-          @f.while_match(/\A[ \t\z]/) do |line|
-            line compile_text(line.strip)
-          end
+          line compile_text(text_node_from_lines(@f.span(/\A[ \t]/)))
           line '</p>'
         when %r!\A//emlist(?:\[(?:[^\[\]]+?)?\]\[\w+?\])?\{!
           emlist
@@ -249,10 +247,8 @@ module BitClust
       line '<dd>'
       while /\A[ \t]/ =~ @f.peek or %r!\A//emlist(?:\[(?:[^\[\]]+?)?\]\[\w+?\])?\{! =~ @f.peek
         case @f.peek
-        when  /\A[ \t\z]/
-          @f.while_match(/\A[ \t\z]/) do |line|
-            line compile_text(line.strip)
-          end
+        when  /\A[ \t]/
+          line compile_text(text_node_from_lines(@f.span(/\A[ \t]/)))
         when %r!\A//emlist(?:\[(?:[^\[\]]+?)?\]\[\w+?\])?\{!
           emlist
         end
@@ -264,6 +260,11 @@ module BitClust
       "<dt>#{s}</dt>"
     end
 
+    def stop_on_syntax_error?
+      return true unless @option.key?(:stop_on_syntax_error)
+      @option[:stop_on_syntax_error]
+    end
+
     def emlist
       command = @f.gets
       if %r!\A//emlist\[(?<caption>[^\[\]]+?)?\]\[(?<lang>\w+?)\]! =~ command
@@ -280,7 +281,11 @@ module BitClust
             string BitClust::SyntaxHighlighter.new(src, filename).highlight
           rescue BitClust::SyntaxHighlighter::Error => ex
             $stderr.puts ex.message
-            exit(false)
+            if stop_on_syntax_error?
+              exit(false)
+            else
+              string src
+            end
           end
         else
           string src
@@ -313,9 +318,7 @@ module BitClust
 
     def paragraph
       line '<p>'
-      read_paragraph(@f).each do |line|
-        line compile_text(line.strip)
-      end
+      line compile_text(text_node_from_lines(read_paragraph(@f)))
       line '</p>'
     end
 
@@ -325,16 +328,16 @@ module BitClust
 
     def see
       header = @f.gets
-      cmd = header.slice!(/\A\@\w+/)
+      header.slice!(/\A\@\w+/)
       body = [header] + @f.span(/\A\s+\S/)
       line '<p>'
-      line '[SEE_ALSO] ' + compile_text(body.join('').strip)
+      line '[SEE_ALSO] ' + compile_text(text_node_from_lines(body))
       line '</p>'
     end
 
     def todo
       header = @f.gets
-      cmd = header.slice!(/\A\@\w+/)
+      header.slice!(/\A\@\w+/)
       body = header
       line '<p class="todo">'
       line '[TODO]' + body
@@ -368,9 +371,7 @@ module BitClust
     # FIXME: parse @param, @return, ...
     def entry_paragraph
       line '<p>'
-      read_entry_paragraph(@f).each do |line|
-        line compile_text(line.strip)
-      end
+      line compile_text(text_node_from_lines(read_entry_paragraph(@f)))
       line '</p>'
     end
 
@@ -392,6 +393,10 @@ module BitClust
         string a_href(@urlmapper.method_url(methodid2specstring(@method.id)), "permalink")
         string ']['
         string rdoc_link(@method.id, @option[:database].properties["version"])
+        if @option[:edit_base_url] && @method.source_location
+          string ']['
+          string a_href(@urlmapper.edit_url(@method.source_location), 'edit')
+        end
         string ']</span>'
       end
       if @method and not @method.defined?
@@ -552,7 +557,7 @@ module BitClust
     end
 
     def rdoc_url(method_id, version)
-      cname, tmark, mname, libname = methodid2specparts(method_id)
+      cname, tmark, mname, _libname = methodid2specparts(method_id)
       tchar = typemark2char(tmark) == 'i' ? 'i' : 'c'
       cname = cname.split(".").first
       cname = cname.gsub('::', '/')
@@ -591,6 +596,11 @@ module BitClust
       @out.puts
     end
 
+    def text_node_from_lines(lines)
+      lines.map(&:strip).join("\n").gsub(/(\P{ascii})\n(\P{ascii})/) do
+        "#{::Regexp.last_match(1)}#{::Regexp.last_match(2)}"
+      end
+    end
   end
 
 end

data/lib/bitclust/requesthandler.rb

@@ -207,7 +207,7 @@ module BitClust
     end
 
     def defined_type?
-      type, param = parse_path_info()
+      type, _param = parse_path_info()
       case type
       when 'library', 'class', 'method', 'function', 'search', 'opensearchdescription'
         true
@@ -217,7 +217,7 @@ module BitClust
     end
 
     def type_id
-      type, param = parse_path_info()
+      type, _param = parse_path_info()
       type.intern if type
     end
 
@@ -256,7 +256,7 @@ module BitClust
     private
 
     def type_param
-      type, param = parse_path_info()
+      _type, param = parse_path_info()
       return nil unless param
       return nil if param.empty?
       param