ffi-gphoto2 0.4.1 → 0.5.0

data/lib/gphoto2/camera_file_path.rb

@@ -1,21 +1,19 @@
 module GPhoto2
   class CameraFilePath
-    attr_reader :ptr
+    include GPhoto2::Struct
 
     def initialize(ptr = nil)
       @ptr = ptr || FFI::GPhoto2::CameraFilePath.new
     end
 
+    # @return [String]
     def name
       ptr[:name].to_s
     end
 
+    # @return [String]
     def folder
       ptr[:folder].to_s
     end
-
-    def to_ptr
-      @ptr
-    end
   end
 end

data/lib/gphoto2/camera_folder.rb

@@ -2,6 +2,7 @@ module GPhoto2
   class CameraFolder
     include FFI::GPhoto2
 
+    # @return [String]
     attr_reader :path
 
     def initialize(camera, path = '/')
@@ -9,10 +10,12 @@ module GPhoto2
       @path = path
     end
 
+    # @return [Boolean]
     def root?
       @path == '/'
     end
 
+    # @return [String]
     def name
       if root?
         '/'
@@ -21,14 +24,18 @@ module GPhoto2
       end
     end
 
+    # @return [Array<GPhoto2::CameraFolder>]
     def folders
       folder_list_folders
     end
 
+    # @return [Array<GPhoto2::CameraFile>]
     def files
       folder_list_files
     end
 
+    # @param [String] name the name of the directory
+    # @return [GPhoto2::CameraFolder]
     def cd(name)
       case name
       when '.'
@@ -41,10 +48,13 @@ module GPhoto2
     end
     alias_method :/, :cd
 
+    # @param [String] name the filename of the file to open
+    # @return [GPhoto2::CameraFile]
     def open(name)
       CameraFile.new(@camera, @path, name)
     end
 
+    # @return [GPhoto2::CameraFolder]
     def up
       if root?
         self
@@ -55,6 +65,7 @@ module GPhoto2
       end
     end
 
+    # @return [String]
     def to_s
       name
     end

data/lib/gphoto2/camera_list.rb

@@ -1,30 +1,23 @@
 module GPhoto2
   class CameraList
     include FFI::GPhoto2
-
-    attr_reader :ptr
+    include GPhoto2::Struct
 
     def initialize
       new
     end
 
-    def finalize
-      free
-    end
-
+    # @return [Integer]
     def size
       count
     end
     alias_method :length, :size
 
+    # @return [Array<GPhoto2::Entry>]
     def to_a
       size.times.map { |i| Entry.new(self, i) }
     end
 
-    def to_ptr
-      @ptr
-    end
-
     private
 
     def new

data/lib/gphoto2/camera_widgets/camera_widget.rb

@@ -1,9 +1,11 @@
 module GPhoto2
+  # @abstract
   class CameraWidget
     include FFI::GPhoto2
+    include GPhoto2::Struct
 
-    attr_reader :ptr
-
+    # @param [FFI::GPhoto2::CameraWidget] ptr
+    # @param [GPhoto2::CameraWidget] parent
     def self.factory(ptr, parent = nil)
       # ptr fields are supposed to be private, but we ignore that here
       type = ptr[:type].to_s.split('_').last.capitalize
@@ -11,41 +13,52 @@ module GPhoto2
       klass.new(ptr, parent)
     end
 
+    # @param [FFI::GPhoto2::CameraWidget] ptr
+    # @param [GPhoto2::CameraWidget] parent
     def initialize(ptr, parent = nil)
       @ptr = ptr
       @parent = parent
     end
 
+    # @return [void]
     def finalize
       free
     end
     alias_method :close, :finalize
 
+    # @return [String]
     def label
       get_label
     end
 
+    # @return [String]
     def name
       get_name
     end
 
+    # @return [Object]
     def value
       get_value
     end
 
+    # @return [Object]
     def value=(value)
       set_value(value)
       value
     end
 
+    # @return [CameraWidgetType]
     def type
       get_type
     end
 
+    # @return [Array<GPhoto2::CameraWidget>]
     def children
       count_children.times.map { |i| get_child(i) }
     end
 
+    # @param [Hash<String,GPhoto2::CameraWidget>] map
+    # @return [Hash<String,GPhoto2::CameraWidget>]
     def flatten(map = {})
       case type
       when :window, :section
@@ -59,12 +72,19 @@ module GPhoto2
       map
     end
 
+    # @param [String]
     def to_s
       value.to_s
     end
 
-    def to_ptr
-      @ptr
+    protected
+
+    def get_value
+      raise NotImplementedError
+    end
+
+    def set_value(value)
+      raise NotImplementedError
     end
 
     private
@@ -86,14 +106,6 @@ module GPhoto2
       str_ptr.null? ? nil : str_ptr.read_string
     end
 
-    def get_value
-      raise NotImplementedError
-    end
-
-    def set_value(value)
-      raise NotImplementedError
-    end
-
     def get_type
       # assume CameraWidgetType is an int
       type = FFI::MemoryPointer.new(:int)
@@ -108,15 +120,16 @@ module GPhoto2
       str_ptr.write_pointer(str)
 
       rc = gp_widget_get_type(ptr, str_ptr)
+      GPhoto2.check!(rc)
 
       str_ptr = str_ptr.read_pointer
       str_ptr.null? ? nil : str_ptr.read_string
     end
 
     def count_children
-      rc = gp_widget_count_children(ptr)
+      count = rc = gp_widget_count_children(ptr)
       GPhoto2.check!(rc)
-      rc
+      count
     end
 
     def get_child(index)

data/lib/gphoto2/camera_widgets/radio_camera_widget.rb

@@ -1,5 +1,6 @@
 module GPhoto2
   class RadioCameraWidget < CameraWidget
+    # @return [Array<String>]
     def choices
       count_choices.times.map { |i| get_choice(i) }
     end

data/lib/gphoto2/camera_widgets/range_camera_widget.rb

@@ -1,5 +1,6 @@
 module GPhoto2
   class RangeCameraWidget < CameraWidget
+    # @return [Array<Number>]
     def range
       min, max, inc = get_range
       (min..max).step(inc).to_a

data/lib/gphoto2/context.rb

@@ -1,22 +1,18 @@
 module GPhoto2
   class Context
     include FFI::GPhoto2
-
-    attr_reader :ptr
+    include GPhoto2::Struct
 
     def initialize
       new
     end
 
+    # @return [void]
     def finalize
       unref
     end
     alias_method :close, :finalize
 
-    def to_ptr
-      @ptr
-    end
-
     private
 
     def new

data/lib/gphoto2/entry.rb

@@ -7,10 +7,12 @@ module GPhoto2
       @index = index
     end
 
+    # @return [String]
     def name
       get_name
     end
 
+    # @return [String]
     def value
       get_value
     end

data/lib/gphoto2/port_info.rb

@@ -1,37 +1,39 @@
 module GPhoto2
   class PortInfo
     include FFI::GPhoto2Port
+    include GPhoto2::Struct
 
-    attr_reader :ptr
-
+    # @param [String] port
+    # @return [GPhoto2::PortInfo]
     def self.find(port)
       port_info_list = PortInfoList.new
       index = port_info_list.lookup_path(port)
       port_info_list[index]
     end
 
+    # @param [GPhoto2::PortInfoList] port_info_list
+    # @param [Integer] index
     def initialize(port_info_list, index)
       @port_info_list = port_info_list
       @index = index
       new
     end
 
+    # @return [String]
     def name
       get_name
     end
 
+    # @return [String]
     def path
       get_path
     end
 
+    # @return [GPPortType]
     def type
       get_type
     end
 
-    def to_ptr
-      @ptr
-    end
-
     private
 
     def new

data/lib/gphoto2/port_info_list.rb

@@ -1,28 +1,27 @@
 module GPhoto2
   class PortInfoList
     include FFI::GPhoto2Port
-
-    attr_reader :ptr
+    include GPhoto2::Struct
 
     def initialize
       new
       load
     end
 
+    # @param [String] port
+    # @return [Integer]
     def lookup_path(port)
       _lookup_path(port)
     end
     alias_method :index, :lookup_path
 
+    # @param [Integer] index
+    # @return [GPhoto2::PortInfo]
     def at(index)
       PortInfo.new(self, index)
     end
     alias_method :[], :at
 
-    def to_ptr
-      @ptr
-    end
-
     private
 
     def new

data/lib/gphoto2/port_result.rb

@@ -1,5 +1,7 @@
 module GPhoto2
   class PortResult
+    # @param [Integer] rc
+    # @return [String]
     def self.as_string(rc)
       FFI::GPhoto2Port.gp_port_result_as_string(rc)
     end

data/lib/gphoto2/struct.rb

@@ -0,0 +1,11 @@
+module GPhoto2
+  module Struct
+    # @return [FFI::Struct]
+    attr_reader :ptr
+
+    # @return [FFI::Struct]
+    def to_ptr
+      ptr
+    end
+  end
+end

data/lib/gphoto2/version.rb

@@ -1,3 +1,3 @@
 module GPhoto2
-  VERSION = '0.4.1'
+  VERSION = '0.5.0'
 end

data/lib/gphoto2.rb

@@ -5,6 +5,8 @@ require 'ffi'
 require 'ffi/gphoto2'
 require 'ffi/gphoto2_port'
 
+require 'gphoto2/struct'
+
 require 'gphoto2/camera_widgets/camera_widget'
 require 'gphoto2/camera_widgets/date_camera_widget'
 require 'gphoto2/camera_widgets/menu_camera_widget'
@@ -14,7 +16,13 @@ require 'gphoto2/camera_widgets/section_camera_widget'
 require 'gphoto2/camera_widgets/text_camera_widget'
 require 'gphoto2/camera_widgets/toggle_camera_widget'
 require 'gphoto2/camera_widgets/window_camera_widget'
+
+require 'gphoto2/camera/capture'
+require 'gphoto2/camera/configuration'
+require 'gphoto2/camera/event'
+require 'gphoto2/camera/filesystem'
 require 'gphoto2/camera'
+
 require 'gphoto2/camera_abilities'
 require 'gphoto2/camera_abilities_list'
 require 'gphoto2/camera_event'
@@ -27,13 +35,18 @@ require 'gphoto2/entry'
 require 'gphoto2/port_info'
 require 'gphoto2/port_info_list'
 require 'gphoto2/port_result'
+
 require 'gphoto2/version'
 
 module GPhoto2
+  # @return [Logger]
   def self.logger
     @logger ||= Logger.new(STDERR)
   end
 
+  # @param [Integer] rc
+  # @return [void]
+  # @raise RuntimeError when the return code is not {FFI::GPhoto2Port::GP_OK}
   def self.check!(rc)
     logger.debug "#{caller.first} => #{rc}" if ENV['DEBUG']
     return if rc >= FFI::GPhoto2Port::GP_OK