workspace.c File Reference

#include "private.h"
#include "pipsdbm_private.h"

Include dependency graph for workspace.c:

Go to the source code of this file.

Macros
#define	WORKSPACE_NAME_CHARS    "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789-_"
	the workspace name must be composed of the following characters. More...
#define	MD_DATABASE   "database"
#define	METADATA   "Metadata"
#define	DATABASE_STATUS   "STATUS"
#define	DATABASE_SYMBOLS   "SYMBOLS"
#define	DATABASE_MISC   "MISC"
#define	DATABASE_NEWGEN   "NEWGEN" /**newgen type translation data... */
#define	ONERROR(cond, what)    if (cond) { what; return false; }

Functions
bool	workspace_name_p (const char *name)
	workspace.c More...
static void	db_set_current_workspace_name (const char *name)
static void	db_reset_current_workspace_name (void)
static void	db_reset_current_workspace_name_if_necessary (void)
string	db_get_current_workspace_name (void)
	the function is used to check that there is some current workspace... More...
string	db_get_workspace_directory_name (const char *name)
	returns an allocated string. More...
string	db_get_current_workspace_directory (void)
int	db_inc_logical_time (void)
	0 means not set... More...
int	db_get_logical_time (void)
static void	db_set_logical_time (int time)
static void	db_reset_logical_time (void)
string	db_get_meta_data_directory ()
	The syntax of a property list. More...
static string	meta_data_db_file_name (string data)
static void	reset_meta_data (void)
	reset all meta data on failures. More...
static bool	save_meta_data (bool do_free)
	save (and maybe free) metadata. More...
static bool	load_meta_data (void)
	load metadata from workspace. More...
bool	workspace_exists_p (const char *name)
bool	workspace_ok_p (const char *name)
bool	db_create_workspace (const char *name)
static void	db_close_module (string what, string oname, bool do_free)
	stores all resources of module oname. More...
static void	db_save_workspace (string what, bool do_free)
void	db_checkpoint_workspace (void)
bool	db_close_workspace (bool is_quit)
bool	db_open_workspace (const char *name)

Variables
static string	current_workspace_name = NULL
	the workspace has a name. More...
static int	logical_time = 1

Macro Definition Documentation

DATABASE_MISC

#define DATABASE_MISC   "MISC"

Definition at line 136 of file workspace.c.

DATABASE_NEWGEN

#define DATABASE_NEWGEN   "NEWGEN" /**newgen type translation data... */

Definition at line 137 of file workspace.c.

DATABASE_STATUS

#define DATABASE_STATUS   "STATUS"

Definition at line 134 of file workspace.c.

DATABASE_SYMBOLS

#define DATABASE_SYMBOLS   "SYMBOLS"

Definition at line 135 of file workspace.c.

MD_DATABASE

#define MD_DATABASE   "database"

Definition at line 88 of file workspace.c.

METADATA

#define METADATA   "Metadata"

Definition at line 132 of file workspace.c.

ONERROR

#define ONERROR	(		cond,
			what
	)		if (cond) { what; return false; }

Definition at line 205 of file workspace.c.

WORKSPACE_NAME_CHARS

#define WORKSPACE_NAME_CHARS    "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789-_"

the workspace name must be composed of the following characters.

Definition at line 43 of file workspace.c.

Function Documentation

db_checkpoint_workspace()

void db_checkpoint_workspace

(

void

)

load ENTITIES (since no one ask for them as they should...)

Definition at line 350 of file workspace.c.

{
    debug_on(PIPSDBM_DEBUG_LEVEL);
    pips_debug(1, "Checkpointing workspace %s\n", 
               db_get_current_workspace_name());
 
    db_save_workspace("Saving", false); 
 
    /* load ENTITIES (since no one ask for them as they should...)
     */
    if (db_resource_p(DBR_ENTITIES, "")) 
        (void) db_get_memory_resource(DBR_ENTITIES, "", true);
 
    ifdebug(1) dump_all_db_resource_status(stderr, "db_checkpoint_workspace");
    debug_off();
}

References db_get_current_workspace_name(), db_get_memory_resource(), db_resource_p(), db_save_workspace(), debug_off, debug_on, dump_all_db_resource_status(), ifdebug, pips_debug, and PIPSDBM_DEBUG_LEVEL.

Referenced by checkpoint_workspace().

Here is the call graph for this function:

Here is the caller graph for this function:

db_close_module()

static void db_close_module ( string  what, string  oname, bool  do_free  )

static

stores all resources of module oname.

log if necessary.

