Changeset 7dfe886 for util.c

Timestamp:

Jun 19, 2011, 2:44:13 AM (13 years ago)

Author:

Jason Gross <jgross@mit.edu>

Children:

b0e6560

Parents:

9d43dcc

git-author:

Jason Gross <jgross@mit.edu> (06/06/11 05:24:30)

git-committer:

Jason Gross <jgross@mit.edu> (06/19/11 02:44:13)

Message:

Use G_GNUC_WARN_UNUSED_RESULT

Have gcc warn us when we ignore the result of a function that requires
the caller to free the result, or an initilization function that can
fail.  This might help (slightly) with preventing leaks and segfaults.

Additionally changed some functions that should never fail to not
return values.  (The owl_list_* functions changed only fail if
list->size < 0, which we assume is not the case elsewhere.)

File:

• util.c (modified) (14 diffs)

util.c

@@ -35 +35 @@
  * duplicate slashes are removed.  Caller must free the return.
  */
-char *owl_util_makepath(const char *in)
+G_GNUC_WARN_UNUSED_RESULT char *owl_util_makepath(const char *in)
 {
   int i, j, x;
@@ -102 +102 @@
    to -1, argv will be NULL and the caller does not need to free anything. The
    returned vector is NULL-terminated. */
-char **owl_parseline(const char *line, int *argc)
+G_GNUC_WARN_UNUSED_RESULT char **owl_parseline(const char *line, int *argc)
 {
   GPtrArray *argv;
@@ -245 +245 @@
 }
 
-char *owl_string_build_quoted(const char *tmpl, ...)
+G_GNUC_WARN_UNUSED_RESULT char *owl_string_build_quoted(const char *tmpl, ...)
 {
   GString *buf = g_string_new("");
@@ -257 +257 @@
 /* Returns a quoted version of arg suitable for placing in a
  * command-line. Result should be freed with g_free. */
-char *owl_arg_quote(const char *arg)
+G_GNUC_WARN_UNUSED_RESULT char *owl_arg_quote(const char *arg)
 {
   GString *buf = g_string_new("");;
@@ -265 +265 @@
 
 /* caller must free the return */
-char *owl_util_minutes_to_timestr(int in)
+G_GNUC_WARN_UNUSED_RESULT char *owl_util_minutes_to_timestr(int in)
 {
   int days, hours;
@@ -331 +331 @@
 
 /* Get the default tty name.  Caller must free the return */
-char *owl_util_get_default_tty(void)
+G_GNUC_WARN_UNUSED_RESULT char *owl_util_get_default_tty(void)
 {
   const char *tmp;
@@ -353 +353 @@
  * return.
  */
-char *owl_util_stripnewlines(const char *in)
+G_GNUC_WARN_UNUSED_RESULT char *owl_util_stripnewlines(const char *in)
 {
   
@@ -384 +384 @@
  * Error conditions are the same as g_file_read_link.
  */
-gchar *owl_util_recursive_resolve_link(const char *filename)
+G_GNUC_WARN_UNUSED_RESULT gchar *owl_util_recursive_resolve_link(const char *filename)
 {
   gchar *last_path = g_strdup(filename);
@@ -511 +511 @@
    The caller is responsible for freeing the allocated string.
 */
-char * owl_util_baseclass(const char * class)
+G_GNUC_WARN_UNUSED_RESULT char *owl_util_baseclass(const char *class)
 {
   char *start, *end;
@@ -546 +546 @@
 
 /* Strips format characters from a valid utf-8 string. Returns the
-   empty string if 'in' does not validate. */
-char * owl_strip_format_chars(const char *in)
+   empty string if 'in' does not validate.  Caller must free the return. */
+G_GNUC_WARN_UNUSED_RESULT char *owl_strip_format_chars(const char *in)
 {
   char *r;
@@ -584 +584 @@
  * out characters in Unicode Plane 16, as we use that plane internally
  * for formatting.
- */
-char * owl_validate_or_convert(const char *in)
+ * Caller must free the return.
+ */
+G_GNUC_WARN_UNUSED_RESULT char *owl_validate_or_convert(const char *in)
 {
   if (g_utf8_validate(in, -1, NULL)) {
@@ -599 +600 @@
  * Validate 'in' as UTF-8, and either return a copy of it, or an empty
  * string if it is invalid utf-8.
- */
-char * owl_validate_utf8(const char *in)
+ * Caller must free the return.
+ */
+G_GNUC_WARN_UNUSED_RESULT char *owl_validate_utf8(const char *in)
 {
   char *out;
@@ -632 +634 @@
 }
 
-char *owl_escape_highbit(const char *str)
+/* caller must free the return */
+G_GNUC_WARN_UNUSED_RESULT char *owl_escape_highbit(const char *str)
 {
   GString *out = g_string_new("");
@@ -695 +698 @@
 
 /* Read the rest of the input available in fp into a string. */
-char *owl_slurp(FILE *fp)
+G_GNUC_WARN_UNUSED_RESULT char *owl_slurp(FILE *fp)
 {
   char *buf = NULL;