/home/archives/aegis/branch.4/branch.25/delta28933.505/libaegis/change.h

Go to the documentation of this file.

//
// aegis - project change supervisor
// Copyright (C) 1995-2009, 2011, 2012 Peter Miller
// Copyright (C) 2007, 2008 Walter Franzini
//
// This program is free software; you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation; either version 3 of the License, or (at
// your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program. If not, see <http://www.gnu.org/licenses/>.
//

#ifndef LIBAEGIS_CHANGE_H
#define LIBAEGIS_CHANGE_H

#include <libaegis/cstate.fmtgen.h>
#include <libaegis/fstate.fmtgen.h>
#include <libaegis/pconf.fmtgen.h>
#include <libaegis/view_path.h>
#include <libaegis/zero.h>

class nstring_list; // forward

//
// Name of the project configuration file,
// relative to the baseline/devdir root.
//
#define THE_CONFIG_FILE_OLD "config"
#define THE_CONFIG_FILE_NEW "aegis.conf"

#include <libaegis/user.h>

//
// Define a magic number to represent the trunk transaction
// of the project.  It has an exceptional file name.
//
#define TRUNK_CHANGE_NUMBER ((long)((~(unsigned long)0) >> 1))

#define TIME_NOT_SET (time_t)0
#define UUID_NOT_SET (string_ty*)0

struct string_list_ty; // forward
struct sub_context_ty; // forward
struct symtab_ty; // forward
class project; // forward

class change
{
public:
    typedef change *pointer;

    long                reference_count;
    project          *pp;
    long                number;
    cstate_ty           *cstate_data;
    string_ty           *cstate_filename;
    int                 cstate_is_a_new_file;
    fstate_ty           *fstate_data;
    symtab_ty           *fstate_stp;
    symtab_ty           *fstate_uuid_stp;
    string_ty           *fstate_filename;
    fstate_ty           *pfstate_data;
    symtab_ty           *pfstate_stp;
    symtab_ty           *pfstate_uuid_stp;
    string_ty           *pfstate_filename;
    int                 fstate_is_a_new_file;
    string_ty           *top_path_unresolved;
    string_ty           *top_path_resolved;
    string_ty           *development_directory_unresolved;
    string_ty           *development_directory_resolved;
    string_ty           *integration_directory_unresolved;
    string_ty           *integration_directory_resolved;
    string_ty           *logfile;
    pconf_ty            *pconf_data;
    long                lock_magic;
    int                 bogus;
    string_ty           *architecture_name;
    string_list_ty      *file_list[view_path_MAX];
    bool                project_specific_setenv_performed;

    // NOTE: methods are sorted alphabetically.  To have methods
    // grouped, make sure they change their suffix rather than their
    // prefix.  E.g. thingumy_get and thingumy_set rather than
    // get_thingumy and set_thingumy.

    // ----------  A  ------------------------------------------------------

    nstring attributes_get(const nstring &name);

    bool attributes_get_boolean(const nstring &name);

    // ----------  B  ------------------------------------------------------

    nstring brief_description_get(void);

    // ----------  C  ------------------------------------------------------

    nstring copyright_years_get_string(void);

    time_t completion_timestamp(void);

    string_ty *creator_name(void);

    string_ty *cstate_filename_get(void);

    cstate_ty *cstate_get(void);

    void cstate_write(void);

    // ----------  D  ------------------------------------------------------

    long delta_number_get(void);

    nstring description_get(void);

    string_ty *developer_name(void);

    user_ty::pointer developer_user_get(void);

    // ----------  E  ------------------------------------------------------

    // ----------  F  ------------------------------------------------------

    bool file_exists(const nstring &filename);

    fstate_src_ty *file_find(const nstring &filename, view_path_ty vp);

    fstate_src_ty *file_find(fstate_src_ty *src, view_path_ty vp);

    fstate_src_ty *file_find(cstate_src_ty *src, view_path_ty vp);

    fstate_src_ty *file_find(const nstring &filename);