Definition at line 318 of file workspace.c.

{
  // the download order is retrieved from the methods...
  int nr = dbll_number_of_resources(), i;
 
  if (!same_string_p(oname, "")) /* log if necessary. */
    user_log("  %s module %s.\n", what, oname);
 
  for (i=0; i<nr; i++)
  {
    db_save_and_free_memory_resource_if_any
            (dbll_get_ith_resource_name(i), oname, do_free);
  }
}

References db_save_and_free_memory_resource_if_any(), dbll_get_ith_resource_name(), dbll_number_of_resources(), same_string_p, and user_log().

Referenced by db_save_workspace(), and main().

Here is the call graph for this function:

Here is the caller graph for this function:

db_close_workspace()

bool db_close_workspace

(

bool

is_quit

)

free?

Parameters

is_quit

s_quit

Definition at line 367 of file workspace.c.

{
    debug_on(PIPSDBM_DEBUG_LEVEL);
    pips_debug(1, "Closing workspace %s\n", db_get_current_workspace_name());
 
    db_save_workspace("Closing", /* free? */ !is_quit);
    db_reset_current_workspace_name();
 
    pips_debug(1, "done\n");
    debug_off();
    return true;
}

References db_get_current_workspace_name(), db_reset_current_workspace_name(), db_save_workspace(), debug_off, debug_on, pips_debug, and PIPSDBM_DEBUG_LEVEL.

Referenced by create(), main(), make_close_workspace(), make_open_workspace(), old_reductions(), tpips_internal_error(), and tpips_user_error().

Here is the call graph for this function:

Here is the caller graph for this function:

db_create_workspace()

bool db_create_workspace

(

const char *

name

)

Parameters

name

ame

Definition at line 282 of file workspace.c.

{
  bool ok;
  string dir_name;
  debug_on(PIPSDBM_DEBUG_LEVEL);
 
  dir_name = db_get_workspace_directory_name(name);
 
  pips_debug(1, "workspace %s in directory %s\n", name, dir_name);
 
  if ((ok = purge_directory(dir_name)))
  {
    if ((ok = create_directory(dir_name)))
    {
            db_set_current_workspace_name(name);
            db_create_pips_database();
    }
    else
    {
            pips_user_warning("could not create directory %s\n", dir_name);
    }
  }
  else
  {
    pips_user_warning("could not remove old directory %s\n", dir_name);
  }
 
  free(dir_name);
  pips_debug(1, "done\n");
 
  debug_off();
  return ok;
}

References create_directory(), db_create_pips_database(), db_get_workspace_directory_name(), db_set_current_workspace_name(), debug_off, debug_on, free(), ok, pips_debug, pips_user_warning, PIPSDBM_DEBUG_LEVEL, and purge_directory().

Referenced by create(), end_create_workspace_notify(), execute_workspace_creation_and_so_on_given_with_options(), and pips_main().

Here is the call graph for this function:

Here is the caller graph for this function:

db_get_current_workspace_directory()

string db_get_current_workspace_directory

(

void

)

Definition at line 96 of file workspace.c.

{
    string ws_name = db_get_current_workspace_name();
    pips_assert("some current workspace", ws_name);
    return db_get_workspace_directory_name(ws_name);
}

db_get_current_workspace_name()

string db_get_current_workspace_name

(

void

)

the function is used to check that there is some current workspace...

Definition at line 82 of file workspace.c.

{
    return current_workspace_name;
}

References current_workspace_name.

Referenced by activate_phase(), check_delete_workspace(), checkpoint_workspace(), close_workspace(), close_workspace_if_opened(), create(), create_workspace(), db_checkpoint_workspace(), db_close_workspace(), db_get_current_workspace_directory(), edit_notify(), end_create_workspace_notify(), end_delete_workspace_notify(), epips_select_module(), generate_a_directory_menu(), generate_module_menu(), get_module_names(), get_view_file(), hpfc_get_file_list(), hpfc_install(), info(), lazy_open_module(), load_meta_data(), make_close_workspace(), make_open_workspace(), old_reductions(), open_module(), open_module_if_unique(), open_or_create_workspace(), open_workspace(), open_workspace_notify(), options_select(), perform(), quit_notify(), save_meta_data(), send_the_names_of_the_available_modules_to_emacs(), show_workspace(), start_create_workspace_notify(), start_delete_workspace_notify(), start_directory_notify(), tp_close_the_workspace(), tp_some_info(), and tpips_user_error().

Here is the caller graph for this function:

db_get_logical_time()

int db_get_logical_time

(

void

)

