util.c

Go to the documentation of this file.

    /*+-----------------------------------------------------------------**
     **                       OpenScop Library                          **
     **-----------------------------------------------------------------**
     **                            util.c                               **
     **-----------------------------------------------------------------**
     **                   First version: 08/10/2010                     **
     **-----------------------------------------------------------------**

 
 *****************************************************************************
 * OpenScop: Structures and formats for polyhedral tools to talk together    *
 *****************************************************************************
 *    ,___,,_,__,,__,,__,,__,,_,__,,_,__,,__,,___,_,__,,_,__,                *
 *    /   / /  //  //  //  // /   / /  //  //   / /  // /  /|,_,             *
 *   /   / /  //  //  //  // /   / /  //  //   / /  // /  / / /\             *
 *  |~~~|~|~~~|~~~|~~~|~~~|~|~~~|~|~~~|~~~|~~~|~|~~~|~|~~~|/_/  \            *
 *  | G |C| P | = | L | P |=| = |C| = | = | = |=| = |=| C |\  \ /\           *
 *  | R |l| o | = | e | l |=| = |a| = | = | = |=| = |=| L | \# \ /\          *
 *  | A |a| l | = | t | u |=| = |n| = | = | = |=| = |=| o | |\# \  \         *
 *  | P |n| l | = | s | t |=| = |d| = | = | = | |   |=| o | | \# \  \        *
 *  | H | | y |   | e | o | | = |l|   |   | = | |   | | G | |  \  \  \       *
 *  | I | |   |   | e |   | |   | |   |   |   | |   | |   | |   \  \  \      *
 *  | T | |   |   |   |   | |   | |   |   |   | |   | |   | |    \  \  \     *
 *  | E | |   |   |   |   | |   | |   |   |   | |   | |   | |     \  \  \    *
 *  | * |*| * | * | * | * |*| * |*| * | * | * |*| * |*| * | /      \* \  \   *
 *  | O |p| e | n | S | c |o| p |-| L | i | b |r| a |r| y |/        \  \ /   *
 *  '---'-'---'---'---'---'-'---'-'---'---'---'-'---'-'---'          '--'    *
 *                                                                           *
 * Copyright (C) 2008 University Paris-Sud 11 and INRIA                      *
 *                                                                           *
 * (3-clause BSD license)                                                    *
 * Redistribution and use in source  and binary forms, with or without       *
 * modification, are permitted provided that the following conditions        *
 * are met:                                                                  *
 *                                                                           *
 * 1. Redistributions of source code must retain the above copyright notice, *
 *    this list of conditions and the following disclaimer.                  *
 * 2. Redistributions in binary form must reproduce the above copyright      *
 *    notice, this list of conditions and the following disclaimer in the    *
 *    documentation and/or other materials provided with the distribution.   *
 * 3. The name of the author may not be used to endorse or promote products  *
 *    derived from this software without specific prior written permission.  *
 *                                                                           *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR      *
 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES *
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.   *
 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,          *
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT  *
 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, *
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY     *
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT       *
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF  *
 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.         *
 *                                                                           *
 * OpenScop Library, a library to manipulate OpenScop formats and data       *
 * structures. Written by:                                                   *
 * Cedric Bastoul     <Cedric.Bastoul@u-psud.fr> and                         *
 * Louis-Noel Pouchet <Louis-Noel.pouchet@inria.fr>                          *
 *                                                                           *
 *****************************************************************************/

#include <stdlib.h>
#include <stdio.h>
#include <ctype.h>
#include <string.h>

#include <osl/macros.h>
#include <osl/util.h>


/*+***************************************************************************
 *                             Utility functions                             *
 *****************************************************************************/


char * osl_util_skip_blank_and_comments(FILE * file, char * str) {
  char * start;

  do {
    start = fgets(str, OSL_MAX_STRING, file);
    while ((start != NULL) && isspace(*start) && (*start != '\n'))
      start++;
  }
  while (start != NULL && (*start == '#' || *start == '\n'));

  return start;
}


void osl_util_sskip_blank_and_comments(char ** str) {
  do {
    // Skip spaces/blanc lines.
    while (*str && **str && isspace(**str))
      (*str)++;

    // Skip the comment if any.
    if (*str && **str && **str == '#') {
      while (**str && **str != '\n') {
        (*str)++;
      }
    }
  }
  while (*str && **str && **str == '\n');
}


