message: Consistently initialize locator; use 0 for "no line number".
authorBen Pfaff <blp@cs.stanford.edu>
Sun, 19 Sep 2010 18:04:41 +0000 (11:04 -0700)
committerBen Pfaff <blp@cs.stanford.edu>
Fri, 24 Sep 2010 03:45:31 +0000 (20:45 -0700)
A few of the callers of msg_emit() did not initialize the "where" member
of the struct msg, because they expect that msg_emit() will do it for them.
This is currently correct, but I intend to soon introduce the ability for
msg_emit()'s caller to specify a location.  With that change, it will be
important for the caller to initialize this member, so this commit makes
sure of that.

At the same time, some callers were using -1 as the default value that
means "no line number" and others were using 0.  This commit standardizes
on the latter.

src/data/data-in.c
src/language/control/repeat.c
src/language/expressions/helpers.c
src/language/syntax-string-source.c
src/libpspp/getl.c
src/libpspp/message.c
src/libpspp/message.h

index cd512268309a76f0a00cfe36b5a6fae3f7d75915..480d335a9c086b007f01b0a9efcde1b516e2bf0e 100644 (file)
@@ -1203,7 +1203,7 @@ vdata_warning (const struct data_in *i, const char *format, va_list args)
   m.severity = MSG_S_WARNING;
   m.text = ds_cstr (&text);
   m.where.file_name = NULL;
-  m.where.line_number = -1;
+  m.where.line_number = 0;
 
   msg_emit (&m);
 }
index 1ab3b9c2ff7f49b4d392655aa336bd9087e0cab1..d7cc544fe6e8e001268b6c37643cacc91bce7daf 100644 (file)
@@ -1,5 +1,5 @@
 /* PSPP - a program for statistical analysis.
-   Copyright (C) 1997-9, 2000, 2007, 2009 Free Software Foundation, Inc.
+   Copyright (C) 1997-9, 2000, 2007, 2009, 2010 Free Software Foundation, Inc.
 
    This program is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
@@ -618,10 +618,10 @@ do_repeat_name (const struct getl_interface *interface)
 }
 
 /* Returns the line number in the source file from which the
-   previous line was originally obtained, or -1 if none. */
+   previous line was originally obtained, or 0 if none. */
 static int
 do_repeat_location (const struct getl_interface *interface)
 {
   struct repeat_line *line = current_line (interface);
-  return line ? line->line_number : -1;
+  return line ? line->line_number : 0;
 }
index 17fc3182253369ef9177a29f186b04355cc15639..2d707e9941dd2c480bf1446d2d81e9f697192988 100644 (file)
@@ -34,6 +34,8 @@ expr_error (void *aux UNUSED, const char *format, ...)
   m.severity = MSG_S_ERROR;
   va_start (args, format);
   m.text = xvasprintf (format, args);
+  m.where.file_name = NULL;
+  m.where.line_number = 0;
   va_end (args);
 
   msg_emit (&m);
index 3860b8987cc805e6226fddbcb1cdcd8b01f4475f..4f3c1c143a76f577e522568b78d869dde9574dd2 100644 (file)
@@ -54,7 +54,7 @@ name (const struct getl_interface *i UNUSED)
 static int
 location (const struct getl_interface *i UNUSED)
 {
-  return -1;
+  return 0;
 }
 
 
index 43d2a56f460d8f645a61ee86dc5e457c862a9efc..9db6c3ae56260d3be735efd45588622b4eb2077b 100644 (file)
@@ -212,18 +212,18 @@ getl_source_name (const struct source_stream *ss)
   return s->interface->name (s->interface);
 }
 
-/* Returns the location within the current source, or -1 if there is
-   no current source */
+/* Returns the line number within the current source, or 0 if there is no
+   current source. */
 int
 getl_source_location (const struct source_stream *ss)
 {
   const struct getl_source *s = current_source (ss);
 
   if ( ll_is_empty (&ss->sources) )
-    return -1;
+    return 0;
 
   if ( !s->interface->location )
-    return -1;
+    return 0;
 
   return s->interface->location (s->interface);
 }
index 4ba8a8f7aca966e5add8671fa31dbd178abfc387..e0f9bf178a202a94e76f93d4a6d3dd8d83bb3185 100644 (file)
@@ -57,6 +57,8 @@ msg (enum msg_class class, const char *format, ...)
   m.severity = msg_class_to_severity (class);
   va_start (args, format);
   m.text = xvasprintf (format, args);
+  m.where.file_name = NULL;
+  m.where.line_number = 0;
   va_end (args);
 
   msg_emit (&m);
@@ -118,7 +120,7 @@ msg_to_string (const struct msg *m, const char *command_name)
     {
       if (m->where.file_name)
         ds_put_format (&s, "%s:", m->where.file_name);
-      if (m->where.line_number != -1)
+      if (m->where.line_number > 0)
         ds_put_format (&s, "%d:", m->where.line_number);
       ds_put_char (&s, ' ');
     }
@@ -199,7 +201,7 @@ submit_note (char *s)
   m.category = MSG_C_GENERAL;
   m.severity = MSG_S_NOTE;
   m.where.file_name = NULL;
-  m.where.line_number = -1;
+  m.where.line_number = 0;
   m.text = s;
   msg_handler (&m);
   free (s);
@@ -258,7 +260,7 @@ msg_emit (struct msg *m)
   else
     {
       m->where.file_name = NULL;
-      m->where.line_number = -1;
+      m->where.line_number = 0;
     }
 
   if (!messages_disabled)
index bdd27a5e72faac5cc52ee2e85bbd8a992a7c6912..6cdf6e87c3732d19cd34679ce7f6afab7f31fe18 100644 (file)
@@ -1,5 +1,5 @@
 /* PSPP - a program for statistical analysis.
-   Copyright (C) 1997-9, 2000, 2006 Free Software Foundation, Inc.
+   Copyright (C) 1997-9, 2000, 2006, 2010 Free Software Foundation, Inc.
 
    This program is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
@@ -70,8 +70,8 @@ msg_class_from_category_and_severity (enum msg_category category,
 /* A file location.  */
 struct msg_locator
   {
-    char *file_name;           /* File name. */
-    int line_number;            /* Line number. */
+    char *file_name;           /* File name (NULL if none). */
+    int line_number;           /* Line number (0 if none). */
   };
 
 /* A message. */