string_buffer.c File Reference

#include <stdlib.h>
#include "genC.h"
#include <stdarg.h>

Include dependency graph for string_buffer.c:

Go to the source code of this file.

Data Structures
struct	__string_buffer_head
	internally defined structure. More...

Macros
#define	BUFFER_SIZE   512

Functions
string_buffer	string_buffer_make (bool dup)
	allocate a new string buffer More...
void	string_buffer_reset (string_buffer sb)
	remove stack contents More...
void	string_buffer_free (string_buffer *psb)
	free string buffer structure, also free string contents according to the dup field More...
void	string_buffer_free_all (string_buffer *psb)
	free string buffer structure and force string freeing More...
size_t	string_buffer_size (const string_buffer sb)
	return the size of the string in string_buffer sb More...
bool	string_buffer_empty_p (const string_buffer sb)
	return whether string_buffer sb is empty. More...
static string	string_buffer_to_string_internal (const string_buffer sb, bool rev)
	convert to a malloced string, maybe in rev-ersed order of the appends More...
string	string_buffer_to_string (const string_buffer sb)
	return malloc'ed string from string buffer sb More...
string	string_buffer_to_string_reverse (const string_buffer sb)
	return malloc'ed string from string buffer sb going from bottom to top More...
void	string_buffer_to_file (const string_buffer sb, FILE *out)
	put string buffer into file. More...
void	string_buffer_append_c_string_buffer (string_buffer sb, const string_buffer src, int indent)
	put string buffer as a C-string definition of the string buffer, including external double-quotes. More...
static void	string_buffer_append_internal (string_buffer sb, const string s)
	append, without handling duplication More...
void	string_buffer_append (string_buffer sb, const string s)
	append string s (if non empty) to string buffer sb, the duplication is done if needed according to the dup field. More...
void	string_buffer_append_sb (string_buffer sb, const string_buffer sb2)
	append the string buffer sb2 to string buffer sb. More...
void	string_buffer_append_list (string_buffer sb, const list l)
	append a list of string to a string buffer. More...
void	string_buffer_cat (string_buffer sb, const string first,...)
	append a NULL terminated list of string to sb. More...
void	string_buffer_printf_alist (string_buffer sb, const string format, va_list *args)
	formatted alist version More...
void	string_buffer_printf (string_buffer sb, const string format,...)
	append a formatted string to sb More...
void	string_buffer_append_xml_text (string_buffer sb, const string stuff, bool also_nl)
	append a string with XML escapes More...

Macro Definition Documentation

BUFFER_SIZE

#define BUFFER_SIZE   512

Definition at line 160 of file string_buffer.c.

Function Documentation

string_buffer_append()

void string_buffer_append	(	string_buffer	sb,
		const string	s
	)

append string s (if non empty) to string buffer sb, the duplication is done if needed according to the dup field.

Definition at line 260 of file string_buffer.c.

{
  if (*s)
    string_buffer_append_internal(sb, sb->dup? strdup(s): s);
}

References strdup(), and string_buffer_append_internal().

Referenced by add_margin(), append_xml_attribute(), close_extensions(), dump_common_layout(), dump_functional(), extensions_to_string(), get_symbol_table(), open_xml_logfile(), pips_stop_xml(), pragma_to_string(), print_call_precondition(), reductions_get_omp_pragma_str(), safe_get_line_interval(), set_to_string_buffer(), step_directive_to_strings(), string_buffer_append_c_string_buffer(), string_buffer_append_list(), string_buffer_append_numeric(), string_buffer_append_sb(), string_buffer_append_symbolic(), string_buffer_append_word(), string_buffer_cat(), string_buffer_printf_alist(), text_to_string_gen(), two_string_buffer_append_symbolic(), xml_Application(), xml_Argument(), xml_Array(), xml_AssignArgument(), xml_Bounds(), xml_Boxes(), xml_Call(), xml_Chain_Graph(), xml_code(), xml_Compute_and_Need(), xml_data(), xml_declarations(), xml_Full_Type(), xml_loop(), xml_Loop(), xml_Matrix(), xml_ParameterUseToArrayBound(), xml_Pattern_Paving(), xml_reference(), xml_references(), xml_Region_Parameter(), xml_Region_Range(), xml_Scalar(), xml_Task(), xml_task(), xml_TaskParameter(), xml_TaskParameters(), xml_TaskReturnParameter(), xml_tasks(), xml_tiling(), xml_Transposition(), and xml_Type_Entity().