    fstate_src_ty *file_find_fuzzy(const nstring &filename, view_path_ty vp);

    fstate_src_ty *file_find_uuid(string_ty *uuid, view_path_ty view_path);

    fstate_src_ty *file_find_uuid(const nstring &uuid, view_path_ty view_path);

    fstate_src_ty *file_new(string_ty *file_name);

    fstate_src_ty *file_new(fstate_src_ty *meta);

    string_ty *file_path(string_ty *file_name);

    nstring file_path(const nstring &file_name);

    string_ty *file_path(fstate_src_ty *src);

    string_ty *file_path_by_uuid(string_ty *uuid);

    nstring file_path_by_uuid(const nstring &uuid);

    bool file_promote(void);

    string_ty *file_resolve_name(user_ty::pointer up, string_ty *file_name);

    nstring file_resolve_name(user_ty::pointer up, const nstring &file_name);

    void file_resolve_names(user_ty::pointer up, string_list_ty &file_names);

    bool file_unchanged(fstate_src_ty *src_data, user_ty::pointer up);

    bool file_is_config(string_ty *name);

    bool download_files_accessable(void);

private:
    void fimprove(fstate_ty *fstate_data);

public:
    fstate_ty *fstate_get(void);

    // ----------  G  ------------------------------------------------------

    int gid_get() const;

    // ----------  H  ------------------------------------------------------

    // ----------  I  ------------------------------------------------------

    nstring integration_directory_get(bool resolve);

    string_ty *integrator_name(void);

    bool is_a_branch(void);

    bool is_awaiting_development(void);

    bool is_being_developed(void);

    bool is_being_integrated(void);

    bool is_completed(void);

    // ----------  J  ------------------------------------------------------

    // ----------  K  ------------------------------------------------------

    // ----------  L  ------------------------------------------------------

    // ----------  M  ------------------------------------------------------

    // ----------  N  ------------------------------------------------------

    // ----------  O  ------------------------------------------------------

    // ----------  P  ------------------------------------------------------

    nstring pconf_attributes_find(const nstring &name);

    bool pconf_attributes_get_boolean(const nstring &name, bool dflt = false);

    nstring pconf_copyright_owner_get(void);

    fstate_ty *pfstate_get(void);

    void project_specific_setenv_performed_set(void);

    bool project_specific_setenv_performed_get() const;

    // ----------  Q  ------------------------------------------------------

    // ----------  R  ------------------------------------------------------

    string_ty *reviewer_name(void);

    bool run_project_file_command_needed(void);

    void run_project_file_command(const user_ty::pointer &up);

    void run_project_file_command_done(void);

    void run_new_file_command(string_list_ty *slp, const user_ty::pointer &up);

    void run_new_file_undo_command(string_list_ty *slp,
        const user_ty::pointer &up);

    void run_new_test_command(string_list_ty *slp,
        const user_ty::pointer &up);

    void run_new_test_undo_command(string_list_ty *slp,
        const user_ty::pointer &up);

    void run_copy_file_command(string_list_ty *slp, const user_ty::pointer &up);

    void run_copy_file_undo_command(string_list_ty *slp,
        const user_ty::pointer &up);

    void run_remove_file_command(string_list_ty *slp,
        const user_ty::pointer &up);

    void run_remove_file_undo_command(string_list_ty *slp,
        const user_ty::pointer &up);

    void run_make_transparent_command(string_list_ty *slp,
        const user_ty::pointer &up);

    void run_make_transparent_undo_command(string_list_ty *slp,
        const user_ty::pointer &up);

    void run_forced_develop_begin_notify_command(const user_ty::pointer &up);

    void run_develop_end_notify_command(void);

    void run_develop_end_undo_notify_command(void);

    void run_review_begin_notify_command(void);

    void run_review_begin_undo_notify_command(void);

    void run_review_pass_notify_command(void);

    void run_review_pass_undo_notify_command(void);

    void run_review_fail_notify_command(void);

    void run_integrate_pass_notify_command(void);

