gogyou 0.2.3 → 0.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 27a359613aa14229e1909aa2407b66a0453d32d0
-  data.tar.gz: a20b4c0a8daba874576b033294d052741d65a4f7
+  metadata.gz: 9633436e949f5045c684dde26894ed49cb30630e
+  data.tar.gz: 86d4d3037ebbbf38f66757aa1735cdb4430f684b
 SHA512:
-  metadata.gz: 6756d3ec51de9d0a2f8a7d806b8fcc019b6f4345c3312437f4c94d94e94a38c25154d9e510dfb12eb1416e61c3170a6dcdfcff92809b22efa628fe036c2baa70
-  data.tar.gz: ea1b5f3afd52b88b8f273f98794c36afd191ab2ba45235a8d0f8680c2de168937558ffb7e5c064c7c8288f50beb93fac1c1fd1cfbbfee43eee5f936df0ec1fcf
+  metadata.gz: 014588ae16a1e4def6fb346f49f8102e268d7035e0b0a7174430c3a1e31dccc085dc5c5045f9fcba7f3c7fe738892ff34e26d7503eb8d0b4c0e90447f0655c93
+  data.tar.gz: dc82211d768d36370a59b67b03e3715cde0cea1c351f0914ec6f6948cfeac50b0c8bdc21e306684fe7e1e3e517b949cf848067592a1adcde0a823fdeb6e2c0ea

data/HISTORY.ja.md

@@ -1,5 +1,62 @@
 # gogyou の更新履歴
 
+## gogyou-0.2.4 (2015-10-16)
+
+  * 環境依存の型に対する結果の正確性を修正
+
+    バイトオーダーが環境依存の型に対する値の取得・変更処理をより正確になるように修正しました。
+
+    ただし代入時の CPU 負荷が二倍程度悪化しています。
+
+  * いくつかの ruby 実装に対する修正
+
+    ruby-2.0 はサポート対象としていたにもかかわらず gogyou-0.2.3 で require が失敗してしまった部分を修正しています。
+
+    jruby、rubinius はこれまで確認すらしていませんでしたが、お遊び程度で確認しています
+    (サポート対象となっていないことに注意して下さい)。
+
+  * Gogyou::Accessor::Array#each の追加と Enumerable 化
+
+    Gogyou::Accessor::Array#each を追加し、Enumerabale を include するように変更しました。
+
+    Gogyou::Accessor::Array#each_with_index も追加してあります。
+
+  * Fiddle::Pointer と FFI::AbstractMemory を構造体バッファオブジェクトとして利用可能に
+
+    Fiddle::Pointer と FFI::AbstractMemory のインスタンスを構造体の
+    バッファオブジェクトとして利用できるように機能を追加しました。
+
+  * IEEE 754-2008 に対応した浮動小数点実数型を追加
+
+    IEEE 754-2008 に対応した 16・32・64 ビット精度の浮動小数点実数に対する以下の型を追加しました。
+
+    ``float16_t`` ``float16_swap`` ``float16_be`` ``float16_le``
+    ``float32_t`` ``float32_swap`` ``float32_be`` ``float32_le``
+    ``float64_t`` ``float64_swap`` ``float64_be`` ``float64_le``
+
+  * 固定小数点実数の型名を追加
+
+    16・32 ビット精度の固定小数点実数に対する以下の型を追加しました。
+
+    ``fixed16q8_t`` ``fixed16q8_swap`` ``fixed16q8_be`` ``fixed16q8_le``
+    ``fixed32q6_t`` ``fixed32q6_swap`` ``fixed32q6_be`` ``fixed32q6_le``
+    ``fixed32q8_t`` ``fixed32q8_swap`` ``fixed32q8_be`` ``fixed32q8_le``
+    ``fixed32q12_t`` ``fixed32q12_swap`` ``fixed32q12_be`` ``fixed32q12_le``
+    ``fixed32q16_t`` ``fixed32q16_swap`` ``fixed32q16_be`` ``fixed32q16_le``
+    ``fixed32q24_t`` ``fixed32q24_swap`` ``fixed32q24_be`` ``fixed32q24_le``
+
+    これらは格納する時 (storeXXX) は固定小数点実数として処理されますが、ruby
+    オブジェクトとして取り出す時 (loadXXX) は Float オブジェクトとして処理されます。
+
+  * クラス・モジュール名の変更
+
+    Gogyou::Primitives::Primitive を Gogyou::Primitive に変更しました。
+
+  * いくつかの処理の効率を改善
+
+  * その他問題の修正
+
+
 ## gogyou-0.2.3 (2015-5-17)
 
   * short、int、long、long long のバイト数が環境ごとの値として取得するようになっていなかった問題を修正

