[Pspp-cvs] pspp/src data/ChangeLog data/file-handle-def.c ...

[Ben Pfaff]

CVSROOT:        /cvsroot/pspp
Module name:    pspp
Changes by:     Ben Pfaff <blp> 07/02/02 00:57:32

Modified files:
        src/data       : ChangeLog file-handle-def.c file-handle-def.h 
        src/language/data-io: ChangeLog file-handle.q 

Log message:
        We are using a single member in struct file_handle, the "name"
        field, for more than one purpose.  When it begins with '"', it's a
        file name; otherwise, it's a token that can be used to identify
        it.  When that assertion fires, it's because we searched for the
        name case-sensitively as a file name (so that there was no match),
        and then we try to insert it case-insensitively as a token, which
        fails because duplicates aren't allowed.
        
        Solution: break the two purposes into two separate fields.  This
        fixes the problem and likely makes the code easier to read too.
        
        Fixes bug #18922.  Thanks to John Darrington for bug report and
        review.

CVSWeb URLs:
http://cvs.savannah.gnu.org/viewcvs/pspp/src/data/ChangeLog?cvsroot=pspp&r1=1.100&r2=1.101
http://cvs.savannah.gnu.org/viewcvs/pspp/src/data/file-handle-def.c?cvsroot=pspp&r1=1.7&r2=1.8
http://cvs.savannah.gnu.org/viewcvs/pspp/src/data/file-handle-def.h?cvsroot=pspp&r1=1.3&r2=1.4
http://cvs.savannah.gnu.org/viewcvs/pspp/src/language/data-io/ChangeLog?cvsroot=pspp&r1=1.36&r2=1.37
http://cvs.savannah.gnu.org/viewcvs/pspp/src/language/data-io/file-handle.q?cvsroot=pspp&r1=1.11&r2=1.12

Patches:
Index: data/ChangeLog
===================================================================
RCS file: /cvsroot/pspp/pspp/src/data/ChangeLog,v
retrieving revision 1.100
retrieving revision 1.101
diff -u -b -r1.100 -r1.101
--- data/ChangeLog      16 Jan 2007 15:30:28 -0000      1.100
+++ data/ChangeLog      2 Feb 2007 00:57:32 -0000       1.101
@@ -1,3 +1,25 @@
+Thu Feb  1 16:53:37 2007  Ben Pfaff  <address@hidden>
+
+       We are using a single member in struct file_handle, the "name"
+       field, for more than one purpose.  When it begins with '"', it's a
+       file name; otherwise, it's a token that can be used to identify
+       it.  When that assertion fires, it's because we searched for the
+       name case-sensitively as a file name (so that there was no match),
+       and then we try to insert it case-insensitively as a token, which
+       fails because duplicates aren't allowed.
+
+       Solution: break the two purposes into two separate fields.  This
+       fixes the problem and likely makes the code easier to read too.
+
+       Fixes bug #18922.  Thanks to John Darrington for bug report and
+       review.
+
+       * file-handle-def.c (struct file_handle): New `id' member.
+       (fh_from_name): Rename fh_from_id.  Update all callers.
+       (create_handle): New `id' parameter.  Update all callers.
+       (fh_create_file): Ditto.
+       (fh_get_id): New function.
+
 Mon Jan 15 16:18:10 2007  Ben Pfaff  <address@hidden>
 
        * case.c (case_is_null): Change return type to bool.

Index: data/file-handle-def.c
===================================================================
RCS file: /cvsroot/pspp/pspp/src/data/file-handle-def.c,v
retrieving revision 1.7
retrieving revision 1.8
diff -u -b -r1.7 -r1.8
--- data/file-handle-def.c      15 Dec 2006 00:16:02 -0000      1.7
+++ data/file-handle-def.c      2 Feb 2007 00:57:32 -0000       1.8
@@ -29,9 +29,10 @@
 #include <libpspp/compiler.h>
 #include <libpspp/magic.h>
 #include <libpspp/message.h>
-#include "file-name.h"
-#include "variable.h"
-#include "scratch-handle.h"
+#include <libpspp/str.h>
+#include <data/file-name.h>
+#include <data/variable.h>
+#include <data/scratch-handle.h>
 
 #include "gettext.h"
 #define _(msgid) gettext (msgid)
@@ -45,7 +46,8 @@
     int open_cnt;               /* 0=not open, otherwise # of openers. */
     bool deleted;               /* Destroy handle when open_cnt goes to 0? */
 