    void run_integrate_fail_notify_command(void);

    void run_develop_begin_early_command(user_ty::pointer up);

    void run_develop_begin_command(user_ty::pointer up);

    // ----------  S  ------------------------------------------------------

    void search_path_get(string_list_ty *result, bool resolve);

    void search_path_get(nstring_list &result, bool resolve);

    // ----------  T  ------------------------------------------------------

    time_t time_limit_get(void);

    int umask_get() const;

    // ----------  U  ------------------------------------------------------

    nstring uuid_get(void);

    void uuid_get_list(nstring_list &uuids);

    // ----------  V  ------------------------------------------------------

    nstring version_debian_get(void);

    nstring version_rpm_get(void);

    nstring version_get(void);

    // ----------  W  ------------------------------------------------------

    bool was_a_branch(void);

    // ----------  X  ------------------------------------------------------

    // ----------  Y  ------------------------------------------------------

    // ----------  Z  ------------------------------------------------------

    // ---------------------------------------------------------------------
    // PLEASE keep the above method declarations in alphabetical order.

    //
    // If you add instance variables to this class, don't forget to update
    // change_alloc()     in libaegis/change/alloc.cc
    // change_free()      in libaegis/change/free.cc
    // change_lock_sync() in libaegis/change/lock_sync.cc
    //
};

change::pointer change_alloc(project *, long);
void change_free(change::pointer );
change::pointer change_copy(change::pointer );
void change_bind_existing(change::pointer );
int change_bind_existing_errok(change::pointer );
void change_bind_new(change::pointer );
change::pointer change_bogus(project *);

cstate_history_ty *change_history_new(change::pointer , user_ty::pointer );

void change_top_path_set(change::pointer , string_ty *);
void change_top_path_set(change::pointer , const nstring &);
void change_development_directory_set(change::pointer , string_ty *);
void change_integration_directory_set(change::pointer , string_ty *);
string_ty *change_top_path_get(change::pointer , int);
string_ty *change_development_directory_get(change::pointer , int);
string_ty *change_integration_directory_get(change::pointer , int);
string_ty *change_logfile_basename(void);
string_ty *change_logfile_get(change::pointer );
void change_cstate_lock_prepare(change::pointer );
void change_error(change::pointer , sub_context_ty *, const char *);
void change_fatal(change::pointer , sub_context_ty *, const char *) NORETURN;
void change_verbose(change::pointer , sub_context_ty *, const char *);

void change_warning(change::pointer , sub_context_ty *, const char *);

void change_warning_obsolete_field(change::pointer cp, string_ty *errpos,
    const char *old_field, const char *new_field);

pconf_ty *change_pconf_get(change::pointer , int);

// use cp->run_new_file_command instead
void change_run_new_file_command(change::pointer cp, string_list_ty *slp,
    user_ty::pointer up) DEPRECATED;

// use cp->run_new_file_undo_command instead
void change_run_new_file_undo_command(change::pointer cp, string_list_ty *slp,
    user_ty::pointer up) DEPRECATED;

// use cp->run_new_test_command instead
void change_run_new_test_command(change::pointer cp, string_list_ty *slp,
    user_ty::pointer up) DEPRECATED;

// use cp->run_new_test_undo_command instead
void change_run_new_test_undo_command(change::pointer cp, string_list_ty *slp,
    user_ty::pointer up) DEPRECATED;

// use cp->run_copy_file_command instead
void change_run_copy_file_command(change::pointer cp, string_list_ty *slp,
    user_ty::pointer up) DEPRECATED;

// use cp->run_copy_file_undo_command instead
void change_run_copy_file_undo_command(change::pointer cp, string_list_ty *slp,
    user_ty::pointer up) DEPRECATED;

// use cp->run_remove_file_command instead
void change_run_remove_file_command(change::pointer cp, string_list_ty *slp,
    user_ty::pointer up) DEPRECATED;

