CTPL_ENVIRON_ERROR

#define CTPL_ENVIRON_ERROR  (ctpl_environ_error_quark ())

Error domain of CtplEnviron.

CtplEnvironForeachFunc ()

gboolean
(*CtplEnvironForeachFunc) (CtplEnviron *env,
                           const gchar *symbol,
                           const CtplValue *value,
                           gpointer user_data);

User function for ctpl_environ_foreach().

ctpl_environ_new ()

CtplEnviron *
ctpl_environ_new (void);

Creates a new CtplEnviron.

ctpl_environ_ref ()

CtplEnviron *
ctpl_environ_ref (CtplEnviron *env);

Adds a reference to a CtplEnviron.

Since 0.3

ctpl_environ_unref ()

void
ctpl_environ_unref (CtplEnviron *env);

Removes a reference from a CtplEnviron. If the reference count drops to 0, frees the environ and all its allocated resources.

Since 0.3

ctpl_environ_lookup ()

const CtplValue *
ctpl_environ_lookup (const CtplEnviron *env,
                     const gchar *symbol);

Looks up for a symbol in the given CtplEnviron.

ctpl_environ_push ()

void
ctpl_environ_push (CtplEnviron *env,
                   const gchar *symbol,
                   const CtplValue *value);

Pushes a symbol into a CtplEnviron. Pushing a symbol adds it or overwrites the value in place for it while keeping any already present value for latter poping. The push/pop concept is simple as a stack: when you push, you add a value on the top of a stack, and when you pop, you remove the top element of this stack, revealing the previous value.

ctpl_environ_push_int ()

void
ctpl_environ_push_int (CtplEnviron *env,
                       const gchar *symbol,
                       glong value);

Pushes an integer symbol into a CtplEnviron. See ctpl_environ_push().

ctpl_environ_push_float ()

void
ctpl_environ_push_float (CtplEnviron *env,
                         const gchar *symbol,
                         gdouble value);

Pushes a float symbol into a CtplEnviron. See ctpl_environ_push().

ctpl_environ_push_string ()

void
ctpl_environ_push_string (CtplEnviron *env,
                          const gchar *symbol,
                          const gchar *value);

Pushes a string symbol into a CtplEnviron. See ctpl_environ_push().

ctpl_environ_pop ()

gboolean
ctpl_environ_pop (CtplEnviron *env,
                  const gchar *symbol,
                  CtplValue **poped_value);

Tries to pop a symbol from a CtplEnviron. See ctpl_environ_push() for details on pushing and poping. Use ctpl_environ_lookup() if you want to get the symbol's value without poping it from the environ.

Since 0.3

ctpl_environ_foreach ()

void
ctpl_environ_foreach (CtplEnviron *env,
                      CtplEnvironForeachFunc func,
                      gpointer user_data);

Calls func on each symbol of the environment.

ctpl_environ_merge ()

void
ctpl_environ_merge (CtplEnviron *env,
                    const CtplEnviron *source,
                    gboolean merge_symbols);

Merges an environment into another. If a symbol of the source environ already exists in the destination one, its value is either pushed if merge_symbols is true or ignored if FALSE.

ctpl_environ_add_from_stream ()

gboolean
ctpl_environ_add_from_stream (CtplEnviron *env,
                              CtplInputStream *stream,
                              GError **error);

Loads an environment description from a CtplInputStream.

ctpl_environ_add_from_path ()

gboolean
ctpl_environ_add_from_path (CtplEnviron *env,
                            const gchar *path,
                            GError **error);

Loads an environment description from a path. See ctpl_environ_add_from_stream().

Errors can come from the G_IO_ERROR domain if the file loading failed, or from the CTPL_ENVIRON_ERROR domain if the parsing of the environment description failed.

ctpl_environ_add_from_string ()

gboolean
ctpl_environ_add_from_string (CtplEnviron *env,
                              const gchar *string,
                              GError **error);

Loads an environment description from a string. See ctpl_environ_add_from_stream().

enum CtplEnvironError

Errors in the CTPL_ENVIRON_ERROR domain.

CtplEnviron

typedef struct _CtplEnviron CtplEnviron;

Represents an environment.