comparison src/callproc.c @ 83529:0d9e16eab053

Rework environment variable support. (Reported by Kalle Olavi Niemitalo and Noah Friedman.) * src/callproc.c (Vglobal_environment, Vlocal_environment_variables): Remove. (getenv_internal, child_setup): Don't look at global-environment or local-environment-variables. (Fgetenv_internal): Update docs. (set_initial_environment): Rename from set_global_environment. Store Emacs environment in initial frame parameter. (syms_of_callproc): Remove obsolete defvars. Update docs. * lisp/env.el (read-envvar-name): Remove reference to global-environment. (setenv-internal): New function. (setenv): Use it. Always set process-environment. Update docs. (getenv): Update docs. (environment): Rewrite for the new environment design. Update docs. * lisp/frame.el (frame-initialize): Copy the environment from the initial frame. * src/emacs.c (main): Call set_initial_environment, not set_global_environment. git-archimport-id: [e-mail]--2004/emacs--multi-tty--0--patch-569

83528:a43b5a268ea1

Lisp_Object Vconfigure_info_directory, Vshared_game_score_directory;
Lisp_Object Vtemp_file_name_pattern;

Lisp_Object Vshell_file_name;

Lisp_Object Vglobal_environment;
Lisp_Object Vprocess_environment;

#ifdef DOS_NT
Lisp_Object Qbuffer_file_type;
#endif /* DOS_NT */

int synch_process_termsig;

/* If synch_process_death is zero,
   this is exit code of synchronous subprocess.  */
int synch_process_retcode;

/* List of environment variables to look up in emacsclient.  */
Lisp_Object Vlocal_environment_variables;


