|
Aegis
4.25.D505
|
#include <change.h>
| typedef change* change::pointer |
The pointer typedef is provided so that clients of this interface may use change::pointer everywhere they need to point at a change instance, and only this typedef needs to be edited to use a variety of smart pointer instead.
| nstring change::attributes_get | ( | const nstring & | name | ) |
The attributes_get method is used to obtain the value of an attribute of this change set.
| name | The name of the attribute. Attribute names are not case sensitive. |
| bool change::attributes_get_boolean | ( | const nstring & | name | ) |
The attributes_get_boolean method is used to obtain the value of an attribute of this change set, as a true/false attribute.
| name | The name of the attribute. Attribute names are not case sensitive. |
| nstring change::brief_description_get | ( | void | ) |
The brief_description_get method is used to obtain the brief description of this change set.
| time_t change::completion_timestamp | ( | void | ) |
The completion_timestamp method is used to obtain the time that the change set completed integration, or "now" if it is not yet complete. use the is_completed method to distinguish the two cases.
The copyright_years_get_string is used to get a string containing the list fo copyrigth years, a union of the project's copyright years and this change set's copyright years.
| string_ty* change::creator_name | ( | void | ) |
The creator_name method is used to obtain the Unix name of the user that created this change.
| string_ty* change::cstate_filename_get | ( | void | ) |
The cstate_filename_get method is used to obtain the name of the file containing cstate meta-data of this change.
| cstate_ty* change::cstate_get | ( | void | ) |
The cstate_get method may be used to obtain the cstate meta-data of this change.
| void change::cstate_write | ( | void | ) |
THe cstate_write method may be used to write the cstate meta-data of this change
| long change::delta_number_get | ( | void | ) |
The delta_number_get method is used to get the delta number of a change, or zero if the change is not yet completed.
| nstring change::description_get | ( | void | ) |
The description_get method is used to obtain the long description of this change set.
| string_ty* change::developer_name | ( | void | ) |
The developer_name method is used to obtain the Unix name of the developer of this change.
The developer_user_get method is used to obtain a user_ty instance representing the (most recent) developer of this change set.
| bool change::download_files_accessable | ( | void | ) |
The download_files_acessable method may be used to to determine whether or not the calling user has permission to access the change set's download files. This usually means read and search premission on the development directory and/or the integration director, unless the change set is in the completed state.
| bool change::file_exists | ( | const nstring & | filename | ) |
The file_exists method is used to determine whether or not a file exists in the change set. (view_path == view_path_first)
| filename | The base-relative name of the file to search for. |
| fstate_src_ty* change::file_find | ( | const nstring & | filename, |
| view_path_ty | vp | ||
| ) |
The file_find method is used to locate a change file similar to the file named.
| filename | The name of the file to be found. |
| vp | The style of view path to be used. |
| fstate_src_ty* change::file_find | ( | fstate_src_ty * | src, |
| view_path_ty | vp | ||
| ) |
The file_find method is used to locate a change file similar to the one indicated. If possible it uses the UUID otherwise (for backwards compatibility) it uses the file name.
| src | The meta-data of the file to be found. |
| vp | The style of view path to be used. |
| fstate_src_ty* change::file_find | ( | cstate_src_ty * | src, |
| view_path_ty | vp | ||
| ) |
The file_find method is used to locate a change file similar to the one indicated. If possible it uses the UUID otherwise (for backwards compatibility) it uses the file name.
| src | The meta-data of the file to be found. |
| vp | The style of view path to be used. |
| fstate_src_ty* change::file_find | ( | const nstring & | filename | ) |
The file_find method is used to locate a change file similar to the file named, in the change set itself (view_path == view_path_first).
| filename | The name of the file to be found. |
| fstate_src_ty* change::file_find_fuzzy | ( | const nstring & | filename, |
| view_path_ty | vp | ||
| ) |
The file_find_fuzzy method is used to locate a change file with a name similar to the one given.
| filename | The name of the file to be found. |
| vp | The style of view path to be used. |
| fstate_src_ty* change::file_find_uuid | ( | string_ty * | uuid, |
| view_path_ty | view_path | ||
| ) |
The file_find_uuid method is used to find a source file given the UUID.
| uuid | The UUID to search for. |
| view_path | The style and depth of search for the file. |
| fstate_src_ty* change::file_find_uuid | ( | const nstring & | uuid, |
| view_path_ty | view_path | ||
| ) |
The file_find_uuid method is used to find a source file given the UUID.
| uuid | The UUID to search for. |
| view_path | The style and depth of search for the file. |
| bool change::file_is_config | ( | string_ty * | name | ) |
The file_is_config method is used to determine whether or not the named file is a configuration file.
| name | The name of the file of interest |
| fstate_src_ty* change::file_new | ( | string_ty * | file_name | ) |
The file_new method is used to add a new file to a change set's file manifest. No checking is poerformed, it is up to the caller to ensure that the name is unique.
| file_name | The name of the file to be created. |
| fstate_src_ty* change::file_new | ( | fstate_src_ty * | meta | ) |
The file_new method is used to add a new file to a change set's file manifest. No checking is poerformed, it is up to the caller to ensure that the file name and UUID are unique. Typically this is used when adding a project file to a change set for modification or removal.
| meta | The meta-data of the file to be created. |
| string_ty* change::file_path | ( | string_ty * | file_name | ) |
The file_path method is used to obtain the absolute path to the given change file.
| file_name | The name of the file in question. |
| nstring change::file_path | ( | const nstring & | file_name | ) |
The file_path method is used to obtain the absolute path to the given change file.
| file_name | The name of the file in question. |
| string_ty* change::file_path | ( | fstate_src_ty * | src | ) |
The file_path method is used to obtain the absolute path to the given change file.
| src | The meta-data of the file in question. |
| string_ty* change::file_path_by_uuid | ( | string_ty * | uuid | ) |
The file_path_by_uuid method is used to obtain the absolute path to the given change file.
| uuid | The UUID of the file in question. |
| nstring change::file_path_by_uuid | ( | const nstring & | uuid | ) |
The file_path_by_uuid method is used to obtain the absolute path to the given change file.
| uuid | The UUID of the file in question. |
| bool change::file_promote | ( | void | ) |
The file_promote method is used to check whether or not recent integrations have change the actions the change files must perform.
If two changes are creating the same file, the first one integrated means that the second one must update its action to "modify".
If two changes are removing the same file, the first one integrated means that the second one needs to drop the file from its list.
If one change is removing a file, and a second change is modifying the same file, after the first change is integrated, the second change must update its action to "create".
| string_ty* change::file_resolve_name | ( | user_ty::pointer | up, |
| string_ty * | file_name | ||
| ) |
The file_resolve_name method is used to resolve an arbitrary UNIX pathname (relative or absolute) into a base relative path within a change set's search path.
| up | The user invoking the program. |
| file_name | The file name to be resolved. |
| nstring change::file_resolve_name | ( | user_ty::pointer | up, |
| const nstring & | file_name | ||
| ) |
The file_resolve_name method is used to resolve an arbitrary UNIX pathname (relative or absolute) into a base relative path within a change set's search path.
| up | The user invoking the program. |
| file_name | The file name to be resolved. |
| void change::file_resolve_names | ( | user_ty::pointer | up, |
| string_list_ty & | file_names | ||
| ) |
The file_resolve_names method is used to resolve arbitrary UNIX pathnames (relative or absolute) into base relative paths within a change set's search path.
| up | The user invoking the program. |
| file_names | The file names to be resolved. This parameter ISN'T const because this will be done in situ. |
| bool change::file_unchanged | ( | fstate_src_ty * | src_data, |
| user_ty::pointer | up | ||
| ) |
The file_unchanged method is used to determine whether a source file is unchanged compared to the file in the baseline.
| src_data | The file in question. |
| up | The user to perform file actions as. |
| void change::fimprove | ( | fstate_ty * | fstate_data | ) | [private] |
The fimprove method is used to cope with previous versions of the file meta data, and rewrite them to conform to later expectations.
| fstate_data | The file meta data to be massaged. |
| fstate_ty* change::fstate_get | ( | void | ) |
The fstate_get method is used to obtain a current value for the change file state symbol table.
| int change::gid_get | ( | ) | const |
The gid_get method is used to obtain the Unix group id of the change owner.
| nstring change::integration_directory_get | ( | bool | resolve | ) |
The integration_directory_get method may be used to obtain the change's integration directory path. It is an error if the change is not in the 'being integrated' state.
| resolve | whether or not to resolve symlinks in the path. |
| string_ty* change::integrator_name | ( | void | ) |
The integrator_name method is used to obtain the Unix group name of the integrator.
| bool change::is_a_branch | ( | void | ) |
The is_a_branch method is used to determine whether or not this change set is an active branch. If you want to know if it was ever an active branch (e.g. now completed) use the was_a_branch method.
| bool change::is_awaiting_development | ( | void | ) |
The is_awaiting_development method returns true if the given change is in the awaiting development state, and false if it is not.
| bool change::is_being_developed | ( | void | ) |
The is_being_developed method returns true if the given change is in the being developed state, and false if it is not.
| bool change::is_being_integrated | ( | void | ) |
The is_being_integrated method is used to determine whether or not this is in the being integrated state.
| bool change::is_completed | ( | void | ) |
The change_is_completed function returns true (non-zero) if this change is in the completed state, and false (zero) if it is not.
| nstring change::pconf_attributes_find | ( | const nstring & | name | ) |
The pconf_attributes_get method is used to obtain the value of an attribute of the project, from the project configuration file. It could be in this change, or it could be in a baseline or an ancestor baseline.
| name | The name of the attribute. Attribute names are not case sensitive. |
| bool change::pconf_attributes_get_boolean | ( | const nstring & | name, |
| bool | dflt = false |
||
| ) |
The pconf_attributes_get_boolean method is used to obtain the value of an attribute of the project, from the project configuration file. It could be in this change, or it could be in a baseline or an ancestor baseline.
| name | The name of the attribute. Attribute names are not case sensitive. |
| dflt | The default value to return if no attribute available. |
| nstring change::pconf_copyright_owner_get | ( | void | ) |
The pconf_copyright_owner_get method is used to obtain the name of the copyright holder of a project.
| fstate_ty* change::pfstate_get | ( | void | ) |
The pfstate_get method is used to obtain the project file state information for a change set. This is all of the project files, not just one.
| bool change::project_specific_setenv_performed_get | ( | ) | const |
The project_specific_setenv_performed_get method is used to know if the environment variable(s), specified as project_specific attributes, has been already exported.
| void change::project_specific_setenv_performed_set | ( | void | ) |
The project_specific_setenv_performed_set method is used to remember if the environment variable(s), specified as project_specific attributes, has been already exported.
| string_ty* change::reviewer_name | ( | void | ) |
The reviewer_name method is used to determine the Unix name of the (last) reviewer.
| void change::run_copy_file_command | ( | string_list_ty * | slp, |
| const user_ty::pointer & | up | ||
| ) |
The run_copy_file_command method is used to run the command in the copy_file_command field of the aegis.conf file.
| slp | The list of filenames affected. |
| up | the user to run the program as |
| void change::run_copy_file_undo_command | ( | string_list_ty * | slp, |
| const user_ty::pointer & | up | ||
| ) |
The run_copy_file_undo_command method is used to run the command in the copy_file_undo_command field of the aegis.conf file.
| slp | The list of filenames affected. |
| up | the user to run the program as |
The run_develop_begin_command method is used to run the develop_begin_command from the projetc configuration file. This is used by the aedb command, just all other actions performed by aedb.
| up | The user to run the command as. |
The run_develop_begin_early_command method is used to run the develop_begin_early_command from the project configuration file. This is used by the aedb command, just after the development directory has been created.
| up | The user to run the command as. |
| void change::run_develop_end_notify_command | ( | void | ) |
The run_develop_end_notify_command method is used to run the command in the develop_end_notify_command field of the aegis.conf file.
| void change::run_develop_end_undo_notify_command | ( | void | ) |
The run_develop_end_undo_notify_command method is used to run the command in the develop_end_undo_notify_command field of the aegis.conf file.
| void change::run_forced_develop_begin_notify_command | ( | const user_ty::pointer & | up | ) |
The run_forced_develop_begin_notify_command method is used to run the command in the forced_develop_begin_notify_command field of the aegis.conf file.
| up | the user to run the program as |
| void change::run_integrate_fail_notify_command | ( | void | ) |
The run_integrate_fail_notify_command method is used to run the command in the integrate_fail_notify_command field of the aegis.conf file.
| void change::run_integrate_pass_notify_command | ( | void | ) |
The run_integrate_pass_notify_command method is used to run the command in the integrate_pass_notify_command field of the aegis.conf file.
| void change::run_make_transparent_command | ( | string_list_ty * | slp, |
| const user_ty::pointer & | up | ||
| ) |
The run_make_transparent_command method is used to run the command in the make_transparent_command field of the aegis.conf file.
| slp | The list of filenames affected. |
| up | the user to run the program as |
| void change::run_make_transparent_undo_command | ( | string_list_ty * | slp, |
| const user_ty::pointer & | up | ||
| ) |
The run_make_transparent_undo_comman method is used to run the command in the make_transparent_undo_command field of the aegis.conf file.
| slp | The list of filenames affected. |
| up | the user to run the program as |
| void change::run_new_file_command | ( | string_list_ty * | slp, |
| const user_ty::pointer & | up | ||
| ) |
The run_new_file_command method is used to run the new_file_command field of the aegis.conf file.
| slp | The list of new file names |
| up | Th euser to run the command as. |
| void change::run_new_file_undo_command | ( | string_list_ty * | slp, |
| const user_ty::pointer & | up | ||
| ) |
The run_new_file_undo_command method is used to run the command in the new_file_undo_command field of the aegis.conf file.
| slp | The list of filenames affected. |
| up | the user to run the program as |
| void change::run_new_test_command | ( | string_list_ty * | slp, |
| const user_ty::pointer & | up | ||
| ) |
The run_new_test_command method is used to run the command in the new_test_command field of the aegis.conf file.
| slp | The list of filenames affected. |
| up | the user to run the program as |
| void change::run_new_test_undo_command | ( | string_list_ty * | slp, |
| const user_ty::pointer & | up | ||
| ) |
The run_new_test_undo_command method is used to run the command in the new_test_undo_command field of the aegis.conf file.
| slp | The list of filenames affected. |
| up | the user to run the program as |
| void change::run_project_file_command | ( | const user_ty::pointer & | up | ) |
The run_project_file_command method is used to run the command configured in the aegis.conf file's project_file_command field.
| up | The user to run the command as. |
| void change::run_project_file_command_done | ( | void | ) |
The run_project_file_command_done method is used to remember that the project_file comman has been (is about to be) called recently.
| bool change::run_project_file_command_needed | ( | void | ) |
The run_project_file_command_needed method may be used to determine whether or not the project_file_command needstosed in recent integration history.
| void change::run_remove_file_command | ( | string_list_ty * | slp, |
| const user_ty::pointer & | up | ||
| ) |
The run_remove_file_command method is used to run the command in the remove_file_command field of the aegis.conf file.
| slp | The list of filenames affected. |
| up | the user to run the program as |
| void change::run_remove_file_undo_command | ( | string_list_ty * | slp, |
| const user_ty::pointer & | up | ||
| ) |
The run_remove_file_undo_command method is used to run the command in the remove_file_undo_command field of the aegis.conf file.
| slp | The list of filenames affected. |
| up | the user to run the program as |
| void change::run_review_begin_notify_command | ( | void | ) |
The run_review_begin_notify_command method is used to run the command in the review_begin_notify_command field of the aegis.conf file.
| void change::run_review_begin_undo_notify_command | ( | void | ) |
The run_review_begin_undo_notify_command method is used to run the command in the review_begin_undo_notify_command field of the aegis.conf file.
| void change::run_review_fail_notify_command | ( | void | ) |
The run_review_fail_notify_command method is used to run the command in the review_fail_notify_command field of the aegis.conf file.
| void change::run_review_pass_notify_command | ( | void | ) |
The run_review_pass_notify_command method is used to run the command in the review_pass_notify_command field of the aegis.conf file.
| void change::run_review_pass_undo_notify_command | ( | void | ) |
The run_review_pass_undo_notify_command method is used to run the command in the review_pass_undo_notify_command field of the aegis.conf file.
| void change::search_path_get | ( | string_list_ty * | result, |
| bool | resolve | ||
| ) |
The search_path_get method may be used to obtain the search path (list of progressively more out-of-date ancestor branches) within which to search for files.
| result | Where to append the additional directories. |
| resolve | Whether or not to expand synbolic links within paths. |
| void change::search_path_get | ( | nstring_list & | result, |
| bool | resolve | ||
| ) |
The search_path_get method may be used to obtain the search path (list of progressively more out-of-date ancestor branches) within which to search for files.
| result | Where to append the additional directories. |
| resolve | Whether or not to expand synbolic links within paths. |
| time_t change::time_limit_get | ( | void | ) |
| int change::umask_get | ( | ) | const |
The umask method is used to obtain the umask for this change.
| nstring change::uuid_get | ( | void | ) |
The uuid_get method is used to obtain the UUID of this change set.
| void change::uuid_get_list | ( | nstring_list & | uuids | ) |
The uuid_get_list method is used to obtain all of the UUIDs associated with this change set. This includes the change set's UUID, if it has one, and all of the aoriginal-uuid attributes.
| uuids | Where to put all of the UUIDs associated with this change set. |
| nstring change::version_debian_get | ( | void | ) |
The version_debian_get method is used to get the version of this change set, in Debian format. In particular, it makes being-developed change sets look like they are "release candidates" for the next project delta, otherwise business as usual.
| nstring change::version_get | ( | void | ) |
The version_get method is used to get the version of this change set. This will consist of the branch name (1.2) combined with ether a delta number (.D123) or, for incomplete changes, a change number (.C123).
| nstring change::version_rpm_get | ( | void | ) |
The version_rpm_get method is used to get the version of this change set, in RPM format. In particular, it makes being-developed change sets look like they are "branched from" for the current project delta, otherwise business as usual.
| bool change::was_a_branch | ( | void | ) |
The was_a_branch method is used to determine whether or not this change set is, or was ever, an active branch. If you want to know if it is a currently active branch (beging_developed) use the is_a_branch method.
| int change::bogus |
| long change::lock_magic |
| long change::number |
1.7.6.1