/home/archives/aegis/branch.4/branch.24/delta12472.002/libaegis/common.h File Reference

#include <common/str.h>
#include <libaegis/output.h>
#include <libaegis/meta_lex.h>
#include <libaegis/meta_parse.h>
#include <libaegis/meta_type.h>

Go to the source code of this file.

Data Structures
struct	metric_ty
struct	metric_list_ty
struct	history_version_ty
struct	attributes_ty
struct	attributes_list_ty
struct	common_ty
Defines
#define	change_cause_max   7
#define	file_action_max   5
#define	file_usage_max   5
#define	metric_name_mask   ((unsigned long)0)
#define	metric_value_mask   ((unsigned long)1 << 0)
#define	metric_trace(x)
#define	metric_list_trace(x)
#define	history_version_encoding_max   3
#define	history_version_revision_mask   ((unsigned long)0)
#define	history_version_encoding_mask   ((unsigned long)1 << 0)
#define	history_version_trace(x)
#define	attributes_name_mask   ((unsigned long)0)
#define	attributes_value_mask   ((unsigned long)0)
#define	attributes_trace(x)
#define	attributes_list_trace(x)
#define	common_trace(x)
Enumerations
enum	change_cause_ty {   change_cause_external_bug, change_cause_external_enhancement, change_cause_external_improvement, change_cause_internal_bug,   change_cause_internal_enhancement, change_cause_internal_improvement, change_cause_chain, change_cause_external_bug,   change_cause_external_enhancement, change_cause_external_improvement, change_cause_internal_bug, change_cause_internal_enhancement,   change_cause_internal_improvement, change_cause_chain, change_cause_external_bug, change_cause_external_enhancement,   change_cause_external_improvement, change_cause_internal_bug, change_cause_internal_enhancement, change_cause_internal_improvement,   change_cause_chain, change_cause_external_bug, change_cause_external_enhancement, change_cause_external_improvement,   change_cause_internal_bug, change_cause_internal_enhancement, change_cause_internal_improvement, change_cause_chain,   change_cause_external_bug, change_cause_external_enhancement, change_cause_external_improvement, change_cause_internal_bug,   change_cause_internal_enhancement, change_cause_internal_improvement, change_cause_chain, change_cause_external_bug,   change_cause_external_enhancement, change_cause_external_improvement, change_cause_internal_bug, change_cause_internal_enhancement,   change_cause_internal_improvement, change_cause_chain, change_cause_external_bug, change_cause_external_enhancement,   change_cause_external_improvement, change_cause_internal_bug, change_cause_internal_enhancement, change_cause_internal_improvement,   change_cause_chain }
enum	file_action_ty {   file_action_create, file_action_modify, file_action_remove, file_action_insulate,   file_action_transparent, file_action_create, file_action_modify, file_action_remove,   file_action_insulate, file_action_transparent, file_action_create, file_action_modify,   file_action_remove, file_action_insulate, file_action_transparent, file_action_create,   file_action_modify, file_action_remove, file_action_insulate, file_action_transparent,   file_action_create, file_action_modify, file_action_remove, file_action_insulate,   file_action_transparent, file_action_create, file_action_modify, file_action_remove,   file_action_insulate, file_action_transparent, file_action_create, file_action_modify,   file_action_remove, file_action_insulate, file_action_transparent }
enum	file_usage_ty {   file_usage_source, file_usage_config, file_usage_build, file_usage_test,   file_usage_manual_test, file_usage_source, file_usage_config, file_usage_build,   file_usage_test, file_usage_manual_test, file_usage_source, file_usage_config,   file_usage_build, file_usage_test, file_usage_manual_test, file_usage_source,   file_usage_config, file_usage_build, file_usage_test, file_usage_manual_test,   file_usage_source, file_usage_config, file_usage_build, file_usage_test,   file_usage_manual_test, file_usage_source, file_usage_config, file_usage_build,   file_usage_test, file_usage_manual_test, file_usage_source, file_usage_config,   file_usage_build, file_usage_test, file_usage_manual_test }
enum	history_version_encoding_ty {   history_version_encoding_none, history_version_encoding_quoted_printable, history_version_encoding_base64, history_version_encoding_none,   history_version_encoding_quoted_printable, history_version_encoding_base64, history_version_encoding_none, history_version_encoding_quoted_printable,   history_version_encoding_base64, history_version_encoding_none, history_version_encoding_quoted_printable, history_version_encoding_base64,   history_version_encoding_none, history_version_encoding_quoted_printable, history_version_encoding_base64, history_version_encoding_none,   history_version_encoding_quoted_printable, history_version_encoding_base64, history_version_encoding_none, history_version_encoding_quoted_printable,   history_version_encoding_base64 }
Functions
void	change_cause_write (const output::pointer &fp, const char *name, change_cause_ty value, bool show)
void	change_cause_write_xml (const output::pointer &fp, const char *name, change_cause_ty value, bool show)
const char *	change_cause_ename (change_cause_ty)
void	file_action_write (const output::pointer &fp, const char *name, file_action_ty value, bool show)
void	file_action_write_xml (const output::pointer &fp, const char *name, file_action_ty value, bool show)
const char *	file_action_ename (file_action_ty)
void	file_usage_write (const output::pointer &fp, const char *name, file_usage_ty value, bool show)
void	file_usage_write_xml (const output::pointer &fp, const char *name, file_usage_ty value, bool show)
const char *	file_usage_ename (file_usage_ty)
void	metric_write (const output::pointer &fp, const char *name, metric_ty *value)
void	metric_write_xml (const output::pointer &fp, const char *name, metric_ty *value)
metric_ty *	metric_copy (metric_ty *)
metric_ty *	metric_clone (metric_ty *)
metric_list_ty *	metric_list_copy (metric_list_ty *)
metric_list_ty *	metric_list_clone (metric_list_ty *)
void	metric_list_write (const output::pointer &fp, const char *name, metric_list_ty *value)
void	metric_list_write_xml (const output::pointer &fp, const char *name, metric_list_ty *value)
void	history_version_encoding_write (const output::pointer &fp, const char *name, history_version_encoding_ty value, bool show)
void	history_version_encoding_write_xml (const output::pointer &fp, const char *name, history_version_encoding_ty value, bool show)
const char *	history_version_encoding_ename (history_version_encoding_ty)
void	history_version_write (const output::pointer &fp, const char *name, history_version_ty *value)
void	history_version_write_xml (const output::pointer &fp, const char *name, history_version_ty *value)
history_version_ty *	history_version_copy (history_version_ty *)
history_version_ty *	history_version_clone (history_version_ty *)
void	attributes_write (const output::pointer &fp, const char *name, attributes_ty *value)
void	attributes_write_xml (const output::pointer &fp, const char *name, attributes_ty *value)
attributes_ty *	attributes_copy (attributes_ty *)
attributes_ty *	attributes_clone (attributes_ty *)
attributes_list_ty *	attributes_list_copy (attributes_list_ty *)
attributes_list_ty *	attributes_list_clone (attributes_list_ty *)
void	attributes_list_write (const output::pointer &fp, const char *name, attributes_list_ty *value)
void	attributes_list_write_xml (const output::pointer &fp, const char *name, attributes_list_ty *value)
void	common_write (const output::pointer &fp, common_ty *value)
void	common_write_xml (const output::pointer &fp, common_ty *value)
common_ty *	common_copy (common_ty *)
common_ty *	common_clone (common_ty *)
void	common_write_file (string_ty *filename, common_ty *value, int comp)
void	common_write_file (const nstring &filnam, common_ty *value, bool comp)
common_ty *	common_read_file (string_ty *filename)
common_ty *	common_read_file (const nstring &filename)
void	common__rpt_init (void)
Variables
meta_type	change_cause_type
meta_type	file_action_type
meta_type	file_usage_type
meta_type	metric_type
meta_type	metric_list_type
meta_type	history_version_encoding_type
meta_type	history_version_type
meta_type	attributes_type
meta_type	attributes_list_type
meta_type	common_type