Definition at line 112 of file workspace.c.

{
    return logical_time; 
}

References logical_time.

Referenced by db_check_time(), db_put_or_update_memory_resource(), db_set_resource_as_required(), db_touch_resource(), db_update_time(), and save_meta_data().

Here is the caller graph for this function:

db_get_meta_data_directory()

string db_get_meta_data_directory

(

void

)

The syntax of a property list.

FC 2015-07-19 include "pipsdbm.h" avoid include cycle pipsdbm -> properties -> pipsdbm there is still a link cycle.

Definition at line 139 of file workspace.c.

{
    return db_get_directory_name_for_module(METADATA);
}

Referenced by meta_data_db_file_name().

Here is the caller graph for this function:

db_get_workspace_directory_name()

string db_get_workspace_directory_name

(

const char *

name

)

returns an allocated string.

Parameters

name

ame

Definition at line 91 of file workspace.c.

{
    return strdup(concatenate("./", name, "." MD_DATABASE, NULL)); 
}

References concatenate(), MD_DATABASE, and strdup().

Referenced by db_create_workspace(), db_get_current_workspace_directory(), db_open_workspace(), workspace_exists_p(), and workspace_ok_p().

Here is the call graph for this function:

Here is the caller graph for this function:

db_inc_logical_time()

int db_inc_logical_time

(

void

)

0 means not set...

Definition at line 107 of file workspace.c.

{
    return logical_time++; 
}

References logical_time.

Referenced by db_check_time(), and update_preserved_resources().

Here is the caller graph for this function:

db_open_workspace()

bool db_open_workspace

(

const char *

name

)

failure!

load ENTITIES (since no one ask for them as they should;-)

should touch them somehow to force latter saving?

Parameters

name

ame

Definition at line 380 of file workspace.c.

{
    bool ok = true;
    string dir_name;
    debug_on(PIPSDBM_DEBUG_LEVEL);
    pips_debug(1, "Opening workspace %s\n", name);
 
    dir_name = db_get_workspace_directory_name(name);
    if (directory_exists_p(dir_name))
    {
        db_set_current_workspace_name(name);
        ok = load_meta_data();
        
        if (!ok)  /* failure! */
        {
            reset_meta_data();
            pips_user_warning("Cannot load workspace metadata for %s.\n",
                              name);
        }
 
        /* load ENTITIES (since no one ask for them as they should;-) */
        if (ok && db_resource_p(DBR_ENTITIES, "")) {
            (void) db_get_memory_resource(DBR_ENTITIES, "", true);
            /* should touch them somehow to force latter saving? */
        }
    }
    else ok = false;
 
    pips_debug(1, "done (%d)\n", ok);
    debug_off();
    free(dir_name);
    return ok;
}

References db_get_memory_resource(), db_get_workspace_directory_name(), db_resource_p(), db_set_current_workspace_name(), debug_off, debug_on, directory_exists_p(), free(), load_meta_data(), ok, pips_debug, pips_user_warning, PIPSDBM_DEBUG_LEVEL, and reset_meta_data().

Referenced by main(), make_open_workspace(), and old_reductions().

Here is the call graph for this function:

Here is the caller graph for this function:

db_reset_current_workspace_name()

static void db_reset_current_workspace_name ( void  )

static

Definition at line 69 of file workspace.c.

{
    pips_assert("some current workspace", current_workspace_name);
    free(current_workspace_name), current_workspace_name = NULL;
}

References current_workspace_name, free(), and pips_assert.

Referenced by db_close_workspace(), and db_reset_current_workspace_name_if_necessary().

Here is the call graph for this function:

Here is the caller graph for this function:

db_reset_current_workspace_name_if_necessary()

static void db_reset_current_workspace_name_if_necessary ( void  )

static

Definition at line 75 of file workspace.c.

{
    if (current_workspace_name) db_reset_current_workspace_name();
}

References current_workspace_name, and db_reset_current_workspace_name().

Referenced by reset_meta_data().

Here is the call graph for this function:

Here is the caller graph for this function:

db_reset_logical_time()

static void db_reset_logical_time ( void  )

static

Definition at line 123 of file workspace.c.

{
    logical_time = 0;
}

References logical_time.

Referenced by reset_meta_data().

Here is the caller graph for this function:

db_save_workspace()

static void db_save_workspace ( string  what, bool  do_free  )

static

ENTITIES are saved here...

Definition at line 333 of file workspace.c.

