2011-01-11 Michael Snyder <msnyder@vmware.com>
[deliverable/binutils-gdb.git] / gdb / source.c
index 8449878790841835dc38289deba52102d900dd2c..a14a8028903a0a7501723d7916a8871525ab299d 100644 (file)
 #define OPEN_MODE (O_RDONLY | O_BINARY)
 #define FDOPEN_MODE FOPEN_RB
 
-/* Prototypes for exported functions. */
+/* Prototypes for exported functions.  */
 
 void _initialize_source (void);
 
-/* Prototypes for local functions. */
+/* Prototypes for local functions.  */
 
 static int get_filename_and_charpos (struct symtab *, char **);
 
@@ -121,14 +121,14 @@ static int last_line_listed;
 static int first_line_listed;
 
 /* Saves the name of the last source file visited and a possible error code.
-   Used to prevent repeating annoying "No such file or directories" msgs */
+   Used to prevent repeating annoying "No such file or directories" msgs */
 
 static struct symtab *last_source_visited = NULL;
 static int last_source_error = 0;
 \f
 /* Return the first line listed by print_source_lines.
    Used by command interpreters to request listing from
-   a previous point. */
+   a previous point.  */
 
 int
 get_first_line_listed (void)
@@ -139,7 +139,7 @@ get_first_line_listed (void)
 /* Return the default number of lines to print with commands like the
    cli "list".  The caller of print_source_lines must use this to
    calculate the end line and use it in the call to print_source_lines
-   as it does not automatically use this value. */
+   as it does not automatically use this value.  */
 
 int
 get_lines_to_list (void)
@@ -148,7 +148,7 @@ get_lines_to_list (void)
 }
 
 /* Return the current source file for listing and next line to list.
-   NOTE: The returned sal pc and end fields are not valid. */
+   NOTE: The returned sal pc and end fields are not valid.  */
    
 struct symtab_and_line
 get_current_source_symtab_and_line (void)
@@ -170,7 +170,7 @@ get_current_source_symtab_and_line (void)
    We must be cautious about where it is called, as it can recurse as the
    process of determining a new default may call the caller!
    Use get_current_source_symtab_and_line only to get whatever
-   we have without erroring out or trying to get a default. */
+   we have without erroring out or trying to get a default.  */
    
 void
 set_default_source_symtab_and_line (void)
@@ -178,7 +178,7 @@ set_default_source_symtab_and_line (void)
   if (!have_full_symbols () && !have_partial_symbols ())
     error (_("No symbol table is loaded.  Use the \"file\" command."));
 
-  /* Pull in a current source symtab if necessary */
+  /* Pull in a current source symtab if necessary */
   if (current_source_symtab == 0)
     select_source_symtab (0);
 }
@@ -186,7 +186,7 @@ set_default_source_symtab_and_line (void)
 /* Return the current default file for listing and next line to list
    (the returned sal pc and end fields are not valid.)
    and set the current default to whatever is in SAL.
-   NOTE: The returned sal pc and end fields are not valid. */
+   NOTE: The returned sal pc and end fields are not valid.  */
    
 struct symtab_and_line
 set_current_source_symtab_and_line (const struct symtab_and_line *sal)
@@ -206,7 +206,7 @@ set_current_source_symtab_and_line (const struct symtab_and_line *sal)
   return cursal;
 }
 
-/* Reset any information stored about a default file and line to print. */
+/* Reset any information stored about a default file and line to print.  */
 
 void
 clear_current_source_symtab_and_line (void)
