libaegis/sub.h File Reference

#include <common/ac/stdarg.h>
#include <common/ac/time.h>
#include <common/str.h>
#include <libaegis/change.h>
#include <libaegis/sub/diversion/stack.h>
#include <libaegis/sub/functor/list.h>

Go to the source code of this file.

Data Structures

class  sub_context_ty

Functions

sub_context_tysub_context_New (const char *file, int line)
sub_context_tysub_context_new ()
void sub_context_delete (sub_context_ty *scp)
void sub_var_clear (sub_context_ty *scp)
void sub_var_set_format (sub_context_ty *scp, const char *name, const char *fmt,...)
void sub_var_set_string (sub_context_ty *scp, const char *name, string_ty *value)
void sub_var_set_string (sub_context_ty *scp, const char *name, const nstring &value)
void sub_var_set_charstar (sub_context_ty *scp, const char *name, const char *value)
void sub_var_set_long (sub_context_ty *scp, const char *name, long value)
void sub_var_set_time (sub_context_ty *scp, const char *name, time_t value)
void sub_var_optional (sub_context_ty *scp, const char *name)
void sub_var_append_if_unused (sub_context_ty *scp, const char *name)
void sub_var_override (sub_context_ty *scp, const char *name)
void sub_var_resubstitute (sub_context_ty *scp, const char *name)
void sub_errno_setx (sub_context_ty *scp, int value)
string_tysubstitute (sub_context_ty *scp, change::pointer cp, string_ty *the_command)
string_tysubstitute_p (sub_context_ty *scp, struct project_ty *pp, string_ty *the_command)
string_tysubst_intl (sub_context_ty *scp, const char *substme)
void subst_intl_project (sub_context_ty *scp, struct project_ty *pp)
void subst_intl_change (sub_context_ty *scp, change::pointer cp)
void error_intl (sub_context_ty *scp, const char *message)
void fatal_intl (sub_context_ty *, const char *)
void verbose_intl (sub_context_ty *scp, const char *message)
const char * i18n (const char *x)
void sub_context_error_set (sub_context_ty *scp, const char *message)
project_tysub_context_project_get (sub_context_ty *scp)
change::pointer sub_context_change_get (sub_context_ty *scp)


Function Documentation

void error_intl ( sub_context_ty scp,
const char *  message 
) [inline]

Definition at line 617 of file sub.h.

void fatal_intl ( sub_context_ty scp,
const char *  message 
) [inline]

Definition at line 632 of file sub.h.

const char* i18n ( const char *  x  )  [inline]

Definition at line 661 of file sub.h.

change::pointer sub_context_change_get ( sub_context_ty scp  )  [inline]

Definition at line 679 of file sub.h.

void sub_context_delete ( sub_context_ty scp  )  [inline]

Definition at line 446 of file sub.h.

void sub_context_error_set ( sub_context_ty scp,
const char *  message 
) [inline]

Definition at line 667 of file sub.h.

sub_context_ty* sub_context_new (  )  [inline]

Definition at line 440 of file sub.h.

sub_context_ty* sub_context_New ( const char *  file,
int  line 
) [inline]

Definition at line 434 of file sub.h.

project_ty* sub_context_project_get ( sub_context_ty scp  )  [inline]

Definition at line 673 of file sub.h.

void sub_errno_setx ( sub_context_ty scp,
int  value 
) [inline]

Set the $ERRNO value in the given substitition context.

Note:
There is no method to directly read errno and set it, because there is at least one malloc() library call and possibly several others before you get around to calling this function. You *must* instead copy the value of errno immediatly after the offending system call, and before doing anything towards preparing the error message.

Definition at line 554 of file sub.h.

void sub_var_append_if_unused ( sub_context_ty scp,
const char *  name 
) [inline]

Definition at line 525 of file sub.h.

void sub_var_clear ( sub_context_ty scp  )  [inline]

Definition at line 452 of file sub.h.

void sub_var_optional ( sub_context_ty scp,
const char *  name 
) [inline]

Definition at line 519 of file sub.h.

void sub_var_override ( sub_context_ty scp,
const char *  name 
) [inline]

Definition at line 531 of file sub.h.

void sub_var_resubstitute ( sub_context_ty scp,
const char *  name 
) [inline]

Definition at line 537 of file sub.h.

void sub_var_set_charstar ( sub_context_ty scp,
const char *  name,
const char *  value 
) [inline]

Definition at line 501 of file sub.h.

void sub_var_set_format ( sub_context_ty scp,
const char *  name,
const char *  fmt,
  ... 
) [inline]

Definition at line 458 of file sub.h.

void sub_var_set_long ( sub_context_ty scp,
const char *  name,
long  value 
) [inline]

Definition at line 507 of file sub.h.

void sub_var_set_string ( sub_context_ty scp,
const char *  name,
const nstring value 
) [inline]

The sub_var_set_string function is used to set the value of a substitution variable.

Parameters:
scp The substitution context to set the variable within.
name The name of the variable to be set.
value The value of the variable to be set.

Definition at line 495 of file sub.h.

void sub_var_set_string ( sub_context_ty scp,
const char *  name,
string_ty value 
) [inline]

The sub_var_set_string function is used to set the value of a substitution variable.

Parameters:
scp The substitution context to set the variable within.
name The name of the variable to be set.
value The value of the variable to be set.

Definition at line 478 of file sub.h.

void sub_var_set_time ( sub_context_ty scp,
const char *  name,
time_t  value 
) [inline]

Definition at line 513 of file sub.h.

string_ty* subst_intl ( sub_context_ty scp,
const char *  substme 
) [inline]

Definition at line 582 of file sub.h.

void subst_intl_change ( sub_context_ty scp,
change::pointer  cp 
) [inline]

Definition at line 605 of file sub.h.

void subst_intl_project ( sub_context_ty scp,
struct project_ty pp 
) [inline]

Definition at line 593 of file sub.h.

string_ty* substitute ( sub_context_ty scp,
change::pointer  cp,
string_ty the_command 
) [inline]

Definition at line 560 of file sub.h.

string_ty* substitute_p ( sub_context_ty scp,
struct project_ty pp,
string_ty the_command 
) [inline]

Definition at line 571 of file sub.h.

void verbose_intl ( sub_context_ty scp,
const char *  message 
) [inline]

Definition at line 644 of file sub.h.


Generated on Wed Mar 12 23:37:37 2008 for Aegis by  doxygen 1.5.5