1berry/ruby
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

[DOC] Update extension.rdoc

Browse Source 
Refine the uses of word "Data", which were often ambiguous.  Also,
that word now refers the new class unrelated to `T_DATA`.
This commit is contained in:
Nobuyoshi Nakada 2022-12-26 17:04:53 +09:00
parent b37e9c77fe
commit cb820bff33
Notes: git 2022-12-26 11:30:15 +00:00 
Merged: https://github.com/ruby/ruby/pull/7027
2 changed files with 17 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
doc/extension.ja.rdoc
View File

@ -888,12 +888,12 @@ dbm.cではTypedData_Make_Structを以下のように使っています．
obj = TypedData_Make_Struct(klass, struct dbmdata, &dbm_type, dbmp); obj = TypedData_Make_Struct(klass, struct dbmdata, &dbm_type, dbmp);
ここではdbmdata構造体へのポインタをDataにカプセル化してい ここではdbmdata構造体へのポインタをRubyオブジェクトにカプセ
ます．DBM*を直接カプセル化しないのはclose()した時の処理を考 ル化しています．DBM*を直接カプセル化しないのはclose()した時
えてのことです． の処理を考えてのことです．
Dataオブジェクトからdbmstruct構造体のポインタを取り出すため Rubyオブジェクトからdbmdata構造体のポインタを取り出すために
に以下のマクロを使っています． 以下のマクロを使っています．
#define GetDBM(obj, dbmp) do {\ #define GetDBM(obj, dbmp) do {\
TypedData_Get_Struct((obj), struct dbmdata, &dbm_type, (dbmp));\ TypedData_Get_Struct((obj), struct dbmdata, &dbm_type, (dbmp));\

24
doc/extension.rdoc
View File

@ -10,8 +10,8 @@ In C, variables have types and data do not have types. In contrast,
Ruby variables do not have a static type, and data themselves have Ruby variables do not have a static type, and data themselves have
types, so data will need to be converted between the languages. types, so data will need to be converted between the languages.
Data in Ruby are represented by the C type `VALUE'. Each VALUE data Objects in Ruby are represented by the C type `VALUE'. Each VALUE
has its data type. data has its data type.
To retrieve C data from a VALUE, you need to: To retrieve C data from a VALUE, you need to:
@ -20,7 +20,7 @@ To retrieve C data from a VALUE, you need to:
Converting to the wrong data type may cause serious problems. Converting to the wrong data type may cause serious problems.
=== Data Types === Ruby data types
The Ruby interpreter has the following data types: The Ruby interpreter has the following data types:
@ -54,7 +54,7 @@ T_ZOMBIE :: object awaiting finalization
Most of the types are represented by C structures. Most of the types are represented by C structures.
=== Check Data Type of the VALUE === Check type of the VALUE data
The macro TYPE() defined in ruby.h shows the data type of the VALUE. The macro TYPE() defined in ruby.h shows the data type of the VALUE.
TYPE() returns the constant number T_XXXX described above. To handle TYPE() returns the constant number T_XXXX described above. To handle
@ -88,7 +88,7 @@ There are also faster check macros for fixnums and nil.
FIXNUM_P(obj) FIXNUM_P(obj)
NIL_P(obj) NIL_P(obj)
=== Convert VALUE into C Data === Convert VALUE into C data
The data for type T_NIL, T_FALSE, T_TRUE are nil, false, true The data for type T_NIL, T_FALSE, T_TRUE are nil, false, true
respectively. They are singletons for the data type. respectively. They are singletons for the data type.
@ -143,7 +143,7 @@ Notice: Do not change the value of the structure directly, unless you
are responsible for the result. This ends up being the cause of are responsible for the result. This ends up being the cause of
interesting bugs. interesting bugs.
=== Convert C Data into VALUE === Convert C data into VALUE
To convert C data to Ruby values: To convert C data to Ruby values:
@ -169,7 +169,7 @@ INT2NUM() :: for arbitrary sized integers.
INT2NUM() converts an integer into a Bignum if it is out of the FIXNUM INT2NUM() converts an integer into a Bignum if it is out of the FIXNUM
range, but is a bit slower. range, but is a bit slower.
=== Manipulating Ruby Data === Manipulating Ruby object
As I already mentioned, it is not recommended to modify an object's As I already mentioned, it is not recommended to modify an object's
internal structure. To manipulate objects, use the functions supplied internal structure. To manipulate objects, use the functions supplied
@ -636,7 +636,7 @@ The prototypes of the getter and setter functions are as follows:
VALUE (*getter)(ID id); VALUE (*getter)(ID id);
void (*setter)(VALUE val, ID id); void (*setter)(VALUE val, ID id);
=== Encapsulate C Data into a Ruby Object === Encapsulate C data into a Ruby object
Sometimes you need to expose your struct in the C world as a Ruby Sometimes you need to expose your struct in the C world as a Ruby
object. object.
@ -762,7 +762,7 @@ You can allocate and wrap the structure in one step.
TypedData_Make_Struct(klass, type, data_type, sval) TypedData_Make_Struct(klass, type, data_type, sval)
This macro returns an allocated Data object, wrapping the pointer to This macro returns an allocated T_DATA object, wrapping the pointer to
the structure, which is also allocated. This macro works like: the structure, which is also allocated. This macro works like:
(sval = ZALLOC(type), TypedData_Wrap_Struct(klass, data_type, sval)) (sval = ZALLOC(type), TypedData_Wrap_Struct(klass, data_type, sval))
@ -773,7 +773,7 @@ be assigned to sval, which should be a pointer of the type specified.
==== Ruby object to C struct ==== Ruby object to C struct
To retrieve the C pointer from the Data object, use the macro To retrieve the C pointer from the T_DATA object, use the macro
TypedData_Get_Struct(). TypedData_Get_Struct().
TypedData_Get_Struct(obj, type, &data_type, sval) TypedData_Get_Struct(obj, type, &data_type, sval)
@ -1225,7 +1225,7 @@ Data_Get_Struct(data, type, sval) ::
This macro retrieves the pointer value from DATA, and assigns it to This macro retrieves the pointer value from DATA, and assigns it to
the variable sval. the variable sval.
=== Checking Data Types === Checking VALUE types
RB_TYPE_P(value, type) :: RB_TYPE_P(value, type) ::
@ -1255,7 +1255,7 @@ void Check_Type(VALUE value, int type) ::
Ensures +value+ is of the given internal +type+ or raises a TypeError Ensures +value+ is of the given internal +type+ or raises a TypeError
=== Data Type Conversion === VALUE type conversion
FIX2INT(value), INT2FIX(i) :: FIX2INT(value), INT2FIX(i) ::