int osl_util_read_int(FILE * file, char ** str) {
  char s[OSL_MAX_STRING], * start;
  int res;
  int i = 0;

  if ((file != NULL && str != NULL) || (file == NULL && str == NULL))
    OSL_error("one and only one of the two parameters can be non-NULL");

  if (file != NULL) {
    // Parse from a file.
    start = osl_util_skip_blank_and_comments(file, s);
    if (sscanf(start, " %d", &res) != 1)
      OSL_error("an int was expected");
  }
  else {
    // Parse from a string.
    // Skip blank/commented lines.
    osl_util_sskip_blank_and_comments(str);
    
    // Build the chain to analyze.
    while (**str && !isspace(**str) && **str != '\n' && **str != '#')
      s[i++] = *((*str)++);
    s[i] = '\0';
    if (sscanf(s, "%d", &res) != 1)
      OSL_error("an int was expected");
  }

  return res;
}


char * osl_util_read_string(FILE * file, char ** str) {
  char s[OSL_MAX_STRING], * start;
  char * res;
  int i = 0;

  if ((file != NULL && str != NULL) || (file == NULL && str == NULL))
    OSL_error("one and only one of the two parameters can be non-NULL");

  OSL_malloc(res, char *, OSL_MAX_STRING * sizeof(char));
  if (file != NULL) {
    // Parse from a file.
    start = osl_util_skip_blank_and_comments(file, s);
    if (sscanf(start, " %s", res) != 1)
      OSL_error("a string was expected");
  }
  else {
    // Parse from a string.
    // Skip blank/commented lines.
    osl_util_sskip_blank_and_comments(str);
    
    // Build the chain to analyze.
    while (**str && !isspace(**str) && **str != '\n' && **str != '#')
      s[i++] = *((*str)++);
    s[i] = '\0';
    if (sscanf(s, "%s", res) != 1)
      OSL_error("a string was expected");
  }

  OSL_realloc(res, char *, strlen(res) + 1);
  return res;
}


char * osl_util_read_line(FILE * file, char ** str) {
  char s[OSL_MAX_STRING], * start;
  char * res;
  int i = 0;

  if ((file != NULL && str != NULL) || (file == NULL && str == NULL))
    OSL_error("one and only one of the two parameters can be non-NULL");

  OSL_malloc(res, char *, OSL_MAX_STRING * sizeof(char));
  if (file != NULL) {
    // Parse from a file.
    start = osl_util_skip_blank_and_comments(file, s);
    while (*start && *start != '\n' && *start != '#' && i < OSL_MAX_STRING)
      res[i++] = *start++;
  }
  else {
    // Parse from a string.
    osl_util_sskip_blank_and_comments(str);
    while (**str && **str != '\n' && **str != '#' && i < OSL_MAX_STRING)
      res[i++] = *((*str)++);
  }

  res[i] = '\0';
  OSL_realloc(res, char *, strlen(res) + 1);
  return res;
}


char * osl_util_read_tag(FILE * file, char ** str) {
  char s[OSL_MAX_STRING], * start;
  char * res;
  int i = 0;

  if ((file != NULL && str != NULL) || (file == NULL && str == NULL))
    OSL_error("one and only one of the two parameters can be non-NULL");

  // Skip blank/commented lines.
  if (file != NULL) {
    start = osl_util_skip_blank_and_comments(file, s);
    str = &start;
  }
  else {
    osl_util_sskip_blank_and_comments(str);
  }

  // If the end of the input has been reached, return NULL.
  if (((file != NULL) && (feof(file))) ||
      ((str  != NULL) && (**str == '\0')))
    return NULL;
  
  // Pass the starting '<'.
  if (**str != '<')
    OSL_error("a \"<\" to start a tag was expected");
  (*str)++;

  // Read the tag.
  OSL_malloc(res, char *, (OSL_MAX_STRING + 1) * sizeof(char));
  res[OSL_MAX_STRING] = '\0';
  
  while (**str && **str != '>') {
    if (((**str >= 'A') && (**str <= 'Z')) ||
        ((**str >= 'a') && (**str <= 'z')) ||
        ((**str == '/') && (i == 0))       ||
        (**str == '_')) {
      res[i++] = *((*str)++);
      res[i] = '\0';
    }
    else {
      OSL_error("illegal character in the tag name");
    }
  }

  // Check we actually end up with a '>' and pass it.
  if (**str != '>')
    OSL_error("a \">\" to end a tag was expected");
  (*str)++;

  return res;
}


