Bug 557405 – Use 'allow-none' consistently

2008-10-22  Tommi Komulainen  <tommi.komulainen@iki.fi>

	* docs/typelib-format.txt:
	* girepository/ginfo.c (g_arg_info_may_be_null):
	* girepository/girnode.c (g_ir_node_build_typelib):
	* girepository/girnode.h (struct _GIrNodeParam):
	* girepository/girparser.c (start_parameter):
	* girepository/girwriter.c (function_generate):
	* girepository/gtypelib.h (ArgBlob):
	* tests/errors.gir:
	* tests/function.gir:
	* tools/generate.c (write_callable_info): Use 'allow-none'
	consistently throughout

svn path=/trunk/; revision=782

diff --git a/ChangeLog b/ChangeLog
index f98b783..b56aa7f 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,5 +1,21 @@
 2008-10-22  Tommi Komulainen  <tommi.komulainen@iki.fi>
 
+       Bug 557405 – Use 'allow-none' consistently
+
+       * docs/typelib-format.txt:
+       * girepository/ginfo.c (g_arg_info_may_be_null):
+       * girepository/girnode.c (g_ir_node_build_typelib):
+       * girepository/girnode.h (struct _GIrNodeParam):
+       * girepository/girparser.c (start_parameter):
+       * girepository/girwriter.c (function_generate):
+       * girepository/gtypelib.h (ArgBlob):
+       * tests/errors.gir:
+       * tests/function.gir:
+       * tools/generate.c (write_callable_info): Use 'allow-none'
+       consistently throughout
+
+2008-10-22  Tommi Komulainen  <tommi.komulainen@iki.fi>
+
        Bug 557092 – Callback annotations not used
 
        * giscanner/transformer.py (_create_callback): use annotations

diff --git a/docs/typelib-format.txt b/docs/typelib-format.txt
index a09ab01..0c813ba 100644 (file)
--- a/docs/typelib-format.txt
+++ b/docs/typelib-format.txt
@@ -380,7 +380,7 @@ struct ArgBlob
   guint          in                           : 1;
   guint          out                          : 1;
   guint          dipper                       : 1;
-  guint          null_ok                      : 1;
+  guint          allow_none                   : 1;
   guint          optional                     : 1;
   guint          transfer_ownership           : 1;
   guint          transfer_container_ownership : 1;
@@ -403,11 +403,12 @@ out:      The parameter is used to return an output of the function.
 dipper:   The parameter is a pointer to a struct or object that will 
           receive an output of the function. 
 
-null_ok:  Only meaningful for types which are passed as pointers.
+allow_none:
+          Only meaningful for types which are passed as pointers.
           For an in parameter, indicates if it is ok to pass NULL in, for 
           an out parameter, whether it may return NULL. Note that NULL is a 
-          valid GList and GSList value, thus null_ok will normally be set for 
-          parameters of these types.
+          valid GList and GSList value, thus allow_none will normally be set
+          for parameters of these types.
 
 optional:          
           For an out parameter, indicates that NULL may be passed in

diff --git a/girepository/ginfo.c b/girepository/ginfo.c
index fc265ad..b2a7431 100644 (file)
--- a/girepository/ginfo.c
+++ b/girepository/ginfo.c
@@ -707,7 +707,7 @@ g_arg_info_may_be_null (GIArgInfo *info)
   GIBaseInfo *base = (GIBaseInfo *)info;
   ArgBlob *blob = (ArgBlob *)&base->typelib->data[base->offset];
   
-  return blob->null_ok;
+  return blob->allow_none;
 }
 
 GITransfer

diff --git a/girepository/girnode.c b/girepository/girnode.c
index e6fc799..7b68e0c 100644 (file)
--- a/girepository/girnode.c
+++ b/girepository/girnode.c
@@ -1489,7 +1489,7 @@ g_ir_node_build_typelib (GIrNode    *node,
                                 module, modules, strings, types,
                                 data, &signature, offset2);
 
