text_print.c File Reference

#include <stdio.h>
#include <stdlib.h>
#include <ctype.h>
#include <string.h>
#include "linear.h"
#include "genC.h"
#include "ri.h"
#include "text.h"
#include "misc.h"
#include "properties.h"
#include "text-util.h"

Include dependency graph for text_print.c:

Go to the source code of this file.

Macros
#define	MAX_END_COLUMN_F77   (72)
	print_sentence: More...
#define	MAX_END_COLUMN_F95   (132)
#define	MAX_END_COLUMN_DEFAULT   (INT_MAX/2)
	Define a huge line size value because the previous one (999) was too small for PIPS generated declarations after the outliner. More...
#define	MAX_START_COLUMN   (42)
#define	C_STATEMENT_LINE_COLUMN   (71)
#define	C_STATEMENT_LINE_STEP   (15)

Functions
static void	print_sentence_init ()
	Before using print_sentence: More...
static char	putc_sentence (char c, FILE *fd)
	Output functions that tracks the number of output characters: More...
static int	fprintf_sentence (FILE *fd, char *a_format,...)
void	print_sentence (FILE *fd, sentence s)
	cproto-generated files More...
void	print_text (FILE *fd, text t)
void	dump_sentence (sentence s)
void	dump_text (text t)
	FI: print_text() should be fprint_text() and dump_text(), print_text() More...
string	words_join (list ls, const char *sep)
string	words_to_string (list ls)
	Convert a word list into a string and translate the position of eventual attachment accordingly: More...
string	sentence_to_string (sentence sen)
	SG: moved here from icfdg BUG (FC): words_to_string is malloced, but sentence_formatted is not:-(. More...
string	text_to_string_gen (text t, bool with_newline)
string	text_to_string (text t)
	SG: moved here from ricedg. More...
string	text_to_string_nl (text t)
void	print_words (FILE *fd, list lw)
void	dump_words (list lw)
static void	debug_word (string w)
void	debug_words (list l)
static void	debug_formatted (string s)
static void	debug_unformatted (unformatted u)
void	debug_sentence (sentence s)
void	debug_text (text t)

Variables
static int	position_in_the_output = 0
	FI: just to make sure that text.h is built; pips-makemake -l does not take into account a library whose modules do not use the library header. More...

Macro Definition Documentation

C_STATEMENT_LINE_COLUMN

#define C_STATEMENT_LINE_COLUMN   (71)

Definition at line 102 of file text_print.c.

C_STATEMENT_LINE_STEP

#define C_STATEMENT_LINE_STEP   (15)

Definition at line 103 of file text_print.c.

MAX_END_COLUMN_DEFAULT

#define MAX_END_COLUMN_DEFAULT   (INT_MAX/2)

Define a huge line size value because the previous one (999) was too small for PIPS generated declarations after the outliner.

Do not use INT_MAX because there are some assertions such as (... < MAX_END_COLUMN_DEFAULT + 1). So (INT_MAX/2) is a rough approximation. :-)

Definition at line 100 of file text_print.c.

MAX_END_COLUMN_F77

#define MAX_END_COLUMN_F77   (72)

print_sentence:

FI: I had to change this module to handle string longer than the space available on one line; I tried to preserve as much as I could of the previous behavior to avoid pseudo-hyphenation at the wrong place and to avoid extensicve problems with validate; the resulting code is lousy, of course; FI, 15 March 1993

RK: the print_sentence could print lower case letter according to a property... 17/12/1993.

Definition at line 93 of file text_print.c.

MAX_END_COLUMN_F95

#define MAX_END_COLUMN_F95   (132)

Definition at line 94 of file text_print.c.

MAX_START_COLUMN

#define MAX_START_COLUMN   (42)

Definition at line 101 of file text_print.c.

Function Documentation

debug_formatted()

static void debug_formatted ( string  s )

static

Definition at line 487 of file text_print.c.

{
    fprintf(stderr, "# formatted\n%s\n# end formatted\n", s);
}

References fprintf().

Referenced by debug_sentence().

Here is the call graph for this function:

Here is the caller graph for this function:

debug_sentence()