char * osl_util_read_uptoflag(FILE * file, char ** str, char * flag) {
  int high_water_mark = OSL_MAX_STRING;
  int nb_chars = 0;
  int lenflag = strlen(flag), lenstr;
  int flag_found = 0;
  char * res;

  if ((file != NULL && str != NULL) || (file == NULL && str == NULL))
    OSL_error("one and only one of the two parameters can be non-NULL");
  
  OSL_malloc(res, char *, high_water_mark * sizeof(char));

  // Copy everything to the res string.
  if (str != NULL)
    lenstr = strlen(*str);
  while (((str  != NULL) && (nb_chars != lenstr)) ||
         ((file != NULL) && (!feof(file)))) {
    res[nb_chars++] = (str != NULL) ? *((*str)++) : fgetc(file);

    if ((nb_chars >= lenflag) &&
        (!strncmp(&res[nb_chars - lenflag], flag, lenflag))) {
      flag_found = 1;
      break;
    }

    if (nb_chars >= high_water_mark) {
      high_water_mark += high_water_mark;
      OSL_realloc(res, char *, high_water_mark * sizeof(char));
    }
  }

  if (!flag_found) {
    OSL_debug("flag was not found, end of input reached");
    free(res);
    return NULL;
  }

  // - 0-terminate the string.
  OSL_realloc(res, char *, (nb_chars - strlen(flag) + 1) * sizeof(char));
  res[nb_chars - strlen(flag)] = '\0';

  return res;
}


char * osl_util_read_uptotag(FILE * file, char ** str, char * name) {
  char tag[strlen(name) + 3];
  
  sprintf(tag, "<%s>", name);
  return osl_util_read_uptoflag(file, str, tag);
}


char * osl_util_read_uptoendtag(FILE * file, char ** str, char * name) {
  char endtag[strlen(name) + 4];
  
  sprintf(endtag, "</%s>", name);
  return osl_util_read_uptoflag(file, str, endtag);
}


char * osl_util_tag_content(char * str, char * name) {
  int i;
  char * start;
  char * stop;
  char tag[strlen(name) + 3];
  char endtag[strlen(name) + 4];
  int size = 0;
  size_t lentag;
  char * res = NULL;

  sprintf(tag, "<%s>", name);
  sprintf(endtag, "</%s>", name);
  
  if (str) {
    start = str;
    lentag = strlen(tag);
    for (; start && *start && strncmp(start, tag, lentag); ++start)
      continue;
    
    // The tag 'tag' was not found.
    if (! *start)
      return NULL;
    start += lentag;
    stop = start;
    lentag = strlen(endtag);
    for (size = 0; *stop && strncmp(stop, endtag, lentag); ++stop, ++size)
      continue;
    
    // the tag 'endtag' was not found.
    if (! *stop)
      return NULL;
    OSL_malloc(res, char *, (size + 1) * sizeof(char));
    
    // Copy the chain between the two tags.
    for (++start, i = 0; start != stop; ++start, ++i)
      res[i] = *start;
    res[i] = '\0';
  }

  return res;
}


void osl_util_safe_strcat(char ** dst, char * src, int * hwm) {

  while ((int)(strlen(*dst) + strlen(src)) >= *hwm) {
    *hwm += OSL_MAX_STRING;
    OSL_realloc(*dst, char *, *hwm * sizeof(char));
  }

  strcat(*dst, src);
}


char * osl_util_strdup(char const * str) {
  char * dup = NULL;
  OSL_malloc(dup, char *, (strlen(str) + 1) * sizeof(char));
  if (dup) { strcpy(dup, str); }
  return dup;
}


