pathexp.h

   1 /* pathexp.h -- The shell interface to the globbing library. */
   2
   3 /* Copyright (C) 1987-2005 Free Software Foundation, Inc.
   4
   5    This file is part of GNU Bash, the Bourne Again SHell.
   6
   7    Bash is free software; you can redistribute it and/or modify it under
   8    the terms of the GNU General Public License as published by the Free
   9    Software Foundation; either version 2, or (at your option) any later
  10    version.
  11
  12    Bash is distributed in the hope that it will be useful, but WITHOUT ANY
  13    WARRANTY; without even the implied warranty of MERCHANTABILITY or
  14    FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  15    for more details.
  16
  17    You should have received a copy of the GNU General Public License along
  18    with Bash; see the file COPYING.  If not, write to the Free Software
  19    Foundation, 59 Temple Place, Suite 330, Boston, MA 02111 USA. */
  20
  21 #if !defined (_PATHEXP_H_)
  22 #define _PATHEXP_H_
  23
  24 #if defined (USE_POSIX_GLOB_LIBRARY)
  25 #  define GLOB_FAILED(glist)    !(glist)
  26 #else /* !USE_POSIX_GLOB_LIBRARY */
  27 #  define GLOB_FAILED(glist)    (glist) == (char **)&glob_error_return
  28 extern int noglob_dot_filenames;
  29 extern char *glob_error_return;
  30 #endif /* !USE_POSIX_GLOB_LIBRARY */
  31
  32 /* Flag values for quote_string_for_globbing */
  33 #define QGLOB_CVTNULL   0x01    /* convert QUOTED_NULL strings to '\0' */
  34 #define QGLOB_FILENAME  0x02    /* do correct quoting for matching filenames */
  35
  36 #if defined (EXTENDED_GLOB)
  37 /* Flags to OR with other flag args to strmatch() to enabled the extended
  38    pattern matching. */
  39 #  define FNMATCH_EXTFLAG       (extended_glob ? FNM_EXTMATCH : 0)
  40 #else
  41 #  define FNMATCH_EXTFLAG       0
  42 #endif /* !EXTENDED_GLOB */
  43
  44 #define FNMATCH_IGNCASE         (match_ignore_case ? FNM_CASEFOLD : 0)
  45
  46 extern int glob_dot_filenames;
  47 extern int extended_glob;
  48 extern int match_ignore_case;   /* doesn't really belong here */
  49
  50 extern int unquoted_glob_pattern_p __P((char *));
  51
  52 /* PATHNAME can contain characters prefixed by CTLESC; this indicates
  53    that the character is to be quoted.  We quote it here in the style
  54    that the glob library recognizes.  If flags includes QGLOB_CVTNULL,
  55    we change quoted null strings (pathname[0] == CTLNUL) into empty
  56    strings (pathname[0] == 0).  If this is called after quote removal
  57    is performed, (flags & QGLOB_CVTNULL) should be 0; if called when quote
  58    removal has not been done (for example, before attempting to match a
  59    pattern while executing a case statement), flags should include
  60    QGLOB_CVTNULL.  If flags includes QGLOB_FILENAME, appropriate quoting
  61    to match a filename should be performed. */
  62 extern char *quote_string_for_globbing __P((const char *, int));
  63
  64 extern char *quote_globbing_chars __P((char *));
  65
  66 /* Call the glob library to do globbing on PATHNAME. */
  67 extern char **shell_glob_filename __P((const char *));
  68
  69 /* Filename completion ignore.  Used to implement the "fignore" facility of
  70    tcsh and GLOBIGNORE (like ksh-93 FIGNORE).
  71
  72    It is passed a NULL-terminated array of (char *)'s that must be
  73    free()'d if they are deleted.  The first element (names[0]) is the
  74    least-common-denominator string of the matching patterns (i.e.
  75    u<TAB> produces names[0] = "und", names[1] = "under.c", names[2] =
  76    "undun.c", name[3] = NULL).  */
  77
  78 struct ign {
  79   char *val;
  80   int len, flags;
  81 };
  82
  83 typedef int sh_iv_item_func_t __P((struct ign *));
  84
  85 struct ignorevar {
  86   char *varname;        /* FIGNORE or GLOBIGNORE */
  87   struct ign *ignores;  /* Store the ignore strings here */
  88   int num_ignores;      /* How many are there? */
  89   char *last_ignoreval; /* Last value of variable - cached for speed */
  90   sh_iv_item_func_t *item_func; /* Called when each item is parsed from $`varname' */
  91 };
  92
  93 extern void setup_ignore_patterns __P((struct ignorevar *));
  94
  95 extern void setup_glob_ignore __P((char *));
  96 extern int should_ignore_glob_matches __P((void));
  97 extern void ignore_glob_matches __P((char **));
  98
  99 #endif