void debug_sentence

(

sentence

s

)

Definition at line 501 of file text_print.c.

{
    fprintf(stderr, "# sentence\n");
    switch (sentence_tag(s))
    {
    case is_sentence_formatted:
        debug_formatted(sentence_formatted(s));
        break;
    case is_sentence_unformatted:
        debug_unformatted(sentence_unformatted(s));
        break;
    default:
        pips_internal_error("unexpected sentence tag %d", sentence_tag(s));
    }
 
    fprintf(stderr,"# end sentence\n");
}

References debug_formatted(), debug_unformatted(), fprintf(), is_sentence_formatted, is_sentence_unformatted, pips_internal_error, sentence_formatted, sentence_tag, and sentence_unformatted.

Referenced by debug_text().

Here is the call graph for this function:

Here is the caller graph for this function:

debug_text()

void debug_text

(

text

t

)

Definition at line 519 of file text_print.c.

{
    fprintf(stderr, "# text\n");
    gen_map((gen_iter_func_t)debug_sentence, text_sentences(t));
    fprintf(stderr,"# end text\n");
}

References debug_sentence(), fprintf(), gen_map(), and text_sentences.

Here is the call graph for this function:

debug_unformatted()

static void debug_unformatted ( unformatted  u )

static

Definition at line 492 of file text_print.c.

{
    fprintf(stderr, "# unformatted\n# label %s, %td, %td\n",
            unformatted_label(u)? unformatted_label(u): "<null>",
            unformatted_number(u), unformatted_extra_margin(u));
    debug_words(unformatted_words(u));
    fprintf(stderr, "# end unformatted\n");
}

References debug_words(), fprintf(), unformatted_extra_margin, unformatted_label, unformatted_number, and unformatted_words.

Referenced by debug_sentence().

Here is the call graph for this function:

Here is the caller graph for this function:

debug_word()

static void debug_word ( string  w )

static

Definition at line 475 of file text_print.c.

{
    fprintf(stderr, "# string--%s--\n", w? w: "<null>");
}

References fprintf().

Referenced by debug_words().

Here is the call graph for this function:

Here is the caller graph for this function:

debug_words()

void debug_words

(

list

l

)

Parameters

l

of string

Definition at line 481 of file text_print.c.

{
    gen_map((gen_iter_func_t)debug_word, l);
}

References debug_word(), and gen_map().

Referenced by debug_unformatted().

Here is the call graph for this function:

Here is the caller graph for this function:

dump_sentence()

void dump_sentence

(

sentence

s

)

Definition at line 373 of file text_print.c.

{
    print_sentence(stderr, s);
}

References print_sentence().

Here is the call graph for this function:

dump_text()

void dump_text

(

text

t

)

FI: print_text() should be fprint_text() and dump_text(), print_text()

Definition at line 380 of file text_print.c.

{
    print_text(stderr, t);
}

References print_text().

Here is the call graph for this function:

dump_words()

void dump_words

(

list

lw

)

Parameters

lw

w

Definition at line 467 of file text_print.c.

{
    print_words(stderr, lw);
}

References print_words().

Here is the call graph for this function:

fprintf_sentence()

static int fprintf_sentence ( FILE *  fd, char *  a_format,   ...  )

static

Definition at line 65 of file text_print.c.

{
    va_list some_arguments;
    int number_of_printed_char;
 
    va_start(some_arguments, a_format);
    number_of_printed_char = vfprintf(fd, a_format, some_arguments);
    va_end(some_arguments);
 
    position_in_the_output += number_of_printed_char;
    return number_of_printed_char;
}

References position_in_the_output.

Referenced by print_sentence().

Here is the caller graph for this function:

print_sentence()

void print_sentence	(	FILE *	fd,
		sentence	s
	)

cproto-generated files

text_print.c

cproto-generated files

print_sentence:

FI: I had to change this module to handle string longer than the space available on one line; I tried to preserve as much as I could of the previous behavior to avoid pseudo-hyphenation at the wrong place and to avoid extensicve problems with validate; the resulting code is lousy, of course; FI, 15 March 1993

RK: the print_sentence could print lower case letter according to a property... 17/12/1993.

col: the next column number, starting from 1. it means tha columns 1 to col-1 have been output. I guess. FC.

first 6 columns (0-5)

05/08/2003 - Nga Nguyen - Add code for C prettyprinter

Keep track of the attachment against the padding:

C prettyprinter: a label cannot begin with a number so "l" is added for this case

FI: do not indent too much (9 June 1995)

Initial tabulation, if needed: do not put useless SPACEs in output file. Well, it's difficult to know if it is useful or not. The test below leads to misplaced opening braces.

& gen_length(lw)>1 && !same_string_p(STRING(CAR(lw)), "\n")

Fortran77 start on 7th column

if the string fits on the current line: no problem

if the string fits on one line: use the 88 algorithm to break as few syntactic constructs as possible

Complete current line with the statement line number, if it is significative:

prepare to cut the line

start a new line with its prefix

Special label for Cray directives

if the string has to be broken in at least two lines: new algorithmic part to avoid line overflow (FI, March 1993)

Complete the current line, but not after :-)

start a new line with its prefix but no indentation since string constants may be broken onto two lines

prepare to cut the line

Special label for Cray directives

statement line number starts at different column depending on the used language : C or fortran

fortran case right the line number on the right where characters are ignored by a f77 parser

C and F95 case, try to align the line number on the right using commentaries. The alignment is done modulo C_STATEMENT_LINE_STEP

Output the statement line number on the right end of the line:

Parameters

fd

d