---

Define Documentation

#define attributes_list_trace

(

x

)

Definition at line 225 of file common.h.

#define attributes_name_mask   ((unsigned long)0)

Definition at line 179 of file common.h.

#define attributes_trace

(

x

)

Definition at line 202 of file common.h.

#define attributes_value_mask   ((unsigned long)0)

Definition at line 180 of file common.h.

#define change_cause_max   7

Definition at line 31 of file common.h.

#define common_trace

(

x

)

Definition at line 250 of file common.h.

#define file_action_max   5

Definition at line 50 of file common.h.

#define file_usage_max   5

Definition at line 69 of file common.h.

#define history_version_encoding_mask   ((unsigned long)1 << 0)

Definition at line 151 of file common.h.

#define history_version_encoding_max   3

Definition at line 138 of file common.h.

#define history_version_revision_mask   ((unsigned long)0)

Definition at line 150 of file common.h.

#define history_version_trace

(

x

)

Definition at line 173 of file common.h.

#define metric_list_trace

(

x

)

Definition at line 127 of file common.h.

#define metric_name_mask   ((unsigned long)0)

Definition at line 81 of file common.h.

#define metric_trace

(

x

)

Definition at line 104 of file common.h.

#define metric_value_mask   ((unsigned long)1 << 0)

Definition at line 82 of file common.h.