@@ -386,7 +386,7 @@ void
 directory_command (char *dirname, int from_tty)
 {
   dont_repeat ();
-  /* FIXME, this goes to "delete dir"... */
+  /* FIXME, this goes to "delete dir"...  */
   if (dirname == 0)
     {
       if (!from_tty || query (_("Reinitialize source path to empty? ")))
@@ -425,7 +425,7 @@ mod_path (char *dirname, char **which_path)
    if dirname should be parsed for separators that indicate multiple
    directories.  This allows for interfaces that pre-parse the dirname
    and allow specification of traditional separator characters such
-   as space or tab. */
+   as space or tab.  */
 
 void
 add_path (char *dirname, char **which_path, int parse_separators)
@@ -442,7 +442,7 @@ add_path (char *dirname, char **which_path, int parse_separators)
   if (parse_separators)
     {
       /* This will properly parse the space and tab separators
-        and any quotes that may exist. DIRNAME_SEPARATOR will
+        and any quotes that may exist.  DIRNAME_SEPARATOR will
         be dealt with later.  */
       argv = gdb_buildargv (dirname);
       make_cleanup_freeargv (argv);
@@ -495,7 +495,7 @@ add_path (char *dirname, char **which_path, int parse_separators)
             && !(p == name + 3 && name[1] == ':')              /* "d:/" */
 #endif
             && IS_DIR_SEPARATOR (p[-1]))
-       /* Sigh. "foo/" => "foo" */
+       /* Sigh.  "foo/" => "foo" */
        --p;
       *p = '\0';
 
@@ -580,11 +580,11 @@ add_path (char *dirname, char **which_path, int parse_separators)
            if (!strncmp (p, name, len)
                && (p[len] == '\0' || p[len] == DIRNAME_SEPARATOR))
              {
-               /* Found it in the search path, remove old copy */
+               /* Found it in the search path, remove old copy */
                if (p > *which_path)
-                 p--;          /* Back over leading separator */
+                 p--;          /* Back over leading separator */
                if (prefix > p - *which_path)
-                 goto skip_dup;        /* Same dir twice in one cmd */
+                 goto skip_dup;        /* Same dir twice in one cmd */
                strcpy (p, &p[len + 1]);        /* Copy from next \0 or  : */
              }
            p = strchr (p, DIRNAME_SEPARATOR);
@@ -657,7 +657,7 @@ source_info (char *ignore, int from_tty)
 }
 \f
 
-/* Return True if the file NAME exists and is a regular file */
+/* Return True if the file NAME exists and is a regular file */
 static int
 is_regular_file (const char *name)
 {
@@ -667,8 +667,8 @@ is_regular_file (const char *name)
   /* Stat should never fail except when the file does not exist.
      If stat fails, analyze the source of error and return True
      unless the file does not exist, to avoid returning false results
-     on obscure systems where stat does not work as expected.
-   */
+     on obscure systems where stat does not work as expected.  */
+
   if (status != 0)
     return (errno != ENOENT);
 
@@ -701,7 +701,7 @@ is_regular_file (const char *name)
    Otherwise, return -1, with errno set for the last name we tried to open.  */
 
 /*  >>>> This should only allow files of certain types,
-    >>>>  eg executable, non-directory */
+    >>>>  eg executable, non-directory */
 int
 openp (const char *path, int opts, const char *string,
        int mode, char **filename_opened)
@@ -763,7 +763,7 @@ openp (const char *path, int opts, const char *string,
   if (HAS_DRIVE_SPEC (string))
     string = STRIP_DRIVE_SPEC (string);
 
-  /* /foo => foo, to avoid multiple slashes that Emacs doesn't like. */
+  /* /foo => foo, to avoid multiple slashes that Emacs doesn't like.  */
   while (IS_DIR_SEPARATOR(string[0]))
     string++;
 
@@ -788,7 +788,7 @@ openp (const char *path, int opts, const char *string,
          /* Name is $cwd -- insert current directory name instead.  */
          int newlen;
 
-         /* First, realloc the filename buffer if too short. */
+         /* First, realloc the filename buffer if too short.  */
          len = strlen (current_directory);
          newlen = len + strlen (string) + 2;
          if (newlen > alloclen)
@@ -815,7 +815,7 @@ openp (const char *path, int opts, const char *string,
            continue;
        }
 
-      /* Remove trailing slashes */
+      /* Remove trailing slashes */
       while (len > 0 && IS_DIR_SEPARATOR (filename[len - 1]))
        filename[--len] = 0;
 
@@ -833,9 +833,9 @@ openp (const char *path, int opts, const char *string,
 done:
   if (filename_opened)
     {
-      /* If a file was opened, canonicalize its filename. Use xfullpath
+      /* If a file was opened, canonicalize its filename.  Use xfullpath
          rather than gdb_realpath to avoid resolving the basename part
-         of filenames when the associated file is a symbolic link. This
+         of filenames when the associated file is a symbolic link.  This
          fixes a potential inconsistency between the filenames known to
          GDB and the filenames it prints in the annotations.  */
       if (fd < 0)
@@ -844,7 +844,7 @@ done:
        *filename_opened = xfullpath (filename);
       else
        {
-         /* Beware the // my son, the Emacs barfs, the botch that catch... */
+         /* Beware the // my son, the Emacs barfs, the botch that catch...  */
 
          char *f = concat (current_directory,
                            IS_DIR_SEPARATOR (current_directory[strlen (current_directory) - 1])
@@ -940,7 +940,7 @@ get_substitute_path_rule (const char *path)
 
 /* If the user specified a source path substitution rule that applies
    to PATH, then apply it and return the new path.  This new path must
-   be deallocated afterwards.  
+   be deallocated afterwards.
    
    Return NULL if no substitution rule was specified by the user,
    or if no rule applied to the given PATH.  */
@@ -968,8 +968,8 @@ rewrite_source_path (const char *path)
 }
 
 /* This function is capable of finding the absolute path to a
-   source file, and opening it, provided you give it a FILENAME. Both the
-   DIRNAME and FULLNAME are only added suggestions on where to find the file. 
+   source file, and opening it, provided you give it a FILENAME.  Both the
+   DIRNAME and FULLNAME are only added suggestions on where to find the file.
 
    FILENAME should be the filename to open.
    DIRNAME is the compilation directory of a particular source file.
@@ -979,12 +979,12 @@ rewrite_source_path (const char *path)
      is applied we free the old value and set a new one.
 
    On Success 
-     A valid file descriptor is returned. ( the return value is positive )
+     A valid file descriptor is returned (the return value is positive).
      FULLNAME is set to the absolute path to the file just opened.
      The caller is responsible for freeing FULLNAME.
 
    On Failure
-     An invalid file descriptor is returned. ( the return value is negative ) 
+     An invalid file descriptor is returned (the return value is negative).
      FULLNAME is set to NULL.  */
 
 int
@@ -996,7 +996,7 @@ find_and_open_source (const char *filename,
   const char *p;
   int result;
 
-  /* Quick way out if we already know its full name */
+  /* Quick way out if we already know its full name */
 
   if (*fullname)
     {
@@ -1014,7 +1014,7 @@ find_and_open_source (const char *filename,
       result = open (*fullname, OPEN_MODE);
       if (result >= 0)
        return result;
-      /* Didn't work -- free old one, try again. */
+      /* Didn't work -- free old one, try again.  */
       xfree (*fullname);
       *fullname = NULL;
     }
@@ -1032,10 +1032,11 @@ find_and_open_source (const char *filename,
           dirname = rewritten_dirname;
         }
       
-      /* Replace a path entry of  $cdir  with the compilation directory name */
+      /* Replace a path entry of $cdir with the compilation directory
+        name.  */
 #define        cdir_len        5
       /* We cast strstr's result in case an ANSIhole has made it const,
-         which produces a "required warning" when assigned to a nonconst. */
+         which produces a "required warning" when assigned to a nonconst.  */
       p = (char *) strstr (source_path, "$cdir");
       if (p && (p == path || p[-1] == DIRNAME_SEPARATOR)
          && (p[cdir_len] == DIRNAME_SEPARATOR || p[cdir_len] == '\0'))
@@ -1068,7 +1069,7 @@ find_and_open_source (const char *filename,
   result = openp (path, OPF_SEARCH_IN_PATH, filename, OPEN_MODE, fullname);
   if (result < 0)
     {
-      /* Didn't work.  Try using just the basename. */
+      /* Didn't work.  Try using just the basename.  */
       p = lbasename (filename);
       if (p != filename)
        result = openp (path, OPF_SEARCH_IN_PATH, p, OPEN_MODE, fullname);
@@ -1080,7 +1081,7 @@ find_and_open_source (const char *filename,
 /* Open a source file given a symtab S.  Returns a file descriptor or
    negative number for error.  
    
-   This function is a convience function to find_and_open_source. */
+   This function is a convience function to find_and_open_source.  */
 
 int
 open_source_file (struct symtab *s)
@@ -1107,7 +1108,7 @@ symtab_to_fullname (struct symtab *s)
     return NULL;
 
   /* Don't check s->fullname here, the file could have been 
-     deleted/moved/..., look for it again */
+     deleted/moved/..., look for it again */
   r = find_and_open_source (s->filename, s->dirname, &s->fullname);
 
   if (r >= 0)
@@ -1152,7 +1153,7 @@ find_source_lines (struct symtab *s, int desc)
   {
     char c;
 
-    /* Have to read it byte by byte to find out where the chars live */
+    /* Have to read it byte by byte to find out where the chars live */
 
     line_charpos[0] = lseek (desc, 0, SEEK_CUR);
     nlines = 1;
@@ -1245,7 +1246,7 @@ source_charpos_line (struct symtab *s, int chr)
   if (s == 0 || s->line_charpos == 0)
     return 0;
   lnp = s->line_charpos;
-  /* Files are usually short, so sequential search is Ok */
+  /* Files are usually short, so sequential search is Ok */
   while (line < s->nlines && *lnp <= chr)
     {
       line++;
@@ -1320,7 +1321,7 @@ identify_source_line (struct symtab *s, int line, int mid_statement,
 \f
 
 /* Print source lines from the file of symtab S,
-   starting with line number LINE and stopping before line number STOPLINE. */
+   starting with line number LINE and stopping before line number STOPLINE.  */
 
 static void print_source_lines_base (struct symtab *s, int line, int stopline,
                                     int noerror);
@@ -1334,16 +1335,16 @@ print_source_lines_base (struct symtab *s, int line, int stopline, int noerror)
   int nlines = stopline - line;
   struct cleanup *cleanup;
 
-  /* Regardless of whether we can open the file, set current_source_symtab. */
+  /* Regardless of whether we can open the file, set current_source_symtab.  */
   current_source_symtab = s;
   current_source_line = line;
   first_line_listed = line;
 
   /* If printing of source lines is disabled, just print file and line
-     number */
+     number */
   if (ui_out_test_flags (uiout, ui_source_list))
     {
-      /* Only prints "No such file or directory" once */
+      /* Only prints "No such file or directory" once */
       if ((s != last_source_visited) || (!last_source_error))
        {
          last_source_visited = s;
@@ -1447,7 +1448,7 @@ print_source_lines_base (struct symtab *s, int line, int stopline, int noerror)
 /* Show source lines from the file of symtab S, starting with line
    number LINE and stopping before line number STOPLINE.  If this is
    not the command line version, then the source is shown in the source
-   window otherwise it is simply printed */
+   window otherwise it is simply printed */
 
 void
 print_source_lines (struct symtab *s, int line, int stopline, int noerror)
@@ -1484,7 +1485,7 @@ line_info (char *arg, int from_tty)
     }
 
   /* C++  More than one line may have been specified, as when the user
-     specifies an overloaded function name. Print info on them all. */
+     specifies an overloaded function name.  Print info on them all.  */
   for (i = 0; i < sals.nelts; i++)
     {
       sal = sals.sals[i];
@@ -1629,11 +1630,11 @@ forward_search_command (char *regex, int from_tty)
          p[-1] = '\n';
        }
 
-      /* we now have a source line in buf, null terminate and match */
+      /* We now have a source line in buf, null terminate and match.  */
       *p = 0;
       if (re_exec (buf) > 0)
        {
-         /* Match! */
+         /* Match!  */
          do_cleanups (cleanups);
          print_source_lines (current_source_symtab, line, line + 1, 0);
          set_internalvar_integer (lookup_internalvar ("_"), line);
@@ -1686,8 +1687,8 @@ reverse_search_command (char *regex, int from_tty)
   cleanups = make_cleanup_fclose (stream);
   while (line > 1)
     {
-/* FIXME!!!  We walk right off the end of buf if we get a long line!!! */
-      char buf[4096];          /* Should be reasonable??? */
+/* FIXME!!!  We walk right off the end of buf if we get a long line!!!  */
+      char buf[4096];          /* Should be reasonable???  */
       char *p = buf;
 
       c = getc (stream);
@@ -1711,7 +1712,7 @@ reverse_search_command (char *regex, int from_tty)
       *p = 0;
       if (re_exec (buf) > 0)
        {
-         /* Match! */
+         /* Match!  */
          do_cleanups (cleanups);
          print_source_lines (current_source_symtab, line, line + 1, 0);
          set_internalvar_integer (lookup_internalvar ("_"), line);
This page took 0.050156 seconds and 4 git commands to generate.