home *** CD-ROM | disk | FTP | other *** search
/ Geek Gadgets 1 / ADE-1.bin / ade-dist / texinfo-3.7-src.tgz / tar.out / fsf / texinfo / info / tilde.c < prev    next >
C/C++ Source or Header  |  1996-09-28  |  9KB  |  379 lines
  1. /* tilde.c -- Tilde expansion code (~/foo := $HOME/foo). */
  2.  
  3. /* This file is part of GNU Info, a program for reading online documentation
  4.    stored in Info format.
  5.  
  6.    This file has appeared in prior works by the Free Software Foundation;
  7.    thus it carries copyright dates from 1988 through 1993.
  8.  
  9.    Copyright (C) 1988, 1989, 1990, 1991, 1992, 1993 Free Software
  10.    Foundation, Inc.
  11.  
  12.    This program is free software; you can redistribute it and/or modify
  13.    it under the terms of the GNU General Public License as published by
  14.    the Free Software Foundation; either version 2, or (at your option)
  15.    any later version.
  16.  
  17.    This program is distributed in the hope that it will be useful,
  18.    but WITHOUT ANY WARRANTY; without even the implied warranty of
  19.    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  20.    GNU General Public License for more details.
  21.  
  22.    You should have received a copy of the GNU General Public License
  23.    along with this program; if not, write to the Free Software
  24.    Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  25.  
  26.    Written by Brian Fox (bfox@ai.mit.edu). */
  27.  
  28. #if defined (__GNUC__)
  29. #  define alloca __builtin_alloca
  30. #else /* !__GNUC__ */
  31. #  if defined (_AIX)
  32.  #pragma alloca
  33. #  else /* !_AIX */
  34. #    if defined (HAVE_ALLOCA_H)
  35. #      include <alloca.h>
  36. #    endif /* HAVE_ALLOCA_H */
  37. #  endif /* !AIX */
  38. #endif /* !__GNUC__ */
  39.  
  40. #if defined (HAVE_STDLIB_H)
  41. #include <stdlib.h>
  42. #endif
  43.  
  44. #include "tilde.h"
  45. #include <pwd.h>
  46.  
  47. #if defined (HAVE_STRING_H)
  48. #include <string.h>
  49. #endif
  50.  
  51. #include "clib.h"
  52.  
  53. #if !defined (NULL)
  54. #  define NULL 0x0
  55. #endif
  56.  
  57. #if defined (TEST) || defined (STATIC_MALLOC)
  58. static void *xmalloc (), *xrealloc ();
  59. #else
  60. extern void *xmalloc (), *xrealloc ();
  61. #endif /* TEST || STATIC_MALLOC */
  62.  
  63. /* The default value of tilde_additional_prefixes.  This is set to
  64.    whitespace preceding a tilde so that simple programs which do not
  65.    perform any word separation get desired behaviour. */
  66. static char *default_prefixes[] =
  67.   { " ~", "\t~", (char *)NULL };
  68.  
  69. /* The default value of tilde_additional_suffixes.  This is set to
  70.    whitespace or newline so that simple programs which do not
  71.    perform any word separation get desired behaviour. */
  72. static char *default_suffixes[] =
  73.   { " ", "\n", (char *)NULL };
  74.  
  75. /* If non-null, this contains the address of a function to call if the
  76.    standard meaning for expanding a tilde fails.  The function is called
  77.    with the text (sans tilde, as in "foo"), and returns a malloc()'ed string
  78.    which is the expansion, or a NULL pointer if there is no expansion. */
  79. CFunction *tilde_expansion_failure_hook = (CFunction *)NULL;
  80.  
  81. /* When non-null, this is a NULL terminated array of strings which
  82.    are duplicates for a tilde prefix.  Bash uses this to expand
  83.    `=~' and `:~'. */
  84. char **tilde_additional_prefixes = default_prefixes;
  85.  
  86. /* When non-null, this is a NULL terminated array of strings which match
  87.    the end of a username, instead of just "/".  Bash sets this to
  88.    `:' and `=~'. */
  89. char **tilde_additional_suffixes = default_suffixes;
  90.  
  91. /* Find the start of a tilde expansion in STRING, and return the index of
  92.    the tilde which starts the expansion.  Place the length of the text
  93.    which identified this tilde starter in LEN, excluding the tilde itself. */
  94. static int
  95. tilde_find_prefix (string, len)
  96.      char *string;
  97.      int *len;
  98. {
  99.   register int i, j, string_len;
  100.   register char **prefixes = tilde_additional_prefixes;
  101.  
  102.   string_len = strlen (string);
  103.   *len = 0;
  104.  
  105.   if (!*string || *string == '~')
  106.     return (0);
  107.  
  108.   if (prefixes)
  109.     {
  110.       for (i = 0; i < string_len; i++)
  111.     {
  112.       for (j = 0; prefixes[j]; j++)
  113.         {
  114.           if (strncmp (string + i, prefixes[j], strlen (prefixes[j])) == 0)
  115.         {
  116.           *len = strlen (prefixes[j]) - 1;
  117.           return (i + *len);
  118.         }
  119.         }
  120.     }
  121.     }
  122.   return (string_len);
  123. }
  124.  
  125. /* Find the end of a tilde expansion in STRING, and return the index of
  126.    the character which ends the tilde definition.  */
  127. static int
  128. tilde_find_suffix (string)
  129.      char *string;
  130. {
  131.   register int i, j, string_len;
  132.   register char **suffixes = tilde_additional_suffixes;
  133.  
  134.   string_len = strlen (string);
  135.  
  136.   for (i = 0; i < string_len; i++)
  137.     {
  138.       if (string[i] == '/' || !string[i])
  139.     break;
  140.  
  141.       for (j = 0; suffixes && suffixes[j]; j++)
  142.     {
  143.       if (strncmp (string + i, suffixes[j], strlen (suffixes[j])) == 0)
  144.         return (i);
  145.     }
  146.     }
  147.   return (i);
  148. }
  149.  
  150. /* Return a new string which is the result of tilde expanding STRING. */
  151. char *
  152. tilde_expand (string)
  153.      char *string;
  154. {
  155.   char *result, *tilde_expand_word ();
  156.   int result_size, result_index;
  157.  
  158.   result_size = result_index = 0;
  159.   result = (char *)NULL;
  160.  
  161.   /* Scan through STRING expanding tildes as we come to them. */
  162.   while (1)
  163.     {
  164.       register int start, end;
  165.       char *tilde_word, *expansion;
  166.       int len;
  167.  
  168.       /* Make START point to the tilde which starts the expansion. */
  169.       start = tilde_find_prefix (string, &len);
  170.  
  171.       /* Copy the skipped text into the result. */
  172.       if ((result_index + start + 1) > result_size)
  173.     result = (char *)xrealloc (result, 1 + (result_size += (start + 20)));
  174.  
  175.       strncpy (result + result_index, string, start);
  176.       result_index += start;
  177.  
  178.       /* Advance STRING to the starting tilde. */
  179.       string += start;
  180.  
  181.       /* Make END be the index of one after the last character of the
  182.      username. */
  183.       end = tilde_find_suffix (string);
  184.  
  185.       /* If both START and END are zero, we are all done. */
  186.       if (!start && !end)
  187.     break;
  188.  
  189.       /* Expand the entire tilde word, and copy it into RESULT. */
  190.       tilde_word = (char *)xmalloc (1 + end);
  191.       strncpy (tilde_word, string, end);
  192.       tilde_word[end] = '\0';
  193.       string += end;
  194.  
  195.       expansion = tilde_expand_word (tilde_word);
  196.       free (tilde_word);
  197.  
  198.       len = strlen (expansion);
  199.       if ((result_index + len + 1) > result_size)
  200.     result = (char *)xrealloc (result, 1 + (result_size += (len + 20)));
  201.  
  202.       strcpy (result + result_index, expansion);
  203.       result_index += len;
  204.       free (expansion);
  205.     }
  206.  
  207.   result[result_index] = '\0';
  208.  
  209.   return (result);
  210. }
  211.  
  212. /* Do the work of tilde expansion on FILENAME.  FILENAME starts with a
  213.    tilde.  If there is no expansion, call tilde_expansion_failure_hook. */
  214. char *
  215. tilde_expand_word (filename)
  216.      char *filename;
  217. {
  218.   char *dirname;
  219.  
  220.   dirname = filename ? strdup (filename) : (char *)NULL;
  221.  
  222.   if (dirname && *dirname == '~')
  223.     {
  224.       char *temp_name;
  225.       if (!dirname[1] || dirname[1] == '/')
  226.     {
  227.       /* Prepend $HOME to the rest of the string. */
  228.       char *temp_home = (char *)getenv ("HOME");
  229.  
  230.       /* If there is no HOME variable, look up the directory in
  231.          the password database. */
  232.       if (!temp_home)
  233.         {
  234.           struct passwd *entry;
  235.  
  236.           entry = (struct passwd *) getpwuid (getuid ());
  237.           if (entry)
  238.         temp_home = entry->pw_dir;
  239.         }
  240.  
  241.       temp_name = (char *)
  242.         alloca (1 + strlen (&dirname[1])
  243.             + (temp_home ? strlen (temp_home) : 0));
  244.       temp_name[0] = '\0';
  245.       if (temp_home)
  246.         strcpy (temp_name, temp_home);
  247.       strcat (temp_name, &dirname[1]);
  248.       free (dirname);
  249.       dirname = strdup (temp_name);
  250.     }
  251.       else
  252.     {
  253.       struct passwd *user_entry;
  254.       char *username = (char *)alloca (257);
  255.       int i, c;
  256.  
  257.       for (i = 1; c = dirname[i]; i++)
  258.         {
  259.           if (c == '/')
  260.         break;
  261.           else
  262.         username[i - 1] = c;
  263.         }
  264.       username[i - 1] = '\0';
  265.  
  266.       if (!(user_entry = (struct passwd *) getpwnam (username)))
  267.         {
  268.           /* If the calling program has a special syntax for
  269.          expanding tildes, and we couldn't find a standard
  270.          expansion, then let them try. */
  271.           if (tilde_expansion_failure_hook)
  272.         {
  273.           char *expansion;
  274.  
  275.           expansion = (*tilde_expansion_failure_hook) (username);
  276.  
  277.           if (expansion)
  278.             {
  279.               temp_name = (char *)alloca
  280.             (1 + strlen (expansion) + strlen (&dirname[i]));
  281.               strcpy (temp_name, expansion);
  282.               strcat (temp_name, &dirname[i]);
  283.               free (expansion);
  284.               goto return_name;
  285.             }
  286.         }
  287.           /* We shouldn't report errors. */
  288.         }
  289.       else
  290.         {
  291.           temp_name = (char *)alloca
  292.         (1 + strlen (user_entry->pw_dir) + strlen (&dirname[i]));
  293.           strcpy (temp_name, user_entry->pw_dir);
  294.           strcat (temp_name, &dirname[i]);
  295.         return_name:
  296.           free (dirname);
  297.           dirname = strdup (temp_name);
  298.         }
  299.         endpwent ();
  300.     }
  301.     }
  302.   return (dirname);
  303. }
  304.  
  305.  
  306. #if defined (TEST)
  307. #undef NULL
  308. #include <stdio.h>
  309.  
  310. main (argc, argv)
  311.      int argc;
  312.      char **argv;
  313. {
  314.   char *result, line[512];
  315.   int done = 0;
  316.  
  317.   while (!done)
  318.     {
  319.       printf ("~expand: ");
  320.       fflush (stdout);
  321.  
  322.       if (!gets (line))
  323.     strcpy (line, "done");
  324.  
  325.       if ((strcmp (line, "done") == 0) ||
  326.       (strcmp (line, "quit") == 0) ||
  327.       (strcmp (line, "exit") == 0))
  328.     {
  329.       done = 1;
  330.       break;
  331.     }
  332.  
  333.       result = tilde_expand (line);
  334.       printf ("  --> %s\n", result);
  335.       free (result);
  336.     }
  337.   exit (0);
  338. }
  339.  
  340. static void memory_error_and_abort ();
  341.  
  342. static void *
  343. xmalloc (bytes)
  344.      int bytes;
  345. {
  346.   void *temp = (void *)malloc (bytes);
  347.  
  348.   if (!temp)
  349.     memory_error_and_abort ();
  350.   return (temp);
  351. }
  352.  
  353. static void *
  354. xrealloc (pointer, bytes)
  355.      void *pointer;
  356.      int bytes;
  357. {
  358.   void *temp;
  359.  
  360.   if (!pointer)
  361.     temp = (char *)malloc (bytes);
  362.   else
  363.     temp = (char *)realloc (pointer, bytes);
  364.  
  365.   if (!temp)
  366.     memory_error_and_abort ();
  367.  
  368.   return (temp);
  369. }
  370.  
  371. static void
  372. memory_error_and_abort ()
  373. {
  374.   fprintf (stderr, "readline: Out of virtual memory!\n");
  375.   abort ();
  376. }
  377. #endif /* TEST */
  378.  
  379.