Definition at line 105 of file text_print.c.

                                           {
  enum language_utype lang = get_prettyprint_language_tag();
 
 
  if (sentence_formatted_p(s)) {
    string ps = sentence_formatted(s);
 
    while(*ps) {
      char c = *ps;
      putc_sentence(c, fd);
      deal_with_attachments_at_this_character(ps, position_in_the_output);
      ps++;
    }
  } else {
    /* col: the next column number, starting from 1.
     * it means tha columns 1 to col-1 have been output. I guess. FC.
     */
    int i, line_num = 1;
    int col;
    unformatted u = sentence_unformatted(s);
    string label = unformatted_label(u);
    int em = unformatted_extra_margin(u);
    int n = unformatted_number(u);
    cons *lw = unformatted_words(u);
    int max_line_size;
    if(lang==is_language_fortran95) {
      max_line_size = MAX_END_COLUMN_F95;
    } else if(lang==is_language_fortran ) {
      max_line_size =MAX_END_COLUMN_F77;
    } else {
      max_line_size = MAX_END_COLUMN_DEFAULT;
    }
 
    /* first 6 columns (0-5)
     */
    /* 05/08/2003 - Nga Nguyen - Add code for C prettyprinter */
 
    if (label != NULL && !string_undefined_p(label)) {
      /* Keep track of the attachment against the padding: */
      deal_with_attachments_in_this_string(label, position_in_the_output);
 
      switch(lang) {
        case is_language_fortran:
          fprintf_sentence(fd, "%-5s ", label);
          break;
        case is_language_fortran95:
          // Check that the label is non empty
          if(*label!='\0') {
            fprintf_sentence(fd, "%-5s ", label);
          }
          break;
        case is_language_c:
          /* C prettyprinter: a label cannot begin with a number
           * so "l" is added for this case
           */
          if (strlen(label) > 0)
            fprintf_sentence(fd, get_C_label_printf_format(label), label);
          break;
        default:
          pips_internal_error("language unknown not handled");
      }
    } else if (lang==is_language_fortran) {
      fprintf_sentence(fd, "      ");
    }
 
 
    /* FI: do not indent too much (9 June 1995) */
    em = (em > MAX_START_COLUMN) ? MAX_START_COLUMN : em;
    /* Initial tabulation, if needed: do not put useless SPACEs
     in output file.
     Well, it's difficult to know if it is useful or not. The
     test below leads to misplaced opening braces.
     */
    if (!ENDP(lw)
    /*&& gen_length(lw)>1
     && !same_string_p(STRING(CAR(lw)), "\n")*/)
      for (i = 0; i < em; i++)
        putc_sentence(' ', fd);
 
    col = em;
 
    if (lang == is_language_fortran) {
      col = col + 7; /* Fortran77 start on 7th column */
    }
 
    pips_assert("not too many columns", col <= max_line_size - 2);
    FOREACH(string, w, lw) {
      switch(lang) {
        case is_language_c:
          col += fprintf_sentence(fd, "%s", w);
          break;
        case is_language_fortran:
        case is_language_fortran95: {
          int max_space_on_a_line = max_line_size - em;
          if(lang==is_language_fortran) {
            max_space_on_a_line -= 7;
          }
 
 
          /* if the string fits on the current line: no problem */
          if (col + (int) strlen(w) <= max_line_size - 2) {
            deal_with_attachments_in_this_string(w, position_in_the_output);
            col += fprintf_sentence(fd, "%s", w);
          }
          /* if the string fits on one line:
           * use the 88 algorithm to break as few
           * syntactic constructs as possible */
          else if ((int)strlen(w) < max_space_on_a_line) {
              /* Complete current line with the statement
               line number, if it is significative: */
              if (n > 0 && get_bool_property("PRETTYPRINT_STATEMENT_NUMBER")) {
                for (i = col; i <= max_line_size; i++) {
                  putc_sentence(' ', fd);
                }
                if (lang == is_language_fortran95) {
                  fprintf_sentence(fd, "! %04d", n);
                } else {
                  fprintf_sentence(fd, "%04d", n);
                }
              }
 
              if(lang==is_language_fortran95) {
                 /* prepare to cut the line */
                 fprintf_sentence(fd," &");
               }
 
              /* start a new line with its prefix */
              putc_sentence('\n', fd);
 
              if (label != (char *)NULL && !string_undefined_p(label)
                  && (strcmp(label, "CDIR$") == 0 || strcmp(label, "CDIR@")
                      == 0 || strcmp(label, "CMIC$") == 0)) {
                pips_assert("Cray with F95 not handled",
                            lang!=is_language_fortran95);
                /* Special label for Cray directives */
                fprintf_sentence(fd, "%s%d", label, (++line_num) % 10);
              } else if (lang == is_language_fortran) {
                fprintf_sentence(fd, "     &");
              }
 
              for (i = 0; i < em; i++)
                putc_sentence(' ', fd);
 
              if (lang == is_language_fortran) {
                col = 7 + em;
              } else {
                col = em;
              }
            deal_with_attachments_in_this_string(w, position_in_the_output);
            col += fprintf_sentence(fd, "%s", w);
          }
          /* if the string has to be broken in at least two lines:
           * new algorithmic part
           * to avoid line overflow (FI, March 1993) */
          else {
            char * line = w;
            int ncar;
 
            /* Complete the current line, but not after :-) */
            ncar = MIN(max_line_size - col + 1, (int) strlen(line));
            ;
            deal_with_attachments_in_this_string_length(line,
                                                        position_in_the_output,
                                                        ncar);
            fprintf_sentence(fd, "%.*s", ncar, line);
            line += ncar;
            col = max_line_size;
 
            pips_debug(9, "line to print, col=%d\n", col);
 
            while(strlen(line) != 0) {
              ncar = MIN(max_line_size - 7 + 1, (int) strlen(line));
 
 
              /* start a new line with its prefix but no indentation
               * since string constants may be broken onto two lines
               */
              if (lang == is_language_fortran95) {
                /* prepare to cut the line */
                fprintf_sentence(fd, " &");
              }
              putc_sentence('\n', fd);
 
              if (label != (char *)NULL
                  && (strcmp(label, "CDIR$") == 0 || strcmp(label, "CDIR@")
                      == 0 || strcmp(label, "CMIC$") == 0)) {
                /* Special label for Cray directives */
                (void)fprintf_sentence(fd, "%s%d", label, (++line_num) % 10);
              } else if (lang == is_language_fortran) {
                (void)fprintf_sentence(fd, "     &");
                col = 7;
              } else {
                col = 0;
              }
              deal_with_attachments_in_this_string_length(line,
                                                          position_in_the_output,
                                                          ncar);
              (void)fprintf_sentence(fd, "%.*s", ncar, line);
              line += ncar;
              col += ncar;
            }
          }
          break;
        }
        default:
          pips_internal_error("Language unknown !");
          break;
      }
    }
 
    pips_debug(9, "line completed, col=%d\n", col);
    pips_assert("not too many columns", col <= max_line_size + 1);
 
    /* statement line number starts at different column depending on
     * the used language : C or fortran
     */
    int column_start = 0;
    switch (get_prettyprint_language_tag()) {
      case is_language_fortran:
        /* fortran case right the line number on the right where characters
         are ignored by a f77 parser*/
        column_start = max_line_size;
        break;
      case is_language_c:
      case is_language_fortran95:
        /* C and F95 case, try to align the line number on the right using
         * commentaries. The alignment is done modulo C_STATEMENT_LINE_STEP
         */
        column_start = C_STATEMENT_LINE_COLUMN;
        while(column_start <= col)
          column_start += C_STATEMENT_LINE_STEP;
        break;
      default:
        pips_internal_error("Language unknown !");
        break;
    }
 
    /* Output the statement line number on the right end of the
     line: */
    if (n > 0 && get_bool_property("PRETTYPRINT_STATEMENT_NUMBER")) {
      for (int i = col; i <= column_start; i++) {
        putc_sentence(' ', fd);
      }
      switch (get_prettyprint_language_tag()) {
        case is_language_fortran:
          fprintf_sentence(fd, "%04d", n);
          break;
        case is_language_c:
          fprintf_sentence(fd, "/*%04d*/", n);
          break;
        case is_language_fortran95:
          fprintf_sentence(fd, "! %04d", n);
          break;
        default:
          pips_internal_error("Language unknown !");
          break;
      }
    }
    putc_sentence('\n', fd);
  }
}

