win32ole 1.8.9 → 1.9.0

data/ext/win32ole/win32ole_param.c

@@ -64,9 +64,9 @@ create_win32ole_param(ITypeInfo *pTypeInfo, UINT method_index, UINT index, VALUE
 }
 
 /*
- * Document-class: WIN32OLE_PARAM
+ * Document-class: WIN32OLE::Param
  *
- *   <code>WIN32OLE_PARAM</code> objects represent param information of
+ *   +WIN32OLE::Param+ objects represent param information of
  *   the OLE method.
  */
 static VALUE
@@ -131,15 +131,15 @@ oleparam_ole_param(VALUE self, VALUE olemethod, int n)
 
 /*
  * call-seq:
- *    WIN32OLE_PARAM.new(method, n) -> WIN32OLE_PARAM object
+ *    new(method, n) -> WIN32OLE::Param object
  *
- * Returns WIN32OLE_PARAM object which represents OLE parameter information.
- * 1st argument should be WIN32OLE_METHOD object.
+ * Returns WIN32OLE::Param object which represents OLE parameter information.
+ * 1st argument should be WIN32OLE::Method object.
  * 2nd argument `n' is n-th parameter of the method specified by 1st argument.
  *
- *    tobj = WIN32OLE_TYPE.new('Microsoft Scripting Runtime', 'IFileSystem')
- *    method = WIN32OLE_METHOD.new(tobj, 'CreateTextFile')
- *    param = WIN32OLE_PARAM.new(method, 2) # => #<WIN32OLE_PARAM:Overwrite=true>
+ *    tobj = WIN32OLE::Type.new('Microsoft Scripting Runtime', 'IFileSystem')
+ *    method = WIN32OLE::Method.new(tobj, 'CreateTextFile')
+ *    param = WIN32OLE::Param.new(method, 2) # => #<WIN32OLE::Param:Overwrite=true>
  *
  */
 static VALUE
