libaegis/project.h File Reference

#include <common/ac/time.h>
#include <libaegis/pattr.h>
#include <libaegis/pstate.h>
#include <libaegis/view_path.h>
#include <libaegis/change.h>

Go to the source code of this file.

Data Structures
class	project_ty
class	project
Functions
project_ty *	project_alloc (string_ty *name)
void	project_bind_existing (project_ty *pp)
bool	project_bind_existing_errok (project_ty *pp)
project_ty *	project_bind_branch (project_ty *ppp, change::pointer bp)
void	project_bind_new (project_ty *pp)
void	project_list_get (struct string_list_ty *)
void	project_list_inner (struct string_list_ty *result, project_ty *pp)
project_ty *	project_find_branch (project_ty *pp, const char *number)
void	project_free (project_ty *)
string_ty *	project_name_get (project_ty *pp)
project_ty *	project_copy (project_ty *)
change::pointer	project_change_get (project_ty *pp)
string_ty *	project_home_path_get (project_ty *pp)
string_ty *	project_Home_path_get (project_ty *)
string_ty *	project_top_path_get (project_ty *, int)
nstring	project_rss_path_get (project_ty *pp, bool resolve=false)
void	project_home_path_set (project_ty *pp, string_ty *dir)
string_ty *	project_baseline_path_get (project_ty *pp, bool resolve=false)
string_ty *	project_history_path_get (project_ty *pp)
string_ty *	project_history_filename_get (project_ty *, struct fstate_src_ty *)
string_ty *	project_info_path_get (project_ty *pp)
string_ty *	project_changes_path_get (project_ty *pp)
string_ty *	project_change_path_get (project_ty *, long)
string_ty *	project_pstate_path_get (project_ty *pp)
pstate_ty *	project_pstate_get (project_ty *pp)
void	project_pstate_write (project_ty *pp)
void	project_pstate_write_top (project_ty *)
void	project_pstate_lock_prepare (project_ty *pp)
void	project_pstate_lock_prepare_top (project_ty *)
void	project_baseline_read_lock_prepare (project_ty *)
void	project_baseline_write_lock_prepare (project_ty *)
void	project_history_lock_prepare (project_ty *)
void	project_error (project_ty *, struct sub_context_ty *, const char *)
void	project_fatal (project_ty *, struct sub_context_ty *, const char *)
void	project_verbose (project_ty *, struct sub_context_ty *, const char *)
void	project_change_append (project_ty *, long, int)
void	project_change_delete (project_ty *, long)
int	project_change_number_in_use (project_ty *, long)
string_ty *	project_version_short_get (project_ty *)
string_ty *	project_version_get (project_ty *)
int	project_uid_get (project_ty *pp)
int	project_gid_get (project_ty *pp)
user_ty::pointer	project_user (project_ty *)
void	project_become (project_ty *)
void	project_become_undo (project_ty *pp)
long	project_next_test_number_get (project_ty *)
int	project_is_readable (project_ty *)
long	project_minimum_change_number_get (project_ty *)
void	project_minimum_change_number_set (project_ty *, long)
bool	project_reuse_change_numbers_get (project_ty *)
void	project_reuse_change_numbers_set (project_ty *, bool)
long	project_minimum_branch_number_get (project_ty *)
void	project_minimum_branch_number_set (project_ty *, long)
bool	project_skip_unlucky_get (project_ty *)
void	project_skip_unlucky_set (project_ty *, bool)
bool	project_compress_database_get (project_ty *)
void	project_compress_database_set (project_ty *, bool)
int	project_develop_end_action_get (project_ty *)
void	project_develop_end_action_set (project_ty *, int)
bool	project_protect_development_directory_get (project_ty *)
void	project_protect_development_directory_set (project_ty *, bool)
int	break_up_version_string (const char *, long *, int, int *, int)
void	extract_version_from_project_name (string_ty **, long *, int, int *)
int	project_name_ok (string_ty *)
pconf_ty *	project_pconf_get (project_ty *)
project_ty *	project_new_branch (project_ty *pp, user_ty::pointer up, long change_number, string_ty *topdir=0, string_ty *reason=0)
void	project_file_list_invalidate (project_ty *pp)
string_ty *	project_brief_description_get (project_ty *)
change::pointer	project_uuid_find (project_ty *pp, string_ty *uuid)

---

Function Documentation

int break_up_version_string	(	const char *	,
		long *	,
		int	,
		int *	,
		int
	)

void extract_version_from_project_name	(	string_ty **	,
		long *	,
		int	,
		int *
	)

project_ty* project_alloc

(

string_ty *

name

)

string_ty* project_baseline_path_get	(	project_ty *	pp,
		bool	resolve = false
	)			[inline]

Definition at line 854 of file project.h.

void project_baseline_read_lock_prepare

(

project_ty *

)

void project_baseline_write_lock_prepare

(

project_ty *

)

void project_become

(

project_ty *

)

void project_become_undo

(

project_ty *

pp

)

project_ty* project_bind_branch	(	project_ty *	ppp,
		change::pointer	bp
	)			[inline]

Definition at line 784 of file project.h.

void project_bind_existing

(

project_ty *

pp

)

[inline]

Definition at line 772 of file project.h.

bool project_bind_existing_errok

(

project_ty *

pp

)

[inline]

Definition at line 778 of file project.h.

void project_bind_new

(

project_ty *

pp

)

[inline]

Definition at line 790 of file project.h.

string_ty* project_brief_description_get

(

project_ty *

)

void project_change_append	(	project_ty *	,
		long	,
		int
	)

void project_change_delete	(	project_ty *	,
		long
	)

change::pointer project_change_get

(

project_ty *

pp

)

