generate Class Reference

#include <generate.h>

Inheritance diagram for generate:

List of all members.

Public Member Functions
virtual	~generate ()
	generate ()
void	files (int argc, char **argv, output::pointer op, rfc822 &meta)
Static Public Member Functions
static generate *	factory (const rcstring &name)
static rcstring	relative_to (const rcstring &from_here, const rcstring &to_here)
Protected Member Functions
virtual void	begin (output::pointer op, rfc822 &meta)=0
virtual void	file (output::pointer op, const rcstring &filename, rfc822 &meta)=0
virtual void	end (output::pointer op)=0
Static Protected Member Functions
static void	print_meta (output::pointer op, rfc822 &meta)
static rcstring	get_project_name ()
Private Member Functions
	generate (const generate &)
generate &	operator= (const generate &)

---

Detailed Description

The generate class is used to represent an action to be performed by icomp-index

Definition at line 30 of file generate.h.

---

Constructor & Destructor Documentation

virtual generate::~generate

(

)

[virtual]

The destructor.

generate::generate

(

)

The default constructor.

generate::generate

(

const generate &

)

[private]

The copy constructor.

---

Member Function Documentation

void generate::files	(	int	argc,
		char **	argv,
		output::pointer	op,
		rfc822 &	meta
	)

The files method is used to process all of the files on the command line.

Parameters:

	argc	The number of files
	argv	Each of the file names
	op	The stream to write the output on
	meta	the accompanying meta data

static generate* generate::factory

(

const rcstring &

name

)

[static]

The factory class method is used to create new dynamically allocated instances of this class.

Parameters:

name

The name of the generator to create.

static rcstring generate::relative_to	(	const rcstring &	from_here,
		const rcstring &	to_here
	)			[static]

The relative_to class method is used to turn files names into relative files names, suitable for symlinks or anchor href attributes.

Parameters:

	from_here	The source of the reference
	to_here	The destination of the reference

virtual void generate::begin	(	output::pointer	op,
		rfc822 &	meta
	)			[protected, pure virtual]

The begin method is called by the files method before processing each of the files.

Parameters:

	op	The stream to write the output on
	meta	the accompanying meta data

Implemented in generate_catalogue_depends, generate_catalogue_html, generate_closure, generate_image_depends, generate_image_html, generate_index_depends, and generate_index_html.

virtual void generate::file	(	output::pointer	op,
		const rcstring &	filename,
		rfc822 &	meta
	)			[protected, pure virtual]

The file method is called by the files method once for each of the files.

Parameters:

	op	The stream to write the output on
	filename	the name of the file
	meta	the accompanying meta data

Implemented in generate_catalogue_depends, generate_catalogue_html, generate_closure, generate_image_depends, generate_image_html, generate_index_depends, and generate_index_html.

virtual void generate::end

(

output::pointer

op

)

[protected, pure virtual]

The end method is called by the files method after processing each of the files.

Parameters:

op

The stream to write the output on

Implemented in generate_catalogue_depends, generate_catalogue_html, generate_closure, generate_image_depends, generate_image_html, generate_index_depends, and generate_index_html.

static void generate::print_meta	(	output::pointer	op,
		rfc822 &	meta
	)			[static, protected]

static rcstring generate::get_project_name

(

)

[static, protected]

The get_project_name method may be used to obtain the name of the current project, often used to build URLs of other CGI script invokations.

generate& generate::operator=

(

const generate &

)

[private]

The assignment operator.

---

The documentation for this class was generated from the following file:

• /home/archives/icon-compositor/branch.0/branch.0/delta7447.209/icomp-index/generate.h

---