gogyou 0.2.4 → 0.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9633436e949f5045c684dde26894ed49cb30630e
-  data.tar.gz: 86d4d3037ebbbf38f66757aa1735cdb4430f684b
+  metadata.gz: 163f1b2f74bea2dc136f06beb499aaf9904db858
+  data.tar.gz: b7d8d846d1dfa2ee4747ab51d5dabdf29bdc63f4
 SHA512:
-  metadata.gz: 014588ae16a1e4def6fb346f49f8102e268d7035e0b0a7174430c3a1e31dccc085dc5c5045f9fcba7f3c7fe738892ff34e26d7503eb8d0b4c0e90447f0655c93
-  data.tar.gz: dc82211d768d36370a59b67b03e3715cde0cea1c351f0914ec6f6948cfeac50b0c8bdc21e306684fe7e1e3e517b949cf848067592a1adcde0a823fdeb6e2c0ea
+  metadata.gz: e0ab33b2ed9a6758fdd4d784839138aa78f1ef17ba18def71a46063bf8a95ed7e5b52241635abfd247c117056457bf526c25e6701425d9fc010dfb3c72a17f0d
+  data.tar.gz: 44db392c49b2afe2649b1815ea12e3770499ae0697eb848bb0744953990d25b760000c3bcf905d62fdc62bf2159c63909686c490482e2e40d2fd54fd5ef1cdea

data/HISTORY.ja.md

@@ -1,5 +1,19 @@
 # gogyou の更新履歴
 
+## gogyou-0.2.5 (2015-10-20)
+
+  * 可変長要素に続く要素の定義
+
+    構造体定義中に可変長要素を置いた場合、続く要素を定義出来ませんでしたがこの制限を撤廃しています。
+
+    この場合、可変長要素の可変長領域と、続く要素の領域以降が重なるため、部分的に union を用いたような動作となります。
+
+  * ポインタ要素の実現 (実験的)
+
+    非常に限定的ながらポインタ要素の定義を可能としました。
+    詳細は pointer.ja.md を参照して下さい。
+
+
 ## gogyou-0.2.4 (2015-10-16)
 
   * 環境依存の型に対する結果の正確性を修正

data/README.md