[inline]

Definition at line 820 of file project.h.

int project_change_number_in_use	(	project_ty *	,
		long
	)

string_ty* project_change_path_get	(	project_ty *	,
		long
	)

string_ty* project_changes_path_get

(

project_ty *

pp

)

[inline]

Definition at line 882 of file project.h.

bool project_compress_database_get

(

project_ty *

)

void project_compress_database_set	(	project_ty *	,
		bool
	)

project_ty* project_copy

(

project_ty *

)

int project_develop_end_action_get

(

project_ty *

)

void project_develop_end_action_set	(	project_ty *	,
		int
	)

void project_error	(	project_ty *	,
		struct sub_context_ty *	,
		const char *
	)

void project_fatal	(	project_ty *	,
		struct sub_context_ty *	,
		const char *
	)

void project_file_list_invalidate

(

project_ty *

pp

)

[inline]

Definition at line 993 of file project.h.

project_ty* project_find_branch	(	project_ty *	pp,
		const char *	number
	)			[inline]

Definition at line 804 of file project.h.

void project_free

(

project_ty *

)

int project_gid_get

(

project_ty *

pp

)

[inline]

Definition at line 937 of file project.h.

string_ty* project_history_filename_get	(	project_ty *	,
		struct fstate_src_ty *
	)

The project_history_filename_get function is used to determine the absolute path pf the file used to contain the history of the given file.

Returns:

a pointer to a string. You are required to str_free this string when you are done with it.

void project_history_lock_prepare

(

project_ty *

)

string_ty* project_history_path_get

(

project_ty *

pp

)

[inline]

Definition at line 860 of file project.h.

string_ty* project_Home_path_get

(

project_ty *

)

string_ty* project_home_path_get

(

project_ty *

pp

)

[inline]

Definition at line 826 of file project.h.

void project_home_path_set	(	project_ty *	pp,
		string_ty *	dir
	)			[inline]

Definition at line 848 of file project.h.

string_ty* project_info_path_get

(

project_ty *

pp

)

[inline]

Definition at line 876 of file project.h.

int project_is_readable

(

project_ty *

)

void project_list_get

(

struct string_list_ty *

)

void project_list_inner	(	struct string_list_ty *	result,
		project_ty *	pp
	)			[inline]

Definition at line 798 of file project.h.

long project_minimum_branch_number_get

(

project_ty *

)

void project_minimum_branch_number_set	(	project_ty *	,
		long
	)

long project_minimum_change_number_get

(

project_ty *

)

void project_minimum_change_number_set	(	project_ty *	,
		long
	)

string_ty* project_name_get

(

project_ty *

pp

)

[inline]

Definition at line 812 of file project.h.

int project_name_ok

(

string_ty *

)

project_ty* project_new_branch	(	project_ty *	pp,
		user_ty::pointer	up,
		long	change_number,
		string_ty *	topdir = 0,
		string_ty *	reason = 0
	)

The project_new_branch function is used to create new branches.

Parameters:

	pp	The project to create the branch below.
	up	The authorised user requesting the new branch.
	change_number	The change number to use for the new branch.
	topdir	The change (branch) directory, It is in the same place as the rest of the project, unless otherwise specified (i.e. not NULL). This makes it easy to collect the whole project tree, branches, info and all, in a simple tar or cpio command for archiving or moving.
	reason	The reason the user gave on the command line, or NULL for no reason to be attached to the change's history.

Returns:

A pointer to the new project represented by the new branch.

long project_next_test_number_get

(

project_ty *

)

pconf_ty* project_pconf_get

(

project_ty *

)

bool project_protect_development_directory_get

(

project_ty *

)

void project_protect_development_directory_set	(	project_ty *	,
		bool
	)

pstate_ty* project_pstate_get

(

project_ty *

pp

)

[inline]

Definition at line 897 of file project.h.

void project_pstate_lock_prepare

(

project_ty *

pp

)

[inline]

Definition at line 911 of file project.h.

void project_pstate_lock_prepare_top

(

project_ty *

)

string_ty* project_pstate_path_get

(

project_ty *

pp

)

[inline]

Definition at line 891 of file project.h.

void project_pstate_write

(

project_ty *

pp

)

[inline]

Definition at line 903 of file project.h.

void project_pstate_write_top

(

project_ty *

)

bool project_reuse_change_numbers_get

(

project_ty *

)

void project_reuse_change_numbers_set	(	project_ty *	,
		bool
	)

nstring project_rss_path_get	(	project_ty *	pp,
		bool	resolve = false
	)

The project_rss_path_get function is used to get the path of the RSS directory for the given project.

Parameters:

	pp	The project in question
	resolve	Whether or not to resolve symlinks in the path.

Returns:

a string containing the absolute path

bool project_skip_unlucky_get

(

project_ty *

)

void project_skip_unlucky_set	(	project_ty *	,
		bool
	)

string_ty* project_top_path_get	(	project_ty *	,
		int
	)

int project_uid_get

(

project_ty *

pp

)

[inline]

Definition at line 931 of file project.h.

user_ty::pointer project_user

(

project_ty *

)

change::pointer project_uuid_find	(	project_ty *	pp,
		string_ty *	uuid
	)

The project_uuid_find function is used to locate a change given its UUID.

Parameters:

	pp	The project to search. Will rewind to the trunk project before the search commences.
	uuid	The change UUID to search for.

Returns:

a pointer to the change with th given UUID, or NULL if no change has the given UUID.

void project_verbose	(	project_ty *	,
		struct sub_context_ty *	,
		const char *
	)

string_ty* project_version_get

(

project_ty *

)

string_ty* project_version_short_get

(

project_ty *

)