-       blob2->may_return_null = function->result->null_ok;
+       blob2->may_return_null = function->result->allow_none;
        blob2->caller_owns_return_value = function->result->transfer;
        blob2->caller_owns_return_container = function->result->shallow_transfer;
        blob2->reserved = 0;
@@ -1533,7 +1533,7 @@ g_ir_node_build_typelib (GIrNode    *node,
                                 module, modules, strings, types,
                                 data, &signature, offset2);
 
-       blob2->may_return_null = function->result->null_ok;
+       blob2->may_return_null = function->result->allow_none;
        blob2->caller_owns_return_value = function->result->transfer;
        blob2->caller_owns_return_container = function->result->shallow_transfer;
        blob2->reserved = 0;
@@ -1585,7 +1585,7 @@ g_ir_node_build_typelib (GIrNode    *node,
                                 module, modules, strings, types,
                                 data, &signature, offset2);
 
-       blob2->may_return_null = signal->result->null_ok;
+       blob2->may_return_null = signal->result->allow_none;
        blob2->caller_owns_return_value = signal->result->transfer;
        blob2->caller_owns_return_container = signal->result->shallow_transfer;
        blob2->reserved = 0;
@@ -1632,7 +1632,7 @@ g_ir_node_build_typelib (GIrNode    *node,
                                 module, modules, strings, types,
                                 data, &signature, offset2);
 
-       blob2->may_return_null = vfunc->result->null_ok;
+       blob2->may_return_null = vfunc->result->allow_none;
        blob2->caller_owns_return_value = vfunc->result->transfer;
        blob2->caller_owns_return_container = vfunc->result->shallow_transfer;
        blob2->reserved = 0;
@@ -1661,7 +1661,7 @@ g_ir_node_build_typelib (GIrNode    *node,
        blob->in = param->in;
        blob->out = param->out;
        blob->dipper = param->dipper;
-       blob->null_ok = param->null_ok;
+       blob->allow_none = param->allow_none;
        blob->optional = param->optional;
        blob->transfer_ownership = param->transfer;
        blob->transfer_container_ownership = param->shallow_transfer;

diff --git a/girepository/girnode.h b/girepository/girnode.h
index 0ef95df..b816137 100644 (file)
--- a/girepository/girnode.h
+++ b/girepository/girnode.h
@@ -136,7 +136,7 @@ struct _GIrNodeParam
   gboolean dipper;
   gboolean optional;
   gboolean retval;
-  gboolean null_ok;
+  gboolean allow_none;
   gboolean transfer;
   gboolean shallow_transfer;
   

diff --git a/girepository/girparser.c b/girepository/girparser.c
index fb5b68b..9ca5225 100644 (file)
--- a/girepository/girparser.c
+++ b/girepository/girparser.c
@@ -699,7 +699,7 @@ start_parameter (GMarkupParseContext *context,
   const gchar *retval;
   const gchar *dipper;
   const gchar *optional;
-  const gchar *nullok;
+  const gchar *allow_none;
   const gchar *transfer;
   GIrNodeParam *param;
       
@@ -712,7 +712,7 @@ start_parameter (GMarkupParseContext *context,
   retval = find_attribute ("retval", attribute_names, attribute_values);
   dipper = find_attribute ("dipper", attribute_names, attribute_values);
   optional = find_attribute ("optional", attribute_names, attribute_values);
-  nullok = find_attribute ("null-ok", attribute_names, attribute_values);
+  allow_none = find_attribute ("allow-none", attribute_names, attribute_values);
   transfer = find_attribute ("transfer-ownership", attribute_names, attribute_values);
 
   if (name == NULL)
@@ -756,10 +756,10 @@ start_parameter (GMarkupParseContext *context,
   else
     param->optional = FALSE;
 
-  if (nullok && strcmp (nullok, "1") == 0)
-    param->null_ok = TRUE;
+  if (allow_none && strcmp (allow_none, "1") == 0)
+    param->allow_none = TRUE;
   else
-    param->null_ok = FALSE;
+    param->allow_none = FALSE;
 
   parse_param_transfer (param, transfer);
 

diff --git a/girepository/girwriter.c b/girepository/girwriter.c
index d4d5506..5a9459f 100644 (file)
--- a/girepository/girwriter.c
+++ b/girepository/girwriter.c
@@ -183,9 +183,9 @@ function_generate (GIdlWriter * writer, GIdlNodeFunction * node)
            g_string_append (markup_s,
                           g_markup_printf_escaped (" transfer=\"full\""));
 
-         if (param->null_ok)
+         if (param->allow_none)
            g_string_append (markup_s,
-                            g_markup_printf_escaped (" null-ok=\"1\""));
+                            g_markup_printf_escaped (" allow-none=\"1\""));
          
          if (strcmp (direction, "in") != 0)
            g_string_append (markup_s,

diff --git a/girepository/gtypelib.h b/girepository/gtypelib.h
index 8bb8777..3db620d 100644 (file)
--- a/girepository/gtypelib.h
+++ b/girepository/gtypelib.h
@@ -127,7 +127,7 @@ typedef struct
   guint          in                           : 1;
   guint          out                          : 1;
   guint          dipper                       : 1;
-  guint          null_ok                      : 1;
+  guint          allow_none                   : 1;
   guint          optional                     : 1;
   guint          transfer_ownership           : 1;
   guint          transfer_container_ownership : 1;

diff --git a/tests/errors.gir b/tests/errors.gir
index 1458807..6353498 100644 (file)
--- a/tests/errors.gir
+++ b/tests/errors.gir
@@ -17,7 +17,7 @@
     <function name="test1" symbol="test1">
       <return-type type="gboolean" />
       <parameters>
-        <parameter name="p1" type="gint" direction="in" null-ok="1" />
+        <parameter name="p1" type="gint" direction="in" allow-none="1" />
         <parameter name="p2" type="GError<Errors1,Errors2>*" transfer="full" direction="out" />
       </parameters>
     </function>

diff --git a/tests/function.gir b/tests/function.gir
index e60670a..a32ccb1 100644 (file)
--- a/tests/function.gir
+++ b/tests/function.gir
@@ -9,14 +9,14 @@
     <function name="test1" symbol="test1" deprecated="1">
       <return-type type="gboolean" />
       <parameters>
-        <parameter name="p1" type="Boxed1*" transfer="full" direction="in" null-ok="1" />
+        <parameter name="p1" type="Boxed1*" transfer="full" direction="in" allow-none="1" />
         <parameter name="p2" type="gboolean" direction="out" />
       </parameters>
     </function>
     <callback name="callback1" deprecated="1">
       <return-type type="gboolean" />
       <parameters>
-        <parameter name="p1" type="Boxed1*" transfer="full" direction="in" null-ok="1" />
+        <parameter name="p1" type="Boxed1*" transfer="full" direction="in" allow-none="1" />
         <parameter name="p2" type="gboolean" direction="out" />
       </parameters>
     </callback>

diff --git a/tools/generate.c b/tools/generate.c
index 42ce9e4..b6e6fc8 100644 (file)
--- a/tools/generate.c
+++ b/tools/generate.c
@@ -400,7 +400,7 @@ write_callable_info (const gchar    *namespace,
     }
   
   if (g_callable_info_may_return_null (info))
-    xml_printf (file, " null-ok=\"1\"");
+    xml_printf (file, " allow-none=\"1\"");
 
   write_type_info (namespace, type, file);
 
@@ -445,7 +445,7 @@ write_callable_info (const gchar    *namespace,
        }
       
       if (g_arg_info_may_be_null (arg))
-       xml_printf (file, " null-ok=\"1\"");
+       xml_printf (file, " allow-none=\"1\"");
       
       if (g_arg_info_is_dipper (arg))
        xml_printf (file, " dipper=\"1\"");