myvar.h File Reference

Handling of personal config ('my' variables) More...

#include "mutt/lib.h"

Include dependency graph for myvar.h:

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

Go to the source code of this file.

Data Structures
struct	MyVar
	A user-set variable. More...

Functions
	TAILQ_HEAD (MyVarList, MyVar)
void	myvar_del (const char *var)
	Unset the value of a "my_" variable. More...
const char *	myvar_get (const char *var)
	Get the value of a "my_" variable. More...
void	myvar_set (const char *var, const char *val)
	Set the value of a "my_" variable. More...
void	myvar_append (const char *var, const char *val)
	Append to the value of a "my_" variable. More...
void	myvarlist_free (struct MyVarList *list)
	Free a List of MyVars. More...

Variables
struct MyVarList	MyVars
	List of all the user's custom config variables. More...

Detailed Description

Handling of personal config ('my' 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 myvar.h.

Function Documentation

TAILQ_HEAD()

TAILQ_HEAD	(	MyVarList	,
		MyVar
	)

myvar_del()

void myvar_del

(

const char *

var

)

Unset the value of a "my_" variable.

Parameters

var	Variable name

Definition at line 146 of file myvar.c.

{
  struct MyVar *myv = myvar_find(var);
 
  if (myv)
  {
    TAILQ_REMOVE(&MyVars, myv, entries);
    myvar_free(&myv);
  }
}

Here is the call graph for this function:

Here is the caller graph for this function:

myvar_get()

const char * myvar_get

(

const char *

var

)

Get the value of a "my_" variable.

Parameters

var	Variable name

Return values

ptr	Success, value of variable
NULL	Error, variable doesn't exist

Definition at line 92 of file myvar.c.

{
  struct MyVar *myv = myvar_find(var);
 
  if (myv)
  {
    return NONULL(myv->value);
  }
 
  return NULL;
}

Here is the call graph for this function:

Here is the caller graph for this function:

myvar_set()

void myvar_set	(	const char *	var,
		const char *	val
	)

Set the value of a "my_" variable.

Parameters

var	Variable name
val	Value to set

Definition at line 109 of file myvar.c.

{
  struct MyVar *myv = myvar_find(var);
 
  if (myv)
  {
    mutt_str_replace(&myv->value, val);
    return;
  }
 
  myv = myvar_new(var, val);
  TAILQ_INSERT_TAIL(&MyVars, myv, entries);
}

Here is the call graph for this function:

Here is the caller graph for this function:

myvar_append()

void myvar_append	(	const char *	var,
		const char *	val
	)

Append to the value of a "my_" variable.

Parameters

var	Variable name
val	Value to append

Definition at line 128 of file myvar.c.

{
  struct MyVar *myv = myvar_find(var);
 
  if (myv)
  {
    mutt_str_append_item(&myv->value, val, '\0');
    return;
  }
 
  myv = myvar_new(var, val);
  TAILQ_INSERT_TAIL(&MyVars, myv, entries);
}

Here is the call graph for this function:

Here is the caller graph for this function:

myvarlist_free()

void myvarlist_free

(

struct MyVarList *

list

)

Free a List of MyVars.

Parameters

list	List of MyVars

Definition at line 161 of file myvar.c.

{
  if (!list)
    return;
 
  struct MyVar *myv = NULL;
  struct MyVar *tmp = NULL;
  TAILQ_FOREACH_SAFE(myv, list, entries, tmp)
  {
    TAILQ_REMOVE(list, myv, entries);
    myvar_free(&myv);
  }
}

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

MyVars

struct MyVarList MyVars

extern

List of all the user's custom config variables.

Definition at line 34 of file myvar.c.