-    char *name;                 /* File handle identifier. */
+    char id[LONG_NAME_LEN + 1]; /* Identifier token; empty string if none. */
+    char *name;                 /* User-friendly identifying name. */
     const char *type;           /* If open, type of file. */
     char open_mode[3];          /* "[rw][se]". */
     void *aux;                  /* Aux data pointer for owner if any. */
@@ -74,13 +76,14 @@
 /* The "file" that reads from BEGIN DATA...END DATA. */
 static struct file_handle *inline_file;
 
-static struct file_handle *create_handle (const char *name, enum fh_referent);
+static struct file_handle *create_handle (const char *id,
+                                          const char *name, enum fh_referent);
 
 /* File handle initialization routine. */
 void 
 fh_init (void)
 {
-  inline_file = create_handle ("INLINE", FH_REF_INLINE);
+  inline_file = create_handle ("INLINE", "INLINE", FH_REF_INLINE);
   inline_file->record_width = 80;
   inline_file->tab_width = 8;
 }
@@ -116,15 +119,15 @@
     free_handle (file_handles);
 }
 
-/* Returns the handle named HANDLE_NAME, or a null pointer if
+/* Returns the handle with the given ID, or a null pointer if
    there is none. */
 struct file_handle *
-fh_from_name (const char *handle_name) 
+fh_from_id (const char *id) 
 {
   struct file_handle *iter;
 
   for (iter = file_handles; iter != NULL; iter = iter->next)
-    if (!iter->deleted && !strcasecmp (handle_name, iter->name))
+    if (!iter->deleted && !strcasecmp (id, iter->id))
       return iter;
   return NULL;
 }
@@ -164,19 +167,22 @@
   return NULL;
 }
 
-/* Creates a new handle with name HANDLE_NAME that refers to
-   REFERENT.  Links the new handle into the global list.  Returns
-   the new handle.
+/* Creates a new handle with identifier ID (which may be null)
+   and name HANDLE_NAME that refers to REFERENT.  Links the new
+   handle into the global list.  Returns the new handle.
 
    The new handle is not fully initialized.  The caller is
    responsible for completing its initialization. */
 static struct file_handle *
-create_handle (const char *handle_name, enum fh_referent referent) 
+create_handle (const char *id, const char *handle_name,
+               enum fh_referent referent) 
 {
   struct file_handle *handle = xzalloc (sizeof *handle);
+  assert (id == NULL || fh_from_id (id) == NULL);
   handle->next = file_handles;
   handle->open_cnt = 0;
   handle->deleted = false;
+  str_copy_trunc (handle->id, sizeof handle->id, id != NULL ? id : "");
   handle->name = xstrdup (handle_name);
   handle->type = NULL;
   handle->aux = NULL;
@@ -194,16 +200,21 @@
   return inline_file;
 }
 
-/* Creates a new file handle named HANDLE_NAME, which must not be
-   the name of an existing file handle.  The new handle is
-   associated with file FILE_NAME and the given PROPERTIES. */
+/* Creates a new file handle with the given ID, which may be
+   null.  If it is non-null, it must be unique among existing
+   file identifiers.  The new handle is associated with file
+   FILE_NAME and the given PROPERTIES. */
 struct file_handle *
-fh_create_file (const char *handle_name, const char *file_name,
+fh_create_file (const char *id, const char *file_name,
                 const struct fh_properties *properties)
 {
+  char *handle_name;
   struct file_handle *handle;
-  assert (fh_from_name (handle_name) == NULL);
-  handle = create_handle (handle_name, FH_REF_FILE);
+
+  handle_name = id != NULL ? (char *) id : xasprintf ("\"%s\"", file_name);
+  handle = create_handle (id, handle_name, FH_REF_FILE);
+  if (id == NULL)
+    free (handle_name);
   handle->file_name = xstrdup (file_name);
   handle->identity = fn_get_identity (file_name);
   handle->mode = properties->mode;
@@ -212,13 +223,15 @@
   return handle;
 }
 
-/* Creates a new file handle named HANDLE_NAME, which must not be
-   the name of an existing file handle.  The new handle is
+/* Creates a new file handle with the given ID, which must be
+   unique among existing file identifiers.  The new handle is
    associated with a scratch file (initially empty). */
 struct file_handle *
-fh_create_scratch (const char *handle_name) 
+fh_create_scratch (const char *id) 
 {
-  struct file_handle *handle = create_handle (handle_name, FH_REF_SCRATCH);
+  struct file_handle *handle;
+  assert (id != NULL);
+  handle = create_handle (id, id, FH_REF_SCRATCH);
   handle->sh = NULL;
   return handle;
 }
@@ -368,10 +381,21 @@
   return handle->open_cnt > 0;
 }
 
-/* Returns the identifier of file HANDLE.  If HANDLE was created
-   by referring to a file name instead of a handle name, returns
-   the file name, enclosed in double quotes.  Return value is
-   owned by the file handle. 
+/* Returns the identifier that may be used in syntax to name the
+   given HANDLE, which takes the form of a PSPP identifier.  If
+   HANDLE has no identifier, returns a null pointer.
+
+   Return value is owned by the file handle.*/
+const char *
+fh_get_id (const struct file_handle *handle) 
+{
+  return handle->id[0] != '\0' ? handle->id : NULL;
+}
+
+/* Returns a user-friendly string to identify the given HANDLE.
+   If HANDLE was created by referring to a file name, returns the
+   file name, enclosed in double quotes.  Return value is owned
+   by the file handle.
 
    Useful for printing error messages about use of file handles.  */
 const char *

Index: data/file-handle-def.h
===================================================================
RCS file: /cvsroot/pspp/pspp/src/data/file-handle-def.h,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -b -r1.3 -r1.4
--- data/file-handle-def.h      15 Dec 2006 00:16:02 -0000      1.3
+++ data/file-handle-def.h      2 Feb 2007 00:57:32 -0000       1.4
@@ -61,11 +61,12 @@
 void fh_free (struct file_handle *);
 
 /* Finding file handles. */
-struct file_handle *fh_from_name (const char *handle_name);
+struct file_handle *fh_from_id (const char *handle_name);
 struct file_handle *fh_from_file_name (const char *file_name);
 struct file_handle *fh_inline_file (void);
 
 /* Generic properties of file handles. */
+const char *fh_get_id (const struct file_handle *);
 const char *fh_get_name (const struct file_handle *);
 enum fh_referent fh_get_referent (const struct file_handle *);
 

Index: language/data-io/ChangeLog
===================================================================
RCS file: /cvsroot/pspp/pspp/src/language/data-io/ChangeLog,v
retrieving revision 1.36
retrieving revision 1.37
diff -u -b -r1.36 -r1.37
--- language/data-io/ChangeLog  19 Dec 2006 14:21:53 -0000      1.36
+++ language/data-io/ChangeLog  2 Feb 2007 00:57:32 -0000       1.37
@@ -1,3 +1,8 @@
+Thu Feb  1 16:56:02 2007  Ben Pfaff  <address@hidden>
+
+       * file-handle.q (fh_parse): Update to new fh_create_file
+       prototype.
+
 Sat Dec 16 22:16:18 2006  Ben Pfaff  <address@hidden>
 
        Make it possible to pull cases from the active file with a

Index: language/data-io/file-handle.q
===================================================================
RCS file: /cvsroot/pspp/pspp/src/language/data-io/file-handle.q,v
retrieving revision 1.11
retrieving revision 1.12
diff -u -b -r1.11 -r1.12
--- language/data-io/file-handle.q      15 Dec 2006 00:16:02 -0000      1.11
+++ language/data-io/file-handle.q      2 Feb 2007 00:57:32 -0000       1.12
@@ -61,7 +61,7 @@
     return CMD_CASCADING_FAILURE;
   str_copy_trunc (handle_name, sizeof handle_name, lex_tokid (lexer));
 
-  handle = fh_from_name (handle_name);
+  handle = fh_from_id (handle_name);
   if (handle != NULL)
     {
       msg (SE, _("File handle %s is already defined.  "
@@ -131,7 +131,7 @@
 
   if (!lex_force_id (lexer))
     return CMD_CASCADING_FAILURE;
-  handle = fh_from_name (lex_tokid (lexer));
+  handle = fh_from_id (lex_tokid (lexer));
   if (handle == NULL)
     return CMD_CASCADING_FAILURE;
 
@@ -178,19 +178,14 @@
 
       handle = NULL;
       if (lex_token (lexer) == T_ID) 
-        handle = fh_from_name (lex_tokid (lexer));
+        handle = fh_from_id (lex_tokid (lexer));
       if (handle == NULL) 
         handle = fh_from_file_name (ds_cstr (lex_tokstr (lexer))); 
       if (handle == NULL)
         {
           if (lex_token (lexer) != T_ID || lex_tokid (lexer)[0] != '#' || 
get_syntax () != ENHANCED) 
-            {
-              char *file_name = ds_cstr (lex_tokstr (lexer));
-              char *handle_name = xasprintf ("\"%s\"", file_name);
-              handle = fh_create_file (handle_name, file_name,
+            handle = fh_create_file (NULL, ds_cstr (lex_tokstr (lexer)),
                                        fh_default_properties ());
-              free (handle_name);
-            }
           else
             handle = fh_create_scratch (lex_tokid (lexer));
         }