top-level.h File Reference

#include <setjmp.h>
#include "constants.h"

Include dependency graph for top-level.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions
void	default_update_props (void)
	Warning! Do not modify this file that is automatically generated! More...
bool	open_module (const char *)
	tpips used to convert lower cases into upper cases for all module names, but this is no longer possible with C functions. More...
bool	open_module_if_unique (void)
	Open the module of a workspace if there is only one. More...
bool	create_workspace (gen_array_t)
	FI: should be called "initialize_workspace()"; a previous call to db_create_workspace() is useful to create the log file between the two calls says RK. More...
bool	lazy_open_module (const char *)
	Do not open a module already opened : More...
bool	open_workspace (const char *)
	should be: success (cf wpips.h) More...
bool	close_workspace (bool)
bool	delete_workspace (const char *)
bool	check_delete_workspace (const char *, bool)
void	compile_f90_module (string)
gen_array_t	get_stubs (void)
	Get all stubs. More...
void	get_help_topics (gen_array_t)
	help.c More...
void	get_help_topic (string, gen_array_t)
void	pips_checks (void)
	add checkings here (FI: why in help.c?) SG : PIPS_ROOT should not be required :) More...

Variables
void(*	pips_update_props_handler )(void)
	default assignment of pips_update_props_handler is default_update_props. More...

Function Documentation

check_delete_workspace()

bool check_delete_workspace	(	const char *	wname,
		bool	check
	)

Yes but at least close the LOGFILE if we delete the current workspace since it will fail on NFS because of the open file descriptor (creation of .nfs files). RK

reset_entity_to_size();

Parameters

wname	name
check	heck

Definition at line 375 of file dbm.c.

{
    int failure;
    string current = db_get_current_workspace_name();
 
    /* Yes but at least close the LOGFILE if we delete the current
       workspace since it will fail on NFS because of the open file
       descriptor (creation of .nfs files). RK */
 
    if (check)
    {
        if (current && same_string_p(wname, current))
        pips_user_error("Cannot delete current workspace, close it first!\n");
    }
    else
    {
        string name = strdup(current);
        (void) close_makefile(name);
        free(name);
        close_log_file();
        close_processed_include_cache();
        /* reset_entity_to_size(); */
        close_warning_file();
    }
 
    char *escaped_wname = strescape(wname);
    if ((failure=safe_system_no_abort(concatenate("Delete ", escaped_wname, NULL))))
        pips_user_warning("exit code for Delete is %d\n", failure);
    free(escaped_wname);
 
    return !failure;
}

References close_log_file(), close_makefile(), close_processed_include_cache(), close_warning_file(), concatenate(), current, db_get_current_workspace_name(), failure(), free(), pips_user_error, pips_user_warning, safe_system_no_abort(), same_string_p, strdup(), and strescape().

Referenced by delete_workspace(), and quit_notify().

Here is the call graph for this function:

Here is the caller graph for this function:

close_workspace()

bool close_workspace

(

bool

is_quit

)

It is useless to save on disk some non up to date resources:

lear_props();

Parameters

is_quit

s_quit

Definition at line 346 of file dbm.c.

{
    bool success;
 
    if (!db_get_current_workspace_name())
        pips_user_error("No workspace to close!\n");
 
    /* It is useless to save on disk some non up to date resources:
     */
    delete_some_resources();
    success = make_close_workspace(is_quit);
    close_log_file();
    close_processed_include_cache();
    safe_reset_entity_to_size();
    reset_static_entities();
    reset_label_counter();
    close_warning_file();
    safe_pop_path();
    return success;
    /*clear_props();*/
}

References close_log_file(), close_processed_include_cache(), close_warning_file(), db_get_current_workspace_name(), delete_some_resources(), make_close_workspace(), pips_user_error, reset_label_counter(), reset_static_entities(), safe_pop_path(), and safe_reset_entity_to_size().

Referenced by close_workspace_if_opened(), close_workspace_notify(), pips_main(), quit_notify(), and tp_close_the_workspace().

Here is the call graph for this function:

Here is the caller graph for this function:

compile_f90_module()

void compile_f90_module

(

string

filename

)

Parameters

filename

ilename

Definition at line 410 of file dbm.c.

                                           {
  string dir = db_get_current_workspace_directory( );
 
  // Create precompiled directory
  char *compiled_dir_name = strdup( concatenate( dir, "/Precompiled", NULL ) );
  mkdir( compiled_dir_name, S_IRWXU | S_IRWXG | S_IROTH | S_IXOTH );
 
  char *gfc_command = concatenate( "gfortran -fsyntax-only",
                                  " -fcray-pointer -ffree-form",
                                  " -x f95-cpp-input"
                                  " -J ",
                                  compiled_dir_name,
                                  " ",
                                  filename,
                                  NULL );
  if( 0 != system( gfc_command ) ) {
    pips_user_warning("Precompilation failed : %s", gfc_command);
  }
 
}