@@ -147,7 +147,7 @@ foleparam_initialize(VALUE self, VALUE olemethod, VALUE n)
 {
     int idx;
     if (!rb_obj_is_kind_of(olemethod, cWIN32OLE_METHOD)) {
-        rb_raise(rb_eTypeError, "1st parameter must be WIN32OLE_METHOD object");
+        rb_raise(rb_eTypeError, "1st parameter must be WIN32OLE::Method object");
     }
     idx = RB_FIX2INT(n);
     return oleparam_ole_param(self, olemethod, idx);
@@ -155,11 +155,11 @@ foleparam_initialize(VALUE self, VALUE olemethod, VALUE n)
 
 /*
  *  call-seq:
- *     WIN32OLE_PARAM#name
+ *     name
  *
  *  Returns name.
- *     tobj = WIN32OLE_TYPE.new('Microsoft Excel 9.0 Object Library', 'Workbook')
- *     method = WIN32OLE_METHOD.new(tobj, 'SaveAs')
+ *     tobj = WIN32OLE::Type.new('Microsoft Excel 9.0 Object Library', 'Workbook')
+ *     method = WIN32OLE::Method.new(tobj, 'SaveAs')
  *     param1 = method.params[0]
  *     puts param1.name # => Filename
  */
@@ -186,11 +186,11 @@ ole_param_ole_type(ITypeInfo *pTypeInfo, UINT method_index, UINT index)
 
 /*
  *  call-seq:
- *     WIN32OLE_PARAM#ole_type
+ *     ole_type
  *
- *  Returns OLE type of WIN32OLE_PARAM object(parameter of OLE method).
- *     tobj = WIN32OLE_TYPE.new('Microsoft Excel 9.0 Object Library', 'Workbook')
- *     method = WIN32OLE_METHOD.new(tobj, 'SaveAs')
+ *  Returns OLE type of WIN32OLE::Param object(parameter of OLE method).
+ *     tobj = WIN32OLE::Type.new('Microsoft Excel 9.0 Object Library', 'Workbook')
+ *     method = WIN32OLE::Method.new(tobj, 'SaveAs')
  *     param1 = method.params[0]
  *     puts param1.ole_type # => VARIANT
  */
@@ -220,11 +220,11 @@ ole_param_ole_type_detail(ITypeInfo *pTypeInfo, UINT method_index, UINT index)
 
 /*
  *  call-seq:
- *     WIN32OLE_PARAM#ole_type_detail
+ *     ole_type_detail
  *
  *  Returns detail information of type of argument.
- *     tobj = WIN32OLE_TYPE.new('Microsoft Excel 9.0 Object Library', 'IWorksheetFunction')
- *     method = WIN32OLE_METHOD.new(tobj, 'SumIf')
+ *     tobj = WIN32OLE::Type.new('Microsoft Excel 9.0 Object Library', 'IWorksheetFunction')
+ *     method = WIN32OLE::Method.new(tobj, 'SumIf')
  *     param1 = method.params[0]
  *     p param1.ole_type_detail # => ["PTR", "USERDEFINED", "Range"]
  */
@@ -254,11 +254,11 @@ ole_param_flag_mask(ITypeInfo *pTypeInfo, UINT method_index, UINT index, USHORT
 
 /*
  *  call-seq:
- *     WIN32OLE_PARAM#input?
+ *     input?
  *
  *  Returns true if the parameter is input.
- *     tobj = WIN32OLE_TYPE.new('Microsoft Excel 9.0 Object Library', 'Workbook')
- *     method = WIN32OLE_METHOD.new(tobj, 'SaveAs')
+ *     tobj = WIN32OLE::Type.new('Microsoft Excel 9.0 Object Library', 'Workbook')
+ *     method = WIN32OLE::Method.new(tobj, 'SaveAs')
  *     param1 = method.params[0]
  *     puts param1.input? # => true
  */
@@ -273,22 +273,22 @@ foleparam_input(VALUE self)
 
 /*
  *  call-seq:
- *     WIN32OLE#output?
+ *     output?
  *
  *  Returns true if argument is output.
- *     tobj = WIN32OLE_TYPE.new('Microsoft Internet Controls', 'DWebBrowserEvents')
- *     method = WIN32OLE_METHOD.new(tobj, 'NewWindow')
+ *     tobj = WIN32OLE::Type.new('Microsoft Internet Controls', 'DWebBrowserEvents')
+ *     method = WIN32OLE::Method.new(tobj, 'NewWindow')
  *     method.params.each do |param|
  *       puts "#{param.name} #{param.output?}"
  *     end
  *
- *     The result of above script is following:
- *       URL false
- *       Flags false
- *       TargetFrameName false
- *       PostData false
- *       Headers false
- *       Processed true
+ *  The result of above script is following:
+ *    URL false
+ *    Flags false
+ *    TargetFrameName false
+ *    PostData false
+ *    Headers false
+ *    Processed true
  */
 static VALUE
 foleparam_output(VALUE self)
@@ -301,11 +301,11 @@ foleparam_output(VALUE self)
 
 /*
  *  call-seq:
- *     WIN32OLE_PARAM#optional?
+ *     optional?
  *
  *  Returns true if argument is optional.
- *     tobj = WIN32OLE_TYPE.new('Microsoft Excel 9.0 Object Library', 'Workbook')
- *     method = WIN32OLE_METHOD.new(tobj, 'SaveAs')
+ *     tobj = WIN32OLE::Type.new('Microsoft Excel 9.0 Object Library', 'Workbook')
+ *     method = WIN32OLE::Method.new(tobj, 'SaveAs')
  *     param1 = method.params[0]
  *     puts "#{param1.name} #{param1.optional?}" # => Filename true
  */
@@ -320,12 +320,12 @@ foleparam_optional(VALUE self)
 
 /*
  *  call-seq:
- *     WIN32OLE_PARAM#retval?
+ *     retval?
  *
  *  Returns true if argument is return value.
- *     tobj = WIN32OLE_TYPE.new('DirectX 7 for Visual Basic Type Library',
- *                              'DirectPlayLobbyConnection')
- *     method = WIN32OLE_METHOD.new(tobj, 'GetPlayerShortName')
+ *     tobj = WIN32OLE::Type.new('DirectX 7 for Visual Basic Type Library',
+ *                               'DirectPlayLobbyConnection')
+ *     method = WIN32OLE::Method.new(tobj, 'GetPlayerShortName')
  *     param = method.params[0]
  *     puts "#{param.name} #{param.retval?}"  # => name true
  */
@@ -363,12 +363,12 @@ ole_param_default(ITypeInfo *pTypeInfo, UINT method_index, UINT index)
 
 /*
  *  call-seq:
- *     WIN32OLE_PARAM#default
+ *     default
  *
  *  Returns default value. If the default value does not exist,
  *  this method returns nil.
- *     tobj = WIN32OLE_TYPE.new('Microsoft Excel 9.0 Object Library', 'Workbook')
- *     method = WIN32OLE_METHOD.new(tobj, 'SaveAs')
+ *     tobj = WIN32OLE::Type.new('Microsoft Excel 9.0 Object Library', 'Workbook')
+ *     method = WIN32OLE::Method.new(tobj, 'SaveAs')
  *     method.params.each do |param|
  *       if param.default
  *         puts "#{param.name} (= #{param.default})"
@@ -377,18 +377,18 @@ ole_param_default(ITypeInfo *pTypeInfo, UINT method_index, UINT index)
  *       end
  *     end
  *
- *     The above script result is following:
- *         Filename
- *         FileFormat
- *         Password
- *         WriteResPassword
- *         ReadOnlyRecommended
- *         CreateBackup
- *         AccessMode (= 1)
- *         ConflictResolution
- *         AddToMru
- *         TextCodepage
- *         TextVisualLayout
+ *  The above script result is following:
+ *      Filename
+ *      FileFormat
+ *      Password
+ *      WriteResPassword
+ *      ReadOnlyRecommended
+ *      CreateBackup
+ *      AccessMode (= 1)
+ *      ConflictResolution
+ *      AddToMru
+ *      TextCodepage
+ *      TextVisualLayout
  */
 static VALUE
 foleparam_default(VALUE self)
@@ -401,7 +401,7 @@ foleparam_default(VALUE self)
 
 /*
  *  call-seq:
- *     WIN32OLE_PARAM#inspect -> String
+ *     inspect -> String
  *
  *  Returns the parameter name with class name. If the parameter has default value,
  *  then returns name=value string with class name.
@@ -416,13 +416,14 @@ foleparam_inspect(VALUE self)
         rb_str_cat2(detail, "=");
         rb_str_concat(detail, rb_inspect(defval));
     }
-    return make_inspect("WIN32OLE_PARAM", detail);
+    return make_inspect("WIN32OLE::Param", detail);
 }
 
 void
 Init_win32ole_param(void)
 {
     cWIN32OLE_PARAM = rb_define_class_under(cWIN32OLE, "Param", rb_cObject);
+    /* Alias of WIN32OLE::Param, for the backward compatibility */
     rb_define_const(rb_cObject, "WIN32OLE_PARAM", cWIN32OLE_PARAM);
     rb_define_alloc_func(cWIN32OLE_PARAM, foleparam_s_allocate);
     rb_define_method(cWIN32OLE_PARAM, "initialize", foleparam_initialize, 2);

data/ext/win32ole/win32ole_record.c

@@ -177,10 +177,10 @@ create_win32ole_record(IRecordInfo *pri, void *prec)
 }
 
 /*
- * Document-class: WIN32OLE_RECORD
+ * Document-class: WIN32OLE::Record
  *
- *   <code>WIN32OLE_RECORD</code> objects represents VT_RECORD OLE variant.
- *   Win32OLE returns WIN32OLE_RECORD object if the result value of invoking
+ *   +WIN32OLE::Record+ objects represents VT_RECORD OLE variant.
+ *   Win32OLE returns WIN32OLE::Record object if the result value of invoking
  *   OLE methods.
  *
  *   If COM server in VB.NET ComServer project is the following:
@@ -206,7 +206,7 @@ create_win32ole_record(IRecordInfo *pri, void *prec)
  *     require 'win32ole'
  *     obj = WIN32OLE.new('ComServer.ComClass')
  *     book = obj.getBook
- *     book.class # => WIN32OLE_RECORD
+ *     book.class # => WIN32OLE::Record
  *     book.title # => "The Ruby Book"
  *     book.cost  # => 20
  *
@@ -253,11 +253,11 @@ folerecord_s_allocate(VALUE klass) {
 
 /*
  * call-seq:
- *    WIN32OLE_RECORD.new(typename, obj) -> WIN32OLE_RECORD object
+ *    new(typename, obj) -> WIN32OLE::Record object
  *
- * Returns WIN32OLE_RECORD object. The first argument is struct name (String
+ * Returns WIN32OLE::Record object. The first argument is struct name (String
  * or Symbol).
- * The second parameter obj should be WIN32OLE object or WIN32OLE_TYPELIB object.
+ * The second parameter obj should be WIN32OLE object or WIN32OLE::TypeLib object.
  * If COM server in VB.NET ComServer project is the following:
  *
  *   Imports System.Runtime.InteropServices
@@ -269,13 +269,13 @@ folerecord_s_allocate(VALUE klass) {
  *       End Structure
  *   End Class
  *
- * then, you can create WIN32OLE_RECORD object is as following:
+ * then, you can create WIN32OLE::Record object is as following:
  *
  *   require 'win32ole'
  *   obj = WIN32OLE.new('ComServer.ComClass')
- *   book1 = WIN32OLE_RECORD.new('Book', obj) # => WIN32OLE_RECORD object
+ *   book1 = WIN32OLE::Record.new('Book', obj) # => WIN32OLE::Record object
  *   tlib = obj.ole_typelib
- *   book2 = WIN32OLE_RECORD.new('Book', tlib) # => WIN32OLE_RECORD object
+ *   book2 = WIN32OLE::Record.new('Book', tlib) # => WIN32OLE::Record object
  *
  */
 static VALUE
@@ -303,7 +303,7 @@ folerecord_initialize(VALUE self, VALUE typename, VALUE oleobj) {
             hr = E_FAIL;
         }
     } else {
-        rb_raise(rb_eArgError, "2nd argument should be WIN32OLE object or WIN32OLE_TYPELIB object");
+        rb_raise(rb_eArgError, "2nd argument should be WIN32OLE object or WIN32OLE::TypeLib object");
     }
 
     if (FAILED(hr)) {
@@ -323,7 +323,7 @@ folerecord_initialize(VALUE self, VALUE typename, VALUE oleobj) {
 
 /*
  *  call-seq:
- *     WIN32OLE_RECORD#to_h #=> Ruby Hash object.
+ *     WIN32OLE::Record#to_h #=> Ruby Hash object.
  *
  *  Returns Ruby Hash object which represents VT_RECORD variable.
  *  The keys of Hash object are member names of VT_RECORD OLE variable and
@@ -346,7 +346,7 @@ folerecord_initialize(VALUE self, VALUE typename, VALUE oleobj) {
  *         End Function
  *     End Class
  *
- *  then, the result of WIN32OLE_RECORD#to_h is the following:
+ *  then, the result of WIN32OLE::Record#to_h is the following:
  *
  *     require 'win32ole'
  *     obj = WIN32OLE.new('ComServer.ComClass')
@@ -362,7 +362,7 @@ folerecord_to_h(VALUE self)
 
 /*
  *  call-seq:
- *     WIN32OLE_RECORD#typename #=> String object
+ *     typename #=> String object
  *
  *  Returns the type name of VT_RECORD OLE variable.
  *
@@ -383,7 +383,7 @@ folerecord_to_h(VALUE self)
  *         End Function
  *     End Class
  *
- *  then, the result of WIN32OLE_RECORD#typename is the following:
+ *  then, the result of WIN32OLE::Record#typename is the following:
  *
  *     require 'win32ole'
  *     obj = WIN32OLE.new('ComServer.ComClass')
@@ -423,7 +423,7 @@ olerecord_ivar_set(VALUE self, VALUE name, VALUE val)
 
 /*
  *  call-seq:
- *     WIN32OLE_RECORD#method_missing(name)
+ *     method_missing(name)
  *
  *  Returns value specified by the member name of VT_RECORD OLE variable.
  *  Or sets value specified by the member name of VT_RECORD OLE variable.
@@ -443,7 +443,7 @@ olerecord_ivar_set(VALUE self, VALUE name, VALUE val)
  *  Then getting/setting value from Ruby is as the following:
  *
  *     obj = WIN32OLE.new('ComServer.ComClass')
- *     book = WIN32OLE_RECORD.new('Book', obj)
+ *     book = WIN32OLE::Record.new('Book', obj)
  *     book.title # => nil ( book.method_missing(:title) is invoked. )
  *     book.title = "Ruby" # ( book.method_missing(:title=, "Ruby") is invoked. )
  */
@@ -473,7 +473,7 @@ folerecord_method_missing(int argc, VALUE *argv, VALUE self)
 
 /*
  *  call-seq:
- *     WIN32OLE_RECORD#ole_instance_variable_get(name)
+ *     ole_instance_variable_get(name)
  *
  *  Returns value specified by the member name of VT_RECORD OLE object.
  *  If the member name is not correct, KeyError exception is raised.
@@ -494,7 +494,7 @@ folerecord_method_missing(int argc, VALUE *argv, VALUE self)
  *  then accessing object_id of ComObject from Ruby is as the following:
  *
  *     srver = WIN32OLE.new('ComServer.ComClass')
- *     obj = WIN32OLE_RECORD.new('ComObject', server)
+ *     obj = WIN32OLE::Record.new('ComObject', server)
  *     # obj.object_id returns Ruby Object#object_id
  *     obj.ole_instance_variable_get(:object_id) # => nil
  *
@@ -515,7 +515,7 @@ folerecord_ole_instance_variable_get(VALUE self, VALUE name)
 
 /*
  *  call-seq:
- *     WIN32OLE_RECORD#ole_instance_variable_set(name, val)
+ *     ole_instance_variable_set(name, val)
  *
  *  Sets value specified by the member name of VT_RECORD OLE object.
  *  If the member name is not correct, KeyError exception is raised.
@@ -534,7 +534,7 @@ folerecord_ole_instance_variable_get(VALUE self, VALUE name)
  *  then setting value of the `title' member is as following:
  *
  *     srver = WIN32OLE.new('ComServer.ComClass')
- *     obj = WIN32OLE_RECORD.new('Book', server)
+ *     obj = WIN32OLE::Record.new('Book', server)
  *     obj.ole_instance_variable_set(:title, "The Ruby Book")
  *
  */
@@ -554,7 +554,7 @@ folerecord_ole_instance_variable_set(VALUE self, VALUE name, VALUE val)
 
 /*
  *  call-seq:
- *     WIN32OLE_RECORD#inspect -> String
+ *     inspect -> String
  *
  *  Returns the OLE struct name and member name and the value of member
  *
@@ -570,8 +570,8 @@ folerecord_ole_instance_variable_set(VALUE self, VALUE name, VALUE val)
  *  then
  *
  *     srver = WIN32OLE.new('ComServer.ComClass')
- *     obj = WIN32OLE_RECORD.new('Book', server)
- *     obj.inspect # => <WIN32OLE_RECORD(ComClass) {"title" => nil, "cost" => nil}>
+ *     obj = WIN32OLE::Record.new('Book', server)
+ *     obj.inspect # => <WIN32OLE::Record(ComClass) {"title" => nil, "cost" => nil}>
  *
  */
 static VALUE
@@ -584,7 +584,7 @@ folerecord_inspect(VALUE self)
         tname = rb_inspect(tname);
     }
     field = rb_inspect(folerecord_to_h(self));
-    return rb_sprintf("#<WIN32OLE_RECORD(%"PRIsVALUE") %"PRIsVALUE">",
+    return rb_sprintf("#<WIN32OLE::Record(%"PRIsVALUE") %"PRIsVALUE">",
                       tname,
                       field);
 }
@@ -595,6 +595,7 @@ void
 Init_win32ole_record(void)
 {
     cWIN32OLE_RECORD = rb_define_class_under(cWIN32OLE, "Record", rb_cObject);
+    /* Alias of WIN32OLE::Record, for the backward compatibility */
     rb_define_const(rb_cObject, "WIN32OLE_RECORD", cWIN32OLE_RECORD);
     rb_define_alloc_func(cWIN32OLE_RECORD, folerecord_s_allocate);
     rb_define_method(cWIN32OLE_RECORD, "initialize", folerecord_initialize, 2);