#include <stdlib.h>
#include <stdio.h>
#include <string.h>
#include "linear.h"
#include "genC.h"
#include "text.h"
#include "text-util.h"
#include "top-level.h"
#include "ri.h"
#include "effects.h"
#include "ri-util.h"
#include "effects-util.h"
#include "database.h"
#include "pipsdbm.h"
#include "resources.h"
#include "misc.h"
#include "properties.h"
#include "prettyprint.h"
#include "transformer.h"
#include "effects-generic.h"
#include "semantics.h"
#include "continuation.h"

Include dependency graph for prettyprint.c:

Macros
#define	PREC_FORESYS_PREFIX "C$PREC"
	package continuation : Be'atrice Creusillet, 1996 More...

#define	TRAN_FORESYS_PREFIX "C$TRAN"

#define	continuation get_comment_continuation()

#define	append(s) add_to_current_line(crt_line, s, continuation, txt)

Functions
static int	is_inferior_pvarval (Pvecteur pvarval1, Pvecteur pvarval2)
	The strange argument type is required by qsort(), deep down in the calls. More...

static text	text_continuation (transformer cont, bool is_must)
	text text_continuation(transformer tran) input : a transformer representing a transformer or a precondition output : a text containing commentaries representing the transformer modifies : nothing. More...

static text	text_continuation_conditions (transformer must_cont_t, transformer may_cont_t)

static text	text_statement_continuation_conditions (entity module, int margin, statement stat)

static text	get_continuation_condition_text (const char *module_name, bool give_code_p)

static bool	print_continuation_conditions (const char *module_name)

bool	print_code_continuation_conditions (const string module_name)
	prettyprint.c More...

bool	print_source_continuation_conditions (const string module_name)

Variables
static bool	is_user_view_p

static hash_table	nts = hash_table_undefined

Macro Definition Documentation

◆ append

#define append ( s ) add_to_current_line(crt_line, s, continuation, txt)

Definition at line 103 of file prettyprint.c.

◆ continuation

#define continuation get_comment_continuation()

Definition at line 102 of file prettyprint.c.

◆ PREC_FORESYS_PREFIX

#define PREC_FORESYS_PREFIX "C$PREC"

package continuation : Be'atrice Creusillet, 1996