References concatenate(), db_get_current_workspace_directory(), pips_user_warning, and strdup().

Referenced by create_workspace().

Here is the call graph for this function:

Here is the caller graph for this function:

create_workspace()

bool create_workspace

(

gen_array_t

files

)

FI: should be called "initialize_workspace()"; a previous call to db_create_workspace() is useful to create the log file between the two calls says RK.

Parameters

files

iles

Definition at line 180 of file dbm.c.

{
  int i, argc = gen_array_nitems(files);
  string name, dir = db_get_current_workspace_directory();
  bool success = true;
 
  // since db_create_workspace() must have been called before...
  pips_assert("some current workspace", db_get_current_workspace_name());
 
  open_log_file(dir);
  open_warning_file(dir);
  free(dir);
 
  // although CREATE_WORKSPACE is not a pass, to avoid unknown[unknown]"
  set_pips_current_computation("CREATE_WORKSPACE","Program");
  set_entity_to_size();
  reset_static_entities();
 
  // pop_path() is too strict,
  // let's push anyway since user errors are not caught below!
  push_path();
 
  // Flag that check if there is F90 file
  bool fortran_90_p = false;
 
  // Precompile F95/F90 files, necessary because of module
  for ( i = 0; i < argc; i++ ) {
    string filename = gen_array_item( files, i );
    if ( dot_f90_file_p( filename ) || dot_f95_file_p( filename ) ) {
      fortran_90_p = true;
      compile_f90_module( filename );
    }
  }
 
  if (fortran_90_p) {
    // Load entities (fortran95 need it)
    bootstrap( NULL );
  }
 
  for (i = 0; success && i < argc; i++)
  {
    CATCH (user_exception_error)
    {
      success = false;
      // cleanup???
      if (!get_bool_property("CLOSE_WORKSPACE_AND_QUIT_ON_ERROR"))
      {
        // DB: free the hash_table, otherwise core dump during the next
        // call to create_workspace.
        reset_pips_current_computation();
        reset_entity_to_size();
        reset_static_entities();
        close_log_file();
        close_warning_file();
        pop_path();
      }
      RETHROW();
    }
    TRY
    {
      success = process_user_file(gen_array_item(files, i));
      UNCATCH(user_exception_error);
    }
  }
 
  if (success)
  {
    (* pips_update_props_handler)();
    name = db_get_current_workspace_name();
    user_log("Workspace %s created and opened.\n", name);
 
    // If there is only one function, make it the current module
    success = open_module_if_unique();
 
    if (success)
      init_processed_include_cache();
 
    // set active phases
    success = activate_phases();
  }
 
  if (success) {
    // Try to select the source language
    language l = language_undefined;
 
    l = workspace_language(files);
    activate_language(l);
    free_language(l);
  }
 
  if (!success)
  {
    if (!get_bool_property("CLOSE_WORKSPACE_AND_QUIT_ON_ERROR"))
    {
      // DB: free the hash_table, otherwise core dump during the next
      // call to create_workspace.
      reset_entity_to_size();
      reset_static_entities();
      close_log_file();
      close_warning_file();
      pop_path();
    }
  }
 
  reset_pips_current_computation();
  return success;
}

References activate_language(), activate_phases(), bootstrap(), CATCH, close_log_file(), close_warning_file(), compile_f90_module(), db_get_current_workspace_directory(), db_get_current_workspace_name(), dot_f90_file_p(), dot_f95_file_p(), free(), free_language(), gen_array_item(), gen_array_nitems(), get_bool_property(), init_processed_include_cache(), language_undefined, open_log_file(), open_module_if_unique(), open_warning_file(), pips_assert, pop_path(), process_user_file(), push_path(), reset_entity_to_size(), reset_pips_current_computation(), reset_static_entities(), RETHROW, set_entity_to_size(), set_pips_current_computation(), TRY, UNCATCH, user_exception_error, user_log(), and workspace_language().

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:

default_update_props()

void default_update_props

(

void

)

Warning! Do not modify this file that is automatically generated!

Modify src/Libs/top-level/top-level-local.h instead, to add your own modifications. header file built by cproto top_level-local.h Top-level declares a extern jmp_buf pips_top_level : cproto-generated files dbm.c

Definition at line 46 of file dbm.c.

{}

delete_workspace()

bool delete_workspace

(

const char *

wname

)

Parameters

wname

name

Definition at line 368 of file dbm.c.

{
    int success = check_delete_workspace(wname,true);
 
    return success;
}

References check_delete_workspace().

Referenced by end_delete_workspace_notify().

Here is the call graph for this function:

