ffi-chm 0.1.0 → 0.2.0

data/README.txt

@@ -9,12 +9,15 @@ Ruby bindings for the libchm via FFI.
 == FEATURES/PROBLEMS:
 
 * Provides basic access to the CHM files.
-* Currently developed on MRI 1.8 / 1.9
+* Some functionalities to access to internal structure.
+* Currently developed on MRI 1.8.7 / 1.9.2
 
 == SYNOPSIS:
 
   FFI::Chm::ChmFile.new("reference-manual.chm") do |chm|
     chm.enumerate(:normal, :files).map{|ui| ui[:path]}
+
+    puts chm.title
   end
 
 == REQUIREMENTS:

data/lib/ffi-chm/chm_file/aux.rb

@@ -0,0 +1,39 @@
+require 'nokogiri'
+require 'ffi-chm/com8ble'
+
+module FFI::Chm::ChmFile::Aux
+  include FFI::Chm
+
+  def system
+    @system ||= Struct::System.new.read self.retrieve_object("/#SYSTEM")
+  end
+
+  def encoding
+    @encoding ||= self.system.encoding
+  end
+
+  def title
+    @title ||= self.system.record(3).data.title.com8ble.force_encoding(encoding).encode("UTF-8")
+  end
+
+  def contents(cache=true)
+    return @contents if @contents
+    xml = self.retrieve_object("/#{self.system.record(6).data.compiled_file}.hhc").com8ble.force_encoding(encoding).encode("UTF-8")
+    doc = Struct::HHXDocument.new(Struct::HHC::Entry)
+    Nokogiri::HTML::SAX::Parser.new(doc).parse(xml)
+
+    doc.root.first.tap do |v|
+      @contents = v if cache
+    end
+  end
+
+  def index(cache=true)
+    return @index if @index
+    xml = self.retrieve_object("/#{self.system.record(6).data.compiled_file}.hhk").com8ble.force_encoding(encoding).encode("UTF-8")
+    doc = Struct::HHXDocument.new(Struct::HHK::Entry)
+    Nokogiri::HTML::SAX::Parser.new(doc).parse(xml)
+    doc.root.flatten.tap do |v|
+      @index = v if cache
+    end
+  end
+end

data/lib/ffi-chm/chm_file.rb

@@ -0,0 +1,102 @@
+module FFI::Chm
+  class ChmFile
+    require 'ffi-chm/chm_file/aux'
+    include Aux
+
+    attr_reader :path
+
+    def initialize(path, &block)
+      @path = path
+      self.open &block if block_given?
+    end
+
+    def open(path=@path, &block)
+      @path = path
+      @h = API.chm_open @path
+      raise ChmError, "Not exists?" if @h.null?
+      if block_given?
+        begin
+          yield self
+        ensure
+          self.close
+        end
+      else
+        self
+      end
+    end
+
+    def close
+      API.chm_close @h unless @h.null?
+    end
+
+    def set_param(param, value)
+      API.chm_set_param @h, param, value
+    end
+
+    def resolve_object(name)
+      ui = UnitInfo.new
+      case API.chm_resolve_object @h, name, ui
+      when Const::RESOLVE_SUCCESS
+        ui
+      when Const::RESOLVE_FAILURE
+        raise ResolveError
+      end
+    end
+
+    def retrieve_object(ui)
+      if UnitInfo === ui
+        buf = FFI::Buffer.new ui[:length]
+        API.chm_retrieve_object @h, ui, buf, 0, ui[:length]
+        buf.read_bytes buf.size
+      else
+        retrieve_object resolve_object(ui)
+      end
+    rescue ResolveError
+      raise RetrieveError, ui
+    end
+
+    require 'enumerator'
+    def enumerate(*what, &block)
+      if block_given?
+        API.chm_enumerate @h, to_flags(what), enum_func(&block), nil
+        self
+      else
+        (Enumerable::Enumerator rescue Enumerator).new self, :enumerate, to_flags(what)
+      end
+    end
+
+    def enumerate_dir(prefix, *what, &block)
+      if block_given?
+        API.chm_enumerate_dir @h, prefix, to_flags(what), enum_func(&block), nil
+        self
+      else
+        (Enumerable::Enumerator rescue Enumerator).new self, :enumerate_dir, prefix, to_flags(what)
+      end
+    end
+
+    private
+    def enum_func(&block)
+      lambda do |h, ui, _|
+        begin
+          if block.call(UnitInfo.new(ui).clone) == :break
+            Const::ENUMERATOR_SUCCESS
+          else
+            Const::ENUMERATOR_CONTINUE
+          end
+        rescue
+          Const::ENUMERATOR_FAILURE
+        end
+      end
+    end
+
+    def to_flags(what)
+      if what.size == 1 && Integer === what.first
+        what.first
+      else
+        what.inject(0) do |r, sym|
+          r | (Const::ENUMERATE_FLAGS[sym] || 0)
+        end
+      end
+    end
+  end
+end