This File contains the functions to prettyprint continuation conditions of a module (over- and under-approximations.

Definition at line 67 of file prettyprint.c.

◆ TRAN_FORESYS_PREFIX

#define TRAN_FORESYS_PREFIX "C$TRAN"

Definition at line 68 of file prettyprint.c.

Function Documentation

◆ get_continuation_condition_text()

static text get_continuation_condition_text	(	const char *	module_name,
		bool	give_code_p
	)

static

To set up the hash table to translate value into value names

prepare the prettyprinting

summary information first

then code with regions, using text_statement_continuation_conditions

Definition at line 228 of file prettyprint.c.

 {
     entity module;
     statement module_stat, user_stat = statement_undefined;
     text txt = make_text(NIL);
     transformer must_sum_cont_t, may_sum_cont_t;   
  
     set_current_module_entity( local_name_to_top_level_entity(module_name));
     module = get_current_module_entity();
     set_current_module_statement((statement) db_get_memory_resource
                                  (DBR_CODE, module_name, true));
     module_stat = get_current_module_statement();
  
     /* To set up the hash table to translate value into value names */       
     set_cumulated_rw_effects((statement_effects)
           db_get_memory_resource(DBR_CUMULATED_EFFECTS, module_name, true));
     module_to_value_mappings(module);
  
  
     if(is_user_view_p) 
     {
         user_stat =  (statement)
             db_get_memory_resource(DBR_PARSED_CODE, module_name, true);
  
         nts = allocate_number_to_statement();
         nts = build_number_to_statement(nts, module_stat);
  
         ifdebug(1)
         {
             print_number_to_statement(nts);
         }
     }
  
     debug_on("CONTINUATION_DEBUG_LEVEL");
  
     set_must_continuation_map( (statement_mapping) 
         db_get_memory_resource(DBR_MUST_CONTINUATION, module_name, true) );
     set_may_continuation_map( (statement_mapping) 
         db_get_memory_resource(DBR_MAY_CONTINUATION, module_name, true) );
     must_sum_cont_t = (transformer) 
      db_get_memory_resource(DBR_MUST_SUMMARY_CONTINUATION, module_name, true);
     may_sum_cont_t = (transformer) 
      db_get_memory_resource(DBR_MAY_SUMMARY_CONTINUATION, module_name, true);
  
     /* prepare the prettyprinting */
     init_prettyprint(text_statement_continuation_conditions);
     /* summary information first */
     MERGE_TEXTS(txt,text_continuation(must_sum_cont_t, true)); 
     MERGE_TEXTS(txt,text_continuation(may_sum_cont_t, false)); 
  
     if (give_code_p)
         /* then code with regions, 
          * using text_statement_continuation_conditions */
         MERGE_TEXTS(txt, text_module(module,
                                      is_user_view_p? user_stat : module_stat));
  
     debug_off();
  
     if(is_user_view_p)
     {
         hash_table_free(nts);
         nts = hash_table_undefined;
     }
  
     close_prettyprint();
  
     reset_current_module_entity();
     reset_current_module_statement();
     reset_cumulated_rw_effects();
     reset_must_continuation_map();
     reset_may_continuation_map();
     free_value_mappings();
  
     return txt;
 }

References allocate_number_to_statement(), build_number_to_statement(), close_prettyprint(), db_get_memory_resource(), debug_off, debug_on, free_value_mappings(), get_current_module_entity(), get_current_module_statement(), hash_table_free(), hash_table_undefined, ifdebug, init_prettyprint(), is_user_view_p, local_name_to_top_level_entity(), make_text(), may_sum_cont_t, MERGE_TEXTS, module, module_name(), module_to_value_mappings(), must_sum_cont_t, NIL, nts, print_number_to_statement(), reset_cumulated_rw_effects(), reset_current_module_entity(), reset_current_module_statement(), reset_may_continuation_map(), reset_must_continuation_map(), set_cumulated_rw_effects(), set_current_module_entity(), set_current_module_statement(), set_may_continuation_map(), set_must_continuation_map(), statement_undefined, text_continuation(), text_module(), and text_statement_continuation_conditions().

Referenced by print_continuation_conditions().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ is_inferior_pvarval()

static int is_inferior_pvarval	(	Pvecteur *	pvarval1,
		Pvecteur *	pvarval2
	)

static

The strange argument type is required by qsort(), deep down in the calls.

The constant term is given the highest weight to push constant terms at the end of the constraints and to make those easy to compare. If not, constant 0 will be handled differently from other constants. However, it would be nice to give constant terms the lowest weight to print simple constraints first...

Either I define two comparison functions, or I cheat somewhere else. Let's cheat?

Definition at line 75 of file prettyprint.c.

 {
     /* The constant term is given the highest weight to push constant
        terms at the end of the constraints and to make those easy
        to compare. If not, constant 0 will be handled differently from
        other constants. However, it would be nice to give constant terms
        the lowest weight to print simple constraints first...
  
        Either I define two comparison functions, or I cheat somewhere else.
        Let's cheat? */
     int is_equal = 0;
     
     if (term_cst(*pvarval1) && !term_cst(*pvarval2))
         is_equal = 1;
     else if (term_cst(*pvarval1) && term_cst(*pvarval2))
         is_equal = 0;
     else if(term_cst(*pvarval2))
         is_equal = -1;
     else
         is_equal = 
             strcmp(pips_user_value_name((entity) vecteur_var(*pvarval1)),
                    pips_user_value_name((entity) vecteur_var(*pvarval2)));
  
  
     return is_equal; 
 }

References pips_user_value_name(), term_cst, and vecteur_var.

Referenced by text_continuation().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ print_code_continuation_conditions()

bool print_code_continuation_conditions ( const string module_name )

prettyprint.c

Parameters

module_name odule_name

Definition at line 331 of file prettyprint.c.

 {
     is_user_view_p = false;
     return print_continuation_conditions(module_name);
 }

References is_user_view_p, module_name(), and print_continuation_conditions().

Here is the call graph for this function:

◆ print_continuation_conditions()

static bool print_continuation_conditions ( const char * module_name )

static

Definition at line 305 of file prettyprint.c.

 {
     char *file_name, *file_resource_name;
     bool success = true;
  
     file_name = strdup(concatenate(".cont",
                                    get_bool_property
                                   ("PRETTYPRINT_UNSTRUCTURED_AS_A_GRAPH") ? 
                                   GRAPH_FILE_EXT : "",
                                   NULL));
     file_resource_name = 
         get_bool_property("PRETTYPRINT_UNSTRUCTURED_AS_A_GRAPH") ?
         DBR_GRAPH_PRINTED_FILE : 
         (is_user_view_p ? DBR_PARSED_PRINTED_FILE : DBR_PRINTED_FILE);
  
     success = 
         make_text_resource_and_free(
             module_name,
             file_resource_name,
             file_name,
             get_continuation_condition_text(module_name,true));
  
     free(file_name);
     return(success);
 }

References concatenate(), file_name, free(), get_bool_property(), get_continuation_condition_text(), is_user_view_p, make_text_resource_and_free(), module_name(), and strdup().

Referenced by print_code_continuation_conditions(), and print_source_continuation_conditions().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ print_source_continuation_conditions()

bool print_source_continuation_conditions ( const string module_name )

Parameters

module_name odule_name

Definition at line 338 of file prettyprint.c.

 {
     is_user_view_p = true;
     return print_continuation_conditions(module_name);
 }

References is_user_view_p, module_name(), and print_continuation_conditions().

Here is the call graph for this function:

◆ text_continuation()

static text text_continuation	(	transformer	cont,
		bool	is_must
	)

static

text text_continuation(transformer tran) input : a transformer representing a transformer or a precondition output : a text containing commentaries representing the transformer modifies : nothing.

Modification: AP, Nov 10th, 1995. Instead of building a (very long) string, I directly use the transformer to build the prettyprint in text format. This is to avoid the problem occuring when the buffer used in transformer[precondition]_to_string() is too small. I also use a static buffer to build each constraint; we are restricted to constraints of lengths smaller than the line length.

else an empty text is returned.

Definition at line 118 of file prettyprint.c.

 {
     text txt = make_text(NIL);
     char crt_line[MAX_LINE_LENGTH];
  
     crt_line[0] = '\0'; 
     append(get_comment_sentinel());
     append(" ");
  
     if(cont != (transformer) HASH_UNDEFINED_VALUE ) 
     {
         if(cont==transformer_undefined)
         {
             append(" CONTINUATION: TRANSFORMER_UNDEFINED");
         }
         else
         {  
             Psysteme ps = predicate_system(transformer_relation(cont));
             sc_lexicographic_sort(ps, is_inferior_pvarval); 
  
             append(is_must? "C-MUST-":"C-MAY-");
             system_text_format(crt_line, continuation, txt, ps, 
                                (get_variable_name_t) pips_user_value_name,
                                false);
         }
       
         close_current_line(crt_line, txt,continuation);
     }
     /* else an empty text is returned. 
      */
  
     return txt; 
 }

References append, close_current_line(), continuation, get_comment_sentinel(), HASH_UNDEFINED_VALUE, is_inferior_pvarval(), make_text(), MAX_LINE_LENGTH, NIL, pips_user_value_name(), predicate_system, sc_lexicographic_sort(), system_text_format(), transformer_relation, and transformer_undefined.

Referenced by get_continuation_condition_text(), and text_continuation_conditions().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ text_continuation_conditions()

static text text_continuation_conditions	(	transformer	must_cont_t,
		transformer	may_cont_t
	)

static

First: must continuation conditions

Then: may continuation conditions

Definition at line 153 of file prettyprint.c.

 {
     
     text cont_text = make_text(NIL);
     bool loose_p = get_bool_property("PRETTYPRINT_LOOSE");
     
     if ((must_cont_t ==(transformer) HASH_UNDEFINED_VALUE) &&
         (may_cont_t ==(transformer) HASH_UNDEFINED_VALUE) )
         return(cont_text);
  
     if (loose_p)
     {
         ADD_SENTENCE_TO_TEXT(cont_text, 
                              make_sentence(is_sentence_formatted, 
                                            strdup("\n")));
     }
     
     /* First: must continuation conditions */
     if (must_cont_t !=(transformer) HASH_UNDEFINED_VALUE)
     {
         MERGE_TEXTS(cont_text, text_continuation(must_cont_t,true));
     }
     
     /* Then: may continuation conditions */
     if (may_cont_t !=(transformer) HASH_UNDEFINED_VALUE)
     {
         MERGE_TEXTS(cont_text, text_continuation(may_cont_t,false));
     }
     if (loose_p)
         ADD_SENTENCE_TO_TEXT(cont_text, 
                              make_sentence(is_sentence_formatted, 
                                            strdup("\n")));
  
     return(cont_text);
 }

References ADD_SENTENCE_TO_TEXT, get_bool_property(), HASH_UNDEFINED_VALUE, is_sentence_formatted, make_sentence(), make_text(), MERGE_TEXTS, NIL, strdup(), and text_continuation().

Referenced by text_statement_continuation_conditions().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ text_statement_continuation_conditions()

static text text_statement_continuation_conditions	(	entity	module,
		int	margin,
		statement	stat
	)

static

Definition at line 192 of file prettyprint.c.

 {
   pips_assert("true", module==module && margin==margin);
  
     transformer must_cont_t, may_cont_t;
     statement s;
  
     s = is_user_view_p? 
         (statement) hash_get(nts, (char *) statement_number(stat)) :
         stat;
  
     if (is_user_view_p)
     {
         s = (statement) hash_get(nts, (char *) statement_number(stat));
     }
  
     
     if (s != (statement) HASH_UNDEFINED_VALUE)
     {
         must_cont_t = load_statement_must_continuation(s);
         may_cont_t = load_statement_may_continuation(s);
     }
     else
     {
         must_cont_t = (transformer) HASH_UNDEFINED_VALUE;
         may_cont_t = (transformer) HASH_UNDEFINED_VALUE;
     }
     
     return text_continuation_conditions(must_cont_t, may_cont_t);
 }