data/LICENSE

@@ -1,4 +1,4 @@
-# Gogyou License (2-clause BSD License)
+Gogyou License (2-clause BSD License)
 
 ----
 

data/README.md

@@ -19,14 +19,14 @@ ruby 構文による、C 言語の構造体・共用体・多次元配列 (も
 ----
 
   * Product Name (名称): gogyou (ゴギョウ / 御形 / Gnaphalium affine)
-  * Author (制作者): dearblue <dearblue@users.sourceforge.jp>
+  * Author (制作者): dearblue <dearblue@users.osdn.me>
   * Distribute License (頒布ライセンス): 2-clause BSD License (二条項 BSD ライセンス)
-  * Software Quarity (ソフトウェア品質): alpha
+  * Software Quarity (ソフトウェア品質): EXPERIMENTAL
   * User (想定利用者): Rubyist
-  * Release Number (リリースナンバー): 0.2.3
+  * Release Number (リリースナンバー): 0.2.4
   * Memory Usage (使用メモリ量): 2 MB +
   * Installed Size (インストール容量): under 1 MB
-  * Project Page: <http://sourceforge.jp/projects/rutsubo/>
+  * Project Page: <https://osdn.jp/projects/rutsubo/>
   * Support Ruby: ruby-2.0+ <http://www.ruby-lang.org/>
 
 ## Example
@@ -34,7 +34,7 @@ ruby 構文による、C 言語の構造体・共用体・多次元配列 (も
 ruby/ruby.h の ``struct RBasic`` と ``struct RObject`` を gogyou を用いて次のように記述出来ます
 (ポインタの定義はできていないため、``uintptr_t`` で置き換えています):
 
-```ruby:ruby
+``` ruby:ruby
 require "gogyou"
 
 module MyRuby
@@ -71,9 +71,15 @@ end
 
 また、ruby がもつ ``p`` メソッドや ``pp`` メソッドでわかりやすく表示されます (gogyou-0.2.3 にて追加)。
 
-```ruby:ruby
+定義した構造体のインスタンスを作成する場合、文字列だけではなく Fiddle::Pointer や FFI::AbstractMemory インスタンスの指定も可能です (gogyou-0.2.4 にて追加)。
+
+``` ruby:ruby
 obj = MyRuby::RObject.new
-# OR obj = MyRuby::RObject.bind("0123456789abcdef" * 2000)  # given any string
+# OR: obj = MyRuby::RObject.bind("0123456789abcdef" * 2000)  # given any string
+# OR: require "gogyou/fiddle"
+#     obj = MyRuby::RObject.bind(Fiddle::Pointer.malloc(MyRuby::RObject.bytesize))
+# OR: require "gogyou/ffi"
+#     obj = MyRuby::RObject.bind(FFI::MemoryPointer.new(MyRuby::RObject.bytesize))
 
 obj.basic.flags = 1234567890
 (obj.basic.klass = 0xaaaaaaaa) rescue p $!  # => EXCEPTION! klass field is immutable
@@ -87,7 +93,7 @@ tmp = obj.as.heap       # get a middle field accessor
 tmp.ivptr = 0x44444444
 p obj.as.heap.ivptr     # => 0x44444444
 
-# following results are in little endian 64 bit enviroment
+# following results are in little endian 64 bit system
 require "pp"
 
 pp obj.bytesize     # => 40
@@ -194,7 +200,7 @@ pp obj              # => #<MyRuby::RObject
 
 最初に gogyou を読み込みます。
 
-```ruby:ruby
+``` ruby:ruby
 require "gogyou"
 ```
 
@@ -202,7 +208,7 @@ require "gogyou"
 
  1. クラスやモジュールの中で ``extend Gogyou`` して、``struct`` (または ``union``) をブロック付きで呼び出し、その戻り値を定数に代入する
 
-    ```ruby:ruby
+    ``` ruby:ruby
     module MyModule
       extend Gogyou
 
@@ -219,7 +225,7 @@ require "gogyou"
 
  2. Gogyou.struct (または Gogyou.union) をブロック付きで呼び出し、その戻り値を定数に代入する
 
-    ```ruby:ruby
+    ``` ruby:ruby
     TypeA = Gogyou.struct {
       int :a
     }
@@ -233,7 +239,7 @@ require "gogyou"
  3. Gogyou::Struct (または Gogyou::Union) を親クラスとしてクラスを定義し、その中で ``struct`` (または ``union``) をブロック付きで呼び出す
     (gogyou-0.2.3 にて追加)
 
-    ```ruby:ruby
+    ``` ruby:ruby
     class TypeA < Gogyou::Struct
       struct {
         int :a
@@ -256,7 +262,7 @@ require "gogyou"
 
 フィールド名はシンボル (または文字列) で与えます。
 
-```ruby:ruby
+``` ruby:ruby
 module MyModule
   extend Gogyou
 
@@ -275,7 +281,7 @@ end
 
 配列として定義する場合は、フィールド名に続く引数として整数値を与えます。
 
-```ruby:ruby
+``` ruby:ruby
 module MyModule
   extend Gogyou
 
@@ -287,7 +293,7 @@ end
 
 多次元配列の場合は、連続して整数値を与えます。
 
-```ruby:ruby
+``` ruby:ruby
 module MyModule
   extend Gogyou
 
@@ -299,7 +305,7 @@ end
 
 配列の場合でも、複数のフィールドを連続してまとめることが出来ます。
 
-```ruby:ruby
+``` ruby:ruby
 module MyModule
   extend Gogyou
 
@@ -318,7 +324,7 @@ struct の最初の引数にブロックを与えること以外は、先に述
 
 コメントは C 言語で記述した場合の対比としてあります。
 
-```ruby:ruby
+``` ruby:ruby
 module MyModule
   extend Gogyou
 
@@ -332,7 +338,7 @@ end
 
 最初の引数にブロックではなく、型情報としてのオブジェクトを与えることも出来ます。
 
-```ruby:ruby
+``` ruby:ruby
 module MyModule
   extend Gogyou
 
@@ -348,7 +354,7 @@ end
 
 無名構造体の場合、引数は渡さずにブロックを渡すだけです。
 
-```ruby:ruby
+``` ruby:ruby
 module MyModule
   extend Gogyou
 
@@ -436,42 +442,42 @@ end
 
 順を追って説明していきます。
 
-### `.bytesize`
+### ``.bytesize``
 
 このメソッドはその型が必要とする領域のバイト数を正の整数値で返します。
 
 型が拡張構造になっている場合は、最小値となる値を返します。
 
-MD5 を定義する場合、16バイトなので `16` を返します。
+MD5 を定義する場合、16バイトなので ``16`` を返します。
 
-### `.bytealign`
+### ``.bytealign``
 
 このメソッドはその型のアライメントサイズを正の整数値で返します。
 
-MD5 を定義する場合、内部表現は1バイトの塊なので `1` を返します
-(MD5 の実装によっては `4` だったり `8` だったり、はたまた `16` になるかもしれません)。
+MD5 を定義する場合、内部表現は1バイトの塊なので ``1`` を返します
+(MD5 の実装によっては ``4`` だったり ``8`` だったり、はたまた ``16`` になるかもしれません)。
 
-### `.extensible?`
+### ``.extensible?``
 
 このメソッドはその型が常に固定長か、任意に拡張する構造になっているかどうかを返します。
 
-`true` であれば拡張構造であることを意味し、`false` であれば固定長であることを意味します。
+``true`` であれば拡張構造であることを意味し、``false`` であれば固定長であることを意味します。
 
-MD5 は固定長なので、`false` を返します。
+MD5 は固定長なので、``false`` を返します。
 
-### `.aref(buffer, offset)`
+### ``.aref(buffer, offset)``
 
 このメソッドは構造体のフィールドを参照した場合に呼ばれます。
 
-`buffer` は上位構造のバイナリデータとしての String インスタンスです。
+``buffer`` はバイナリデータとしての String インスタンスです (※gogyou-0.2.4 からは Fiddle::Pointer や FFI::AbstractMemory インスタンスである可能性もあります)。
 
-`offset` は上位構造から見た、フィールドの絶対位置をバイト値で表した整数値です。
+``offset`` はバッファ上における、フィールドの絶対位置をバイト値で表した整数値です。
 
 戻り値はその構造体のフィールドに対するインスタンスを返します。
 
-MD5 の場合、`buffer` からデータを切り出して MD5 のインスタンスを返すべきです。
+MD5 の場合、``buffer`` を元にした MD5 のインスタンスを返すべきです。
 
-```ruby:ruby
+``` ruby:ruby
 class MD5
   def self.aref(buffer, offset)
     new(buffer.byteslice(offset, 16))
@@ -479,13 +485,13 @@ class MD5
 end
 ```
 
-もしもインスタンスの変更を反映させる `MD5#[]=` のようなメソッドが必要であるならば、上述したメソッドではうまく行きません。
-理由は `buffer.byteslice` によって `buffer` オブジェクトが切り離されてしまっているからです。
+もしもインスタンスの変更を反映させる ``MD5#[]=`` のようなメソッドが必要であるならば、上述したメソッドではうまく行きません。
+理由は ``buffer.byteslice`` によって ``buffer`` オブジェクトが切り離されてしまっているからです。
 
-クラスを MD5 のデータが保持されるだけの構造から、`buffer` と `offset` を保持する構造に変更する必要があります。
+クラスを MD5 のデータが保持されるだけの構造から、``buffer`` と ``offset`` を保持する構造に変更する必要があります。
 その上でメソッドの定義を変更します。
 
-```ruby:ruby
+``` ruby:ruby
 class MD5
   def self.aref(buffer, offset)
     new(buffer, offset)
@@ -503,27 +509,27 @@ class MD5
 end
 ```
 
-### `.aset(buffer, offset, data)`
+### ``.aset(buffer, offset, data)``
 
 このメソッドは構造体のフィールドへデータを代入した時に呼ばれます。
 
 例えば、`structobj.field = data` のような場合です。
 
-`buffer` は上位構造のバイナリデータとしての String インスタンスです。
+``buffer`` はバイナリデータとしての String インスタンスです (※gogyou-0.2.4 からは他のライブラリが提供するポインタオブジェクトである可能性もあります)。
 
-`offset` は上位構造から見た、フィールドの絶対位置をバイト値で表した整数値です。
+``offset`` はバッファ上における、フィールドの絶対位置をバイト値で表した整数値です。
 
-`data` は代入する値です。
+``data`` は代入する値です。
 
 戻り値は無視されます。
 
-`data` に対してどのような値 (オブジェクト) を受け入れるのかを決定するのは、型情報を定義する側の問題となります。
+``data`` に対してどのような値 (オブジェクト) を受け入れるのかを決定するのは、型情報を定義する側の問題となります。
 
 MD5 の場合、最低でも MD5 インスタンスを受け入れるようにするべきです。
 
-今回は MD5 インスタンスだけではなく 16バイトの文字列、そして `nil` を受け取れるようにしてみます。
+今回は MD5 インスタンスだけではなく 16バイトの文字列、そして ``nil`` を受け取れるようにしてみます。
 
-```ruby:ruby
+``` ruby:ruby
 class MD5
   def self.aset(buffer, offset, data)
     case data
@@ -532,7 +538,7 @@ class MD5
     when String
       buffer.setbinary(offset, data.byteslice(0, 16))
     when nil
-      buffer[offset, 16] = ?0 * 16
+      buffer.setbinary(offset, ?0 * 16)
     else
       raise ArgumentError, "data is not a MD5, String or nil"
     end
@@ -595,9 +601,88 @@ Z = Gogyou.struct {
 ```
 
 
+## Use Fiddle::Pointer or FFI::AbstractMemory as buffer object of struct (構造体のバッファオブジェクトとして Fiddle::Pointer や FFI::AbstractMemory を使う)
+
+構造体の実体となるバッファオブジェクトは、文字列だけではなく Fiddle::Pointer や FFI::AbstractMemory インスタンスを指定することも出来ます (gogyou-0.2.4 にて追加)。
+
+Fiddle::Pointer を利用する場合は、"gogyou/fiddle" を ``require`` する必要があります。
+この時 ``require "fiddle"`` されていなければ "gogyou/fiddle" の内部で ``require`` されます。
+
+あとは作成した構造体に ``bind`` する時、任意の Fiddle::Pointer インスタンスを指定します。
+
+``` ruby:ruby
+require "gogyou/fiddle"
+
+ptr = Fiddle::Pointer.malloc(YourStruct.bytesize)
+data = YourStruct.bind(ptr)
+```
+
+同様に FFI::AbstractMemory (または派生クラス) を利用する場合は、"gogyou/ffi" を ``require`` する必要があります。
+この時 ``require "ffi"`` されていなければ "gogyou/ffi" の内部で ``require`` されます。
+
+あとは作成した構造体に ``bind`` する時、任意の FFI::AbstractMemory (または派生クラス) インスタンスを指定します。
+
+``` ruby:ruby
+require "gogyou/ffi"
+
+ptr = FFI::MemoryPointer.new(YourStruct.bytesize)
+data = YourStruct.bind(ptr)
+```
+
+
 ## Demerit (短所)
 
   * Can't be handled pointer
     (ポインタが扱えない)
+
   * The cost is high for reference/asignment from/to fields
     (フィールドに対する参照・代入のコストが高い)
+
+
+## Available typenames when definision struct (構造体定義の際に利用できる型名)
+
+  * C の型名
+
+                                符号あり    符号なし
+                                ----        ----
+        char 型                 char        uchar
+                                            unsigned_char
+        short 型                short       ushort
+                                            unsigned_short
+        int 型                  int         uint
+                                            unsigned_int
+        long 型                 long        ulong
+                                            unsigned_long
+        long long 型            longlong    ulonglong
+                                long_long   unsigned_long_long
+        sizeof 型               ssize_t     size_t
+        ポインタ整数型          intptr_t    uintptr_t
+        float                   float       N/A
+        double                  double      N/A
+
+  * バイトオーダー環境依存・ビット数環境非依存
+
+                                  バイトオーダー環境依存  バイトオーダー反転
+                                  符号あり    符号なし    符号あり      符号なし
+                                  ----        ----        ----          ----
+        8ビット整数型             int8_t      uint8_t     N/A           N/A
+        16ビット整数型            int16_t     uint16_t    int16_swap    uint16_swap
+        32ビット整数型            int32_t     uint32_t    int32_swap    uint32_swap
+        64ビット整数型            int64_t     uint64_t    int64_swap    uint64_swap
+        16ビット浮動小数点実数型  float16_t   N/A         float16_swap  N/A
+        32ビット浮動小数点実数型  float32_t   N/A         float32_swap  N/A
+        64ビット浮動小数点実数型  float64_t   N/A         float64_swap  N/A
+
+  * バイトオーダー・ビット数環境非依存
+
+                                  ビッグエンディアン      リトルエンディアン
+                                  符号あり    符号なし    符号あり      符号なし
+                                  ----        ----        ----          ----
+        16ビット整数型            int16_be    uint16_be   int16_le      uint16_le
+        24ビット整数型            int24_be    uint24_be   int24_le      uint24_le
+        32ビット整数型            int32_be    uint32_be   int32_le      uint32_le
+        48ビット整数型            int48_be    uint48_be   int48_le      uint48_le
+        64ビット整数型            int64_be    uint64_be   int64_le      uint64_le
+        16ビット浮動小数点実数型  float16_be  N/A         float16_le    N/A
+        32ビット浮動小数点実数型  float32_be  N/A         float32_le    N/A
+        64ビット浮動小数点実数型  float64_be  N/A         float64_le    N/A

data/Rakefile

@@ -29,7 +29,10 @@ GEMSPEC = "#{GEMSTUB.name}.gemspec"
 
 GEMSTUB.files += DOC + EXT + EXTCONF + BIN + LIB + SPEC + TEST + EXAMPLE + RAKEFILE + EXTRA
 GEMSTUB.files.sort!
-GEMSTUB.rdoc_options ||= %w(--charset UTF-8)
+if GEMSTUB.rdoc_options.nil? || GEMSTUB.rdoc_options.empty?
+  readme = %W(.md .markdown .rd .rdoc .txt #{""}).map { |ext| "README#{ext}" }.find { |m| DOC.find { |n| n == m } }
+  GEMSTUB.rdoc_options = %w(--charset UTF-8) + (readme ? %W(-m #{readme}) : [])
+end
 GEMSTUB.extra_rdoc_files += DOC + LIB + EXT.reject { |n| n.include?("/externals/") || !%w(.h .hh .c .cc .cpp .cxx).include?(File.extname(n)) }
 GEMSTUB.extra_rdoc_files.sort!
 

data/gemstub.rb

@@ -18,8 +18,8 @@ The C-liked struct, union and multidimensional array definition are posible in r
 EOS
   s.license = "2-clause BSD License"
   s.author = "dearblue"
-  s.email = "dearblue@users.sourceforge.jp"
-  s.homepage = "http://sourceforge.jp/projects/rutsubo/"
+  s.email = "dearblue@users.osdn.me"
+  s.homepage = "https://osdn.jp/projects/rutsubo/"
 
   s.required_ruby_version = ">= 2.0"
   s.add_development_dependency "rspec", "~> 2.14"