Here is the call graph for this function:

string_buffer_append_c_string_buffer()

void string_buffer_append_c_string_buffer	(	string_buffer	sb,
		const string_buffer	src,
		int	indent
	)

put string buffer as a C-string definition of the string buffer, including external double-quotes.

It adds escapes for special characters.

Definition at line 165 of file string_buffer.c.

{
  message_assert("distinct string buffers", sb!=src);
  // internal working buffer...
  char buffer[BUFFER_SIZE];
  int i = 0, j;
  // start string
  buffer[i++] = '"';
  bool in_string = true;
  STACK_MAP_X(s, string,
    for (char * c = s; *c; c++)
    {
      if (i>BUFFER_SIZE-10-indent)
      {
        buffer[i++] = '\0';
        string_buffer_append(sb, buffer);
        i = 0;
      }
      if (!in_string)
      {
        buffer[i++] = '\n';
        for (j=0; j<indent; j++)
          buffer[i++] = ' ';
        buffer[i++] = '"';
        in_string = true;
      }
      switch (*c)
      {
      case '\n': // New line
        buffer[i++] = '\\';
        buffer[i++] = 'n';
        // the string is closed on newlines anyway
        buffer[i++] = '"';
        in_string = false;
        break;
      case '\a': // Audible bell
        buffer[i++] = '\\';
        buffer[i++] = 'a';
        break;
      case '\b': // Backspace
        buffer[i++] = '\\';
        buffer[i++] = 'b';
        break;
      case '\f': // Form feed
        buffer[i++] = '\\';
        buffer[i++] = 'f';
        break;
      case '\r': // carriage Return
        buffer[i++] = '\\';
        buffer[i++] = 'r';
        break;
      case '\t': // horizontal tab
        buffer[i++] = '\\';
        buffer[i++] = 't';
        break;
      case '\v': // Vertical tab
        buffer[i++] = '\\';
        buffer[i++] = 'v';
        break;
      case '\0': // null character
        buffer[i++] = '\\';
        buffer[i++] = '0';
        break;
      case '\\': // backslash
        buffer[i++] = '\\';
        buffer[i++] = '\\';
        break;
      case '"': // double quote
        buffer[i++] = '\\';
        buffer[i++] = '"';
        break;
      default:
        buffer[i++] = *c;
      }
    },
              src->ins, 0);
  // end string if needed
  if (in_string)
    buffer[i++] = '"';
  buffer[i++] = '\0';
  string_buffer_append(sb, buffer);
}

References buffer, BUFFER_SIZE, message_assert, src, STACK_MAP_X, and string_buffer_append().

Referenced by opencl_compile_mergeable_dag().

Here is the call graph for this function:

Here is the caller graph for this function:

string_buffer_append_internal()

static void string_buffer_append_internal ( string_buffer  sb, const string  s  )

static

append, without handling duplication

Definition at line 251 of file string_buffer.c.

{
  if (*s)
    stack_push(s, sb->ins);
}

References stack_push().

Referenced by string_buffer_append(), and string_buffer_append_xml_text().

Here is the call graph for this function:

Here is the caller graph for this function:

string_buffer_append_list()

void string_buffer_append_list	(	string_buffer	sb,
		const list	l
	)

append a list of string to a string buffer.

Note that each element of the list is duplicated or not according to the dup field.

Returns

void

Parameters

sb,the	string buffer where to append the whole list
l,the	list of string to append to the string buffer

Definition at line 282 of file string_buffer.c.

{
  FOREACH (string, s, l)
    string_buffer_append(sb, s);
}

References FOREACH, and string_buffer_append().

Referenced by pragma_to_string().

Here is the call graph for this function:

Here is the caller graph for this function:

string_buffer_append_sb()

void string_buffer_append_sb	(	string_buffer	sb,
		const string_buffer	sb2
	)

append the string buffer sb2 to string buffer sb.