data/lib/ffi-chm/com8ble.rb

@@ -0,0 +1,37 @@
+module Com8ble
+  module String
+    require 'iconv'
+
+    def force_encoding(encoding)
+      @encoding = _encoding(encoding)
+      self
+    end
+
+    def encoding
+      @encoding
+    end
+
+    def encode(encoding)
+      r = Iconv.conv(_encoding(encoding).name, @encoding.name, self)
+      r.extend String
+      r.force_encoding encoding
+      r
+    end
+
+    private
+    def _encoding(encoding)
+      if ::String === encoding
+        Struct.new(:name).new(encoding)
+      else
+        encoding
+      end
+    end
+  end
+end
+
+class String
+  def com8ble
+    self.extend Com8ble::String unless self.respond_to? :force_encoding
+    self
+  end
+end

data/lib/ffi-chm/struct/hhc/entry.rb

@@ -0,0 +1,4 @@
+module FFI::Chm::Struct::HHC
+  class Entry < Struct.new(:Name, :Type, :Local, :URL, :FrameName, :WindowName, :Comment, :Merge, :ImageNumber, :New)
+  end
+end

data/lib/ffi-chm/struct/hhk/entry.rb

@@ -0,0 +1,7 @@
+module FFI::Chm::Struct::HHK
+  class Entry < Struct.new(:Name, :Type, :Local, :URL, :FrameName, :WindowName, :Comment, :Merge, :'See Also')
+    def SeeAlso
+      self["See Also"]
+    end
+  end
+end

data/lib/ffi-chm/struct/hhx_document.rb

@@ -0,0 +1,41 @@
+module FFI::Chm::Struct
+  class HHXDocument < Nokogiri::XML::SAX::Document
+    # ul - li - object - param
+    attr_reader :root
+
+    def initialize(entry_klass)
+      @klass = entry_klass
+    end
+
+    def start_document
+      @root = []
+      @heads = []
+      @heads << @root
+    end
+
+    def start_element(name, attributes = [])
+      case name
+      when "param"
+        return unless @entry
+        attr = {}
+        attributes.each_slice(2){|k, v| attr[k.intern] = v}
+        @entry[attr[:name].intern] = attr[:value]
+      when "li"
+        @entry = @klass.new
+      when "ul"
+        head = []
+        @heads.last << head
+        @heads << head
+      end
+    end
+
+    def end_element(name, *attributes)
+      case name
+      when "object" # li results broken structure.
+        @heads.last << @entry if @entry
+      when "ul"
+        @heads.pop
+      end
+    end
+  end
+end

data/lib/ffi-chm/struct/system/code3.rb

@@ -0,0 +1,3 @@
+class FFI::Chm::Struct::System::Code3 < BinData::Record
+  stringz :title
+end

data/lib/ffi-chm/struct/system/code4.rb

@@ -0,0 +1,11 @@
+class FFI::Chm::Struct::System::Code4 < BinData::Record
+  endian :little
+
+  uint32 :lcid
+  uint32 :use_dbcs
+  uint32 :fulltext_enabled
+  uint32 :has_klinks
+  uint32 :has_alinks
+  uint64 :timestamp
+  uint64 :unknown
+end

data/lib/ffi-chm/struct/system/code6.rb

@@ -0,0 +1,3 @@
+class FFI::Chm::Struct::System::Code6 < BinData::Record
+  stringz :compiled_file
+end

data/lib/ffi-chm/struct/system/record.rb

