ffi-chm 0.1.0

data/README.txt

@@ -0,0 +1,62 @@
+= ffi-chm
+
+* http://github.com/nanki/ffi-chm
+
+== DESCRIPTION:
+
+Ruby bindings for the libchm via FFI.
+
+== FEATURES/PROBLEMS:
+
+* Provides basic access to the CHM files.
+* Currently developed on MRI 1.8 / 1.9
+
+== SYNOPSIS:
+
+  FFI::Chm::ChmFile.new("reference-manual.chm") do |chm|
+    chm.enumerate(:normal, :files).map{|ui| ui[:path]}
+  end
+
+== REQUIREMENTS:
+
+* Ruby
+* libffi
+* libchm
+
+== INSTALL:
+
+  $ gem install ffi-chm
+
+== DEVELOPERS:
+
+After checking out the source, run:
+
+  $ rake newb
+
+This task will install any missing dependencies, run the tests/specs,
+and generate the RDoc.
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2011 NANKI Haruo
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/lib/ffi-chm/api.rb

@@ -0,0 +1,22 @@
+require 'ffi'
+
+module FFI::Chm::API
+  extend FFI::Library
+
+  ffi_lib('chm')
+
+  # proc {|handle, unitinfo, userdata| ... }
+  callback :enumerator, [:pointer, :pointer, :pointer], :int
+
+  prototypes = [
+    [:chm_open, [:string], :pointer],
+    [:chm_close, [:pointer], :void],
+    [:chm_set_param, [:pointer, :int, :int], :void],
+    [:chm_resolve_object, [:pointer, :string, :buffer_out], :int],
+    [:chm_retrieve_object, [:pointer, :pointer, :buffer_out, :uint64, :int64], :int64],
+    [:chm_enumerate, [:pointer, :int, :enumerator, :pointer], :int],
+    [:chm_enumerate_dir, [:pointer, :string, :int, :enumerator, :pointer], :int]
+  ]
+
+  prototypes.each {|func| attach_function(*func)}
+end

data/lib/ffi-chm/const.rb

@@ -0,0 +1,33 @@
+module FFI::Chm::Const
+  MAX_PATHLEN = 512
+
+  UNCOMPRESSED = 0
+  COMPRESSED = 1
+
+  PARAM_MAX_BLOCKS_CACHED = 0
+
+  RESOLVE_SUCCESS = 0
+  RESOLVE_FAILURE = 1
+
+  ENUMERATE_NORMAL = 1
+  ENUMERATE_META = 2
+  ENUMERATE_SPECIAL = 4
+
+  ENUMERATE_FILES = 8
+  ENUMERATE_DIRS = 16
+
+  ENUMERATE_ALL = 31
+
+  ENUMERATE_FLAGS = Hash[
+    :normal, ENUMERATE_NORMAL,
+    :meta, ENUMERATE_META,
+    :special, ENUMERATE_SPECIAL,
+    :files, ENUMERATE_FILES,
+    :dirs, ENUMERATE_DIRS,
+    :all, ENUMERATE_ALL
+  ]
+
+  ENUMERATOR_FAILURE = 0
+  ENUMERATOR_CONTINUE = 1
+  ENUMERATOR_SUCCESS = 2
+end

data/lib/ffi-chm.rb

@@ -0,0 +1,132 @@
+module FFI
+  module Chm
+    VERSION = '0.1.0'
+  end
+end
+
+require 'ffi-chm/const'
+require 'ffi-chm/api'
+
+module FFI::Chm
+  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

data/test/test_ffi_chm.rb

@@ -0,0 +1,8 @@
+require "test/unit"
+require "ffi-chm"
+
+class TestFFIChm < Test::Unit::TestCase
+  def test_ffi_chm
+    assert true
+  end
+end

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification 
+name: ffi-chm
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: 
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- nanki
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-07-28 00:00:00 +09:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: ffi
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 2
+        - 10
+        version: "2.10"
+  type: :development
+  version_requirements: *id002
+description: Ruby bindings for the libchm via FFI.
+email: 
+- nanki@dotswitch.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.txt
+files: 
+- README.txt
+- lib/ffi-chm.rb
+- lib/ffi-chm/api.rb
+- lib/ffi-chm/const.rb
+- test/test_ffi_chm.rb
+- .gemtest
+has_rdoc: true
+homepage: http://github.com/nanki/ffi-chm
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --main
+- README.txt
+require_paths: 
+- lib
+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 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: ffi-chm
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Ruby bindings for the libchm via FFI.
+test_files: 
+- test/test_ffi_chm.rb