---

Enumeration Type Documentation

enum change_cause_ty

Enumerator:

change_cause_external_bug
change_cause_external_enhancement
change_cause_external_improvement
change_cause_internal_bug
change_cause_internal_enhancement
change_cause_internal_improvement
change_cause_chain
change_cause_external_bug
change_cause_external_enhancement
change_cause_external_improvement
change_cause_internal_bug
change_cause_internal_enhancement
change_cause_internal_improvement
change_cause_chain
change_cause_external_bug
change_cause_external_enhancement
change_cause_external_improvement
change_cause_internal_bug
change_cause_internal_enhancement
change_cause_internal_improvement
change_cause_chain
change_cause_external_bug
change_cause_external_enhancement
change_cause_external_improvement
change_cause_internal_bug
change_cause_internal_enhancement
change_cause_internal_improvement
change_cause_chain
change_cause_external_bug
change_cause_external_enhancement
change_cause_external_improvement
change_cause_internal_bug
change_cause_internal_enhancement
change_cause_internal_improvement
change_cause_chain
change_cause_external_bug
change_cause_external_enhancement
change_cause_external_improvement
change_cause_internal_bug
change_cause_internal_enhancement
change_cause_internal_improvement
change_cause_chain
change_cause_external_bug
change_cause_external_enhancement
change_cause_external_improvement
change_cause_internal_bug
change_cause_internal_enhancement
change_cause_internal_improvement
change_cause_chain

Definition at line 21 of file common.h.

enum file_action_ty

Enumerator:

file_action_create
file_action_modify
file_action_remove
file_action_insulate
file_action_transparent
file_action_create
file_action_modify
file_action_remove
file_action_insulate
file_action_transparent
file_action_create
file_action_modify
file_action_remove
file_action_insulate
file_action_transparent
file_action_create
file_action_modify
file_action_remove
file_action_insulate
file_action_transparent
file_action_create
file_action_modify
file_action_remove
file_action_insulate
file_action_transparent
file_action_create
file_action_modify
file_action_remove
file_action_insulate
file_action_transparent
file_action_create
file_action_modify
file_action_remove
file_action_insulate
file_action_transparent

Definition at line 42 of file common.h.

enum file_usage_ty

Enumerator:

file_usage_source
file_usage_config
file_usage_build
file_usage_test
file_usage_manual_test
file_usage_source
file_usage_config
file_usage_build
file_usage_test
file_usage_manual_test
file_usage_source
file_usage_config
file_usage_build
file_usage_test
file_usage_manual_test
file_usage_source
file_usage_config
file_usage_build
file_usage_test
file_usage_manual_test
file_usage_source
file_usage_config
file_usage_build
file_usage_test
file_usage_manual_test
file_usage_source
file_usage_config
file_usage_build
file_usage_test
file_usage_manual_test
file_usage_source
file_usage_config
file_usage_build
file_usage_test
file_usage_manual_test

Definition at line 61 of file common.h.

enum history_version_encoding_ty

Enumerator:

history_version_encoding_none
history_version_encoding_quoted_printable
history_version_encoding_base64
history_version_encoding_none
history_version_encoding_quoted_printable
history_version_encoding_base64
history_version_encoding_none
history_version_encoding_quoted_printable
history_version_encoding_base64
history_version_encoding_none
history_version_encoding_quoted_printable
history_version_encoding_base64
history_version_encoding_none
history_version_encoding_quoted_printable
history_version_encoding_base64
history_version_encoding_none
history_version_encoding_quoted_printable
history_version_encoding_base64
history_version_encoding_none
history_version_encoding_quoted_printable
history_version_encoding_base64

Definition at line 132 of file common.h.

---

Function Documentation

attributes_ty* attributes_clone

(

attributes_ty *

)

attributes_ty* attributes_copy

(

attributes_ty *

)

attributes_list_ty* attributes_list_clone

(

attributes_list_ty *

)

attributes_list_ty* attributes_list_copy

(

attributes_list_ty *

)

void attributes_list_write	(	const output::pointer &	fp,
		const char *	name,
		attributes_list_ty *	value
	)

void attributes_list_write_xml	(	const output::pointer &	fp,
		const char *	name,
		attributes_list_ty *	value
	)

void attributes_write	(	const output::pointer &	fp,
		const char *	name,
		attributes_ty *	value
	)