@@ -0,0 +1,17 @@
+class FFI::Chm::Struct::System::Record < BinData::Record
+  require 'ffi-chm/struct/system/code3'
+  require 'ffi-chm/struct/system/code4'
+  require 'ffi-chm/struct/system/code6'
+
+  endian :little
+
+  uint16 :code
+  uint16 :len
+
+  choice :data, :selection => :code do
+    code3 3
+    code4 4
+    code6 6
+    string :default, :read_length => :len
+  end
+end

data/lib/ffi-chm/struct/system.rb

@@ -0,0 +1,23 @@
+class FFI::Chm::Struct::System < BinData::Record
+  require 'ffi-chm/struct/system/record'
+
+  endian :little
+
+  uint32 :version
+  array :records, :type => :record, :read_until => :eof
+
+
+  def record(code)
+    @memo ||= Hash[*records.map{|v|[v.code.to_i, v]}.flatten]
+    @memo[code]
+  end
+
+  def encoding
+    case self.record(4).data.lcid.to_i
+    when 1041
+      "CP932"
+    else
+      "UTF-8"
+    end
+  end
+end

data/lib/ffi-chm/struct.rb

@@ -0,0 +1,8 @@
+require 'bindata'
+
+module FFI::Chm::Struct
+  autoload :System, 'ffi-chm/struct/system'
+  autoload :HHK, 'ffi-chm/struct/hhk/entry'
+  autoload :HHC, 'ffi-chm/struct/hhc/entry'
+  autoload :HHXDocument, 'ffi-chm/struct/hhx_document'
+end

data/lib/ffi-chm/unit_info.rb

@@ -0,0 +1,28 @@
+module FFI::Chm
+  class UnitInfo < FFI::Struct
+    layout :start, :uint64,
+           :length, :uint64,
+           :space, :int,
+           :flags, :int,
+           :path, [:char, Const::MAX_PATHLEN + 1]
+
+    def dir?
+      flag? :dirs
+    end
+
+    def file?
+      flag? :files
+    end
+
+    %w(normal special meta).each do |name|
+      define_method("#{name}?") do
+        flag? name.intern
+      end
+    end
+
+    private
+    def flag?(flag)
+      !!(self[:flags] & Const::ENUMERATE_FLAGS[flag]).nonzero?
+    end
+  end
+end

data/lib/ffi-chm.rb

@@ -1,6 +1,6 @@
 module FFI
   module Chm
-    VERSION = '0.1.0'
+    VERSION = '0.2.0'
   end
 end
 
@@ -8,125 +8,14 @@ require 'ffi-chm/const'
 require 'ffi-chm/api'
 
 module FFI::Chm
+  autoload :Struct, 'ffi-chm/struct'
+  autoload :ChmFile, 'ffi-chm/chm_file'
+  autoload :UnitInfo, 'ffi-chm/unit_info'
+
   include API
   include Const
 
   class ChmError < StandardError;end
   class ResolveError < ChmError;end
   class RetrieveError < ChmError;end