Returns

void

Parameters

sb,the	string buffer where to append the second string buffer
sb2,the	string buffer to append to the fisrt string buffer

Definition at line 271 of file string_buffer.c.

{
  STACK_MAP_X(s, string, string_buffer_append(sb, s), sb2->ins, 0);
}

References __string_buffer_head::ins, STACK_MAP_X, and string_buffer_append().

Referenced by freia_spoc_code_buildup(), freia_terapix_call(), and opencl_compile_mergeable_dag().

Here is the call graph for this function:

Here is the caller graph for this function:

string_buffer_append_xml_text()

void string_buffer_append_xml_text	(	string_buffer	sb,
		const string	stuff,
		bool	also_nl
	)

append a string with XML escapes

Definition at line 342 of file string_buffer.c.

{
  // count needed chars, with a margin
  int len = 1; // final '\0'
  char * s = stuff;
  while (*s) {
      // only five mandatory ("'&<>), \n added...
    if (strchr("\"'&<>\n", *s))
      len += 5;
    len ++, s ++;
  }
 
  // allocate
  char * escaped = (char*) malloc(sizeof(char)*len);
 
  // copy stuff & insert escapes
  s = stuff;
  char * e = escaped;
  while (*s) {
    switch (*s) {
      // mandatory
    case '"':
      *e++='&'; *e++='q'; *e++='u'; *e++='o'; *e++='t'; *e++=';'; break;
    case '\'':
      *e++='&'; *e++='a'; *e++='p'; *e++='o'; *e++='s'; *e++=';'; break;
    case '&':
      *e++='&'; *e++='a'; *e++='m'; *e++='p'; *e++=';'; break;
    case '<':
      *e++='&'; *e++='l'; *e++='t'; *e++=';'; break;
    case '>':
      *e++='&'; *e++='g'; *e++='t'; *e++=';'; break;
      // others...
    case '\n':
      if (also_nl) {
        *e++='&'; *e++='#'; *e++='1'; *e++='0'; *e++=';'; break;
      }
      // else fall through
    default:
      *e++ = *s;
    }
    s++;
  }
  *e = '\0';
 
  string_buffer_append_internal(sb, escaped);
}

References malloc(), and string_buffer_append_internal().

Referenced by append_xml_attribute(), string_buffer_append_symbolic(), string_buffer_append_word(), two_string_buffer_append_symbolic(), xml_Argument(), xml_Array(), xml_AssignArgument(), xml_Call(), xml_Chain_Graph(), xml_Compute_and_Need(), xml_Loop(), xml_ParameterUseToArrayBound(), xml_Pattern_Paving(), xml_Region_Parameter(), xml_Scalar(), xml_TaskParameter(), xml_Transposition(), and xml_Type_Entity().

Here is the call graph for this function:

Here is the caller graph for this function:

string_buffer_cat()

void string_buffer_cat	(	string_buffer	sb,
		const string	first,
			...
	)

append a NULL terminated list of string to sb.

Parameters

sb	string buffer to be appended to
first...	appended strings

Definition at line 294 of file string_buffer.c.

{
  va_list args;
  va_start(args, first);
  string next = first;
  while (next)
  {
    string_buffer_append(sb, next);
    next = va_arg(args, string);
  }
  va_end(args);
}

References string_buffer_append().

Referenced by pips_log_xml(), set_to_string_buffer(), and step_directive_to_strings().

Here is the call graph for this function:

Here is the caller graph for this function:

string_buffer_empty_p()

bool string_buffer_empty_p

(

const string_buffer

sb

)

return whether string_buffer sb is empty.

Definition at line 112 of file string_buffer.c.

{
  return string_buffer_size(sb)==0;
}

References string_buffer_size().

Referenced by sc_delimiter(), and xml_TaskParameters().

Here is the call graph for this function:

Here is the caller graph for this function:

string_buffer_free()

void string_buffer_free

(

string_buffer *

psb

)

free string buffer structure, also free string contents according to the dup field

• psb the string_buffer to free

Definition at line 82 of file string_buffer.c.

{
  if ((*psb)->dup)
    STACK_MAP_X(s, string, free(s), (*psb)->ins, 0);
  stack_free(&((*psb)->ins));
  free(*psb);
  *psb = NULL;
}