{
  gen_array_t a;
 
  user_log("%s all modules.\n", what);
  a = db_get_module_list();
  GEN_ARRAY_FOREACH(string, module, a)
    db_close_module(what, module, do_free);
  gen_array_full_free(a);
 
  user_log("%s program.\n", what);
  db_close_module(what, "", do_free); /* ENTITIES are saved here... */
 
  user_log("%s workspace.\n", what);
  save_meta_data(do_free);
}

References db_close_module(), db_get_module_list(), GEN_ARRAY_FOREACH, gen_array_full_free(), module, save_meta_data(), and user_log().

Referenced by db_checkpoint_workspace(), and db_close_workspace().

Here is the call graph for this function:

Here is the caller graph for this function:

db_set_current_workspace_name()

static void db_set_current_workspace_name ( const char *  name )

static

Definition at line 60 of file workspace.c.

{
    if (current_workspace_name)
        pips_internal_error("current workspace %s not closed", 
                            current_workspace_name);
    pips_assert("valid workspace name", workspace_name_p(name));
    current_workspace_name = strdup(name);
}

References current_workspace_name, pips_assert, pips_internal_error, strdup(), and workspace_name_p().

Referenced by db_create_workspace(), and db_open_workspace().

Here is the call graph for this function:

Here is the caller graph for this function:

db_set_logical_time()

static void db_set_logical_time ( int  time )

static

Definition at line 117 of file workspace.c.

{
    pips_assert("positive time set", time>=1);
    logical_time = time;
}

References logical_time, and pips_assert.

Referenced by load_meta_data().

Here is the caller graph for this function:

load_meta_data()

static bool load_meta_data ( void  )

static

load metadata from workspace.

Returns

whether successful.

Definition at line 211 of file workspace.c.

{
    string file_name, ws_name;
    FILE * file;
    int time;
    bool ok;
 
    pips_debug(2, "loading newgen type translation data\n");
    file_name = meta_data_db_file_name(DATABASE_NEWGEN);
    if (file_exists_p(file_name))
      gen_type_translation_read(file_name);
    else
      pips_user_warning("no newgen type translation file...");
    free(file_name);
    
    pips_debug(2, "loading database misc data\n");
    file_name = meta_data_db_file_name(DATABASE_MISC);
    file = check_fopen(file_name, "r");
    ONERROR(!file,/* nope */)
    ONERROR(fscanf(file, "%d\n", &time)!=1,
            pips_internal_error("fscanf failed"))
    db_set_logical_time(time);
    ws_name = safe_readline(file);
    if (!same_string_p(ws_name, db_get_current_workspace_name()))
        pips_user_warning("Workspace %s has been moved to %s\n", 
                          ws_name, db_get_current_workspace_name());
    free(ws_name);
    safe_fclose(file, file_name);
    free(file_name);
 
    pips_debug(2, "loading database symbols\n");
    file_name = meta_data_db_file_name(DATABASE_SYMBOLS);
    file = check_fopen(file_name, "r");
    ONERROR(!file,/* nope */)
    read_tabulated_db_symbol(file);
            
    safe_fclose(file, file_name);
    free(file_name);
 
    pips_debug(2, "loading database status\n");
    file_name = meta_data_db_file_name(DATABASE_STATUS);
    file = check_fopen(file_name, "r");
    ONERROR(!file,/* nope */)
    ok = db_open_pips_database(file);
    ONERROR(!ok, pips_user_error("Could not read database content!"))
    safe_fclose(file, file_name);
    free(file_name);
    
    pips_debug(2, "done\n");
 
    return true;
}

References check_fopen(), DATABASE_MISC, DATABASE_NEWGEN, DATABASE_STATUS, DATABASE_SYMBOLS, db_get_current_workspace_name(), db_open_pips_database(), db_set_logical_time(), file_exists_p(), file_name, free(), gen_type_translation_read(), meta_data_db_file_name(), ok, ONERROR, pips_debug, pips_internal_error, pips_user_error, pips_user_warning, read_tabulated_db_symbol(), safe_fclose(), safe_readline(), and same_string_p.

Referenced by db_open_workspace().

Here is the call graph for this function:

Here is the caller graph for this function:

meta_data_db_file_name()

static string meta_data_db_file_name ( string  data )

static

Definition at line 144 of file workspace.c.

{
    string dir_name = db_get_meta_data_directory(),
        res = strdup(concatenate(dir_name, "/" MD_DATABASE ".", data, NULL));
    free(dir_name); return res;
}

References concatenate(), db_get_meta_data_directory(), free(), MD_DATABASE, and strdup().

Referenced by load_meta_data(), and save_meta_data().

Here is the call graph for this function:

Here is the caller graph for this function:

reset_meta_data()

static void reset_meta_data ( void  )

static

reset all meta data on failures.

what about db_symbols?

Definition at line 153 of file workspace.c.

{
    db_reset_current_workspace_name_if_necessary();
    db_reset_logical_time();
    /* what about db_symbols? */
    db_reset_pips_database_if_necessary();
}

References db_reset_current_workspace_name_if_necessary(), db_reset_logical_time(), and db_reset_pips_database_if_necessary().

Referenced by db_open_workspace().

Here is the call graph for this function:

Here is the caller graph for this function:

save_meta_data()

static bool save_meta_data ( bool  do_free )

static

save (and maybe free) metadata.

Returns

whether sucessful.

Definition at line 164 of file workspace.c.

{
    string file_name;
    FILE * file;
 
    pips_debug(2, "saving database status\n");
    file_name = meta_data_db_file_name(DATABASE_STATUS);
    file = safe_fopen(file_name, "w");
    db_save_pips_database(file);
    safe_fclose(file, file_name);
    free(file_name);
 
    if (do_free) db_close_pips_database();
 
    pips_debug(2, "saving database symbols\n");
    file_name = meta_data_db_file_name(DATABASE_SYMBOLS);
    file = safe_fopen(file_name, "w");
    write_tabulated_db_symbol(file);
    safe_fclose(file, file_name);
    free(file_name);
 
    if (do_free) gen_free_tabulated(db_symbol_domain);
 
    pips_debug(2, "saving database misc data\n");
    file_name = meta_data_db_file_name(DATABASE_MISC);
    file = safe_fopen(file_name, "w");
    fprintf(file, "%d\n%s\n", 
            db_get_logical_time(), db_get_current_workspace_name());
    safe_fclose(file, file_name);
    free(file_name);
 
    pips_debug(2, "saving newgen type translation data\n");
    file_name = meta_data_db_file_name(DATABASE_NEWGEN);
    gen_type_translation_write(file_name);
    free(file_name);
    
    pips_debug(2, "done\n");
 
    return true;
}

References DATABASE_MISC, DATABASE_NEWGEN, DATABASE_STATUS, DATABASE_SYMBOLS, db_close_pips_database(), db_get_current_workspace_name(), db_get_logical_time(), db_save_pips_database(), db_symbol_domain, file_name, fprintf(), free(), gen_free_tabulated(), gen_type_translation_write(), meta_data_db_file_name(), pips_debug, safe_fclose(), safe_fopen(), and write_tabulated_db_symbol().

Referenced by db_save_workspace().

Here is the call graph for this function:

Here is the caller graph for this function:

workspace_exists_p()

bool workspace_exists_p

(

const char *

name

)

Parameters

name

ame

Definition at line 266 of file workspace.c.

{
    string full_name = db_get_workspace_directory_name(name);
    bool result = directory_exists_p(full_name);
    free(full_name); 
    return result;
}

References db_get_workspace_directory_name(), directory_exists_p(), free(), and full_name.

Referenced by continue_create_workspace_notify(), create(), and open_workspace().

Here is the call graph for this function:

Here is the caller graph for this function:

workspace_name_p()

bool workspace_name_p

(

const char *

name

)

workspace.c

Parameters

name

ame

Definition at line 46 of file workspace.c.

{
    return strlen(name)==strspn(name, WORKSPACE_NAME_CHARS);
}

References WORKSPACE_NAME_CHARS.

Referenced by continue_create_workspace_notify(), db_set_current_workspace_name(), end_create_workspace_notify(), and open_or_create_workspace().

Here is the caller graph for this function:

workspace_ok_p()

bool workspace_ok_p

(

const char *

name

)

Parameters

name

ame

Definition at line 274 of file workspace.c.

{
    string full_name = db_get_workspace_directory_name(name);
    bool result = file_readable_p(full_name);
    free(full_name);
    return result;
}

References db_get_workspace_directory_name(), file_readable_p(), free(), and full_name.

Referenced by open_workspace().

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

current_workspace_name

string current_workspace_name = NULL

static

the workspace has a name.

{set,reset,get}_workspace

Definition at line 58 of file workspace.c.

Referenced by db_get_current_workspace_name(), db_reset_current_workspace_name(), db_reset_current_workspace_name_if_necessary(), and db_set_current_workspace_name().

logical_time

int logical_time = 1

static

Definition at line 105 of file workspace.c.

Referenced by db_get_logical_time(), db_inc_logical_time(), db_reset_logical_time(), and db_set_logical_time().