Here is the caller graph for this function:

get_help_topic()

void get_help_topic	(	string	topic,
		gen_array_t	array
	)

Parameters

topic	opic
array	rray

Definition at line 64 of file help.c.

{
    FILE *fd;
    int selected = false, index=0;
    int begin_length, end_length;
 
    char *line;
 
 
    begin_length = strlen(BEGIN_STR);
    end_length = strlen(END_STR);
 
    fd = fopen_config(XV_HELP_RC, NULL,NULL);
        while ((line = safe_readline(fd)) != NULL) 
        {
            if (strncmp(line, BEGIN_STR, begin_length) == 0 &&
                strcmp(line + begin_length + 1, topic) == 0) {
                selected = true;
            } else if (strncmp(line, END_STR, end_length) == 0) {
                if (selected) break;
            }
            else if (selected) 
                gen_array_dupaddto(array, index++, line);
            free(line);
        }
 
    if (! selected)
        gen_array_dupaddto(array, index++, "Sorry: no help on this topic");
 
    fclose(fd);
}

References array, BEGIN_STR, END_STR, fopen_config(), free(), gen_array_dupaddto(), line, and safe_readline().

Referenced by display_help().

Here is the call graph for this function:

Here is the caller graph for this function:

get_help_topics()

void get_help_topics

(

gen_array_t

array

)

help.c

Parameters

array

rray

Definition at line 43 of file help.c.

{
    int index = 0, begin_length;
    FILE *fd;
    char *line;
 
 
    begin_length = strlen(BEGIN_STR);
 
    fd = fopen_config(XV_HELP_RC, NULL,NULL);
 
    while ((line = safe_readline(fd)) != NULL) {
        if (strncmp(line, BEGIN_STR, begin_length) == 0)
            gen_array_dupaddto(array, index++, line+begin_length+1);
        free(line);
    }
 
    fclose(fd);
}

References array, BEGIN_STR, fopen_config(), free(), gen_array_dupaddto(), line, and safe_readline().

Here is the call graph for this function:

get_stubs()

gen_array_t get_stubs

(

void

)

Get all stubs.

The returned value is allocated dynamically and needs to be freed by the caller of this function

Definition at line 433 of file dbm.c.

{
    list stubs = NIL;
 
    // flag_as_stub pass specific
#ifdef DBR_STUBS
    if (db_resource_p(DBR_STUBS, "")) {
      callees r_stubs = (callees) db_get_memory_resource(DBR_STUBS, "", true);
      stubs = callees_callees(r_stubs);
    }
#endif // DBR_STUBS
 
    return gen_array_from_list(stubs);
}

References callees_callees, db_get_memory_resource(), db_resource_p(), gen_array_from_list(), and NIL.

Referenced by pyps_get_stubs().

Here is the call graph for this function:

Here is the caller graph for this function:

lazy_open_module()

bool lazy_open_module

(

const char *

name

)

Do not open a module already opened :

Parameters

name

ame

Definition at line 289 of file dbm.c.

{
    bool success = true;
 
    pips_assert("lazy_open_module", db_get_current_workspace_name());
    pips_assert("cannot lazy_open no module", name != NULL);
 
    if (db_get_current_module_name()) {
        char * current_name = db_get_current_module_name();
        if (strcmp(current_name, name) != 0)
            success = open_module(name);
        else
            user_log ("Module %s already active.\n", name);
    } else
        success = open_module(name);
 
    return success;
}

References current_name, db_get_current_module_name(), db_get_current_workspace_name(), open_module(), pips_assert, and user_log().

Referenced by end_select_module_callback(), end_select_module_notify(), and tp_set_current_module().

Here is the call graph for this function:

Here is the caller graph for this function:

open_module()

bool open_module

(

const char *

name

)

tpips used to convert lower cases into upper cases for all module names, but this is no longer possible with C functions.

To make it easier for the user and for the validation, an upper case version of name is open if name cannot be open.

reset if needed

Parameters

name

ame

Definition at line 95 of file dbm.c.

{
    bool success = false;
    char* upper_case_name = strupper(strdup(name), name);
    char* module_name ;
 
    if (!db_get_current_workspace_name())
      pips_user_error("No current workspace, open or create one first!\n");
 
    if (db_module_exists_p(name))
      module_name = strdup(name);
    else if(db_module_exists_p(upper_case_name)) {
      module_name = upper_case_name;
      pips_user_warning("Module \"%s\" selected instead of \"%s\""
                        " which was not found\n",
                        module_name, name);
    }
    else
      module_name = NULL;
 
    if(module_name) {
        if (db_get_current_module_name()) /* reset if needed */
            db_reset_current_module_name();
 
        success = db_set_current_module_name(module_name);
    }
 
    if (success) {
      reset_unique_variable_numbers();
      user_log("Module %s selected\n", module_name);
    }
    else {
        if(strcmp(name, upper_case_name)==0)
            pips_user_warning("Could not open module %s\n", name);
        else
            pips_user_warning("Could not open module %s (nor %s)\n",
                    name, upper_case_name);
    }
 
    if (upper_case_name != module_name)
        free(upper_case_name);
    return success;
}