// use cp->run_remove_file_undo_command instead
void change_run_remove_file_undo_command(change::pointer cp,
    string_list_ty *slp, user_ty::pointer up) DEPRECATED;

// use cp->run_make_transparent_command instead
void change_run_make_transparent_command(change::pointer cp,
    string_list_ty *slp, user_ty::pointer up) DEPRECATED;

// use cp->run_make_transparent_undo_command instead
void change_run_make_transparent_undo_command(change::pointer cp,
    string_list_ty *slp, user_ty::pointer up) DEPRECATED;

// use vp->run_project_file_command_needed() instead
int change_run_project_file_command_needed(change::pointer cp) DEPRECATED;

// use cp->run_project_file_command(up) instead
void change_run_project_file_command(change::pointer cp, user_ty::pointer up)
    DEPRECATED;

// use cp->run_forced_develop_begin_notify_command instead
void change_run_forced_develop_begin_notify_command(change::pointer cp,
    user_ty::pointer up) DEPRECATED;

// use cp->run_develop_end_notify_command instead
void change_run_develop_end_notify_command(change::pointer cp) DEPRECATED;

// use cp->run_develop_end_undo_notify_command instead
void change_run_develop_end_undo_notify_command(change::pointer cp) DEPRECATED;

// use cp->run_review_begin_notify_command instead
void change_run_review_begin_notify_command(change::pointer cp) DEPRECATED;

// use cp->run_review_begin_undo_notify_command
void change_run_review_begin_undo_notify_command(change::pointer cp) DEPRECATED;

// use cp->run_review_pass_notify_command instead
void change_run_review_pass_notify_command(change::pointer cp) DEPRECATED;

// use cp->run_review_pass_undo_notify_command instead
void change_run_review_pass_undo_notify_command(change::pointer cp) DEPRECATED;

// use cp->run_review_fail_notify_command instead
void change_run_review_fail_notify_command(change::pointer cp) DEPRECATED;

// use cp->run_integrate_pass_notify_command instead
void change_run_integrate_pass_notify_command(change::pointer cp) DEPRECATED;

// use cp->run_integrate_fail_notify_command instead
void change_run_integrate_fail_notify_command(change::pointer cp) DEPRECATED;

void change_run_history_get_command(change::pointer cp, fstate_src_ty *src,
    string_ty *output_file, user_ty::pointer up);
void change_run_history_create_command(change::pointer cp, fstate_src_ty *);
void change_run_history_put_command(change::pointer cp, fstate_src_ty *);

string_ty *change_run_history_query_command(change::pointer cp,
    fstate_src_ty *src);

void change_run_history_label_command(change::pointer cp, fstate_src_ty *,
    string_ty *label);

void change_run_history_transaction_begin_command(change::pointer cp);

void change_run_history_transaction_end_command(change::pointer cp);

void change_run_history_transaction_abort_command(change::pointer cp);

void change_history_trashed_fingerprints(change::pointer , string_list_ty *);
void change_run_diff_command(change::pointer cp, user_ty::pointer up,
    string_ty *original, string_ty *input, string_ty *output);
void change_run_diff3_command(change::pointer cp, user_ty::pointer up,
    string_ty *original, string_ty *most_recent, string_ty *input,
    string_ty *output);
void change_run_merge_command(change::pointer cp, user_ty::pointer up,
    string_ty *original, string_ty *most_recent, string_ty *input,
    string_ty *output);
void change_run_patch_diff_command(change::pointer cp, user_ty::pointer up,
    string_ty *original, string_ty *input, string_ty *output,
    string_ty *index_name);
void change_run_annotate_diff_command(change::pointer cp, user_ty::pointer up,
    string_ty *original, string_ty *input, string_ty *output,
    string_ty *index_name, const char *diff_option);
int change_has_merge_command(change::pointer );
void change_run_integrate_begin_command(change::pointer );
void change_run_integrate_begin_undo_command(change::pointer );

void change_run_develop_begin_command(change::pointer cp, user_ty::pointer up)
    DEPRECATED;