References C_STATEMENT_LINE_COLUMN, C_STATEMENT_LINE_STEP, deal_with_attachments_at_this_character(), deal_with_attachments_in_this_string(), deal_with_attachments_in_this_string_length(), ENDP, FOREACH, fprintf_sentence(), get_bool_property(), get_C_label_printf_format(), get_prettyprint_language_tag(), is_language_c, is_language_fortran, is_language_fortran95, line, MAX_END_COLUMN_DEFAULT, MAX_END_COLUMN_F77, MAX_END_COLUMN_F95, MAX_START_COLUMN, MIN, pips_assert, pips_debug, pips_internal_error, position_in_the_output, putc_sentence(), sentence_formatted, sentence_formatted_p, sentence_unformatted, string_undefined_p, unformatted_extra_margin, unformatted_label, unformatted_number, and unformatted_words.

Referenced by dump_sentence(), and print_text().

Here is the call graph for this function:

Here is the caller graph for this function:

print_sentence_init()

static void print_sentence_init ( )

static

Before using print_sentence:

Definition at line 49 of file text_print.c.

{
    position_in_the_output = 0;
}

References position_in_the_output.

Referenced by print_text().

Here is the caller graph for this function:

print_text()

void print_text	(	FILE *	fd,
		text	t
	)

Parameters

fd

d

Definition at line 367 of file text_print.c.

{
    print_sentence_init();
    MAP(SENTENCE, s, print_sentence(fd, s), text_sentences(t));
}

References MAP, print_sentence(), print_sentence_init(), SENTENCE, and text_sentences.

Referenced by dump_text().

Here is the call graph for this function:

Here is the caller graph for this function:

print_words()

void print_words	(	FILE *	fd,
		list	lw
	)

Parameters

fd	d
lw	w

Definition at line 460 of file text_print.c.

{
    string s = words_to_string(lw);
    fputs(s, fd);
    free(s);
}

References free(), and words_to_string().

Referenced by dump_words().

Here is the call graph for this function:

Here is the caller graph for this function:

putc_sentence()

static char putc_sentence ( char  c, FILE *  fd  )

static

Output functions that tracks the number of output characters:

Definition at line 57 of file text_print.c.

{
    position_in_the_output ++;
    return putc(c, fd);
}

References position_in_the_output.

Referenced by print_sentence().

Here is the caller graph for this function:

sentence_to_string()

string sentence_to_string

(

sentence

sen

)

SG: moved here from icfdg BUG (FC): words_to_string is malloced, but sentence_formatted is not:-(.

SG: moved here from icfdg.

Parameters

sen

en

Definition at line 420 of file text_print.c.

{
  if (!sentence_formatted_p(sen))
    return words_to_string(unformatted_words(sentence_unformatted(sen)));
  else
    return sentence_formatted(sen);
}

References sentence_formatted, sentence_formatted_p, sentence_unformatted, unformatted_words, and words_to_string().

Referenced by text_to_string_gen().

Here is the call graph for this function:

Here is the caller graph for this function:

text_to_string()

string text_to_string

(

text

t

)

SG: moved here from ricedg.

Definition at line 450 of file text_print.c.

{
  return text_to_string_gen(t, false);
}

References text_to_string_gen().

Here is the call graph for this function:

text_to_string_gen()

string text_to_string_gen	(	text	t,
		bool	with_newline
	)

Parameters

with_newline

ith_newline

Definition at line 428 of file text_print.c.

{
  string_buffer sb = string_buffer_make(true);
 
  FOREACH(sentence, sen, text_sentences(t))
  {
    string ss = sentence_to_string(sen);
    string_buffer_append(sb, ss);
    // try to avoid a memory leak... see comments above
    if (sentence_unformatted_p(sen))
      free(ss);
    if (with_newline)
      string_buffer_append(sb, "\n");
  }
 
  string s = string_buffer_to_string(sb);
  string_buffer_free(&sb);
 
  return s;
}

References FOREACH, free(), sentence_to_string(), sentence_unformatted_p, string_buffer_append(), string_buffer_free(), string_buffer_make(), string_buffer_to_string(), and text_sentences.

Referenced by text_to_string(), and text_to_string_nl().

Here is the call graph for this function:

Here is the caller graph for this function:

text_to_string_nl()

string text_to_string_nl

(

text

t

)

Definition at line 455 of file text_print.c.

{
  return text_to_string_gen(t, true);
}

References text_to_string_gen().

Referenced by ensure_comment_consistency().

Here is the call graph for this function:

Here is the caller graph for this function:

words_join()

string words_join	(	list	ls,
		const char *	sep
	)

1 for null termination.

computes the buffer length.

appends to the buffer...

Parameters

ls	s
sep	ep

Definition at line 385 of file text_print.c.

{
    int size = 1; /* 1 for null termination. */
    size_t sep_sz = strlen(sep);
    string buffer, p;
 
    /* computes the buffer length.
     */
    MAP(STRING, s, size+=strlen(s)+sep_sz, ls);
    buffer = (char*) malloc(sizeof(char)*size);
    pips_assert("malloc ok", buffer);
 
    /* appends to the buffer...
     */
    buffer[0] = '\0';
    p=buffer;
    FOREACH(STRING, s,ls) {
        strcat_word_and_migrate_attachments(p, s);
        strcat_word_and_migrate_attachments(p, sep);
        p+=strlen(s);
        p+=sep_sz;
    }
    return buffer;
}

References buffer, FOREACH, malloc(), MAP, pips_assert, strcat_word_and_migrate_attachments(), and STRING.

Referenced by words_to_string().

Here is the call graph for this function:

Here is the caller graph for this function:

words_to_string()

string words_to_string

(

list

ls

)

Convert a word list into a string and translate the position of eventual attachment accordingly:

Parameters

ls

s

Definition at line 412 of file text_print.c.

{
    return words_join(ls,"");
}

References words_join().

Referenced by print_words(), and sentence_to_string().

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

position_in_the_output

int position_in_the_output = 0

static

FI: just to make sure that text.h is built; pips-makemake -l does not take into account a library whose modules do not use the library header.

Definition at line 45 of file text_print.c.

Referenced by deal_with_attachment_boundary(), deal_with_attachments_at_this_character(), deal_with_attachments_in_this_string(), deal_with_attachments_in_this_string_length(), fprintf_sentence(), print_sentence(), print_sentence_init(), and putc_sentence().