Changeset 6829afc for owl.h

Timestamp:

Jun 25, 2011, 3:26:15 AM (13 years ago)

Author:

David Benjamin <davidben@mit.edu>

Branches:

master, release-1.10, release-1.8, release-1.9

Children:

12294d2

Parents:

95b52d1

git-author:

David Benjamin <davidben@mit.edu> (06/24/11 22:56:15)

git-committer:

David Benjamin <davidben@mit.edu> (06/25/11 03:26:15)

Message:

Define CALLER_OWN macro

Replace our exising uses of G_GNUC_WARN_UNUSED_RESULT with it. The
old macro is just way too long. This also more clearly specifies the
intent.

File:

• owl.h (modified) (4 diffs)

owl.h

@@ -199 +199 @@
 #define OWL_ENABLE_ZCRYPT 1
 #endif
+
+/* Annotate functions in which the caller owns the return value and is
+ * responsible for ensuring it is freed. */
+#define CALLER_OWN G_GNUC_WARN_UNUSED_RESULT
 
 #define OWL_META(key) ((key)|010000)
@@ -251 +255 @@
                                  * WARNING:  this approach is hard to make
                                  * thread-safe... */
-  char G_GNUC_WARN_UNUSED_RESULT *(*get_tostring_fn)(const struct _owl_variable *v, const void *val);
+  char CALLER_OWN *(*get_tostring_fn)(const struct _owl_variable *v, const void *val);
                                 /* converts val to a string;
                                  * caller must free the result */
@@ -313 +317 @@
   
   /* These don't take any context */
-  char G_GNUC_WARN_UNUSED_RESULT *(*cmd_args_fn)(int argc, const char *const *argv, const char *buff);
+  char CALLER_OWN *(*cmd_args_fn)(int argc, const char *const *argv, const char *buff);
                                 /* takes argv and the full command as buff.
                                  * caller must free return value if !NULL */
@@ -320 +324 @@
 
   /* The following also take the active context if it's valid */
-  char G_GNUC_WARN_UNUSED_RESULT *(*cmd_ctxargs_fn)(void *ctx, int argc, const char *const *argv, const char *buff);
+  char CALLER_OWN *(*cmd_ctxargs_fn)(void *ctx, int argc, const char *const *argv, const char *buff);
                                 /* takes argv and the full command as buff.
                                  * caller must free return value if !NULL */