void change_run_develop_begin_undo_command(change::pointer cp,
    user_ty::pointer up);
int change_run_test_command(change::pointer cp, user_ty::pointer up,
    string_ty *, string_ty *, int, int,
    const nstring_list &variable_assignments);
int change_run_development_test_command(change::pointer cp, user_ty::pointer up,
    string_ty *, string_ty *, int, int,
    const nstring_list &variable_assignments);
void change_run_build_command(change::pointer );
void change_run_build_time_adjust_notify_command(change::pointer );
void change_run_development_build_command(change::pointer , user_ty::pointer ,
    string_list_ty *);

void change_run_develop_end_policy_command(change::pointer cp,
    user_ty::pointer up);

string_ty *change_file_whiteout(change::pointer , string_ty *);
void change_file_whiteout_write(change::pointer cp, string_ty *path,
    user_ty::pointer up);
void change_become(change::pointer );
void change_become_undo(change::pointer cp);
void change_developer_become(change::pointer );
void change_developer_become_undo(change::pointer cp);

void change_development_directory_clear(change::pointer );
void change_integration_directory_clear(change::pointer );
void change_architecture_clear(change::pointer );
void change_architecture_add(change::pointer , string_ty *);
void change_architecture_query(change::pointer );
string_ty *change_architecture_name(change::pointer , int);
string_ty *change_run_architecture_discriminator_command(change::pointer cp);
cstate_architecture_times_ty *change_architecture_times_find(change::pointer ,
                                                             string_ty *);
void change_build_time_set(change::pointer );

void change_test_time_set(change::pointer cp, time_t when);

void change_test_time_set(change::pointer cp, string_ty *variant, time_t when);

void change_test_baseline_time_set(change::pointer cp, time_t when);

void change_test_baseline_time_set(change::pointer cp, string_ty *variant,
    time_t when);

void change_regression_test_time_set(change::pointer cp, time_t when,
    string_ty *arch_name = 0);

void change_test_times_clear(change::pointer );
void change_build_times_clear(change::pointer );
void change_architecture_from_pconf(change::pointer );

const char *change_outstanding_builds(change::pointer , time_t);
const char *change_outstanding_tests(change::pointer , time_t);
const char *change_outstanding_tests_baseline(change::pointer , time_t);
const char *change_outstanding_tests_regression(change::pointer , time_t);

int change_pathconf_name_max(change::pointer );
string_ty *change_filename_check(change::pointer , string_ty *);

void change_create_symlinks_to_baseline(change::pointer , user_ty::pointer ,
    const work_area_style_ty &);

void change_maintain_symlinks_to_baseline(change::pointer cp,
    user_ty::pointer up, bool undoing = false);

void change_remove_symlinks_to_baseline(change::pointer , user_ty::pointer ,
    const work_area_style_ty &);

void change_rescind_test_exemption(change::pointer );

string_ty *change_fstate_filename_get(change::pointer cp);

string_ty *change_pfstate_filename_get(change::pointer cp);

void change_rescind_test_exemption_undo(change::pointer );
void change_force_regression_test_exemption(change::pointer );
void change_force_regression_test_exemption_undo(change::pointer );

void change_check_architectures(change::pointer );
string_ty *change_new_test_filename_get(change::pointer , long, int);
string_ty *change_development_directory_template(change::pointer ,
                                                 user_ty::pointer );
string_ty *change_metrics_filename_pattern_get(change::pointer );

void change_uuid_set(change::pointer cp);

void change_uuid_clear(change::pointer cp);

void change_reviewer_list(change::pointer cp, string_list_ty &result);

bool change_reviewer_already(change::pointer cp, string_ty *login);

bool change_reviewer_already(change::pointer cp, const nstring &login);

time_t change_when_get(change::pointer cp, cstate_history_what_ty what);

bool change_diff_required(change::pointer cp);

bool change_build_required(change::pointer cp, bool conf_exists = true);

// vim: set ts=8 sw=4 et :
#endif // LIBAEGIS_CHANGE_H