Bash-5.2 patch 4: fix for nested brace expansions and brackets

[thirdparty/bash.git] / subst.c

/* subst.c -- The part of the shell that does parameter, command, arithmetic,
   and globbing substitutions. */

/* ``Have a little faith, there's magic in the night.  You ain't a
     beauty, but, hey, you're alright.'' */

/* Copyright (C) 1987-2022 Free Software Foundation, Inc.

   This file is part of GNU Bash, the Bourne Again SHell.

   Bash is free software: you can redistribute it and/or modify
   it under the terms of the GNU General Public License as published by
   the Free Software Foundation, either version 3 of the License, or
   (at your option) any later version.

   Bash is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   GNU General Public License for more details.

   You should have received a copy of the GNU General Public License
   along with Bash.  If not, see <http://www.gnu.org/licenses/>.
*/

#include "config.h"

#include "bashtypes.h"
#include <stdio.h>
#include "chartypes.h"
#if defined (HAVE_PWD_H)
#  include <pwd.h>
#endif
#include <signal.h>
#include <errno.h>

#if defined (HAVE_UNISTD_H)
#  include <unistd.h>
#endif

#define NEED_FPURGE_DECL

#include "bashansi.h"
#include "posixstat.h"
#include "bashintl.h"

#include "shell.h"
#include "parser.h"
#include "redir.h"
#include "flags.h"
#include "jobs.h"
#include "execute_cmd.h"
#include "filecntl.h"
#include "trap.h"
#include "pathexp.h"
#include "mailcheck.h"

#include "shmbutil.h"
#if defined (HAVE_MBSTR_H) && defined (HAVE_MBSCHR)
#  include <mbstr.h>            /* mbschr */
#endif
#include "typemax.h"

#include "builtins/getopt.h"
#include "builtins/common.h"

#include "builtins/builtext.h"

#include <tilde/tilde.h>
#include <glob/strmatch.h>

#if !defined (errno)
extern int errno;
#endif /* !errno */

/* The size that strings change by. */
#define DEFAULT_INITIAL_ARRAY_SIZE 112
#define DEFAULT_ARRAY_SIZE 128

/* Variable types. */
#define VT_VARIABLE     0
#define VT_POSPARMS     1
#define VT_ARRAYVAR     2
#define VT_ARRAYMEMBER  3
#define VT_ASSOCVAR     4

#define VT_STARSUB      128     /* $* or ${array[*]} -- used to split */

/* Flags for quoted_strchr */
#define ST_BACKSL       0x01
#define ST_CTLESC       0x02
#define ST_SQUOTE       0x04    /* unused yet */
#define ST_DQUOTE       0x08    /* unused yet */

/* These defs make it easier to use the editor. */
#define LBRACE          '{'
#define RBRACE          '}'
#define LPAREN          '('
#define RPAREN          ')'
#define LBRACK          '['
#define RBRACK          ']'

#if defined (HANDLE_MULTIBYTE)
#define WLPAREN         L'('
#define WRPAREN         L')'
#endif

#define DOLLAR_AT_STAR(c)       ((c) == '@' || (c) == '*')
#define STR_DOLLAR_AT_STAR(s)   (DOLLAR_AT_STAR ((s)[0]) && (s)[1] == '\0')

/* Evaluates to 1 if C is one of the shell's special parameters whose length
   can be taken, but is also one of the special expansion characters. */
#define VALID_SPECIAL_LENGTH_PARAM(c) \
  ((c) == '-' || (c) == '?' || (c) == '#' || (c) == '@')

/* Evaluates to 1 if C is one of the shell's special parameters for which an
   indirect variable reference may be made. */
#define VALID_INDIR_PARAM(c) \
  ((posixly_correct == 0 && (c) == '#') || (posixly_correct == 0 && (c) == '?') || (c) == '@' || (c) == '*')

/* Evaluates to 1 if C is one of the OP characters that follows the parameter
   in ${parameter[:]OPword}. */
#define VALID_PARAM_EXPAND_CHAR(c) (sh_syntaxtab[(unsigned char)c] & CSUBSTOP)

/* Evaluates to 1 if this is one of the shell's special variables. */
#define SPECIAL_VAR(name, wi) \
 (*name && ((DIGIT (*name) && all_digits (name)) || \
      (name[1] == '\0' && (sh_syntaxtab[(unsigned char)*name] & CSPECVAR)) || \
      (wi && name[2] == '\0' && VALID_INDIR_PARAM (name[1]))))

/* This can be used by all of the *_extract_* functions that have a similar
   structure.  It can't just be wrapped in a do...while(0) loop because of
   the embedded `break'. The dangling else accommodates a trailing semicolon;
   we could also put in a do ; while (0) */

#define CHECK_STRING_OVERRUN(oind, ind, len, ch) \
  if (ind >= len) \
    { \
      oind = len; \
      ch = 0; \
      break; \
    } \
  else \

/* An expansion function that takes a string and a quoted flag and returns
   a WORD_LIST *.  Used as the type of the third argument to
   expand_string_if_necessary(). */
typedef WORD_LIST *EXPFUNC PARAMS((char *, int));

/* Process ID of the last command executed within command substitution. */
pid_t last_command_subst_pid = NO_PID;
pid_t current_command_subst_pid = NO_PID;

/* Variables used to keep track of the characters in IFS. */
SHELL_VAR *ifs_var;
char *ifs_value;
unsigned char ifs_cmap[UCHAR_MAX + 1];
int ifs_is_set, ifs_is_null;

#if defined (HANDLE_MULTIBYTE)
unsigned char ifs_firstc[MB_LEN_MAX];
size_t ifs_firstc_len;
#else
unsigned char ifs_firstc;
#endif

/* If non-zero, command substitution inherits the value of errexit option */
int inherit_errexit = 0;

/* Sentinel to tell when we are performing variable assignments preceding a
   command name and putting them into the environment.  Used to make sure
   we use the temporary environment when looking up variable values. */
int assigning_in_environment;

/* Used to hold a list of variable assignments preceding a command.  Global
   so the SIGCHLD handler in jobs.c can unwind-protect it when it runs a
   SIGCHLD trap and so it can be saved and restored by the trap handlers. */
WORD_LIST *subst_assign_varlist = (WORD_LIST *)NULL;

/* Tell the expansion functions to not longjmp back to top_level on fatal
   errors.  Enabled when doing completion and prompt string expansion. */
int no_longjmp_on_fatal_error = 0;

/* Non-zero means to allow unmatched globbed filenames to expand to
   a null file. */
int allow_null_glob_expansion;

/* Non-zero means to throw an error when globbing fails to match anything. */
int fail_glob_expansion;

/* If non-zero, perform `&' substitution on the replacement string in the
   pattern substitution word expansion. */
int patsub_replacement = 1;

/* Extern functions and variables from different files. */
extern struct fd_bitmap *current_fds_to_close;
extern int wordexp_only;
extern int singlequote_translations;
extern int extended_quote;

#if defined (JOB_CONTROL) && defined (PROCESS_SUBSTITUTION)
extern PROCESS *last_procsub_child;
#endif

#if !defined (HAVE_WCSDUP) && defined (HANDLE_MULTIBYTE)
extern wchar_t *wcsdup PARAMS((const wchar_t *));
#endif

#if 0
/* Variables to keep track of which words in an expanded word list (the
   output of expand_word_list_internal) are the result of globbing
   expansions.  GLOB_ARGV_FLAGS is used by execute_cmd.c.
   (CURRENTLY UNUSED). */
char *glob_argv_flags;
static int glob_argv_flags_size;
#endif

static WORD_LIST *cached_quoted_dollar_at = 0;

/* Distinguished error values to return from expansion functions */
static WORD_LIST expand_word_error, expand_word_fatal;
static WORD_DESC expand_wdesc_error, expand_wdesc_fatal;
static char expand_param_error, expand_param_fatal, expand_param_unset;
static char extract_string_error, extract_string_fatal;

/* Set by expand_word_unsplit and several of the expand_string_XXX functions;
   used to inhibit splitting and re-joining $* on $IFS, primarily when doing
   assignment statements.  The idea is that if we're in a context where this
   is set, we're not going to be performing word splitting, so we use the same
   rules to expand $* as we would if it appeared within double quotes. */
static int expand_no_split_dollar_star = 0;

/* A WORD_LIST of words to be expanded by expand_word_list_internal,
   without any leading variable assignments. */
static WORD_LIST *garglist = (WORD_LIST *)NULL;

static char *quoted_substring PARAMS((char *, int, int));
static int quoted_strlen PARAMS((char *));
static char *quoted_strchr PARAMS((char *, int, int));

static char *expand_string_if_necessary PARAMS((char *, int, EXPFUNC *));
static inline char *expand_string_to_string_internal PARAMS((char *, int, EXPFUNC *));
static WORD_LIST *call_expand_word_internal PARAMS((WORD_DESC *, int, int, int *, int *));
static WORD_LIST *expand_string_internal PARAMS((char *, int));
static WORD_LIST *expand_string_leave_quoted PARAMS((char *, int));
static WORD_LIST *expand_string_for_rhs PARAMS((char *, int, int, int, int *, int *));
static WORD_LIST *expand_string_for_pat PARAMS((char *, int, int *, int *));

static char *quote_escapes_internal PARAMS((const char *, int));

static WORD_LIST *list_quote_escapes PARAMS((WORD_LIST *));
static WORD_LIST *list_dequote_escapes PARAMS((WORD_LIST *));

static char *make_quoted_char PARAMS((int));
static WORD_LIST *quote_list PARAMS((WORD_LIST *));

static int unquoted_substring PARAMS((char *, char *));
static int unquoted_member PARAMS((int, char *));

#if defined (ARRAY_VARS)
static SHELL_VAR *do_compound_assignment PARAMS((char *, char *, int));
#endif
static int do_assignment_internal PARAMS((const WORD_DESC *, int));

static char *string_extract_verbatim PARAMS((char *, size_t, int *, char *, int));
static char *string_extract PARAMS((char *, int *, char *, int));
static char *string_extract_double_quoted PARAMS((char *, int *, int));
static inline char *string_extract_single_quoted PARAMS((char *, int *, int));
static inline int skip_single_quoted PARAMS((const char *, size_t, int, int));
static int skip_double_quoted PARAMS((char *, size_t, int, int));
static char *extract_delimited_string PARAMS((char *, int *, char *, char *, char *, int));
static char *extract_heredoc_dolbrace_string PARAMS((char *, int *, int, int));
static char *extract_dollar_brace_string PARAMS((char *, int *, int, int));
static int skip_matched_pair PARAMS((const char *, int, int, int, int));

static char *pos_params PARAMS((char *, int, int, int, int));

static unsigned char *mb_getcharlens PARAMS((char *, int));

static char *remove_upattern PARAMS((char *, char *, int));
#if defined (HANDLE_MULTIBYTE) 
static wchar_t *remove_wpattern PARAMS((wchar_t *, size_t, wchar_t *, int));
#endif
static char *remove_pattern PARAMS((char *, char *, int));

static int match_upattern PARAMS((char *, char *, int, char **, char **));
#if defined (HANDLE_MULTIBYTE)
static int match_wpattern PARAMS((wchar_t *, char **, size_t, wchar_t *, int, char **, char **));
#endif
static int match_pattern PARAMS((char *, char *, int, char **, char **));
static int getpatspec PARAMS((int, char *));
static char *getpattern PARAMS((char *, int, int));
static char *variable_remove_pattern PARAMS((char *, char *, int, int));
static char *list_remove_pattern PARAMS((WORD_LIST *, char *, int, int, int));
static char *parameter_list_remove_pattern PARAMS((int, char *, int, int));
#ifdef ARRAY_VARS
static char *array_remove_pattern PARAMS((SHELL_VAR *, char *, int, int, int));
#endif
static char *parameter_brace_remove_pattern PARAMS((char *, char *, array_eltstate_t *, char *, int, int, int));

static char *string_var_assignment PARAMS((SHELL_VAR *, char *));
#if defined (ARRAY_VARS)
static char *array_var_assignment PARAMS((SHELL_VAR *, int, int, int));
#endif
static char *pos_params_assignment PARAMS((WORD_LIST *, int, int));
static char *string_transform PARAMS((int, SHELL_VAR *, char *));
static char *list_transform PARAMS((int, SHELL_VAR *, WORD_LIST *, int, int));
static char *parameter_list_transform PARAMS((int, int, int));
#if defined ARRAY_VARS
static char *array_transform PARAMS((int, SHELL_VAR *, int, int));
#endif
static char *parameter_brace_transform PARAMS((char *, char *, array_eltstate_t *, char *, int, int, int, int));
static int valid_parameter_transform PARAMS((char *));

static char *process_substitute PARAMS((char *, int));

static char *optimize_cat_file PARAMS((REDIRECT *, int, int, int *));
static char *read_comsub PARAMS((int, int, int, int *));

#ifdef ARRAY_VARS
static arrayind_t array_length_reference PARAMS((char *));
#endif

static int valid_brace_expansion_word PARAMS((char *, int));
static int chk_atstar PARAMS((char *, int, int, int *, int *));
static int chk_arithsub PARAMS((const char *, int));

static WORD_DESC *parameter_brace_expand_word PARAMS((char *, int, int, int, array_eltstate_t *));
static char *parameter_brace_find_indir PARAMS((char *, int, int, int));
static WORD_DESC *parameter_brace_expand_indir PARAMS((char *, int, int, int, int *, int *));
static WORD_DESC *parameter_brace_expand_rhs PARAMS((char *, char *, int, int, int, int *, int *));
static void parameter_brace_expand_error PARAMS((char *, char *, int));

static int valid_length_expression PARAMS((char *));
static intmax_t parameter_brace_expand_length PARAMS((char *));

static char *skiparith PARAMS((char *, int));
static int verify_substring_values PARAMS((SHELL_VAR *, char *, char *, int, intmax_t *, intmax_t *));
static int get_var_and_type PARAMS((char *, char *, array_eltstate_t *, int, int, SHELL_VAR **, char **));
static char *mb_substring PARAMS((char *, int, int));
static char *parameter_brace_substring PARAMS((char *, char *, array_eltstate_t *, char *, int, int, int));

static int shouldexp_replacement PARAMS((char *));

static char *pos_params_pat_subst PARAMS((char *, char *, char *, int));

static char *expand_string_for_patsub PARAMS((char *, int));
static char *parameter_brace_patsub PARAMS((char *, char *, array_eltstate_t *, char *, int, int, int));

static char *pos_params_casemod PARAMS((char *, char *, int, int));
static char *parameter_brace_casemod PARAMS((char *, char *, array_eltstate_t *, int, char *, int, int, int));

static WORD_DESC *parameter_brace_expand PARAMS((char *, int *, int, int, int *, int *));
static WORD_DESC *param_expand PARAMS((char *, int *, int, int *, int *, int *, int *, int));

static WORD_LIST *expand_word_internal PARAMS((WORD_DESC *, int, int, int *, int *));

static WORD_LIST *word_list_split PARAMS((WORD_LIST *));

static void exp_jump_to_top_level PARAMS((int));

static WORD_LIST *separate_out_assignments PARAMS((WORD_LIST *));
static WORD_LIST *glob_expand_word_list PARAMS((WORD_LIST *, int));
#ifdef BRACE_EXPANSION
static WORD_LIST *brace_expand_word_list PARAMS((WORD_LIST *, int));
#endif
#if defined (ARRAY_VARS)
static int make_internal_declare PARAMS((char *, char *, char *));
static void expand_compound_assignment_word PARAMS((WORD_LIST *, int));
static WORD_LIST *expand_declaration_argument PARAMS((WORD_LIST *, WORD_LIST *));
#endif
static WORD_LIST *shell_expand_word_list PARAMS((WORD_LIST *, int));
static WORD_LIST *expand_word_list_internal PARAMS((WORD_LIST *, int));

static int do_assignment_statements PARAMS((WORD_LIST *, char *, int));

/* **************************************************************** */
/*                                                                  */
/*                      Utility Functions                           */
/*                                                                  */
/* **************************************************************** */

#if defined (DEBUG)
void
dump_word_flags (flags)
     int flags;
{
  int f;

  f = flags;
  fprintf (stderr, "%d -> ", f);
  if (f & W_ARRAYIND)
    {
      f &= ~W_ARRAYIND;
      fprintf (stderr, "W_ARRAYIND%s", f ? "|" : "");
    }
  if (f & W_ASSIGNASSOC)
    {
      f &= ~W_ASSIGNASSOC;
      fprintf (stderr, "W_ASSIGNASSOC%s", f ? "|" : "");
    }
  if (f & W_ASSIGNARRAY)
    {
      f &= ~W_ASSIGNARRAY;
      fprintf (stderr, "W_ASSIGNARRAY%s", f ? "|" : "");
    }
  if (f & W_SAWQUOTEDNULL)
    {
      f &= ~W_SAWQUOTEDNULL;
      fprintf (stderr, "W_SAWQUOTEDNULL%s", f ? "|" : "");
    }
  if (f & W_NOPROCSUB)
    {
      f &= ~W_NOPROCSUB;
      fprintf (stderr, "W_NOPROCSUB%s", f ? "|" : "");
    }
  if (f & W_DQUOTE)
    {
      f &= ~W_DQUOTE;
      fprintf (stderr, "W_DQUOTE%s", f ? "|" : "");
    }
  if (f & W_HASQUOTEDNULL)
    {
      f &= ~W_HASQUOTEDNULL;
      fprintf (stderr, "W_HASQUOTEDNULL%s", f ? "|" : "");
    }
  if (f & W_ASSIGNARG)
    {
      f &= ~W_ASSIGNARG;
      fprintf (stderr, "W_ASSIGNARG%s", f ? "|" : "");
    }
  if (f & W_ASSNBLTIN)
    {
      f &= ~W_ASSNBLTIN;
      fprintf (stderr, "W_ASSNBLTIN%s", f ? "|" : "");
    }
  if (f & W_ASSNGLOBAL)
    {
      f &= ~W_ASSNGLOBAL;
      fprintf (stderr, "W_ASSNGLOBAL%s", f ? "|" : "");
    }
  if (f & W_COMPASSIGN)
    {
      f &= ~W_COMPASSIGN;
      fprintf (stderr, "W_COMPASSIGN%s", f ? "|" : "");
    }
  if (f & W_EXPANDRHS)
    {
      f &= ~W_EXPANDRHS;
      fprintf (stderr, "W_EXPANDRHS%s", f ? "|" : "");
    }
  if (f & W_NOTILDE)
    {
      f &= ~W_NOTILDE;
      fprintf (stderr, "W_NOTILDE%s", f ? "|" : "");
    }
  if (f & W_ASSIGNRHS)
    {
      f &= ~W_ASSIGNRHS;
      fprintf (stderr, "W_ASSIGNRHS%s", f ? "|" : "");
    }
  if (f & W_NOASSNTILDE)
    {
      f &= ~W_NOASSNTILDE;
      fprintf (stderr, "W_NOASSNTILDE%s", f ? "|" : "");
    }
  if (f & W_NOCOMSUB)
    {
      f &= ~W_NOCOMSUB;
      fprintf (stderr, "W_NOCOMSUB%s", f ? "|" : "");
    }
  if (f & W_ARRAYREF)
    {
      f &= ~W_ARRAYREF;
      fprintf (stderr, "W_ARRAYREF%s", f ? "|" : "");
    }
  if (f & W_DOLLARAT)
    {
      f &= ~W_DOLLARAT;
      fprintf (stderr, "W_DOLLARAT%s", f ? "|" : "");
    }
  if (f & W_TILDEEXP)
    {
      f &= ~W_TILDEEXP;
      fprintf (stderr, "W_TILDEEXP%s", f ? "|" : "");
    }
  if (f & W_NOSPLIT2)
    {
      f &= ~W_NOSPLIT2;
      fprintf (stderr, "W_NOSPLIT2%s", f ? "|" : "");
    }
  if (f & W_NOSPLIT)
    {
      f &= ~W_NOSPLIT;
      fprintf (stderr, "W_NOSPLIT%s", f ? "|" : "");
    }
  if (f & W_NOBRACE)
    {
      f &= ~W_NOBRACE;
      fprintf (stderr, "W_NOBRACE%s", f ? "|" : "");
    }
  if (f & W_NOGLOB)
    {
      f &= ~W_NOGLOB;
      fprintf (stderr, "W_NOGLOB%s", f ? "|" : "");
    }
  if (f & W_SPLITSPACE)
    {
      f &= ~W_SPLITSPACE;
      fprintf (stderr, "W_SPLITSPACE%s", f ? "|" : "");
    }
  if (f & W_ASSIGNMENT)
    {
      f &= ~W_ASSIGNMENT;
      fprintf (stderr, "W_ASSIGNMENT%s", f ? "|" : "");
    }
  if (f & W_QUOTED)
    {
      f &= ~W_QUOTED;
      fprintf (stderr, "W_QUOTED%s", f ? "|" : "");
    }
  if (f & W_HASDOLLAR)
    {
      f &= ~W_HASDOLLAR;
      fprintf (stderr, "W_HASDOLLAR%s", f ? "|" : "");
    }
  if (f & W_COMPLETE)
    {
      f &= ~W_COMPLETE;
      fprintf (stderr, "W_COMPLETE%s", f ? "|" : "");
    }
  if (f & W_CHKLOCAL)
    {
      f &= ~W_CHKLOCAL;
      fprintf (stderr, "W_CHKLOCAL%s", f ? "|" : "");
    }
  if (f & W_FORCELOCAL)
    {
      f &= ~W_FORCELOCAL;
      fprintf (stderr, "W_FORCELOCAL%s", f ? "|" : "");
    }

  fprintf (stderr, "\n");
  fflush (stderr);
}
#endif

#ifdef INCLUDE_UNUSED
static char *
quoted_substring (string, start, end)
     char *string;
     int start, end;
{
  register int len, l;
  register char *result, *s, *r;

  len = end - start;

  /* Move to string[start], skipping quoted characters. */
  for (s = string, l = 0; *s && l < start; )
    {
      if (*s == CTLESC)
        {
          s++;
          continue;
        }
      l++;
      if (*s == 0)
        break;
    }

  r = result = (char *)xmalloc (2*len + 1);      /* save room for quotes */

  /* Copy LEN characters, including quote characters. */
  s = string + l;
  for (l = 0; l < len; s++)
    {
      if (*s == CTLESC)
        *r++ = *s++;
      *r++ = *s;
      l++;
      if (*s == 0)
        break;
    }
  *r = '\0';
  return result;
}
#endif

#ifdef INCLUDE_UNUSED
/* Return the length of S, skipping over quoted characters */
static int
quoted_strlen (s)
     char *s;
{
  register char *p;
  int i;

  i = 0;
  for (p = s; *p; p++)
    {
      if (*p == CTLESC)
        {
          p++;
          if (*p == 0)
            return (i + 1);
        }
      i++;
    }

  return i;
}
#endif

#ifdef INCLUDE_UNUSED
/* Find the first occurrence of character C in string S, obeying shell
   quoting rules.  If (FLAGS & ST_BACKSL) is non-zero, backslash-escaped
   characters are skipped.  If (FLAGS & ST_CTLESC) is non-zero, characters
   escaped with CTLESC are skipped. */
static char *
quoted_strchr (s, c, flags)
     char *s;
     int c, flags;
{
  register char *p;

  for (p = s; *p; p++)
    {
      if (((flags & ST_BACKSL) && *p == '\\')
            || ((flags & ST_CTLESC) && *p == CTLESC))
        {
          p++;
          if (*p == '\0')
            return ((char *)NULL);
          continue;
        }
      else if (*p == c)
        return p;
    }
  return ((char *)NULL);
}

/* Return 1 if CHARACTER appears in an unquoted portion of
   STRING.  Return 0 otherwise.  CHARACTER must be a single-byte character. */
static int
unquoted_member (character, string)
     int character;
     char *string;
{
  size_t slen;
  int sindex, c;
  DECLARE_MBSTATE;

  slen = strlen (string);
  sindex = 0;
  while (c = string[sindex])
    {
      if (c == character)
        return (1);

      switch (c)
        {
        default:
          ADVANCE_CHAR (string, slen, sindex);
          break;

        case '\\':
          sindex++;
          if (string[sindex])
            ADVANCE_CHAR (string, slen, sindex);
          break;

        case '\'':
          sindex = skip_single_quoted (string, slen, ++sindex, 0);
          break;

        case '"':
          sindex = skip_double_quoted (string, slen, ++sindex, 0);
          break;
        }
    }
  return (0);
}

/* Return 1 if SUBSTR appears in an unquoted portion of STRING. */
static int
unquoted_substring (substr, string)
     char *substr, *string;
{
  size_t slen;
  int sindex, c, sublen;
  DECLARE_MBSTATE;

  if (substr == 0 || *substr == '\0')
    return (0);

  slen = strlen (string);
  sublen = strlen (substr);
  for (sindex = 0; c = string[sindex]; )
    {
      if (STREQN (string + sindex, substr, sublen))
        return (1);

      switch (c)
        {
        case '\\':
          sindex++;
          if (string[sindex])
            ADVANCE_CHAR (string, slen, sindex);
          break;

        case '\'':
          sindex = skip_single_quoted (string, slen, ++sindex, 0);
          break;

        case '"':
          sindex = skip_double_quoted (string, slen, ++sindex, 0);
          break;

        default:
          ADVANCE_CHAR (string, slen, sindex);
          break;
        }
    }
  return (0);
}
#endif

/* Most of the substitutions must be done in parallel.  In order
   to avoid using tons of unclear goto's, I have some functions
   for manipulating malloc'ed strings.  They all take INDX, a
   pointer to an integer which is the offset into the string
   where manipulation is taking place.  They also take SIZE, a
   pointer to an integer which is the current length of the
   character array for this string. */

/* Append SOURCE to TARGET at INDEX.  SIZE is the current amount
   of space allocated to TARGET.  SOURCE can be NULL, in which
   case nothing happens.  Gets rid of SOURCE by freeing it.
   Returns TARGET in case the location has changed. */
INLINE char *
sub_append_string (source, target, indx, size)
     char *source, *target;
     size_t *indx;
     size_t *size;
{
  if (source)
    {
      size_t n, srclen;

      srclen = STRLEN (source);
      if (srclen >= (*size - *indx))
        {
          n = srclen + *indx;
          n = (n + DEFAULT_ARRAY_SIZE) - (n % DEFAULT_ARRAY_SIZE);
          target = (char *)xrealloc (target, (*size = n));
        }

      FASTCOPY (source, target + *indx, srclen);
      *indx += srclen;
      target[*indx] = '\0';

      free (source);
    }
  return (target);
}

#if 0
/* UNUSED */
/* Append the textual representation of NUMBER to TARGET.
   INDX and SIZE are as in SUB_APPEND_STRING. */
char *
sub_append_number (number, target, indx, size)
     intmax_t number;
     char *target;
     size_t *indx;
     size_t *size;
{
  char *temp;

  temp = itos (number);
  return (sub_append_string (temp, target, indx, size));
}
#endif

/* Extract a substring from STRING, starting at SINDEX and ending with
   one of the characters in CHARLIST.  Don't make the ending character
   part of the string.  Leave SINDEX pointing at the ending character.
   Understand about backslashes in the string.  If (flags & SX_VARNAME)
   is non-zero, and array variables have been compiled into the shell,
   everything between a `[' and a corresponding `]' is skipped over.
   If (flags & SX_NOALLOC) is non-zero, don't return the substring, just
   update SINDEX.  If (flags & SX_REQMATCH) is non-zero, the string must
   contain a closing character from CHARLIST. */
static char *
string_extract (string, sindex, charlist, flags)
     char *string;
     int *sindex;
     char *charlist;
     int flags;
{
  register int c, i;
  int found;
  size_t slen;
  char *temp;
  DECLARE_MBSTATE;

  slen = (MB_CUR_MAX > 1) ? strlen (string + *sindex) + *sindex : 0;
  i = *sindex;
  found = 0;
  while (c = string[i])
    {
      if (c == '\\')
        {
          if (string[i + 1])
            i++;
          else
            break;
        }
#if defined (ARRAY_VARS)
      else if ((flags & SX_VARNAME) && c == LBRACK)
        {
          int ni;
          /* If this is an array subscript, skip over it and continue. */
          ni = skipsubscript (string, i, 0);
          if (string[ni] == RBRACK)
            i = ni;
        }
#endif
      else if (MEMBER (c, charlist))
        {
          found = 1;
          break;
        }

      ADVANCE_CHAR (string, slen, i);
    }

  /* If we had to have a matching delimiter and didn't find one, return an
     error and let the caller deal with it. */
  if ((flags & SX_REQMATCH) && found == 0)
    {
      *sindex = i;
      return (&extract_string_error);
    }
  
  temp = (flags & SX_NOALLOC) ? (char *)NULL : substring (string, *sindex, i);
  *sindex = i;
  
  return (temp);
}

/* Extract the contents of STRING as if it is enclosed in double quotes.
   SINDEX, when passed in, is the offset of the character immediately
   following the opening double quote; on exit, SINDEX is left pointing after
   the closing double quote.  If STRIPDQ is non-zero, unquoted double
   quotes are stripped and the string is terminated by a null byte.
   Backslashes between the embedded double quotes are processed.  If STRIPDQ
   is zero, an unquoted `"' terminates the string. */
static char *
string_extract_double_quoted (string, sindex, flags)
     char *string;
     int *sindex, flags;
{
  size_t slen;
  char *send;
  int j, i, t;
  unsigned char c;
  char *temp, *ret;             /* The new string we return. */
  int pass_next, backquote, si; /* State variables for the machine. */
  int dquote;
  int stripdq;
  DECLARE_MBSTATE;

  slen = strlen (string + *sindex) + *sindex;
  send = string + slen;

  stripdq = (flags & SX_STRIPDQ);

  pass_next = backquote = dquote = 0;
  temp = (char *)xmalloc (1 + slen - *sindex);

  j = 0;
  i = *sindex;
  while (c = string[i])
    {
      /* Process a character that was quoted by a backslash. */
      if (pass_next)
        {
          /* XXX - take another look at this in light of Interp 221 */
          /* Posix.2 sez:

             ``The backslash shall retain its special meaning as an escape
             character only when followed by one of the characters:
                $       `       "       \       <newline>''.

             If STRIPDQ is zero, we handle the double quotes here and let
             expand_word_internal handle the rest.  If STRIPDQ is non-zero,
             we have already been through one round of backslash stripping,
             and want to strip these backslashes only if DQUOTE is non-zero,
             indicating that we are inside an embedded double-quoted string. */

          /* If we are in an embedded quoted string, then don't strip
             backslashes before characters for which the backslash
             retains its special meaning, but remove backslashes in
             front of other characters.  If we are not in an
             embedded quoted string, don't strip backslashes at all.
             This mess is necessary because the string was already
             surrounded by double quotes (and sh has some really weird
             quoting rules).
             The returned string will be run through expansion as if
             it were double-quoted. */
          if ((stripdq == 0 && c != '"') ||
              (stripdq && ((dquote && (sh_syntaxtab[c] & CBSDQUOTE)) || dquote == 0)))
            temp[j++] = '\\';
          pass_next = 0;

add_one_character:
          COPY_CHAR_I (temp, j, string, send, i);
          continue;
        }

      /* A backslash protects the next character.  The code just above
         handles preserving the backslash in front of any character but
         a double quote. */
      if (c == '\\')
        {
          pass_next++;
          i++;
          continue;
        }

      /* Inside backquotes, ``the portion of the quoted string from the
         initial backquote and the characters up to the next backquote
         that is not preceded by a backslash, having escape characters
         removed, defines that command''. */
      if (backquote)
        {
          if (c == '`')
            backquote = 0;
          temp[j++] = c;        /* COPY_CHAR_I? */
          i++;
          continue;
        }

      if (c == '`')
        {
          temp[j++] = c;
          backquote++;
          i++;
          continue;
        }

      /* Pass everything between `$(' and the matching `)' or a quoted
         ${ ... } pair through according to the Posix.2 specification. */
      if (c == '$' && ((string[i + 1] == LPAREN) || (string[i + 1] == LBRACE)))
        {
          int free_ret = 1;

          si = i + 2;
          if (string[i + 1] == LPAREN)
            ret = extract_command_subst (string, &si, (flags & SX_COMPLETE));
          else
            ret = extract_dollar_brace_string (string, &si, Q_DOUBLE_QUOTES, 0);

          temp[j++] = '$';
          temp[j++] = string[i + 1];

          /* Just paranoia; ret will not be 0 unless no_longjmp_on_fatal_error
             is set. */
          if (ret == 0 && no_longjmp_on_fatal_error)
            {
              free_ret = 0;
              ret = string + i + 2;
            }

          /* XXX - CHECK_STRING_OVERRUN here? */
          for (t = 0; ret[t]; t++, j++)
            temp[j] = ret[t];
          temp[j] = string[si];

          if (si < i + 2)       /* we went back? */
            i += 2;
          else if (string[si])
            {
              j++;
              i = si + 1;
            }
          else
            i = si;

          if (free_ret)
            free (ret);
          continue;
        }

      /* Add any character but a double quote to the quoted string we're
         accumulating. */
      if (c != '"')
        goto add_one_character;

      /* c == '"' */
      if (stripdq)
        {
          dquote ^= 1;
          i++;
          continue;
        }

      break;
    }
  temp[j] = '\0';

  /* Point to after the closing quote. */
  if (c)
    i++;
  *sindex = i;

  return (temp);
}

/* This should really be another option to string_extract_double_quoted. */
static int
skip_double_quoted (string, slen, sind, flags)
     char *string;
     size_t slen;
     int sind;
     int flags;
{
  int c, i;
  char *ret;
  int pass_next, backquote, si;
  DECLARE_MBSTATE;

  pass_next = backquote = 0;
  i = sind;
  while (c = string[i])
    {
      if (pass_next)
        {
          pass_next = 0;
          ADVANCE_CHAR (string, slen, i);
          continue;
        }
      else if (c == '\\')
        {
          pass_next++;
          i++;
          continue;
        }
      else if (backquote)
        {
          if (c == '`')
            backquote = 0;
          ADVANCE_CHAR (string, slen, i);
          continue;
        }
      else if (c == '`')
        {
          backquote++;
          i++;
          continue;
        }
      else if (c == '$' && ((string[i + 1] == LPAREN) || (string[i + 1] == LBRACE)))
        {
          si = i + 2;
          if (string[i + 1] == LPAREN)
            ret = extract_command_subst (string, &si, SX_NOALLOC|(flags&SX_COMPLETE));
          else
            ret = extract_dollar_brace_string (string, &si, Q_DOUBLE_QUOTES, SX_NOALLOC);

          /* These can consume the entire string if they are unterminated */
          CHECK_STRING_OVERRUN (i, si, slen, c);

          i = si + 1;
          continue;
        }
      else if (c != '"')
        {
          ADVANCE_CHAR (string, slen, i);
          continue;
        }
      else
        break;
    }

  if (c)
    i++;

  return (i);
}

/* Extract the contents of STRING as if it is enclosed in single quotes.
   SINDEX, when passed in, is the offset of the character immediately
   following the opening single quote; on exit, SINDEX is left pointing after
   the closing single quote. ALLOWESC allows the single quote to be quoted by
   a backslash; it's not used yet. */
static inline char *
string_extract_single_quoted (string, sindex, allowesc)
     char *string;
     int *sindex;
     int allowesc;
{
  register int i;
  size_t slen;
  char *t;
  int pass_next;
  DECLARE_MBSTATE;

  /* Don't need slen for ADVANCE_CHAR unless multibyte chars possible. */
  slen = (MB_CUR_MAX > 1) ? strlen (string + *sindex) + *sindex : 0;
  i = *sindex;
  pass_next = 0;
  while (string[i])
    {
      if (pass_next)
        {
          pass_next = 0;
          ADVANCE_CHAR (string, slen, i);
          continue;
        }
      if (allowesc && string[i] == '\\')
        pass_next++;
      else if (string[i] == '\'')
        break;
      ADVANCE_CHAR (string, slen, i);
    }

  t = substring (string, *sindex, i);

  if (string[i])
    i++;
  *sindex = i;

  return (t);
}

/* Skip over a single-quoted string.  We overload the SX_COMPLETE flag to mean
   that we are splitting out words for completion and have encountered a $'...'
   string, which allows backslash-escaped single quotes. */
static inline int
skip_single_quoted (string, slen, sind, flags)
     const char *string;
     size_t slen;
     int sind;
     int flags;
{
  register int c;
  DECLARE_MBSTATE;

  c = sind;
  while (string[c] && string[c] != '\'')
    {
      if ((flags & SX_COMPLETE) && string[c] == '\\' && string[c+1] == '\'' && string[c+2])
        ADVANCE_CHAR (string, slen, c);
      ADVANCE_CHAR (string, slen, c);
    }

  if (string[c])
    c++;
  return c;
}

/* Just like string_extract, but doesn't hack backslashes or any of
   that other stuff.  Obeys CTLESC quoting.  Used to do splitting on $IFS. */
static char *
string_extract_verbatim (string, slen, sindex, charlist, flags)
     char *string;
     size_t slen;
     int *sindex;
     char *charlist;
     int flags;
{
  register int i;
#if defined (HANDLE_MULTIBYTE)
  wchar_t *wcharlist;
#endif
  int c;
  char *temp;
  DECLARE_MBSTATE;

  if ((flags & SX_NOCTLESC) && charlist[0] == '\'' && charlist[1] == '\0')
    {
      temp = string_extract_single_quoted (string, sindex, 0);
      --*sindex;        /* leave *sindex at separator character */
      return temp;
    }

  /* This can never be called with charlist == NULL. If *charlist == NULL,
     we can skip the loop and just return a copy of the string, updating
     *sindex */
  if (*charlist == 0)
    {
      temp = string + *sindex;
      c = (*sindex == 0) ? slen : STRLEN (temp);
      temp = savestring (temp);
      *sindex += c;
      return temp;
    }

  i = *sindex;
#if defined (HANDLE_MULTIBYTE)
  wcharlist = 0;
#endif
  while (c = string[i])
    {
#if defined (HANDLE_MULTIBYTE)
      size_t mblength;
#endif
      if ((flags & SX_NOCTLESC) == 0 && c == CTLESC)
        {
          i += 2;
          CHECK_STRING_OVERRUN (i, i, slen, c);
          continue;
        }
      /* Even if flags contains SX_NOCTLESC, we let CTLESC quoting CTLNUL
         through, to protect the CTLNULs from later calls to
         remove_quoted_nulls. */
      else if ((flags & SX_NOESCCTLNUL) == 0 && c == CTLESC && string[i+1] == CTLNUL)
        {
          i += 2;
          CHECK_STRING_OVERRUN (i, i, slen, c);
          continue;
        }

#if defined (HANDLE_MULTIBYTE)
      if (locale_utf8locale && slen > i && UTF8_SINGLEBYTE (string[i]))
        mblength = (string[i] != 0) ? 1 : 0;
      else
        mblength = MBLEN (string + i, slen - i);
      if (mblength > 1)
        {
          wchar_t wc;
          mblength = mbtowc (&wc, string + i, slen - i);
          if (MB_INVALIDCH (mblength))
            {
              if (MEMBER (c, charlist))
                break;
            }
          else
            {
              if (wcharlist == 0)
                {
                  size_t len;
                  len = mbstowcs (wcharlist, charlist, 0);
                  if (len == -1)
                    len = 0;
                  wcharlist = (wchar_t *)xmalloc (sizeof (wchar_t) * (len + 1));
                  mbstowcs (wcharlist, charlist, len + 1);
                }

              if (wcschr (wcharlist, wc))
                break;
            }
        }
      else              
#endif
      if (MEMBER (c, charlist))
        break;

      ADVANCE_CHAR (string, slen, i);
    }

#if defined (HANDLE_MULTIBYTE)
  FREE (wcharlist);
#endif

  temp = substring (string, *sindex, i);
  *sindex = i;

  return (temp);
}

/* Extract the $( construct in STRING, and return a new string.
   Start extracting at (SINDEX) as if we had just seen "$(".
   Make (SINDEX) get the position of the matching ")". )
   XFLAGS is additional flags to pass to other extraction functions. */
char *
extract_command_subst (string, sindex, xflags)
     char *string;
     int *sindex;
     int xflags;
{
  char *ret;

  if (string[*sindex] == LPAREN || (xflags & SX_COMPLETE))
    return (extract_delimited_string (string, sindex, "$(", "(", ")", xflags|SX_COMMAND)); /*)*/
  else
    {
      xflags |= (no_longjmp_on_fatal_error ? SX_NOLONGJMP : 0);
      ret = xparse_dolparen (string, string+*sindex, sindex, xflags);
      return ret;
    }
}

/* Extract the $[ construct in STRING, and return a new string. (])
   Start extracting at (SINDEX) as if we had just seen "$[".
   Make (SINDEX) get the position of the matching "]". */
char *
extract_arithmetic_subst (string, sindex)
     char *string;
     int *sindex;
{
  return (extract_delimited_string (string, sindex, "$[", "[", "]", 0)); /*]*/
}

#if defined (PROCESS_SUBSTITUTION)
/* Extract the <( or >( construct in STRING, and return a new string.
   Start extracting at (SINDEX) as if we had just seen "<(".
   Make (SINDEX) get the position of the matching ")". */ /*))*/
char *
extract_process_subst (string, starter, sindex, xflags)
     char *string;
     char *starter;
     int *sindex;
     int xflags;
{
#if 0
  /* XXX - check xflags&SX_COMPLETE here? */
  return (extract_delimited_string (string, sindex, starter, "(", ")", SX_COMMAND));
#else
  xflags |= (no_longjmp_on_fatal_error ? SX_NOLONGJMP : 0);
  return (xparse_dolparen (string, string+*sindex, sindex, xflags));
#endif
}
#endif /* PROCESS_SUBSTITUTION */

#if defined (ARRAY_VARS)
/* This can be fooled by unquoted right parens in the passed string. If
   each caller verifies that the last character in STRING is a right paren,
   we don't even need to call extract_delimited_string. */
char *
extract_array_assignment_list (string, sindex)
     char *string;
     int *sindex;
{
  int slen;
  char *ret;

  slen = strlen (string);
  if (string[slen - 1] == RPAREN)
   {
      ret = substring (string, *sindex, slen - 1);
      *sindex = slen - 1;
      return ret;
    }
  return 0;  
}
#endif

/* Extract and create a new string from the contents of STRING, a
   character string delimited with OPENER and CLOSER.  SINDEX is
   the address of an int describing the current offset in STRING;
   it should point to just after the first OPENER found.  On exit,
   SINDEX gets the position of the last character of the matching CLOSER.
   If OPENER is more than a single character, ALT_OPENER, if non-null,
   contains a character string that can also match CLOSER and thus
   needs to be skipped. */
static char *
extract_delimited_string (string, sindex, opener, alt_opener, closer, flags)
     char *string;
     int *sindex;
     char *opener, *alt_opener, *closer;
     int flags;
{
  int i, c, si;
  size_t slen;
  char *t, *result;
  int pass_character, nesting_level, in_comment;
  int len_closer, len_opener, len_alt_opener;
  DECLARE_MBSTATE;

  slen = strlen (string + *sindex) + *sindex;
  len_opener = STRLEN (opener);
  len_alt_opener = STRLEN (alt_opener);
  len_closer = STRLEN (closer);

  pass_character = in_comment = 0;

  nesting_level = 1;
  i = *sindex;

  while (nesting_level)
    {
      c = string[i];

      /* If a recursive call or a call to ADVANCE_CHAR leaves the index beyond
         the end of the string, catch it and cut the loop. */
      if (i > slen)
        {
          i = slen;
          c = string[i = slen];
          break;
        }

      if (c == 0)
        break;

      if (in_comment)
        {
          if (c == '\n')
            in_comment = 0;
          ADVANCE_CHAR (string, slen, i);
          continue;
        }

      if (pass_character)       /* previous char was backslash */
        {
          pass_character = 0;
          ADVANCE_CHAR (string, slen, i);
          continue;
        }

      /* Not exactly right yet; should handle shell metacharacters and
         multibyte characters, too.  See COMMENT_BEGIN define in parse.y */
      if ((flags & SX_COMMAND) && c == '#' && (i == 0 || string[i - 1] == '\n' || shellblank (string[i - 1])))
        {
          in_comment = 1;
          ADVANCE_CHAR (string, slen, i);
          continue;
        }
        
      if (c == CTLESC || c == '\\')
        {
          pass_character++;
          i++;
          continue;
        }

      /* Process a nested command substitution, but only if we're parsing an
         arithmetic substitution. */
      if ((flags & SX_COMMAND) && string[i] == '$' && string[i+1] == LPAREN)
        {
          si = i + 2;
          t = extract_command_subst (string, &si, flags|SX_NOALLOC);
          CHECK_STRING_OVERRUN (i, si, slen, c);
          i = si + 1;
          continue;
        }

      /* Process a nested OPENER. */
      if (STREQN (string + i, opener, len_opener))
        {
          si = i + len_opener;
          t = extract_delimited_string (string, &si, opener, alt_opener, closer, flags|SX_NOALLOC);
          CHECK_STRING_OVERRUN (i, si, slen, c);
          i = si + 1;
          continue;
        }

      /* Process a nested ALT_OPENER */
      if (len_alt_opener && STREQN (string + i, alt_opener, len_alt_opener))
        {
          si = i + len_alt_opener;
          t = extract_delimited_string (string, &si, alt_opener, alt_opener, closer, flags|SX_NOALLOC);
          CHECK_STRING_OVERRUN (i, si, slen, c);
          i = si + 1;
          continue;
        }

      /* If the current substring terminates the delimited string, decrement
         the nesting level. */
      if (STREQN (string + i, closer, len_closer))
        {
          i += len_closer - 1;  /* move to last byte of the closer */
          nesting_level--;
          if (nesting_level == 0)
            break;
        }

      /* Pass old-style command substitution through verbatim. */
      if (c == '`')
        {
          si = i + 1;
          t = string_extract (string, &si, "`", flags|SX_NOALLOC);
          CHECK_STRING_OVERRUN (i, si, slen, c);
          i = si + 1;
          continue;
        }

      /* Pass single-quoted and double-quoted strings through verbatim. */
      if (c == '\'' || c == '"')
        {
          si = i + 1;
          i = (c == '\'') ? skip_single_quoted (string, slen, si, 0)
                          : skip_double_quoted (string, slen, si, 0);
          continue;
        }

      /* move past this character, which was not special. */
      ADVANCE_CHAR (string, slen, i);
    }

  if (c == 0 && nesting_level)
    {
      if (no_longjmp_on_fatal_error == 0)
        {
          last_command_exit_value = EXECUTION_FAILURE;
          report_error (_("bad substitution: no closing `%s' in %s"), closer, string);
          exp_jump_to_top_level (DISCARD);
        }
      else
        {
          *sindex = i;
          return (char *)NULL;
        }
    }

  si = i - *sindex - len_closer + 1;
  if (flags & SX_NOALLOC)
    result = (char *)NULL;
  else    
    {
      result = (char *)xmalloc (1 + si);
      strncpy (result, string + *sindex, si);
      result[si] = '\0';
    }
  *sindex = i;

  return (result);
}

/* A simplified version of extract_dollar_brace_string that exists to handle
   $'...' and $"..." quoting in here-documents, since the here-document read
   path doesn't. It's separate because we don't want to mess with the fast
   common path. We already know we're going to allocate and return a new
   string and quoted == Q_HERE_DOCUMENT. We might be able to cut it down
   some more, but extracting strings and adding them as we go adds complexity.
   This needs to match the logic in parse.y:parse_matched_pair so we get
   consistent behavior between here-documents and double-quoted strings. */
static char *
extract_heredoc_dolbrace_string (string, sindex, quoted, flags)
     char *string;
     int *sindex, quoted, flags;
{
  register int i, c;
  size_t slen, tlen, result_index, result_size;
  int pass_character, nesting_level, si, dolbrace_state;
  char *result, *t, *send;
  DECLARE_MBSTATE;

  pass_character = 0;
  nesting_level = 1;
  slen = strlen (string + *sindex) + *sindex;
  send = string + slen;

  result_size = slen;
  result_index = 0;
  result = xmalloc (result_size + 1);

  /* This function isn't called if this condition is not true initially. */
  dolbrace_state = DOLBRACE_QUOTE;

  i = *sindex;
  while (c = string[i])
    {
      if (pass_character)
        {
          pass_character = 0;
          RESIZE_MALLOCED_BUFFER (result, result_index, locale_mb_cur_max + 1, result_size, 64);
          COPY_CHAR_I (result, result_index, string, send, i);
          continue;
        }

      /* CTLESCs and backslashes quote the next character. */
      if (c == CTLESC || c == '\\')
        {
          pass_character++;
          RESIZE_MALLOCED_BUFFER (result, result_index, 2, result_size, 64);
          result[result_index++] = c;
          i++;
          continue;
        }

      /* The entire reason we have this separate function right here. */
      if (c == '$' && string[i+1] == '\'')
        {
          char *ttrans;
          int ttranslen;

          if ((posixly_correct || extended_quote == 0) && dolbrace_state != DOLBRACE_QUOTE && dolbrace_state != DOLBRACE_QUOTE2)
            {
              RESIZE_MALLOCED_BUFFER (result, result_index, 3, result_size, 64);
              result[result_index++] = '$';
              result[result_index++] = '\'';
              i += 2;
              continue;
            }

          si = i + 2;
          t = string_extract_single_quoted (string, &si, 1);    /* XXX */
          CHECK_STRING_OVERRUN (i, si, slen, c);

          tlen = si - i - 2;    /* -2 since si is one after the close quote */
          ttrans = ansiexpand (t, 0, tlen, &ttranslen);
          free (t);

          /* needed to correctly quote any embedded single quotes. */
          if (dolbrace_state == DOLBRACE_QUOTE || dolbrace_state == DOLBRACE_QUOTE2)
            {
              t = sh_single_quote (ttrans);
              tlen = strlen (t);
              free (ttrans);
            }
          else if (extended_quote) /* dolbrace_state == DOLBRACE_PARAM */
            {
              /* This matches what parse.y:parse_matched_pair() does */
              t = ttrans;
              tlen = strlen (t);
            }

          RESIZE_MALLOCED_BUFFER (result, result_index, tlen + 1, result_size, 64);
          strncpy (result + result_index, t, tlen);
          result_index += tlen;
          free (t);
          i = si;
          continue;
        }

#if defined (TRANSLATABLE_STRINGS)
      if (c == '$' && string[i+1] == '"')
        {
          char *ttrans;
          int ttranslen;

          si = i + 2;
          t = string_extract_double_quoted (string, &si, flags);        /* XXX */
          CHECK_STRING_OVERRUN (i, si, slen, c);

          tlen = si - i - 2;    /* -2 since si is one after the close quote */
          ttrans = locale_expand (t, 0, tlen, line_number, &ttranslen);
          free (t);

          t = singlequote_translations ? sh_single_quote (ttrans) : sh_mkdoublequoted (ttrans, ttranslen, 0);
          tlen = strlen (t);
          free (ttrans);

          RESIZE_MALLOCED_BUFFER (result, result_index, tlen + 1, result_size, 64);
          strncpy (result + result_index, t, tlen);
          result_index += tlen;
          free (t);
          i = si;
          continue;
        }
#endif /* TRANSLATABLE_STRINGS */

      if (c == '$' && string[i+1] == LBRACE)
        {
          nesting_level++;
          RESIZE_MALLOCED_BUFFER (result, result_index, 3, result_size, 64);
          result[result_index++] = c;
          result[result_index++] = string[i+1];
          i += 2;
          if (dolbrace_state == DOLBRACE_QUOTE || dolbrace_state == DOLBRACE_QUOTE2 || dolbrace_state == DOLBRACE_WORD)
            dolbrace_state = DOLBRACE_PARAM;
          continue;
        }

      if (c == RBRACE)
        {
          nesting_level--;
          if (nesting_level == 0)
            break;
          RESIZE_MALLOCED_BUFFER (result, result_index, 2, result_size, 64);
          result[result_index++] = c;
          i++;
          continue;
        }

      /* Pass the contents of old-style command substitutions through
         verbatim. */
      if (c == '`')
        {
          si = i + 1;
          t = string_extract (string, &si, "`", flags); /* already know (flags & SX_NOALLOC) == 0) */
          CHECK_STRING_OVERRUN (i, si, slen, c);

          tlen = si - i - 1;
          RESIZE_MALLOCED_BUFFER (result, result_index, tlen + 3, result_size, 64);
          result[result_index++] = c;
          strncpy (result + result_index, t, tlen);
          result_index += tlen;
          result[result_index++] = string[si];
          free (t);
          i = si + 1;
          continue;
        }

      /* Pass the contents of new-style command substitutions and
         arithmetic substitutions through verbatim. */
      if (string[i] == '$' && string[i+1] == LPAREN)
        {
          si = i + 2;
          t = extract_command_subst (string, &si, flags);
          CHECK_STRING_OVERRUN (i, si, slen, c);

          tlen = si - i - 1;
          RESIZE_MALLOCED_BUFFER (result, result_index, tlen + 4, result_size, 64);
          result[result_index++] = c;
          result[result_index++] = LPAREN;
          strncpy (result + result_index, t, tlen);
          result_index += tlen;
          result[result_index++] = string[si];
          free (t);
          i = si + 1;
          continue;
        }

#if defined (PROCESS_SUBSTITUTION)
      /* Technically this should only work at the start of a word */
      if ((string[i] == '<' || string[i] == '>') && string[i+1] == LPAREN)
        {
          si = i + 2;
          t = extract_process_subst (string, (string[i] == '<' ? "<(" : ">)"), &si, flags);
          CHECK_STRING_OVERRUN (i, si, slen, c);

          tlen = si - i - 1;
          RESIZE_MALLOCED_BUFFER (result, result_index, tlen + 4, result_size, 64);
          result[result_index++] = c;
          result[result_index++] = LPAREN;
          strncpy (result + result_index, t, tlen);
          result_index += tlen;
          result[result_index++] = string[si];
          free (t);
          i = si + 1;
          continue;
        }
#endif

      if (c == '\'' && posixly_correct && shell_compatibility_level > 42 && dolbrace_state != DOLBRACE_QUOTE)
        {
          COPY_CHAR_I (result, result_index, string, send, i);
          continue;
        }

      /* Pass the contents of single and double-quoted strings through verbatim. */
      if (c == '"' || c == '\'')
        {
          si = i + 1;
          if (c == '"')
            t = string_extract_double_quoted (string, &si, flags);
          else
            t = string_extract_single_quoted (string, &si, 0);
          CHECK_STRING_OVERRUN (i, si, slen, c);

          tlen = si - i - 2;    /* -2 since si is one after the close quote */
          RESIZE_MALLOCED_BUFFER (result, result_index, tlen + 3, result_size, 64);
          result[result_index++] = c;
          strncpy (result + result_index, t, tlen);
          result_index += tlen;
          result[result_index++] = string[si - 1];
          free (t);
          i = si;
          continue;
        }

      /* copy this character, which was not special. */
      COPY_CHAR_I (result, result_index, string, send, i);

      /* This logic must agree with parse.y:parse_matched_pair, since they
         share the same defines. */
      if (dolbrace_state == DOLBRACE_PARAM && c == '%' && (i - *sindex) > 1)
        dolbrace_state = DOLBRACE_QUOTE;
      else if (dolbrace_state == DOLBRACE_PARAM && c == '#' && (i - *sindex) > 1)
        dolbrace_state = DOLBRACE_QUOTE;
      else if (dolbrace_state == DOLBRACE_PARAM && c == '/' && (i - *sindex) > 1)
        dolbrace_state = DOLBRACE_QUOTE2;       /* XXX */
      else if (dolbrace_state == DOLBRACE_PARAM && c == '^' && (i - *sindex) > 1)
        dolbrace_state = DOLBRACE_QUOTE;
      else if (dolbrace_state == DOLBRACE_PARAM && c == ',' && (i - *sindex) > 1)
        dolbrace_state = DOLBRACE_QUOTE;
      /* This is intended to handle all of the [:]op expansions and the substring/
         length/pattern removal/pattern substitution expansions. */
      else if (dolbrace_state == DOLBRACE_PARAM && strchr ("#%^,~:-=?+/", c) != 0)
        dolbrace_state = DOLBRACE_OP;
      else if (dolbrace_state == DOLBRACE_OP && strchr ("#%^,~:-=?+/", c) == 0)
        dolbrace_state = DOLBRACE_WORD;
    }

  if (c == 0 && nesting_level)
    {
      free (result);
      if (no_longjmp_on_fatal_error == 0)
        {                       /* { */
          last_command_exit_value = EXECUTION_FAILURE;
          report_error (_("bad substitution: no closing `%s' in %s"), "}", string);
          exp_jump_to_top_level (DISCARD);
        }
      else
        {
          *sindex = i;
          return ((char *)NULL);
        }
    }

  *sindex = i;
  result[result_index] = '\0';

  return (result);
}

#define PARAMEXPNEST_MAX        32      // for now
static int dbstate[PARAMEXPNEST_MAX];

/* Extract a parameter expansion expression within ${ and } from STRING.
   Obey the Posix.2 rules for finding the ending `}': count braces while
   skipping over enclosed quoted strings and command substitutions.
   SINDEX is the address of an int describing the current offset in STRING;
   it should point to just after the first `{' found.  On exit, SINDEX
   gets the position of the matching `}'.  QUOTED is non-zero if this
   occurs inside double quotes. */
/* XXX -- this is very similar to extract_delimited_string -- XXX */
static char *
extract_dollar_brace_string (string, sindex, quoted, flags)
     char *string;
     int *sindex, quoted, flags;
{
  register int i, c;
  size_t slen;
  int pass_character, nesting_level, si, dolbrace_state;
  char *result, *t;
  DECLARE_MBSTATE;

  /* The handling of dolbrace_state needs to agree with the code in parse.y:
     parse_matched_pair().  The different initial value is to handle the
     case where this function is called to parse the word in
     ${param op word} (SX_WORD). */
  dolbrace_state = (flags & SX_WORD) ? DOLBRACE_WORD : DOLBRACE_PARAM;
  if ((quoted & (Q_HERE_DOCUMENT|Q_DOUBLE_QUOTES)) && (flags & SX_POSIXEXP))
    dolbrace_state = DOLBRACE_QUOTE;

  if (quoted == Q_HERE_DOCUMENT && dolbrace_state == DOLBRACE_QUOTE && (flags & SX_NOALLOC) == 0)
    return (extract_heredoc_dolbrace_string (string, sindex, quoted, flags));

  dbstate[0] = dolbrace_state;

  pass_character = 0;
  nesting_level = 1;
  slen = strlen (string + *sindex) + *sindex;

  i = *sindex;
  while (c = string[i])
    {
      if (pass_character)
        {
          pass_character = 0;
          ADVANCE_CHAR (string, slen, i);
          continue;
        }

      /* CTLESCs and backslashes quote the next character. */
      if (c == CTLESC || c == '\\')
        {
          pass_character++;
          i++;
          continue;
        }

      if (string[i] == '$' && string[i+1] == LBRACE)
        {
          if (nesting_level < PARAMEXPNEST_MAX)
            dbstate[nesting_level] = dolbrace_state;
          nesting_level++;
          i += 2;
          if (dolbrace_state == DOLBRACE_QUOTE || dolbrace_state == DOLBRACE_WORD)
            dolbrace_state = DOLBRACE_PARAM;
          continue;
        }

      if (c == RBRACE)
        {
          nesting_level--;
          if (nesting_level == 0)
            break;
          dolbrace_state = (nesting_level < PARAMEXPNEST_MAX) ? dbstate[nesting_level] : dbstate[0];    /* Guess using initial state */
          i++;
          continue;
        }

      /* Pass the contents of old-style command substitutions through
         verbatim. */
      if (c == '`')
        {
          si = i + 1;
          t = string_extract (string, &si, "`", flags|SX_NOALLOC);

          CHECK_STRING_OVERRUN (i, si, slen, c);

          i = si + 1;
          continue;
        }

      /* Pass the contents of new-style command substitutions and
         arithmetic substitutions through verbatim. */
      if (string[i] == '$' && string[i+1] == LPAREN)
        {
          si = i + 2;
          t = extract_command_subst (string, &si, flags|SX_NOALLOC);

          CHECK_STRING_OVERRUN (i, si, slen, c);

          i = si + 1;
          continue;
        }

#if defined (PROCESS_SUBSTITUTION)
      /* Technically this should only work at the start of a word */
      if ((string[i] == '<' || string[i] == '>') && string[i+1] == LPAREN)
        {
          si = i + 2;
          t = extract_process_subst (string, (string[i] == '<' ? "<(" : ">)"), &si, flags|SX_NOALLOC);

          CHECK_STRING_OVERRUN (i, si, slen, c);

          i = si + 1;
          continue;
        }
#endif

      /* Pass the contents of double-quoted strings through verbatim. */
      if (c == '"')
        {
          si = i + 1;
          i = skip_double_quoted (string, slen, si, 0);
          /* skip_XXX_quoted leaves index one past close quote */
          continue;
        }

      if (c == '\'')
        {
/*itrace("extract_dollar_brace_string: c == single quote flags = %d quoted = %d dolbrace_state = %d", flags, quoted, dolbrace_state);*/
          if (posixly_correct && shell_compatibility_level > 42 && dolbrace_state != DOLBRACE_QUOTE && (quoted & (Q_HERE_DOCUMENT|Q_DOUBLE_QUOTES)))
            ADVANCE_CHAR (string, slen, i);
          else
            {
              si = i + 1;
              i = skip_single_quoted (string, slen, si, 0);
            }

          continue;
        }

#if defined (ARRAY_VARS)
      if (c == LBRACK && dolbrace_state == DOLBRACE_PARAM)
        {
          si = skipsubscript (string, i, 0);
          CHECK_STRING_OVERRUN (i, si, slen, c);
          if (string[si] == RBRACK)
            c = string[i = si];
        }
#endif

      /* move past this character, which was not special. */
      ADVANCE_CHAR (string, slen, i);

      /* This logic must agree with parse.y:parse_matched_pair, since they
         share the same defines. */
      if (dolbrace_state == DOLBRACE_PARAM && c == '%' && (i - *sindex) > 1)
        dolbrace_state = DOLBRACE_QUOTE;
      else if (dolbrace_state == DOLBRACE_PARAM && c == '#' && (i - *sindex) > 1)
        dolbrace_state = DOLBRACE_QUOTE;
      else if (dolbrace_state == DOLBRACE_PARAM && c == '/' && (i - *sindex) > 1)
        dolbrace_state = DOLBRACE_QUOTE2;       /* XXX */
      else if (dolbrace_state == DOLBRACE_PARAM && c == '^' && (i - *sindex) > 1)
        dolbrace_state = DOLBRACE_QUOTE;
      else if (dolbrace_state == DOLBRACE_PARAM && c == ',' && (i - *sindex) > 1)
        dolbrace_state = DOLBRACE_QUOTE;
      /* This is intended to handle all of the [:]op expansions and the substring/
         length/pattern removal/pattern substitution expansions. */
      else if (dolbrace_state == DOLBRACE_PARAM && strchr ("#%^,~:-=?+/", c) != 0)
        dolbrace_state = DOLBRACE_OP;
      else if (dolbrace_state == DOLBRACE_OP && strchr ("#%^,~:-=?+/", c) == 0)
        dolbrace_state = DOLBRACE_WORD;
    }

  if (c == 0 && nesting_level)
    {
      if (no_longjmp_on_fatal_error == 0)
        {                       /* { */
          last_command_exit_value = EXECUTION_FAILURE;
          report_error (_("bad substitution: no closing `%s' in %s"), "}", string);
          exp_jump_to_top_level (DISCARD);
        }
      else
        {
          *sindex = i;
          return ((char *)NULL);
        }
    }

  result = (flags & SX_NOALLOC) ? (char *)NULL : substring (string, *sindex, i);
  *sindex = i;

  return (result);
}

/* Remove backslashes which are quoting backquotes from STRING.  Modifies
   STRING, and returns a pointer to it. */
char *
de_backslash (string)
     char *string;
{
  register size_t slen;
  register int i, j, prev_i;
  DECLARE_MBSTATE;

  slen = strlen (string);
  i = j = 0;

  /* Loop copying string[i] to string[j], i >= j. */
  while (i < slen)
    {
      if (string[i] == '\\' && (string[i + 1] == '`' || string[i + 1] == '\\' ||
                              string[i + 1] == '$'))
        i++;
      prev_i = i;
      ADVANCE_CHAR (string, slen, i);
      if (j < prev_i)
        do string[j++] = string[prev_i++]; while (prev_i < i);
      else
        j = i;
    }
  string[j] = '\0';

  return (string);
}

#if 0
/*UNUSED*/
/* Replace instances of \! in a string with !. */
void
unquote_bang (string)
     char *string;
{
  register int i, j;
  register char *temp;

  temp = (char *)xmalloc (1 + strlen (string));

  for (i = 0, j = 0; (temp[j] = string[i]); i++, j++)
    {
      if (string[i] == '\\' && string[i + 1] == '!')
        {
          temp[j] = '!';
          i++;
        }
    }
  strcpy (string, temp);
  free (temp);
}
#endif

#define CQ_RETURN(x) do { no_longjmp_on_fatal_error = oldjmp; return (x); } while (0)

/* When FLAGS & 2 == 0, this function assumes STRING[I] == OPEN; when
   FLAGS & 2 != 0, it assumes STRING[I] points to one character past OPEN;
   returns with STRING[RET] == close; used to parse array subscripts.
   FLAGS & 1 means not to attempt to skip over matched pairs of quotes or
   backquotes, or skip word expansions; it is intended to be used after
   expansion has been performed and during final assignment parsing (see
   arrayfunc.c:assign_compound_array_list()) or during execution by a builtin
   which has already undergone word expansion. */
static int
skip_matched_pair (string, start, open, close, flags)
     const char *string;
     int start, open, close, flags;
{
  int i, pass_next, backq, si, c, count, oldjmp;
  size_t slen;
  char *temp, *ss;
  DECLARE_MBSTATE;

  slen = strlen (string + start) + start;
  oldjmp = no_longjmp_on_fatal_error;
  no_longjmp_on_fatal_error = 1;

  /* Move to the first character after a leading OPEN. If FLAGS&2, we assume
    that START already points to that character. If not, we need to skip over
    it here. */
  i = (flags & 2) ? start : start + 1;
  count = 1;
  pass_next = backq = 0;
  ss = (char *)string;
  while (c = string[i])
    {
      if (pass_next)
        {
          pass_next = 0;
          if (c == 0)
            CQ_RETURN(i);
          ADVANCE_CHAR (string, slen, i);
          continue;
        }
      else if ((flags & 1) == 0 && c == '\\')
        {
          pass_next = 1;
          i++;
          continue;
        }
      else if (backq)
        {
          if (c == '`')
            backq = 0;
          ADVANCE_CHAR (string, slen, i);
          continue;
        }
      else if ((flags & 1) == 0 && c == '`')
        {
          backq = 1;
          i++;
          continue;
        }
      else if ((flags & 1) == 0 && c == open)
        {
          count++;
          i++;
          continue;
        }
      else if (c == close)
        {
          count--;
          if (count == 0)
            break;
          i++;
          continue;
        }
      else if ((flags & 1) == 0 && (c == '\'' || c == '"'))
        {
          i = (c == '\'') ? skip_single_quoted (ss, slen, ++i, 0)
                          : skip_double_quoted (ss, slen, ++i, 0);
          /* no increment, the skip functions increment past the closing quote. */
        }
      else if ((flags & 1) == 0 && c == '$' && (string[i+1] == LPAREN || string[i+1] == LBRACE))
        {
          si = i + 2;
          if (string[si] == '\0')
            CQ_RETURN(si);

          /* XXX - extract_command_subst here? */
          if (string[i+1] == LPAREN)
            temp = extract_delimited_string (ss, &si, "$(", "(", ")", SX_NOALLOC|SX_COMMAND); /* ) */
          else
            temp = extract_dollar_brace_string (ss, &si, 0, SX_NOALLOC);

          CHECK_STRING_OVERRUN (i, si, slen, c);

          i = si;
          if (string[i] == '\0')        /* don't increment i past EOS in loop */
            break;
          i++;
          continue;
        }
      else
        ADVANCE_CHAR (string, slen, i);
    }

  CQ_RETURN(i);
}

#if defined (ARRAY_VARS)
/* FLAGS has 1 as a reserved value, since skip_matched_pair uses it for
   skipping over quoted strings and taking the first instance of the
   closing character. FLAGS & 2 means that STRING[START] points one
   character past the open bracket; FLAGS & 2 == 0 means that STRING[START]
   points to the open bracket. skip_matched_pair knows how to deal with this. */
int
skipsubscript (string, start, flags)
     const char *string;
     int start, flags;
{
  return (skip_matched_pair (string, start, '[', ']', flags));
}
#endif

/* Skip characters in STRING until we find a character in DELIMS, and return
   the index of that character.  START is the index into string at which we
   begin.  This is similar in spirit to strpbrk, but it returns an index into
   STRING and takes a starting index.  This little piece of code knows quite
   a lot of shell syntax.  It's very similar to skip_double_quoted and other
   functions of that ilk. */
int
skip_to_delim (string, start, delims, flags)
     char *string;
     int start;
     char *delims;
     int flags;
{
  int i, pass_next, backq, dquote, si, c, oldjmp;
  int invert, skipquote, skipcmd, noprocsub, completeflag;
  int arithexp, skipcol;
  size_t slen;
  char *temp, open[3];
  DECLARE_MBSTATE;

  slen = strlen (string + start) + start;
  oldjmp = no_longjmp_on_fatal_error;
  if (flags & SD_NOJMP)
    no_longjmp_on_fatal_error = 1;
  invert = (flags & SD_INVERT);
  skipcmd = (flags & SD_NOSKIPCMD) == 0;
  noprocsub = (flags & SD_NOPROCSUB);
  completeflag = (flags & SD_COMPLETE) ? SX_COMPLETE : 0;

  arithexp = (flags & SD_ARITHEXP);
  skipcol = 0;

  i = start;
  pass_next = backq = dquote = 0;
  while (c = string[i])
    {
      /* If this is non-zero, we should not let quote characters be delimiters
         and the current character is a single or double quote.  We should not
         test whether or not it's a delimiter until after we skip single- or
         double-quoted strings. */
      skipquote = ((flags & SD_NOQUOTEDELIM) && (c == '\'' || c =='"'));
      if (pass_next)
        {
          pass_next = 0;
          if (c == 0)
            CQ_RETURN(i);
          ADVANCE_CHAR (string, slen, i);
          continue;
        }
      else if (c == '\\')
        {
          pass_next = 1;
          i++;
          continue;
        }
      else if (backq)
        {
          if (c == '`')
            backq = 0;
          ADVANCE_CHAR (string, slen, i);
          continue;
        }
      else if (c == '`')
        {
          backq = 1;
          i++;
          continue;
        }
      else if (arithexp && skipcol && c == ':')
        {
          skipcol--;
          i++;
          continue;
        }
      else if (arithexp && c == '?')
        {
          skipcol++;
          i++;
          continue;
        }
      else if (skipquote == 0 && invert == 0 && member (c, delims))
        break;
      /* the usual case is to use skip_xxx_quoted, but we don't skip over double
         quoted strings when looking for the history expansion character as a
         delimiter. */
      /* special case for programmable completion which takes place before
         parser converts backslash-escaped single quotes between $'...' to
         `regular' single-quoted strings. */
      else if (completeflag && i > 0 && string[i-1] == '$' && c == '\'')
        i = skip_single_quoted (string, slen, ++i, SX_COMPLETE);
      else if (c == '\'')
        i = skip_single_quoted (string, slen, ++i, 0);
      else if (c == '"')
        i = skip_double_quoted (string, slen, ++i, completeflag);
      else if (c == LPAREN && arithexp)
        {
          si = i + 1;
          if (string[si] == '\0')
            CQ_RETURN(si);

          temp = extract_delimited_string (string, &si, "(", "(", ")", SX_NOALLOC); /* ) */
          i = si;
          if (string[i] == '\0')        /* don't increment i past EOS in loop */
            break;
          i++;
          continue;         
        }
      else if (c == '$' && ((skipcmd && string[i+1] == LPAREN) || string[i+1] == LBRACE))
        {
          si = i + 2;
          if (string[si] == '\0')
            CQ_RETURN(si);

          if (string[i+1] == LPAREN)
            temp = extract_delimited_string (string, &si, "$(", "(", ")", SX_NOALLOC|SX_COMMAND|completeflag); /* ) */
          else
            temp = extract_dollar_brace_string (string, &si, 0, SX_NOALLOC);
          CHECK_STRING_OVERRUN (i, si, slen, c);
          i = si;
          if (string[i] == '\0')        /* don't increment i past EOS in loop */
            break;
          i++;
          continue;
        }
#if defined (PROCESS_SUBSTITUTION)
      else if (skipcmd && noprocsub == 0 && (c == '<' || c == '>') && string[i+1] == LPAREN)
        {
          si = i + 2;
          if (string[si] == '\0')
            CQ_RETURN(si);

          temp = extract_delimited_string (string, &si, (c == '<') ? "<(" : ">(", "(", ")", SX_COMMAND|SX_NOALLOC); /* )) */
          CHECK_STRING_OVERRUN (i, si, slen, c);
          i = si;
          if (string[i] == '\0')
            break;
          i++;
          continue;
        }
#endif /* PROCESS_SUBSTITUTION */
#if defined (EXTENDED_GLOB)
      else if ((flags & SD_EXTGLOB) && extended_glob && string[i+1] == LPAREN && member (c, "?*+!@"))
        {
          si = i + 2;
          if (string[si] == '\0')
            CQ_RETURN(si);

          open[0] = c;
          open[1] = LPAREN;
          open[2] = '\0';
          temp = extract_delimited_string (string, &si, open, "(", ")", SX_NOALLOC); /* ) */

          CHECK_STRING_OVERRUN (i, si, slen, c);
          i = si;
          if (string[i] == '\0')        /* don't increment i past EOS in loop */
            break;
          i++;
          continue;
        }
#endif
      else if ((flags & SD_GLOB) && c == LBRACK)
        {
          si = i + 1;
          if (string[si] == '\0')
            CQ_RETURN(si);

          temp = extract_delimited_string (string, &si, "[", "[", "]", SX_NOALLOC); /* ] */

          i = si;
          if (string[i] == '\0')        /* don't increment i past EOS in loop */
            break;
          i++;
          continue;
        }
      else if ((skipquote || invert) && (member (c, delims) == 0))
        break;
      else
        ADVANCE_CHAR (string, slen, i);
    }

  CQ_RETURN(i);
}

#if defined (BANG_HISTORY)
/* Skip to the history expansion character (delims[0]), paying attention to
   quoted strings and command and process substitution.  This is a stripped-
   down version of skip_to_delims.  The essential difference is that this
   resets the quoting state when starting a command substitution */
int
skip_to_histexp (string, start, delims, flags)
     char *string;
     int start;
     char *delims;
     int flags;
{
  int i, pass_next, backq, dquote, c, oldjmp;
  int histexp_comsub, histexp_backq, old_dquote;
  size_t slen;
  DECLARE_MBSTATE;

  slen = strlen (string + start) + start;
  oldjmp = no_longjmp_on_fatal_error;
  if (flags & SD_NOJMP)
    no_longjmp_on_fatal_error = 1;

  histexp_comsub = histexp_backq = old_dquote = 0;

  i = start;
  pass_next = backq = dquote = 0;
  while (c = string[i])
    {
      if (pass_next)
        {
          pass_next = 0;
          if (c == 0)
            CQ_RETURN(i);
          ADVANCE_CHAR (string, slen, i);
          continue;
        }
      else if (c == '\\')
        {
          pass_next = 1;
          i++;
          continue;
        }
      else if (backq && c == '`')
        {
          backq = 0;
          histexp_backq--;
          dquote = old_dquote;
          i++;
          continue;
        }
      else if (c == '`')
        {
          backq = 1;
          histexp_backq++;
          old_dquote = dquote;          /* simple - one level for now */
          dquote = 0;
          i++;
          continue;
        }
      /* When in double quotes, act as if the double quote is a member of
         history_no_expand_chars, like the history library does */
      else if (dquote && c == delims[0] && string[i+1] == '"')
        {
          i++;
          continue;
        }
      else if (c == delims[0])
        break;
      /* the usual case is to use skip_xxx_quoted, but we don't skip over double
         quoted strings when looking for the history expansion character as a
         delimiter. */
      else if (dquote && c == '\'')
        {
          i++;
          continue;
        }
      else if (c == '\'')
        i = skip_single_quoted (string, slen, ++i, 0);
      /* The posixly_correct test makes posix-mode shells allow double quotes
         to quote the history expansion character */
      else if (posixly_correct == 0 && c == '"')
        {
          dquote = 1 - dquote;
          i++;
          continue;
        }     
      else if (c == '"')
        i = skip_double_quoted (string, slen, ++i, 0);
#if defined (PROCESS_SUBSTITUTION)
      else if ((c == '$' || c == '<' || c == '>') && string[i+1] == LPAREN && string[i+2] != LPAREN)
#else
      else if (c == '$' && string[i+1] == LPAREN && string[i+2] != LPAREN)
#endif
        {
          if (string[i+2] == '\0')
            CQ_RETURN(i+2);
          i += 2;
          histexp_comsub++;
          old_dquote = dquote;
          dquote = 0;
        }
      else if (histexp_comsub && c == RPAREN)
        {
          histexp_comsub--;
          dquote = old_dquote;
          i++;
          continue;
        }
      else if (backq)           /* placeholder */
        {
          ADVANCE_CHAR (string, slen, i);
          continue;
        }
      else
        ADVANCE_CHAR (string, slen, i);
    }

  CQ_RETURN(i);
}
#endif /* BANG_HISTORY */

#if defined (READLINE)
/* Return 1 if the portion of STRING ending at EINDEX is quoted (there is
   an unclosed quoted string), or if the character at EINDEX is quoted
   by a backslash. NO_LONGJMP_ON_FATAL_ERROR is used to flag that the various
   single and double-quoted string parsing functions should not return an
   error if there are unclosed quotes or braces.  The characters that this
   recognizes need to be the same as the contents of
   rl_completer_quote_characters. */

int
char_is_quoted (string, eindex)
     char *string;
     int eindex;
{
  int i, pass_next, c, oldjmp;
  size_t slen;
  DECLARE_MBSTATE;

  slen = strlen (string);
  oldjmp = no_longjmp_on_fatal_error;
  no_longjmp_on_fatal_error = 1;
  i = pass_next = 0;

  /* If we have an open quoted string from a previous line, see if it's
     closed before string[eindex], so we don't interpret that close quote
     as starting a new quoted string. */
  if (current_command_line_count > 0 && dstack.delimiter_depth > 0)
    {
      c = dstack.delimiters[dstack.delimiter_depth - 1];
      if (c == '\'')
        i = skip_single_quoted (string, slen, 0, 0);
      else if (c == '"')
        i = skip_double_quoted (string, slen, 0, SX_COMPLETE);
      if (i > eindex)
        CQ_RETURN (1);
    }

  while (i <= eindex)
    {
      c = string[i];

      if (pass_next)
        {
          pass_next = 0;
          if (i >= eindex)      /* XXX was if (i >= eindex - 1) */
            CQ_RETURN(1);
          ADVANCE_CHAR (string, slen, i);
          continue;
        }
      else if (c == '\\')
        {
          pass_next = 1;
          i++;
          continue;
        }
      else if (c == '$' && string[i+1] == '\'' && string[i+2])
        {
          i += 2;
          i = skip_single_quoted (string, slen, i, SX_COMPLETE);
          if (i > eindex)
            CQ_RETURN (i);
        }
      else if (c == '\'' || c == '"')
        {
          i = (c == '\'') ? skip_single_quoted (string, slen, ++i, 0)
                          : skip_double_quoted (string, slen, ++i, SX_COMPLETE);
          if (i > eindex)
            CQ_RETURN(1);
          /* no increment, the skip_xxx functions go one past end */
        }
      else
        ADVANCE_CHAR (string, slen, i);
    }

  CQ_RETURN(0);
}

int
unclosed_pair (string, eindex, openstr)
     char *string;
     int eindex;
     char *openstr;
{
  int i, pass_next, openc, olen;
  size_t slen;
  DECLARE_MBSTATE;

  slen = strlen (string);
  olen = strlen (openstr);
  i = pass_next = openc = 0;
  while (i <= eindex)
    {
      if (pass_next)
        {
          pass_next = 0;
          if (i >= eindex)      /* XXX was if (i >= eindex - 1) */
            return 0;
          ADVANCE_CHAR (string, slen, i);
          continue;
        }
      else if (string[i] == '\\')
        {
          pass_next = 1;
          i++;
          continue;
        }
      else if (STREQN (string + i, openstr, olen))
        {
          openc = 1 - openc;
          i += olen;
        }
      /* XXX - may want to handle $'...' specially here */
      else if (string[i] == '\'' || string[i] == '"')
        {
          i = (string[i] == '\'') ? skip_single_quoted (string, slen, i, 0)
                                  : skip_double_quoted (string, slen, i, SX_COMPLETE);
          if (i > eindex)
            return 0;
        }
      else
        ADVANCE_CHAR (string, slen, i);
    }
  return (openc);
}

/* Split STRING (length SLEN) at DELIMS, and return a WORD_LIST with the
   individual words.  If DELIMS is NULL, the current value of $IFS is used
   to split the string, and the function follows the shell field splitting
   rules.  SENTINEL is an index to look for.  NWP, if non-NULL,
   gets the number of words in the returned list.  CWP, if non-NULL, gets
   the index of the word containing SENTINEL.  Non-whitespace chars in
   DELIMS delimit separate fields.  This is used by programmable completion. */
WORD_LIST *
split_at_delims (string, slen, delims, sentinel, flags, nwp, cwp)
     char *string;
     int slen;
     const char *delims;
     int sentinel, flags;
     int *nwp, *cwp;
{
  int ts, te, i, nw, cw, ifs_split, dflags;
  char *token, *d, *d2;
  WORD_LIST *ret, *tl;

  if (string == 0 || *string == '\0')
    {
      if (nwp)
        *nwp = 0;
      if (cwp)
        *cwp = 0;       
      return ((WORD_LIST *)NULL);
    }

  d = (delims == 0) ? ifs_value : (char *)delims;
  ifs_split = delims == 0;

  /* Make d2 the non-whitespace characters in delims */
  d2 = 0;
  if (delims)
    {
      size_t slength;
#if defined (HANDLE_MULTIBYTE)
      size_t mblength = 1;
#endif
      DECLARE_MBSTATE;

      slength = strlen (delims);
      d2 = (char *)xmalloc (slength + 1);
      i = ts = 0;
      while (delims[i])
        {
#if defined (HANDLE_MULTIBYTE)
          mbstate_t state_bak;
          state_bak = state;
          mblength = MBRLEN (delims + i, slength, &state);
          if (MB_INVALIDCH (mblength))
            state = state_bak;
          else if (mblength > 1)
            {
              memcpy (d2 + ts, delims + i, mblength);
              ts += mblength;
              i += mblength;
              slength -= mblength;
              continue;
            }
#endif
          if (whitespace (delims[i]) == 0)
            d2[ts++] = delims[i];

          i++;
          slength--;
        }
      d2[ts] = '\0';
    }

  ret = (WORD_LIST *)NULL;

  /* Remove sequences of whitespace characters at the start of the string, as
     long as those characters are delimiters. */
  for (i = 0; member (string[i], d) && spctabnl (string[i]); i++)
    ;
  if (string[i] == '\0')
    {
      FREE (d2);
      return (ret);
    }

  ts = i;
  nw = 0;
  cw = -1;
  dflags = flags|SD_NOJMP;
  while (1)
    {
      te = skip_to_delim (string, ts, d, dflags);

      /* If we have a non-whitespace delimiter character, use it to make a
         separate field.  This is just about what $IFS splitting does and
         is closer to the behavior of the shell parser. */
      if (ts == te && d2 && member (string[ts], d2))
        {
          te = ts + 1;
          /* If we're using IFS splitting, the non-whitespace delimiter char
             and any additional IFS whitespace delimits a field. */
          if (ifs_split)
            while (member (string[te], d) && spctabnl (string[te]) && ((flags&SD_NOQUOTEDELIM) == 0 || (string[te] != '\'' && string[te] != '"')))
              te++;
          else
            while (member (string[te], d2) && ((flags&SD_NOQUOTEDELIM) == 0 || (string[te] != '\'' && string[te] != '"')))
              te++;
        }

      token = substring (string, ts, te);

      ret = add_string_to_list (token, ret);    /* XXX */
      free (token);
      nw++;

      if (sentinel >= ts && sentinel <= te)
        cw = nw;

      /* If the cursor is at whitespace just before word start, set the
         sentinel word to the current word. */
      if (cwp && cw == -1 && sentinel == ts-1)
        cw = nw;

      /* If the cursor is at whitespace between two words, make a new, empty
         word, add it before (well, after, since the list is in reverse order)
         the word we just added, and set the current word to that one. */
      if (cwp && cw == -1 && sentinel < ts)
        {
          tl = make_word_list (make_word (""), ret->next);
          ret->next = tl;
          cw = nw;
          nw++;
        }

      if (string[te] == 0)
        break;

      i = te;
      /* XXX - honor SD_NOQUOTEDELIM here */
      while (member (string[i], d) && (ifs_split || spctabnl(string[i])) && ((flags&SD_NOQUOTEDELIM) == 0 || (string[te] != '\'' && string[te] != '"')))
        i++;

      if (string[i])
        ts = i;
      else
        break;
    }

  /* Special case for SENTINEL at the end of STRING.  If we haven't found
     the word containing SENTINEL yet, and the index we're looking for is at
     the end of STRING (or past the end of the previously-found token,
     possible if the end of the line is composed solely of IFS whitespace)
     add an additional null argument and set the current word pointer to that. */
  if (cwp && cw == -1 && (sentinel >= slen || sentinel >= te))
    {
      if (whitespace (string[sentinel - 1]))
        {
          token = "";
          ret = add_string_to_list (token, ret);
          nw++;
        }
      cw = nw;
    }

  if (nwp)
    *nwp = nw;
  if (cwp)
    *cwp = cw;

  FREE (d2);

  return (REVERSE_LIST (ret, WORD_LIST *));
}
#endif /* READLINE */

#if 0
/* UNUSED */
/* Extract the name of the variable to bind to from the assignment string. */
char *
assignment_name (string)
     char *string;
{
  int offset;
  char *temp;

  offset = assignment (string, 0);
  if (offset == 0)
    return (char *)NULL;
  temp = substring (string, 0, offset);
  return (temp);
}
#endif

/* **************************************************************** */
/*                                                                  */
/*     Functions to convert strings to WORD_LISTs and vice versa    */
/*                                                                  */
/* **************************************************************** */

/* Return a single string of all the words in LIST.  SEP is the separator
   to put between individual elements of LIST in the output string. */
char *
string_list_internal (list, sep)
     WORD_LIST *list;
     char *sep;
{
  register WORD_LIST *t;
  char *result, *r;
  size_t word_len, sep_len, result_size;

  if (list == 0)
    return ((char *)NULL);

  /* Short-circuit quickly if we don't need to separate anything. */
  if (list->next == 0)
    return (savestring (list->word->word));

  /* This is nearly always called with either sep[0] == 0 or sep[1] == 0. */
  sep_len = STRLEN (sep);
  result_size = 0;

  for (t = list; t; t = t->next)
    {
      if (t != list)
        result_size += sep_len;
      result_size += strlen (t->word->word);
    }

  r = result = (char *)xmalloc (result_size + 1);

  for (t = list; t; t = t->next)
    {
      if (t != list && sep_len)
        {
          if (sep_len > 1)
            {
              FASTCOPY (sep, r, sep_len);
              r += sep_len;
            }
          else
            *r++ = sep[0];
        }

      word_len = strlen (t->word->word);
      FASTCOPY (t->word->word, r, word_len);
      r += word_len;
    }

  *r = '\0';
  return (result);
}

/* Return a single string of all the words present in LIST, separating
   each word with a space. */
char *
string_list (list)
     WORD_LIST *list;
{
  return (string_list_internal (list, " "));
}

/* An external interface that can be used by the rest of the shell to
   obtain a string containing the first character in $IFS.  Handles all
   the multibyte complications.  If LENP is non-null, it is set to the
   length of the returned string. */
char *
ifs_firstchar (lenp)
     int *lenp;
{
  char *ret;
  int len;

  ret = xmalloc (MB_LEN_MAX + 1);
#if defined (HANDLE_MULTIBYTE)
  if (ifs_firstc_len == 1)
    {
      ret[0] = ifs_firstc[0];
      ret[1] = '\0';
      len = ret[0] ? 1 : 0;
    }
  else
    {
      memcpy (ret, ifs_firstc, ifs_firstc_len);
      ret[len = ifs_firstc_len] = '\0';
    }
#else
  ret[0] = ifs_firstc;
  ret[1] = '\0';
  len = ret[0] ? 0 : 1;
#endif

  if (lenp)
    *lenp = len;

  return ret;
}

/* Return a single string of all the words present in LIST, obeying the
   quoting rules for "$*", to wit: (P1003.2, draft 11, 3.5.2) "If the
   expansion [of $*] appears within a double quoted string, it expands
   to a single field with the value of each parameter separated by the
   first character of the IFS variable, or by a <space> if IFS is unset." */
/* Posix interpretation 888 changes this when IFS is null by specifying
   that when unquoted, this expands to separate arguments */
char *
string_list_dollar_star (list, quoted, flags)
     WORD_LIST *list;
     int quoted, flags;
{
  char *ret;
#if defined (HANDLE_MULTIBYTE)
#  if defined (__GNUC__)
  char sep[MB_CUR_MAX + 1];
#  else
  char *sep = 0;
#  endif
#else
  char sep[2];
#endif

#if defined (HANDLE_MULTIBYTE)
#  if !defined (__GNUC__)
  sep = (char *)xmalloc (MB_CUR_MAX + 1);
#  endif /* !__GNUC__ */
  if (ifs_firstc_len == 1)
    {
      sep[0] = ifs_firstc[0];
      sep[1] = '\0';
    }
  else
    {
      memcpy (sep, ifs_firstc, ifs_firstc_len);
      sep[ifs_firstc_len] = '\0';
    }
#else
  sep[0] = ifs_firstc;
  sep[1] = '\0';
#endif

  ret = string_list_internal (list, sep);
#if defined (HANDLE_MULTIBYTE) && !defined (__GNUC__)
  free (sep);
#endif
  return ret;
}

/* Turn $@ into a string.  If (quoted & (Q_HERE_DOCUMENT|Q_DOUBLE_QUOTES))
   is non-zero, the $@ appears within double quotes, and we should quote
   the list before converting it into a string.  If IFS is unset, and the
   word is not quoted, we just need to quote CTLESC and CTLNUL characters
   in the words in the list, because the default value of $IFS is
   <space><tab><newline>, IFS characters in the words in the list should
   also be split.  If IFS is null, and the word is not quoted, we need
   to quote the words in the list to preserve the positional parameters
   exactly.
   Valid values for the FLAGS argument are the PF_ flags in command.h,
   the only one we care about is PF_ASSIGNRHS.  $@ is supposed to expand
   to the positional parameters separated by spaces no matter what IFS is
   set to if in a context where word splitting is not performed.  The only
   one that we didn't handle before is assignment statement arguments to
   declaration builtins like `declare'. */
char *
string_list_dollar_at (list, quoted, flags)
     WORD_LIST *list;
     int quoted;
     int flags;
{
  char *ifs, *ret;
#if defined (HANDLE_MULTIBYTE)
#  if defined (__GNUC__)
  char sep[MB_CUR_MAX + 1];
#  else
  char *sep = 0;
#  endif /* !__GNUC__ */
#else
  char sep[2];
#endif
  WORD_LIST *tlist;

  /* XXX this could just be ifs = ifs_value; */
  ifs = ifs_var ? value_cell (ifs_var) : (char *)0;

#if defined (HANDLE_MULTIBYTE)
#  if !defined (__GNUC__)
  sep = (char *)xmalloc (MB_CUR_MAX + 1);
#  endif /* !__GNUC__ */
  /* XXX - testing PF_ASSIGNRHS to make sure positional parameters are
     separated with a space even when word splitting will not occur. */
  if (flags & PF_ASSIGNRHS)
    {
      sep[0] = ' ';
      sep[1] = '\0';
    }
  else if (ifs && *ifs)
    {
      if (ifs_firstc_len == 1)
        {
          sep[0] = ifs_firstc[0];
          sep[1] = '\0';
        }
      else
        {
          memcpy (sep, ifs_firstc, ifs_firstc_len);
          sep[ifs_firstc_len] = '\0';
        }
    }
  else
    {
      sep[0] = ' ';
      sep[1] = '\0';
    }
#else   /* !HANDLE_MULTIBYTE */
  /* XXX - PF_ASSIGNRHS means no word splitting, so we want positional
     parameters separated by a space. */
  sep[0] = ((flags & PF_ASSIGNRHS) || ifs == 0 || *ifs == 0) ? ' ' : *ifs;
  sep[1] = '\0';
#endif  /* !HANDLE_MULTIBYTE */

  /* XXX -- why call quote_list if ifs == 0?  we can get away without doing
     it now that quote_escapes quotes spaces */
  tlist = (quoted & (Q_HERE_DOCUMENT|Q_DOUBLE_QUOTES|Q_PATQUOTE))
                ? quote_list (list)
                : list_quote_escapes (list);

  ret = string_list_internal (tlist, sep);
#if defined (HANDLE_MULTIBYTE) && !defined (__GNUC__)
  free (sep);
#endif
  return ret;
}

/* Turn the positional parameters into a string, understanding quoting and
   the various subtleties of using the first character of $IFS as the
   separator.  Calls string_list_dollar_at, string_list_dollar_star, and
   string_list as appropriate. */
/* This needs to fully understand the additional contexts where word
   splitting does not occur (W_ASSIGNRHS, etc.) */
char *
string_list_pos_params (pchar, list, quoted, pflags)
     int pchar;
     WORD_LIST *list;
     int quoted, pflags;
{
  char *ret;
  WORD_LIST *tlist;

  if (pchar == '*' && (quoted & Q_DOUBLE_QUOTES))
    {
      tlist = quote_list (list);
      word_list_remove_quoted_nulls (tlist);
      ret = string_list_dollar_star (tlist, 0, 0);
    }
  else if (pchar == '*' && (quoted & Q_HERE_DOCUMENT))
    {
      tlist = quote_list (list);
      word_list_remove_quoted_nulls (tlist);
      ret = string_list (tlist);
    }
  else if (pchar == '*' && quoted == 0 && ifs_is_null)  /* XXX */
    ret = expand_no_split_dollar_star ? string_list_dollar_star (list, quoted, 0) : string_list_dollar_at (list, quoted, 0);    /* Posix interp 888 */
  else if (pchar == '*' && quoted == 0 && (pflags & PF_ASSIGNRHS))      /* XXX */
    ret = expand_no_split_dollar_star ? string_list_dollar_star (list, quoted, 0) : string_list_dollar_at (list, quoted, 0);    /* Posix interp 888 */
  else if (pchar == '*')
    {
      /* Even when unquoted, string_list_dollar_star does the right thing
         making sure that the first character of $IFS is used as the
         separator. */
      ret = string_list_dollar_star (list, quoted, 0);
    }
  else if (pchar == '@' && (quoted & (Q_HERE_DOCUMENT|Q_DOUBLE_QUOTES)))
    /* We use string_list_dollar_at, but only if the string is quoted, since
       that quotes the escapes if it's not, which we don't want.  We could
       use string_list (the old code did), but that doesn't do the right
       thing if the first character of $IFS is not a space.  We use
       string_list_dollar_star if the string is unquoted so we make sure that
       the elements of $@ are separated by the first character of $IFS for
       later splitting. */
    ret = string_list_dollar_at (list, quoted, 0);
  else if (pchar == '@' && quoted == 0 && ifs_is_null)  /* XXX */
    ret = string_list_dollar_at (list, quoted, 0);      /* Posix interp 888 */
  else if (pchar == '@' && quoted == 0 && (pflags & PF_ASSIGNRHS))
    ret = string_list_dollar_at (list, quoted, pflags); /* Posix interp 888 */
  else if (pchar == '@')
    ret = string_list_dollar_star (list, quoted, 0);
  else
    ret = string_list ((quoted & (Q_HERE_DOCUMENT|Q_DOUBLE_QUOTES)) ? quote_list (list) : list);

  return ret;
}

/* Return the list of words present in STRING.  Separate the string into
   words at any of the characters found in SEPARATORS.  If QUOTED is
   non-zero then word in the list will have its quoted flag set, otherwise
   the quoted flag is left as make_word () deemed fit.

   This obeys the P1003.2 word splitting semantics.  If `separators' is
   exactly <space><tab><newline>, then the splitting algorithm is that of
   the Bourne shell, which treats any sequence of characters from `separators'
   as a delimiter.  If IFS is unset, which results in `separators' being set
   to "", no splitting occurs.  If separators has some other value, the
   following rules are applied (`IFS white space' means zero or more
   occurrences of <space>, <tab>, or <newline>, as long as those characters
   are in `separators'):

        1) IFS white space is ignored at the start and the end of the
           string.
        2) Each occurrence of a character in `separators' that is not
           IFS white space, along with any adjacent occurrences of
           IFS white space delimits a field.
        3) Any nonzero-length sequence of IFS white space delimits a field.
   */

/* BEWARE!  list_string strips null arguments.  Don't call it twice and
   expect to have "" preserved! */

/* This performs word splitting and quoted null character removal on
   STRING. */
#define issep(c) \
        (((separators)[0]) ? ((separators)[1] ? isifs(c) \
                                              : (c) == (separators)[0]) \
                           : 0)

/* member of the space character class in the current locale */
#define ifs_whitespace(c)       ISSPACE(c)

/* "adjacent IFS white space" */
#define ifs_whitesep(c) ((sh_style_split || separators == 0) ? spctabnl (c) \
                                                             : ifs_whitespace (c))

WORD_LIST *
list_string (string, separators, quoted)
     register char *string, *separators;
     int quoted;
{
  WORD_LIST *result;
  WORD_DESC *t;
  char *current_word, *s;
  int sindex, sh_style_split, whitesep, xflags, free_word;
  size_t slen;

  if (!string || !*string)
    return ((WORD_LIST *)NULL);

  sh_style_split = separators && separators[0] == ' ' &&
                                 separators[1] == '\t' &&
                                 separators[2] == '\n' &&
                                 separators[3] == '\0';
  for (xflags = 0, s = ifs_value; s && *s; s++)
    {
      if (*s == CTLESC) xflags |= SX_NOCTLESC;
      else if (*s == CTLNUL) xflags |= SX_NOESCCTLNUL;
    }

  slen = 0;
  /* Remove sequences of whitespace at the beginning of STRING, as
     long as those characters appear in IFS.  Do not do this if
     STRING is quoted or if there are no separator characters. We use the
     Posix definition of whitespace as a member of the space character
     class in the current locale. */
#if 0
  if (!quoted || !separators || !*separators)
#else
  /* issep() requires that separators be non-null, and always returns 0 if
     separator is the empty string, so don't bother if we get an empty string
     for separators. We already returned NULL above if STRING is empty. */
  if (!quoted && separators && *separators)
#endif
    {
      for (s = string; *s && issep (*s) && ifs_whitespace (*s); s++);

      if (!*s)
        return ((WORD_LIST *)NULL);

      string = s;
    }

  /* OK, now STRING points to a word that does not begin with white space.
     The splitting algorithm is:
        extract a word, stopping at a separator
        skip sequences of whitespace characters as long as they are separators
     This obeys the field splitting rules in Posix.2. */
  slen = STRLEN (string);
  for (result = (WORD_LIST *)NULL, sindex = 0; string[sindex]; )
    {
      /* Don't need string length in ADVANCE_CHAR unless multibyte chars are
         possible, but need it in string_extract_verbatim for bounds checking */
      current_word = string_extract_verbatim (string, slen, &sindex, separators, xflags);
      if (current_word == 0)
        break;

      free_word = 1;    /* If non-zero, we free current_word */

      /* If we have a quoted empty string, add a quoted null argument.  We
         want to preserve the quoted null character iff this is a quoted
         empty string; otherwise the quoted null characters are removed
         below. */
      if (QUOTED_NULL (current_word))
        {
          t = alloc_word_desc ();
          t->word = make_quoted_char ('\0');
          t->flags |= W_QUOTED|W_HASQUOTEDNULL;
          result = make_word_list (t, result);
        }
      else if (current_word[0] != '\0')
        {
          /* If we have something, then add it regardless.  However,
             perform quoted null character removal on the current word. */
          remove_quoted_nulls (current_word);

          /* We don't want to set the word flags based on the string contents
             here -- that's mostly for the parser -- so we just allocate a
             WORD_DESC *, assign current_word (noting that we don't want to
             free it), and skip all of make_word. */
          t = alloc_word_desc ();
          t->word = current_word;
          result = make_word_list (t, result);
          free_word = 0;
          result->word->flags &= ~W_HASQUOTEDNULL;      /* just to be sure */
          if (quoted & (Q_DOUBLE_QUOTES|Q_HERE_DOCUMENT))
            result->word->flags |= W_QUOTED;
          /* If removing quoted null characters leaves an empty word, note
             that we saw this for the caller to act on. */
          if (current_word == 0 || current_word[0] == '\0')
            result->word->flags |= W_SAWQUOTEDNULL;
        }

      /* If we're not doing sequences of separators in the traditional
         Bourne shell style, then add a quoted null argument. */
      else if (!sh_style_split && !ifs_whitespace (string[sindex]))
        {
          t = alloc_word_desc ();
          t->word = make_quoted_char ('\0');
          t->flags |= W_QUOTED|W_HASQUOTEDNULL;
          result = make_word_list (t, result);
        }

      if (free_word)
        free (current_word);

      /* Note whether or not the separator is IFS whitespace, used later. */
      whitesep = string[sindex] && ifs_whitesep (string[sindex]);

      /* Move past the current separator character. */
      if (string[sindex])
        {
          DECLARE_MBSTATE;
          ADVANCE_CHAR (string, slen, sindex);
        }

      /* Now skip sequences of whitespace characters if they are
         in the list of separators. */
      while (string[sindex] && ifs_whitesep (string[sindex]) && issep (string[sindex]))
        sindex++;

      /* If the first separator was IFS whitespace and the current character
         is a non-whitespace IFS character, it should be part of the current
         field delimiter, not a separate delimiter that would result in an
         empty field.  Look at POSIX.2, 3.6.5, (3)(b). */
      if (string[sindex] && whitesep && issep (string[sindex]) && !ifs_whitesep (string[sindex]))
        {
          sindex++;
          /* An IFS character that is not IFS white space, along with any
             adjacent IFS white space, shall delimit a field. (SUSv3) */
          while (string[sindex] && ifs_whitesep (string[sindex]) && isifs (string[sindex]))
            sindex++;
        }
    }
  return (REVERSE_LIST (result, WORD_LIST *));
}

/* Parse a single word from STRING, using SEPARATORS to separate fields.
   ENDPTR is set to the first character after the word.  This is used by
   the `read' builtin.
   
   This is never called with SEPARATORS != $IFS, and takes advantage of that.

   XXX - this function is very similar to list_string; they should be
         combined - XXX */

/* character is in $IFS */
#define islocalsep(c)   (local_cmap[(unsigned char)(c)] != 0)

char *
get_word_from_string (stringp, separators, endptr)
     char **stringp, *separators, **endptr;
{
  register char *s;
  char *current_word;
  int sindex, sh_style_split, whitesep, xflags;
  unsigned char local_cmap[UCHAR_MAX+1];        /* really only need single-byte chars here */
  size_t slen;

  if (!stringp || !*stringp || !**stringp)
    return ((char *)NULL);

  sh_style_split = separators && separators[0] == ' ' &&
                                 separators[1] == '\t' &&
                                 separators[2] == '\n' &&
                                 separators[3] == '\0';
  memset (local_cmap, '\0', sizeof (local_cmap));
  for (xflags = 0, s = separators; s && *s; s++)
    {
      if (*s == CTLESC) xflags |= SX_NOCTLESC;
      if (*s == CTLNUL) xflags |= SX_NOESCCTLNUL;
      local_cmap[(unsigned char)*s] = 1;        /* local charmap of separators */
    }

  s = *stringp;
  slen = 0;

  /* Remove sequences of whitespace at the beginning of STRING, as
     long as those characters appear in SEPARATORS.  This happens if
     SEPARATORS == $' \t\n' or if IFS is unset. */
  if (sh_style_split || separators == 0)
    for (; *s && spctabnl (*s) && islocalsep (*s); s++);
  else
    for (; *s && ifs_whitespace (*s) && islocalsep (*s); s++);

  /* If the string is nothing but whitespace, update it and return. */
  if (!*s)
    {
      *stringp = s;
      if (endptr)
        *endptr = s;
      return ((char *)NULL);
    }

  /* OK, S points to a word that does not begin with white space.
     Now extract a word, stopping at a separator, save a pointer to
     the first character after the word, then skip sequences of spc,
     tab, or nl as long as they are separators.

     This obeys the field splitting rules in Posix.2. */
  sindex = 0;
  /* Don't need string length in ADVANCE_CHAR unless multibyte chars are
     possible, but need it in string_extract_verbatim for bounds checking */
  slen = STRLEN (s);
  current_word = string_extract_verbatim (s, slen, &sindex, separators, xflags);

  /* Set ENDPTR to the first character after the end of the word. */
  if (endptr)
    *endptr = s + sindex;

  /* Note whether or not the separator is IFS whitespace, used later. */
  whitesep = s[sindex] && ifs_whitesep (s[sindex]);

  /* Move past the current separator character. */
  if (s[sindex])
    {
      DECLARE_MBSTATE;
      ADVANCE_CHAR (s, slen, sindex);
    }

  /* Now skip sequences of space, tab, or newline characters if they are
     in the list of separators. */
  while (s[sindex] && spctabnl (s[sindex]) && islocalsep (s[sindex]))
    sindex++;

  /* If the first separator was IFS whitespace and the current character is
     a non-whitespace IFS character, it should be part of the current field
     delimiter, not a separate delimiter that would result in an empty field.
     Look at POSIX.2, 3.6.5, (3)(b). */
  if (s[sindex] && whitesep && islocalsep (s[sindex]) && !ifs_whitesep (s[sindex]))
    {
      sindex++;
      /* An IFS character that is not IFS white space, along with any adjacent
         IFS white space, shall delimit a field. */
      while (s[sindex] && ifs_whitesep (s[sindex]) && islocalsep(s[sindex]))
        sindex++;
    }

  /* Update STRING to point to the next field. */
  *stringp = s + sindex;
  return (current_word);
}

/* Remove IFS white space at the end of STRING.  Start at the end
   of the string and walk backwards until the beginning of the string
   or we find a character that's not IFS white space and not CTLESC.
   Only let CTLESC escape a white space character if SAW_ESCAPE is
   non-zero.  */
char *
strip_trailing_ifs_whitespace (string, separators, saw_escape)
     char *string, *separators;
     int saw_escape;
{
  char *s;

  s = string + STRLEN (string) - 1;
  while (s > string && ((spctabnl (*s) && isifs (*s)) ||
                        (saw_escape && *s == CTLESC && spctabnl (s[1]))))
    s--;
  *++s = '\0';
  return string;
}

#if 0
/* UNUSED */
/* Split STRING into words at whitespace.  Obeys shell-style quoting with
   backslashes, single and double quotes. */
WORD_LIST *
list_string_with_quotes (string)
     char *string;
{
  WORD_LIST *list;
  char *token, *s;
  size_t s_len;
  int c, i, tokstart, len;

  for (s = string; s && *s && spctabnl (*s); s++)
    ;
  if (s == 0 || *s == 0)
    return ((WORD_LIST *)NULL);

  s_len = strlen (s);
  tokstart = i = 0;
  list = (WORD_LIST *)NULL;
  while (1)
    {
      c = s[i];
      if (c == '\\')
        {
          i++;
          if (s[i])
            i++;
        }
      else if (c == '\'')
        i = skip_single_quoted (s, s_len, ++i, 0);
      else if (c == '"')
        i = skip_double_quoted (s, s_len, ++i, 0);
      else if (c == 0 || spctabnl (c))
        {
          /* We have found the end of a token.  Make a word out of it and
             add it to the word list. */
          token = substring (s, tokstart, i);
          list = add_string_to_list (token, list);
          free (token);
          while (spctabnl (s[i]))
            i++;
          if (s[i])
            tokstart = i;
          else
            break;
        }
      else
        i++;    /* normal character */
    }
  return (REVERSE_LIST (list, WORD_LIST *));
}
#endif

/********************************************************/
/*                                                      */
/*      Functions to perform assignment statements      */
/*                                                      */
/********************************************************/

#if defined (ARRAY_VARS)
static SHELL_VAR *
do_compound_assignment (name, value, flags)
     char *name, *value;
     int flags;
{
  SHELL_VAR *v;
  int mklocal, mkassoc, mkglobal, chklocal;
  WORD_LIST *list;
  char *newname;        /* used for local nameref references */

  mklocal = flags & ASS_MKLOCAL;
  mkassoc = flags & ASS_MKASSOC;
  mkglobal = flags & ASS_MKGLOBAL;
  chklocal = flags & ASS_CHKLOCAL;

  if (mklocal && variable_context)
    {
      v = find_variable (name);         /* follows namerefs */
      newname = (v == 0) ? nameref_transform_name (name, flags) : v->name;
      if (v && ((readonly_p (v) && (flags & ASS_FORCE) == 0) || noassign_p (v)))
        {
          if (readonly_p (v))
            err_readonly (name);
          return (v);   /* XXX */
        }
      list = expand_compound_array_assignment (v, value, flags);
      if (mkassoc)
        v = make_local_assoc_variable (newname, 0);
      else if (v == 0 || (array_p (v) == 0 && assoc_p (v) == 0) || v->context != variable_context)
        v = make_local_array_variable (newname, 0);
      if (v)
        assign_compound_array_list (v, list, flags);
      if (list)
        dispose_words (list);
    }
  /* In a function but forcing assignment in global context. CHKLOCAL means to
     check for an existing local variable first. */
  else if (mkglobal && variable_context)
    {
      v = chklocal ? find_variable (name) : 0;
      if (v && (local_p (v) == 0 || v->context != variable_context))
        v = 0;
      if (v == 0)
        v = find_global_variable (name);
      if (v && ((readonly_p (v) && (flags & ASS_FORCE) == 0) || noassign_p (v)))
        {
          if (readonly_p (v))
            err_readonly (name);
          return (v);   /* XXX */
        }
      /* sanity check */
      newname = (v == 0) ? nameref_transform_name (name, flags) : name;
      list = expand_compound_array_assignment (v, value, flags);
      if (v == 0 && mkassoc)
        v = make_new_assoc_variable (newname);
      else if (v && mkassoc && assoc_p (v) == 0)
        v = convert_var_to_assoc (v);
      else if (v == 0)
        v = make_new_array_variable (newname);
      else if (v && mkassoc == 0 && array_p (v) == 0)
        v = convert_var_to_array (v);
      if (v)
        assign_compound_array_list (v, list, flags);
      if (list)
        dispose_words (list);
    }
  else
    {
      v = assign_array_from_string (name, value, flags);
      if (v && ((readonly_p (v) && (flags & ASS_FORCE) == 0) || noassign_p (v)))
        {
          if (readonly_p (v))
            err_readonly (name);
          return (v);   /* XXX */
        }
    }

  return (v);
}
#endif

/* Given STRING, an assignment string, get the value of the right side
   of the `=', and bind it to the left side.  If EXPAND is true, then
   perform parameter expansion, command substitution, and arithmetic
   expansion on the right-hand side.  Perform tilde expansion in any
   case.  Do not perform word splitting on the result of expansion. */
static int
do_assignment_internal (word, expand)
     const WORD_DESC *word;
     int expand;
{
  int offset, appendop, assign_list, aflags, retval;
  char *name, *value, *temp;
  SHELL_VAR *entry;
#if defined (ARRAY_VARS)
  char *t;
  int ni;
#endif
  const char *string;

  if (word == 0 || word->word == 0)
    return 0;

  appendop = assign_list = aflags = 0;
  string = word->word;
  offset = assignment (string, 0);
  name = savestring (string);
  value = (char *)NULL;

  if (name[offset] == '=')
    {
      if (name[offset - 1] == '+')
        {
          appendop = 1;
          name[offset - 1] = '\0';
        }

      name[offset] = 0;         /* might need this set later */
      temp = name + offset + 1;

#if defined (ARRAY_VARS)
      if (expand && (word->flags & W_COMPASSIGN))
        {
          assign_list = ni = 1;
          value = extract_array_assignment_list (temp, &ni);
        }
      else
#endif
      if (expand && temp[0])
        value = expand_string_if_necessary (temp, 0, expand_string_assignment);
      else
        value = savestring (temp);
    }

  if (value == 0)
    {
      value = (char *)xmalloc (1);
      value[0] = '\0';
    }

  if (echo_command_at_execute)
    {
      if (appendop)
        name[offset - 1] = '+';
      xtrace_print_assignment (name, value, assign_list, 1);
      if (appendop)
        name[offset - 1] = '\0';
    }

#define ASSIGN_RETURN(r)        do { FREE (value); free (name); return (r); } while (0)

  if (appendop)
    aflags |= ASS_APPEND;

#if defined (ARRAY_VARS)
  if (t = mbschr (name, LBRACK))
    {
      if (assign_list)
        {
          report_error (_("%s: cannot assign list to array member"), name);
          ASSIGN_RETURN (0);
        }
      aflags |= ASS_ALLOWALLSUB;        /* allow a[@]=value for existing associative arrays */
      entry = assign_array_element (name, value, aflags, (array_eltstate_t *)0);
      if (entry == 0)
        ASSIGN_RETURN (0);
    }
  else if (assign_list)
    {
      if ((word->flags & W_ASSIGNARG) && (word->flags & W_CHKLOCAL))
        aflags |= ASS_CHKLOCAL;
      if ((word->flags & W_ASSIGNARG) && (word->flags & W_ASSNGLOBAL) == 0)
        aflags |= ASS_MKLOCAL;
      if ((word->flags & W_ASSIGNARG) && (word->flags & W_ASSNGLOBAL))
        aflags |= ASS_MKGLOBAL;
      if (word->flags & W_ASSIGNASSOC)
        aflags |= ASS_MKASSOC;
      entry = do_compound_assignment (name, value, aflags);
    }
  else
#endif /* ARRAY_VARS */
  entry = bind_variable (name, value, aflags);

  if (entry)
    stupidly_hack_special_variables (entry->name);      /* might be a nameref */
  else
    stupidly_hack_special_variables (name);

  /* Return 1 if the assignment seems to have been performed correctly. */
  if (entry == 0 || readonly_p (entry))
    retval = 0;         /* assignment failure */
  else if (noassign_p (entry))
    {
      set_exit_status (EXECUTION_FAILURE);
      retval = 1;       /* error status, but not assignment failure */
    }
  else
    retval = 1;

  if (entry && retval != 0 && noassign_p (entry) == 0)
    VUNSETATTR (entry, att_invisible);

  ASSIGN_RETURN (retval);
}

/* Perform the assignment statement in STRING, and expand the
   right side by doing tilde, command and parameter expansion. */
int
do_assignment (string)
     char *string;
{
  WORD_DESC td;

  td.flags = W_ASSIGNMENT;
  td.word = string;

  return do_assignment_internal (&td, 1);
}

int
do_word_assignment (word, flags)
     WORD_DESC *word;
     int flags;
{
  return do_assignment_internal (word, 1);
}

/* Given STRING, an assignment string, get the value of the right side
   of the `=', and bind it to the left side.  Do not perform any word
   expansions on the right hand side. */
int
do_assignment_no_expand (string)
     char *string;
{
  WORD_DESC td;

  td.flags = W_ASSIGNMENT;
  td.word = string;

  return (do_assignment_internal (&td, 0));
}

/***************************************************
 *                                                 *
 *  Functions to manage the positional parameters  *
 *                                                 *
 ***************************************************/

/* Return the word list that corresponds to `$*'. */
WORD_LIST *
list_rest_of_args ()
{
  register WORD_LIST *list, *args;
  int i;

  /* Break out of the loop as soon as one of the dollar variables is null. */
  for (i = 1, list = (WORD_LIST *)NULL; i < 10 && dollar_vars[i]; i++)
    list = make_word_list (make_bare_word (dollar_vars[i]), list);

  for (args = rest_of_args; args; args = args->next)
    list = make_word_list (make_bare_word (args->word->word), list);

  return (REVERSE_LIST (list, WORD_LIST *));
}

/* Return the value of a positional parameter.  This handles values > 10. */
char *
get_dollar_var_value (ind)
     intmax_t ind;
{
  char *temp;
  WORD_LIST *p;

  if (ind < 10)
    temp = dollar_vars[ind] ? savestring (dollar_vars[ind]) : (char *)NULL;
  else  /* We want something like ${11} */
    {
      ind -= 10;
      for (p = rest_of_args; p && ind--; p = p->next)
        ;
      temp = p ? savestring (p->word->word) : (char *)NULL;
    }
  return (temp);
}

/* Make a single large string out of the dollar digit variables,
   and the rest_of_args.  If DOLLAR_STAR is 1, then obey the special
   case of "$*" with respect to IFS. */
char *
string_rest_of_args (dollar_star)
     int dollar_star;
{
  register WORD_LIST *list;
  char *string;

  list = list_rest_of_args ();
  string = dollar_star ? string_list_dollar_star (list, 0, 0) : string_list (list);
  dispose_words (list);
  return (string);
}

/* Return a string containing the positional parameters from START to
   END, inclusive.  If STRING[0] == '*', we obey the rules for $*,
   which only makes a difference if QUOTED is non-zero.  If QUOTED includes
   Q_HERE_DOCUMENT or Q_DOUBLE_QUOTES, this returns a quoted list, otherwise
   no quoting chars are added. */
static char *
pos_params (string, start, end, quoted, pflags)
     char *string;
     int start, end, quoted, pflags;
{
  WORD_LIST *save, *params, *h, *t;
  char *ret;
  int i;

  /* see if we can short-circuit.  if start == end, we want 0 parameters. */
  if (start == end)
    return ((char *)NULL);

  save = params = list_rest_of_args ();
  if (save == 0 && start > 0)
    return ((char *)NULL);

  if (start == 0)               /* handle ${@:0[:x]} specially */
    {
      t = make_word_list (make_word (dollar_vars[0]), params);
      save = params = t;
    }

  for (i = start ? 1 : 0; params && i < start; i++)
    params = params->next;
  if (params == 0)
    {
      dispose_words (save);
      return ((char *)NULL);
    }
  for (h = t = params; params && i < end; i++)
    {
      t = params;
      params = params->next;
    }
  t->next = (WORD_LIST *)NULL;

  ret = string_list_pos_params (string[0], h, quoted, pflags);

  if (t != params)
    t->next = params;

  dispose_words (save);
  return (ret);
}

/******************************************************************/
/*                                                                */
/*      Functions to expand strings to strings or WORD_LISTs      */
/*                                                                */
/******************************************************************/

#if defined (PROCESS_SUBSTITUTION)
#define EXP_CHAR(s) (s == '$' || s == '`' || s == '<' || s == '>' || s == CTLESC || s == '~')
#else
#define EXP_CHAR(s) (s == '$' || s == '`' || s == CTLESC || s == '~')
#endif

/* If there are any characters in STRING that require full expansion,
   then call FUNC to expand STRING; otherwise just perform quote
   removal if necessary.  This returns a new string. */
static char *
expand_string_if_necessary (string, quoted, func)
     char *string;
     int quoted;
     EXPFUNC *func;
{
  WORD_LIST *list;
  size_t slen;
  int i, saw_quote;
  char *ret;
  DECLARE_MBSTATE;

  /* Don't need string length for ADVANCE_CHAR unless multibyte chars possible. */
  slen = (MB_CUR_MAX > 1) ? strlen (string) : 0;
  i = saw_quote = 0;
  while (string[i])
    {
      if (EXP_CHAR (string[i]))
        break;
      else if (string[i] == '\'' || string[i] == '\\' || string[i] == '"')
        saw_quote = 1;
      ADVANCE_CHAR (string, slen, i);
    }

  if (string[i])
    {
      list = (*func) (string, quoted);
      if (list)
        {
          ret = string_list (list);
          dispose_words (list);
        }
      else
        ret = (char *)NULL;
    }
  else if (saw_quote && ((quoted & (Q_HERE_DOCUMENT|Q_DOUBLE_QUOTES)) == 0))
    ret = string_quote_removal (string, quoted);
  else
    ret = savestring (string);

  return ret;
}

static inline char *
expand_string_to_string_internal (string, quoted, func)
     char *string;
     int quoted;
     EXPFUNC *func;
{
  WORD_LIST *list;
  char *ret;

  if (string == 0 || *string == '\0')
    return ((char *)NULL);

  list = (*func) (string, quoted);
  if (list)
    {
      ret = string_list (list);
      dispose_words (list);
    }
  else
    ret = (char *)NULL;

  return (ret);
}

char *
expand_string_to_string (string, quoted)
     char *string;
     int quoted;
{
  return (expand_string_to_string_internal (string, quoted, expand_string));
}

char *
expand_string_unsplit_to_string (string, quoted)
     char *string;
     int quoted;
{
  return (expand_string_to_string_internal (string, quoted, expand_string_unsplit));
}

char *
expand_assignment_string_to_string (string, quoted)
     char *string;
     int quoted;
{
  return (expand_string_to_string_internal (string, quoted, expand_string_assignment));
}

/* Kind of like a combination of dequote_string and quote_string_for_globbing;
   try to remove CTLESC quoting characters and convert CTLESC escaping a `&'
   or a backslash into a backslash. The output of this function must eventually
   be processed by strcreplace(). */
static char *
quote_string_for_repl (string, flags)
     char *string;
     int flags;
{
  size_t slen;
  char *result, *t;
  const char *s, *send;
  DECLARE_MBSTATE;

  slen = strlen (string);
  send = string + slen;

  result = (char *)xmalloc (slen * 2 + 1);

  if (string[0] == CTLESC && string[1] == 0)
    {
      result[0] = CTLESC;
      result[1] = '\0';
      return (result);
    }

  /* This is awkward. We want to translate CTLESC-\ to \\ if we will
     eventually send this string through strcreplace(), which we will do
     only if shouldexp_replacement() determines that there is something
     to replace. We can either make sure to escape backslashes here and
     have shouldexp_replacement() signal that we should send the string to
     strcreplace() if it sees an escaped backslash, or we can scan the
     string before copying it and turn CTLESC-\ into \\ only if we encounter
     a CTLESC-& or a &. This does the former and changes shouldexp_replacement().
     If we double the backslashes  here, we'll get doubled backslashes in any
     result that doesn't get passed to strcreplace(). */

  for (s = string, t = result; *s; )
    {
      /* This function's result has to be processed by strcreplace() */
      if (*s == CTLESC && (s[1] == '&' || s[1] == '\\'))
        {
          *t++ = '\\';
          s++;
          *t++ = *s++;
          continue;
        }
      /* Dequote it */
      if (*s == CTLESC)
        {
          s++;
          if (*s == '\0')
            break;
        }
      COPY_CHAR_P (t, s, send);
    }

  *t = '\0';
  return (result);
}
        
/* This does not perform word splitting on the WORD_LIST it returns and
   it treats $* as if it were quoted. It dequotes the WORD_LIST, adds
   backslash escapes before CTLESC-quoted backslash and `& if 
   patsub_replacement is enabled. */
static char *
expand_string_for_patsub (string, quoted)
     char *string;
     int quoted;
{
  WORD_LIST *value;
  char *ret, *t;

  if (string == 0 || *string == '\0')
    return (char *)NULL;

  value = expand_string_for_pat (string, quoted, (int *)0, (int *)0);

  if (value && value->word)
    {
      remove_quoted_nulls (value->word->word);  /* XXX */
      value->word->flags &= ~W_HASQUOTEDNULL;
    }

  if (value)
    {
      t = (value->next) ? string_list (value) : value->word->word;
      ret = quote_string_for_repl (t, quoted);
      if (t != value->word->word)
        free (t);
      dispose_words (value);
    }
  else
    ret = (char *)NULL;

  return (ret);
}

char *
expand_arith_string (string, quoted)
     char *string;
     int quoted;
{
  WORD_DESC td;
  WORD_LIST *list, *tlist;
  size_t slen;
  int i, saw_quote;
  char *ret;
  DECLARE_MBSTATE;

  /* Don't need string length for ADVANCE_CHAR unless multibyte chars possible. */
  slen = (MB_CUR_MAX > 1) ? strlen (string) : 0;
  i = saw_quote = 0;
  while (string[i])
    {
      if (EXP_CHAR (string[i]))
        break;
      else if (string[i] == '\'' || string[i] == '\\' || string[i] == '"')
        saw_quote = string[i];
      ADVANCE_CHAR (string, slen, i);
    }

  if (string[i])
    {
      /* This is expanded version of expand_string_internal as it's called by
         expand_string_leave_quoted  */
      td.flags = W_NOPROCSUB|W_NOTILDE; /* don't want process substitution or tilde expansion */
#if 0   /* TAG: bash-5.2 */
      if (quoted & Q_ARRAYSUB)
        td.flags |= W_NOCOMSUB;
#endif
      td.word = savestring (string);
      list = call_expand_word_internal (&td, quoted, 0, (int *)NULL, (int *)NULL);
      /* This takes care of the calls from expand_string_leave_quoted and
         expand_string */
      if (list)
        {
          tlist = word_list_split (list);
          dispose_words (list);
          list = tlist;
          if (list)
            dequote_list (list);
        }
      /* This comes from expand_string_if_necessary */
      if (list)
        {
          ret = string_list (list);
          dispose_words (list);
        }
      else
        ret = (char *)NULL;
      FREE (td.word);
    }
  else if (saw_quote && (quoted & Q_ARITH))
    ret = string_quote_removal (string, quoted);
  else if (saw_quote && ((quoted & (Q_HERE_DOCUMENT|Q_DOUBLE_QUOTES)) == 0))
    ret = string_quote_removal (string, quoted);
  else
    ret = savestring (string);

  return ret;
}

#if defined (COND_COMMAND)
/* Just remove backslashes in STRING.  Returns a new string. */
char *
remove_backslashes (string)
     char *string;
{
  char *r, *ret, *s;

  r = ret = (char *)xmalloc (strlen (string) + 1);
  for (s = string; s && *s; )
    {
      if (*s == '\\')
        s++;
      if (*s == 0)
        break;
      *r++ = *s++;
    }
  *r = '\0';
  return ret;
}

/* This needs better error handling. */
/* Expand W for use as an argument to a unary or binary operator in a
   [[...]] expression.  If SPECIAL is 1, this is the rhs argument
   to the != or == operator, and should be treated as a pattern.  In
   this case, we quote the string specially for the globbing code.  If
   SPECIAL is 2, this is an rhs argument for the =~ operator, and should
   be quoted appropriately for regcomp/regexec.  If SPECIAL is 3, this is
   an array subscript and should be quoted after expansion so it's only
   expanded once (Q_ARITH). The caller is responsible
   for removing the backslashes if the unquoted word is needed later. In
   any case, since we don't perform word splitting, we need to do quoted
   null character removal. */
char *
cond_expand_word (w, special)
     WORD_DESC *w;
     int special;
{
  char *r, *p;
  WORD_LIST *l;
  int qflags;

  if (w->word == 0 || w->word[0] == '\0')
    return ((char *)NULL);

  expand_no_split_dollar_star = 1;
  w->flags |= W_NOSPLIT2;
  qflags = (special == 3) ? Q_ARITH : 0;
  l = call_expand_word_internal (w, qflags, 0, (int *)0, (int *)0);
  expand_no_split_dollar_star = 0;
  if (l)
    {
      if (special == 0)                 /* LHS */
        {
          if (l->word)
            word_list_remove_quoted_nulls (l);
          dequote_list (l);
          r = string_list (l);
        }
      else if (special == 3)            /* arithmetic expression, Q_ARITH */
        {
          if (l->word)
            word_list_remove_quoted_nulls (l);  /* for now */
          dequote_list (l);
          r = string_list (l);
        }
      else
        {
          /* Need to figure out whether or not we should call dequote_escapes
             or a new dequote_ctlnul function here, and under what
             circumstances. */
          qflags = QGLOB_CVTNULL|QGLOB_CTLESC;
          if (special == 2)
            qflags |= QGLOB_REGEXP;
          word_list_remove_quoted_nulls (l);
          p = string_list (l);
          r = quote_string_for_globbing (p, qflags);
          free (p);
        }
      dispose_words (l);
    }
  else
    r = (char *)NULL;

  return r;
}
#endif

/* Expand $'...' and $"..." in a string for code paths that don't do it. The
   FLAGS argument is 1 if this function should treat CTLESC as a quote
   character (e.g., for here-documents) or not (e.g., for shell_expand_line). */
char *
expand_string_dollar_quote (string, flags)
     char *string;
     int flags;
{
  size_t slen, retind, retsize;
  int sindex, c, translen, peekc, news;
  char *ret, *trans, *send, *t;
  DECLARE_MBSTATE;

  slen = strlen (string);
  send = string + slen;
  sindex = 0;

  retsize = slen + 1;
  ret = xmalloc (retsize);
  retind = 0;

  while (c = string[sindex])
    {
      switch (c)
        {
        default:
          RESIZE_MALLOCED_BUFFER (ret, retind, locale_mb_cur_max + 1, retsize, 64);
          COPY_CHAR_I (ret, retind, string, send, sindex);
          break;

        case '\\':
          RESIZE_MALLOCED_BUFFER (ret, retind, locale_mb_cur_max + 2, retsize, 64);
          ret[retind++] = string[sindex++];

          if (string[sindex])
            COPY_CHAR_I (ret, retind, string, send, sindex);
          break;

        case '\'':
        case '"':
          if (c == '\'')
            news = skip_single_quoted (string, slen, ++sindex, SX_COMPLETE);
          else
            news = skip_double_quoted (string, slen, ++sindex, SX_COMPLETE);
          translen = news - sindex - 1;
          RESIZE_MALLOCED_BUFFER (ret, retind, translen + 3, retsize, 64);
          ret[retind++] = c;
          if (translen > 0)
            {
              strncpy (ret + retind, string + sindex, translen);
              retind += translen;
            }
          if (news > sindex && string[news - 1] == c)
            ret[retind++] = c;
          sindex = news;
          break;

        case CTLESC:
          RESIZE_MALLOCED_BUFFER (ret, retind, locale_mb_cur_max + 2, retsize, 64);
          if (flags)
            ret[retind++] = string[sindex++];
          if (string[sindex])
            COPY_CHAR_I (ret, retind, string, send, sindex);
          break;

        case '$':
          peekc = string[++sindex];
#if defined (TRANSLATABLE_STRINGS)
          if (peekc != '\'' && peekc != '"')
#else
          if (peekc != '\'')
#endif
            {
              RESIZE_MALLOCED_BUFFER (ret, retind, 2, retsize, 16);
              ret[retind++] = c;
              break;
            }
          if (string[sindex + 1] == '\0')       /* don't bother */      
            {
              RESIZE_MALLOCED_BUFFER (ret, retind, 3, retsize, 16);
              ret[retind++] = c;
              ret[retind++] = peekc;
              sindex++;
              break;
            }
          if (peekc == '\'')
            {
              /* SX_COMPLETE is the  equivalent of ALLOWESC here */
              /* We overload SX_COMPLETE below */
              news = skip_single_quoted (string, slen, ++sindex, SX_COMPLETE);
              /* Check for unclosed string and don't bother if so */
              if (news > sindex && string[news] == '\0' && string[news-1] != peekc)
                {
                  RESIZE_MALLOCED_BUFFER (ret, retind, 3, retsize, 16);
                  ret[retind++] = c;
                  ret[retind++] = peekc;
                  continue;
                }
              t = substring (string, sindex, news - 1);
              trans = ansiexpand (t, 0, news-sindex-1, &translen);
              free (t);
              t = sh_single_quote (trans);
              sindex = news;
            }
#if defined (TRANSLATABLE_STRINGS)
          else
            {
              news = ++sindex;
              t = string_extract_double_quoted (string, &news, SX_COMPLETE);
              /* Check for unclosed string and don't bother if so */
              if (news > sindex && string[news] == '\0' && string[news-1] != peekc)
                {
                  RESIZE_MALLOCED_BUFFER (ret, retind, 3, retsize, 16);
                  ret[retind++] = c;
                  ret[retind++] = peekc;
                  free (t);
                  continue;
                }
              trans = locale_expand (t, 0, news-sindex, 0, &translen);
              free (t);
              if (singlequote_translations &&
                    ((news-sindex-1) != translen || STREQN (t, trans, translen) == 0))
                t = sh_single_quote (trans);
              else
                t = sh_mkdoublequoted (trans, translen, 0);
              sindex = news;
            }
#endif /* TRANSLATABLE_STRINGS */
          free (trans);
          trans = t;
          translen = strlen (trans);

          RESIZE_MALLOCED_BUFFER (ret, retind, translen + 1, retsize, 128);
          strcpy (ret + retind, trans);
          retind += translen;
          FREE (trans);
          break;
        }
    }

  ret[retind] = 0;
  return ret;
}

/* Call expand_word_internal to expand W and handle error returns.
   A convenience function for functions that don't want to handle
   any errors or free any memory before aborting. */
static WORD_LIST *
call_expand_word_internal (w, q, i, c, e)
     WORD_DESC *w;
     int q, i, *c, *e;
{
  WORD_LIST *result;

  result = expand_word_internal (w, q, i, c, e);
  if (result == &expand_word_error || result == &expand_word_fatal)
    {
      /* By convention, each time this error is returned, w->word has
         already been freed (it sometimes may not be in the fatal case,
         but that doesn't result in a memory leak because we're going
         to exit in most cases). */
      w->word = (char *)NULL;
      last_command_exit_value = EXECUTION_FAILURE;
      exp_jump_to_top_level ((result == &expand_word_error) ? DISCARD : FORCE_EOF);
      /* NOTREACHED */
      return (NULL);
    }
  else
    return (result);
}

/* Perform parameter expansion, command substitution, and arithmetic
   expansion on STRING, as if it were a word.  Leave the result quoted.
   Since this does not perform word splitting, it leaves quoted nulls
   in the result.  */
static WORD_LIST *
expand_string_internal (string, quoted)
     char *string;
     int quoted;
{
  WORD_DESC td;
  WORD_LIST *tresult;

  if (string == 0 || *string == 0)
    return ((WORD_LIST *)NULL);

  td.flags = 0;
  td.word = savestring (string);

  tresult = call_expand_word_internal (&td, quoted, 0, (int *)NULL, (int *)NULL);

  FREE (td.word);
  return (tresult);
}

/* Expand STRING by performing parameter expansion, command substitution,
   and arithmetic expansion.  Dequote the resulting WORD_LIST before
   returning it, but do not perform word splitting.  The call to
   remove_quoted_nulls () is in here because word splitting normally
   takes care of quote removal. */
WORD_LIST *
expand_string_unsplit (string, quoted)
     char *string;
     int quoted;
{
  WORD_LIST *value;

  if (string == 0 || *string == '\0')
    return ((WORD_LIST *)NULL);

  expand_no_split_dollar_star = 1;
  value = expand_string_internal (string, quoted);
  expand_no_split_dollar_star = 0;

  if (value)
    {
      if (value->word)
        {
          remove_quoted_nulls (value->word->word);      /* XXX */
          value->word->flags &= ~W_HASQUOTEDNULL;
        }
      dequote_list (value);
    }
  return (value);
}

/* Expand the rhs of an assignment statement */
WORD_LIST *
expand_string_assignment (string, quoted)
     char *string;
     int quoted;
{
  WORD_DESC td;
  WORD_LIST *value;

  if (string == 0 || *string == '\0')
    return ((WORD_LIST *)NULL);

  expand_no_split_dollar_star = 1;

#if 0
  /* Other shells (ksh93) do it this way, which affects how $@ is expanded
     in constructs like bar=${@#0} (preserves the spaces resulting from the
     expansion of $@ in a context where you don't do word splitting); Posix
     interp 888 makes the expansion of $@ in contexts where word splitting
     is not performed unspecified. */
  td.flags = W_ASSIGNRHS|W_NOSPLIT2;            /* Posix interp 888 */
#else
  td.flags = W_ASSIGNRHS;
#endif
  td.flags |= (W_NOGLOB|W_TILDEEXP);
  td.word = savestring (string);
  value = call_expand_word_internal (&td, quoted, 0, (int *)NULL, (int *)NULL);
  FREE (td.word);

  expand_no_split_dollar_star = 0;

  if (value)
    {
      if (value->word)
        {
          remove_quoted_nulls (value->word->word);      /* XXX */
          value->word->flags &= ~W_HASQUOTEDNULL;
        }
      dequote_list (value);
    }
  return (value);
}

/* Expand one of the PS? prompt strings. This is a sort of combination of
   expand_string_unsplit and expand_string_internal, but returns the
   passed string when an error occurs.  Might want to trap other calls
   to jump_to_top_level here so we don't endlessly loop. */
WORD_LIST *
expand_prompt_string (string, quoted, wflags)
     char *string;
     int quoted;
     int wflags;
{
  WORD_LIST *value;
  WORD_DESC td;

  if (string == 0 || *string == 0)
    return ((WORD_LIST *)NULL);

  td.flags = wflags;
  td.word = savestring (string);

  no_longjmp_on_fatal_error = 1;
  value = expand_word_internal (&td, quoted, 0, (int *)NULL, (int *)NULL);
  no_longjmp_on_fatal_error = 0;

  if (value == &expand_word_error || value == &expand_word_fatal)
    {
      value = make_word_list (make_bare_word (string), (WORD_LIST *)NULL);
      return value;
    }
  FREE (td.word);
  if (value)
    {
      if (value->word)
        {
          remove_quoted_nulls (value->word->word);      /* XXX */
          value->word->flags &= ~W_HASQUOTEDNULL;
        }
      dequote_list (value);
    }
  return (value);
}

/* Expand STRING just as if you were expanding a word, but do not dequote
   the resultant WORD_LIST.  This is called only from within this file,
   and is used to correctly preserve quoted characters when expanding
   things like ${1+"$@"}.  This does parameter expansion, command
   substitution, arithmetic expansion, and word splitting. */
static WORD_LIST *
expand_string_leave_quoted (string, quoted)
     char *string;
     int quoted;
{
  WORD_LIST *tlist;
  WORD_LIST *tresult;

  if (string == 0 || *string == '\0')
    return ((WORD_LIST *)NULL);

  tlist = expand_string_internal (string, quoted);

  if (tlist)
    {
      tresult = word_list_split (tlist);
      dispose_words (tlist);
      return (tresult);
    }
  return ((WORD_LIST *)NULL);
}

/* This does not perform word splitting or dequote the WORD_LIST
   it returns. */
static WORD_LIST *
expand_string_for_rhs (string, quoted, op, pflags, dollar_at_p, expanded_p)
     char *string;
     int quoted, op, pflags;
     int *dollar_at_p, *expanded_p;
{
  WORD_DESC td;
  WORD_LIST *tresult;
  int old_nosplit;

  if (string == 0 || *string == '\0')
    return (WORD_LIST *)NULL;

  /* We want field splitting to be determined by what is going to be done with
     the entire ${parameterOPword} expansion, so we don't want to split the RHS
     we expand here.  However, the expansion of $* is determined by whether we
     are going to eventually perform word splitting, so we want to set this
     depending on whether or not are are going to be splitting: if the expansion
     is quoted, if the OP is `=', or if IFS is set to the empty string, we
     are not going to be splitting, so we set expand_no_split_dollar_star to
     note this to callees.
     We pass through PF_ASSIGNRHS as W_ASSIGNRHS if this is on the RHS of an
     assignment statement. */
  /* The updated treatment of $* is the result of Posix interp 888 */
  /* This was further clarified on the austin-group list in March, 2017 and
     in Posix bug 1129 */
  old_nosplit = expand_no_split_dollar_star;
  expand_no_split_dollar_star = (quoted & (Q_DOUBLE_QUOTES|Q_HERE_DOCUMENT)) || op == '=' || ifs_is_null == 0;  /* XXX - was 1 */
  td.flags = W_EXPANDRHS;               /* expanding RHS of ${paramOPword} */
  td.flags |= W_NOSPLIT2;               /* no splitting, remove "" and '' */
  if (pflags & PF_ASSIGNRHS)            /* pass through */
    td.flags |= W_ASSIGNRHS;
  if (op == '=')
#if 0
    td.flags |= W_ASSIGNRHS;            /* expand b in ${a=b} like assignment */
#else
    td.flags |= W_ASSIGNRHS|W_NOASSNTILDE;              /* expand b in ${a=b} like assignment */
#endif
  td.word = savestring (string);
  tresult = call_expand_word_internal (&td, quoted, 1, dollar_at_p, expanded_p);
  expand_no_split_dollar_star = old_nosplit;
  free (td.word);

  return (tresult);
}

/* This does not perform word splitting or dequote the WORD_LIST
   it returns and it treats $* as if it were quoted. */
static WORD_LIST *
expand_string_for_pat (string, quoted, dollar_at_p, expanded_p)
     char *string;
     int quoted, *dollar_at_p, *expanded_p;
{
  WORD_DESC td;
  WORD_LIST *tresult;
  int oexp;

  if (string == 0 || *string == '\0')
    return (WORD_LIST *)NULL;

  oexp = expand_no_split_dollar_star;
  expand_no_split_dollar_star = 1;
  td.flags = W_NOSPLIT2;                /* no splitting, remove "" and '' */
  td.word = savestring (string);
  tresult = call_expand_word_internal (&td, quoted, 1, dollar_at_p, expanded_p);
  expand_no_split_dollar_star = oexp;
  free (td.word);

  return (tresult);
}

/* Expand STRING just as if you were expanding a word.  This also returns
   a list of words.  Note that filename globbing is *NOT* done for word
   or string expansion, just when the shell is expanding a command.  This
   does parameter expansion, command substitution, arithmetic expansion,
   and word splitting.  Dequote the resultant WORD_LIST before returning. */
WORD_LIST *
expand_string (string, quoted)
     char *string;
     int quoted;
{
  WORD_LIST *result;

  if (string == 0 || *string == '\0')
    return ((WORD_LIST *)NULL);

  result = expand_string_leave_quoted (string, quoted);
  return (result ? dequote_list (result) : result);
}

/*******************************************
 *                                         *
 *      Functions to expand WORD_DESCs     *
 *                                         *
 *******************************************/

/* Expand WORD, performing word splitting on the result.  This does
   parameter expansion, command substitution, arithmetic expansion,
   word splitting, and quote removal. */

WORD_LIST *
expand_word (word, quoted)
     WORD_DESC *word;
     int quoted;
{
  WORD_LIST *result, *tresult;

  tresult = call_expand_word_internal (word, quoted, 0, (int *)NULL, (int *)NULL);
  result = word_list_split (tresult);
  dispose_words (tresult);
  return (result ? dequote_list (result) : result);
}

/* Expand WORD, but do not perform word splitting on the result.  This
   does parameter expansion, command substitution, arithmetic expansion,
   and quote removal. */
WORD_LIST *
expand_word_unsplit (word, quoted)
     WORD_DESC *word;
     int quoted;
{
  WORD_LIST *result;

  result = expand_word_leave_quoted (word, quoted);
  return (result ? dequote_list (result) : result);
}

/* Perform shell expansions on WORD, but do not perform word splitting or
   quote removal on the result.  Virtually identical to expand_word_unsplit;
   could be combined if implementations don't diverge. */
WORD_LIST *
expand_word_leave_quoted (word, quoted)
     WORD_DESC *word;
     int quoted;
{
  WORD_LIST *result;

  expand_no_split_dollar_star = 1;
  if (ifs_is_null)
    word->flags |= W_NOSPLIT;
  word->flags |= W_NOSPLIT2;
  result = call_expand_word_internal (word, quoted, 0, (int *)NULL, (int *)NULL);
  expand_no_split_dollar_star = 0;

  return result;
}

/***************************************************
 *                                                 *
 *      Functions to handle quoting chars          *
 *                                                 *
 ***************************************************/

/* Conventions:

     A string with s[0] == CTLNUL && s[1] == 0 is a quoted null string.
     The parser passes CTLNUL as CTLESC CTLNUL. */

/* Quote escape characters in string s, but no other characters.  This is
   used to protect CTLESC and CTLNUL in variable values from the rest of
   the word expansion process after the variable is expanded (word splitting
   and filename generation).  If IFS is null, we quote spaces as well, just
   in case we split on spaces later (in the case of unquoted $@, we will
   eventually attempt to split the entire word on spaces).  Corresponding
   code exists in dequote_escapes.  Even if we don't end up splitting on
   spaces, quoting spaces is not a problem.  This should never be called on
   a string that is quoted with single or double quotes or part of a here
   document (effectively double-quoted).
   FLAGS says whether or not we are going to split the result. If we are not,
   and there is a CTLESC or CTLNUL in IFS, we need to quote CTLESC and CTLNUL,
   respectively, to prevent them from being removed as part of dequoting. */
static char *
quote_escapes_internal (string, flags)
     const char *string;
     int flags;
{
  const char *s, *send;
  char *t, *result;
  size_t slen;
  int quote_spaces, skip_ctlesc, skip_ctlnul, nosplit;
  DECLARE_MBSTATE; 

  slen = strlen (string);
  send = string + slen;

  quote_spaces = (ifs_value && *ifs_value == 0);
  nosplit = (flags & PF_NOSPLIT2);

  for (skip_ctlesc = skip_ctlnul = 0, s = ifs_value; s && *s; s++)
    {
      skip_ctlesc |= (nosplit == 0 && *s == CTLESC);
      skip_ctlnul |= (nosplit == 0 && *s == CTLNUL);
    }

  t = result = (char *)xmalloc ((slen * 2) + 1);
  s = string;

  while (*s)
    {
      if ((skip_ctlesc == 0 && *s == CTLESC) || (skip_ctlnul == 0 && *s == CTLNUL) || (quote_spaces && *s == ' '))
        *t++ = CTLESC;
      COPY_CHAR_P (t, s, send);
    }
  *t = '\0';

  return (result);
}

char *
quote_escapes (string)
     const char *string;
{
  return (quote_escapes_internal (string, 0));
}

char *
quote_rhs (string)
     const char *string;
{
  return (quote_escapes_internal (string, PF_NOSPLIT2));
}

static WORD_LIST *
list_quote_escapes (list)
     WORD_LIST *list;
{
  register WORD_LIST *w;
  char *t;

  for (w = list; w; w = w->next)
    {
      t = w->word->word;
      w->word->word = quote_escapes (t);
      free (t);
    }
  return list;
}

/* Inverse of quote_escapes; remove CTLESC protecting CTLESC or CTLNUL.

   The parser passes us CTLESC as CTLESC CTLESC and CTLNUL as CTLESC CTLNUL.
   This is necessary to make unquoted CTLESC and CTLNUL characters in the
   data stream pass through properly.

   We need to remove doubled CTLESC characters inside quoted strings before
   quoting the entire string, so we do not double the number of CTLESC
   characters.

   Also used by parts of the pattern substitution code. */
char *
dequote_escapes (string)
     const char *string;
{
  const char *s, *send;
  char *t, *result;
  size_t slen;
  int quote_spaces;
  DECLARE_MBSTATE;

  if (string == 0)
    return (char *)0;

  slen = strlen (string);
  send = string + slen;

  t = result = (char *)xmalloc (slen + 1);

  if (strchr (string, CTLESC) == 0)
    return (strcpy (result, string));

  quote_spaces = (ifs_value && *ifs_value == 0);

  s = string;
  while (*s)
    {
      if (*s == CTLESC && (s[1] == CTLESC || s[1] == CTLNUL || (quote_spaces && s[1] == ' ')))
        {
          s++;
          if (*s == '\0')
            break;
        }
      COPY_CHAR_P (t, s, send);
    }
  *t = '\0';

  return result;
}

#if defined (INCLUDE_UNUSED)
static WORD_LIST *
list_dequote_escapes (list)
     WORD_LIST *list;
{
  register WORD_LIST *w;
  char *t;

  for (w = list; w; w = w->next)
    {
      t = w->word->word;
      w->word->word = dequote_escapes (t);
      free (t);
    }
  return list;
}
#endif

/* Return a new string with the quoted representation of character C.
   This turns "" into QUOTED_NULL, so the W_HASQUOTEDNULL flag needs to be
   set in any resultant WORD_DESC where this value is the word. */
static char *
make_quoted_char (c)
     int c;
{
  char *temp;

  temp = (char *)xmalloc (3);
  if (c == 0)
    {
      temp[0] = CTLNUL;
      temp[1] = '\0';
    }
  else
    {
      temp[0] = CTLESC;
      temp[1] = c;
      temp[2] = '\0';
    }
  return (temp);
}

/* Quote STRING, returning a new string.  This turns "" into QUOTED_NULL, so
   the W_HASQUOTEDNULL flag needs to be set in any resultant WORD_DESC where
   this value is the word. */
char *
quote_string (string)
     char *string;
{
  register char *t;
  size_t slen;
  char *result, *send;

  if (*string == 0)
    {
      result = (char *)xmalloc (2);
      result[0] = CTLNUL;
      result[1] = '\0';
    }
  else
    {
      DECLARE_MBSTATE;

      slen = strlen (string);
      send = string + slen;

      result = (char *)xmalloc ((slen * 2) + 1);

      for (t = result; string < send; )
        {
          *t++ = CTLESC;
          COPY_CHAR_P (t, string, send);
        }
      *t = '\0';
    }
  return (result);
}

/* De-quote quoted characters in STRING. */
char *
dequote_string (string)
     char *string;
{
  register char *s, *t;
  size_t slen;
  char *result, *send;
  DECLARE_MBSTATE;

  if (string[0] == CTLESC && string[1] == 0)
    internal_debug ("dequote_string: string with bare CTLESC");

  slen = STRLEN (string);

  t = result = (char *)xmalloc (slen + 1);

  if (QUOTED_NULL (string))
    {
      result[0] = '\0';
      return (result);
    }

  /* A string consisting of only a single CTLESC should pass through unchanged */
  if (string[0] == CTLESC && string[1] == 0)
    {
      result[0] = CTLESC;
      result[1] = '\0';
      return (result);
    }

  /* If no character in the string can be quoted, don't bother examining
     each character.  Just return a copy of the string passed to us. */
  if (strchr (string, CTLESC) == NULL)
    return (strcpy (result, string));

  send = string + slen;
  s = string;
  while (*s)
    {
      if (*s == CTLESC)
        {
          s++;
          if (*s == '\0')
            break;
        }
      COPY_CHAR_P (t, s, send);
    }

  *t = '\0';
  return (result);
}

/* Quote the entire WORD_LIST list. */
static WORD_LIST *
quote_list (list)
     WORD_LIST *list;
{
  register WORD_LIST *w;
  char *t;

  for (w = list; w; w = w->next)
    {
      t = w->word->word;
      w->word->word = quote_string (t);
      if (*t == 0)
        w->word->flags |= W_HASQUOTEDNULL;      /* XXX - turn on W_HASQUOTEDNULL here? */
      w->word->flags |= W_QUOTED;
      free (t);
    }
  return list;
}

WORD_DESC *
dequote_word (word)
     WORD_DESC *word;
{
  register char *s;

  s = dequote_string (word->word);
  if (QUOTED_NULL (word->word))
    word->flags &= ~W_HASQUOTEDNULL;
  free (word->word);
  word->word = s;

  return word;
}

/* De-quote quoted characters in each word in LIST. */
WORD_LIST *
dequote_list (list)
     WORD_LIST *list;
{
  register char *s;
  register WORD_LIST *tlist;

  for (tlist = list; tlist; tlist = tlist->next)
    {
      s = dequote_string (tlist->word->word);
      if (QUOTED_NULL (tlist->word->word))
        tlist->word->flags &= ~W_HASQUOTEDNULL;
      free (tlist->word->word);
      tlist->word->word = s;
    }
  return list;
}

/* Remove CTLESC protecting a CTLESC or CTLNUL in place.  Return the passed
   string. */
char *
remove_quoted_escapes (string)
     char *string;
{
  char *t;

  if (string)
    {
      t = dequote_escapes (string);
      strcpy (string, t);
      free (t);
    }

  return (string);
}

/* Remove quoted $IFS characters from STRING.  Quoted IFS characters are
   added to protect them from word splitting, but we need to remove them
   if no word splitting takes place.  This returns newly-allocated memory,
   so callers can use it to replace savestring(). */
char *
remove_quoted_ifs (string)
     char *string;
{
  register size_t slen;
  register int i, j;
  char *ret, *send;
  DECLARE_MBSTATE;

  slen = strlen (string);
  send = string + slen;

  i = j = 0;
  ret = (char *)xmalloc (slen + 1);

  while (i < slen)
    {
      if (string[i] == CTLESC)
        {
          i++;
          if (string[i] == 0 || isifs (string[i]) == 0)
            ret[j++] = CTLESC;
          if (i == slen)
            break;
        }

      COPY_CHAR_I (ret, j, string, send, i);
    }
  ret[j] = '\0';

  return (ret);
}

char *
remove_quoted_nulls (string)
     char *string;
{
  register size_t slen;
  register int i, j, prev_i;
  DECLARE_MBSTATE;

  if (strchr (string, CTLNUL) == 0)             /* XXX */
    return string;                              /* XXX */

  slen = strlen (string);
  i = j = 0;

  while (i < slen)
    {
      if (string[i] == CTLESC)
        {
          /* Old code had j++, but we cannot assume that i == j at this
             point -- what if a CTLNUL has already been removed from the
             string?  We don't want to drop the CTLESC or recopy characters
             that we've already copied down. */
          i++;
          string[j++] = CTLESC;
          if (i == slen)
            break;
        }
      else if (string[i] == CTLNUL)
        {
          i++;
          continue;
        }

      prev_i = i;
      ADVANCE_CHAR (string, slen, i);           /* COPY_CHAR_I? */
      if (j < prev_i)
        {
          do string[j++] = string[prev_i++]; while (prev_i < i);
        }
      else
        j = i;
    }
  string[j] = '\0';

  return (string);
}

/* Perform quoted null character removal on each element of LIST.
   This modifies LIST. */
void
word_list_remove_quoted_nulls (list)
     WORD_LIST *list;
{
  register WORD_LIST *t;

  for (t = list; t; t = t->next)
    {
      remove_quoted_nulls (t->word->word);
      t->word->flags &= ~W_HASQUOTEDNULL;
    }
}

/* **************************************************************** */
/*                                                                  */
/*         Functions for Matching and Removing Patterns             */
/*                                                                  */
/* **************************************************************** */

#if defined (HANDLE_MULTIBYTE)
# ifdef INCLUDE_UNUSED
static unsigned char *
mb_getcharlens (string, len)
     char *string;
     int len;
{
  int i, offset, last;
  unsigned char *ret;
  char *p;
  DECLARE_MBSTATE;

  i = offset = 0;
  last = 0;
  ret = (unsigned char *)xmalloc (len);
  memset (ret, 0, len);
  while (string[last])
    {
      ADVANCE_CHAR (string, len, offset);
      ret[last] = offset - last;
      last = offset;
    }
  return ret;
}
#  endif
#endif

/* Remove the portion of PARAM matched by PATTERN according to OP, where OP
   can have one of 4 values:
        RP_LONG_LEFT    remove longest matching portion at start of PARAM
        RP_SHORT_LEFT   remove shortest matching portion at start of PARAM
        RP_LONG_RIGHT   remove longest matching portion at end of PARAM
        RP_SHORT_RIGHT  remove shortest matching portion at end of PARAM
*/

#define RP_LONG_LEFT    1
#define RP_SHORT_LEFT   2
#define RP_LONG_RIGHT   3
#define RP_SHORT_RIGHT  4

/* Returns its first argument if nothing matched; new memory otherwise */
static char *
remove_upattern (param, pattern, op)
     char *param, *pattern;
     int op;
{
  register size_t len;
  register char *end;
  register char *p, *ret, c;

  len = STRLEN (param);
  end = param + len;

  switch (op)
    {
      case RP_LONG_LEFT:        /* remove longest match at start */
        for (p = end; p >= param; p--)
          {
            c = *p; *p = '\0';
            if (strmatch (pattern, param, FNMATCH_EXTFLAG) != FNM_NOMATCH)
              {
                *p = c;
                return (savestring (p));
              }
            *p = c;

          }
        break;

      case RP_SHORT_LEFT:       /* remove shortest match at start */
        for (p = param; p <= end; p++)
          {
            c = *p; *p = '\0';
            if (strmatch (pattern, param, FNMATCH_EXTFLAG) != FNM_NOMATCH)
              {
                *p = c;
                return (savestring (p));
              }
            *p = c;
          }
        break;

      case RP_LONG_RIGHT:       /* remove longest match at end */
        for (p = param; p <= end; p++)
          {
            if (strmatch (pattern, p, FNMATCH_EXTFLAG) != FNM_NOMATCH)
              {
                c = *p; *p = '\0';
                ret = savestring (param);
                *p = c;
                return (ret);
              }
          }
        break;

      case RP_SHORT_RIGHT:      /* remove shortest match at end */
        for (p = end; p >= param; p--)
          {
            if (strmatch (pattern, p, FNMATCH_EXTFLAG) != FNM_NOMATCH)
              {
                c = *p; *p = '\0';
                ret = savestring (param);
                *p = c;
                return (ret);
              }
          }
        break;
    }

  return (param);       /* no match, return original string */
}

#if defined (HANDLE_MULTIBYTE)
/* Returns its first argument if nothing matched; new memory otherwise */
static wchar_t *
remove_wpattern (wparam, wstrlen, wpattern, op)
     wchar_t *wparam;
     size_t wstrlen;
     wchar_t *wpattern;
     int op;
{
  wchar_t wc, *ret;
  int n;

  switch (op)
    {
      case RP_LONG_LEFT:        /* remove longest match at start */
        for (n = wstrlen; n >= 0; n--)
          {
            wc = wparam[n]; wparam[n] = L'\0';
            if (wcsmatch (wpattern, wparam, FNMATCH_EXTFLAG) != FNM_NOMATCH)
              {
                wparam[n] = wc;
                return (wcsdup (wparam + n));
              }
            wparam[n] = wc;
          }
        break;

      case RP_SHORT_LEFT:       /* remove shortest match at start */
        for (n = 0; n <= wstrlen; n++)
          {
            wc = wparam[n]; wparam[n] = L'\0';
            if (wcsmatch (wpattern, wparam, FNMATCH_EXTFLAG) != FNM_NOMATCH)
              {
                wparam[n] = wc;
                return (wcsdup (wparam + n));
              }
            wparam[n] = wc;
          }
        break;

      case RP_LONG_RIGHT:       /* remove longest match at end */
        for (n = 0; n <= wstrlen; n++)
          {
            if (wcsmatch (wpattern, wparam + n, FNMATCH_EXTFLAG) != FNM_NOMATCH)
              {
                wc = wparam[n]; wparam[n] = L'\0';
                ret = wcsdup (wparam);
                wparam[n] = wc;
                return (ret);
              }
          }
        break;

      case RP_SHORT_RIGHT:      /* remove shortest match at end */
        for (n = wstrlen; n >= 0; n--)
          {
            if (wcsmatch (wpattern, wparam + n, FNMATCH_EXTFLAG) != FNM_NOMATCH)
              {
                wc = wparam[n]; wparam[n] = L'\0';
                ret = wcsdup (wparam);
                wparam[n] = wc;
                return (ret);
              }
          }
        break;
    }

  return (wparam);      /* no match, return original string */
}
#endif /* HANDLE_MULTIBYTE */

static char *
remove_pattern (param, pattern, op)
     char *param, *pattern;
     int op;
{
  char *xret;

  if (param == NULL)
    return (param);
  if (*param == '\0' || pattern == NULL || *pattern == '\0')    /* minor optimization */
    return (savestring (param));

#if defined (HANDLE_MULTIBYTE)
  if (MB_CUR_MAX > 1)
    {
      wchar_t *ret, *oret;
      size_t n;
      wchar_t *wparam, *wpattern;
      mbstate_t ps;

      /* XXX - could optimize here by checking param and pattern for multibyte
         chars with mbsmbchar and calling remove_upattern. */

      n = xdupmbstowcs (&wpattern, NULL, pattern);
      if (n == (size_t)-1)
        {
          xret = remove_upattern (param, pattern, op);
          return ((xret == param) ? savestring (param) : xret);
        }
      n = xdupmbstowcs (&wparam, NULL, param);

      if (n == (size_t)-1)
        {
          free (wpattern);
          xret = remove_upattern (param, pattern, op);
          return ((xret == param) ? savestring (param) : xret);
        }
      oret = ret = remove_wpattern (wparam, n, wpattern, op);
      /* Don't bother to convert wparam back to multibyte string if nothing
         matched; just return copy of original string */
      if (ret == wparam)
        {
          free (wparam);
          free (wpattern);
          return (savestring (param));
        }

      free (wparam);
      free (wpattern);

      n = strlen (param);
      xret = (char *)xmalloc (n + 1);
      memset (&ps, '\0', sizeof (mbstate_t));
      n = wcsrtombs (xret, (const wchar_t **)&ret, n, &ps);
      xret[n] = '\0';           /* just to make sure */
      free (oret);
      return xret;      
    }
  else
#endif
    {
      xret = remove_upattern (param, pattern, op);
      return ((xret == param) ? savestring (param) : xret);
    }
}

/* Match PAT anywhere in STRING and return the match boundaries.
   This returns 1 in case of a successful match, 0 otherwise.  SP
   and EP are pointers into the string where the match begins and
   ends, respectively.  MTYPE controls what kind of match is attempted.
   MATCH_BEG and MATCH_END anchor the match at the beginning and end
   of the string, respectively.  The longest match is returned. */
static int
match_upattern (string, pat, mtype, sp, ep)
     char *string, *pat;
     int mtype;
     char **sp, **ep;
{
  int c, mlen;
  size_t len;
  register char *p, *p1, *npat;
  char *end;

  /* If the pattern doesn't match anywhere in the string, go ahead and
     short-circuit right away.  A minor optimization, saves a bunch of
     unnecessary calls to strmatch (up to N calls for a string of N
     characters) if the match is unsuccessful.  To preserve the semantics
     of the substring matches below, we make sure that the pattern has
     `*' as first and last character, making a new pattern if necessary. */
  /* XXX - check this later if I ever implement `**' with special meaning,
     since this will potentially result in `**' at the beginning or end */
  len = STRLEN (pat);
  if (pat[0] != '*' || (pat[0] == '*' && pat[1] == LPAREN && extended_glob) || pat[len - 1] != '*')
    {
      int unescaped_backslash;
      char *pp;

      p = npat = (char *)xmalloc (len + 3);
      p1 = pat;
      if ((mtype != MATCH_BEG) && (*p1 != '*' || (*p1 == '*' && p1[1] == LPAREN && extended_glob)))
        *p++ = '*';
      while (*p1)
        *p++ = *p1++;
#if 1
      /* Need to also handle a pattern that ends with an unescaped backslash.
         For right now, we ignore it because the pattern matching code will
         fail the match anyway */
      /* If the pattern ends with a `*' we leave it alone if it's preceded by
         an even number of backslashes, but if it's escaped by a backslash
         we need to add another `*'. */
      if ((mtype != MATCH_END) && (p1[-1] == '*' && (unescaped_backslash = p1[-2] == '\\')))
        {
          pp = p1 - 3;
          while (pp >= pat && *pp-- == '\\')
            unescaped_backslash = 1 - unescaped_backslash;
          if (unescaped_backslash)
            *p++ = '*';
        }
      else if (mtype != MATCH_END && p1[-1] != '*')
        *p++ = '*';
#else 
      if (p1[-1] != '*' || p1[-2] == '\\')
        *p++ = '*';
#endif
      *p = '\0';
    }
  else
    npat = pat;
  c = strmatch (npat, string, FNMATCH_EXTFLAG | FNMATCH_IGNCASE);
  if (npat != pat)
    free (npat);
  if (c == FNM_NOMATCH)
    return (0);

  len = STRLEN (string);
  end = string + len;

  mlen = umatchlen (pat, len);
  if (mlen > (int)len)
    return (0);

  switch (mtype)
    {
    case MATCH_ANY:
      for (p = string; p <= end; p++)
        {
          if (match_pattern_char (pat, p, FNMATCH_IGNCASE))
            {
              p1 = (mlen == -1) ? end : p + mlen;
              /* p1 - p = length of portion of string to be considered
                 p = current position in string
                 mlen = number of characters consumed by match (-1 for entire string)
                 end = end of string
                 we want to break immediately if the potential match len
                 is greater than the number of characters remaining in the
                 string
              */
              if (p1 > end)
                break;
              for ( ; p1 >= p; p1--)
                {
                  c = *p1; *p1 = '\0';
                  if (strmatch (pat, p, FNMATCH_EXTFLAG | FNMATCH_IGNCASE) == 0)
                    {
                      *p1 = c;
                      *sp = p;
                      *ep = p1;
                      return 1;
                    }
                  *p1 = c;
#if 1
                  /* If MLEN != -1, we have a fixed length pattern. */
                  if (mlen != -1)
                    break;
#endif
                }
            }
        }

      return (0);

    case MATCH_BEG:
      if (match_pattern_char (pat, string, FNMATCH_IGNCASE) == 0)
        return (0);

      for (p = (mlen == -1) ? end : string + mlen; p >= string; p--)
        {
          c = *p; *p = '\0';
          if (strmatch (pat, string, FNMATCH_EXTFLAG | FNMATCH_IGNCASE) == 0)
            {
              *p = c;
              *sp = string;
              *ep = p;
              return 1;
            }
          *p = c;
          /* If MLEN != -1, we have a fixed length pattern. */
          if (mlen != -1)
            break;
        }

      return (0);

    case MATCH_END:
      for (p = end - ((mlen == -1) ? len : mlen); p <= end; p++)
        {
          if (strmatch (pat, p, FNMATCH_EXTFLAG | FNMATCH_IGNCASE) == 0)
            {
              *sp = p;
              *ep = end;
              return 1;
            }
          /* If MLEN != -1, we have a fixed length pattern. */
          if (mlen != -1)
            break;
        }

      return (0);
    }

  return (0);
}

#if defined (HANDLE_MULTIBYTE)

#define WFOLD(c) (match_ignore_case && iswupper (c) ? towlower (c) : (c))

/* Match WPAT anywhere in WSTRING and return the match boundaries.
   This returns 1 in case of a successful match, 0 otherwise.  Wide
   character version. */
static int
match_wpattern (wstring, indices, wstrlen, wpat, mtype, sp, ep)
     wchar_t *wstring;
     char **indices;
     size_t wstrlen;
     wchar_t *wpat;
     int mtype;
     char **sp, **ep;
{
  wchar_t wc, *wp, *nwpat, *wp1;
  size_t len;
  int mlen;
  int n, n1, n2, simple;

  simple = (wpat[0] != L'\\' && wpat[0] != L'*' && wpat[0] != L'?' && wpat[0] != L'[');
#if defined (EXTENDED_GLOB)
  if (extended_glob)
    simple &= (wpat[1] != L'(' || (wpat[0] != L'*' && wpat[0] != L'?' && wpat[0] != L'+' && wpat[0] != L'!' && wpat[0] != L'@')); /*)*/
#endif

  /* If the pattern doesn't match anywhere in the string, go ahead and
     short-circuit right away.  A minor optimization, saves a bunch of
     unnecessary calls to strmatch (up to N calls for a string of N
     characters) if the match is unsuccessful.  To preserve the semantics
     of the substring matches below, we make sure that the pattern has
     `*' as first and last character, making a new pattern if necessary. */
  len = wcslen (wpat);
  if (wpat[0] != L'*' || (wpat[0] == L'*' && wpat[1] == WLPAREN && extended_glob) || wpat[len - 1] != L'*')
    {
      int unescaped_backslash;
      wchar_t *wpp;

      wp = nwpat = (wchar_t *)xmalloc ((len + 3) * sizeof (wchar_t));
      wp1 = wpat;
      if (*wp1 != L'*' || (*wp1 == '*' && wp1[1] == WLPAREN && extended_glob))
        *wp++ = L'*';
      while (*wp1 != L'\0')
        *wp++ = *wp1++;
#if 1
      /* See comments above in match_upattern. */
      if (wp1[-1] == L'*' && (unescaped_backslash = wp1[-2] == L'\\'))
        {
          wpp = wp1 - 3;
          while (wpp >= wpat && *wpp-- == L'\\')
            unescaped_backslash = 1 - unescaped_backslash;
          if (unescaped_backslash)
            *wp++ = L'*';
        }
      else if (wp1[-1] != L'*')
        *wp++ = L'*';
#else      
      if (wp1[-1] != L'*' || wp1[-2] == L'\\')
        *wp++ = L'*';
#endif
      *wp = '\0';
    }
  else
    nwpat = wpat;
  len = wcsmatch (nwpat, wstring, FNMATCH_EXTFLAG | FNMATCH_IGNCASE);
  if (nwpat != wpat)
    free (nwpat);
  if (len == FNM_NOMATCH)
    return (0);

  mlen = wmatchlen (wpat, wstrlen);
  if (mlen > (int)wstrlen)
    return (0);

/* itrace("wmatchlen (%ls) -> %d", wpat, mlen); */
  switch (mtype)
    {
    case MATCH_ANY:
      for (n = 0; n <= wstrlen; n++)
        {
          n2 = simple ? (WFOLD(*wpat) == WFOLD(wstring[n])) : match_pattern_wchar (wpat, wstring + n, FNMATCH_IGNCASE);
          if (n2)
            {
              n1 = (mlen == -1) ? wstrlen : n + mlen;
              if (n1 > wstrlen)
                break;

              for ( ; n1 >= n; n1--)
                {
                  wc = wstring[n1]; wstring[n1] = L'\0';
                  if (wcsmatch (wpat, wstring + n, FNMATCH_EXTFLAG | FNMATCH_IGNCASE) == 0)
                    {
                      wstring[n1] = wc;
                      *sp = indices[n];
                      *ep = indices[n1];
                      return 1;
                    }
                  wstring[n1] = wc;
                  /* If MLEN != -1, we have a fixed length pattern. */
                  if (mlen != -1)
                    break;
                }
            }
        }

      return (0);

    case MATCH_BEG:
      if (match_pattern_wchar (wpat, wstring, FNMATCH_IGNCASE) == 0)
        return (0);

      for (n = (mlen == -1) ? wstrlen : mlen; n >= 0; n--)
        {
          wc = wstring[n]; wstring[n] = L'\0';
          if (wcsmatch (wpat, wstring, FNMATCH_EXTFLAG | FNMATCH_IGNCASE) == 0)
            {
              wstring[n] = wc;
              *sp = indices[0];
              *ep = indices[n];
              return 1;
            }
          wstring[n] = wc;
          /* If MLEN != -1, we have a fixed length pattern. */
          if (mlen != -1)
            break;
        }

      return (0);

    case MATCH_END:
      for (n = wstrlen - ((mlen == -1) ? wstrlen : mlen); n <= wstrlen; n++)
        {
          if (wcsmatch (wpat, wstring + n, FNMATCH_EXTFLAG | FNMATCH_IGNCASE) == 0)
            {
              *sp = indices[n];
              *ep = indices[wstrlen];
              return 1;
            }
          /* If MLEN != -1, we have a fixed length pattern. */
          if (mlen != -1)
            break;
        }

      return (0);
    }

  return (0);
}
#undef WFOLD
#endif /* HANDLE_MULTIBYTE */

static int
match_pattern (string, pat, mtype, sp, ep)
     char *string, *pat;
     int mtype;
     char **sp, **ep;
{
#if defined (HANDLE_MULTIBYTE)
  int ret;
  size_t n;
  wchar_t *wstring, *wpat;
  char **indices;
#endif

  if (string == 0 || pat == 0 || *pat == 0)
    return (0);

#if defined (HANDLE_MULTIBYTE)
  if (MB_CUR_MAX > 1)
    {
      if (mbsmbchar (string) == 0 && mbsmbchar (pat) == 0)
        return (match_upattern (string, pat, mtype, sp, ep));

      n = xdupmbstowcs (&wpat, NULL, pat);
      if (n == (size_t)-1)
        return (match_upattern (string, pat, mtype, sp, ep));
      n = xdupmbstowcs (&wstring, &indices, string);
      if (n == (size_t)-1)
        {
          free (wpat);
          return (match_upattern (string, pat, mtype, sp, ep));
        }
      ret = match_wpattern (wstring, indices, n, wpat, mtype, sp, ep);

      free (wpat);
      free (wstring);
      free (indices);

      return (ret);
    }
  else
#endif
    return (match_upattern (string, pat, mtype, sp, ep));
}

static int
getpatspec (c, value)
     int c;
     char *value;
{
  if (c == '#')
    return ((*value == '#') ? RP_LONG_LEFT : RP_SHORT_LEFT);
  else  /* c == '%' */
    return ((*value == '%') ? RP_LONG_RIGHT : RP_SHORT_RIGHT);
}

/* Posix.2 says that the WORD should be run through tilde expansion,
   parameter expansion, command substitution and arithmetic expansion.
   This leaves the result quoted, so quote_string_for_globbing () has
   to be called to fix it up for strmatch ().  If QUOTED is non-zero,
   it means that the entire expression was enclosed in double quotes.
   This means that quoting characters in the pattern do not make any
   special pattern characters quoted.  For example, the `*' in the
   following retains its special meaning: "${foo#'*'}". */
static char *
getpattern (value, quoted, expandpat)
     char *value;
     int quoted, expandpat;
{
  char *pat, *tword;
  WORD_LIST *l;
#if 0
  int i;
#endif
  /* There is a problem here:  how to handle single or double quotes in the
     pattern string when the whole expression is between double quotes?
     POSIX.2 says that enclosing double quotes do not cause the pattern to
     be quoted, but does that leave us a problem with @ and array[@] and their
     expansions inside a pattern? */
#if 0
  if (expandpat && (quoted & (Q_HERE_DOCUMENT|Q_DOUBLE_QUOTES)) && *tword)
    {
      i = 0;
      pat = string_extract_double_quoted (tword, &i, SX_STRIPDQ);
      free (tword);
      tword = pat;
    }
#endif

  /* expand_string_for_pat () leaves WORD quoted and does not perform
     word splitting. */
  l = *value ? expand_string_for_pat (value,
                                      (quoted & (Q_HERE_DOCUMENT|Q_DOUBLE_QUOTES)) ? Q_PATQUOTE : quoted,
                                      (int *)NULL, (int *)NULL)
             : (WORD_LIST *)0;
  if (l)
    word_list_remove_quoted_nulls (l);
  pat = string_list (l);
  dispose_words (l);
  if (pat)
    {
      tword = quote_string_for_globbing (pat, QGLOB_CVTNULL);
      free (pat);
      pat = tword;
    }
  return (pat);
}

#if 0
/* Handle removing a pattern from a string as a result of ${name%[%]value}
   or ${name#[#]value}. */
static char *
variable_remove_pattern (value, pattern, patspec, quoted)
     char *value, *pattern;
     int patspec, quoted;
{
  char *tword;

  tword = remove_pattern (value, pattern, patspec);

  return (tword);
}
#endif

static char *
list_remove_pattern (list, pattern, patspec, itype, quoted)
     WORD_LIST *list;
     char *pattern;
     int patspec, itype, quoted;
{
  WORD_LIST *new, *l;
  WORD_DESC *w;
  char *tword;

  for (new = (WORD_LIST *)NULL, l = list; l; l = l->next)
    {
      tword = remove_pattern (l->word->word, pattern, patspec);
      w = alloc_word_desc ();
      w->word = tword ? tword : savestring ("");
      new = make_word_list (w, new);
    }

  l = REVERSE_LIST (new, WORD_LIST *);
  tword = string_list_pos_params (itype, l, quoted, 0);
  dispose_words (l);

  return (tword);
}

static char *
parameter_list_remove_pattern (itype, pattern, patspec, quoted)
     int itype;
     char *pattern;
     int patspec, quoted;
{
  char *ret;
  WORD_LIST *list;

  list = list_rest_of_args ();
  if (list == 0)
    return ((char *)NULL);
  ret = list_remove_pattern (list, pattern, patspec, itype, quoted);
  dispose_words (list);
  return (ret);
}

#if defined (ARRAY_VARS)
static char *
array_remove_pattern (var, pattern, patspec, starsub, quoted)
     SHELL_VAR *var;
     char *pattern;
     int patspec;
     int starsub;       /* so we can figure out how it's indexed */
     int quoted;
{
  ARRAY *a;
  HASH_TABLE *h;
  int itype;
  char *ret;
  WORD_LIST *list;
  SHELL_VAR *v;

  v = var;              /* XXX - for now */

  itype = starsub ? '*' : '@';

  a = (v && array_p (v)) ? array_cell (v) : 0;
  h = (v && assoc_p (v)) ? assoc_cell (v) : 0;
  
  list = a ? array_to_word_list (a) : (h ? assoc_to_word_list (h) : 0);
  if (list == 0)
   return ((char *)NULL);
  ret = list_remove_pattern (list, pattern, patspec, itype, quoted);
  dispose_words (list);

  return ret;
}
#endif /* ARRAY_VARS */

static char *
parameter_brace_remove_pattern (varname, value, estatep, patstr, rtype, quoted, flags)
     char *varname, *value;
     array_eltstate_t *estatep;
     char *patstr;
     int rtype, quoted, flags;
{
  int vtype, patspec, starsub;
  char *temp1, *val, *pattern, *oname;
  SHELL_VAR *v;

  if (value == 0)
    return ((char *)NULL);

  oname = this_command_name;
  this_command_name = varname;

  vtype = get_var_and_type (varname, value, estatep, quoted, flags, &v, &val);
  if (vtype == -1)
    {
      this_command_name = oname;
      return ((char *)NULL);
    }

  starsub = vtype & VT_STARSUB;
  vtype &= ~VT_STARSUB;

  patspec = getpatspec (rtype, patstr);
  if (patspec == RP_LONG_LEFT || patspec == RP_LONG_RIGHT)
    patstr++;

  /* Need to pass getpattern newly-allocated memory in case of expansion --
     the expansion code will free the passed string on an error. */
  temp1 = savestring (patstr);
  pattern = getpattern (temp1, quoted, 1);
  free (temp1);

  temp1 = (char *)NULL;         /* shut up gcc */
  switch (vtype)
    {
    case VT_VARIABLE:
    case VT_ARRAYMEMBER:
      temp1 = remove_pattern (val, pattern, patspec);
      if (vtype == VT_VARIABLE)
        FREE (val);
      if (temp1)
        {
          val = (quoted & (Q_HERE_DOCUMENT|Q_DOUBLE_QUOTES))
                        ? quote_string (temp1)
                        : quote_escapes (temp1);
          free (temp1);
          temp1 = val;
        }
      break;
#if defined (ARRAY_VARS)
    case VT_ARRAYVAR:
      temp1 = array_remove_pattern (v, pattern, patspec, starsub, quoted);
      if (temp1 && ((quoted & (Q_HERE_DOCUMENT|Q_DOUBLE_QUOTES)) == 0))
        {
          val = quote_escapes (temp1);
          free (temp1);
          temp1 = val;
        }
      break;
#endif
    case VT_POSPARMS:
      temp1 = parameter_list_remove_pattern (varname[0], pattern, patspec, quoted);
      if (temp1 && quoted == 0 && ifs_is_null)
        {
          /* Posix interp 888 */
        }
      else if (temp1 && ((quoted & (Q_HERE_DOCUMENT|Q_DOUBLE_QUOTES)) == 0))
        {
          val = quote_escapes (temp1);
          free (temp1);
          temp1 = val;
        }
      break;
    }

  this_command_name = oname;

  FREE (pattern);
  return temp1;
}    

#if defined (PROCESS_SUBSTITUTION)

static void reap_some_procsubs PARAMS((int));

/*****************************************************************/
/*                                                               */
/*                  Hacking Process Substitution                 */
/*                                                               */
/*****************************************************************/

#if !defined (HAVE_DEV_FD)
/* Named pipes must be removed explicitly with `unlink'.  This keeps a list
   of FIFOs the shell has open.  unlink_fifo_list will walk the list and
   unlink the ones that don't have a living process on the other end.
   unlink_all_fifos will walk the list and unconditionally unlink them, trying
   to open and close the FIFO first to release any child processes sleeping on
   the FIFO. add_fifo_list adds the name of an open FIFO to the list. 
   NFIFO is a count of the number of FIFOs in the list. */
#define FIFO_INCR 20

/* PROC value of -1 means the process has been reaped and the FIFO needs to
   be removed. PROC value of 0 means the slot is unused. */
struct temp_fifo {
  char *file;
  pid_t proc;
};

static struct temp_fifo *fifo_list = (struct temp_fifo *)NULL;
static int nfifo;
static int fifo_list_size;

void
clear_fifo_list ()
{
  int i;

  for (i = 0; i < fifo_list_size; i++)
    {
      if (fifo_list[i].file)
        free (fifo_list[i].file);
      fifo_list[i].file = NULL;
      fifo_list[i].proc = 0;
    }
  nfifo = 0;
}

void *
copy_fifo_list (sizep)
     int *sizep;
{
  if (sizep)
    *sizep = 0;
  return (void *)NULL;
}

static void
add_fifo_list (pathname)
     char *pathname;
{
  int osize, i;

  if (nfifo >= fifo_list_size - 1)
    {
      osize = fifo_list_size;
      fifo_list_size += FIFO_INCR;
      fifo_list = (struct temp_fifo *)xrealloc (fifo_list,
                                fifo_list_size * sizeof (struct temp_fifo));
      for (i = osize; i < fifo_list_size; i++)
        {
          fifo_list[i].file = (char *)NULL;
          fifo_list[i].proc = 0;        /* unused */
        }
    }

  fifo_list[nfifo].file = savestring (pathname);
  nfifo++;
}

void
unlink_fifo (i)
     int i;
{
  if ((fifo_list[i].proc == (pid_t)-1) || (fifo_list[i].proc > 0 && (kill(fifo_list[i].proc, 0) == -1)))
    {
      unlink (fifo_list[i].file);
      free (fifo_list[i].file);
      fifo_list[i].file = (char *)NULL;
      fifo_list[i].proc = 0;
    }
}

void
unlink_fifo_list ()
{
  int saved, i, j;

  if (nfifo == 0)
    return;

  for (i = saved = 0; i < nfifo; i++)
    {
      if ((fifo_list[i].proc == (pid_t)-1) || (fifo_list[i].proc > 0 && (kill(fifo_list[i].proc, 0) == -1)))
        {
          unlink (fifo_list[i].file);
          free (fifo_list[i].file);
          fifo_list[i].file = (char *)NULL;
          fifo_list[i].proc = 0;
        }
      else
        saved++;
    }

  /* If we didn't remove some of the FIFOs, compact the list. */
  if (saved)
    {
      for (i = j = 0; i < nfifo; i++)
        if (fifo_list[i].file)
          {
            if (i != j)
              {
                fifo_list[j].file = fifo_list[i].file;
                fifo_list[j].proc = fifo_list[i].proc;
                fifo_list[i].file = (char *)NULL;
                fifo_list[i].proc = 0;
              }
            j++;
          }
      nfifo = j;
    }
  else
    nfifo = 0;
}

void
unlink_all_fifos ()
{
  int i, fd;

  if (nfifo == 0)
    return;

  for (i = 0; i < nfifo; i++)
    {
      fifo_list[i].proc = (pid_t)-1;
#if defined (O_NONBLOCK)
      fd = open (fifo_list[i].file, O_RDWR|O_NONBLOCK);
#else
      fd = -1;
#endif
      unlink_fifo (i);
      if (fd >= 0)
        close (fd);
    }

  nfifo = 0;
}

/* Take LIST, which is a bitmap denoting active FIFOs in fifo_list
   from some point in the past, and close all open FIFOs in fifo_list
   that are not marked as active in LIST.  If LIST is NULL, close
   everything in fifo_list. LSIZE is the number of elements in LIST, in
   case it's larger than fifo_list_size (size of fifo_list). */
void
close_new_fifos (list, lsize)
     void *list;
     int lsize;
{
  int i;
  char *plist;

  if (list == 0)
    {
      unlink_fifo_list ();
      return;
    }

  for (plist = (char *)list, i = 0; i < lsize; i++)
    if (plist[i] == 0 && i < fifo_list_size && fifo_list[i].proc != -1)
      unlink_fifo (i);

  for (i = lsize; i < fifo_list_size; i++)
    unlink_fifo (i);  
}

int
find_procsub_child (pid)
     pid_t pid;
{
  int i;

  for (i = 0; i < nfifo; i++)
    if (fifo_list[i].proc == pid)
      return i;
  return -1;
}

void
set_procsub_status (ind, pid, status)
     int ind;
     pid_t pid;
     int status;
{
  if (ind >= 0 && ind < nfifo)
    fifo_list[ind].proc = (pid_t)-1;            /* sentinel */
}

/* If we've marked the process for this procsub as dead, close the
   associated file descriptor and delete the FIFO. */
static void
reap_some_procsubs (max)
     int max;
{
  int i;

  for (i = 0; i < max; i++)
    if (fifo_list[i].proc == (pid_t)-1) /* reaped */
      unlink_fifo (i);
}

void
reap_procsubs ()
{
  reap_some_procsubs (nfifo);
}

#if 0
/* UNUSED */
void
wait_procsubs ()
{
  int i, r;

  for (i = 0; i < nfifo; i++)
    {
      if (fifo_list[i].proc != (pid_t)-1 && fifo_list[i].proc > 0)
        {
          r = wait_for (fifo_list[i].proc, 0);
          save_proc_status (fifo_list[i].proc, r);
          fifo_list[i].proc = (pid_t)-1;
        }
    }
}
#endif

int
fifos_pending ()
{
  return nfifo;
}

int
num_fifos ()
{
  return nfifo;
}

static char *
make_named_pipe ()
{
  char *tname;

  tname = sh_mktmpname ("sh-np", MT_USERANDOM|MT_USETMPDIR);
  if (mkfifo (tname, 0600) < 0)
    {
      free (tname);
      return ((char *)NULL);
    }

  add_fifo_list (tname);
  return (tname);
}

#else /* HAVE_DEV_FD */

/* DEV_FD_LIST is a bitmap of file descriptors attached to pipes the shell
   has open to children.  NFDS is a count of the number of bits currently
   set in DEV_FD_LIST.  TOTFDS is a count of the highest possible number
   of open files. */
/* dev_fd_list[I] value of -1 means the process has been reaped and file
   descriptor I needs to be closed. Value of 0 means the slot is unused. */

static pid_t *dev_fd_list = (pid_t *)NULL;
static int nfds;
static int totfds;      /* The highest possible number of open files. */

void
clear_fifo (i)
     int i;
{
  if (dev_fd_list[i])
    {
      dev_fd_list[i] = 0;
      nfds--;
    }
}

void
clear_fifo_list ()
{
  register int i;

  if (nfds == 0)
    return;

  for (i = 0; nfds && i < totfds; i++)
    clear_fifo (i);

  nfds = 0;
}

void *
copy_fifo_list (sizep)
     int *sizep;
{
  void *ret;

  if (nfds == 0 || totfds == 0)
    {
      if (sizep)
        *sizep = 0;
      return (void *)NULL;
    }

  if (sizep)
    *sizep = totfds;
  ret = xmalloc (totfds * sizeof (pid_t));
  return (memcpy (ret, dev_fd_list, totfds * sizeof (pid_t)));
}

static void
add_fifo_list (fd)
     int fd;
{
  if (dev_fd_list == 0 || fd >= totfds)
    {
      int ofds;

      ofds = totfds;
      totfds = getdtablesize ();
      if (totfds < 0 || totfds > 256)
        totfds = 256;
      if (fd >= totfds)
        totfds = fd + 2;

      dev_fd_list = (pid_t *)xrealloc (dev_fd_list, totfds * sizeof (dev_fd_list[0]));
      /* XXX - might need a loop for this */
      memset (dev_fd_list + ofds, '\0', (totfds - ofds) * sizeof (pid_t));
    }

  dev_fd_list[fd] = 1;          /* marker; updated later */
  nfds++;
}

int
fifos_pending ()
{
  return 0;     /* used for cleanup; not needed with /dev/fd */
}

int
num_fifos ()
{
  return nfds;
}

void
unlink_fifo (fd)
     int fd;
{
  if (dev_fd_list[fd])
    {
      close (fd);
      dev_fd_list[fd] = 0;
      nfds--;
    }
}

void
unlink_fifo_list ()
{
  register int i;

  if (nfds == 0)
    return;

  for (i = totfds-1; nfds && i >= 0; i--)
    unlink_fifo (i);

  nfds = 0;
}

void
unlink_all_fifos ()
{
  unlink_fifo_list ();
}

/* Take LIST, which is a snapshot copy of dev_fd_list from some point in
   the past, and close all open fds in dev_fd_list that are not marked
   as open in LIST.  If LIST is NULL, close everything in dev_fd_list.
   LSIZE is the number of elements in LIST, in case it's larger than
   totfds (size of dev_fd_list). */
void
close_new_fifos (list, lsize)
     void *list;
     int lsize;
{
  int i;
  pid_t *plist;

  if (list == 0)
    {
      unlink_fifo_list ();
      return;
    }

  for (plist = (pid_t *)list, i = 0; i < lsize; i++)
    if (plist[i] == 0 && i < totfds && dev_fd_list[i])
      unlink_fifo (i);

  for (i = lsize; i < totfds; i++)
    unlink_fifo (i);  
}

int
find_procsub_child (pid)
     pid_t pid;
{
  int i;

  if (nfds == 0)
    return -1;

  for (i = 0; i < totfds; i++)
    if (dev_fd_list[i] == pid)
      return i;

  return -1;
}

void
set_procsub_status (ind, pid, status)
     int ind;
     pid_t pid;
     int status;
{
  if (ind >= 0 && ind < totfds)
    dev_fd_list[ind] = (pid_t)-1;               /* sentinel */
}

/* If we've marked the process for this procsub as dead, close the
   associated file descriptor. */
static void
reap_some_procsubs (max)
     int max;
{
  int i;

  for (i = 0; nfds > 0 && i < max; i++)
    if (dev_fd_list[i] == (pid_t)-1)
      unlink_fifo (i);
}

void
reap_procsubs ()
{
  reap_some_procsubs (totfds);
}

#if 0
/* UNUSED */
void
wait_procsubs ()
{
  int i, r;

  for (i = 0; nfds > 0 && i < totfds; i++)
    {
      if (dev_fd_list[i] != (pid_t)-1 && dev_fd_list[i] > 0)
        {
          r = wait_for (dev_fd_list[i], 0);
          save_proc_status (dev_fd_list[i], r);
          dev_fd_list[i] = (pid_t)-1;
        }
    }
}
#endif

#if defined (NOTDEF)
print_dev_fd_list ()
{
  register int i;

  fprintf (stderr, "pid %ld: dev_fd_list:", (long)getpid ());
  fflush (stderr);

  for (i = 0; i < totfds; i++)
    {
      if (dev_fd_list[i])
        fprintf (stderr, " %d", i);
    }
  fprintf (stderr, "\n");
}
#endif /* NOTDEF */

static char *
make_dev_fd_filename (fd)
     int fd;
{
  char *ret, intbuf[INT_STRLEN_BOUND (int) + 1], *p;

  ret = (char *)xmalloc (sizeof (DEV_FD_PREFIX) + 8);

  strcpy (ret, DEV_FD_PREFIX);
  p = inttostr (fd, intbuf, sizeof (intbuf));
  strcpy (ret + sizeof (DEV_FD_PREFIX) - 1, p);

  add_fifo_list (fd);
  return (ret);
}

#endif /* HAVE_DEV_FD */

/* Return a filename that will open a connection to the process defined by
   executing STRING.  HAVE_DEV_FD, if defined, means open a pipe and return
   a filename in /dev/fd corresponding to a descriptor that is one of the
   ends of the pipe.  If not defined, we use named pipes on systems that have
   them.  Systems without /dev/fd and named pipes are out of luck.

   OPEN_FOR_READ_IN_CHILD, if 1, means open the named pipe for reading or
   use the read end of the pipe and dup that file descriptor to fd 0 in
   the child.  If OPEN_FOR_READ_IN_CHILD is 0, we open the named pipe for
   writing or use the write end of the pipe in the child, and dup that
   file descriptor to fd 1 in the child.  The parent does the opposite. */

static char *
process_substitute (string, open_for_read_in_child)
     char *string;
     int open_for_read_in_child;
{
  char *pathname;
  int fd, result, rc, function_value;
  pid_t old_pid, pid;
#if defined (HAVE_DEV_FD)
  int parent_pipe_fd, child_pipe_fd;
  int fildes[2];
#endif /* HAVE_DEV_FD */
#if defined (JOB_CONTROL)
  pid_t old_pipeline_pgrp;
#endif

  if (!string || !*string || wordexp_only)
    return ((char *)NULL);

#if !defined (HAVE_DEV_FD)
  pathname = make_named_pipe ();
#else /* HAVE_DEV_FD */
  if (pipe (fildes) < 0)
    {
      sys_error ("%s", _("cannot make pipe for process substitution"));
      return ((char *)NULL);
    }
  /* If OPEN_FOR_READ_IN_CHILD == 1, we want to use the write end of
     the pipe in the parent, otherwise the read end. */
  parent_pipe_fd = fildes[open_for_read_in_child];
  child_pipe_fd = fildes[1 - open_for_read_in_child];
  /* Move the parent end of the pipe to some high file descriptor, to
     avoid clashes with FDs used by the script. */
  parent_pipe_fd = move_to_high_fd (parent_pipe_fd, 1, 64);

  pathname = make_dev_fd_filename (parent_pipe_fd);
#endif /* HAVE_DEV_FD */

  if (pathname == 0)
    {
      sys_error ("%s", _("cannot make pipe for process substitution"));
      return ((char *)NULL);
    }

  old_pid = last_made_pid;

#if defined (JOB_CONTROL)
  old_pipeline_pgrp = pipeline_pgrp;
  if (pipeline_pgrp == 0 || (subshell_environment & (SUBSHELL_PIPE|SUBSHELL_FORK|SUBSHELL_ASYNC)) == 0)
    pipeline_pgrp = shell_pgrp;
  save_pipeline (1);
#endif /* JOB_CONTROL */

  pid = make_child ((char *)NULL, FORK_ASYNC);
  if (pid == 0)
    {
#if 0
      int old_interactive;

      old_interactive = interactive;
#endif
      /* The currently-executing shell is not interactive */
      interactive = 0;

      reset_terminating_signals ();     /* XXX */
      free_pushed_string_input ();
      /* Cancel traps, in trap.c. */
      restore_original_signals ();      /* XXX - what about special builtins? bash-4.2 */
      subshell_environment &= ~SUBSHELL_IGNTRAP;
      QUIT;     /* catch any interrupts we got post-fork */
      setup_async_signals ();
#if 0
      if (open_for_read_in_child == 0 && old_interactive && (bash_input.type == st_stdin || bash_input.type == st_stream))
        async_redirect_stdin ();
#endif

      subshell_environment |= SUBSHELL_COMSUB|SUBSHELL_PROCSUB|SUBSHELL_ASYNC;

      /* We don't inherit the verbose option for command substitutions now, so
         let's try it for process substitutions. */
      change_flag ('v', FLAG_OFF);

      /* if we're expanding a redirection, we shouldn't have access to the
         temporary environment, but commands in the subshell should have
         access to their own temporary environment. */
      if (expanding_redir)
        flush_temporary_env ();
    }

#if defined (JOB_CONTROL)
  set_sigchld_handler ();
  stop_making_children ();
  /* XXX - should we only do this in the parent? (as in command subst) */
  pipeline_pgrp = old_pipeline_pgrp;
#else
  stop_making_children ();
#endif /* JOB_CONTROL */

  if (pid < 0)
    {
      sys_error ("%s", _("cannot make child for process substitution"));
      free (pathname);
#if defined (HAVE_DEV_FD)
      close (parent_pipe_fd);
      close (child_pipe_fd);
#endif /* HAVE_DEV_FD */
#if defined (JOB_CONTROL)
      restore_pipeline (1);
#endif
      return ((char *)NULL);
    }

  if (pid > 0)
    {
#if defined (JOB_CONTROL)
      last_procsub_child = restore_pipeline (0);
      /* We assume that last_procsub_child->next == last_procsub_child because
         of how jobs.c:add_process() works. */
      last_procsub_child->next = 0;
      procsub_add (last_procsub_child);
#endif

#if defined (HAVE_DEV_FD)
      dev_fd_list[parent_pipe_fd] = pid;
#else
      fifo_list[nfifo-1].proc = pid;
#endif

      last_made_pid = old_pid;

#if defined (JOB_CONTROL) && defined (PGRP_PIPE)
      close_pgrp_pipe ();
#endif /* JOB_CONTROL && PGRP_PIPE */

#if defined (HAVE_DEV_FD)
      close (child_pipe_fd);
#endif /* HAVE_DEV_FD */

      return (pathname);
    }

  set_sigint_handler ();

#if defined (JOB_CONTROL)
  /* make sure we don't have any job control */
  set_job_control (0);

  /* Clear out any existing list of process substitutions */
  procsub_clear ();

  /* The idea is that we want all the jobs we start from an async process
     substitution to be in the same process group, but not the same pgrp
     as our parent shell, since we don't want to affect our parent shell's
     jobs if we get a SIGHUP and end up calling hangup_all_jobs, for example.
     If pipeline_pgrp != shell_pgrp, we assume that there is a job control
     shell somewhere in our parent process chain (since make_child initializes
     pipeline_pgrp to shell_pgrp if job_control == 0). What we do in this
     case is to set pipeline_pgrp to our PID, so all jobs started by this
     process have that same pgrp and we are basically the process group leader.
     This should not have negative effects on child processes surviving
     after we exit, since we wait for the children we create, but that is
     something to watch for. */

  if (pipeline_pgrp != shell_pgrp)
    pipeline_pgrp = getpid ();
#endif /* JOB_CONTROL */

#if !defined (HAVE_DEV_FD)
  /* Open the named pipe in the child. */
  fd = open (pathname, open_for_read_in_child ? O_RDONLY : O_WRONLY);
  if (fd < 0)
    {
      /* Two separate strings for ease of translation. */
      if (open_for_read_in_child)
        sys_error (_("cannot open named pipe %s for reading"), pathname);
      else
        sys_error (_("cannot open named pipe %s for writing"), pathname);

      exit (127);
    }
  if (open_for_read_in_child)
    {
      if (sh_unset_nodelay_mode (fd) < 0)
        {
          sys_error (_("cannot reset nodelay mode for fd %d"), fd);
          exit (127);
        }
    }
#else /* HAVE_DEV_FD */
  fd = child_pipe_fd;
#endif /* HAVE_DEV_FD */

  /* Discard  buffered stdio output before replacing the underlying file
     descriptor. */
  if (open_for_read_in_child == 0)
    fpurge (stdout);

  if (dup2 (fd, open_for_read_in_child ? 0 : 1) < 0)
    {
      sys_error (_("cannot duplicate named pipe %s as fd %d"), pathname,
        open_for_read_in_child ? 0 : 1);
      exit (127);
    }

  if (fd != (open_for_read_in_child ? 0 : 1))
    close (fd);

  /* Need to close any files that this process has open to pipes inherited
     from its parent. */
  if (current_fds_to_close)
    {
      close_fd_bitmap (current_fds_to_close);
      current_fds_to_close = (struct fd_bitmap *)NULL;
    }

#if defined (HAVE_DEV_FD)
  /* Make sure we close the parent's end of the pipe and clear the slot
     in the fd list so it is not closed later, if reallocated by, for
     instance, pipe(2). */
  close (parent_pipe_fd);
  dev_fd_list[parent_pipe_fd] = 0;
#endif /* HAVE_DEV_FD */

  /* subshells shouldn't have this flag, which controls using the temporary
     environment for variable lookups.  We have already flushed the temporary
     environment above in the case we're expanding a redirection, so processes
     executed by this command need to be able to set it independently of their
     parent. */
  expanding_redir = 0;

  remove_quoted_escapes (string);

  startup_state = 2;    /* see if we can avoid a fork */
  parse_and_execute_level = 0;

  /* Give process substitution a place to jump back to on failure,
     so we don't go back up to main (). */
  result = setjmp_nosigs (top_level);

  /* If we're running a process substitution inside a shell function,
     trap `return' so we don't return from the function in the subshell
     and go off to never-never land. */
  if (result == 0 && return_catch_flag)
    function_value = setjmp_nosigs (return_catch);
  else
    function_value = 0;

  if (result == ERREXIT)
    rc = last_command_exit_value;
  else if (result == EXITPROG || result == EXITBLTIN)
    rc = last_command_exit_value;
  else if (result)
    rc = EXECUTION_FAILURE;
  else if (function_value)
    rc = return_catch_value;
  else
    {
      subshell_level++;
      rc = parse_and_execute (string, "process substitution", (SEVAL_NONINT|SEVAL_NOHIST));
      /* leave subshell level intact for any exit trap */
    }

#if !defined (HAVE_DEV_FD)
  /* Make sure we close the named pipe in the child before we exit. */
  close (open_for_read_in_child ? 0 : 1);
#endif /* !HAVE_DEV_FD */

  last_command_exit_value = rc;
  rc = run_exit_trap ();
  exit (rc);
  /*NOTREACHED*/
}
#endif /* PROCESS_SUBSTITUTION */

/***********************************/
/*                                 */
/*      Command Substitution       */
/*                                 */
/***********************************/

#define COMSUB_PIPEBUF  4096

static char *
optimize_cat_file (r, quoted, flags, flagp)
     REDIRECT *r;
     int quoted, flags, *flagp;
{
  char *ret;
  int fd;

  fd = open_redir_file (r, (char **)0);
  if (fd < 0)
    return &expand_param_error;

  ret = read_comsub (fd, quoted, flags, flagp);
  close (fd);

  return ret;
}

static char *
read_comsub (fd, quoted, flags, rflag)
     int fd, quoted, flags;
     int *rflag;
{
  char *istring, buf[COMSUB_PIPEBUF], *bufp;
  int c, tflag, skip_ctlesc, skip_ctlnul;
  int mb_cur_max;
  size_t istring_index;
  size_t istring_size;
  ssize_t bufn;
  int nullbyte;
#if defined (HANDLE_MULTIBYTE)
  mbstate_t ps;
  wchar_t wc;
  size_t mblen;
  int i;
#endif

  istring = (char *)NULL;
  istring_index = istring_size = bufn = tflag = 0;

  skip_ctlesc = ifs_cmap[CTLESC];
  skip_ctlnul = ifs_cmap[CTLNUL];

  mb_cur_max = MB_CUR_MAX;
  nullbyte = 0;

  /* Read the output of the command through the pipe. */
  while (1)
    {
      if (fd < 0)
        break;
      if (--bufn <= 0)
        {
          bufn = zread (fd, buf, sizeof (buf));
          if (bufn <= 0) 
            break;
          bufp = buf;
        }
      c = *bufp++;

      if (c == 0)
        {
#if 1
          if (nullbyte == 0)
            {
              internal_warning ("%s", _("command substitution: ignored null byte in input"));
              nullbyte = 1;
            }
#endif
          continue;
        }

      /* Add the character to ISTRING, possibly after resizing it. */
      RESIZE_MALLOCED_BUFFER (istring, istring_index, mb_cur_max+1, istring_size, 512);

      /* This is essentially quote_string inline */
      if ((quoted & (Q_HERE_DOCUMENT|Q_DOUBLE_QUOTES)) /* || c == CTLESC || c == CTLNUL */)
        istring[istring_index++] = CTLESC;
      else if ((flags & PF_ASSIGNRHS) && skip_ctlesc && c == CTLESC)
        istring[istring_index++] = CTLESC;
      /* Escape CTLESC and CTLNUL in the output to protect those characters
         from the rest of the word expansions (word splitting and globbing.)
         This is essentially quote_escapes inline. */
      else if (skip_ctlesc == 0 && c == CTLESC)
        istring[istring_index++] = CTLESC;
      else if ((skip_ctlnul == 0 && c == CTLNUL) || (c == ' ' && (ifs_value && *ifs_value == 0)))
        istring[istring_index++] = CTLESC;

#if defined (HANDLE_MULTIBYTE)
      if ((locale_utf8locale && (c & 0x80)) ||
          (locale_utf8locale == 0 && mb_cur_max > 1 && (unsigned char)c > 127))
        {
          /* read a multibyte character from buf */
          /* punt on the hard case for now */
          memset (&ps, '\0', sizeof (mbstate_t));
          mblen = mbrtowc (&wc, bufp-1, bufn, &ps);
          if (MB_INVALIDCH (mblen) || mblen == 0 || mblen == 1)
            istring[istring_index++] = c;
          else
            {
              istring[istring_index++] = c;
              for (i = 0; i < mblen-1; i++)
                istring[istring_index++] = *bufp++;
              bufn -= mblen - 1;
            }
          continue;
        }
#endif

      istring[istring_index++] = c;
    }

  if (istring)
    istring[istring_index] = '\0';

  /* If we read no output, just return now and save ourselves some
     trouble. */
  if (istring_index == 0)
    {
      FREE (istring);
      if (rflag)
        *rflag = tflag;
      return (char *)NULL;
    }

  /* Strip trailing newlines from the output of the command. */
  if (quoted & (Q_HERE_DOCUMENT|Q_DOUBLE_QUOTES))
    {
      while (istring_index > 0)
        {
          if (istring[istring_index - 1] == '\n')
            {
              --istring_index;

              /* If the newline was quoted, remove the quoting char. */
              if (istring[istring_index - 1] == CTLESC)
                --istring_index;
            }
          else
            break;
        }
      istring[istring_index] = '\0';
    }
  else
    strip_trailing (istring, istring_index - 1, 1);

  if (rflag)
    *rflag = tflag;
  return istring;
}

/* Perform command substitution on STRING.  This returns a WORD_DESC * with the
   contained string possibly quoted. */
WORD_DESC *
command_substitute (string, quoted, flags)
     char *string;
     int quoted;
     int flags;
{
  pid_t pid, old_pid, old_pipeline_pgrp, old_async_pid;
  char *istring, *s;
  int result, fildes[2], function_value, pflags, rc, tflag, fork_flags;
  WORD_DESC *ret;
  sigset_t set, oset;

  istring = (char *)NULL;

  /* Don't fork () if there is no need to.  In the case of no command to
     run, just return NULL. */
  for (s = string; s && *s && (shellblank (*s) || *s == '\n'); s++)
    ;
  if (s == 0 || *s == 0)
    return ((WORD_DESC *)NULL);

  if (*s == '<' && (s[1] != '<' && s[1] != '>' && s[1] != '&'))
    {
      COMMAND *cmd;

      cmd = parse_string_to_command (string, 0);        /* XXX - flags */
      if (cmd && can_optimize_cat_file (cmd))
        {
          tflag = 0;
          istring = optimize_cat_file (cmd->value.Simple->redirects, quoted, flags, &tflag);
          if (istring == &expand_param_error)
            {
              last_command_exit_value = EXECUTION_FAILURE;
              istring = 0;
            }
          else
            last_command_exit_value = EXECUTION_SUCCESS;        /* compat */
          last_command_subst_pid = dollar_dollar_pid;

          dispose_command (cmd);          
          ret = alloc_word_desc ();
          ret->word = istring;
          ret->flags = tflag;

          return ret;
        }
      dispose_command (cmd);
    }

  if (wordexp_only && read_but_dont_execute)
    {
      last_command_exit_value = EX_WEXPCOMSUB;
      jump_to_top_level (EXITPROG);
    }

  /* We're making the assumption here that the command substitution will
     eventually run a command from the file system.  Since we'll run
     maybe_make_export_env in this subshell before executing that command,
     the parent shell and any other shells it starts will have to remake
     the environment.  If we make it before we fork, other shells won't
     have to.  Don't bother if we have any temporary variable assignments,
     though, because the export environment will be remade after this
     command completes anyway, but do it if all the words to be expanded
     are variable assignments. */
  if (subst_assign_varlist == 0 || garglist == 0)
    maybe_make_export_env ();   /* XXX */

  /* Flags to pass to parse_and_execute() */
  pflags = (interactive && sourcelevel == 0) ? SEVAL_RESETLINE : 0;

  old_pid = last_made_pid;

  /* Pipe the output of executing STRING into the current shell. */
  if (pipe (fildes) < 0)
    {
      sys_error ("%s", _("cannot make pipe for command substitution"));
      goto error_exit;
    }

#if defined (JOB_CONTROL)
  old_pipeline_pgrp = pipeline_pgrp;
  /* Don't reset the pipeline pgrp if we're already a subshell in a pipeline or
     we've already forked to run a disk command (and are expanding redirections,
     for example). */
  if ((subshell_environment & (SUBSHELL_FORK|SUBSHELL_PIPE)) == 0)
    pipeline_pgrp = shell_pgrp;
  cleanup_the_pipeline ();
#endif /* JOB_CONTROL */

  old_async_pid = last_asynchronous_pid;
  fork_flags = (subshell_environment&SUBSHELL_ASYNC) ? FORK_ASYNC : 0;
  pid = make_child ((char *)NULL, fork_flags|FORK_NOTERM);
  last_asynchronous_pid = old_async_pid;

  if (pid == 0)
    {
      /* Reset the signal handlers in the child, but don't free the
         trap strings.  Set a flag noting that we have to free the
         trap strings if we run trap to change a signal disposition. */
      reset_signal_handlers ();
      if (ISINTERRUPT)
        {
          kill (getpid (), SIGINT);
          CLRINTERRUPT;         /* if we're ignoring SIGINT somehow */
        }       
      QUIT;     /* catch any interrupts we got post-fork */
      subshell_environment |= SUBSHELL_RESETTRAP;
      subshell_environment &= ~SUBSHELL_IGNTRAP;
    }

#if defined (JOB_CONTROL)
  /* XXX DO THIS ONLY IN PARENT ? XXX */
  set_sigchld_handler ();
  stop_making_children ();
  if (pid != 0)
    pipeline_pgrp = old_pipeline_pgrp;
#else
  stop_making_children ();
#endif /* JOB_CONTROL */

  if (pid < 0)
    {
      sys_error (_("cannot make child for command substitution"));
    error_exit:

      last_made_pid = old_pid;

      FREE (istring);
      close (fildes[0]);
      close (fildes[1]);
      return ((WORD_DESC *)NULL);
    }

  if (pid == 0)
    {
      /* The currently executing shell is not interactive. */
      interactive = 0;

#if defined (JOB_CONTROL)
      /* Invariant: in child processes started to run command substitutions,
         pipeline_pgrp == shell_pgrp. Other parts of the shell assume this. */
      if (pipeline_pgrp > 0 && pipeline_pgrp != shell_pgrp)
        shell_pgrp = pipeline_pgrp;
#endif

      set_sigint_handler ();    /* XXX */

      free_pushed_string_input ();

      /* Discard  buffered stdio output before replacing the underlying file
         descriptor. */
      fpurge (stdout);

      if (dup2 (fildes[1], 1) < 0)
        {
          sys_error ("%s", _("command_substitute: cannot duplicate pipe as fd 1"));
          exit (EXECUTION_FAILURE);
        }

      /* If standard output is closed in the parent shell
         (such as after `exec >&-'), file descriptor 1 will be
         the lowest available file descriptor, and end up in
         fildes[0].  This can happen for stdin and stderr as well,
         but stdout is more important -- it will cause no output
         to be generated from this command. */
      if ((fildes[1] != fileno (stdin)) &&
          (fildes[1] != fileno (stdout)) &&
          (fildes[1] != fileno (stderr)))
        close (fildes[1]);

      if ((fildes[0] != fileno (stdin)) &&
          (fildes[0] != fileno (stdout)) &&
          (fildes[0] != fileno (stderr)))
        close (fildes[0]);

#ifdef __CYGWIN__
      /* Let stdio know the fd may have changed from text to binary mode, and
         make sure to preserve stdout line buffering. */
      freopen (NULL, "w", stdout);
      sh_setlinebuf (stdout);
#endif /* __CYGWIN__ */

      /* This is a subshell environment. */
      subshell_environment |= SUBSHELL_COMSUB;

      /* Many shells do not appear to inherit the -v option for command
         substitutions. */
      change_flag ('v', FLAG_OFF);

      /* When inherit_errexit option is not enabled, command substitution does
         not inherit the -e flag.  It is enabled when Posix mode is enabled */
      if (inherit_errexit == 0)
        {
          builtin_ignoring_errexit = 0;
          change_flag ('e', FLAG_OFF);
        }
      set_shellopts ();

      /* If we are expanding a redirection, we can dispose of any temporary
         environment we received, since redirections are not supposed to have
         access to the temporary environment.  We will have to see whether this
         affects temporary environments supplied to `eval', but the temporary
         environment gets copied to builtin_env at some point. */
      if (expanding_redir)
        {
          flush_temporary_env ();
          expanding_redir = 0;
        }

      remove_quoted_escapes (string);

      /* We want to expand aliases on this pass if we are not in posix mode
         for backwards compatibility. */
      if (expand_aliases)
        expand_aliases = posixly_correct == 0;

      startup_state = 2;        /* see if we can avoid a fork */
      parse_and_execute_level = 0;

      /* Give command substitution a place to jump back to on failure,
         so we don't go back up to main (). */
      result = setjmp_nosigs (top_level);

      /* If we're running a command substitution inside a shell function,
         trap `return' so we don't return from the function in the subshell
         and go off to never-never land. */
      if (result == 0 && return_catch_flag)
        function_value = setjmp_nosigs (return_catch);
      else
        function_value = 0;

      if (result == ERREXIT)
        rc = last_command_exit_value;
      else if (result == EXITPROG || result == EXITBLTIN)
        rc = last_command_exit_value;
      else if (result)
        rc = EXECUTION_FAILURE;
      else if (function_value)
        rc = return_catch_value;
      else
        {
          subshell_level++;
          rc = parse_and_execute (string, "command substitution", pflags|SEVAL_NOHIST);
          /* leave subshell level intact for any exit trap */
        }

      last_command_exit_value = rc;
      rc = run_exit_trap ();
#if defined (PROCESS_SUBSTITUTION)
      unlink_fifo_list ();
#endif
      exit (rc);
    }
  else
    {
      int dummyfd;

#if defined (JOB_CONTROL) && defined (PGRP_PIPE)
      close_pgrp_pipe ();
#endif /* JOB_CONTROL && PGRP_PIPE */

      close (fildes[1]);

      begin_unwind_frame ("read-comsub");
      dummyfd = fildes[0];
      add_unwind_protect (close, dummyfd);

      /* Block SIGINT while we're reading from the pipe. If the child
         process gets a SIGINT, it will either handle it or die, and the
         read will return. */
      BLOCK_SIGNAL (SIGINT, set, oset);
      tflag = 0;
      istring = read_comsub (fildes[0], quoted, flags, &tflag);

      close (fildes[0]);
      discard_unwind_frame ("read-comsub");
      UNBLOCK_SIGNAL (oset);

      current_command_subst_pid = pid;
      last_command_exit_value = wait_for (pid, JWAIT_NOTERM);
      last_command_subst_pid = pid;
      last_made_pid = old_pid;

#if defined (JOB_CONTROL)
      /* If last_command_exit_value > 128, then the substituted command
         was terminated by a signal.  If that signal was SIGINT, then send
         SIGINT to ourselves.  This will break out of loops, for instance. */
      if (last_command_exit_value == (128 + SIGINT) && last_command_exit_signal == SIGINT)
        kill (getpid (), SIGINT);
#endif /* JOB_CONTROL */

      ret = alloc_word_desc ();
      ret->word = istring;
      ret->flags = tflag;

      return ret;
    }
}

/********************************************************
 *                                                      *
 *      Utility functions for parameter expansion       *
 *                                                      *
 ********************************************************/

#if defined (ARRAY_VARS)

static arrayind_t
array_length_reference (s)
     char *s;
{
  int len;
  arrayind_t ind;
  char *akey;
  char *t, c;
  ARRAY *array;
  HASH_TABLE *h;
  SHELL_VAR *var;

  var = array_variable_part (s, 0, &t, &len);

  /* If unbound variables should generate an error, report one and return
     failure. */
  if ((var == 0 || invisible_p (var) || (assoc_p (var) == 0 && array_p (var) == 0)) && unbound_vars_is_error)
    {
      c = *--t;
      *t = '\0';
      set_exit_status (EXECUTION_FAILURE);
      err_unboundvar (s);
      *t = c;
      return (-1);
    }
  else if (var == 0 || invisible_p (var))
    return 0;

  /* We support a couple of expansions for variables that are not arrays.
     We'll return the length of the value for v[0], and 1 for v[@] or
     v[*].  Return 0 for everything else. */

  array = array_p (var) ? array_cell (var) : (ARRAY *)NULL;
  h = assoc_p (var) ? assoc_cell (var) : (HASH_TABLE *)NULL;

  if (ALL_ELEMENT_SUB (t[0]) && t[1] == RBRACK)
    {
      if (assoc_p (var))
        return (h ? assoc_num_elements (h) : 0);
      else if (array_p (var))
        return (array ? array_num_elements (array) : 0);
      else
        return (var_isset (var) ? 1 : 0);
    }

  if (assoc_p (var))
    {
      t[len - 1] = '\0';
      akey = expand_subscript_string (t, 0);    /* [ */
      t[len - 1] = RBRACK;
      if (akey == 0 || *akey == 0)
        {
          err_badarraysub (t);
          FREE (akey);
          return (-1);
        }
      t = assoc_reference (assoc_cell (var), akey);
      free (akey);
    }
  else
    {
      ind = array_expand_index (var, t, len, 0);
      /* negative subscripts to indexed arrays count back from end */
      if (var && array_p (var) && ind < 0)
        ind = array_max_index (array_cell (var)) + 1 + ind;
      if (ind < 0)
        {
          err_badarraysub (t);
          return (-1);
        }
      if (array_p (var))
        t = array_reference (array, ind);
      else
        t = (ind == 0) ? value_cell (var) : (char *)NULL;
    }

  len = MB_STRLEN (t);
  return (len);
}
#endif /* ARRAY_VARS */

static int
valid_brace_expansion_word (name, var_is_special)
     char *name;
     int var_is_special;
{
  if (DIGIT (*name) && all_digits (name))
    return 1;
  else if (var_is_special)
    return 1;
#if defined (ARRAY_VARS)
  else if (valid_array_reference (name, 0))
    return 1;
#endif /* ARRAY_VARS */
  else if (legal_identifier (name))
    return 1;
  else
    return 0;
}

static int
chk_atstar (name, quoted, pflags, quoted_dollar_atp, contains_dollar_at)
     char *name;
     int quoted, pflags;
     int *quoted_dollar_atp, *contains_dollar_at;
{
  char *temp1;

  if (name == 0)
    {
      if (quoted_dollar_atp)
        *quoted_dollar_atp = 0;
      if (contains_dollar_at)
        *contains_dollar_at = 0;
      return 0;
    }

  /* check for $@ and $* */
  if (name[0] == '@' && name[1] == 0)
    {
      if ((quoted & (Q_HERE_DOCUMENT|Q_DOUBLE_QUOTES)) && quoted_dollar_atp)
        *quoted_dollar_atp = 1;
      if (contains_dollar_at)
        *contains_dollar_at = 1;
      return 1;
    }
  else if (name[0] == '*' && name[1] == '\0' && quoted == 0)
    {
      /* Need more checks here that parallel what string_list_pos_params and
         param_expand do. Check expand_no_split_dollar_star and ??? */
      if (contains_dollar_at && expand_no_split_dollar_star == 0)
        *contains_dollar_at = 1;
      return 1;
    }

  /* Now check for ${array[@]} and ${array[*]} */
#if defined (ARRAY_VARS)
  else if (valid_array_reference (name, 0))
    {
      temp1 = mbschr (name, LBRACK);
      if (temp1 && temp1[1] == '@' && temp1[2] == RBRACK)
        {
          if ((quoted & (Q_HERE_DOCUMENT|Q_DOUBLE_QUOTES)) && quoted_dollar_atp)
            *quoted_dollar_atp = 1;
          if (contains_dollar_at)
            *contains_dollar_at = 1;
          return 1;
        }
      /* ${array[*]}, when unquoted, should be treated like ${array[@]},
         which should result in separate words even when IFS is unset. */
      if (temp1 && temp1[1] == '*' && temp1[2] == RBRACK && quoted == 0)
        {
          if (contains_dollar_at)
            *contains_dollar_at = 1;
          return 1;
        }
    }
#endif
  return 0;
}

/* Parameter expand NAME, and return a new string which is the expansion,
   or NULL if there was no expansion.  NAME is as given in ${NAMEcWORD}.
   VAR_IS_SPECIAL is non-zero if NAME is one of the special variables in
   the shell, e.g., "@", "$", "*", etc.  QUOTED, if non-zero, means that
   NAME was found inside of a double-quoted expression. */
static WORD_DESC *
parameter_brace_expand_word (name, var_is_special, quoted, pflags, estatep)
     char *name;
     int var_is_special, quoted, pflags;
     array_eltstate_t *estatep;
{
  WORD_DESC *ret;
  char *temp, *tt;
  intmax_t arg_index;
  SHELL_VAR *var;
  int rflags;
  array_eltstate_t es;

  ret = 0;
  temp = 0;
  rflags = 0;

#if defined (ARRAY_VARS)
  if (estatep)
    es = *estatep;      /* structure copy */
  else
    {
      init_eltstate (&es);
      es.ind = INTMAX_MIN;
    }
#endif

  /* Handle multiple digit arguments, as in ${11}. */  
  if (legal_number (name, &arg_index))
    {
      tt = get_dollar_var_value (arg_index);
      if (tt)
        temp = (*tt && (quoted & (Q_DOUBLE_QUOTES|Q_HERE_DOCUMENT)))
                  ? quote_string (tt)
                  : quote_escapes (tt);
      else
        temp = (char *)NULL;
      FREE (tt);
    }
  else if (var_is_special)      /* ${@} */
    {
      int sindex;
      tt = (char *)xmalloc (2 + strlen (name));
      tt[sindex = 0] = '$';
      strcpy (tt + 1, name);

      ret = param_expand (tt, &sindex, quoted, (int *)NULL, (int *)NULL,
                          (int *)NULL, (int *)NULL, pflags);

      /* Make sure we note that we saw a quoted null string and pass the flag back
         to the caller in addition to the value. */
      if ((quoted & (Q_DOUBLE_QUOTES|Q_HERE_DOCUMENT)) && STR_DOLLAR_AT_STAR (name) &&
          ret && ret->word && QUOTED_NULL (ret->word))
        ret->flags |= W_HASQUOTEDNULL;

      free (tt);
    }
#if defined (ARRAY_VARS)
  else if (valid_array_reference (name, 0))
    {
expand_arrayref:
      var = array_variable_part (name, 0, &tt, (int *)0);
      /* These are the cases where word splitting will not be performed */
      if (pflags & PF_ASSIGNRHS)
        {
          if (ALL_ELEMENT_SUB (tt[0]) && tt[1] == RBRACK)
            {
              /* Only treat as double quoted if array variable */
              if (var && (array_p (var) || assoc_p (var)))
                temp = array_value (name, quoted|Q_DOUBLE_QUOTES, AV_ASSIGNRHS, &es);
              else              
                temp = array_value (name, quoted, 0, &es);
            }
          else
            temp = array_value (name, quoted, 0, &es);
        }
      /* Posix interp 888 */
      else if (pflags & PF_NOSPLIT2)
        {
          /* Special cases, then general case, for each of A[@], A[*], A[n] */
#if defined (HANDLE_MULTIBYTE)
          if (tt[0] == '@' && tt[1] == RBRACK && var && quoted == 0 && ifs_is_set && ifs_is_null == 0 && ifs_firstc[0] != ' ')
#else
          if (tt[0] == '@' && tt[1] == RBRACK && var && quoted == 0 && ifs_is_set && ifs_is_null == 0 && ifs_firstc != ' ')
#endif
            temp = array_value (name, Q_DOUBLE_QUOTES, AV_ASSIGNRHS, &es);
          else if (tt[0] == '@' && tt[1] == RBRACK)
            temp = array_value (name, quoted, 0, &es);
          else if (tt[0] == '*' && tt[1] == RBRACK && expand_no_split_dollar_star && ifs_is_null)
            temp = array_value (name, Q_DOUBLE_QUOTES|Q_HERE_DOCUMENT, 0, &es);
          else if (tt[0] == '*' && tt[1] == RBRACK)
            temp = array_value (name, quoted, 0, &es);
          else
            temp = array_value (name, quoted, 0, &es);
        }                 
      else if (tt[0] == '*' && tt[1] == RBRACK && expand_no_split_dollar_star && ifs_is_null)
        temp = array_value (name, Q_DOUBLE_QUOTES|Q_HERE_DOCUMENT, 0, &es);
      else
        temp = array_value (name, quoted, 0, &es);
      if (es.subtype == 0 && temp)
        {
          temp = (*temp && (quoted & (Q_DOUBLE_QUOTES|Q_HERE_DOCUMENT)))
                    ? quote_string (temp)
                    : quote_escapes (temp);
          rflags |= W_ARRAYIND;
          if (estatep)
            *estatep = es;      /* structure copy */
        }
      /* Note that array[*] and array[@] expanded to a quoted null string by
         returning the W_HASQUOTEDNULL flag to the caller in addition to TEMP. */
      else if (es.subtype == 1 && temp && QUOTED_NULL (temp) && (quoted & (Q_DOUBLE_QUOTES|Q_HERE_DOCUMENT)))
        rflags |= W_HASQUOTEDNULL;
      else if (es.subtype == 2 && temp && QUOTED_NULL (temp) && (quoted & (Q_DOUBLE_QUOTES|Q_HERE_DOCUMENT)))
        rflags |= W_HASQUOTEDNULL;

      if (estatep == 0)
        flush_eltstate (&es);
    }
#endif
  else if (var = find_variable (name))
    {
      if (var_isset (var) && invisible_p (var) == 0)
        {
#if defined (ARRAY_VARS)
          /* We avoid a memory leak by saving TT as the memory allocated by
             assoc_to_string or array_to_string and leaving it 0 otherwise,
             then freeing TT after quoting temp. */
          tt = (char *)NULL;
          if ((pflags & PF_ALLINDS) && assoc_p (var))
            tt = temp = assoc_empty (assoc_cell (var)) ? (char *)NULL : assoc_to_string (assoc_cell (var), " ", quoted);
          else if ((pflags & PF_ALLINDS) && array_p (var))
            tt = temp = array_empty (array_cell (var)) ? (char *)NULL : array_to_string (array_cell (var), " ", quoted);
          else if (assoc_p (var))
            temp = assoc_reference (assoc_cell (var), "0");
          else if (array_p (var))
            temp = array_reference (array_cell (var), 0);
          else
            temp = value_cell (var);
#else
          temp = value_cell (var);
#endif

          if (temp)
            temp = (*temp && (quoted & (Q_DOUBLE_QUOTES|Q_HERE_DOCUMENT)))
                      ? quote_string (temp)
                      : ((pflags & PF_ASSIGNRHS) ? quote_rhs (temp)
                                                 : quote_escapes (temp));
          FREE (tt);
        }
      else
        temp = (char *)NULL;
    }
  else if (var = find_variable_last_nameref (name, 0))
    {
      temp = nameref_cell (var);
#if defined (ARRAY_VARS)
      /* Handle expanding nameref whose value is x[n] */
      if (temp && *temp && valid_array_reference (temp, 0))
        {
          name = temp;
          goto expand_arrayref;
        }
      else
#endif
      /* y=2 ; typeset -n x=y; echo ${x} is not the same as echo ${2} in ksh */
      if (temp && *temp && legal_identifier (temp) == 0)
        {
          set_exit_status (EXECUTION_FAILURE);
          report_error (_("%s: invalid variable name for name reference"), temp);
          temp = &expand_param_error;
        }
      else
        temp = (char *)NULL;
    }
  else
    temp = (char *)NULL;

  if (ret == 0)
    {
      ret = alloc_word_desc ();
      ret->word = temp;
      ret->flags |= rflags;
    }
  return ret;
}

static char *
parameter_brace_find_indir (name, var_is_special, quoted, find_nameref)
     char *name;
     int var_is_special, quoted, find_nameref;
{
  char *temp, *t;
  WORD_DESC *w;
  SHELL_VAR *v;
  int pflags, oldex;

  if (find_nameref && var_is_special == 0 && (v = find_variable_last_nameref (name, 0)) &&
      nameref_p (v) && (t = nameref_cell (v)) && *t)
    return (savestring (t));

  /* If var_is_special == 0, and name is not an array reference, this does
     more expansion than necessary.  It should really look up the variable's
     value and not try to expand it. */
  pflags = PF_IGNUNBOUND;
  /* Note that we're not going to be doing word splitting here */
  if (var_is_special)
    {
      pflags |= PF_ASSIGNRHS;   /* suppresses word splitting */
      oldex = expand_no_split_dollar_star;
      expand_no_split_dollar_star = 1;
    }
  w = parameter_brace_expand_word (name, var_is_special, quoted, pflags, 0);
  if (var_is_special)
    expand_no_split_dollar_star = oldex;

  t = w->word;
  /* Have to dequote here if necessary */
  if (t)
    {
      temp = ((quoted & (Q_DOUBLE_QUOTES|Q_HERE_DOCUMENT)) || var_is_special)
                ? dequote_string (t)
                : dequote_escapes (t);
      free (t);
      t = temp;
    }
  dispose_word_desc (w);

  return t;
}
  
/* Expand an indirect reference to a variable: ${!NAME} expands to the
   value of the variable whose name is the value of NAME. */
static WORD_DESC *
parameter_brace_expand_indir (name, var_is_special, quoted, pflags, quoted_dollar_atp, contains_dollar_at)
     char *name;
     int var_is_special, quoted, pflags;
     int *quoted_dollar_atp, *contains_dollar_at;
{
  char *t;
  WORD_DESC *w;
  SHELL_VAR *v;

  /* See if it's a nameref first, behave in ksh93-compatible fashion.
     There is at least one incompatibility: given ${!foo[0]} where foo=bar,
     bash performs an indirect lookup on foo[0] and expands the result;
     ksh93 expands bar[0].  We could do that here -- there are enough usable
     primitives to do that -- but do not at this point. */
  if (var_is_special == 0 && (v = find_variable_last_nameref (name, 0)))
    {
      if (nameref_p (v) && (t = nameref_cell (v)) && *t)
        {
          w = alloc_word_desc ();
          w->word = savestring (t);
          w->flags = 0;
          return w;
        }
    }

  /* An indirect reference to a positional parameter or a special parameter
     is ok.  Indirect references to array references, as explained above, are
     ok (currently).  Only references to unset variables are errors at this
     point. */
  if (legal_identifier (name) && v == 0)
    {
      report_error (_("%s: invalid indirect expansion"), name);
      w = alloc_word_desc ();
      w->word = &expand_param_error;
      w->flags = 0;
      return (w);
    }
      
  t = parameter_brace_find_indir (name, var_is_special, quoted, 0);

  chk_atstar (t, quoted, pflags, quoted_dollar_atp, contains_dollar_at);

#if defined (ARRAY_VARS)
  /* Array references to unset variables are also an error */
  if (t == 0 && valid_array_reference (name, 0))
    {
      v = array_variable_part (name, 0, (char **)0, (int *)0);
      if (v == 0)
        {
          report_error (_("%s: invalid indirect expansion"), name);
          w = alloc_word_desc ();
          w->word = &expand_param_error;
          w->flags = 0;
          return (w);
        }
      else
        return (WORD_DESC *)NULL;      
    }
#endif

  if (t == 0)
    return (WORD_DESC *)NULL;

  if (valid_brace_expansion_word (t, SPECIAL_VAR (t, 0)) == 0)
    {
      report_error (_("%s: invalid variable name"), t);
      free (t);
      w = alloc_word_desc ();
      w->word = &expand_param_error;
      w->flags = 0;
      return (w);
    }
        
  w = parameter_brace_expand_word (t, SPECIAL_VAR(t, 0), quoted, pflags, 0);
  free (t);

  return w;
}

/* Expand the right side of a parameter expansion of the form ${NAMEcVALUE},
   depending on the value of C, the separating character.  C can be one of
   "-", "+", or "=".  QUOTED is true if the entire brace expression occurs
   between double quotes. */
static WORD_DESC *
parameter_brace_expand_rhs (name, value, op, quoted, pflags, qdollaratp, hasdollarat)
     char *name, *value;
     int op, quoted, pflags, *qdollaratp, *hasdollarat;
{
  WORD_DESC *w;
  WORD_LIST *l, *tl;
  char *t, *t1, *temp, *vname, *newval;
  int l_hasdollat, sindex, arrayref;
  SHELL_VAR *v;
  array_eltstate_t es;

/*itrace("parameter_brace_expand_rhs: %s:%s pflags = %d", name, value, pflags);*/
  /* If the entire expression is between double quotes, we want to treat
     the value as a double-quoted string, with the exception that we strip
     embedded unescaped double quotes (for sh backwards compatibility). */
  if ((quoted & (Q_HERE_DOCUMENT|Q_DOUBLE_QUOTES)) && *value)
    {
      sindex = 0;
      temp = string_extract_double_quoted (value, &sindex, SX_STRIPDQ);
    }
  else
    temp = value;

  w = alloc_word_desc ();
  l_hasdollat = 0;
  l = *temp ? expand_string_for_rhs (temp, quoted, op, pflags, &l_hasdollat, (int *)NULL)
            : (WORD_LIST *)0;
  if (hasdollarat)
    *hasdollarat = l_hasdollat || (l && l->next);
  if (temp != value)
    free (temp);

  /* list_string takes multiple CTLNULs and turns them into an empty word
     with W_SAWQUOTEDNULL set. Turn it back into a single CTLNUL for the
     rest of this function and the caller. */
  for (tl = l; tl; tl = tl->next)
    {
      if (tl->word && (tl->word->word == 0 || tl->word->word[0] == 0) &&
            (tl->word->flags | W_SAWQUOTEDNULL))
        {
          t = make_quoted_char ('\0');
          FREE (tl->word->word);
          tl->word->word = t;
          tl->word->flags |= W_QUOTED|W_HASQUOTEDNULL;
          tl->word->flags &= ~W_SAWQUOTEDNULL;
        }
    }

  if (l)
    {
      /* If l->next is not null, we know that TEMP contained "$@", since that
         is the only expansion that creates more than one word. */
      if (qdollaratp && ((l_hasdollat && quoted) || l->next))
        {
/*itrace("parameter_brace_expand_rhs: %s:%s: l != NULL, set *qdollaratp", name, value);*/
          *qdollaratp = 1;
        }

      /* The expansion of TEMP returned something.  We need to treat things
          slightly differently if L_HASDOLLAT is non-zero.  If we have "$@",
          the individual words have already been quoted.  We need to turn them
          into a string with the words separated by the first character of
          $IFS without any additional quoting, so string_list_dollar_at won't
          do the right thing.  If IFS is null, we want "$@" to split into
          separate arguments, not be concatenated, so we use string_list_internal
          and mark the word to be split on spaces later.  We use
          string_list_dollar_star for "$@" otherwise. */
      if (l->next && ifs_is_null)
        {
          temp = string_list_internal (l, " ");
          w->flags |= W_SPLITSPACE;
        }
      else if (l_hasdollat || l->next)
        temp = string_list_dollar_star (l, quoted, 0);
      else
        {
          temp = string_list (l);
          if (temp && (QUOTED_NULL (temp) == 0) && (l->word->flags & W_SAWQUOTEDNULL))
            w->flags |= W_SAWQUOTEDNULL;        /* XXX */
        }

      /* If we have a quoted null result (QUOTED_NULL(temp)) and the word is
         a quoted null (l->next == 0 && QUOTED_NULL(l->word->word)), the
         flags indicate it (l->word->flags & W_HASQUOTEDNULL), and the
         expansion is quoted (quoted & (Q_HERE_DOCUMENT|Q_DOUBLE_QUOTES))
         (which is more paranoia than anything else), we need to return the
         quoted null string and set the flags to indicate it. */
      if (l->next == 0 && (quoted & (Q_HERE_DOCUMENT|Q_DOUBLE_QUOTES)) && QUOTED_NULL (temp) && QUOTED_NULL (l->word->word) && (l->word->flags & W_HASQUOTEDNULL))
        {
          w->flags |= W_HASQUOTEDNULL;
/*itrace("parameter_brace_expand_rhs (%s:%s): returning quoted null, turning off qdollaratp", name, value);*/
          /* If we return a quoted null with L_HASDOLLARAT, we either have a
             construct like "${@-$@}" or "${@-${@-$@}}" with no positional
             parameters or a quoted expansion of "$@" with $1 == ''.  In either
             case, we don't want to enable special handling of $@. */
          if (qdollaratp && l_hasdollat)
            *qdollaratp = 0;
        }
      dispose_words (l);
    }
  else if ((quoted & (Q_HERE_DOCUMENT|Q_DOUBLE_QUOTES)) && l_hasdollat)
    {
      /* Posix interp 221 changed the rules on this.  The idea is that
         something like "$xxx$@" should expand the same as "${foo-$xxx$@}"
         when foo and xxx are unset.  The problem is that it's not in any
         way backwards compatible and few other shells do it.  We're eventually
         going to try and split the difference (heh) a little bit here. */
      /* l_hasdollat == 1 means we saw a quoted dollar at.  */

      /* The brace expansion occurred between double quotes and there was
         a $@ in TEMP.  It does not matter if the $@ is quoted, as long as
         it does not expand to anything.  In this case, we want to return
         a quoted empty string.  Posix interp 888 */
      temp = make_quoted_char ('\0');
      w->flags |= W_HASQUOTEDNULL;
/*itrace("parameter_brace_expand_rhs (%s:%s): returning quoted null", name, value);*/
    }
  else
    temp = (char *)NULL;

  if (op == '-' || op == '+')
    {
      w->word = temp;
      return w;
    }

  /* op == '=' */
  t1 = temp ? dequote_string (temp) : savestring ("");
  free (temp);

  /* bash-4.4/5.0 */
  vname = name;
  if (*name == '!' &&
      (legal_variable_starter ((unsigned char)name[1]) || DIGIT (name[1]) || VALID_INDIR_PARAM (name[1])))
    {
      vname = parameter_brace_find_indir (name + 1, SPECIAL_VAR (name, 1), quoted, 1);
      if (vname == 0 || *vname == 0)
        {
          report_error (_("%s: invalid indirect expansion"), name);
          free (vname);
          free (t1);
          dispose_word (w);
          return &expand_wdesc_error;
        }
      if (legal_identifier (vname) == 0)
        {
          report_error (_("%s: invalid variable name"), vname);
          free (vname);
          free (t1);
          dispose_word (w);
          return &expand_wdesc_error;
        }
    }
    
  arrayref = 0;
#if defined (ARRAY_VARS)
  if (valid_array_reference (vname, 0))
    {
      init_eltstate (&es);
      v = assign_array_element (vname, t1, ASS_ALLOWALLSUB, &es);
      arrayref = 1;
      newval = es.value;
    }
  else
#endif /* ARRAY_VARS */
  v = bind_variable (vname, t1, 0);

  if (v == 0 || readonly_p (v) || noassign_p (v))       /* expansion error  */
    {
      if ((v == 0 || readonly_p (v)) && interactive_shell == 0 && posixly_correct)
        {
          last_command_exit_value = EXECUTION_FAILURE;
          exp_jump_to_top_level (FORCE_EOF);
        }
      else
        {
          if (vname != name)
            free (vname);
          last_command_exit_value = EX_BADUSAGE;
          exp_jump_to_top_level (DISCARD);
        }
    }

  stupidly_hack_special_variables (vname);

  /* "In all cases, the final value of parameter shall be substituted." */
  if (shell_compatibility_level > 51)
    {
      FREE (t1);
#if defined (ARRAY_VARS)
      if (arrayref)
        {
          t1 = newval;
          flush_eltstate (&es);
        }
      else
        t1 = get_variable_value (v);
#else
      t1 = value_cell (v);
#endif
    }

  if (vname != name)
    free (vname);

  /* From Posix group discussion Feb-March 2010.  Issue 7 0000221 */

  /* If we are double-quoted or if we are not going to be performing word
     splitting, we want to quote the value we return appropriately, like
     the other expansions this function handles. */
  w->word = (quoted & (Q_DOUBLE_QUOTES|Q_HERE_DOCUMENT)) ? quote_string (t1) : quote_escapes (t1);
  /* If we have something that's non-null, but not a quoted null string,
     and we're not going to be performing word splitting (we know we're not
     because the operator is `='), we can forget we saw a quoted null. */
  if (w->word && w->word[0] && QUOTED_NULL (w->word) == 0)
    w->flags &= ~W_SAWQUOTEDNULL;

  /* If we convert a null string into a quoted null, make sure the caller
     knows it. */
  if ((quoted & (Q_DOUBLE_QUOTES|Q_HERE_DOCUMENT)) && QUOTED_NULL (w->word))
    w->flags |= W_HASQUOTEDNULL;

  return w;
}

/* Deal with the right hand side of a ${name:?value} expansion in the case
   that NAME is null or not set.  If VALUE is non-null it is expanded and
   used as the error message to print, otherwise a standard message is
   printed. */
static void
parameter_brace_expand_error (name, value, check_null)
     char *name, *value;
     int check_null;
{
  WORD_LIST *l;
  char *temp;

  set_exit_status (EXECUTION_FAILURE);  /* ensure it's non-zero */
  if (value && *value)
    {
      l = expand_string (value, 0);
      temp =  string_list (l);
      report_error ("%s: %s", name, temp ? temp : "");  /* XXX was value not "" */
      FREE (temp);
      dispose_words (l);
    }
  else if (check_null == 0)
    report_error (_("%s: parameter not set"), name);
  else
    report_error (_("%s: parameter null or not set"), name);

  /* Free the data we have allocated during this expansion, since we
     are about to longjmp out. */
  free (name);
  FREE (value);
}

/* Return 1 if NAME is something for which parameter_brace_expand_length is
   OK to do. */
static int
valid_length_expression (name)
     char *name;
{
  return (name[1] == '\0' ||                                    /* ${#} */
          ((sh_syntaxtab[(unsigned char) name[1]] & CSPECVAR) && name[2] == '\0') ||  /* special param */
          (DIGIT (name[1]) && all_digits (name + 1)) || /* ${#11} */
#if defined (ARRAY_VARS)
          valid_array_reference (name + 1, 0) ||                /* ${#a[7]} */
#endif
          legal_identifier (name + 1));                         /* ${#PS1} */
}

/* Handle the parameter brace expansion that requires us to return the
   length of a parameter. */
static intmax_t
parameter_brace_expand_length (name)
     char *name;
{
  char *t, *newname;
  intmax_t number, arg_index;
  WORD_LIST *list;
  SHELL_VAR *var;

  var = (SHELL_VAR *)NULL;

  if (name[1] == '\0')                  /* ${#} */
    number = number_of_args ();
  else if (DOLLAR_AT_STAR (name[1]) && name[2] == '\0') /* ${#@}, ${#*} */
    number = number_of_args ();
  else if ((sh_syntaxtab[(unsigned char) name[1]] & CSPECVAR) && name[2] == '\0')
    {
      /* Take the lengths of some of the shell's special parameters. */
      switch (name[1])
        {
        case '-':
          t = which_set_flags ();
          break;
        case '?':
          t = itos (last_command_exit_value);
          break;
        case '$':
          t = itos (dollar_dollar_pid);
          break;
        case '!':
          if (last_asynchronous_pid == NO_PID)
            t = (char *)NULL;   /* XXX - error if set -u set? */
          else
            t = itos (last_asynchronous_pid);
          break;
        case '#':
          t = itos (number_of_args ());
          break;
        }
      number = STRLEN (t);
      FREE (t);
    }
#if defined (ARRAY_VARS)
  else if (valid_array_reference (name + 1, 0))
    number = array_length_reference (name + 1);
#endif /* ARRAY_VARS */
  else
    {
      number = 0;

      if (legal_number (name + 1, &arg_index))          /* ${#1} */
        {
          t = get_dollar_var_value (arg_index);
          if (t == 0 && unbound_vars_is_error)
            return INTMAX_MIN;
          number = MB_STRLEN (t);
          FREE (t);
        }
#if defined (ARRAY_VARS)
      else if ((var = find_variable (name + 1)) && (invisible_p (var) == 0) && (array_p (var) || assoc_p (var)))
        {
          if (assoc_p (var))
            t = assoc_reference (assoc_cell (var), "0");
          else
            t = array_reference (array_cell (var), 0);
          if (t == 0 && unbound_vars_is_error)
            return INTMAX_MIN;
          number = MB_STRLEN (t);
        }
#endif
      /* Fast path for the common case of taking the length of a non-dynamic
         scalar variable value. */
      else if ((var || (var = find_variable (name + 1))) &&
                invisible_p (var) == 0 &&
                array_p (var) == 0 && assoc_p (var) == 0 &&
                var->dynamic_value == 0)
        number = value_cell (var) ? MB_STRLEN (value_cell (var)) : 0;
      else if (var == 0 && unbound_vars_is_error == 0)
        number = 0;
      else                              /* ${#PS1} */
        {
          newname = savestring (name);
          newname[0] = '$';
          list = expand_string (newname, Q_DOUBLE_QUOTES);
          t = list ? string_list (list) : (char *)NULL;
          free (newname);
          if (list)
            dispose_words (list);

          number = t ? MB_STRLEN (t) : 0;
          FREE (t);
        }
    }

  return (number);
}

/* Skip characters in SUBSTR until DELIM.  SUBSTR is an arithmetic expression,
   so we do some ad-hoc parsing of an arithmetic expression to find
   the first DELIM, instead of using strchr(3).  Two rules:
        1.  If the substring contains a `(', read until closing `)'.
        2.  If the substring contains a `?', read past one `:' for each `?'.
   The SD_ARITHEXP flag to skip_to_delim takes care of doing this.
*/

static char *
skiparith (substr, delim)
     char *substr;
     int delim;
{
  int i;
  char delims[2];

  delims[0] = delim;
  delims[1] = '\0';

  i = skip_to_delim (substr, 0, delims, SD_ARITHEXP);
  return (substr + i);
}

/* Verify and limit the start and end of the desired substring.  If
   VTYPE == 0, a regular shell variable is being used; if it is 1,
   then the positional parameters are being used; if it is 2, then
   VALUE is really a pointer to an array variable that should be used.
   Return value is 1 if both values were OK, 0 if there was a problem
   with an invalid expression, or -1 if the values were out of range. */
static int
verify_substring_values (v, value, substr, vtype, e1p, e2p)
     SHELL_VAR *v;
     char *value, *substr;
     int vtype;
     intmax_t *e1p, *e2p;
{
  char *t, *temp1, *temp2;
  arrayind_t len;
  int expok, eflag;
#if defined (ARRAY_VARS)
 ARRAY *a;
 HASH_TABLE *h;
#endif

  /* duplicate behavior of strchr(3) */
  t = skiparith (substr, ':');
  if (*t && *t == ':')
    *t = '\0';
  else
    t = (char *)0;

  temp1 = expand_arith_string (substr, Q_DOUBLE_QUOTES|Q_ARITH);
  eflag = (shell_compatibility_level > 51) ? 0 : EXP_EXPANDED;

  *e1p = evalexp (temp1, eflag, &expok);
  free (temp1);
  if (expok == 0)
    return (0);

  len = -1;     /* paranoia */
  switch (vtype)
    {
    case VT_VARIABLE:
    case VT_ARRAYMEMBER:
      len = MB_STRLEN (value);
      break;
    case VT_POSPARMS:
      len = number_of_args () + 1;
      if (*e1p == 0)
        len++;          /* add one arg if counting from $0 */
      break;
#if defined (ARRAY_VARS)
    case VT_ARRAYVAR:
      /* For arrays, the first value deals with array indices.  Negative
         offsets count from one past the array's maximum index.  Associative
         arrays treat the number of elements as the maximum index. */
      if (assoc_p (v))
        {
          h = assoc_cell (v);
          len = assoc_num_elements (h) + (*e1p < 0);
        }
      else
        {
          a = (ARRAY *)value;
          len = array_max_index (a) + (*e1p < 0);       /* arrays index from 0 to n - 1 */
        }
      break;
#endif
    }

  if (len == -1)        /* paranoia */
    return -1;

  if (*e1p < 0)         /* negative offsets count from end */
    *e1p += len;

  if (*e1p > len || *e1p < 0)
    return (-1);

#if defined (ARRAY_VARS)
  /* For arrays, the second offset deals with the number of elements. */
  if (vtype == VT_ARRAYVAR)
    len = assoc_p (v) ? assoc_num_elements (h) : array_num_elements (a);
#endif

  if (t)
    {
      t++;
      temp2 = savestring (t);
      temp1 = expand_arith_string (temp2, Q_DOUBLE_QUOTES|Q_ARITH);
      free (temp2);
      t[-1] = ':';
      *e2p = evalexp (temp1, eflag, &expok);
      free (temp1);
      if (expok == 0)
        return (0);

      /* Should we allow positional parameter length < 0 to count backwards
         from end of positional parameters? */
#if 1
      if ((vtype == VT_ARRAYVAR || vtype == VT_POSPARMS) && *e2p < 0)
#else /* XXX - postponed; this isn't really a valuable feature */
      if (vtype == VT_ARRAYVAR && *e2p < 0)
#endif
        {
          internal_error (_("%s: substring expression < 0"), t);
          return (0);
        }
#if defined (ARRAY_VARS)
      /* In order to deal with sparse arrays, push the intelligence about how
         to deal with the number of elements desired down to the array-
         specific functions.  */
      if (vtype != VT_ARRAYVAR)
#endif
        {
          if (*e2p < 0)
            {
              *e2p += len;
              if (*e2p < 0 || *e2p < *e1p)
                {
                  internal_error (_("%s: substring expression < 0"), t);
                  return (0);
                }
            }
          else
            *e2p += *e1p;               /* want E2 chars starting at E1 */
          if (*e2p > len)
            *e2p = len;
        }
    }
  else
    *e2p = len;

  return (1);
}

/* Return the type of variable specified by VARNAME (simple variable,
   positional param, or array variable).  Also return the value specified
   by VARNAME (value of a variable or a reference to an array element).
   QUOTED is the standard description of quoting state, using Q_* defines.
   FLAGS is currently a set of flags to pass to array_value.  If IND is
   not INTMAX_MIN, and FLAGS includes AV_USEIND, IND is
   passed to array_value so the array index is not computed again.
   If this returns VT_VARIABLE, the caller assumes that CTLESC and CTLNUL
   characters in the value are quoted with CTLESC and takes appropriate
   steps.  For convenience, *VALP is set to the dequoted VALUE. */
static int
get_var_and_type (varname, value, estatep, quoted, flags, varp, valp)
     char *varname, *value;
     array_eltstate_t *estatep;
     int quoted, flags;
     SHELL_VAR **varp;
     char **valp;
{
  int vtype, want_indir;
  char *temp, *vname;
  SHELL_VAR *v;

  want_indir = *varname == '!' &&
    (legal_variable_starter ((unsigned char)varname[1]) || DIGIT (varname[1])
                                        || VALID_INDIR_PARAM (varname[1]));
  if (want_indir)
    vname = parameter_brace_find_indir (varname+1, SPECIAL_VAR (varname, 1), quoted, 1);
    /* XXX - what if vname == 0 || *vname == 0 ? */
  else
    vname = varname;

  if (vname == 0)
    {
      vtype = VT_VARIABLE;
      *varp = (SHELL_VAR *)NULL;
      *valp = (char *)NULL;
      return (vtype);
    }

  /* This sets vtype to VT_VARIABLE or VT_POSPARMS */
  vtype = STR_DOLLAR_AT_STAR (vname);
  if (vtype == VT_POSPARMS && vname[0] == '*')
    vtype |= VT_STARSUB;
  *varp = (SHELL_VAR *)NULL;

#if defined (ARRAY_VARS)
  if (valid_array_reference (vname, 0))
    {
      v = array_variable_part (vname, 0, &temp, (int *)0);
      /* If we want to signal array_value to use an already-computed index,
         the caller will set ESTATEP->IND to that index and pass AV_USEIND in
         FLAGS. */
      if (estatep && (flags & AV_USEIND) == 0)
        estatep->ind = INTMAX_MIN;

      if (v && invisible_p (v))
        {
          vtype = VT_ARRAYMEMBER;
          *varp = (SHELL_VAR *)NULL;
          *valp = (char *)NULL;
        }
      if (v && (array_p (v) || assoc_p (v)))
        {
          if (ALL_ELEMENT_SUB (temp[0]) && temp[1] == RBRACK)
            {
              /* Callers have to differentiate between indexed and associative */
              vtype = VT_ARRAYVAR;
              if (temp[0] == '*')
                vtype |= VT_STARSUB;
              *valp = array_p (v) ? (char *)array_cell (v) : (char *)assoc_cell (v);
            }
          else
            {
              vtype = VT_ARRAYMEMBER;
              *valp = array_value (vname, Q_DOUBLE_QUOTES, flags, estatep);
            }
          *varp = v;
        }
      else if (v && (ALL_ELEMENT_SUB (temp[0]) && temp[1] == RBRACK))
        {
          vtype = VT_VARIABLE;
          *varp = v;
          if (quoted & (Q_DOUBLE_QUOTES|Q_HERE_DOCUMENT))
            *valp = value ? dequote_string (value) : (char *)NULL;
          else
            *valp = value ? dequote_escapes (value) : (char *)NULL;
        }
      else
        {
          vtype = VT_ARRAYMEMBER;
          *varp = v;
          *valp = array_value (vname, Q_DOUBLE_QUOTES, flags, estatep);
        }
    }
  else if ((v = find_variable (vname)) && (invisible_p (v) == 0) && (assoc_p (v) || array_p (v)))
    {
      vtype = VT_ARRAYMEMBER;
      *varp = v;
      *valp = assoc_p (v) ? assoc_reference (assoc_cell (v), "0") : array_reference (array_cell (v), 0);
    }
  else
#endif
    {
      if (value && vtype == VT_VARIABLE)
        {
          *varp = find_variable (vname);
          if (quoted & (Q_DOUBLE_QUOTES|Q_HERE_DOCUMENT))
            *valp = dequote_string (value);
          else
            *valp = dequote_escapes (value);
        }
      else
        *valp = value;
    }

  if (want_indir)
    free (vname);

  return vtype;
}

/***********************************************************/
/*                                                         */
/* Functions to perform transformations on variable values */
/*                                                         */
/***********************************************************/

static char *
string_var_assignment (v, s)
     SHELL_VAR *v;
     char *s;
{
  char flags[MAX_ATTRIBUTES], *ret, *val;
  int i;

  val = (v && (invisible_p (v) || var_isset (v) == 0)) ? (char *)NULL : sh_quote_reusable (s, 0);
  i = var_attribute_string (v, 0, flags);
  if (i == 0 && val == 0)
    return (char *)NULL;

  ret = (char *)xmalloc (i + STRLEN (val) + strlen (v->name) + 16 + MAX_ATTRIBUTES);
  if (i > 0 && val == 0)
    sprintf (ret, "declare -%s %s", flags, v->name);
  else if (i > 0)
    sprintf (ret, "declare -%s %s=%s", flags, v->name, val);
  else
    sprintf (ret, "%s=%s", v->name, val);
  free (val);
  return ret;
}

#if defined (ARRAY_VARS)
static char *
array_var_assignment (v, itype, quoted, atype)
     SHELL_VAR *v;
     int itype, quoted, atype;
{
  char *ret, *val, flags[MAX_ATTRIBUTES];
  int i;

  if (v == 0)
    return (char *)NULL;
  if (atype == 2)
    val = array_p (v) ? array_to_kvpair (array_cell (v), 0)
                      : assoc_to_kvpair (assoc_cell (v), 0);
  else
    val = array_p (v) ? array_to_assign (array_cell (v), 0)
                      : assoc_to_assign (assoc_cell (v), 0);

  if (val == 0 && (invisible_p (v) || var_isset (v) == 0))
    ;   /* placeholder */
  else if (val == 0)
    {
      val = (char *)xmalloc (3);
      val[0] = LPAREN;
      val[1] = RPAREN;
      val[2] = 0;
    }
  else
    {
      ret = (quoted & (Q_DOUBLE_QUOTES|Q_HERE_DOCUMENT)) ? quote_string (val) : quote_escapes (val);
      free (val);
      val = ret;
    }

  if (atype == 2)
    return val;

  i = var_attribute_string (v, 0, flags);
  ret = (char *)xmalloc (i + STRLEN (val) + strlen (v->name) + 16);
  if (val)
    sprintf (ret, "declare -%s %s=%s", flags, v->name, val);
  else
    sprintf (ret, "declare -%s %s", flags, v->name);
  free (val);
  return ret;
}
#endif

static char *
pos_params_assignment (list, itype, quoted)
     WORD_LIST *list;
     int itype;
     int quoted;
{
  char *temp, *ret;

  /* first, we transform the list to quote each word. */
  temp = list_transform ('Q', (SHELL_VAR *)0, list, itype, quoted);
  ret = (char *)xmalloc (strlen (temp) + 8);
  strcpy (ret, "set -- ");
  strcpy (ret + 7, temp);
  free (temp);
  return ret;
}

static char *
string_transform (xc, v, s)
     int xc;
     SHELL_VAR *v;
     char *s;
{
  char *ret, flags[MAX_ATTRIBUTES], *t;
  int i;

  if (((xc == 'A' || xc == 'a') && v == 0))
    return (char *)NULL;
  else if (xc != 'a' && xc != 'A' && s == 0)
    return (char *)NULL;

  switch (xc)
    {
      /* Transformations that interrogate the variable */
      case 'a':
        i = var_attribute_string (v, 0, flags);
        ret = (i > 0) ? savestring (flags) : (char *)NULL;
        break;
      case 'A':
        ret = string_var_assignment (v, s);
        break;
      case 'K':
      case 'k':
        ret = sh_quote_reusable (s, 0);
        break;
      /* Transformations that modify the variable's value */
      case 'E':
        t = ansiexpand (s, 0, strlen (s), (int *)0);
        ret = dequote_escapes (t);
        free (t);
        break;
      case 'P':
        ret = decode_prompt_string (s);
        break;
      case 'Q':
        ret = sh_quote_reusable (s, 0);
        break;
      case 'U':
        ret = sh_modcase (s, 0, CASE_UPPER);
        break;
      case 'u':
        ret = sh_modcase (s, 0, CASE_UPFIRST);  /* capitalize */
        break;
      case 'L':
        ret = sh_modcase (s, 0, CASE_LOWER);
        break;
      default:
        ret = (char *)NULL;
        break;
    }
  return ret;
}

static char *
list_transform (xc, v, list, itype, quoted)
     int xc;
     SHELL_VAR *v;
     WORD_LIST *list;
     int itype, quoted;
{
  WORD_LIST *new, *l;
  WORD_DESC *w;
  char *tword;
  int qflags;

  for (new = (WORD_LIST *)NULL, l = list; l; l = l->next)
    {
      tword = string_transform (xc, v, l->word->word);
      w = alloc_word_desc ();
      w->word = tword ? tword : savestring ("");        /* XXX */
      new = make_word_list (w, new);
    }
  l = REVERSE_LIST (new, WORD_LIST *);

  qflags = quoted;
  /* If we are expanding in a context where word splitting will not be
     performed, treat as quoted.  This changes how $* will be expanded. */
  if (itype == '*' && expand_no_split_dollar_star && ifs_is_null)
    qflags |= Q_DOUBLE_QUOTES;          /* Posix interp 888 */

  tword = string_list_pos_params (itype, l, qflags, 0);
  dispose_words (l);

  return (tword);
}

static char *
parameter_list_transform (xc, itype, quoted)
     int xc;
     int itype;
     int quoted;
{
  char *ret;
  WORD_LIST *list;

  list = list_rest_of_args ();
  if (list == 0)
    return ((char *)NULL);
  if (xc == 'A')
    ret = pos_params_assignment (list, itype, quoted);
  else
    ret = list_transform (xc, (SHELL_VAR *)0, list, itype, quoted);
  dispose_words (list);
  return (ret);
}

#if defined (ARRAY_VARS)
static char *
array_transform (xc, var, starsub, quoted)
     int xc;
     SHELL_VAR *var;
     int starsub;       /* so we can figure out how it's indexed */
     int quoted;
{
  ARRAY *a;
  HASH_TABLE *h;
  int itype, qflags;
  char *ret;
  WORD_LIST *list;
  SHELL_VAR *v;

  v = var;      /* XXX - for now */

  itype = starsub ? '*' : '@';

  if (xc == 'A')
    return (array_var_assignment (v, itype, quoted, 1));
  else if (xc == 'K')
    return (array_var_assignment (v, itype, quoted, 2));

  /* special case for unset arrays and attributes */
  if (xc == 'a' && (invisible_p (v) || var_isset (v) == 0))
    {
      char flags[MAX_ATTRIBUTES];
      int i;

      i = var_attribute_string (v, 0, flags);
      return ((i > 0) ? savestring (flags) : (char *)NULL);
    }

  a = (v && array_p (v)) ? array_cell (v) : 0;
  h = (v && assoc_p (v)) ? assoc_cell (v) : 0;

  /* XXX - for now */
  if (xc == 'k')
    {
      if (v == 0)
        return ((char *)NULL);
      list = array_p (v) ? array_to_kvpair_list (a) : assoc_to_kvpair_list (h);
      qflags = quoted;
      /* If we are expanding in a context where word splitting will not be
         performed, treat as quoted.  This changes how $* will be expanded. */
      if (itype == '*' && expand_no_split_dollar_star && ifs_is_null)
        qflags |= Q_DOUBLE_QUOTES;              /* Posix interp 888 */

      ret = string_list_pos_params (itype, list, qflags, 0);
      dispose_words (list);
      return ret;
    }

  list = a ? array_to_word_list (a) : (h ? assoc_to_word_list (h) : 0);
  if (list == 0)
   return ((char *)NULL);
  ret = list_transform (xc, v, list, itype, quoted);
  dispose_words (list);

  return ret;
}
#endif /* ARRAY_VARS */

static int
valid_parameter_transform (xform)
     char *xform;
{
  if (xform[1])
    return 0;

  /* check for valid values of xform[0] */
  switch (xform[0])
    {
    case 'a':           /* expand to a string with just attributes */
    case 'A':           /* expand as an assignment statement with attributes */
    case 'K':           /* expand assoc array to list of key/value pairs */
    case 'k':           /* XXX - for now */
    case 'E':           /* expand like $'...' */
    case 'P':           /* expand like prompt string */
    case 'Q':           /* quote reusably */
    case 'U':           /* transform to uppercase */
    case 'u':           /* transform by capitalizing */
    case 'L':           /* transform to lowercase */
      return 1;
    default:
      return 0;
    }
}
      
static char *
parameter_brace_transform (varname, value, estatep, xform, rtype, quoted, pflags, flags)
     char *varname, *value;
     array_eltstate_t *estatep;
     char *xform;
     int rtype, quoted, pflags, flags;
{
  int vtype, xc, starsub;
  char *temp1, *val, *oname;
  SHELL_VAR *v;

  xc = xform[0];
  if (value == 0 && xc != 'A' && xc != 'a')
    return ((char *)NULL);

  oname = this_command_name;
  this_command_name = varname;

  vtype = get_var_and_type (varname, value, estatep, quoted, flags, &v, &val);
  if (vtype == -1)
    {
      this_command_name = oname;
      return ((char *)NULL);
    }

  if (xform[0] == 0 || valid_parameter_transform (xform) == 0)
    {
      this_command_name = oname;
      if (vtype == VT_VARIABLE)
        FREE (val);
      return (interactive_shell ? &expand_param_error : &expand_param_fatal);
    }

  starsub = vtype & VT_STARSUB;
  vtype &= ~VT_STARSUB;

  /* If we are asked to display the attributes of an unset variable, V will
     be NULL after the call to get_var_and_type. Double-check here. */
  if ((xc == 'a' || xc == 'A') && vtype == VT_VARIABLE && varname && v == 0)
    v = find_variable (varname);

  temp1 = (char *)NULL;         /* shut up gcc */
  switch (vtype)
    {
    case VT_VARIABLE:
    case VT_ARRAYMEMBER:
      temp1 = string_transform (xc, v, val);
      if (vtype == VT_VARIABLE)
        FREE (val);
      if (temp1)
        {
          val = (quoted & (Q_HERE_DOCUMENT|Q_DOUBLE_QUOTES))
                        ? quote_string (temp1)
                        : quote_escapes (temp1);
          free (temp1);
          temp1 = val;
        }
      break;
#if defined (ARRAY_VARS)
    case VT_ARRAYVAR:
      temp1 = array_transform (xc, v, starsub, quoted);
      if (temp1 && quoted == 0 && ifs_is_null)
        {
                /* Posix interp 888 */
        }
      else if (temp1 && ((quoted & (Q_HERE_DOCUMENT|Q_DOUBLE_QUOTES)) == 0))
        {
          val = quote_escapes (temp1);
          free (temp1);
          temp1 = val;
        }
      break;
#endif
    case VT_POSPARMS:
      temp1 = parameter_list_transform (xc, varname[0], quoted);
      if (temp1 && quoted == 0 && ifs_is_null)
        {
                /* Posix interp 888 */
        }
      else if (temp1 && ((quoted & (Q_HERE_DOCUMENT|Q_DOUBLE_QUOTES)) == 0))
        {
          val = quote_escapes (temp1);
          free (temp1);
          temp1 = val;
        }
      break;
    }

  this_command_name = oname;
  return temp1;
}

/******************************************************/
/*                                                    */
/* Functions to extract substrings of variable values */
/*                                                    */
/******************************************************/

#if defined (HANDLE_MULTIBYTE)
/* Character-oriented rather than strictly byte-oriented substrings.  S and
   E, rather being strict indices into STRING, indicate character (possibly
   multibyte character) positions that require calculation.
   Used by the ${param:offset[:length]} expansion. */
static char *
mb_substring (string, s, e)
     char *string;
     int s, e;
{
  char *tt;
  int start, stop, i;
  size_t slen;
  DECLARE_MBSTATE;

  start = 0;
  /* Don't need string length in ADVANCE_CHAR unless multibyte chars possible. */
  slen = (MB_CUR_MAX > 1) ? STRLEN (string) : 0;

  i = s;
  while (string[start] && i--)
    ADVANCE_CHAR (string, slen, start);
  stop = start;
  i = e - s;
  while (string[stop] && i--)
    ADVANCE_CHAR (string, slen, stop);
  tt = substring (string, start, stop);
  return tt;
}
#endif
  
/* Process a variable substring expansion: ${name:e1[:e2]}.  If VARNAME
   is `@', use the positional parameters; otherwise, use the value of
   VARNAME.  If VARNAME is an array variable, use the array elements. */

static char *
parameter_brace_substring (varname, value, estatep, substr, quoted, pflags, flags)
     char *varname, *value;
     array_eltstate_t *estatep;
     char *substr;
     int quoted, pflags, flags;
{
  intmax_t e1, e2;
  int vtype, r, starsub;
  char *temp, *val, *tt, *oname;
  SHELL_VAR *v;

  if (value == 0 && ((varname[0] != '@' && varname[0] != '*') || varname[1]))
    return ((char *)NULL);

  oname = this_command_name;
  this_command_name = varname;

  vtype = get_var_and_type (varname, value, estatep, quoted, flags, &v, &val);
  if (vtype == -1)
    {
      this_command_name = oname;
      return ((char *)NULL);
    }

  starsub = vtype & VT_STARSUB;
  vtype &= ~VT_STARSUB;

  r = verify_substring_values (v, val, substr, vtype, &e1, &e2);
  this_command_name = oname;
  if (r <= 0)
    {
      if (vtype == VT_VARIABLE)
        FREE (val);
      return ((r == 0) ? &expand_param_error : (char *)NULL);
    }

  switch (vtype)
    {
    case VT_VARIABLE:
    case VT_ARRAYMEMBER:
#if defined (HANDLE_MULTIBYTE)
      if (MB_CUR_MAX > 1)
        tt = mb_substring (val, e1, e2);
      else
#endif
      tt = substring (val, e1, e2);

      if (vtype == VT_VARIABLE)
        FREE (val);
      if (quoted & (Q_DOUBLE_QUOTES|Q_HERE_DOCUMENT))
        temp = quote_string (tt);
      else
        temp = tt ? quote_escapes (tt) : (char *)NULL;
      FREE (tt);
      break;
    case VT_POSPARMS:
    case VT_ARRAYVAR:
      if (vtype == VT_POSPARMS)
        tt = pos_params (varname, e1, e2, quoted, pflags);
#if defined (ARRAY_VARS)
        /* assoc_subrange and array_subrange both call string_list_pos_params,
           so we can treat this case just like VT_POSPARAMS. */
      else if (assoc_p (v))
        /* we convert to list and take first e2 elements starting at e1th
           element -- officially undefined for now */   
        tt = assoc_subrange (assoc_cell (v), e1, e2, starsub, quoted, pflags);
      else
        /* We want E2 to be the number of elements desired (arrays can be
           sparse, so verify_substring_values just returns the numbers
           specified and we rely on array_subrange to understand how to
           deal with them). */
        tt = array_subrange (array_cell (v), e1, e2, starsub, quoted, pflags);
#endif
      /* We want to leave this alone in every case where pos_params/
         string_list_pos_params quotes the list members */
      if (tt && quoted == 0 && ifs_is_null)
        {
          temp = tt;    /* Posix interp 888 */
        }
      else if (tt && quoted == 0 && (pflags & PF_ASSIGNRHS))
        {
          temp = tt;    /* Posix interp 888 */
        }
      else if ((quoted & (Q_DOUBLE_QUOTES|Q_HERE_DOCUMENT)) == 0)
        {
          temp = tt ? quote_escapes (tt) : (char *)NULL;
          FREE (tt);
        }
      else
        temp = tt;
      break;

    default:
      temp = (char *)NULL;
    }

  return temp;
}

/****************************************************************/
/*                                                              */
/* Functions to perform pattern substitution on variable values */
/*                                                              */
/****************************************************************/

static int
shouldexp_replacement (s)
     char *s;
{
  size_t slen;
  int sindex, c;
  DECLARE_MBSTATE;

  sindex = 0;
  slen = STRLEN (s);
  while (c = s[sindex])
    {
      if (c == '\\')
        {
          sindex++;
          if (s[sindex] == 0)
            return 0;
          /* We want to remove this backslash because we treat it as special
             in this context. THIS ASSUMES THE STRING IS PROCESSED BY
             strcreplace() OR EQUIVALENT that handles removing backslashes
             preceding the special character. */
          if (s[sindex] == '&')
            return 1;
          if (s[sindex] == '\\')
            return 1;
        }
      else if (c == '&')
        return 1;
      ADVANCE_CHAR (s, slen, sindex);
    }
  return 0;
}

char *
pat_subst (string, pat, rep, mflags)
     char *string, *pat, *rep;
     int mflags;
{
  char *ret, *s, *e, *str, *rstr, *mstr, *send;
  int rptr, mtype, rxpand, mlen;
  size_t rsize, l, replen, rslen;
  DECLARE_MBSTATE;

  if (string == 0)
    return (savestring (""));

  mtype = mflags & MATCH_TYPEMASK;
  rxpand = mflags & MATCH_EXPREP;

  /* Special cases:
   *    1.  A null pattern with mtype == MATCH_BEG means to prefix STRING
   *        with REP and return the result.
   *    2.  A null pattern with mtype == MATCH_END means to append REP to
   *        STRING and return the result.
   *    3.  A null STRING with a matching pattern means to append REP to
   *        STRING and return the result.
   *
   * These process `&' in the replacement string, like `sed' does when
   * presented with a BRE of `^' or `$'.
   */
  if ((pat == 0 || *pat == 0) && (mtype == MATCH_BEG || mtype == MATCH_END))
    {
      rstr = (mflags & MATCH_EXPREP) ? strcreplace (rep, '&', "", 2) : rep;
      rslen = STRLEN (rstr);
      l = STRLEN (string);
      ret = (char *)xmalloc (rslen + l + 2);
      if (rslen == 0)
        strcpy (ret, string);
      else if (mtype == MATCH_BEG)
        {
          strcpy (ret, rstr);
          strcpy (ret + rslen, string);
        }
      else
        {
          strcpy (ret, string);
          strcpy (ret + l, rstr);
        }
      if (rstr != rep)
        free (rstr);
      return (ret);
    }
  else if (*string == 0 && (match_pattern (string, pat, mtype, &s, &e) != 0))
    return ((mflags & MATCH_EXPREP) ? strcreplace (rep, '&', "", 2) : savestring (rep));

  ret = (char *)xmalloc (rsize = 64);
  ret[0] = '\0';
  send = string + strlen (string);

  for (replen = STRLEN (rep), rptr = 0, str = string; *str;)
    {
      if (match_pattern (str, pat, mtype, &s, &e) == 0)
        break;
      l = s - str;

      if (rep && rxpand)
        {
          int x;
          mlen = e - s;
          mstr = xmalloc (mlen + 1);
          for (x = 0; x < mlen; x++)
            mstr[x] = s[x];
          mstr[mlen] = '\0';
          rstr = strcreplace (rep, '&', mstr, 2);
          free (mstr);
          rslen = strlen (rstr);
        }
      else
        {
          rstr = rep;
          rslen = replen;
        }
        
      RESIZE_MALLOCED_BUFFER (ret, rptr, (l + rslen), rsize, 64);

      /* OK, now copy the leading unmatched portion of the string (from
         str to s) to ret starting at rptr (the current offset).  Then copy
         the replacement string at ret + rptr + (s - str).  Increment
         rptr (if necessary) and str and go on. */
      if (l)
        {
          strncpy (ret + rptr, str, l);
          rptr += l;
        }
      if (replen)
        {
          strncpy (ret + rptr, rstr, rslen);
          rptr += rslen;
        }
      str = e;          /* e == end of match */

      if (rstr != rep)
        free (rstr);

      if (((mflags & MATCH_GLOBREP) == 0) || mtype != MATCH_ANY)
        break;

      if (s == e)
        {
          /* On a zero-length match, make sure we copy one character, since
             we increment one character to avoid infinite recursion. */
          char *p, *origp, *origs;
          size_t clen;

          RESIZE_MALLOCED_BUFFER (ret, rptr, locale_mb_cur_max, rsize, 64);
#if defined (HANDLE_MULTIBYTE)
          p = origp = ret + rptr;
          origs = str;
          COPY_CHAR_P (p, str, send);
          rptr += p - origp;
          e += str - origs;
#else
          ret[rptr++] = *str++;
          e++;          /* avoid infinite recursion on zero-length match */
#endif
        }
    }

  /* Now copy the unmatched portion of the input string */
  if (str && *str)
    {
      l = send - str + 1;
      RESIZE_MALLOCED_BUFFER (ret, rptr, l, rsize, 64);
      strcpy (ret + rptr, str);
    }
  else
    ret[rptr] = '\0';

  return ret;
}

/* Do pattern match and replacement on the positional parameters. */
static char *
pos_params_pat_subst (string, pat, rep, mflags)
     char *string, *pat, *rep;
     int mflags;
{
  WORD_LIST *save, *params;
  WORD_DESC *w;
  char *ret;
  int pchar, qflags, pflags;

  save = params = list_rest_of_args ();
  if (save == 0)
    return ((char *)NULL);

  for ( ; params; params = params->next)
    {
      ret = pat_subst (params->word->word, pat, rep, mflags);
      w = alloc_word_desc ();
      w->word = ret ? ret : savestring ("");
      dispose_word (params->word);
      params->word = w;
    }

  pchar = (mflags & MATCH_STARSUB) == MATCH_STARSUB ? '*' : '@';
  qflags = (mflags & MATCH_QUOTED) == MATCH_QUOTED ? Q_DOUBLE_QUOTES : 0;
  pflags = (mflags & MATCH_ASSIGNRHS) == MATCH_ASSIGNRHS ? PF_ASSIGNRHS : 0;

  /* If we are expanding in a context where word splitting will not be
     performed, treat as quoted. This changes how $* will be expanded. */
  if (pchar == '*' && (mflags & MATCH_ASSIGNRHS) && expand_no_split_dollar_star && ifs_is_null)
    qflags |= Q_DOUBLE_QUOTES;          /* Posix interp 888 */

  ret = string_list_pos_params (pchar, save, qflags, pflags);
  dispose_words (save);

  return (ret);
}

/* Perform pattern substitution on VALUE, which is the expansion of
   VARNAME.  PATSUB is an expression supplying the pattern to match
   and the string to substitute.  QUOTED is a flags word containing
   the type of quoting currently in effect. */
static char *
parameter_brace_patsub (varname, value, estatep, patsub, quoted, pflags, flags)
     char *varname, *value;
     array_eltstate_t *estatep;
     char *patsub;
     int quoted, pflags, flags;
{
  int vtype, mflags, starsub, delim;
  char *val, *temp, *pat, *rep, *p, *lpatsub, *tt, *oname;
  SHELL_VAR *v;

  if (value == 0)
    return ((char *)NULL);

  oname = this_command_name;
  this_command_name = varname;          /* error messages */

  vtype = get_var_and_type (varname, value, estatep, quoted, flags, &v, &val);
  if (vtype == -1)
    {
      this_command_name = oname;
      return ((char *)NULL);
    }

  starsub = vtype & VT_STARSUB;
  vtype &= ~VT_STARSUB;

  mflags = 0;
  /* PATSUB is never NULL when this is called. */
  if (*patsub == '/')
    {
      mflags |= MATCH_GLOBREP;
      patsub++;
    }

  /* Malloc this because expand_string_if_necessary or one of the expansion
     functions in its call chain may free it on a substitution error. */
  lpatsub = savestring (patsub);

  if (quoted & (Q_HERE_DOCUMENT|Q_DOUBLE_QUOTES))
    mflags |= MATCH_QUOTED;

  if (starsub)
    mflags |= MATCH_STARSUB;

  if (pflags & PF_ASSIGNRHS)
    mflags |= MATCH_ASSIGNRHS;

  /* If the pattern starts with a `/', make sure we skip over it when looking
     for the replacement delimiter. */
  delim = skip_to_delim (lpatsub, ((*patsub == '/') ? 1 : 0), "/", 0);
  if (lpatsub[delim] == '/')
    {
      lpatsub[delim] = 0;
      rep = lpatsub + delim + 1;
    }
  else
    rep = (char *)NULL;

  if (rep && *rep == '\0')
    rep = (char *)NULL;

  /* Perform the same expansions on the pattern as performed by the
     pattern removal expansions. */
  pat = getpattern (lpatsub, quoted, 1);

  if (rep)
    {
      /* We want to perform quote removal on the expanded replacement even if
         the entire expansion is double-quoted because the parser and string
         extraction functions treated quotes in the replacement string as
         special.  THIS IS NOT BACKWARDS COMPATIBLE WITH BASH-4.2. */
      if (shell_compatibility_level > 42 && patsub_replacement == 0)
        rep = expand_string_if_necessary (rep, quoted & ~(Q_DOUBLE_QUOTES|Q_HERE_DOCUMENT), expand_string_unsplit);
      else if (shell_compatibility_level > 42 && patsub_replacement)
        rep = expand_string_for_patsub (rep, quoted & ~(Q_DOUBLE_QUOTES|Q_HERE_DOCUMENT));
      /* This is the bash-4.2 code. */      
      else if ((mflags & MATCH_QUOTED) == 0)
        rep = expand_string_if_necessary (rep, quoted, expand_string_unsplit);
      else
        rep = expand_string_to_string_internal (rep, quoted, expand_string_unsplit);

      /* Check whether or not to replace `&' in the replacement string after
         expanding it, since we want to treat backslashes quoting the `&'
         consistently. */
      if (patsub_replacement && rep && *rep && shouldexp_replacement (rep))
        mflags |= MATCH_EXPREP;

    }

  /* ksh93 doesn't allow the match specifier to be a part of the expanded
     pattern.  This is an extension.  Make sure we don't anchor the pattern
     at the beginning or end of the string if we're doing global replacement,
     though. */
  p = pat;
  if (mflags & MATCH_GLOBREP)
    mflags |= MATCH_ANY;
  else if (pat && pat[0] == '#')
    {
      mflags |= MATCH_BEG;
      p++;
    }
  else if (pat && pat[0] == '%')
    {
      mflags |= MATCH_END;
      p++;
    }
  else
    mflags |= MATCH_ANY;

  /* OK, we now want to substitute REP for PAT in VAL.  If
     flags & MATCH_GLOBREP is non-zero, the substitution is done
     everywhere, otherwise only the first occurrence of PAT is
     replaced.  The pattern matching code doesn't understand
     CTLESC quoting CTLESC and CTLNUL so we use the dequoted variable
     values passed in (VT_VARIABLE) so the pattern substitution
     code works right.  We need to requote special chars after
     we're done for VT_VARIABLE and VT_ARRAYMEMBER, and for the
     other cases if QUOTED == 0, since the posparams and arrays
     indexed by * or @ do special things when QUOTED != 0. */

  switch (vtype)
    {
    case VT_VARIABLE:
    case VT_ARRAYMEMBER:
      temp = pat_subst (val, p, rep, mflags);
      if (vtype == VT_VARIABLE)
        FREE (val);
      if (temp)
        {
          tt = (mflags & MATCH_QUOTED) ? quote_string (temp) : quote_escapes (temp);
          free (temp);
          temp = tt;
        }
      break;
    case VT_POSPARMS:
      /* This does the right thing for the case where we are not performing
         word splitting. MATCH_STARSUB restricts it to ${* /foo/bar}, and
         pos_params_pat_subst/string_list_pos_params will do the right thing
         in turn for the case where ifs_is_null. Posix interp 888 */
      if ((pflags & PF_NOSPLIT2) && (mflags & MATCH_STARSUB))
        mflags |= MATCH_ASSIGNRHS;
      temp = pos_params_pat_subst (val, p, rep, mflags);
      if (temp && quoted == 0 && ifs_is_null)
        {
          /* Posix interp 888 */
        }
      else if (temp && quoted == 0 && (pflags & PF_ASSIGNRHS))
        {
          /* Posix interp 888 */
        }
      else if (temp && (mflags & MATCH_QUOTED) == 0)
        {
          tt = quote_escapes (temp);
          free (temp);
          temp = tt;
        }
      break;
#if defined (ARRAY_VARS)
    case VT_ARRAYVAR:
      /* If we are expanding in a context where word splitting will not be
         performed, treat as quoted.  This changes how ${A[*]} will be
         expanded to make it identical to $*. */
      if ((mflags & MATCH_STARSUB) && (mflags & MATCH_ASSIGNRHS) && ifs_is_null)
        mflags |= MATCH_QUOTED;         /* Posix interp 888 */

      /* these eventually call string_list_pos_params */
      if (assoc_p (v))
        temp = assoc_patsub (assoc_cell (v), p, rep, mflags);
      else
        temp = array_patsub (array_cell (v), p, rep, mflags);

      if (temp && quoted == 0 && ifs_is_null)
        {
          /* Posix interp 888 */
        }
      else if (temp && (mflags & MATCH_QUOTED) == 0)
        {
          tt = quote_escapes (temp);
          free (temp);
          temp = tt;
        }
      break;
#endif
    }

  FREE (pat);
  FREE (rep);
  free (lpatsub);

  this_command_name = oname;

  return temp;
}

/****************************************************************/
/*                                                              */
/*   Functions to perform case modification on variable values  */
/*                                                              */
/****************************************************************/

/* Do case modification on the positional parameters. */

static char *
pos_params_modcase (string, pat, modop, mflags)
     char *string, *pat;
     int modop;
     int mflags;
{
  WORD_LIST *save, *params;
  WORD_DESC *w;
  char *ret;
  int pchar, qflags, pflags;

  save = params = list_rest_of_args ();
  if (save == 0)
    return ((char *)NULL);

  for ( ; params; params = params->next)
    {
      ret = sh_modcase (params->word->word, pat, modop);
      w = alloc_word_desc ();
      w->word = ret ? ret : savestring ("");
      dispose_word (params->word);
      params->word = w;
    }

  pchar = (mflags & MATCH_STARSUB) == MATCH_STARSUB ? '*' : '@';
  qflags = (mflags & MATCH_QUOTED) == MATCH_QUOTED ? Q_DOUBLE_QUOTES : 0;
  pflags = (mflags & MATCH_ASSIGNRHS) == MATCH_ASSIGNRHS ? PF_ASSIGNRHS : 0;

  /* If we are expanding in a context where word splitting will not be
     performed, treat as quoted.  This changes how $* will be expanded. */
  if (pchar == '*' && (mflags & MATCH_ASSIGNRHS) && ifs_is_null)
    qflags |= Q_DOUBLE_QUOTES;          /* Posix interp 888 */

  ret = string_list_pos_params (pchar, save, qflags, pflags);
  dispose_words (save);

  return (ret);
}

/* Perform case modification on VALUE, which is the expansion of
   VARNAME.  MODSPEC is an expression supplying the type of modification
   to perform.  QUOTED is a flags word containing the type of quoting
   currently in effect. */
static char *
parameter_brace_casemod (varname, value, estatep, modspec, patspec, quoted, pflags, flags)
     char *varname, *value;
     array_eltstate_t *estatep;
     int modspec;
     char *patspec;
     int quoted, pflags, flags;
{
  int vtype, starsub, modop, mflags, x;
  char *val, *temp, *pat, *p, *lpat, *tt, *oname;
  SHELL_VAR *v;

  if (value == 0)
    return ((char *)NULL);

  oname = this_command_name;
  this_command_name = varname;

  vtype = get_var_and_type (varname, value, estatep, quoted, flags, &v, &val);
  if (vtype == -1)
    {
      this_command_name = oname;
      return ((char *)NULL);
    }

  starsub = vtype & VT_STARSUB;
  vtype &= ~VT_STARSUB;

  modop = 0;
  mflags = 0;
  if (quoted & (Q_HERE_DOCUMENT|Q_DOUBLE_QUOTES))
    mflags |= MATCH_QUOTED;
  if (starsub)
    mflags |= MATCH_STARSUB;
  if (pflags & PF_ASSIGNRHS)
    mflags |= MATCH_ASSIGNRHS;
  
  p = patspec;
  if (modspec == '^')
    {
      x = p && p[0] == modspec;
      modop = x ? CASE_UPPER : CASE_UPFIRST;
      p += x;
    }
  else if (modspec == ',')
    {
      x = p && p[0] == modspec;
      modop = x ? CASE_LOWER : CASE_LOWFIRST;
      p += x;
    }
  else if (modspec == '~')
    {
      x = p && p[0] == modspec;
      modop = x ? CASE_TOGGLEALL : CASE_TOGGLE;
      p += x;
    }
    
  lpat = p ? savestring (p) : 0;
  /* Perform the same expansions on the pattern as performed by the
     pattern removal expansions. */
  pat = lpat ? getpattern (lpat, quoted, 1) : 0;

  /* OK, now we do the case modification. */
  switch (vtype)
    {
    case VT_VARIABLE:
    case VT_ARRAYMEMBER:
      temp = sh_modcase (val, pat, modop);
      if (vtype == VT_VARIABLE)
        FREE (val);
      if (temp)
        {
          tt = (mflags & MATCH_QUOTED) ? quote_string (temp) : quote_escapes (temp);
          free (temp);
          temp = tt;
        }
      break;

    case VT_POSPARMS:
      temp = pos_params_modcase (val, pat, modop, mflags);
      if (temp && quoted == 0 && ifs_is_null)
        {
          /* Posix interp 888 */
        }
      else if (temp && (mflags & MATCH_QUOTED) == 0)
        {
          tt = quote_escapes (temp);
          free (temp);
          temp = tt;
        }
      break;

#if defined (ARRAY_VARS)
    case VT_ARRAYVAR:
      /* If we are expanding in a context where word splitting will not be
         performed, treat as quoted.  This changes how ${A[*]} will be
         expanded to make it identical to $*. */
      if ((mflags & MATCH_STARSUB) && (mflags & MATCH_ASSIGNRHS) && ifs_is_null)
        mflags |= MATCH_QUOTED;         /* Posix interp 888 */

      temp = assoc_p (v) ? assoc_modcase (assoc_cell (v), pat, modop, mflags)
                         : array_modcase (array_cell (v), pat, modop, mflags);

      if (temp && quoted == 0 && ifs_is_null)
        {
          /* Posix interp 888 */
        }
      else if (temp && (mflags & MATCH_QUOTED) == 0)
        {
          tt = quote_escapes (temp);
          free (temp);
          temp = tt;
        }

      break;
#endif
    }

  FREE (pat);
  free (lpat);

  this_command_name = oname;

  return temp;
}

/* Check for unbalanced parens in S, which is the contents of $(( ... )).  If
   any occur, this must be a nested command substitution, so return 0.
   Otherwise, return 1.  A valid arithmetic expression must always have a
   ( before a matching ), so any cases where there are more right parens
   means that this must not be an arithmetic expression, though the parser
   will not accept it without a balanced total number of parens. */
static int
chk_arithsub (s, len)
     const char *s;
     int len;
{
  int i, count;
  DECLARE_MBSTATE;

  i = count = 0;
  while (i < len)
    {
      if (s[i] == LPAREN)
        count++;
      else if (s[i] == RPAREN)
        {
          count--;
          if (count < 0)
            return 0;
        }

      switch (s[i])
        {
        default:
          ADVANCE_CHAR (s, len, i);
          break;

        case '\\':
          i++;
          if (s[i])
            ADVANCE_CHAR (s, len, i);
          break;

        case '\'':
          i = skip_single_quoted (s, len, ++i, 0);
          break;

        case '"':
          i = skip_double_quoted ((char *)s, len, ++i, 0);
          break;
        }
    }

  return (count == 0);
}

/****************************************************************/
/*                                                              */
/*      Functions to perform parameter expansion on a string    */
/*                                                              */
/****************************************************************/

/* ${[#][!]name[[:][^[^]][,[,]]#[#]%[%]-=?+[word][:e1[:e2]]]} */
static WORD_DESC *
parameter_brace_expand (string, indexp, quoted, pflags, quoted_dollar_atp, contains_dollar_at)
     char *string;
     int *indexp, quoted, pflags, *quoted_dollar_atp, *contains_dollar_at;
{
  int check_nullness, var_is_set, var_is_null, var_is_special;
  int want_substring, want_indir, want_patsub, want_casemod, want_attributes;
  char *name, *value, *temp, *temp1;
  WORD_DESC *tdesc, *ret;
  int t_index, sindex, c, tflag, modspec, local_pflags, all_element_arrayref;
  intmax_t number;
  array_eltstate_t es;

  temp = temp1 = value = (char *)NULL;
  var_is_set = var_is_null = var_is_special = check_nullness = 0;
  want_substring = want_indir = want_patsub = want_casemod = want_attributes = 0;

  local_pflags = 0;
  all_element_arrayref = 0;

  sindex = *indexp;
  t_index = ++sindex;
  /* ${#var} doesn't have any of the other parameter expansions on it. */
  if (string[t_index] == '#' && legal_variable_starter (string[t_index+1]))             /* {{ */
    name = string_extract (string, &t_index, "}", SX_VARNAME);
  else
#if defined (CASEMOD_EXPANSIONS)
    /* To enable case-toggling expansions using the `~' operator character
       define CASEMOD_TOGGLECASE in config-top.h */
#  if defined (CASEMOD_TOGGLECASE)
    name = string_extract (string, &t_index, "#%^,~:-=?+/@}", SX_VARNAME);
#  else
    name = string_extract (string, &t_index, "#%^,:-=?+/@}", SX_VARNAME);
#  endif /* CASEMOD_TOGGLECASE */
#else
    name = string_extract (string, &t_index, "#%:-=?+/@}", SX_VARNAME);
#endif /* CASEMOD_EXPANSIONS */

  /* Handle ${@[stuff]} now that @ is a word expansion operator.  Not exactly
     the cleanest code ever. */
  if (*name == 0 && sindex == t_index && string[sindex] == '@')
    {
      name = (char *)xrealloc (name, 2);
      name[0] = '@';
      name[1] = '\0';
      t_index++;
    }
  else if (*name == '!' && t_index > sindex && string[t_index] == '@' && string[t_index+1] == RBRACE)
    {
      name = (char *)xrealloc (name, t_index - sindex + 2);
      name[t_index - sindex] = '@';
      name[t_index - sindex + 1] = '\0';
      t_index++;
    }

  ret = 0;
  tflag = 0;

#if defined (ARRAY_VARS)
  init_eltstate (&es);
#endif
  es.ind = INTMAX_MIN;  /* XXX */

  /* If the name really consists of a special variable, then make sure
     that we have the entire name.  We don't allow indirect references
     to special variables except `#', `?', `@' and `*'.  This clause is
     designed to handle ${#SPECIAL} and ${!SPECIAL}, not anything more
     general. */
  if ((sindex == t_index && VALID_SPECIAL_LENGTH_PARAM (string[t_index])) ||
      (sindex == t_index && string[sindex] == '#' && VALID_SPECIAL_LENGTH_PARAM (string[sindex + 1])) ||
      (sindex == t_index - 1 && string[sindex] == '!' && VALID_INDIR_PARAM (string[t_index])))
    {
      t_index++;
      temp1 = string_extract (string, &t_index, "#%:-=?+/@}", 0);
      name = (char *)xrealloc (name, 3 + (strlen (temp1)));
      *name = string[sindex];
      if (string[sindex] == '!')
        {
          /* indirect reference of $#, $?, $@, or $* */
          name[1] = string[sindex + 1];
          strcpy (name + 2, temp1);
        }
      else      
        strcpy (name + 1, temp1);
      free (temp1);
    }
  sindex = t_index;

  /* Find out what character ended the variable name.  Then
     do the appropriate thing. */
  if (c = string[sindex])
    sindex++;

  /* If c is followed by one of the valid parameter expansion
     characters, move past it as normal.  If not, assume that
     a substring specification is being given, and do not move
     past it. */
  if (c == ':' && VALID_PARAM_EXPAND_CHAR (string[sindex]))
    {
      check_nullness++;
      if (c = string[sindex])
        sindex++;
    }
  else if (c == ':' && string[sindex] != RBRACE)
    want_substring = 1;
  else if (c == '/' /* && string[sindex] != RBRACE */)  /* XXX */
    want_patsub = 1;
#if defined (CASEMOD_EXPANSIONS)
  else if (c == '^' || c == ',' || c == '~')
    {
      modspec = c;
      want_casemod = 1;
    }
#endif
  else if (c == '@' && (string[sindex] == 'a' || string[sindex] == 'A') && string[sindex+1] == RBRACE)
    {
      /* special case because we do not want to shortcut foo as foo[0] here */
      want_attributes = 1;
      local_pflags |= PF_ALLINDS;
    }

  /* Catch the valid and invalid brace expressions that made it through the
     tests above. */
  /* ${#-} is a valid expansion and means to take the length of $-.
     Similarly for ${#?} and ${##}... */
  if (name[0] == '#' && name[1] == '\0' && check_nullness == 0 &&
        VALID_SPECIAL_LENGTH_PARAM (c) && string[sindex] == RBRACE)
    {
      name = (char *)xrealloc (name, 3);
      name[1] = c;
      name[2] = '\0';
      c = string[sindex++];
    }

  /* ...but ${#%}, ${#:}, ${#=}, ${#+}, and ${#/} are errors. */
  if (name[0] == '#' && name[1] == '\0' && check_nullness == 0 &&
        member (c, "%:=+/") && string[sindex] == RBRACE)
    {
      temp = (char *)NULL;
      goto bad_substitution;    /* XXX - substitution error */
    }

  /* Indirect expansion begins with a `!'.  A valid indirect expansion is
     either a variable name, one of the positional parameters or a special
     variable that expands to one of the positional parameters. */
  want_indir = *name == '!' &&
    (legal_variable_starter ((unsigned char)name[1]) || DIGIT (name[1])
                                        || VALID_INDIR_PARAM (name[1]));

  /* Determine the value of this variable whose name is NAME. */

  /* Check for special variables, directly referenced. */
  if (SPECIAL_VAR (name, want_indir))
    var_is_special++;

  /* Check for special expansion things, like the length of a parameter */
  if (*name == '#' && name[1])
    {
      /* If we are not pointing at the character just after the
         closing brace, then we haven't gotten all of the name.
         Since it begins with a special character, this is a bad
         substitution.  Also check NAME for validity before trying
         to go on. */
      if (string[sindex - 1] != RBRACE || (valid_length_expression (name) == 0))
        {
          temp = (char *)NULL;
          goto bad_substitution;        /* substitution error */
        }

      number = parameter_brace_expand_length (name);
      if (number == INTMAX_MIN && unbound_vars_is_error)
        {
          set_exit_status (EXECUTION_FAILURE);
          err_unboundvar (name+1);
          free (name);
          return (interactive_shell ? &expand_wdesc_error : &expand_wdesc_fatal);
        }
      free (name);

      *indexp = sindex;
      if (number < 0)
        return (&expand_wdesc_error);
      else
        {
          ret = alloc_word_desc ();
          ret->word = itos (number);
          return ret;
        }
    }

  /* ${@} is identical to $@. */
  if (name[0] == '@' && name[1] == '\0')
    {
      if ((quoted & (Q_HERE_DOCUMENT|Q_DOUBLE_QUOTES)) && quoted_dollar_atp)
        *quoted_dollar_atp = 1;

      if (contains_dollar_at)
        *contains_dollar_at = 1;

      tflag |= W_DOLLARAT;
    }

  /* Process ${!PREFIX*} expansion. */
  if (want_indir && string[sindex - 1] == RBRACE &&
      (string[sindex - 2] == '*' || string[sindex - 2] == '@') &&
      legal_variable_starter ((unsigned char) name[1]))
    {
      char **x;
      WORD_LIST *xlist;

      temp1 = savestring (name + 1);
      number = strlen (temp1);
      temp1[number - 1] = '\0';
      x = all_variables_matching_prefix (temp1);
      xlist = strvec_to_word_list (x, 0, 0);
      if (string[sindex - 2] == '*')
        temp = string_list_dollar_star (xlist, quoted, 0);
      else
        {
          temp = string_list_dollar_at (xlist, quoted, 0);
          if ((quoted & (Q_HERE_DOCUMENT|Q_DOUBLE_QUOTES)) && quoted_dollar_atp)
            *quoted_dollar_atp = 1;
          if (contains_dollar_at)
            *contains_dollar_at = 1;

          tflag |= W_DOLLARAT;
        }
      free (x);
      dispose_words (xlist);
      free (temp1);
      *indexp = sindex;

      free (name);

      ret = alloc_word_desc ();
      ret->word = temp;
      ret->flags = tflag;       /* XXX */
      return ret;
    }

#if defined (ARRAY_VARS)      
  /* Process ${!ARRAY[@]} and ${!ARRAY[*]} expansion. */
  if (want_indir && string[sindex - 1] == RBRACE &&
      string[sindex - 2] == RBRACK && valid_array_reference (name+1, 0))
    {
      char *x, *x1;

      temp1 = savestring (name + 1);
      x = array_variable_name (temp1, 0, &x1, (int *)0);
      FREE (x);
      if (ALL_ELEMENT_SUB (x1[0]) && x1[1] == RBRACK)
        {
          temp = array_keys (temp1, quoted, pflags);    /* handles assoc vars too */
          if (x1[0] == '@')
            {
              if ((quoted & (Q_HERE_DOCUMENT|Q_DOUBLE_QUOTES)) && quoted_dollar_atp)
                *quoted_dollar_atp = 1;
              if (contains_dollar_at)
                *contains_dollar_at = 1;

              tflag |= W_DOLLARAT;
            }       

          free (name);
          free (temp1);
          *indexp = sindex;

          ret = alloc_word_desc ();
          ret->word = temp;
          ret->flags = tflag;   /* XXX */
          return ret;
        }

      free (temp1);
    }
#endif /* ARRAY_VARS */
      
  /* Make sure that NAME is valid before trying to go on. */
  if (valid_brace_expansion_word (want_indir ? name + 1 : name,
                                        var_is_special) == 0)
    {
      temp = (char *)NULL;
      goto bad_substitution;            /* substitution error */
    }

  if (want_indir)
    {
      tdesc = parameter_brace_expand_indir (name + 1, var_is_special, quoted, pflags|local_pflags, quoted_dollar_atp, contains_dollar_at);
      if (tdesc == &expand_wdesc_error || tdesc == &expand_wdesc_fatal)
        {
          temp = (char *)NULL;
          goto bad_substitution;
        }

      /* Turn off the W_ARRAYIND flag because there is no way for this function
         to return the index we're supposed to be using. */
      if (tdesc && tdesc->flags)
        tdesc->flags &= ~W_ARRAYIND;

      /* If the indir expansion contains $@/$*, extend the special treatment
         of the case of no positional parameters and `set -u' to it. */
      if (contains_dollar_at && *contains_dollar_at)
        all_element_arrayref = 1;
    }
  else
    {
      local_pflags |= PF_IGNUNBOUND|(pflags&(PF_NOSPLIT2|PF_ASSIGNRHS));
      tdesc = parameter_brace_expand_word (name, var_is_special, quoted, local_pflags, &es);
    }

  if (tdesc == &expand_wdesc_error || tdesc == &expand_wdesc_fatal)
    {
      tflag = 0;
      tdesc = 0;
    }

  if (tdesc)
    {
      temp = tdesc->word;
      tflag = tdesc->flags;
      dispose_word_desc (tdesc);
    }
  else
    temp = (char *)0;

  if (temp == &expand_param_error || temp == &expand_param_fatal)
    {
      FREE (name);
      FREE (value);
      return (temp == &expand_param_error ? &expand_wdesc_error : &expand_wdesc_fatal);
    }

#if defined (ARRAY_VARS)
  if (valid_array_reference (name, 0))
    {
      int qflags;
      char *t;

      qflags = quoted;
      /* If in a context where word splitting will not take place, treat as
         if double-quoted.  Has effects with $* and ${array[*]} */

      if (pflags & PF_ASSIGNRHS)
        qflags |= Q_DOUBLE_QUOTES;
      /* We duplicate a little code here */
      t = mbschr (name, LBRACK);
      if (t && ALL_ELEMENT_SUB (t[1]) && t[2] == RBRACK)
        {
          all_element_arrayref = 1;
          if (expand_no_split_dollar_star && t[1] == '*')       /* XXX */
            qflags |= Q_DOUBLE_QUOTES;
        }
      chk_atstar (name, qflags, pflags, quoted_dollar_atp, contains_dollar_at);
    }
#endif

  var_is_set = temp != (char *)0;
  var_is_null = check_nullness && (var_is_set == 0 || *temp == 0);
  /* XXX - this may not need to be restricted to special variables */
  if (check_nullness)
    var_is_null |= var_is_set && var_is_special && (quoted & (Q_HERE_DOCUMENT|Q_DOUBLE_QUOTES)) && QUOTED_NULL (temp);
#if defined (ARRAY_VARS)
  if (check_nullness)
    var_is_null |= var_is_set && 
                   (quoted & (Q_HERE_DOCUMENT|Q_DOUBLE_QUOTES)) &&
                   QUOTED_NULL (temp) &&
                   valid_array_reference (name, 0) &&
                   chk_atstar (name, 0, 0, (int *)0, (int *)0);
#endif

  /* Get the rest of the stuff inside the braces. */
  if (c && c != RBRACE)
    {
      /* Extract the contents of the ${ ... } expansion
         according to the Posix.2 rules. */
      value = extract_dollar_brace_string (string, &sindex, quoted, (c == '%' || c == '#' || c =='/' || c == '^' || c == ',' || c ==':') ? SX_POSIXEXP|SX_WORD : SX_WORD);
      if (string[sindex] == RBRACE)
        sindex++;
      else
        goto bad_substitution;          /* substitution error */
    }
  else
    value = (char *)NULL;

  *indexp = sindex;

  /* All the cases where an expansion can possibly generate an unbound
     variable error. */
  if (want_substring || want_patsub || want_casemod || c == '@' || c == '#' || c == '%' || c == RBRACE)
    {
      if (var_is_set == 0 && unbound_vars_is_error && ((name[0] != '@' && name[0] != '*') || name[1]) && all_element_arrayref == 0)
        {
          set_exit_status (EXECUTION_FAILURE);
          err_unboundvar (name);
          FREE (value);
          FREE (temp);
          free (name);
          return (interactive_shell ? &expand_wdesc_error : &expand_wdesc_fatal);
        }
    }
    
  /* If this is a substring spec, process it and add the result. */
  if (want_substring)
    {
      temp1 = parameter_brace_substring (name, temp, &es, value, quoted, pflags, (tflag & W_ARRAYIND) ? AV_USEIND : 0);
      FREE (value);
      FREE (temp);
#if defined (ARRAY_VARS)
      flush_eltstate (&es);
#endif

      if (temp1 == &expand_param_error || temp1 == &expand_param_fatal)
        {
          FREE (name);
          return (temp1 == &expand_param_error ? &expand_wdesc_error : &expand_wdesc_fatal);
        }

      ret = alloc_word_desc ();
      ret->word = temp1;
      /* We test quoted_dollar_atp because we want variants with double-quoted
         "$@" to take a different code path. In fact, we make sure at the end
         of expand_word_internal that we're only looking at these flags if
         quoted_dollar_at == 0. */
      if (temp1 &&
          (quoted_dollar_atp == 0 || *quoted_dollar_atp == 0) &&
          QUOTED_NULL (temp1) && (quoted & (Q_HERE_DOCUMENT|Q_DOUBLE_QUOTES)))
        ret->flags |= W_QUOTED|W_HASQUOTEDNULL;
      else if (temp1 && (name[0] == '*' && name[1] == 0) && quoted == 0 &&
                (pflags & PF_ASSIGNRHS))
        ret->flags |= W_SPLITSPACE;     /* Posix interp 888 */  
      /* Special handling for $* when unquoted and $IFS is null. Posix interp 888 */
      else if (temp1 && (name[0] == '*' && name[1] == 0) && quoted == 0 && ifs_is_null)
        ret->flags |= W_SPLITSPACE;     /* Posix interp 888 */

      FREE (name);
      return ret;
    }
  else if (want_patsub)
    {
      temp1 = parameter_brace_patsub (name, temp, &es, value, quoted, pflags, (tflag & W_ARRAYIND) ? AV_USEIND : 0);
      FREE (value);
      FREE (temp);
#if defined (ARRAY_VARS)
      flush_eltstate (&es);
#endif

      if (temp1 == &expand_param_error || temp1 == &expand_param_fatal)
        {
          FREE (name);
          return (temp1 == &expand_param_error ? &expand_wdesc_error : &expand_wdesc_fatal);
        }

      ret = alloc_word_desc ();
      ret->word = temp1;
      if (temp1 && 
          (quoted_dollar_atp == 0 || *quoted_dollar_atp == 0) &&
          QUOTED_NULL (temp1) && (quoted & (Q_HERE_DOCUMENT|Q_DOUBLE_QUOTES)))
        ret->flags |= W_QUOTED|W_HASQUOTEDNULL;
      /* Special handling for $* when unquoted and $IFS is null. Posix interp 888 */
      else if (temp1 && (name[0] == '*' && name[1] == 0) && quoted == 0 && ifs_is_null)
        ret->flags |= W_SPLITSPACE;     /* Posix interp 888 */

      FREE (name);
      return ret;
    }
#if defined (CASEMOD_EXPANSIONS)
  else if (want_casemod)
    {
      temp1 = parameter_brace_casemod (name, temp, &es, modspec, value, quoted, pflags, (tflag & W_ARRAYIND) ? AV_USEIND : 0);
      FREE (value);
      FREE (temp);
#if defined (ARRAY_VARS)
      flush_eltstate (&es);
#endif

      if (temp1 == &expand_param_error || temp1 == &expand_param_fatal)
        {
          FREE (name);
          return (temp1 == &expand_param_error ? &expand_wdesc_error : &expand_wdesc_fatal);
        }

      ret = alloc_word_desc ();
      ret->word = temp1;
      if (temp1 &&
          (quoted_dollar_atp == 0 || *quoted_dollar_atp == 0) &&
          QUOTED_NULL (temp1) && (quoted & (Q_HERE_DOCUMENT|Q_DOUBLE_QUOTES)))
        ret->flags |= W_QUOTED|W_HASQUOTEDNULL;
      /* Special handling for $* when unquoted and $IFS is null. Posix interp 888 */
      else if (temp1 && (name[0] == '*' && name[1] == 0) && quoted == 0 && ifs_is_null)
        ret->flags |= W_SPLITSPACE;     /* Posix interp 888 */

      FREE (name);
      return ret;
    }
#endif

  /* Do the right thing based on which character ended the variable name. */
  switch (c)
    {
    default:
    case '\0':
bad_substitution:
      set_exit_status (EXECUTION_FAILURE);
      report_error (_("%s: bad substitution"), string ? string : "??");
      FREE (value);
      FREE (temp);
      free (name);
#if defined (ARRAY_VARS)
      flush_eltstate (&es);
#endif
      if (shell_compatibility_level <= 43)
        return &expand_wdesc_error;
      else
        return ((posixly_correct && interactive_shell == 0) ? &expand_wdesc_fatal : &expand_wdesc_error);

    case RBRACE:
      break;

    case '@':
      temp1 = parameter_brace_transform (name, temp, &es, value, c, quoted, pflags, (tflag & W_ARRAYIND) ? AV_USEIND : 0);
      free (temp);
      free (value);
#if defined (ARRAY_VARS)
      flush_eltstate (&es);
#endif

      if (temp1 == &expand_param_error || temp1 == &expand_param_fatal)
        {
          free (name);
          set_exit_status (EXECUTION_FAILURE);
          report_error (_("%s: bad substitution"), string ? string : "??");
          return (temp1 == &expand_param_error ? &expand_wdesc_error : &expand_wdesc_fatal);
        }

      ret = alloc_word_desc ();
      ret->word = temp1;
      if (temp1 && QUOTED_NULL (temp1) && (quoted & (Q_HERE_DOCUMENT|Q_DOUBLE_QUOTES)))
        ret->flags |= W_QUOTED|W_HASQUOTEDNULL;
      /* Special handling for $* when unquoted and $IFS is null. Posix interp 888 */
      else if (temp1 && (name[0] == '*' && name[1] == 0) && quoted == 0 && ifs_is_null)
        ret->flags |= W_SPLITSPACE;     /* Posix interp 888 */

      free (name);
      return ret;

    case '#':   /* ${param#[#]pattern} */
    case '%':   /* ${param%[%]pattern} */
      if (value == 0 || *value == '\0' || temp == 0 || *temp == '\0')
        {
          FREE (value);
          break;
        }
      temp1 = parameter_brace_remove_pattern (name, temp, &es, value, c, quoted, (tflag & W_ARRAYIND) ? AV_USEIND : 0);
      free (temp);
      free (value);
#if defined (ARRAY_VARS)
      flush_eltstate (&es);
#endif

      ret = alloc_word_desc ();
      ret->word = temp1;
      if (temp1 && QUOTED_NULL (temp1) && (quoted & (Q_HERE_DOCUMENT|Q_DOUBLE_QUOTES)))
        ret->flags |= W_QUOTED|W_HASQUOTEDNULL;
      /* Special handling for $* when unquoted and $IFS is null. Posix interp 888 */
      else if (temp1 && (name[0] == '*' && name[1] == 0) && quoted == 0 && ifs_is_null)
        ret->flags |= W_SPLITSPACE;     /* Posix interp 888 */

      free (name);
      return ret;

    case '-':
    case '=':
    case '?':
    case '+':
      if (var_is_set && var_is_null == 0)
        {
          /* If the operator is `+', we don't want the value of the named
             variable for anything, just the value of the right hand side. */
          if (c == '+')
            {
              /* XXX -- if we're double-quoted and the named variable is "$@",
                        we want to turn off any special handling of "$@" --
                        we're not using it, so whatever is on the rhs applies. */
              if ((quoted & (Q_HERE_DOCUMENT|Q_DOUBLE_QUOTES)) && quoted_dollar_atp)
                *quoted_dollar_atp = 0;
              if (contains_dollar_at)
                *contains_dollar_at = 0;

              FREE (temp);
              if (value)
                {
                  /* From Posix discussion on austin-group list.  Issue 221
                     requires that backslashes escaping `}' inside
                     double-quoted ${...} be removed. */
                  if (quoted & (Q_HERE_DOCUMENT|Q_DOUBLE_QUOTES))
                    quoted |= Q_DOLBRACE;
                  ret = parameter_brace_expand_rhs (name, value, c,
                                                    quoted,
                                                    pflags,
                                                    quoted_dollar_atp,
                                                    contains_dollar_at);
                  /* XXX - fix up later, esp. noting presence of
                           W_HASQUOTEDNULL in ret->flags */
                  free (value);
                }
              else
                temp = (char *)NULL;
            }
          else
            {
              FREE (value);
            }
          /* Otherwise do nothing; just use the value in TEMP. */
        }
      else      /* VAR not set or VAR is NULL. */
        {
          /* If we're freeing a quoted null here, we need to remember we saw
             it so we can restore it later if needed, or the caller can note it.
             The check against `+' doesn't really matter, since the other cases
             don't use or return TFLAG, but it's good for clarity. */
          if (c == '+' && temp && QUOTED_NULL (temp) &&
              (quoted & (Q_DOUBLE_QUOTES|Q_HERE_DOCUMENT)))
            tflag |= W_HASQUOTEDNULL;

          FREE (temp);
          temp = (char *)NULL;
          if (c == '=' && var_is_special)
            {
              set_exit_status (EXECUTION_FAILURE);
              report_error (_("$%s: cannot assign in this way"), name);
              free (name);
              free (value);
#if defined (ARRAY_VARS)
              flush_eltstate (&es);
#endif
              return &expand_wdesc_error;
            }
          else if (c == '?')
            {
              parameter_brace_expand_error (name, value, check_nullness);
#if defined (ARRAY_VARS)
              flush_eltstate (&es);
#endif
              return (interactive_shell ? &expand_wdesc_error : &expand_wdesc_fatal);
            }
          else if (c != '+')
            {
              /* XXX -- if we're double-quoted and the named variable is "$@",
                        we want to turn off any special handling of "$@" --
                        we're not using it, so whatever is on the rhs applies. */
              if ((quoted & (Q_HERE_DOCUMENT|Q_DOUBLE_QUOTES)) && quoted_dollar_atp)
                *quoted_dollar_atp = 0;
              if (contains_dollar_at)
                *contains_dollar_at = 0;

              /* From Posix discussion on austin-group list.  Issue 221 requires
                 that backslashes escaping `}' inside double-quoted ${...} be
                 removed. */
              if (quoted & (Q_HERE_DOCUMENT|Q_DOUBLE_QUOTES))
                quoted |= Q_DOLBRACE;
              ret = parameter_brace_expand_rhs (name, value, c, quoted, pflags,
                                                quoted_dollar_atp,
                                                contains_dollar_at);
              /* XXX - fix up later, esp. noting presence of
                       W_HASQUOTEDNULL in tdesc->flags */
            }
          free (value);
        }

      break;
    }
  free (name);
#if defined (ARRAY_VARS)
  flush_eltstate (&es);
#endif

  if (ret == 0)
    {
      ret = alloc_word_desc ();
      ret->flags = tflag;
      ret->word = temp;
    }
  return (ret);
}

/* Expand a single ${xxx} expansion.  The braces are optional.  When
   the braces are used, parameter_brace_expand() does the work,
   possibly calling param_expand recursively. */
static WORD_DESC *
param_expand (string, sindex, quoted, expanded_something,
              contains_dollar_at, quoted_dollar_at_p, had_quoted_null_p,
              pflags)
     char *string;
     int *sindex, quoted, *expanded_something, *contains_dollar_at;
     int *quoted_dollar_at_p, *had_quoted_null_p, pflags;
{
  char *temp, *temp1, uerror[3], *savecmd;
  int zindex, t_index, expok, eflag;
  unsigned char c;
  intmax_t number;
  SHELL_VAR *var;
  WORD_LIST *list, *l;
  WORD_DESC *tdesc, *ret;
  int tflag, nullarg;

/*itrace("param_expand: `%s' pflags = %d", string+*sindex, pflags);*/
  zindex = *sindex;
  c = string[++zindex];

  temp = (char *)NULL;
  ret = tdesc = (WORD_DESC *)NULL;
  tflag = 0;

  /* Do simple cases first. Switch on what follows '$'. */
  switch (c)
    {
    /* $0 .. $9? */
    case '0':
    case '1':
    case '2':
    case '3':
    case '4':
    case '5':
    case '6':
    case '7':
    case '8':
    case '9':
      temp1 = dollar_vars[TODIGIT (c)];
      /* This doesn't get called when (pflags&PF_IGNUNBOUND) != 0 */
      if (unbound_vars_is_error && temp1 == (char *)NULL)
        {
          uerror[0] = '$';
          uerror[1] = c;
          uerror[2] = '\0';
          set_exit_status (EXECUTION_FAILURE);
          err_unboundvar (uerror);
          return (interactive_shell ? &expand_wdesc_error : &expand_wdesc_fatal);
        }
      if (temp1)
        temp = (*temp1 && (quoted & (Q_HERE_DOCUMENT|Q_DOUBLE_QUOTES)))
                  ? quote_string (temp1)
                  : quote_escapes (temp1);
      else
        temp = (char *)NULL;

      break;

    /* $$ -- pid of the invoking shell. */
    case '$':
      temp = itos (dollar_dollar_pid);
      break;

    /* $# -- number of positional parameters. */
    case '#':
      temp = itos (number_of_args ());
      break;

    /* $? -- return value of the last synchronous command. */
    case '?':
      temp = itos (last_command_exit_value);
      break;

    /* $- -- flags supplied to the shell on invocation or by `set'. */
    case '-':
      temp = which_set_flags ();
      break;

      /* $! -- Pid of the last asynchronous command. */
    case '!':
      /* If no asynchronous pids have been created, expand to nothing.
         If `set -u' has been executed, and no async processes have
         been created, this is an expansion error. */
      if (last_asynchronous_pid == NO_PID)
        {
          if (expanded_something)
            *expanded_something = 0;
          temp = (char *)NULL;
          if (unbound_vars_is_error && (pflags & PF_IGNUNBOUND) == 0)
            {
              uerror[0] = '$';
              uerror[1] = c;
              uerror[2] = '\0';
              set_exit_status (EXECUTION_FAILURE);
              err_unboundvar (uerror);
              return (interactive_shell ? &expand_wdesc_error : &expand_wdesc_fatal);
            }
        }
      else
        temp = itos (last_asynchronous_pid);
      break;

    /* The only difference between this and $@ is when the arg is quoted. */
    case '*':           /* `$*' */
      list = list_rest_of_args ();

#if 0
      /* According to austin-group posix proposal by Geoff Clare in
         <20090505091501.GA10097@squonk.masqnet> of 5 May 2009:

        "The shell shall write a message to standard error and
         immediately exit when it tries to expand an unset parameter
         other than the '@' and '*' special parameters."
      */

      if (list == 0 && unbound_vars_is_error && (pflags & PF_IGNUNBOUND) == 0)
        {
          uerror[0] = '$';
          uerror[1] = '*';
          uerror[2] = '\0';
          set_exit_status (EXECUTION_FAILURE);
          err_unboundvar (uerror);
          return (interactive_shell ? &expand_wdesc_error : &expand_wdesc_fatal);
        }
#endif

      /* If there are no command-line arguments, this should just
         disappear if there are other characters in the expansion,
         even if it's quoted. */
      if ((quoted & (Q_HERE_DOCUMENT|Q_DOUBLE_QUOTES)) && list == 0)
        temp = (char *)NULL;
      else if (quoted & (Q_HERE_DOCUMENT|Q_DOUBLE_QUOTES|Q_PATQUOTE))
        {
          /* If we have "$*" we want to make a string of the positional
             parameters, separated by the first character of $IFS, and
             quote the whole string, including the separators.  If IFS
             is unset, the parameters are separated by ' '; if $IFS is
             null, the parameters are concatenated. */
          temp = (quoted & (Q_DOUBLE_QUOTES|Q_PATQUOTE)) ? string_list_dollar_star (list, quoted, 0) : string_list (list);
          if (temp)
            {
              temp1 = (quoted & Q_DOUBLE_QUOTES) ? quote_string (temp) : temp;
              if (*temp == 0)
                tflag |= W_HASQUOTEDNULL;
              if (temp != temp1)
                free (temp);
              temp = temp1;
            }
        }
      else
        {
          /* We check whether or not we're eventually going to split $* here,
             for example when IFS is empty and we are processing the rhs of
             an assignment statement.  In that case, we don't separate the
             arguments at all.  Otherwise, if the $* is not quoted it is
             identical to $@ */
          if (expand_no_split_dollar_star && quoted == 0 && ifs_is_set == 0 && (pflags & PF_ASSIGNRHS))
            {
              /* Posix interp 888: RHS of assignment, IFS unset: no splitting,
                 separate with space */
              temp1 = string_list_dollar_star (list, quoted, pflags);
              temp = temp1 ? quote_string (temp1) : temp1;
              /* XXX - tentative - note that we saw a quoted null here */
              if (temp1 && *temp1 == 0 && QUOTED_NULL (temp))
                tflag |= W_SAWQUOTEDNULL;
              FREE (temp1);
            }
          else if (expand_no_split_dollar_star && quoted == 0 && ifs_is_null && (pflags & PF_ASSIGNRHS))
            {
              /* Posix interp 888: RHS of assignment, IFS set to '' */
              temp1 = string_list_dollar_star (list, quoted, pflags);
              temp = temp1 ? quote_escapes (temp1) : temp1;
              FREE (temp1);
            }
          else if (expand_no_split_dollar_star && quoted == 0 && ifs_is_set && ifs_is_null == 0 && (pflags & PF_ASSIGNRHS))
            {
              /* Posix interp 888: RHS of assignment, IFS set to non-null value */
              temp1 = string_list_dollar_star (list, quoted, pflags);
              temp = temp1 ? quote_string (temp1) : temp1;

              /* XXX - tentative - note that we saw a quoted null here */
              if (temp1 && *temp1 == 0 && QUOTED_NULL (temp))
                tflag |= W_SAWQUOTEDNULL;
              FREE (temp1);
            }
          /* XXX - should we check ifs_is_set here as well? */
#  if defined (HANDLE_MULTIBYTE)
          else if (expand_no_split_dollar_star && ifs_firstc[0] == 0)
#  else
          else if (expand_no_split_dollar_star && ifs_firstc == 0)
#  endif
            /* Posix interp 888: not RHS, no splitting, IFS set to '' */
            temp = string_list_dollar_star (list, quoted, 0);
          else
            {
              temp = string_list_dollar_at (list, quoted, 0);
              /* Set W_SPLITSPACE to make sure the individual positional
                 parameters are split into separate arguments */
#if 0
              if (quoted == 0 && (ifs_is_set == 0 || ifs_is_null))
#else   /* change with bash-5.0 */
              if (quoted == 0 && ifs_is_null)
#endif
                tflag |= W_SPLITSPACE;
              /* If we're not quoted but we still don't want word splitting, make
                 we quote the IFS characters to protect them from splitting (e.g.,
                 when $@ is in the string as well). */
              else if (temp && quoted == 0 && ifs_is_set && (pflags & PF_ASSIGNRHS))
                {
                  temp1 = quote_string (temp);
                  free (temp);
                  temp = temp1;
                }
            }

          if (expand_no_split_dollar_star == 0 && contains_dollar_at)
            *contains_dollar_at = 1;
        }

      dispose_words (list);
      break;

    /* When we have "$@" what we want is "$1" "$2" "$3" ... This
       means that we have to turn quoting off after we split into
       the individually quoted arguments so that the final split
       on the first character of $IFS is still done.  */
    case '@':           /* `$@' */
      list = list_rest_of_args ();

#if 0
      /* According to austin-group posix proposal by Geoff Clare in
         <20090505091501.GA10097@squonk.masqnet> of 5 May 2009:

        "The shell shall write a message to standard error and
         immediately exit when it tries to expand an unset parameter
         other than the '@' and '*' special parameters."
      */

      if (list == 0 && unbound_vars_is_error && (pflags & PF_IGNUNBOUND) == 0)
        {
          uerror[0] = '$';
          uerror[1] = '@';
          uerror[2] = '\0';
          set_exit_status (EXECUTION_FAILURE);
          err_unboundvar (uerror);
          return (interactive_shell ? &expand_wdesc_error : &expand_wdesc_fatal);
        }
#endif

      for (nullarg = 0, l = list; l; l = l->next)
        {
          if (l->word && (l->word->word == 0 || l->word->word[0] == 0))
            nullarg = 1;
        }

      /* We want to flag the fact that we saw this.  We can't turn
         off quoting entirely, because other characters in the
         string might need it (consider "\"$@\""), but we need some
         way to signal that the final split on the first character
         of $IFS should be done, even though QUOTED is 1. */
      /* XXX - should this test include Q_PATQUOTE? */
      if (quoted_dollar_at_p && (quoted & (Q_HERE_DOCUMENT|Q_DOUBLE_QUOTES)))
        *quoted_dollar_at_p = 1;
      if (contains_dollar_at)
        *contains_dollar_at = 1;

      /* We want to separate the positional parameters with the first
         character of $IFS in case $IFS is something other than a space.
         We also want to make sure that splitting is done no matter what --
         according to POSIX.2, this expands to a list of the positional
         parameters no matter what IFS is set to. */
      /* XXX - what to do when in a context where word splitting is not
         performed? Even when IFS is not the default, posix seems to imply
         that we have to expand $@ to all the positional parameters and
         separate them with spaces, which are preserved because word splitting
         doesn't take place.  See below for how we use PF_NOSPLIT2 here. */

      /* These are the cases where word splitting will not be performed. */
      if (pflags & PF_ASSIGNRHS)
        {
          temp = string_list_dollar_at (list, (quoted|Q_DOUBLE_QUOTES), pflags);
          if (nullarg)
            tflag |= W_HASQUOTEDNULL;   /* we know quoting produces quoted nulls */
        }

      /* This needs to match what expand_word_internal does with non-quoted $@
         does with separating with spaces.  Passing Q_DOUBLE_QUOTES means that
         the characters in LIST will be quoted, and PF_ASSIGNRHS ensures that
         they will separated by spaces. After doing this, we need the special
         handling for PF_NOSPLIT2 in expand_word_internal to remove the CTLESC
         quotes. */
      else if (pflags & PF_NOSPLIT2)
        {
#if defined (HANDLE_MULTIBYTE)
          if (quoted == 0 && ifs_is_set && ifs_is_null == 0 && ifs_firstc[0] != ' ')
#else
          if (quoted == 0 && ifs_is_set && ifs_is_null == 0 && ifs_firstc != ' ')
#endif
            /* Posix interp 888 */
            temp = string_list_dollar_at (list, Q_DOUBLE_QUOTES, pflags);
          else
            temp = string_list_dollar_at (list, quoted, pflags);
        }
      else
        temp = string_list_dollar_at (list, quoted, pflags);

      tflag |= W_DOLLARAT;
      dispose_words (list);
      break;

    case LBRACE:
      tdesc = parameter_brace_expand (string, &zindex, quoted, pflags,
                                      quoted_dollar_at_p,
                                      contains_dollar_at);

      if (tdesc == &expand_wdesc_error || tdesc == &expand_wdesc_fatal)
        return (tdesc);
      temp = tdesc ? tdesc->word : (char *)0;

      /* XXX */
      /* Quoted nulls should be removed if there is anything else
         in the string. */
      /* Note that we saw the quoted null so we can add one back at
         the end of this function if there are no other characters
         in the string, discard TEMP, and go on.  The exception to
         this is when we have "${@}" and $1 is '', since $@ needs
         special handling. */
      if (tdesc && tdesc->word && (tdesc->flags & W_HASQUOTEDNULL) && QUOTED_NULL (temp))
        {
          if (had_quoted_null_p)
            *had_quoted_null_p = 1;
          if (*quoted_dollar_at_p == 0)
            {
              free (temp);
              tdesc->word = temp = (char *)NULL;
            }
            
        }

      ret = tdesc;
      goto return0;

    /* Do command or arithmetic substitution. */
    case LPAREN:
      /* We have to extract the contents of this paren substitution. */
      t_index = zindex + 1;
      /* XXX - might want to check for string[t_index+2] == LPAREN and parse
         as arithmetic substitution immediately. */
      temp = extract_command_subst (string, &t_index, (pflags&PF_COMPLETE) ? SX_COMPLETE : 0);
      zindex = t_index;

      /* For Posix.2-style `$(( ))' arithmetic substitution,
         extract the expression and pass it to the evaluator. */
      if (temp && *temp == LPAREN)
        {
          char *temp2;
          temp1 = temp + 1;
          temp2 = savestring (temp1);
          t_index = strlen (temp2) - 1;

          if (temp2[t_index] != RPAREN)
            {
              free (temp2);
              goto comsub;
            }

          /* Cut off ending `)' */
          temp2[t_index] = '\0';

          if (chk_arithsub (temp2, t_index) == 0)
            {
              free (temp2);
#if 0
              internal_warning (_("future versions of the shell will force evaluation as an arithmetic substitution"));
#endif
              goto comsub;
            }

          /* Expand variables found inside the expression. */
          temp1 = expand_arith_string (temp2, Q_DOUBLE_QUOTES|Q_ARITH);
          free (temp2);

arithsub:
          /* No error messages. */
          savecmd = this_command_name;
          this_command_name = (char *)NULL;

          eflag = (shell_compatibility_level > 51) ? 0 : EXP_EXPANDED;
          number = evalexp (temp1, eflag, &expok);
          this_command_name = savecmd;
          free (temp);
          free (temp1);
          if (expok == 0)
            {
              if (interactive_shell == 0 && posixly_correct)
                {
                  set_exit_status (EXECUTION_FAILURE);
                  return (&expand_wdesc_fatal);
                }
              else
                return (&expand_wdesc_error);
            }
          temp = itos (number);
          break;
        }

comsub:
      if (pflags & PF_NOCOMSUB)
        /* we need zindex+1 because string[zindex] == RPAREN */
        temp1 = substring (string, *sindex, zindex+1);
      else
        {
          tdesc = command_substitute (temp, quoted, pflags&PF_ASSIGNRHS);
          temp1 = tdesc ? tdesc->word : (char *)NULL;
          if (tdesc)
            dispose_word_desc (tdesc);
        }
      FREE (temp);
      temp = temp1;
      break;

    /* Do POSIX.2d9-style arithmetic substitution.  This will probably go
       away in a future bash release. */
    case '[':           /*]*/
      /* Extract the contents of this arithmetic substitution. */
      t_index = zindex + 1;
      temp = extract_arithmetic_subst (string, &t_index);
      zindex = t_index;
      if (temp == 0)
        {
          temp = savestring (string);
          if (expanded_something)
            *expanded_something = 0;
          goto return0;
        }         

       /* Do initial variable expansion. */
      temp1 = expand_arith_string (temp, Q_DOUBLE_QUOTES|Q_ARITH);

      goto arithsub;

    default:
      /* Find the variable in VARIABLE_LIST. */
      temp = (char *)NULL;

      for (t_index = zindex; (c = string[zindex]) && legal_variable_char (c); zindex++)
        ;
      temp1 = (zindex > t_index) ? substring (string, t_index, zindex) : (char *)NULL;

      /* If this isn't a variable name, then just output the `$'. */
      if (temp1 == 0 || *temp1 == '\0')
        {
          FREE (temp1);
          temp = (char *)xmalloc (2);
          temp[0] = '$';
          temp[1] = '\0';
          if (expanded_something)
            *expanded_something = 0;
          goto return0;
        }

      /* If the variable exists, return its value cell. */
      var = find_variable (temp1);

      if (var && invisible_p (var) == 0 && var_isset (var))
        {
#if defined (ARRAY_VARS)
          if (assoc_p (var) || array_p (var))
            {
              temp = array_p (var) ? array_reference (array_cell (var), 0)
                                   : assoc_reference (assoc_cell (var), "0");
              if (temp)
                temp = (*temp && (quoted & (Q_HERE_DOCUMENT|Q_DOUBLE_QUOTES)))
                          ? quote_string (temp)
                          : quote_escapes (temp);
              else if (unbound_vars_is_error)
                goto unbound_variable;
            }
          else
#endif
            {
              temp = value_cell (var);

              temp = (*temp && (quoted & (Q_HERE_DOCUMENT|Q_DOUBLE_QUOTES)))
                        ? quote_string (temp)
                        : ((pflags & PF_ASSIGNRHS) ? quote_rhs (temp)
                                                   : quote_escapes (temp));
            }

          free (temp1);

          goto return0;
        }
      else if (var && (invisible_p (var) || var_isset (var) == 0))
        temp = (char *)NULL;
      else if ((var = find_variable_last_nameref (temp1, 0)) && var_isset (var) && invisible_p (var) == 0)
        {
          temp = nameref_cell (var);
#if defined (ARRAY_VARS)
          if (temp && *temp && valid_array_reference (temp, 0))
            {
              chk_atstar (temp, quoted, pflags, quoted_dollar_at_p, contains_dollar_at);
              tdesc = parameter_brace_expand_word (temp, SPECIAL_VAR (temp, 0), quoted, pflags, 0);
              if (tdesc == &expand_wdesc_error || tdesc == &expand_wdesc_fatal)
                return (tdesc);
              ret = tdesc;
              goto return0;
            }
          else
#endif
          /* y=2 ; typeset -n x=y; echo $x is not the same as echo $2 in ksh */
          if (temp && *temp && legal_identifier (temp) == 0)
            {
              set_exit_status (EXECUTION_FAILURE);
              report_error (_("%s: invalid variable name for name reference"), temp);
              return (&expand_wdesc_error);     /* XXX */
            }
          else
            temp = (char *)NULL;
        }

      temp = (char *)NULL;

unbound_variable:
      if (unbound_vars_is_error)
        {
          set_exit_status (EXECUTION_FAILURE);
          err_unboundvar (temp1);
        }
      else
        {
          free (temp1);
          goto return0;
        }

      free (temp1);
      set_exit_status (EXECUTION_FAILURE);
      return ((unbound_vars_is_error && interactive_shell == 0)
                ? &expand_wdesc_fatal
                : &expand_wdesc_error);
    }

  if (string[zindex])
    zindex++;

return0:
  *sindex = zindex;

  if (ret == 0)
    {
      ret = alloc_word_desc ();
      ret->flags = tflag;       /* XXX */
      ret->word = temp;
    }
  return ret;
}

#if defined (ARRAY_VARS)
/* Characters that need to be backslash-quoted after expanding array subscripts */
static char abstab[256] = { '\1' };

/* Run an array subscript through the appropriate word expansions. */
char *
expand_subscript_string (string, quoted)
     char *string;
     int quoted;
{
  WORD_DESC td;
  WORD_LIST *tlist;
  int oe;
  char *ret;

  if (string == 0 || *string == 0)
    return (char *)NULL;

  oe = expand_no_split_dollar_star;
  ret = (char *)NULL;

  td.flags = W_NOPROCSUB|W_NOTILDE|W_NOSPLIT2;  /* XXX - W_NOCOMSUB? */
  td.word = savestring (string);                /* in case it's freed on error */

  expand_no_split_dollar_star = 1;
  tlist = call_expand_word_internal (&td, quoted, 0, (int *)NULL, (int *)NULL);
  expand_no_split_dollar_star = oe;

  if (tlist)
    {
      if (tlist->word)
        {
          remove_quoted_nulls (tlist->word->word);
          tlist->word->flags &= ~W_HASQUOTEDNULL;
        }
      dequote_list (tlist);
      ret = string_list (tlist);
      dispose_words (tlist);
    }

  free (td.word);
  return (ret);
}

/* Expand the subscript in STRING, which is an array reference. To ensure we
   only expand it once, we quote the characters that would start another
   expansion and the bracket characters that are special to array subscripts. */
static char *
expand_array_subscript (string, sindex, quoted, flags)
     char *string;
     int *sindex;
     int quoted, flags;
{
  char *ret, *exp, *t;
  size_t slen;
  int si, ni;

  si = *sindex;
  slen = STRLEN (string);

  if (abstab[0] == '\1')
    {
      /* These are basically the characters that start shell expansions plus
         the characters that delimit subscripts. */
      memset (abstab, '\0', sizeof (abstab));
      abstab[LBRACK] = abstab[RBRACK] = 1;
      abstab['$'] = abstab['`'] = abstab['~'] = 1;
      abstab['\\'] = abstab['\''] = 1;
      abstab['"'] = 1;  /* XXX */
      /* We don't quote `@' or `*' in the subscript at all. */
    }

  /* string[si] == LBRACK */
  ni = skipsubscript (string, si, 0);
  /* These checks mirror the ones in valid_array_reference. The check for
     (ni - si) == 1 checks for empty subscripts. We don't check that the
     subscript is a separate word if we're parsing an arithmetic expression. */
  if (ni >= slen || string[ni] != RBRACK || (ni - si) == 1 ||
      (string[ni+1] != '\0' && (quoted & Q_ARITH) == 0))
    {
      /* let's check and see what fails this check */
      INTERNAL_DEBUG (("expand_array_subscript: bad subscript string: `%s'", string+si));
      ret = (char *)xmalloc (2);        /* badly-formed subscript */
      ret[0] = string[si];
      ret[1] = '\0';
      *sindex = si + 1;
      return ret;
    }

  /* STRING[ni] == RBRACK */
  exp = substring (string, si+1, ni);
  t = expand_subscript_string (exp, quoted & ~(Q_ARITH|Q_DOUBLE_QUOTES));
  free (exp);
  exp = t ? sh_backslash_quote (t, abstab, 0) : savestring ("");
  free (t);

  slen = STRLEN (exp);
  ret = xmalloc (slen + 2 + 1);
  ret[0] ='[';
  strcpy (ret + 1, exp);
  ret[slen + 1] = ']';
  ret[slen + 2] = '\0';

  free (exp);
  *sindex = ni + 1;

  return ret;
}
#endif

void
invalidate_cached_quoted_dollar_at ()
{
  dispose_words (cached_quoted_dollar_at);
  cached_quoted_dollar_at = 0;
}

/* Make a word list which is the result of parameter and variable
   expansion, command substitution, arithmetic substitution, and
   quote removal of WORD.  Return a pointer to a WORD_LIST which is
   the result of the expansion.  If WORD contains a null word, the
   word list returned is also null.

   QUOTED contains flag values defined in shell.h.

   ISEXP is used to tell expand_word_internal that the word should be
   treated as the result of an expansion.  This has implications for
   how IFS characters in the word are treated.

   CONTAINS_DOLLAR_AT and EXPANDED_SOMETHING are return values; when non-null
   they point to an integer value which receives information about expansion.
   CONTAINS_DOLLAR_AT gets non-zero if WORD contained "$@", else zero.
   EXPANDED_SOMETHING get non-zero if WORD contained any parameter expansions,
   else zero.

   This only does word splitting in the case of $@ expansion.  In that
   case, we split on ' '. */

/* Values for the local variable quoted_state. */
#define UNQUOTED         0
#define PARTIALLY_QUOTED 1
#define WHOLLY_QUOTED    2

static WORD_LIST *
expand_word_internal (word, quoted, isexp, contains_dollar_at, expanded_something)
     WORD_DESC *word;
     int quoted, isexp;
     int *contains_dollar_at;
     int *expanded_something;
{
  WORD_LIST *list;
  WORD_DESC *tword;

  /* The intermediate string that we build while expanding. */
  char *istring;

  /* The current size of the above object. */
  size_t istring_size;

  /* Index into ISTRING. */
  size_t istring_index;

  /* Temporary string storage. */
  char *temp, *temp1;

  /* The text of WORD. */
  register char *string;

  /* The size of STRING. */
  size_t string_size;

  /* The index into STRING. */
  int sindex;

  /* This gets 1 if we see a $@ while quoted. */
  int quoted_dollar_at;

  /* One of UNQUOTED, PARTIALLY_QUOTED, or WHOLLY_QUOTED, depending on
     whether WORD contains no quoting characters, a partially quoted
     string (e.g., "xx"ab), or is fully quoted (e.g., "xxab"). */
  int quoted_state;

  /* State flags */
  int had_quoted_null;
  int has_quoted_ifs;           /* did we add a quoted $IFS character here? */
  int has_dollar_at, temp_has_dollar_at;
  int internal_tilde;
  int split_on_spaces;
  int local_expanded;
  int tflag;
  int pflags;                   /* flags passed to param_expand */
  int mb_cur_max;

  int assignoff;                /* If assignment, offset of `=' */

  register unsigned char c;     /* Current character. */
  int t_index;                  /* For calls to string_extract_xxx. */

  char twochars[2];

  DECLARE_MBSTATE;

  /* OK, let's see if we can optimize a common idiom: "$@". This needs to make sure
     that all of the flags callers care about (e.g., W_HASQUOTEDNULL) are set in
     list->flags. */
  if (STREQ (word->word, "\"$@\"") &&
      (word->flags == (W_HASDOLLAR|W_QUOTED)) &&
      dollar_vars[1])           /* XXX - check IFS here as well? */
    {
      if (contains_dollar_at)
        *contains_dollar_at = 1;
      if (expanded_something)
        *expanded_something = 1;
      if (cached_quoted_dollar_at)
        return (copy_word_list (cached_quoted_dollar_at));
      list = list_rest_of_args ();
      list = quote_list (list);
      cached_quoted_dollar_at = copy_word_list (list);
      return (list);
    }

  istring = (char *)xmalloc (istring_size = DEFAULT_INITIAL_ARRAY_SIZE);
  istring[istring_index = 0] = '\0';
  quoted_dollar_at = had_quoted_null = has_dollar_at = 0;
  has_quoted_ifs = 0;
  split_on_spaces = 0;
  internal_tilde = 0;           /* expanding =~ or :~ */
  quoted_state = UNQUOTED;

  string = word->word;
  if (string == 0)
    goto finished_with_string;
  mb_cur_max = MB_CUR_MAX;

  /* Don't need the string length for the SADD... and COPY_ macros unless
     multibyte characters are possible, but do need it for bounds checking. */
  string_size = (mb_cur_max > 1) ? strlen (string) : 1;

  if (contains_dollar_at)
    *contains_dollar_at = 0;

  assignoff = -1;

  /* Begin the expansion. */

  for (sindex = 0; ;)
    {
      c = string[sindex];

      /* Case on top-level character. */
      switch (c)
        {
        case '\0':
          goto finished_with_string;

        case CTLESC:
          sindex++;
#if HANDLE_MULTIBYTE
          if (mb_cur_max > 1 && string[sindex])
            {
              SADD_MBQCHAR_BODY(temp, string, sindex, string_size);
            }
          else
#endif
            {
              temp = (char *)xmalloc (3);
              temp[0] = CTLESC;
              temp[1] = c = string[sindex];
              temp[2] = '\0';
            }

dollar_add_string:
          if (string[sindex])
            sindex++;

add_string:
          if (temp)
            {
              istring = sub_append_string (temp, istring, &istring_index, &istring_size);
              temp = (char *)0;
            }

          break;

#if defined (PROCESS_SUBSTITUTION)
          /* Process substitution. */
        case '<':
        case '>':
          {
               /* XXX - technically this should only be expanded at the start
               of a word */
            if (string[++sindex] != LPAREN || (quoted & (Q_HERE_DOCUMENT|Q_DOUBLE_QUOTES)) || (word->flags & W_NOPROCSUB))
              {
                sindex--;       /* add_character: label increments sindex */
                goto add_character;
              }
            else
              t_index = sindex + 1; /* skip past both '<' and LPAREN */

            temp1 = extract_process_subst (string, (c == '<') ? "<(" : ">(", &t_index, 0); /*))*/
            sindex = t_index;

            /* If the process substitution specification is `<()', we want to
               open the pipe for writing in the child and produce output; if
               it is `>()', we want to open the pipe for reading in the child
               and consume input. */
            temp = temp1 ? process_substitute (temp1, (c == '>')) : (char *)0;

            FREE (temp1);

            goto dollar_add_string;
          }
#endif /* PROCESS_SUBSTITUTION */

#if defined (ARRAY_VARS)
        case '[':               /*]*/
          if ((quoted & Q_ARITH) == 0 || shell_compatibility_level <= 51)
            {
              if (isexp == 0 && (word->flags & (W_NOSPLIT|W_NOSPLIT2)) == 0 && isifs (c) && (quoted & (Q_DOUBLE_QUOTES|Q_HERE_DOCUMENT)) == 0)
                goto add_ifs_character;
              else
                goto add_character;
            }
          else
            {
              temp = expand_array_subscript (string, &sindex, quoted, word->flags);
              goto add_string;
            }
#endif

        case '=':
          /* Posix.2 section 3.6.1 says that tildes following `=' in words
             which are not assignment statements are not expanded.  If the
             shell isn't in posix mode, though, we perform tilde expansion
             on `likely candidate' unquoted assignment statements (flags
             include W_ASSIGNMENT but not W_QUOTED).  A likely candidate
             contains an unquoted :~ or =~.  Something to think about: we
             now have a flag that says  to perform tilde expansion on arguments
             to `assignment builtins' like declare and export that look like
             assignment statements.  We now do tilde expansion on such words
             even in POSIX mode. */     
          if (word->flags & (W_ASSIGNRHS|W_NOTILDE))
            {
              if (isexp == 0 && (word->flags & (W_NOSPLIT|W_NOSPLIT2)) == 0 && isifs (c))
                goto add_ifs_character;
              else
                goto add_character;
            }
          /* If we're not in posix mode or forcing assignment-statement tilde
             expansion, note where the first `=' appears in the word and prepare
             to do tilde expansion following the first `='. We have to keep
             track of the first `=' (using assignoff) to avoid being confused
             by an `=' in the rhs of the assignment statement. */
          if ((word->flags & W_ASSIGNMENT) &&
              (posixly_correct == 0 || (word->flags & W_TILDEEXP)) &&
              assignoff == -1 && sindex > 0)
            assignoff = sindex;
          if (sindex == assignoff && string[sindex+1] == '~')   /* XXX */
            internal_tilde = 1;

          if (word->flags & W_ASSIGNARG)
            word->flags |= W_ASSIGNRHS;         /* affects $@ */

          if (isexp == 0 && (word->flags & (W_NOSPLIT|W_NOSPLIT2)) == 0 && isifs (c))
            {
              has_quoted_ifs++;
              goto add_ifs_character;
            }
          else
            goto add_character;

        case ':':
          if (word->flags & (W_NOTILDE|W_NOASSNTILDE))
            {
              if (isexp == 0 && (word->flags & (W_NOSPLIT|W_NOSPLIT2)) == 0 && isifs (c))
                goto add_ifs_character;
              else
                goto add_character;
            }

          if ((word->flags & (W_ASSIGNMENT|W_ASSIGNRHS)) &&
              (posixly_correct == 0 || (word->flags & W_TILDEEXP)) &&
              string[sindex+1] == '~')
            internal_tilde = 1;

          if (isexp == 0 && (word->flags & (W_NOSPLIT|W_NOSPLIT2)) == 0 && isifs (c))
            goto add_ifs_character;
          else
            goto add_character;

        case '~':
          /* If the word isn't supposed to be tilde expanded, or we're not
             at the start of a word or after an unquoted : or = in an
             assignment statement, we don't do tilde expansion.  We don't
             do tilde expansion if quoted or in an arithmetic context. */

          if ((word->flags & W_NOTILDE) ||
              (sindex > 0 && (internal_tilde == 0)) ||
              (quoted & (Q_DOUBLE_QUOTES|Q_HERE_DOCUMENT)))
            {
              internal_tilde = 0;
              if (isexp == 0 && (word->flags & (W_NOSPLIT|W_NOSPLIT2)) == 0 && isifs (c) && (quoted & (Q_DOUBLE_QUOTES|Q_HERE_DOCUMENT)) == 0)
                goto add_ifs_character;
              else
                goto add_character;
            }

          if (word->flags & W_ASSIGNRHS)
            tflag = 2;
          else if (word->flags & (W_ASSIGNMENT|W_TILDEEXP))
            tflag = 1;
          else
            tflag = 0;

          temp = bash_tilde_find_word (string + sindex, tflag, &t_index);
            
          internal_tilde = 0;

          if (temp && *temp && t_index > 0)
            {
              temp1 = bash_tilde_expand (temp, tflag);
              if  (temp1 && *temp1 == '~' && STREQ (temp, temp1))
                {
                  FREE (temp);
                  FREE (temp1);
                  goto add_character;           /* tilde expansion failed */
                }
              free (temp);
              temp = temp1;
              sindex += t_index;
              goto add_quoted_string;           /* XXX was add_string */
            }
          else
            {
              FREE (temp);
              goto add_character;
            }
        
        case '$':
          if (expanded_something)
            *expanded_something = 1;
          local_expanded = 1;

          temp_has_dollar_at = 0;
          pflags = (word->flags & W_NOCOMSUB) ? PF_NOCOMSUB : 0;
          if (word->flags & W_NOSPLIT2)
            pflags |= PF_NOSPLIT2;
          if (word->flags & W_ASSIGNRHS)
            pflags |= PF_ASSIGNRHS;
          if (word->flags & W_COMPLETE)
            pflags |= PF_COMPLETE;

          tword = param_expand (string, &sindex, quoted, expanded_something,
                               &temp_has_dollar_at, &quoted_dollar_at,
                               &had_quoted_null, pflags);
          has_dollar_at += temp_has_dollar_at;
          split_on_spaces += (tword->flags & W_SPLITSPACE);

          if (tword == &expand_wdesc_error || tword == &expand_wdesc_fatal)
            {
              free (string);
              free (istring);
              return ((tword == &expand_wdesc_error) ? &expand_word_error
                                                     : &expand_word_fatal);
            }
          if (contains_dollar_at && has_dollar_at)
            *contains_dollar_at = 1;

          if (tword && (tword->flags & W_HASQUOTEDNULL))
            had_quoted_null = 1;                /* note for later */
          if (tword && (tword->flags & W_SAWQUOTEDNULL))
            had_quoted_null = 1;                /* XXX */

          temp = tword ? tword->word : (char *)NULL;
          dispose_word_desc (tword);

          /* Kill quoted nulls; we will add them back at the end of
             expand_word_internal if nothing else in the string */
          if (had_quoted_null && temp && QUOTED_NULL (temp))
            {
              FREE (temp);
              temp = (char *)NULL;
            }

          goto add_string;
          break;

        case '`':               /* Backquoted command substitution. */
          {
            t_index = sindex++;

            temp = string_extract (string, &sindex, "`", (word->flags & W_COMPLETE) ? SX_COMPLETE : SX_REQMATCH);
            /* The test of sindex against t_index is to allow bare instances of
               ` to pass through, for backwards compatibility. */
            if (temp == &extract_string_error || temp == &extract_string_fatal)
              {
                if (sindex - 1 == t_index)
                  {
                    sindex = t_index;
                    goto add_character;
                  }
                set_exit_status (EXECUTION_FAILURE);
                report_error (_("bad substitution: no closing \"`\" in %s") , string+t_index);
                free (string);
                free (istring);
                return ((temp == &extract_string_error) ? &expand_word_error
                                                        : &expand_word_fatal);
              }
                
            if (expanded_something)
              *expanded_something = 1;
            local_expanded = 1;

            if (word->flags & W_NOCOMSUB)
              /* sindex + 1 because string[sindex] == '`' */
              temp1 = substring (string, t_index, sindex + 1);
            else
              {
                de_backslash (temp);
                tword = command_substitute (temp, quoted, 0);
                temp1 = tword ? tword->word : (char *)NULL;
                if (tword)
                  dispose_word_desc (tword);
              }
            FREE (temp);
            temp = temp1;
            goto dollar_add_string;
          }

        case '\\':
          if (string[sindex + 1] == '\n')
            {
              sindex += 2;
              continue;
            }

          c = string[++sindex];

          /* "However, the double-quote character ( '"' ) shall not be treated
             specially within a here-document, except when the double-quote
             appears within "$()", "``", or "${}"." */
          if ((quoted & Q_HERE_DOCUMENT) && (quoted & Q_DOLBRACE) && c == '"')
            tflag = CBSDQUOTE;          /* special case */
          else if (quoted & Q_HERE_DOCUMENT)
            tflag = CBSHDOC;
          else if (quoted & Q_DOUBLE_QUOTES)
            tflag = CBSDQUOTE;
          else
            tflag = 0;

          /* From Posix discussion on austin-group list:  Backslash escaping
             a } in ${...} is removed.  Issue 0000221 */
          if ((quoted & Q_DOLBRACE) && c == RBRACE)
            {
              SCOPY_CHAR_I (twochars, CTLESC, c, string, sindex, string_size);
            }
          /* This is the fix for " $@\ " */
          else if ((quoted & (Q_HERE_DOCUMENT|Q_DOUBLE_QUOTES)) && ((sh_syntaxtab[c] & tflag) == 0) && isexp == 0 && isifs (c))
            {
              RESIZE_MALLOCED_BUFFER (istring, istring_index, 2, istring_size,
                                      DEFAULT_ARRAY_SIZE);
              istring[istring_index++] = CTLESC;
              istring[istring_index++] = '\\';
              istring[istring_index] = '\0';

              SCOPY_CHAR_I (twochars, CTLESC, c, string, sindex, string_size);
            }
          else if ((quoted & (Q_HERE_DOCUMENT|Q_DOUBLE_QUOTES)) && c == 0)
            {
              RESIZE_MALLOCED_BUFFER (istring, istring_index, 2, istring_size,
                                      DEFAULT_ARRAY_SIZE);
              istring[istring_index++] = CTLESC;
              istring[istring_index++] = '\\';
              istring[istring_index] = '\0';
              break;          
            }
          else if ((quoted & (Q_HERE_DOCUMENT|Q_DOUBLE_QUOTES)) && ((sh_syntaxtab[c] & tflag) == 0))
            {
              SCOPY_CHAR_I (twochars, '\\', c, string, sindex, string_size);
            }
          else if (c == 0)
            {
              c = CTLNUL;
              sindex--;         /* add_character: label increments sindex */
              goto add_character;
            }
          else
            {
              SCOPY_CHAR_I (twochars, CTLESC, c, string, sindex, string_size);
            }

          sindex++;
add_twochars:
          /* BEFORE jumping here, we need to increment sindex if appropriate */
          RESIZE_MALLOCED_BUFFER (istring, istring_index, 2, istring_size,
                                  DEFAULT_ARRAY_SIZE);
          istring[istring_index++] = twochars[0];
          istring[istring_index++] = twochars[1];
          istring[istring_index] = '\0';

          break;

        case '"':
          /* XXX - revisit this */
          if ((quoted & (Q_DOUBLE_QUOTES|Q_HERE_DOCUMENT)) && ((quoted & Q_ARITH) == 0))
            goto add_character;

          t_index = ++sindex;
          temp = string_extract_double_quoted (string, &sindex, (word->flags & W_COMPLETE) ? SX_COMPLETE : 0);

          /* If the quotes surrounded the entire string, then the
             whole word was quoted. */
          quoted_state = (t_index == 1 && string[sindex] == '\0')
                            ? WHOLLY_QUOTED
                            : PARTIALLY_QUOTED;

          if (temp && *temp)
            {
              tword = alloc_word_desc ();
              tword->word = temp;

              if (word->flags & W_ASSIGNARG)
                tword->flags |= word->flags & (W_ASSIGNARG|W_ASSIGNRHS); /* affects $@ */
              if (word->flags & W_COMPLETE)
                tword->flags |= W_COMPLETE;     /* for command substitutions */
              if (word->flags & W_NOCOMSUB)
                tword->flags |= W_NOCOMSUB;
              if (word->flags & W_NOPROCSUB)
                tword->flags |= W_NOPROCSUB;

              if (word->flags & W_ASSIGNRHS)
                tword->flags |= W_ASSIGNRHS;

              temp = (char *)NULL;

              temp_has_dollar_at = 0;   /* does this quoted (sub)string include $@? */
              /* Need to get W_HASQUOTEDNULL flag through this function. */
              /* XXX - preserve Q_ARITH here? */
              list = expand_word_internal (tword, Q_DOUBLE_QUOTES|(quoted&Q_ARITH), 0, &temp_has_dollar_at, (int *)NULL);
              has_dollar_at += temp_has_dollar_at;

              if (list == &expand_word_error || list == &expand_word_fatal)
                {
                  free (istring);
                  free (string);
                  /* expand_word_internal has already freed temp_word->word
                     for us because of the way it prints error messages. */
                  tword->word = (char *)NULL;
                  dispose_word (tword);
                  return list;
                }

              dispose_word (tword);

              /* "$@" (a double-quoted dollar-at) expands into nothing,
                 not even a NULL word, when there are no positional
                 parameters.  Posix interp 888 says that other parts of the
                 word that expand to quoted nulls result in quoted nulls, so
                 we can't just throw the entire word away if we have "$@"
                 anywhere in it.  We use had_quoted_null to keep track */
              if (list == 0 && temp_has_dollar_at)      /* XXX - was has_dollar_at */
                {
                  quoted_dollar_at++;
                  break;
                }

              /* If this list comes back with a quoted null from expansion,
                 we have either "$x" or "$@" with $1 == ''. In either case,
                 we need to make sure we add a quoted null argument and
                 disable the special handling that "$@" gets. */
              if (list && list->word && list->next == 0 && (list->word->flags & W_HASQUOTEDNULL))
                {
                  if (had_quoted_null && temp_has_dollar_at)
                    quoted_dollar_at++;
                  had_quoted_null = 1;          /* XXX */
                }

              /* If we get "$@", we know we have expanded something, so we
                 need to remember it for the final split on $IFS.  This is
                 a special case; it's the only case where a quoted string
                 can expand into more than one word.  It's going to come back
                 from the above call to expand_word_internal as a list with
                 multiple words. */
              if (list)
                dequote_list (list);

              if (temp_has_dollar_at)           /* XXX - was has_dollar_at */
                {
                  quoted_dollar_at++;
                  if (contains_dollar_at)
                    *contains_dollar_at = 1;
                  if (expanded_something)
                    *expanded_something = 1;
                  local_expanded = 1;
                }
            }
          else
            {
              /* What we have is "".  This is a minor optimization. */
              FREE (temp);
              list = (WORD_LIST *)NULL;
              had_quoted_null = 1;      /* note for later */
            }

          /* The code above *might* return a list (consider the case of "$@",
             where it returns "$1", "$2", etc.).  We can't throw away the
             rest of the list, and we have to make sure each word gets added
             as quoted.  We test on tresult->next:  if it is non-NULL, we
             quote the whole list, save it to a string with string_list, and
             add that string. We don't need to quote the results of this
             (and it would be wrong, since that would quote the separators
             as well), so we go directly to add_string. */
          if (list)
            {
              if (list->next)
                {
                  /* Testing quoted_dollar_at makes sure that "$@" is
                     split correctly when $IFS does not contain a space. */
                  temp = quoted_dollar_at
                                ? string_list_dollar_at (list, Q_DOUBLE_QUOTES, 0)
                                : string_list (quote_list (list));
                  dispose_words (list);
                  goto add_string;
                }
              else
                {
                  temp = savestring (list->word->word);
                  tflag = list->word->flags;
                  dispose_words (list);

                  /* If the string is not a quoted null string, we want
                     to remove any embedded unquoted CTLNUL characters.
                     We do not want to turn quoted null strings back into
                     the empty string, though.  We do this because we
                     want to remove any quoted nulls from expansions that
                     contain other characters.  For example, if we have
                     x"$*"y or "x$*y" and there are no positional parameters,
                     the $* should expand into nothing. */
                  /* We use the W_HASQUOTEDNULL flag to differentiate the
                     cases:  a quoted null character as above and when
                     CTLNUL is contained in the (non-null) expansion
                     of some variable.  We use the had_quoted_null flag to
                     pass the value through this function to its caller. */
                  if ((tflag & W_HASQUOTEDNULL) && QUOTED_NULL (temp) == 0)
                    remove_quoted_nulls (temp); /* XXX */
                }
            }
          else
            temp = (char *)NULL;

          if (temp == 0 && quoted_state == PARTIALLY_QUOTED)
            had_quoted_null = 1;        /* note for later */

          /* We do not want to add quoted nulls to strings that are only
             partially quoted; we can throw them away.  The exception to
             this is when we are going to be performing word splitting,
             since we have to preserve a null argument if the next character
             will cause word splitting. */
          if (temp == 0 && quoted_state == PARTIALLY_QUOTED && quoted == 0 && (word->flags & (W_NOSPLIT|W_EXPANDRHS|W_ASSIGNRHS)) == W_EXPANDRHS)
            {
              c = CTLNUL;
              sindex--;
              had_quoted_null = 1;
              goto add_character;
            }
          if (temp == 0 && quoted_state == PARTIALLY_QUOTED && (word->flags & (W_NOSPLIT|W_NOSPLIT2)))
            continue;

        add_quoted_string:

          if (temp)
            {
              temp1 = temp;
              temp = quote_string (temp);
              free (temp1);
              goto add_string;
            }
          else
            {
              /* Add NULL arg. */
              c = CTLNUL;
              sindex--;         /* add_character: label increments sindex */
              had_quoted_null = 1;      /* note for later */
              goto add_character;
            }

          /* break; */

        case '\'':
          if ((quoted & (Q_DOUBLE_QUOTES|Q_HERE_DOCUMENT)))
            goto add_character;

          t_index = ++sindex;
          temp = string_extract_single_quoted (string, &sindex, 0);

          /* If the entire STRING was surrounded by single quotes,
             then the string is wholly quoted. */
          quoted_state = (t_index == 1 && string[sindex] == '\0')
                            ? WHOLLY_QUOTED
                            : PARTIALLY_QUOTED;

          /* If all we had was '', it is a null expansion. */
          if (*temp == '\0')
            {
              free (temp);
              temp = (char *)NULL;
            }
          else
            remove_quoted_escapes (temp);       /* ??? */

          if (temp == 0 && quoted_state == PARTIALLY_QUOTED)
            had_quoted_null = 1;        /* note for later */

          /* We do not want to add quoted nulls to strings that are only
             partially quoted; such nulls are discarded.  See above for the
             exception, which is when the string is going to be split.
             Posix interp 888/1129 */
          if (temp == 0 && quoted_state == PARTIALLY_QUOTED && quoted == 0 && (word->flags & (W_NOSPLIT|W_EXPANDRHS|W_ASSIGNRHS)) == W_EXPANDRHS)
            {
              c = CTLNUL;
              sindex--;
              goto add_character;
            }

          if (temp == 0 && (quoted_state == PARTIALLY_QUOTED) && (word->flags & (W_NOSPLIT|W_NOSPLIT2)))
            continue;

          /* If we have a quoted null expansion, add a quoted NULL to istring. */
          if (temp == 0)
            {
              c = CTLNUL;
              sindex--;         /* add_character: label increments sindex */
              goto add_character;
            }
          else
            goto add_quoted_string;

          /* break; */

        case ' ':
          /* If we are in a context where the word is not going to be split, but
             we need to account for $@ and $* producing one word for each
             positional parameter, add quoted spaces so the spaces in the
             expansion of "$@", if any, behave correctly. We still may need to
             split if we are expanding the rhs of a word expansion. */
          if (ifs_is_null || split_on_spaces || ((word->flags & (W_NOSPLIT|W_NOSPLIT2|W_ASSIGNRHS)) && (word->flags & W_EXPANDRHS) == 0))
            {
              if (string[sindex])
                sindex++;
              twochars[0] = CTLESC;
              twochars[1] = c;
              goto add_twochars;
            }
          /* FALLTHROUGH */
          
        default:
          /* This is the fix for " $@ " */
add_ifs_character:
          if ((quoted & (Q_HERE_DOCUMENT|Q_DOUBLE_QUOTES)) || (isexp == 0 && isifs (c) && (word->flags & (W_NOSPLIT|W_NOSPLIT2)) == 0))
            {
              if ((quoted&(Q_HERE_DOCUMENT|Q_DOUBLE_QUOTES)) == 0)
                has_quoted_ifs++;
add_quoted_character:
              if (string[sindex])       /* from old goto dollar_add_string */
                sindex++;
              if (c == 0)
                {
                  c = CTLNUL;
                  goto add_character;
                }
              else
                {
#if HANDLE_MULTIBYTE
                  /* XXX - should make sure that c is actually multibyte,
                     otherwise we can use the twochars branch */
                  if (mb_cur_max > 1)
                    sindex--;

                  if (mb_cur_max > 1)
                    {
                      SADD_MBQCHAR_BODY(temp, string, sindex, string_size);
                    }
                  else
#endif
                    {
                      twochars[0] = CTLESC;
                      twochars[1] = c;
                      goto add_twochars;
                    }
                }
            }

          SADD_MBCHAR (temp, string, sindex, string_size);

add_character:
          RESIZE_MALLOCED_BUFFER (istring, istring_index, 1, istring_size,
                                  DEFAULT_ARRAY_SIZE);
          istring[istring_index++] = c;
          istring[istring_index] = '\0';

          /* Next character. */
          sindex++;
        }
    }

finished_with_string:
  /* OK, we're ready to return.  If we have a quoted string, and
     quoted_dollar_at is not set, we do no splitting at all; otherwise
     we split on ' '.  The routines that call this will handle what to
     do if nothing has been expanded. */

  /* Partially and wholly quoted strings which expand to the empty
     string are retained as an empty arguments.  Unquoted strings
     which expand to the empty string are discarded.  The single
     exception is the case of expanding "$@" when there are no
     positional parameters.  In that case, we discard the expansion. */

  /* Because of how the code that handles "" and '' in partially
     quoted strings works, we need to make ISTRING into a QUOTED_NULL
     if we saw quoting characters, but the expansion was empty.
     "" and '' are tossed away before we get to this point when
     processing partially quoted strings.  This makes "" and $xxx""
     equivalent when xxx is unset.  We also look to see whether we
     saw a quoted null from a ${} expansion and add one back if we
     need to. */

  /* If we expand to nothing and there were no single or double quotes
     in the word, we throw it away.  Otherwise, we return a NULL word.
     The single exception is for $@ surrounded by double quotes when
     there are no positional parameters.  In that case, we also throw
     the word away. */

  if (*istring == '\0')
    {
#if 0
      if (quoted_dollar_at == 0 && (had_quoted_null || quoted_state == PARTIALLY_QUOTED))
#else
      if (had_quoted_null || (quoted_dollar_at == 0 && quoted_state == PARTIALLY_QUOTED))
#endif
        {
          istring[0] = CTLNUL;
          istring[1] = '\0';
          tword = alloc_word_desc ();
          tword->word = istring;
          istring = 0;          /* avoid later free() */
          tword->flags |= W_HASQUOTEDNULL;              /* XXX */
          list = make_word_list (tword, (WORD_LIST *)NULL);
          if (quoted & (Q_HERE_DOCUMENT|Q_DOUBLE_QUOTES))
            tword->flags |= W_QUOTED;
        }
      /* According to sh, ksh, and Posix.2, if a word expands into nothing
         and a double-quoted "$@" appears anywhere in it, then the entire
         word is removed. */
      /* XXX - exception appears to be that quoted null strings result in
         null arguments */
      else  if (quoted_state == UNQUOTED || quoted_dollar_at)
        list = (WORD_LIST *)NULL;
      else
        list = (WORD_LIST *)NULL;
    }
  else if (word->flags & W_NOSPLIT)
    {
      tword = alloc_word_desc ();
      tword->word = istring;
      if (had_quoted_null && QUOTED_NULL (istring))
        tword->flags |= W_HASQUOTEDNULL;
      istring = 0;              /* avoid later free() */
      if (word->flags & W_ASSIGNMENT)
        tword->flags |= W_ASSIGNMENT;   /* XXX */
      if (word->flags & W_COMPASSIGN)
        tword->flags |= W_COMPASSIGN;   /* XXX */
      if (word->flags & W_NOGLOB)
        tword->flags |= W_NOGLOB;       /* XXX */
      if (word->flags & W_NOBRACE)
        tword->flags |= W_NOBRACE;      /* XXX */
      if (word->flags & W_ARRAYREF)
        tword->flags |= W_ARRAYREF;
      if (quoted & (Q_HERE_DOCUMENT|Q_DOUBLE_QUOTES))
        tword->flags |= W_QUOTED;
      list = make_word_list (tword, (WORD_LIST *)NULL);
    }
  else if (word->flags & W_ASSIGNRHS)
    {
      list = list_string (istring, "", quoted);
      tword = list->word;
      if (had_quoted_null && QUOTED_NULL (istring))
        tword->flags |= W_HASQUOTEDNULL;
      free (list);
      free (istring);
      istring = 0;                      /* avoid later free() */
      goto set_word_flags;
    }
  else
    {
      char *ifs_chars;

      ifs_chars = (quoted_dollar_at || has_dollar_at) ? ifs_value : (char *)NULL;

      /* If we have $@, we need to split the results no matter what.  If
         IFS is unset or NULL, string_list_dollar_at has separated the
         positional parameters with a space, so we split on space (we have
         set ifs_chars to " \t\n" above if ifs is unset).  If IFS is set,
         string_list_dollar_at has separated the positional parameters
         with the first character of $IFS, so we split on $IFS.  If
         SPLIT_ON_SPACES is set, we expanded $* (unquoted) with IFS either
         unset or null, and we want to make sure that we split on spaces
         regardless of what else has happened to IFS since the expansion,
         or we expanded "$@" with IFS null and we need to split the positional
         parameters into separate words. */
      if (split_on_spaces)
        {
          /* If IFS is not set, and the word is not quoted, we want to split
             the individual words on $' \t\n'. We rely on previous steps to
             quote the portions of the word that should not be split */
          if (ifs_is_set == 0)
            list = list_string (istring, " \t\n", 1);   /* XXX quoted == 1? */
          else
            list = list_string (istring, " ", 1);       /* XXX quoted == 1? */
        }

      /* If we have $@ (has_dollar_at != 0) and we are in a context where we
         don't want to split the result (W_NOSPLIT2), and we are not quoted,
         we have already separated the arguments with the first character of
         $IFS.  In this case, we want to return a list with a single word
         with the separator possibly replaced with a space (it's what other
         shells seem to do).
         quoted_dollar_at is internal to this function and is set if we are
         passed an argument that is unquoted (quoted == 0) but we encounter a
         double-quoted $@ while expanding it. */
      else if (has_dollar_at && quoted_dollar_at == 0 && ifs_chars && quoted == 0 && (word->flags & W_NOSPLIT2))
        {
          tword = alloc_word_desc ();
          /* Only split and rejoin if we have to */
          if (*ifs_chars && *ifs_chars != ' ')
            {
              /* list_string dequotes CTLESCs in the string it's passed, so we
                 need it to get the space separation right if space isn't the
                 first character in IFS (but is present) and to remove the 
                 quoting we added back in param_expand(). */
              list = list_string (istring, *ifs_chars ? ifs_chars : " ", 1);
              /* This isn't exactly right in the case where we're expanding
                 the RHS of an expansion like ${var-$@} where IFS=: (for
                 example). The W_NOSPLIT2 means we do the separation with :;
                 the list_string removes the quotes and breaks the string into
                 a list, and the string_list rejoins it on spaces. When we
                 return, we expect to be able to split the results, but the
                 space separation means the right split doesn't happen. */
              tword->word = string_list (list); 
            }
          else
            tword->word = istring;
          if (had_quoted_null && QUOTED_NULL (istring))
            tword->flags |= W_HASQUOTEDNULL;    /* XXX */
          if (tword->word != istring)
            free (istring);
          istring = 0;                  /* avoid later free() */
          goto set_word_flags;
        }
      else if (has_dollar_at && ifs_chars)
        list = list_string (istring, *ifs_chars ? ifs_chars : " ", 1);
      else
        {
          tword = alloc_word_desc ();
          if (expanded_something && *expanded_something == 0 && has_quoted_ifs)
            tword->word = remove_quoted_ifs (istring);
          else
            tword->word = istring;
          if (had_quoted_null && QUOTED_NULL (istring)) /* should check for more than one */
            tword->flags |= W_HASQUOTEDNULL;    /* XXX */
          else if (had_quoted_null)
            tword->flags |= W_SAWQUOTEDNULL;    /* XXX */
          if (tword->word != istring)
            free (istring);
          istring = 0;                  /* avoid later free() */
set_word_flags:
          if ((quoted & (Q_DOUBLE_QUOTES|Q_HERE_DOCUMENT)) || (quoted_state == WHOLLY_QUOTED))
            tword->flags |= W_QUOTED;
          if (word->flags & W_ASSIGNMENT)
            tword->flags |= W_ASSIGNMENT;
          if (word->flags & W_COMPASSIGN)
            tword->flags |= W_COMPASSIGN;
          if (word->flags & W_NOGLOB)
            tword->flags |= W_NOGLOB;
          if (word->flags & W_NOBRACE)
            tword->flags |= W_NOBRACE;
          if (word->flags & W_ARRAYREF)
            tword->flags |= W_ARRAYREF;
          list = make_word_list (tword, (WORD_LIST *)NULL);
        }
    }

  free (istring);
  return (list);
}

/* **************************************************************** */
/*                                                                  */
/*                 Functions for Quote Removal                      */
/*                                                                  */
/* **************************************************************** */

/* Perform quote removal on STRING.  If QUOTED > 0, assume we are obeying the
   backslash quoting rules for within double quotes or a here document. */
char *
string_quote_removal (string, quoted)
     char *string;
     int quoted;
{
  size_t slen;
  char *r, *result_string, *temp, *send;
  int sindex, tindex, dquote;
  unsigned char c;
  DECLARE_MBSTATE;

  /* The result can be no longer than the original string. */
  slen = strlen (string);
  send = string + slen;

  r = result_string = (char *)xmalloc (slen + 1);

  for (dquote = sindex = 0; c = string[sindex];)
    {
      switch (c)
        {
        case '\\':
          c = string[++sindex];
          if (c == 0)
            {
              *r++ = '\\';
              break;
            }
          if (((quoted & (Q_HERE_DOCUMENT|Q_DOUBLE_QUOTES)) || dquote) && (sh_syntaxtab[c] & CBSDQUOTE) == 0)
            *r++ = '\\';
          /* FALLTHROUGH */

        default:
          SCOPY_CHAR_M (r, string, send, sindex);
          break;

        case '\'':
          if ((quoted & (Q_HERE_DOCUMENT|Q_DOUBLE_QUOTES)) || dquote)
            {
              *r++ = c;
              sindex++;
              break;
            }
          tindex = sindex + 1;
          temp = string_extract_single_quoted (string, &tindex, 0);
          if (temp)
            {
              strcpy (r, temp);
              r += strlen (r);
              free (temp);
            }
          sindex = tindex;
          break;

        case '"':
          dquote = 1 - dquote;
          sindex++;
          break;
        }
    }
    *r = '\0';
    return (result_string);
}

#if 0
/* UNUSED */
/* Perform quote removal on word WORD.  This allocates and returns a new
   WORD_DESC *. */
WORD_DESC *
word_quote_removal (word, quoted)
     WORD_DESC *word;
     int quoted;
{
  WORD_DESC *w;
  char *t;

  t = string_quote_removal (word->word, quoted);
  w = alloc_word_desc ();
  w->word = t ? t : savestring ("");
  return (w);
}

/* Perform quote removal on all words in LIST.  If QUOTED is non-zero,
   the members of the list are treated as if they are surrounded by
   double quotes.  Return a new list, or NULL if LIST is NULL. */
WORD_LIST *
word_list_quote_removal (list, quoted)
     WORD_LIST *list;
     int quoted;
{
  WORD_LIST *result, *t, *tresult, *e;

  for (t = list, result = (WORD_LIST *)NULL; t; t = t->next)
    {
      tresult = make_word_list (word_quote_removal (t->word, quoted), (WORD_LIST *)NULL);
#if 0
      result = (WORD_LIST *) list_append (result, tresult);
#else
      if (result == 0)
        result = e = tresult;
      else
        {
          e->next = tresult;
          while (e->next)
            e = e->next;
        }
#endif
    }
  return (result);
}
#endif

/*******************************************
 *                                         *
 *    Functions to perform word splitting  *
 *                                         *
 *******************************************/

void
setifs (v)
     SHELL_VAR *v;
{
  char *t;
  unsigned char uc;

  ifs_var = v;
  ifs_value = (v && value_cell (v)) ? value_cell (v) : " \t\n";

  ifs_is_set = ifs_var != 0;
  ifs_is_null = ifs_is_set && (*ifs_value == 0);

  /* Should really merge ifs_cmap with sh_syntaxtab.  XXX - doesn't yet
     handle multibyte chars in IFS */
  memset (ifs_cmap, '\0', sizeof (ifs_cmap));
  for (t = ifs_value ; t && *t; t++)
    {
      uc = *t;
      ifs_cmap[uc] = 1;
    }

#if defined (HANDLE_MULTIBYTE)
  if (ifs_value == 0)
    {
      ifs_firstc[0] = '\0';     /* XXX - ? */
      ifs_firstc_len = 1;
    }
  else
    {
      if (locale_utf8locale && UTF8_SINGLEBYTE (*ifs_value))
        ifs_firstc_len = (*ifs_value != 0) ? 1 : 0;
      else
        {
          size_t ifs_len;
          ifs_len = strnlen (ifs_value, MB_CUR_MAX);
          ifs_firstc_len = MBLEN (ifs_value, ifs_len);
        }
      if (ifs_firstc_len == 1 || ifs_firstc_len == 0 || MB_INVALIDCH (ifs_firstc_len))
        {
          ifs_firstc[0] = ifs_value[0];
          ifs_firstc[1] = '\0';
          ifs_firstc_len = 1;
        }
      else
        memcpy (ifs_firstc, ifs_value, ifs_firstc_len);
    }
#else
  ifs_firstc = ifs_value ? *ifs_value : 0;
#endif
}

char *
getifs ()
{
  return ifs_value;
}

/* This splits a single word into a WORD LIST on $IFS, but only if the word
   is not quoted.  list_string () performs quote removal for us, even if we
   don't do any splitting. */
WORD_LIST *
word_split (w, ifs_chars)
     WORD_DESC *w;
     char *ifs_chars;
{
  WORD_LIST *result;

  if (w)
    {
      char *xifs;

      xifs = ((w->flags & W_QUOTED) || ifs_chars == 0) ? "" : ifs_chars;
      result = list_string (w->word, xifs, w->flags & W_QUOTED);
    }
  else
    result = (WORD_LIST *)NULL;

  return (result);
}

/* Perform word splitting on LIST and return the RESULT.  It is possible
   to return (WORD_LIST *)NULL. */
static WORD_LIST *
word_list_split (list)
     WORD_LIST *list;
{
  WORD_LIST *result, *t, *tresult, *e;
  WORD_DESC *w;

  for (t = list, result = (WORD_LIST *)NULL; t; t = t->next)
    {
      tresult = word_split (t->word, ifs_value);
      /* POSIX 2.6: "If the complete expansion appropriate for a word results
         in an empty field, that empty field shall be deleted from the list
         of fields that form the completely expanded command, unless the
         original word contained single-quote or double-quote characters."
         This is where we handle these words that contain quoted null strings
         and other characters that expand to nothing after word splitting. */
      if (tresult == 0 && t->word && (t->word->flags & W_SAWQUOTEDNULL))        /* XXX */
        {
          w = alloc_word_desc ();
          w->word = (char *)xmalloc (1);
          w->word[0] = '\0';
          tresult = make_word_list (w, (WORD_LIST *)NULL);
        }
#if defined (ARRAY_VARS)
      /* pass W_ARRAYREF through for words that are not split and are
         identical to the original word. */
      if (tresult && tresult->next == 0 && t->next == 0 && (t->word->flags & W_ARRAYREF) && STREQ (t->word->word, tresult->word->word))
        tresult->word->flags |= W_ARRAYREF;
#endif
      if (result == 0)
        result = e = tresult;
      else
        {
          e->next = tresult;
          while (e->next)
            e = e->next;
        }
    }
  return (result);
}

/**************************************************
 *                                                *
 *    Functions to expand an entire WORD_LIST     *
 *                                                *
 **************************************************/

/* Do any word-expansion-specific cleanup and jump to top_level */
static void
exp_jump_to_top_level (v)
     int v;
{
  set_pipestatus_from_exit (last_command_exit_value);

  /* Cleanup code goes here. */
  expand_no_split_dollar_star = 0;      /* XXX */
  if (expanding_redir)
    undo_partial_redirects ();
  expanding_redir = 0;
  assigning_in_environment = 0;

  if (parse_and_execute_level == 0)
    top_level_cleanup ();                       /* from sig.c */

  jump_to_top_level (v);
}

/* Put NLIST (which is a WORD_LIST * of only one element) at the front of
   ELIST, and set ELIST to the new list. */
#define PREPEND_LIST(nlist, elist) \
        do { nlist->next = elist; elist = nlist; } while (0)

/* Separate out any initial variable assignments from TLIST.  If set -k has
   been executed, remove all assignment statements from TLIST.  Initial
   variable assignments and other environment assignments are placed
   on SUBST_ASSIGN_VARLIST. */
static WORD_LIST *
separate_out_assignments (tlist)
     WORD_LIST *tlist;
{
  register WORD_LIST *vp, *lp;

  if (tlist == 0)
    return ((WORD_LIST *)NULL);

  if (subst_assign_varlist)
    dispose_words (subst_assign_varlist);       /* Clean up after previous error */

  subst_assign_varlist = (WORD_LIST *)NULL;
  vp = lp = tlist;

  /* Separate out variable assignments at the start of the command.
     Loop invariant: vp->next == lp
     Loop postcondition:
        lp = list of words left after assignment statements skipped
        tlist = original list of words
  */
  while (lp && (lp->word->flags & W_ASSIGNMENT))
    {
      vp = lp;
      lp = lp->next;
    }

  /* If lp != tlist, we have some initial assignment statements.
     We make SUBST_ASSIGN_VARLIST point to the list of assignment
     words and TLIST point to the remaining words.  */
  if (lp != tlist)
    {
      subst_assign_varlist = tlist;
      /* ASSERT(vp->next == lp); */
      vp->next = (WORD_LIST *)NULL;     /* terminate variable list */
      tlist = lp;                       /* remainder of word list */
    }

  /* vp == end of variable list */
  /* tlist == remainder of original word list without variable assignments */
  if (!tlist)
    /* All the words in tlist were assignment statements */
    return ((WORD_LIST *)NULL);

  /* ASSERT(tlist != NULL); */
  /* ASSERT((tlist->word->flags & W_ASSIGNMENT) == 0); */

  /* If the -k option is in effect, we need to go through the remaining
     words, separate out the assignment words, and place them on
     SUBST_ASSIGN_VARLIST. */
  if (place_keywords_in_env)
    {
      WORD_LIST *tp;    /* tp == running pointer into tlist */

      tp = tlist;
      lp = tlist->next;

      /* Loop Invariant: tp->next == lp */
      /* Loop postcondition: tlist == word list without assignment statements */
      while (lp)
        {
          if (lp->word->flags & W_ASSIGNMENT)
            {
              /* Found an assignment statement, add this word to end of
                 subst_assign_varlist (vp). */
              if (!subst_assign_varlist)
                subst_assign_varlist = vp = lp;
              else
                {
                  vp->next = lp;
                  vp = lp;
                }

              /* Remove the word pointed to by LP from TLIST. */
              tp->next = lp->next;
              /* ASSERT(vp == lp); */
              lp->next = (WORD_LIST *)NULL;
              lp = tp->next;
            }
          else
            {
              tp = lp;
              lp = lp->next;
            }
        }
    }
  return (tlist);
}

#define WEXP_VARASSIGN  0x001
#define WEXP_BRACEEXP   0x002
#define WEXP_TILDEEXP   0x004
#define WEXP_PARAMEXP   0x008
#define WEXP_PATHEXP    0x010

/* All of the expansions, including variable assignments at the start of
   the list. */
#define WEXP_ALL        (WEXP_VARASSIGN|WEXP_BRACEEXP|WEXP_TILDEEXP|WEXP_PARAMEXP|WEXP_PATHEXP)

/* All of the expansions except variable assignments at the start of
   the list. */
#define WEXP_NOVARS     (WEXP_BRACEEXP|WEXP_TILDEEXP|WEXP_PARAMEXP|WEXP_PATHEXP)

/* All of the `shell expansions': brace expansion, tilde expansion, parameter
   expansion, command substitution, arithmetic expansion, word splitting, and
   quote removal. */
#define WEXP_SHELLEXP   (WEXP_BRACEEXP|WEXP_TILDEEXP|WEXP_PARAMEXP)

/* Take the list of words in LIST and do the various substitutions.  Return
   a new list of words which is the expanded list, and without things like
   variable assignments. */

WORD_LIST *
expand_words (list)
     WORD_LIST *list;
{
  return (expand_word_list_internal (list, WEXP_ALL));
}

/* Same as expand_words (), but doesn't hack variable or environment
   variables. */
WORD_LIST *
expand_words_no_vars (list)
     WORD_LIST *list;
{
  return (expand_word_list_internal (list, WEXP_NOVARS));
}

WORD_LIST *
expand_words_shellexp (list)
     WORD_LIST *list;
{
  return (expand_word_list_internal (list, WEXP_SHELLEXP));
}

static WORD_LIST *
glob_expand_word_list (tlist, eflags)
     WORD_LIST *tlist;
     int eflags;
{
  char **glob_array, *temp_string;
  register int glob_index;
  WORD_LIST *glob_list, *output_list, *disposables, *next;
  WORD_DESC *tword;
  int x;

  output_list = disposables = (WORD_LIST *)NULL;
  glob_array = (char **)NULL;
  while (tlist)
    {
      /* For each word, either globbing is attempted or the word is
         added to orig_list.  If globbing succeeds, the results are
         added to orig_list and the word (tlist) is added to the list
         of disposable words.  If globbing fails and failed glob
         expansions are left unchanged (the shell default), the
         original word is added to orig_list.  If globbing fails and
         failed glob expansions are removed, the original word is
         added to the list of disposable words.  orig_list ends up
         in reverse order and requires a call to REVERSE_LIST to
         be set right.  After all words are examined, the disposable
         words are freed. */
      next = tlist->next;

      /* If the word isn't an assignment and contains an unquoted
         pattern matching character, then glob it. */
      if ((tlist->word->flags & W_NOGLOB) == 0 &&
          unquoted_glob_pattern_p (tlist->word->word))
        {
          glob_array = shell_glob_filename (tlist->word->word, QGLOB_CTLESC);   /* XXX */

          /* Handle error cases.
             I don't think we should report errors like "No such file
             or directory".  However, I would like to report errors
             like "Read failed". */

          if (glob_array == 0 || GLOB_FAILED (glob_array))
            {
              glob_array = (char **)xmalloc (sizeof (char *));
              glob_array[0] = (char *)NULL;
            }

          /* Dequote the current word in case we have to use it. */
          if (glob_array[0] == NULL)
            {
              temp_string = dequote_string (tlist->word->word);
              free (tlist->word->word);
              tlist->word->word = temp_string;
            }

          /* Make the array into a word list. */
          glob_list = (WORD_LIST *)NULL;
          for (glob_index = 0; glob_array[glob_index]; glob_index++)
            {
              tword = make_bare_word (glob_array[glob_index]);
              glob_list = make_word_list (tword, glob_list);
            }

          if (glob_list)
            {
              output_list = (WORD_LIST *)list_append (glob_list, output_list);
              PREPEND_LIST (tlist, disposables);
            }
          else if (fail_glob_expansion != 0)
            {
              last_command_exit_value = EXECUTION_FAILURE;
              report_error (_("no match: %s"), tlist->word->word);
              exp_jump_to_top_level (DISCARD);
            }
          else if (allow_null_glob_expansion == 0)
            {
              /* Failed glob expressions are left unchanged. */
              PREPEND_LIST (tlist, output_list);
            }
          else
            {
              /* Failed glob expressions are removed. */
              PREPEND_LIST (tlist, disposables);
            }
        }
      else
        {
          /* Dequote the string. */
          temp_string = dequote_string (tlist->word->word);
          free (tlist->word->word);
          tlist->word->word = temp_string;
          PREPEND_LIST (tlist, output_list);
        }

      strvec_dispose (glob_array);
      glob_array = (char **)NULL;

      tlist = next;
    }

  if (disposables)
    dispose_words (disposables);

  if (output_list)
    output_list = REVERSE_LIST (output_list, WORD_LIST *);

  return (output_list);
}

#if defined (BRACE_EXPANSION)
static WORD_LIST *
brace_expand_word_list (tlist, eflags)
     WORD_LIST *tlist;
     int eflags;
{
  register char **expansions;
  char *temp_string;
  WORD_LIST *disposables, *output_list, *next;
  WORD_DESC *w;
  int eindex;

  for (disposables = output_list = (WORD_LIST *)NULL; tlist; tlist = next)
    {
      next = tlist->next;

      if (tlist->word->flags & W_NOBRACE)
        {
/*itrace("brace_expand_word_list: %s: W_NOBRACE", tlist->word->word);*/
          PREPEND_LIST (tlist, output_list);
          continue;
        }

      if ((tlist->word->flags & (W_COMPASSIGN|W_ASSIGNARG)) == (W_COMPASSIGN|W_ASSIGNARG))
        {
/*itrace("brace_expand_word_list: %s: W_COMPASSIGN|W_ASSIGNARG", tlist->word->word);*/
          PREPEND_LIST (tlist, output_list);
          continue;
        }

      /* Only do brace expansion if the word has a brace character.  If
         not, just add the word list element to BRACES and continue.  In
         the common case, at least when running shell scripts, this will
         degenerate to a bunch of calls to `mbschr', and then what is
         basically a reversal of TLIST into BRACES, which is corrected
         by a call to REVERSE_LIST () on BRACES when the end of TLIST
         is reached. */
      if (mbschr (tlist->word->word, LBRACE))
        {
          expansions = brace_expand (tlist->word->word);

          for (eindex = 0; temp_string = expansions[eindex]; eindex++)
            {
              w = alloc_word_desc ();
              w->word = temp_string;

              /* If brace expansion didn't change the word, preserve
                 the flags.  We may want to preserve the flags
                 unconditionally someday -- XXX */
              if (STREQ (temp_string, tlist->word->word))
                w->flags = tlist->word->flags;
              else
                w = make_word_flags (w, temp_string);

              output_list = make_word_list (w, output_list);
            }
          free (expansions);

          /* Add TLIST to the list of words to be freed after brace
             expansion has been performed. */
          PREPEND_LIST (tlist, disposables);
        }
      else
        PREPEND_LIST (tlist, output_list);
    }

  if (disposables)
    dispose_words (disposables);

  if (output_list)
    output_list = REVERSE_LIST (output_list, WORD_LIST *);

  return (output_list);
}
#endif

#if defined (ARRAY_VARS)
/* Take WORD, a compound array assignment, and internally run (for example),
   'declare -A w', where W is the variable name portion of WORD. OPTION is
   the list of options to supply to `declare'. CMD is the declaration command
   we are expanding right now; it's unused currently. */
static int
make_internal_declare (word, option, cmd)
     char *word;
     char *option;
     char *cmd;
{
  int t, r;
  WORD_LIST *wl;
  WORD_DESC *w;

  w = make_word (word);

  t = assignment (w->word, 0);
  if (w->word[t] == '=')
    {
      w->word[t] = '\0';
      if (w->word[t - 1] == '+')        /* cut off any append op */
        w->word[t - 1] = '\0';
    }

  wl = make_word_list (w, (WORD_LIST *)NULL);
  wl = make_word_list (make_word (option), wl);

  r = declare_builtin (wl);

  dispose_words (wl);
  return r;
}  

/* Expand VALUE in NAME[+]=( VALUE ) to a list of words. FLAGS is 1 if NAME
   is an associative array.

   If we are  processing an indexed array, expand_compound_array_assignment
   will expand all the individual words and quote_compound_array_list will
   single-quote them. If we are processing an associative array, we use
   parse_string_to_word_list to split VALUE into a list of words instead of
   faking up a shell variable and calling expand_compound_array_assignment.
   expand_and_quote_assoc_word expands and single-quotes each word in VALUE
   together so we don't have problems finding the end of the subscript when
   quoting it.

   Words in VALUE can be individual words, which are expanded and single-quoted,
   or words of the form [IND]=VALUE, which end up as explained below, as
   ['expanded-ind']='expanded-value'. */

static WORD_LIST *
expand_oneword (value, flags)
     char *value;
     int flags;
{
  WORD_LIST *l, *nl;
  char *t;
  int kvpair;
  
  if (flags == 0)
    {
      /* Indexed array */
      l = expand_compound_array_assignment ((SHELL_VAR *)NULL, value, flags);
      /* Now we quote the results of the expansion above to prevent double
         expansion. */
      quote_compound_array_list (l, flags);
      return l;
    }
  else
    {
      /* Associative array */
      l = parse_string_to_word_list (value, 1, "array assign");
#if ASSOC_KVPAIR_ASSIGNMENT
      kvpair = kvpair_assignment_p (l);
#endif

      /* For associative arrays, with their arbitrary subscripts, we have to
         expand and quote in one step so we don't have to search for the
         closing right bracket more than once. */
      for (nl = l; nl; nl = nl->next)
        {
#if ASSOC_KVPAIR_ASSIGNMENT
          if (kvpair)
            /* keys and values undergo the same set of expansions */
            t = expand_and_quote_kvpair_word (nl->word->word);
          else
#endif
          if ((nl->word->flags & W_ASSIGNMENT) == 0)
            t = sh_single_quote (nl->word->word ? nl->word->word : "");
          else
            t = expand_and_quote_assoc_word (nl->word->word, flags);
          free (nl->word->word);
          nl->word->word = t;
        }
      return l;
    }
}

/* Expand a single compound assignment argument to a declaration builtin.
   This word takes the form NAME[+]=( VALUE ). The NAME[+]= is passed through
   unchanged. The VALUE is expanded and each word in the result is single-
   quoted. Words of the form [key]=value end up as
   ['expanded-key']='expanded-value'. Associative arrays have special
   handling, see expand_oneword() above. The return value is
   NAME[+]=( expanded-and-quoted-VALUE ). */
static void
expand_compound_assignment_word (tlist, flags)
     WORD_LIST *tlist;
     int flags;
{
  WORD_LIST *l;
  int wlen, oind, t;
  char *value, *temp;

/*itrace("expand_compound_assignment_word: original word = -%s-", tlist->word->word);*/
  t = assignment (tlist->word->word, 0);

  /* value doesn't have the open and close parens */
  oind = 1;
  value = extract_array_assignment_list (tlist->word->word + t + 1, &oind);
  /* This performs one round of expansion on the index/key and value and
     single-quotes each word in the result. */
  l = expand_oneword (value, flags);
  free (value);

  value = string_list (l);
  dispose_words (l);

  wlen = STRLEN (value);

  /* Now, let's rebuild the string */
  temp = xmalloc (t + 3 + wlen + 1);    /* name[+]=(value) */
  memcpy (temp, tlist->word->word, ++t);
  temp[t++] = '(';
  if (value)
    memcpy (temp + t, value, wlen);
  t += wlen;
  temp[t++] = ')';
  temp[t] = '\0';
/*itrace("expand_compound_assignment_word: reconstructed word = -%s-", temp);*/

  free (tlist->word->word);
  tlist->word->word = temp;

  free (value);
}

/* Expand and process an argument to a declaration command. We have already
   set flags in TLIST->word->flags depending on the declaration command
   (declare, local, etc.) and the options supplied to it (-a, -A, etc.).
   TLIST->word->word is of the form NAME[+]=( VALUE ).   

   This does several things, all using pieces of other functions to get the
   evaluation sequence right. It's called for compound array assignments with
   the W_ASSIGNMENT flag set (basically, valid identifier names on the lhs).
   It parses out which flags need to be set for declare to create the variable
   correctly, then calls declare internally (make_internal_declare) to make
   sure the variable exists with the correct attributes. Before the variable
   is created, it calls expand_compound_assignment_word to expand VALUE to a
   list of words, appropriately quoted for further evaluation. This preserves
   the semantics of word-expansion-before-calling-builtins. Finally, it calls
   do_word_assignment to perform the expansion and assignment with the same
   expansion semantics as a standalone assignment statement (no word splitting,
   etc.) even though the word is single-quoted so all that needs to happen is
   quote removal. */
static WORD_LIST *
expand_declaration_argument (tlist, wcmd)
     WORD_LIST *tlist, *wcmd;
{
  char opts[16], omap[128];
  int t, opti, oind, skip, inheriting;
  WORD_LIST *l;

  inheriting = localvar_inherit;
  opti = 0;
  if (tlist->word->flags & (W_ASSIGNASSOC|W_ASSNGLOBAL|W_CHKLOCAL|W_ASSIGNARRAY))
    opts[opti++] = '-';

  if ((tlist->word->flags & (W_ASSIGNASSOC|W_ASSNGLOBAL)) == (W_ASSIGNASSOC|W_ASSNGLOBAL))
    {
      opts[opti++] = 'g';
      opts[opti++] = 'A';
    }
  else if (tlist->word->flags & W_ASSIGNASSOC)
    {
      opts[opti++] = 'A';
    }
  else if ((tlist->word->flags & (W_ASSIGNARRAY|W_ASSNGLOBAL)) == (W_ASSIGNARRAY|W_ASSNGLOBAL))
    {
      opts[opti++] = 'g';
      opts[opti++] = 'a';
    }
  else if (tlist->word->flags & W_ASSIGNARRAY)
    {
      opts[opti++] = 'a';
    }
  else if (tlist->word->flags & W_ASSNGLOBAL)
    opts[opti++] = 'g';

  if (tlist->word->flags & W_CHKLOCAL)
    opts[opti++] = 'G';

  /* If we have special handling note the integer attribute and others
     that transform the value upon assignment.  What we do is take all
     of the option arguments and scan through them looking for options
     that cause such transformations, and add them to the `opts' array. */

  memset (omap, '\0', sizeof (omap));
  for (l = wcmd->next; l != tlist; l = l->next)
    {
      int optchar;

      if (l->word->word[0] != '-' && l->word->word[0] != '+')
        break;  /* non-option argument */
      if (l->word->word[0] == '-' && l->word->word[1] == '-' && l->word->word[2] == 0)
        break;  /* -- signals end of options */
      optchar = l->word->word[0];
      for (oind = 1; l->word->word[oind]; oind++)
        switch (l->word->word[oind])
          {
            case 'I':
              inheriting = 1;
            case 'i':
            case 'l':
            case 'u':
            case 'c':
              omap[l->word->word[oind]] = 1;
              if (opti == 0)
                opts[opti++] = optchar;
              break;
            default:
              break;
          }
    }

  for (oind = 0; oind < sizeof (omap); oind++)
    if (omap[oind])
      opts[opti++] = oind;

  /* If there are no -a/-A options, but we have a compound assignment,
     we have a choice: we can set opts[0]='-', opts[1]='a', since the
     default is to create an indexed array, and call
     make_internal_declare with that, or we can just skip the -a and let
     declare_builtin deal with it.  Once we're here, we're better set
     up for the latter, since we don't want to deal with looking up
     any existing variable here -- better to let declare_builtin do it.
     We need the variable created, though, especially if it's local, so
     we get the scoping right before we call do_word_assignment.
     To ensure that make_local_declare gets called, we add `--' if there
     aren't any options. */
  if ((tlist->word->flags & (W_ASSIGNASSOC|W_ASSIGNARRAY)) == 0)
    {
      if (opti == 0)
        {
          opts[opti++] = '-';
          opts[opti++] = '-';
        }
    }
  opts[opti] = '\0';

  /* This isn't perfect, but it's a start. Improvements later. We expand
     tlist->word->word and single-quote the results to avoid multiple
     expansions by, say, do_assignment_internal(). We have to weigh the
     cost of reconstructing the compound assignment string with its single
     quoting and letting the declare builtin handle it. The single quotes
     will prevent any unwanted additional expansion or word splitting. */
  expand_compound_assignment_word (tlist, (tlist->word->flags & W_ASSIGNASSOC) ? 1 : 0);

  skip = 0;
  if (opti > 0)
    {
      t = make_internal_declare (tlist->word->word, opts, wcmd ? wcmd->word->word : (char *)0);
      if (t != EXECUTION_SUCCESS)
        {
          last_command_exit_value = t;
          if (tlist->word->flags & W_FORCELOCAL)        /* non-fatal error */
            skip = 1;
          else
            exp_jump_to_top_level (DISCARD);
        }
    }

  if (skip == 0)
    {
      t = do_word_assignment (tlist->word, 0);
      if (t == 0)
        {
          last_command_exit_value = EXECUTION_FAILURE;
          exp_jump_to_top_level (DISCARD);
        }
    }

  /* Now transform the word as ksh93 appears to do and go on */
  t = assignment (tlist->word->word, 0);
  tlist->word->word[t] = '\0';
  if (tlist->word->word[t - 1] == '+')
    tlist->word->word[t - 1] = '\0';    /* cut off append op */
  tlist->word->flags &= ~(W_ASSIGNMENT|W_NOSPLIT|W_COMPASSIGN|W_ASSIGNARG|W_ASSIGNASSOC|W_ASSIGNARRAY);

  return (tlist);
}
#endif /* ARRAY_VARS */

static WORD_LIST *
shell_expand_word_list (tlist, eflags)
     WORD_LIST *tlist;
     int eflags;
{
  WORD_LIST *expanded, *orig_list, *new_list, *next, *temp_list, *wcmd;
  int expanded_something, has_dollar_at;

  /* We do tilde expansion all the time.  This is what 1003.2 says. */
  wcmd = new_list = (WORD_LIST *)NULL;

  for (orig_list = tlist; tlist; tlist = next)
    {
      if (wcmd == 0 && (tlist->word->flags & W_ASSNBLTIN))
        wcmd = tlist;
        
      next = tlist->next;

#if defined (ARRAY_VARS)
      /* If this is a compound array assignment to a builtin that accepts
         such assignments (e.g., `declare'), take the assignment and perform
         it separately, handling the semantics of declarations inside shell
         functions.  This avoids the double-evaluation of such arguments,
         because `declare' does some evaluation of compound assignments on
         its own. */
      if ((tlist->word->flags & (W_COMPASSIGN|W_ASSIGNARG)) == (W_COMPASSIGN|W_ASSIGNARG))
        expand_declaration_argument (tlist, wcmd);
#endif

      expanded_something = 0;
      expanded = expand_word_internal
        (tlist->word, 0, 0, &has_dollar_at, &expanded_something);

      if (expanded == &expand_word_error || expanded == &expand_word_fatal)
        {
          /* By convention, each time this error is returned,
             tlist->word->word has already been freed. */
          tlist->word->word = (char *)NULL;

          /* Dispose our copy of the original list. */
          dispose_words (orig_list);
          /* Dispose the new list we're building. */
          dispose_words (new_list);

          last_command_exit_value = EXECUTION_FAILURE;
          if (expanded == &expand_word_error)
            exp_jump_to_top_level (DISCARD);
          else
            exp_jump_to_top_level (FORCE_EOF);
        }

      /* Don't split words marked W_NOSPLIT. */
      if (expanded_something && (tlist->word->flags & W_NOSPLIT) == 0)
        {
          temp_list = word_list_split (expanded);
          dispose_words (expanded);
        }
      else
        {
          /* If no parameter expansion, command substitution, process
             substitution, or arithmetic substitution took place, then
             do not do word splitting.  We still have to remove quoted
             null characters from the result. */
          word_list_remove_quoted_nulls (expanded);
          temp_list = expanded;
        }

      expanded = REVERSE_LIST (temp_list, WORD_LIST *);
      new_list = (WORD_LIST *)list_append (expanded, new_list);
    }

  if (orig_list)  
    dispose_words (orig_list);

  if (new_list)
    new_list = REVERSE_LIST (new_list, WORD_LIST *);

  return (new_list);
}

/* Perform assignment statements optionally preceding a command name COMMAND.
   If COMMAND == NULL, is_nullcmd usually == 1. Follow the POSIX rules for
   variable assignment errors. */
static int
do_assignment_statements (varlist, command, is_nullcmd)
     WORD_LIST *varlist;
     char *command;
     int is_nullcmd;
{
  WORD_LIST *temp_list;
  char *savecmd;
  sh_wassign_func_t *assign_func;
  int is_special_builtin, is_builtin_or_func, tint;

  /* If the remainder of the words expand to nothing, Posix.2 requires
     that the variable and environment assignments affect the shell's
     environment (do_word_assignment). */
  assign_func = is_nullcmd ? do_word_assignment : assign_in_env;
  tempenv_assign_error = 0;

  is_builtin_or_func = command && (find_shell_builtin (command) || find_function (command));
  /* Posix says that special builtins exit if a variable assignment error
     occurs in an assignment preceding it. (XXX - this is old -- current Posix
     says that any variable assignment error causes a non-interactive shell
     to exit. See the STRICT_POSIX checks below. */
  is_special_builtin = posixly_correct && command && find_special_builtin (command);

  savecmd = this_command_name;
  for (temp_list = varlist; temp_list; temp_list = temp_list->next)
    {
      this_command_name = (char *)NULL;
      assigning_in_environment = is_nullcmd == 0;
      tint = (*assign_func) (temp_list->word, is_builtin_or_func);
      assigning_in_environment = 0;
      this_command_name = savecmd;

      /* Variable assignment errors in non-interactive shells running
         in posix mode cause the shell to exit. */
      if (tint == 0)
        {
          if (is_nullcmd)       /* assignment statement */
            {
              last_command_exit_value = EXECUTION_FAILURE;
#if defined (STRICT_POSIX)
              if (posixly_correct && interactive_shell == 0)
#else
              if (posixly_correct && interactive_shell == 0 && executing_command_builtin == 0)
#endif
                exp_jump_to_top_level (FORCE_EOF);
              else
                exp_jump_to_top_level (DISCARD);
            }
          /* In posix mode, assignment errors in the temporary environment
             cause a non-interactive shell executing a special builtin to
             exit and a non-interactive shell to otherwise jump back to the
             top level. This is what POSIX says to do for variable assignment
             errors, and POSIX says errors in assigning to the temporary
             environment are treated as variable assignment errors.
             (XXX - this is not what current POSIX says - look at the
             STRICT_POSIX defines. */
          else if (posixly_correct)
            {
              last_command_exit_value = EXECUTION_FAILURE;
#if defined (STRICT_POSIX)
              exp_jump_to_top_level ((interactive_shell == 0) ? FORCE_EOF : DISCARD);
#else
              if (interactive_shell == 0 && is_special_builtin)
                exp_jump_to_top_level (FORCE_EOF);
              else if (interactive_shell == 0)
                exp_jump_to_top_level (DISCARD);        /* XXX - maybe change later */
              else
                exp_jump_to_top_level (DISCARD);
#endif
            }
          else
            tempenv_assign_error++;
        }
    }
  return (tempenv_assign_error);
}

/* The workhorse for expand_words () and expand_words_no_vars ().
   First arg is LIST, a WORD_LIST of words.
   Second arg EFLAGS is a flags word controlling which expansions are
   performed.

   This does all of the substitutions: brace expansion, tilde expansion,
   parameter expansion, command substitution, arithmetic expansion,
   process substitution, word splitting, and pathname expansion, according
   to the bits set in EFLAGS.  Words with the W_QUOTED or W_NOSPLIT bits
   set, or for which no expansion is done, do not undergo word splitting.
   Words with the W_NOGLOB bit set do not undergo pathname expansion; words
   with W_NOBRACE set do not undergo brace expansion (see
   brace_expand_word_list above). */
static WORD_LIST *
expand_word_list_internal (list, eflags)
     WORD_LIST *list;
     int eflags;
{
  WORD_LIST *new_list, *temp_list;

  tempenv_assign_error = 0;
  if (list == 0)
    return ((WORD_LIST *)NULL);

  garglist = new_list = copy_word_list (list);
  if (eflags & WEXP_VARASSIGN)
    {
      garglist = new_list = separate_out_assignments (new_list);
      if (new_list == 0)
        {
          if (subst_assign_varlist)
            do_assignment_statements (subst_assign_varlist, (char *)NULL, 1);
            
          dispose_words (subst_assign_varlist);
          subst_assign_varlist = (WORD_LIST *)NULL;

          return ((WORD_LIST *)NULL);
        }
    }

  /* Begin expanding the words that remain.  The expansions take place on
     things that aren't really variable assignments. */

#if defined (BRACE_EXPANSION)
  /* Do brace expansion on this word if there are any brace characters
     in the string. */
  if ((eflags & WEXP_BRACEEXP) && brace_expansion && new_list)
    new_list = brace_expand_word_list (new_list, eflags);
#endif /* BRACE_EXPANSION */

  /* Perform the `normal' shell expansions: tilde expansion, parameter and
     variable substitution, command substitution, arithmetic expansion,
     and word splitting. */
  new_list = shell_expand_word_list (new_list, eflags);

  /* Okay, we're almost done.  Now let's just do some filename
     globbing. */
  if (new_list)
    {
      if ((eflags & WEXP_PATHEXP) && disallow_filename_globbing == 0)
        /* Glob expand the word list unless globbing has been disabled. */
        new_list = glob_expand_word_list (new_list, eflags);
      else
        /* Dequote the words, because we're not performing globbing. */
        new_list = dequote_list (new_list);
    }

  if ((eflags & WEXP_VARASSIGN) && subst_assign_varlist)
    {
      do_assignment_statements (subst_assign_varlist, (new_list && new_list->word) ? new_list->word->word : (char *)NULL, new_list == 0);

      dispose_words (subst_assign_varlist);
      subst_assign_varlist = (WORD_LIST *)NULL;
    }

  return (new_list);
}