int osl_util_get_precision() {
  int precision = OSL_PRECISION_DP;
  char * precision_env;

#ifdef OSL_GMP_IS_HERE
  precision = OSL_PRECISION_MP;
#endif

  precision_env = getenv(OSL_PRECISION_ENV);
  if (precision_env != NULL) {
    if (!strcmp(precision_env, OSL_PRECISION_ENV_SP))
      precision = OSL_PRECISION_SP;
    else if (!strcmp(precision_env, OSL_PRECISION_ENV_DP))
      precision = OSL_PRECISION_DP;
    else if (!strcmp(precision_env, OSL_PRECISION_ENV_MP)) {
#ifndef OSL_GMP_IS_HERE
      OSL_warning("$OSL_PRECISION says GMP but osl not compiled with "
                  "GMP support, switching to double precision");
      precision = OSL_PRECISION_DP;
#else
      precision = OSL_PRECISION_MP;
#endif
    }
    else
      OSL_warning("bad OSL_PRECISION environment value, see osl's manual");
  }

  return precision;
}


void osl_util_print_provided(FILE * file, int provided, char * title) {
  if (provided) {
    fprintf(file, "# %s provided\n", title);
    fprintf(file, "1\n");
  }
  else {
    fprintf(file, "# %s not provided\n", title);
    fprintf(file, "0\n\n");
  }
}


static
int osl_util_identifier_is_here(char * expression, char * identifier,
                                int index) {
  // If there is no space enough to find the identifier: no.
  if (strlen(identifier) + index > strlen(expression))
    return 0;
  
  // If there is a character before and it is in [A-Za-z0-9]: no.
  if ((index > 0) &&
      (((expression[index - 1] >= 'A') && (expression[index - 1] <= 'Z')) || 
       ((expression[index - 1] >= 'a') && (expression[index - 1] <= 'z')) || 
       ((expression[index - 1] >= '0') && (expression[index - 1] <= '9'))))
    return 0;

  // If there is a character after and it is in [A-Za-z0-9]: no.
  if ((strlen(identifier) + index < strlen(expression)) &&
      (((expression[strlen(identifier) + index] >= 'A') &&
        (expression[strlen(identifier) + index] <= 'Z'))   || 
       ((expression[strlen(identifier) + index] >= 'a') &&
        (expression[strlen(identifier) + index] <= 'z'))   || 
       ((expression[strlen(identifier) + index] >= '0') &&
        (expression[strlen(identifier) + index] <= '9'))))
    return 0;

  // If the identifier string is not here: no.
  if (strncmp(expression + index, identifier, strlen(identifier)))
    return 0;

  return 1;
}


static
int osl_util_lazy_isolated_identifier(char * expression, char * identifier,
                                      int index) {
  int look;

  // If the first non-space character before is not in [\[(,\+=]: no. 
  look = index - 1;
  while (look >= 0) {
    if (isspace(expression[look]))
      look--;
    else
      break;
  }

  if ((look >= 0) &&
      (expression[look] != '[') &&
      (expression[look] != '(') &&
      (expression[look] != '+') &&
      (expression[look] != '=') &&
      (expression[look] != ','))
    return 0;
        
  // If the first non-space character after is not in [\]),;\+]: no. 
  look = index + strlen(identifier);
  while (look < (int)strlen(expression)) {
    if (isspace(expression[look]))
      look++;
    else
      break;
  }

  if ((look < (int)strlen(expression)) &&
      (expression[look] != ']')   &&
      (expression[look] != ')')   &&
      (expression[look] != '+')   &&
      (expression[look] != ',')   &&
      (expression[look] != ';'))
    return 0;

  return 1;
}


char * osl_util_identifier_substitution(char * expression,
                                        char ** identifiers) {
  size_t index;
  int j, found;
  int high_water_mark = OSL_MAX_STRING;
  char buffer[OSL_MAX_STRING];
  char * string;
 
  OSL_malloc(string, char *, high_water_mark * sizeof(char));
  string[0] = '\0';

  index = 0;
  while (index < strlen(expression)) {
    j = 0;
    found = 0;
    while (identifiers[j] != NULL) {
      if (osl_util_identifier_is_here(expression, identifiers[j], index)) {
        if (osl_util_lazy_isolated_identifier(expression,identifiers[j],index))
          sprintf(buffer, "@%d@", j);
        else
          sprintf(buffer, "(@%d@)", j);
        osl_util_safe_strcat(&string, buffer, &high_water_mark);
        index += strlen(identifiers[j]);
        found = 1;
        break;
      }
      j++;
    }
    if (!found) {
      sprintf(buffer, "%c", expression[index]);
      osl_util_safe_strcat(&string, buffer, &high_water_mark);
      index++;
    }
  }

  return string;
}