void attributes_write_xml	(	const output::pointer &	fp,
		const char *	name,
		attributes_ty *	value
	)

const char* change_cause_ename

(

change_cause_ty

)

void change_cause_write	(	const output::pointer &	fp,
		const char *	name,
		change_cause_ty	value,
		bool	show
	)

void change_cause_write_xml	(	const output::pointer &	fp,
		const char *	name,
		change_cause_ty	value,
		bool	show
	)

void common__rpt_init

(

void

)

common_ty* common_clone

(

common_ty *

)

common_ty* common_copy

(

common_ty *

)

common_ty* common_read_file

(

const nstring &

filename

)

The common_read_file function is used to read common meta data from the named file.

Parameters:

filename

The name of the file to be read.

Returns:

a pointer to a dynamically allocated value read from the file.

Note:

If any errors are encountered, this function will not return. All errors (including syntax errors) will print a fatal error message, and exit with an exit status of 1.

common_ty* common_read_file

(

string_ty *

filename

)

The common_read_file function is used to read common meta data from the named file.

Parameters:

filename

The name of the file to be read.

Returns:

a pointer to a dynamically allocated value read from the file.

Note:

If any errors are encountered, this function will not return. All errors (including syntax errors) will print a fatal error message, and exit with an exit status of 1.

void common_write	(	const output::pointer &	fp,
		common_ty *	value
	)

void common_write_file	(	const nstring &	filnam,
		common_ty *	value,
		bool	comp
	)

The common_write_file function is used to write common meta data to the named file.

Parameters:

	filnam	The name of the file to be written.
	value	The value of the meta-data to be written.
	comp	true if data should be compressed.

Note:

If any errors are encountered, this function will not return. All errors will print a fatal error message, and exit with an exit status of 1.

void common_write_file	(	string_ty *	filename,
		common_ty *	value,
		int	comp
	)

The common_write_file function is used to write common meta data to the named file.

Parameters:

	filename	The name of the file to be written.
	value	The value of the meta-data to be written.
	comp	true (non-zero) if data should be compressed.

Note:

If any errors are encountered, this function will not return. All errors will print a fatal error message, and exit with an exit status of 1.

void common_write_xml	(	const output::pointer &	fp,
		common_ty *	value
	)

const char* file_action_ename

(

file_action_ty

)

void file_action_write	(	const output::pointer &	fp,
		const char *	name,
		file_action_ty	value,
		bool	show
	)

void file_action_write_xml	(	const output::pointer &	fp,
		const char *	name,
		file_action_ty	value,
		bool	show
	)

const char* file_usage_ename

(

file_usage_ty

)

void file_usage_write	(	const output::pointer &	fp,
		const char *	name,
		file_usage_ty	value,
		bool	show
	)

void file_usage_write_xml	(	const output::pointer &	fp,
		const char *	name,
		file_usage_ty	value,
		bool	show
	)

history_version_ty* history_version_clone

(

history_version_ty *

)

history_version_ty* history_version_copy

(

history_version_ty *

)

const char* history_version_encoding_ename

(

history_version_encoding_ty

)

void history_version_encoding_write	(	const output::pointer &	fp,
		const char *	name,
		history_version_encoding_ty	value,
		bool	show
	)

void history_version_encoding_write_xml	(	const output::pointer &	fp,
		const char *	name,
		history_version_encoding_ty	value,
		bool	show
	)

void history_version_write	(	const output::pointer &	fp,
		const char *	name,
		history_version_ty *	value
	)

void history_version_write_xml	(	const output::pointer &	fp,
		const char *	name,
		history_version_ty *	value
	)

metric_ty* metric_clone

(

metric_ty *

)

metric_ty* metric_copy

(

metric_ty *

)

metric_list_ty* metric_list_clone

(

metric_list_ty *

)

metric_list_ty* metric_list_copy

(

metric_list_ty *

)

void metric_list_write	(	const output::pointer &	fp,
		const char *	name,
		metric_list_ty *	value
	)

void metric_list_write_xml	(	const output::pointer &	fp,
		const char *	name,
		metric_list_ty *	value
	)

void metric_write	(	const output::pointer &	fp,
		const char *	name,
		metric_ty *	value
	)

void metric_write_xml	(	const output::pointer &	fp,
		const char *	name,
		metric_ty *	value
	)

---

Variable Documentation

meta_type attributes_list_type

meta_type attributes_type

meta_type change_cause_type

meta_type common_type

meta_type file_action_type

meta_type file_usage_type

meta_type history_version_encoding_type

meta_type history_version_type

meta_type metric_list_type

meta_type metric_type