envlist.h File Reference

Private copy of the environment variables. More...

#include <stdbool.h>

Include dependency graph for envlist.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions
void	mutt_envlist_free (void)
	Free the private copy of the environment. More...
char **	mutt_envlist_getlist (void)
	Get the private environment. More...
void	mutt_envlist_init (char *envp[])
	Create a copy of the environment. More...
bool	mutt_envlist_set (const char *name, const char *value, bool overwrite)
	Set an environment variable. More...
bool	mutt_envlist_unset (const char *name)
	Unset an environment variable. More...

Detailed Description

Private copy of the environment variables.

Authors

• Richard Russon

Copyright

This program 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 2 of the License, or (at your option) any later version.

This program 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 this program. If not, see http://www.gnu.org/licenses/.

Definition in file envlist.h.

Function Documentation

mutt_envlist_free()

void mutt_envlist_free

(

void

)

Free the private copy of the environment.

Definition at line 41 of file envlist.c.

{
  if (!EnvList)
    return;
 
  for (char **p = EnvList; p && *p; p++)
    FREE(p);
 
  FREE(&EnvList);
}

Here is the caller graph for this function:

mutt_envlist_getlist()

char ** mutt_envlist_getlist

(

void

)

Get the private environment.

Return values

ptr	Array of strings

Note

The caller must not free the strings

Definition at line 169 of file envlist.c.

{
  return EnvList;
}

Here is the caller graph for this function:

mutt_envlist_init()

void mutt_envlist_init

(

char *

envp[]

)

Create a copy of the environment.

Parameters

envp	Environment variables

Definition at line 56 of file envlist.c.

{
  if (EnvList)
    mutt_envlist_free();
 
  if (!envp)
    return;
 
  char **src = NULL, **dst = NULL;
  int count = 0;
  for (src = envp; src && *src; src++)
    count++;
 
  EnvList = mutt_mem_calloc(count + 1, sizeof(char *));
  for (src = envp, dst = EnvList; src && *src; src++, dst++)
    *dst = mutt_str_dup(*src);
}

Here is the call graph for this function:

Here is the caller graph for this function:

mutt_envlist_set()

bool mutt_envlist_set	(	const char *	name,
		const char *	value,
		bool	overwrite
	)

Set an environment variable.

Parameters

name	Name of the variable
value	New value
overwrite	Should the variable be overwritten?

Return values

true	Success: variable set, or overwritten
false	Variable exists and overwrite was false

It's broken out because some other parts of neomutt (filter.c) need to set/overwrite environment variables in EnvList before calling exec().

Definition at line 85 of file envlist.c.

{
  if (!name)
    return false;
 
  char **envp = EnvList;
  char work[1024] = { 0 };
 
  /* Look for current slot to overwrite */
  int count = 0;
  while (envp && *envp)
  {
    size_t len = mutt_str_startswith(*envp, name);
    if ((len != 0) && ((*envp)[len] == '='))
    {
      if (!overwrite)
        return false;
      break;
    }
    envp++;
    count++;
  }
 
  /* Format var=value string */
  snprintf(work, sizeof(work), "%s=%s", name, NONULL(value));
 
  if (envp && *envp)
  {
    /* slot found, overwrite */
    mutt_str_replace(envp, work);
  }
  else
  {
    /* not found, add new slot */
    mutt_mem_realloc(&EnvList, sizeof(char *) * (count + 2));
    EnvList[count] = mutt_str_dup(work);
    EnvList[count + 1] = NULL;
  }
  return true;
}

Here is the call graph for this function:

Here is the caller graph for this function:

mutt_envlist_unset()

bool mutt_envlist_unset

(

const char *

name

)

Unset an environment variable.

Parameters

name	Variable to unset

Return values

true	Success: Variable unset
false	Error: Variable doesn't exist

Definition at line 132 of file envlist.c.

{
  if (!name || (name[0] == '\0'))
    return false;
 
  char **envp = EnvList;
 
  int count = 0;
  while (envp && *envp)
  {
    size_t len = mutt_str_startswith(*envp, name);
    if ((len != 0) && ((*envp)[len] == '='))
    {
      FREE(envp);
      /* shuffle down */
      char **save = envp++;
      while (*envp)
      {
        *save++ = *envp++;
        count++;
      }
      *save = NULL;
      mutt_mem_realloc(&EnvList, sizeof(char *) * (count + 1));
      return true;
    }
    envp++;
    count++;
  }
  return false;
}

Here is the call graph for this function:

Here is the caller graph for this function: