Initial revision

darcs-hash:20050920132639-ac50b-fa3b476891e1f5f67207cf4cc7bf623834cc5edc.gz

env.h

@@ -0,0 +1,98 @@
+/** \file env.h
+	Prototypes for functions for setting and getting environment variables.
+*/
+
+/**
+   Flag for local (to the current block) variable
+*/
+#define ENV_LOCAL 1
+
+/**
+   Flag for exported (to commands) variable
+*/
+#define ENV_EXPORT 2
+
+/**
+   Flag for unexported variable
+*/
+#define ENV_UNEXPORT 16
+
+/**
+   Flag for global variable
+*/
+#define ENV_GLOBAL 4
+
+/**
+   Flag for variable update request from the user. All variable
+   changes that are made directly by the user, such as those from the
+   'set' builtin must have this flag set.
+*/
+#define ENV_USER 8
+
+/**
+   Flag for universal variable
+*/
+#define ENV_UNIVERSAL 32
+
+/**
+   Initialize environment variable data
+*/
+void env_init();
+
+/**
+   Destroy environment variable data
+*/
+void env_destroy();
+
+
+/**
+   Set the value of the environment variable whose name matches key to val. 
+
+   Memory policy: All keys and values are copied, the parameters can and should be freed by the caller afterwards
+
+   \param key The key
+   \param val The value
+   \param mode The type of the variable. Can be any combination of ENV_GLOBAL, ENV_LOCAL, ENV_EXPORT and ENV_USER. If mode is zero, the current variable space is searched and the current mode is used. If no current variable with the same name is found, ENV_LOCAL is assumed.
+
+*/
+
+void env_set( const wchar_t *key, 
+			  const wchar_t *val,
+			  int mode );
+
+
+/**
+  Return the value of the variable with the specified name.
+  Returns 0 if the key does not exist.
+  The returned string should not be modified or freed.
+*/
+wchar_t *env_get( const wchar_t *key );
+
+/**
+   Remove environemnt variable
+   
+   \param key The name of the variable to remove
+   \param mode should be ENV_USER if this is a remove request from the user, 0 otherwise. If this is a user request, read-only variables can not be removed.
+*/
+void env_remove( const wchar_t *key, int mode );
+
+/**
+  Push the variable stack. Used for implementing local variables for functions and for-loops.
+*/
+void env_push( int new_scope );
+
+/**
+  Pop the variable stack. Used for implementing local variables for functions and for-loops.
+*/
+void env_pop();
+
+/**
+   Returns an array containing all exported variables in a format suitable for execv.
+*/
+char **env_export_arr();
+
+/**
+  Insert all variable names into l. These are not copies of the strings and should not be freed after use.
+
+*/
+void env_get_names( array_list_t *l, int flags );