GIS library - environment routines. More...

#include <signal.h>
#include <unistd.h>
#include <stdlib.h>
#include <string.h>
#include <grass/gis.h>
#include <grass/glocale.h>

Include dependency graph for env.c:

Go to the source code of this file.

Defines
#define	ENV struct env
Functions
void	G_set_gisrc_mode (int mode)
	Set where to find/store variables.
int	G_get_gisrc_mode (void)
	Get info where variables are stored.
char *	G_getenv (const char *name)
	Get environment variable.
char *	G_getenv2 (const char *name, int loc)
	Read variable from specific place.
char *	G__getenv (const char *name)
	Get environment variable.
char *	G__getenv2 (const char *name, int loc)
	Get environment variable from specific place.
int	G_setenv (const char name, const char value)
	Set environment variable.
int	G_setenv2 (const char name, const char value, int loc)
	Set environment variable from specific place.
int	G__setenv (const char name, const char value)
	Set environment name to value.
int	G__setenv2 (const char name, const char value, int loc)
	Set environment name to value from specific place.
int	G_unsetenv (const char *name)
	Remove name from environment.
int	G_unsetenv2 (const char *name, int loc)
	Remove name from environment from specific place.
int	G__write_env (void)
	Writes current environment to .gisrc.
char *	G__env_name (int n)
	Get variable name for index n.
int	G__read_env (void)
	Initialize init array for G_VAR_GISRC.
int	G__set_gisrc_file (const char *name)
	Sets filename for gisrc.
char *	G__get_gisrc_file (void)
	Get gisrc filename.
int	G__create_alt_env (void)
	Set up alternative environment variables.
int	G__switch_env (void)
	Switch environments.

Detailed Description

GIS library - environment routines.

This program is free software under the GNU General Public License (>=v2). Read the file COPYING that comes with GRASS for details.

Author:: Original author CERL

Definition in file env.c.

Define Documentation

#define ENV struct env

Definition at line 25 of file env.c.

Referenced by G__switch_env().

Function Documentation

int G__create_alt_env ( void )

Set up alternative environment variables.

Parameters:

Returns:: 0

Definition at line 537 of file env.c.

References NULL.

Referenced by G__make_mapset().

char* G__env_name ( int n )

Get variable name for index n.

For example:

   for (n = 0; ; n++)
      if ((name = G__env_name(n)) == NULL)
        break;

Parameters:

n	index of variable

Returns:: pointer to variable name

Definition at line 476 of file env.c.

References NULL.

char* G__get_gisrc_file ( void )

Get gisrc filename.

Parameters:

Returns:: char pointer to filename

Definition at line 525 of file env.c.

char* G__getenv ( const char * name )

Get environment variable.

Parameters:

name	variable name

Returns:: char pointer to value for name; NULL if name not set

Definition at line 312 of file env.c.

Referenced by G__mapset(), G_check_overwrite(), G_debug(), and G_getenv().

char* G__getenv2	(	const char *	name,
		int	loc
	)

Get environment variable from specific place.

Parameters:

name	variable name
loc	location id

Returns:: char pointer to value for name; NULL if name not set

Definition at line 331 of file env.c.

Referenced by G_getenv2().

int G__read_env ( void )

Initialize init array for G_VAR_GISRC.

Parameters:

Returns:: 0

Definition at line 495 of file env.c.

int G__set_gisrc_file ( const char * name )

Sets filename for gisrc.

Parameters:

name filename

Returns:: 0

Definition at line 509 of file env.c.

References G_store(), and NULL.

int G__setenv	(	const char *	name,
		const char *	value
	)

Set environment name to value.

Parameters:

name	variable name
value	variable value

Returns:: 0

Definition at line 388 of file env.c.

Referenced by G__make_location(), G__make_mapset(), and G_check_overwrite().

int G__setenv2	(	const char *	name,
		const char *	value,
		int	loc
	)

Set environment name to value from specific place.

Parameters:

name	variable name
value	variable value
loc	location id

Returns:: 0

Definition at line 404 of file env.c.

int G__switch_env ( void )

Switch environments.

Parameters:

Returns:: 0

Definition at line 561 of file env.c.

References ENV.

Referenced by G__make_mapset().

int G__write_env ( void )

Writes current environment to .gisrc.

Parameters:

Returns:: 0

Definition at line 454 of file env.c.

int G_get_gisrc_mode ( void )

Get info where variables are stored.

Parameters:

Returns:: mode

Definition at line 71 of file env.c.

char* G_getenv ( const char * name )

Get environment variable.

Calls G_fatal_error() if name not set.

Parameters:

name	variable name

Returns:: char pointer to value for name

Definition at line 267 of file env.c.

References G__getenv(), G_fatal_error(), and NULL.

Referenced by G_gisbase(), G_gisdbase(), G_gishelp(), and G_location().

char* G_getenv2	(	const char *	name,
		int	loc
	)

Read variable from specific place.

Locations:

G_VAR_GISRC
G_VAR_MAPSET

G_fatal_error() is called when variable is not found.

Parameters:

name	variable name
loc	location id

Returns:: variable value; NULL if not found

Definition at line 293 of file env.c.

References G__getenv2(), G_fatal_error(), and NULL.

void G_set_gisrc_mode ( int mode )

Set where to find/store variables.

Modes:

G_GISRC_MODE_FILE
G_GISRC_MODE_MEMORY

Parameters:

mode	mode to find/store variables (G_GISRC_MODE_FILE by default)

Returns:

Definition at line 59 of file env.c.

int G_setenv	(	const char *	name,
		const char *	value
	)

Set environment variable.

If value is NULL, becomes an G_unsetenv(). Updates .gisrc

Parameters:

name	variable name
value	variable value

Returns:: 0

Definition at line 352 of file env.c.

int G_setenv2	(	const char *	name,
		const char *	value,
		int	loc
	)

Set environment variable from specific place.

If value is NULL, becomes an G_unsetenv(). Updates .gisrc

Parameters:

name	variable name
value	variable value
loc	location id

Returns:: 0

Definition at line 372 of file env.c.

int G_unsetenv ( const char * name )

Remove name from environment.

Updates .gisrc

Parameters:

name	variable name

Returns:: 0

Definition at line 420 of file env.c.

int G_unsetenv2	(	const char *	name,
		int	loc
	)

Remove name from environment from specific place.

Updates .gisrc

Parameters:

name	variable name

Returns:: 0

Definition at line 438 of file env.c.

Defines

Functions

Detailed Description

Define Documentation

Function Documentation