-
-  class ChmFile
-    def initialize(fn)
-      @h = API.chm_open fn
-      raise ChmError, "Not exists?" if @h.null?
-      if block_given?
-        begin
-          yield self
-        ensure
-          self.close
-        end
-      end
-    end
-
-    def close
-      API.chm_close @h unless @h.null?
-    end
-
-    def set_param(param, value)
-      API.chm_set_param @h, param, value
-    end
-
-    def resolve_object(name)
-      ui = UnitInfo.new
-      case API.chm_resolve_object @h, name, ui
-      when Const::RESOLVE_SUCCESS
-        ui
-      when Const::RESOLVE_FAILURE
-        raise ResolveError
-      end
-    end
-
-    def retrieve_object(ui)
-      if UnitInfo === ui
-        buf = FFI::Buffer.new ui[:length]
-        API.chm_retrieve_object @h, ui, buf, 0, ui[:length]
-        buf.read_bytes buf.size
-      else
-        retrieve_object resolve_object(ui)
-      end
-    rescue ResolveError
-      raise RetrieveError, ui
-    end
-
-    require 'enumerator'
-    def enumerate(*what, &block)
-      if block_given?
-        API.chm_enumerate @h, to_flags(what), enum_func(&block), nil
-        self
-      else
-        (Enumerable::Enumerator rescue Enumerator).new self, :enumerate, to_flags(what)
-      end
-    end
-
-    def enumerate_dir(prefix, *what, &block)
-      if block_given?
-        API.chm_enumerate_dir @h, prefix, to_flags(what), enum_func(&block), nil
-        self
-      else
-        (Enumerable::Enumerator rescue Enumerator).new self, :enumerate_dir, prefix, to_flags(what)
-      end
-    end
-
-    private
-    def enum_func(&block)
-      lambda do |h, ui, _|
-        begin
-          if block.call(UnitInfo.new(ui).clone) == :break
-            Const::ENUMERATOR_SUCCESS
-          else
-            Const::ENUMERATOR_CONTINUE
-          end
-        rescue
-          Const::ENUMERATOR_FAILURE
-        end
-      end
-    end
-
-    def to_flags(what)
-      if what.size == 1 && Integer === what.first
-        what.first
-      else
-        what.inject(0) do |r, sym|
-          r | (Const::ENUMERATE_FLAGS[sym] || 0)
-        end
-      end
-    end
-  end
-
-  class UnitInfo < FFI::Struct
-    layout :start, :uint64,
-           :length, :uint64,
-           :space, :int,
-           :flags, :int,
-           :path, [:char, Const::MAX_PATHLEN + 1]
-
-    def dir?
-      flag? :dirs
-    end
-
-    def file?
-      flag? :files
-    end
-
-    %w(normal special meta).each do |name|
-      define_method("#{name}?") do
-        flag? name.intern
-      end
-    end
-
-    private
-    def flag?(flag)
-      !!(self[:flags] & Const::ENUMERATE_FLAGS[flag]).nonzero?
-    end
-  end
 end

metadata

@@ -1,102 +1,112 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: ffi-chm
-version: !ruby/object:Gem::Version 
-  hash: 27
+version: !ruby/object:Gem::Version
+  version: 0.2.0
   prerelease: 
-  segments: 
-  - 0
-  - 1
-  - 0
-  version: 0.1.0
 platform: ruby
-authors: 
+authors:
 - nanki
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-07-28 00:00:00 +09:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2011-08-04 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: ffi
+  requirement: &70275895477860 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
   prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  version_requirements: *70275895477860
+- !ruby/object:Gem::Dependency
+  name: bindata
+  requirement: &70275895475840 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70275895475840
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: &70275895474760 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: hoe
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: *70275895474760
+- !ruby/object:Gem::Dependency
+  name: hoe
+  requirement: &70275895473500 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 23
-        segments: 
-        - 2
-        - 10
-        version: "2.10"
+      - !ruby/object:Gem::Version
+        version: '2.10'
   type: :development
-  version_requirements: *id002
+  prerelease: false
+  version_requirements: *70275895473500
 description: Ruby bindings for the libchm via FFI.
-email: 
+email:
 - nanki@dotswitch.net
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files:
 - README.txt
-files: 
+files:
 - README.txt
-- lib/ffi-chm.rb
 - lib/ffi-chm/api.rb
+- lib/ffi-chm/chm_file/aux.rb
+- lib/ffi-chm/chm_file.rb
+- lib/ffi-chm/com8ble.rb
 - lib/ffi-chm/const.rb
+- lib/ffi-chm/struct/hhc/entry.rb
+- lib/ffi-chm/struct/hhk/entry.rb
+- lib/ffi-chm/struct/hhx_document.rb
+- lib/ffi-chm/struct/system/code3.rb
+- lib/ffi-chm/struct/system/code4.rb
+- lib/ffi-chm/struct/system/code6.rb
+- lib/ffi-chm/struct/system/record.rb
+- lib/ffi-chm/struct/system.rb
+- lib/ffi-chm/struct.rb
+- lib/ffi-chm/unit_info.rb
+- lib/ffi-chm.rb
 - test/test_ffi_chm.rb
 - .gemtest
-has_rdoc: true
 homepage: http://github.com/nanki/ffi-chm
 licenses: []
-
 post_install_message: 
-rdoc_options: 
+rdoc_options:
 - --main
 - README.txt
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: ffi-chm
-rubygems_version: 1.6.2
+rubygems_version: 1.8.6
 signing_key: 
 specification_version: 3
 summary: Ruby bindings for the libchm via FFI.
-test_files: 
+test_files:
 - test/test_ffi_chm.rb