/* Clean up when exiting Fcall_process.
   On MSDOS, delete the temporary file on any kind of termination.
   On Unix, kill the process and any children on termination by signal.  */

  {
    register Lisp_Object tem;
    register char **new_env;
    char **p, **q;
    register int new_length;
    Lisp_Object environment = Vglobal_environment;
    Lisp_Object local;

    new_length = 0;

    for (tem = Vprocess_environment;
         CONSP (tem) && STRINGP (XCAR (tem));
         tem = XCDR (tem))
      new_length++;

    if (!NILP (Vlocal_environment_variables))
      {
        local = get_frame_param (XFRAME (Fframe_with_environment (selected_frame)),
                                 Qenvironment);
        if (EQ (Vlocal_environment_variables, Qt)
            && !NILP (local))
          environment = local;
        else if (CONSP (local))
          {
            new_length += Fsafe_length (Vlocal_environment_variables);
          }
      }

    for (tem = environment;
	 CONSP (tem) && STRINGP (XCAR (tem));
	 tem = XCDR (tem))
      new_length++;

    /* new_length + 2 to include PWD and terminating 0.  */
    env = new_env = (char **) alloca ((new_length + 2) * sizeof (char *));

    /* If we have a PWD envvar, pass one down,
       but with corrected value.  */
    if (getenv ("PWD"))
      *new_env++ = pwd_var;
 
    /* Overrides.  */
    for (tem = Vprocess_environment;
	 CONSP (tem) && STRINGP (XCAR (tem));
	 tem = XCDR (tem))
      new_env = add_env (env, new_env, SDATA (XCAR (tem)));

    /* Local part of environment, if Vlocal_environment_variables is a list.  */
    for (tem = Vlocal_environment_variables;
         CONSP (tem) && STRINGP (XCAR (tem));
         tem = XCDR (tem))
      new_env = add_env (env, new_env, egetenv (SDATA (XCAR (tem))));

    /* The rest of the environment (either Vglobal_environment or the
       'environment frame parameter).  */
    for (tem = environment;
	 CONSP (tem) && STRINGP (XCAR (tem));
	 tem = XCDR (tem))
      new_env = add_env (env, new_env, SDATA (XCAR (tem)));

    *new_env = 0;

    /* Remove variable names without values.  */

     char **value;
     int *valuelen;
     Lisp_Object frame;
{
  Lisp_Object scan;
  Lisp_Object environment = Vglobal_environment;

  /* Try to find VAR in Vprocess_environment first.  */
  for (scan = Vprocess_environment; CONSP (scan); scan = XCDR (scan))
    {
      Lisp_Object entry = XCAR (scan);
      if (STRINGP (entry)
          && SBYTES (entry) >= varlen
#ifdef WINDOWSNT
          /* NT environment variables are case insensitive.  */
          && ! strnicmp (SDATA (entry), var, varlen)
#else  /* not WINDOWSNT */
          && ! bcmp (SDATA (entry), var, varlen)
#endif /* not WINDOWSNT */
          )
        {
          if (SBYTES (entry) > varlen && SREF (entry, varlen) == '=')
            {
              *value = (char *) SDATA (entry) + (varlen + 1);
              *valuelen = SBYTES (entry) - (varlen + 1);
              return 1;
            }
          else if (SBYTES (entry) == varlen)
            {
              /* Lone variable names in Vprocess_environment mean that
                 variable should be removed from the environment. */
              return 0;
            }
        }
    }

  /* Find the environment in which to search the variable. */
  if (!NILP (frame))
    {
      Lisp_Object local;

      CHECK_FRAME (frame);
      frame = Fframe_with_environment (frame);
      local = get_frame_param (XFRAME (frame), Qenvironment);
      /* Use Vglobal_environment if there is no local environment.  */
      if (!NILP (local))
        environment = local;
    }
  else if (!NILP (Vlocal_environment_variables)) 
    {
      Lisp_Object local = get_frame_param (XFRAME (Fframe_with_environment (selected_frame)),
                                           Qenvironment);
      if (EQ (Vlocal_environment_variables, Qt)
          && !NILP (local))
        environment = local;
      else if (CONSP (local))
        {
          for (scan = Vlocal_environment_variables; CONSP (scan); scan = XCDR (scan))
            {
              Lisp_Object entry = XCAR (scan);
              if (STRINGP (entry)
                  && SBYTES (entry) == varlen
#ifdef WINDOWSNT
                  /* NT environment variables are case insensitive.  */
                  && ! strnicmp (SDATA (entry), var, varlen)
#else  /* not WINDOWSNT */
                  && ! bcmp (SDATA (entry), var, varlen)
#endif /* not WINDOWSNT */
                  )
                {
                  environment = local;
                  break;
                } 
            }
        }
    }

  for (scan = environment; CONSP (scan); scan = XCDR (scan))
    {
      Lisp_Object entry;

      entry = XCAR (scan);
      if (STRINGP (entry)

DEFUN ("getenv-internal", Fgetenv_internal, Sgetenv_internal, 1, 2, 0,
       doc: /* Get the value of environment variable VARIABLE.
VARIABLE should be a string.  Value is nil if VARIABLE is undefined in
the environment.  Otherwise, value is a string.

If optional parameter FRAME is non-nil, then it should be a frame.  If
that frame has its own set of environment variables, this function
will look up VARIABLE in there.

Otherwise, this function searches `process-environment' for VARIABLE.
If it is not found there, then it continues the search in either
`global-environment' or the environment list of the selected frame,
depending on the value of `local-environment-variables'.  */)
     (variable, frame)
     Lisp_Object variable, frame;
{
  char *value;
  int valuelen;

#else
  if (getenv ("TMPDIR"))
    {
      char *dir = getenv ("TMPDIR");
      Vtemp_file_name_pattern
	= Fexpand_file_name (build_string ("emacsXXXXXX"),
			     build_string (dir));
    }
  else
    Vtemp_file_name_pattern = build_string ("/tmp/emacsXXXXXX");
#endif

    Vshared_game_score_directory = Qnil;
#endif
}

void
set_global_environment ()
{
  register char **envp;

  Vglobal_environment = Qnil;
#ifndef CANNOT_DUMP
  if (initialized)
#endif
    for (envp = environ; *envp; envp++)
      Vglobal_environment = Fcons (build_string (*envp),
				    Vglobal_environment);
}

void
syms_of_callproc ()
{

  DEFVAR_LISP ("temp-file-name-pattern", &Vtemp_file_name_pattern,
	       doc: /* Pattern for making names for temporary files.
This is used by `call-process-region'.  */);
  /* This variable is initialized in init_callproc.  */

  DEFVAR_LISP ("global-environment", &Vglobal_environment,
	       doc: /* Global list of environment variables for subprocesses to inherit.
Each element should be a string of the form ENVVARNAME=VALUE.

The environment which Emacs inherits is placed in this variable when
Emacs starts.

Some frames may have their own local list of environment variables in
their 'environment parameter, which may override this global list; see
`local-environment-variables' and `frame-with-environment'.  See
`process-environment' for a way to modify an environment variable on
all frames.

If multiple entries define the same variable, the first one always
takes precedence.

Non-ASCII characters are encoded according to the initial value of
`locale-coding-system', i.e. the elements must normally be decoded for use.
See `setenv' and `getenv'.  */);

  DEFVAR_LISP ("process-environment", &Vprocess_environment,
	       doc: /* List of overridden environment variables for subprocesses to inherit.
Each element should be a string of the form ENVVARNAME=VALUE.

Entries in this list take precedence to those in `global-environment'
or the frame-local environments.  (See `local-environment-variables'
and `frame-with-environment'.)  Therefore, let-binding
`process-environment' is an easy way to temporarily change the value
of an environment variable, irrespective of where it comes from.  To
use `process-environment' to remove an environment variable, include
only its name in the list, without "=VALUE".

This variable is set to nil when Emacs starts.

If multiple entries define the same variable, the first one always
takes precedence.

#ifndef VMS
  defsubr (&Scall_process);
  defsubr (&Sgetenv_internal);
#endif
  defsubr (&Scall_process_region);

  DEFVAR_LISP ("local-environment-variables", &Vlocal_environment_variables,
               doc: /* 	Enable or disable frame-local environment variables.
If set to t, `getenv', `setenv' and subprocess creation functions use
the local environment of the selected frame, ignoring
`global-environment'.

If set to nil, Emacs uses `global-environment' and ignores the
frame-local environment.

Otherwise, `local-environment-variables' should be a list of variable
names (represented by Lisp strings) to look up in the frame's
environment.  The rest will come from `global-environment'.

The frame-local environment is stored in the 'environment frame
parameter.  See `frame-with-environment'.  */);
  Vlocal_environment_variables = Qt;
}

/* arch-tag: 769b8045-1df7-4d2b-8968-e3fb49017f95
   (do not change this comment) */

83529:0d9e16eab053

Lisp_Object Vconfigure_info_directory, Vshared_game_score_directory;
Lisp_Object Vtemp_file_name_pattern;

Lisp_Object Vshell_file_name;

Lisp_Object Vprocess_environment;

#ifdef DOS_NT
Lisp_Object Qbuffer_file_type;
#endif /* DOS_NT */

int synch_process_termsig;

/* If synch_process_death is zero,
   this is exit code of synchronous subprocess.  */
int synch_process_retcode;


/* Clean up when exiting Fcall_process.
   On MSDOS, delete the temporary file on any kind of termination.
   On Unix, kill the process and any children on termination by signal.  */

  {
    register Lisp_Object tem;
    register char **new_env;
    char **p, **q;
    register int new_length;
    Lisp_Object local = get_frame_param (XFRAME (Fframe_with_environment (selected_frame)),
                                         Qenvironment);

    new_length = 0;

    for (tem = Vprocess_environment;
         CONSP (tem) && STRINGP (XCAR (tem));
         tem = XCDR (tem))
      new_length++;

    for (tem = local;
	 CONSP (tem) && STRINGP (XCAR (tem));
	 tem = XCDR (tem))
      new_length++;

    /* new_length + 2 to include PWD and terminating 0.  */
    env = new_env = (char **) alloca ((new_length + 2) * sizeof (char *));

    /* If we have a PWD envvar, pass one down,
       but with corrected value.  */
    if (egetenv ("PWD"))
      *new_env++ = pwd_var;
 
    /* Overrides.  */
    for (tem = Vprocess_environment;
	 CONSP (tem) && STRINGP (XCAR (tem));
	 tem = XCDR (tem))
      new_env = add_env (env, new_env, SDATA (XCAR (tem)));

    /* Local part of environment.  */
    for (tem = local;
         CONSP (tem) && STRINGP (XCAR (tem));
         tem = XCDR (tem))
      new_env = add_env (env, new_env, SDATA (XCAR (tem)));

    *new_env = 0;

    /* Remove variable names without values.  */

     char **value;
     int *valuelen;
     Lisp_Object frame;
{
  Lisp_Object scan;

  if (NILP (frame))
    {
      /* Try to find VAR in Vprocess_environment first.  */
      for (scan = Vprocess_environment; CONSP (scan); scan = XCDR (scan))
        {
          Lisp_Object entry = XCAR (scan);
          if (STRINGP (entry)
              && SBYTES (entry) >= varlen
#ifdef WINDOWSNT
              /* NT environment variables are case insensitive.  */
              && ! strnicmp (SDATA (entry), var, varlen)
#else  /* not WINDOWSNT */
              && ! bcmp (SDATA (entry), var, varlen)
#endif /* not WINDOWSNT */
              )
            {
              if (SBYTES (entry) > varlen && SREF (entry, varlen) == '=')
                {
                  *value = (char *) SDATA (entry) + (varlen + 1);
                  *valuelen = SBYTES (entry) - (varlen + 1);
                  return 1;
                }
              else if (SBYTES (entry) == varlen)
                {
                  /* Lone variable names in Vprocess_environment mean that
                     variable should be removed from the environment. */
                  return 0;
                }
            }
        }
      frame = selected_frame;
    }

  /* Find the environment in which to search the variable. */
  CHECK_FRAME (frame);
  frame = Fframe_with_environment (frame);

  for (scan = get_frame_param (XFRAME (frame), Qenvironment);
       CONSP (scan);
       scan = XCDR (scan))
    {
      Lisp_Object entry;

      entry = XCAR (scan);
      if (STRINGP (entry)

DEFUN ("getenv-internal", Fgetenv_internal, Sgetenv_internal, 1, 2, 0,
       doc: /* Get the value of environment variable VARIABLE.
VARIABLE should be a string.  Value is nil if VARIABLE is undefined in
the environment.  Otherwise, value is a string.

This function searches `process-environment' for VARIABLE.  If it is
not found there, then it continues the search in the environment list
of the selected frame.

If optional parameter FRAME is non-nil, then this function will ignore
`process-environment' and will simply look up the variable in that
frame's environment.  */)
     (variable, frame)
     Lisp_Object variable, frame;
{
  char *value;
  int valuelen;

#else
  if (getenv ("TMPDIR"))
    {
      char *dir = getenv ("TMPDIR");
      Vtemp_file_name_pattern
       = Fexpand_file_name (build_string ("emacsXXXXXX"),
                            build_string (dir));
    }
  else
    Vtemp_file_name_pattern = build_string ("/tmp/emacsXXXXXX");
#endif

    Vshared_game_score_directory = Qnil;
#endif
}

void
set_initial_environment ()
{
  register char **envp;
  Lisp_Object env = Qnil;
#ifndef CANNOT_DUMP
  if (initialized)
#endif
    {
      for (envp = environ; *envp; envp++)
        env = Fcons (build_string (*envp), env);
      store_frame_param (SELECTED_FRAME(), Qenvironment, env);
    }
}

void
syms_of_callproc ()
{

  DEFVAR_LISP ("temp-file-name-pattern", &Vtemp_file_name_pattern,
	       doc: /* Pattern for making names for temporary files.
This is used by `call-process-region'.  */);
  /* This variable is initialized in init_callproc.  */

  DEFVAR_LISP ("process-environment", &Vprocess_environment,
	       doc: /* List of overridden environment variables for subprocesses to inherit.
Each element should be a string of the form ENVVARNAME=VALUE.

Entries in this list take precedence to those in the frame-local
environments.  Therefore, let-binding `process-environment' is an easy
way to temporarily change the value of an environment variable,
irrespective of where it comes from.  To use `process-environment' to
remove an environment variable, include only its name in the list,
without "=VALUE".

This variable is set to nil when Emacs starts.

If multiple entries define the same variable, the first one always
takes precedence.

#ifndef VMS
  defsubr (&Scall_process);
  defsubr (&Sgetenv_internal);
#endif
  defsubr (&Scall_process_region);
}

/* arch-tag: 769b8045-1df7-4d2b-8968-e3fb49017f95
   (do not change this comment) */