@@ -23,7 +23,7 @@ ruby 構文による、C 言語の構造体・共用体・多次元配列 (も
   * Distribute License (頒布ライセンス): 2-clause BSD License (二条項 BSD ライセンス)
   * Software Quarity (ソフトウェア品質): EXPERIMENTAL
   * User (想定利用者): Rubyist
-  * Release Number (リリースナンバー): 0.2.4
+  * Release Number (リリースナンバー): 0.2.5
   * Memory Usage (使用メモリ量): 2 MB +
   * Installed Size (インストール容量): under 1 MB
   * Project Page: <https://osdn.jp/projects/rutsubo/>
@@ -32,7 +32,7 @@ ruby 構文による、C 言語の構造体・共用体・多次元配列 (も
 ## Example
 
 ruby/ruby.h の ``struct RBasic`` と ``struct RObject`` を gogyou を用いて次のように記述出来ます
-(ポインタの定義はできていないため、``uintptr_t`` で置き換えています):
+(ポインタの定義は ``uintptr_t`` で置き換えています):
 
 ``` ruby:ruby
 require "gogyou"
@@ -54,8 +54,8 @@ module MyRuby
     union -> {
       struct -> {
         long :numiv
-        uintptr_t :ivptr
-        uintptr_t :iv_index_tbl
+        uintptr_t :ivptr        # VALUE *ivptr
+        uintptr_t :iv_index_tbl # struct st_table *iv_index_tbl
       }, :heap
       VALUE :ary, ROBJECT_EMBED_LEN_MAX
     }, :as
@@ -632,9 +632,6 @@ data = YourStruct.bind(ptr)
 
 ## Demerit (短所)
 
-  * Can't be handled pointer
-    (ポインタが扱えない)
-
   * The cost is high for reference/asignment from/to fields
     (フィールドに対する参照・代入のコストが高い)
 

data/Rakefile

@@ -24,7 +24,8 @@ GEMSTUB.extensions += EXTCONF
 GEMSTUB.executables += FileList["bin/*"].map { |n| File.basename n }
 GEMSTUB.executables.sort!
 
-GEMFILE = "#{GEMSTUB.name}-#{GEMSTUB.version}.gem"
+PACKAGENAME = "#{GEMSTUB.name}-#{GEMSTUB.version}"
+GEMFILE = "#{PACKAGENAME}.gem"
 GEMSPEC = "#{GEMSTUB.name}.gemspec"
 
 GEMSTUB.files += DOC + EXT + EXTCONF + BIN + LIB + SPEC + TEST + EXAMPLE + RAKEFILE + EXTRA
@@ -143,6 +144,11 @@ task gem: GEMFILE
 desc "generate gemspec"
 task gemspec: GEMSPEC
 
+desc "print package name"
+task "package-name" do
+  puts PACKAGENAME
+end
+
 file GEMFILE => DOC + EXT + EXTCONF + BIN + LIB + SPEC + TEST + EXAMPLE + RAKEFILE + [GEMSPEC] do
   sh "gem build #{GEMSPEC}"
 end

data/gemstub.rb

@@ -10,11 +10,15 @@ The gogyou is a library written at pure ruby that provides auxiliary features of
 
 The C-liked struct, union and multidimensional array definition are posible in ruby syntax.
 
-* Available nested struct and union with anonymous field.
-* Available multidimensional array.
-* Available const field.
-* Available packed field.
-* Available user definition types.
+Available features:
+
+(1) nested struct and union with anonymous field
+(2) multidimensional array
+(3) field of variable array
+(4) const field
+(5) packed field
+(6) user definition types
+(7) (EXPERIMENTAL AND LIMITATION FEATURE) pointer
 EOS
   s.license = "2-clause BSD License"
   s.author = "dearblue"
@@ -26,6 +30,8 @@ EOS
   s.add_development_dependency "rake", "~> 10.0"
 end
 
+DOC << "pointer.ja.md"
+
 primitives = "lib/gogyou/primitives.rb"
 mkprims = "mkprims.rb"
 LIB << primitives

data/lib/gogyou.rb

@@ -163,6 +163,12 @@
 module Gogyou
   Gogyou = self
 
+  class PointerError < ::RuntimeError
+  end
+
+  class NullPointerError < PointerError
+  end
+
   require_relative "gogyou/version"
   require_relative "gogyou/typespec"
   require_relative "gogyou/extensions"
@@ -424,6 +430,8 @@ module Gogyou
   #   typedef type, aliasname -> self
   #   typedef type, aliasname, *elements -> self
   #
+  # ***limitation***: not usable the pointer.
+  #
   # [type]
   #   This parameter can given a symbol or an object.
   #

data/lib/gogyou/accessor.rb

@@ -177,6 +177,12 @@ module Gogyou
       subarray
     end
 
+    def self.define_subpointer(typeobj, constant = false)
+      newtype = Accessor::Pointer.define(typeobj)
+      Accessor.const_set("AnonymousPointer_%08X" % newtype.__id__, newtype)
+      newtype
+    end
+
     def self.define_accessors(accessorclass, model)
       accessorclass.class_eval do
         namecheck = {}
@@ -252,6 +258,114 @@ module Gogyou
       self::EXTENSIBLE
     end
 
+    class Pointer < Accessor
+      BYTESIZE = Primitives::SIZE_T.bytesize
+      BYTEALIGN = Primitives::SIZE_T.bytealign
+      EXTENSIBLE = false
+
+      def self.aref(buf, off)
+        new(buf, off)
+      end
+
+      def self.aset(buf, off, val)
+        if val.kind_of?(Fixnum)
+          buf.store_sizet(off, val)
+        else
+          raise PointerError, "wrong address (#{val.class} for Fixnum)"
+        end
+
+        buf
+      end
+
+      def self.define(type)
+        require_relative "fiddle" # for Fiddle::Pointer and extend
+
+        Class.new(Pointer) do |t|
+          define_singleton_method(:aset, ->(buf, off, val) {
+            if val.kind_of?(self)
+              addr = val.buffer.load_sizet(val.offset)
+              buf.store_sizet(off, addr)
+            else
+              super
+            end
+
+            buf
+          })
+
+          define_method(:pointer_address, -> {
+            @buffer__GOGYOU__.load_sizet(@offset__GOGYOU__)
+          })
+
+          define_method(:[], ->(*args) {
+            case args.size
+            when 0
+              elem = 0
+            when 1
+              elem = args[0].to_i
+            else
+              raise ArgumentError, "wrong argument size (#{args.size} for 0 .. 1)"
+            end
+            addr = @buffer__GOGYOU__.load_sizet(@offset__GOGYOU__)
+            if addr == 0
+              raise NullPointerError, "nullpo - #<%s:0x%08X>" % [self.class, __id__ << 1]
+            end
+            buf = ::Fiddle::Pointer.new(addr + elem * type.bytesize, type.bytesize)
+            type.aref(buf, 0)
+          })
+
+          define_method(:[]=, ->(*args) {
+            case args.size
+            when 1
+              elem = 0
+              v = args[0]
+            when 2
+              elem = args[0].to_i
+              v = args[1]
+            else
+              raise ArgumentError, "wrong argument size (#{args.size} for 1 .. 2)"
+            end
+
+            addr = @buffer__GOGYOU__.load_sizet(@offset__GOGYOU__)
+            if addr == 0
+              raise NullPointerError, "nullpo - #<%s:0x%08X>" % [self.class, __id__ << 1]
+            end
+            buf = ::Fiddle::Pointer.new(addr + elem * type.bytesize, type.bytesize)
+            type.aset(buf, 0, v)
+            v
+          })
+
+          define_method(:+, ->(elem) {
+            addr = @buffer__GOGYOU__.load_sizet(@offset__GOGYOU__)
+            buf = String.alloc(Primitives::SIZE_T.bytesize)
+            buf.store_sizet(0, addr + elem * type.bytesize)
+            self.class.new(buf, 0)
+          })
+
+          typename = String(type.respond_to?(:name) ? type.name : type) rescue String(type)
+          define_method(:inspect, -> {
+            addr = @buffer__GOGYOU__.load_sizet(@offset__GOGYOU__)
+            "#<*%s:0x%08X>" % [typename, addr]
+          })
+        end
+      end
+
+      #
+      # call-seq:
+      #   self + elem_num -> new pointer object
+      #
+      def +(elem_num)
+        raise NotImplementedError, "this method is shall be defined in sub-class"
+      end
+
+      def -(off)
+        send(:+, -off.to_i)
+      end
+
+      def pretty_print(q)
+        q.text inspect
+      end
+    end
+
     class BasicStruct < Accessor
     end
 

data/lib/gogyou/model.rb

@@ -360,8 +360,16 @@ module Gogyou
         raise ArgumentError, "nothing argument" if args.empty?
         name = nil
         vector = nil
-        while arg = args.shift
+        args.each do |arg|
           case arg
+          when ::Array  # pointer field
+            yield(name, vector) if name
+            name = nil
+            vector = nil
+            parse!(arg) do |name1, elements|
+              raise ArgumentError, "wrong pointer definision" if name
+              name = Model::Pointer.create(name1, elements)
+            end
           when Symbol, String
             yield(name, vector) if name
             raise ArgumentError, "informal field name (#{arg.to_s})" unless arg =~ FIELDNAME_PATTERN
@@ -369,16 +377,11 @@ module Gogyou
             vector = nil
           when Integer
             raise ArgumentError, "first argument is field name only (#{arg})" unless name
-            raise ArgumentError, "given negative number (#{arg})" unless arg >= 0
+            raise ArgumentError, "can't internal extensible in multi-dimentional array" if vector && vector[-1] < 1
+            v = arg.to_i
+            raise ArgumentError, "given negative number (#{arg})" unless v >= 0
             vector ||= []
-            vector << arg.to_i
-            if vector[-1] == 0
-              yield(name, vector)
-              unless args.empty?
-                raise ArgumentError, "given fields after extensible vector"
-              end
-              return nil
-            end
+            vector << v
           else
             raise ArgumentError, "given any object (#{arg.inspect})"
           end
@@ -399,24 +402,31 @@ module Gogyou
       end
 
       def addfield!(typeobj, packexp, args)
-        #p typeobj
-        # check extensible field  >>>  creator.fields[-1].vector[-1]
-        if (x = fields[-1]) && (x = x.vector) && x[-1] == 0
-          raise ArgumentError, "not given fields after extensible vector"
-        end
-
-        typesize = typeobj.bytesize
-        typealign = [typeobj.bytealign, 1 << packexp].min
+        typesize = typealign = nil # 自己参照構造体を実現するために必要な時に取得する
 
         tmpfields = []
 
         parse!(args) do |name, vect|
-          self.offset = offset.align_ceil(typealign) unless kind_of?(Model::Union::Creator)
-          fields << f = Field[offset, name, vect, typeobj, 0 | packexp]
-          tmpfields << f
-          unless kind_of?(Model::Union::Creator)
-            elements = vect ? vect.inject(1, &:*) : 1
-            self.offset += typesize * elements
+          if name.kind_of?(Model::Pointer::Creator)
+            (name, ptrtype) = name.create(typeobj)
+            self.offset = offset.align_ceil(Primitives::SIZE_T.bytealign) unless kind_of?(Model::Union::Creator)
+            fields << f = Field[offset, name, vect, ptrtype, 0 | packexp]
+            tmpfields << f
+            unless kind_of?(Model::Union::Creator)
+              elements = vect ? vect.inject(1, &:*) : 1
+              self.offset += Primitives::SIZE_T.bytesize * elements
+            end
+          else
+            typesize ||= typeobj.bytesize
+            typealign ||= [typeobj.bytealign, 1 << packexp].min
+
+            self.offset = offset.align_ceil(typealign) unless kind_of?(Model::Union::Creator)
+            fields << f = Field[offset, name, vect, typeobj, 0 | packexp]
+            tmpfields << f
+            unless kind_of?(Model::Union::Creator)
+              elements = vect ? vect.inject(1, &:*) : 1
+              self.offset += typesize * elements
+            end
           end
         end
 
@@ -471,6 +481,27 @@ module Gogyou
       end
     end
 
+    class Pointer < Model
+      class Creator < ::Struct.new(:token, :elements)
+        def create(typeobj)
+          name = token
+          if name.kind_of?(Creator)
+            # multiple pointer
+            (name, typeobj) = name.create(typeobj)
+          end
+          if elements && !elements.empty?
+            typeobj = Accessor.define_subarray(Model::Field[0, nil, elements, typeobj, 0])
+          end
+          model = Accessor.define_subpointer(typeobj)
+          [name, model]
+        end
+      end
+
+      def self.create(token, elements)
+        Creator.new(token, elements)
+      end
+    end
+
     class Struct < Model
       class Creator < Model::BasicCreator
         def bytealign(bytesize)

data/lib/gogyou/version.rb

@@ -1,3 +1,3 @@
 module Gogyou
-  VERSION = "0.2.4"
+  VERSION = "0.2.5"
 end

data/pointer.ja.md

@@ -0,0 +1,104 @@
+
+# About pointer (ポインタについて) (***EXPERIMENTAL FEATURE***)
+
+非常に限定的ながらポインタを扱うことが出来るようになりました (0.2.5 にて追加)。
+
+構造体を作成する時に、ポインタとしたい要素を配列としてくくることで定義できます。
+
+C と ruby を並べて記述しています (左側が ruby、右側が C):
+
+``` ruby:ruby
+int [:a]        # => int *a
+
+int [[[[:a]]]]  # => int ****a
+
+int [:a, 4]     # =>     (NOW) int (*a)[4]
+                #    (FEATURE) int *a[4]      : "a" is a 4 elements pointer of int
+
+int [:a], 4     # =>     (NOW) int *a[4]
+                #    (FEATURE) int (*a)[4]    : "a" is a pointer of 4 elements int
+
+int [:a, 4], 8  # =>     (NOW) int (*a[8])[4]
+                #    (FEATURE) int (*a[4])[8] : "a" is a 4 elements pointer of 8 elements int
+
+const int [:a]  # =>     (NOW) int *const a
+                #    (FEATURE) const int *a   : "a" is a pointer of constant int
+
+int [const(:a)] # =>     (NOW) NOT WORK
+                #    (FEATURE) int *const a   : "a" is a constant pointer of int
+
+a[]             # => *a , a[0]
+a[1]            # => a[1]
+a[][1]          # => (*a)[1] , a[0][1]
+```
+
+実際に利用した例 (***ruby の規律から逸脱しているため、実用しないで下さい***):
+
+``` ruby:ruby
+X = Gogyou.struct {
+  int [:a]
+}
+
+frozen_str = "abcdefghijklmn"
+x = X.new([frozen_str].pack("p"))
+frozen_str.freeze
+
+x.a[] = 0x44434241      # *x.a = 0x44434241
+p frozen_str            # => "ABCDefghijklmn"
+                        #     ^^^^
+
+x.a[2] ^= 0x20202020    # same as C code
+p frozen_str            # => "ABCDefghIJKLmn"
+                        #             ^^^^
+
+x.a += 1                # address + sizeof(int[1])
+x.a[] = 0x24232221      # *x.a = 0x24232221
+p frozen_str            # => "ABCD!\"\#$IJKLmn"
+                        #         ^^^^^^
+```
+
+実験的な機能のため、以下の制限(出来無いこと)があります:
+
+  * const 修飾子が機能しない (又は挙動がおかしい)
+  * typedef 出来ない
+  * ポインタと配列の定義を混ぜると挙動がおかしい
+  * そもそも C に見えない!
+
+
+## 自己参照構造体、相互参照構造体について
+
+ポインタによる自己参照構造体、相互参照構造体を定義する場合、Gogyou::Struct クラスを継承したクラスを定義することで可能です。
+
+``` C:C
+struct TypeA;
+
+struct TypeB
+{
+    struct TypeA *a;
+    struct TypeB *b;
+};
+
+struct TypeA
+{
+    struct TypeB *b;
+};
+```
+
+``` ruby:ruby
+class TypeA < Gogyou::Struct
+  # class definition only!
+end
+
+class TypeB < Gogyou::Struct
+  struct {
+    struct TypeA, [:a]
+    struct TypeB, [:b]
+  }
+end
+
+class TypeA
+  struct {
+    struct TypeB, [:b]
+  }
+end
+```

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gogyou
 version: !ruby/object:Gem::Version
-  version: 0.2.4
+  version: 0.2.5
 platform: ruby
 authors:
 - dearblue
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-16 00:00:00.000000000 Z
+date: 2015-10-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -43,11 +43,15 @@ description: |
 
   The C-liked struct, union and multidimensional array definition are posible in ruby syntax.
 
-  * Available nested struct and union with anonymous field.
-  * Available multidimensional array.
-  * Available const field.
-  * Available packed field.
-  * Available user definition types.
+  Available features:
+
+  (1) nested struct and union with anonymous field
+  (2) multidimensional array
+  (3) field of variable array
+  (4) const field
+  (5) packed field
+  (6) user definition types
+  (7) (EXPERIMENTAL AND LIMITATION FEATURE) pointer
 email: dearblue@users.osdn.me
 executables: []
 extensions: []
@@ -65,6 +69,7 @@ extra_rdoc_files:
 - lib/gogyou/primitives.rb
 - lib/gogyou/typespec.rb
 - lib/gogyou/version.rb
+- pointer.ja.md
 files:
 - HISTORY.ja.md
 - LICENSE
@@ -82,6 +87,7 @@ files:
 - lib/gogyou/typespec.rb
 - lib/gogyou/version.rb
 - mkprims.rb
+- pointer.ja.md
 - spec/gogyou_spec.rb
 - test/test_loadstore.rb
 - test/test_packbin.rb