References free(), stack_free(), and STACK_MAP_X.

Referenced by dagvtx_dot(), freia_spoc_pipeline(), freia_terapix_call(), freia_trpx_compile_one_dag(), generic_print_xml_application(), get_symbol_table(), gpips_user_error(), gpips_user_warning(), mppa_compile_dag(), mppa_helper_args_params(), open_xml_logfile(), opencl_compile_mergeable_dag(), pips_log_xml(), pips_stop_xml(), safe_get_line_interval(), sc_delimiter(), sc_inst(), set_fprint(), set_to_string(), string_buffer_free_all(), text_to_string_gen(), words_type(), wpips_user_error(), wpips_user_warning(), and xml_Chain_Graph().

Here is the call graph for this function:

Here is the caller graph for this function:

string_buffer_free_all()

void string_buffer_free_all

(

string_buffer *

psb

)

free string buffer structure and force string freeing

• psb the string_buffer to free

Definition at line 94 of file string_buffer.c.

{
  message_assert("not null pointer", (*psb) != NULL);
  (*psb)->dup = true;
  string_buffer_free (psb);
}

References message_assert, and string_buffer_free().

Referenced by close_extensions(), extensions_to_string(), pragma_to_string(), reductions_get_omp_pragma_str(), and step_directive_to_strings().

Here is the call graph for this function:

Here is the caller graph for this function:

string_buffer_make()

string_buffer string_buffer_make

(

bool

dup

)

allocate a new string buffer

Parameters

dup	tell whether to string duplicate appended strings if so, the strings will be freed later.

Definition at line 58 of file string_buffer.c.

{
  string_buffer n =
    (string_buffer) malloc(sizeof(struct __string_buffer_head));
  message_assert("string_buffer is allocated", n!=NULL);
  n->ins = stack_make(0, 0, 0);
  n->dup = dup;
  return n;
}

References __string_buffer_head::dup, __string_buffer_head::ins, malloc(), message_assert, and stack_make().

Referenced by close_extensions(), dagvtx_dot(), extensions_to_string(), freia_spoc_pipeline(), freia_terapix_call(), freia_trpx_compile_one_dag(), generic_print_xml_application(), get_symbol_table(), gpips_user_error(), gpips_user_warning(), mppa_compile_dag(), mppa_helper_args_params(), open_xml_logfile(), opencl_compile_mergeable_dag(), pips_log_xml(), pips_stop_xml(), pragma_to_string(), reductions_get_omp_pragma_str(), safe_get_line_interval(), sc_delimiter(), sc_inst(), set_to_string_buffer(), step_directive_to_strings(), text_to_string_gen(), words_type(), wpips_user_error(), wpips_user_warning(), xml_Boxes(), xml_Chain_Graph(), xml_code(), xml_Compute_and_Need(), xml_Pattern_Paving(), xml_Region_Range(), xml_TaskParameters(), and xml_tiling().

Here is the call graph for this function:

Here is the caller graph for this function:

string_buffer_printf()

void string_buffer_printf	(	string_buffer	sb,
		const string	format,
			...
	)

append a formatted string to sb

Parameters

sb	string buffer to be appended to
format	printf format string
...	values

Definition at line 329 of file string_buffer.c.

{
  va_list args;
  va_start(args, format);
  string_buffer_printf_alist(sb, format, &args);
  va_end(args);
}

References string_buffer_printf_alist().

Referenced by append_xml_line_numbers(), gpips_user_error(), gpips_user_warning(), pips_stop_xml(), wpips_user_error(), and wpips_user_warning().

Here is the call graph for this function:

Here is the caller graph for this function:

string_buffer_printf_alist()

void string_buffer_printf_alist	(	string_buffer	sb,
		const string	format,
		va_list *	args
	)

formatted alist version

Definition at line 309 of file string_buffer.c.

{
  va_list acpy;
  va_copy(acpy, *args);
  string str;
  int err = vasprintf(&str, format, acpy);
  message_assert("vasprintf ok", err >= 0);
  string_buffer_append(sb, str);
  if (sb->dup) free(str);
  va_end(acpy);
}