References db_get_current_module_name(), db_get_current_workspace_name(), db_module_exists_p(), db_reset_current_module_name(), db_set_current_module_name(), free(), module_name(), pips_user_error, pips_user_warning, reset_unique_variable_numbers(), strdup(), strupper(), and user_log().

Referenced by lazy_open_module(), open_module_if_unique(), and pips_main().

Here is the call graph for this function:

Here is the caller graph for this function:

open_module_if_unique()

bool open_module_if_unique

(

void

)

Open the module of a workspace if there is only one.

Returns

true if all was OK or if nothing has been done (there is no single module).

Definition at line 144 of file dbm.c.

{
  // Be optimistic:-)
  bool success = true;
  gen_array_t a;
 
  pips_assert("some current workspace", db_get_current_workspace_name());
 
  // First parse the makefile to avoid writing an empty one.
  (void) parse_makefile();
 
  // this function returns various stuff that need to be filtered!
  a = db_get_module_list();
 
  if (gen_array_nitems(a)==1) {
    string mn = gen_array_item(a, 0);
    if (!compilation_unit_p(mn))
      success = open_module(mn);
  }
  else if (gen_array_nitems(a)==2) {
    // In C, you cannot have fewer than two modules
    // because of compilation units
    string mn1 = gen_array_item(a, 0), mn2 = gen_array_item(a, 1);
    bool mod1 = !compilation_unit_p(mn1), mod2 = !compilation_unit_p(mn2);
    if (mod1 ^ mod2)
      success = open_module(mod1? mn1: mod2? mn2: NULL);
  }
  gen_array_full_free(a);
 
  return success;
}

References compilation_unit_p(), db_get_current_workspace_name(), db_get_module_list(), gen_array_full_free(), gen_array_item(), gen_array_nitems(), open_module(), parse_makefile(), and pips_assert.

Referenced by create_workspace(), open_workspace(), and pips_main().

Here is the call graph for this function:

Here is the caller graph for this function:

open_workspace()

bool open_workspace

(

const char *

name

)

should be: success (cf wpips.h)

should be show_message

FI: what happens since log_file is not open?

Parameters

name

ame

Definition at line 309 of file dbm.c.

{
    bool success;
 
    if (db_get_current_workspace_name())
        pips_user_error("Some current workspace, close it first!\n");
 
    if (!workspace_exists_p(name))
        pips_user_error("Workspace %s does not exist!\n", name);
 
    if (!workspace_ok_p(name))
        pips_user_error("Workspace %s not readable!\n", name);
 
    if (make_open_workspace(name) == NULL) {
        /* should be show_message */
        /* FI: what happens since log_file is not open? */
        user_log("Cannot open workspace %s.\n", name);
        success = false;
    }
    else {
        string dir = db_get_current_workspace_directory();
 
        (* pips_update_props_handler)();
 
        open_log_file(dir);
        open_warning_file(dir);
        free(dir);
        set_entity_to_size();
        reset_static_entities();
        user_log("Workspace %s opened.\n", name);
        success = open_module_if_unique();
        if (success) init_processed_include_cache();
        push_path();
    }
    return success;
}

References db_get_current_workspace_directory(), db_get_current_workspace_name(), free(), init_processed_include_cache(), make_open_workspace(), open_log_file(), open_module_if_unique(), open_warning_file(), pips_user_error, push_path(), reset_static_entities(), set_entity_to_size(), user_log(), workspace_exists_p(), and workspace_ok_p().

Referenced by end_open_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:

pips_checks()

void pips_checks

(

void

)

add checkings here (FI: why in help.c?) SG : PIPS_ROOT should not be required :)

Definition at line 100 of file help.c.

{
        /*
    if (!getenv("PIPS_ROOT")) {
        (void) fprintf(stderr, "PIPS_ROOT environment variable not set. \n"
                       "Set it properly and relaunch.\n");
        exit(1);
    }
        */
}

Referenced by gpips_main(), pips_main(), tpips_init(), and wpips_main().

Here is the caller graph for this function:

Variable Documentation

pips_update_props_handler

void(* pips_update_props_handler) (void) ( void  )

externdefault

default assignment of pips_update_props_handler is default_update_props.

Some top-level (eg. wpips) may need a special update_props proceedure; they should let pips_update_props_handler point toward it.

Definition at line 53 of file dbm.c.

Referenced by gpips_main(), and wpips_main().