References free(), message_assert, string_buffer_append(), and vasprintf().

Referenced by gpips_user_error(), gpips_user_warning(), string_buffer_printf(), wpips_user_error(), and wpips_user_warning().

Here is the call graph for this function:

Here is the caller graph for this function:

string_buffer_reset()

void string_buffer_reset

(

string_buffer

sb

)

remove stack contents

Definition at line 70 of file string_buffer.c.

{
  while (!stack_empty_p(sb->ins)) {
    string s = (string) stack_pop(sb->ins);
    if (sb->dup) free(s);
  }
}

References free(), stack_empty_p(), and stack_pop().

Referenced by sc_delimiter(), and sc_inst().

Here is the call graph for this function:

Here is the caller graph for this function:

string_buffer_size()

size_t string_buffer_size

(

const string_buffer

sb

)

return the size of the string in string_buffer sb

Definition at line 103 of file string_buffer.c.

{
  size_t size = 0;
  STACK_MAP_X(s, string, size+=strlen(s), sb->ins, 0);
  return size;
}

References STACK_MAP_X.

Referenced by freia_terapix_call(), string_buffer_empty_p(), and string_buffer_to_string_internal().

Here is the caller graph for this function:

string_buffer_to_file()

void string_buffer_to_file	(	const string_buffer	sb,
		FILE *	out
	)

put string buffer into file.

Definition at line 155 of file string_buffer.c.

{
  STACK_MAP_X(s, string, fputs(s, out), sb->ins, 0);
}

References out, and STACK_MAP_X.

Referenced by dagvtx_dot(), freia_trpx_compile_one_dag(), mppa_compile_dag(), open_xml_logfile(), opencl_compile_mergeable_dag(), pips_log_xml(), pips_stop_xml(), sc_delimiter(), and set_fprint().

Here is the caller graph for this function:

string_buffer_to_string()

string string_buffer_to_string

(

const string_buffer

sb

)

return malloc'ed string from string buffer sb

Definition at line 141 of file string_buffer.c.

{
  return string_buffer_to_string_internal(sb, false);
}

References string_buffer_to_string_internal().

Referenced by close_extensions(), extensions_to_string(), generic_print_xml_application(), get_symbol_table(), gpips_user_error(), gpips_user_warning(), mppa_helper_args_params(), pragma_to_string(), reductions_get_omp_pragma_str(), safe_get_line_interval(), sc_delimiter(), sc_inst(), set_to_string(), step_directive_to_strings(), text_to_string_gen(), words_type(), wpips_user_error(), wpips_user_warning(), xml_Boxes(), xml_Chain_Graph(), xml_code(), xml_Compute_and_Need(), xml_Pattern_Paving(), xml_Region_Range(), xml_TaskParameters(), and xml_tiling().

Here is the call graph for this function:

Here is the caller graph for this function:

string_buffer_to_string_internal()

static string string_buffer_to_string_internal ( const string_buffer  sb, bool  rev  )

static

convert to a malloced string, maybe in rev-ersed order of the appends

Definition at line 120 of file string_buffer.c.

{
  string buf = (string) malloc(string_buffer_size(sb)+1);
  message_assert("allocated", buf!=NULL);
 
  int current = 0;
  buf[current] = '\0';
 
  STACK_MAP_X(s, string,
  {
    int len = strlen(s);
    (void) memcpy(&buf[current], s, len);
    current += len;
    buf[current] = '\0';
  },
              sb->ins, rev);
 
  return buf;
}

References buf, current, malloc(), message_assert, STACK_MAP_X, and string_buffer_size().

Referenced by string_buffer_to_string(), and string_buffer_to_string_reverse().

Here is the call graph for this function:

Here is the caller graph for this function:

string_buffer_to_string_reverse()

string string_buffer_to_string_reverse

(

const string_buffer

sb

)

return malloc'ed string from string buffer sb going from bottom to top

Definition at line 148 of file string_buffer.c.

{
  return string_buffer_to_string_internal(sb, true);
}

References string_buffer_to_string_internal().

Referenced by sc_delimiter().

Here is the call graph for this function:

Here is the caller graph for this function: