| |
| /*+-----------------------------------------------------------------** |
| ** OpenScop Library ** |
| **-----------------------------------------------------------------** |
| ** extensions/comment.c ** |
| **-----------------------------------------------------------------** |
| ** First version: 07/12/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 <string.h> |
| |
| #include <osl/macros.h> |
| #include <osl/util.h> |
| #include <osl/interface.h> |
| #include <osl/extensions/comment.h> |
| |
| |
| /*+*************************************************************************** |
| * Structure display function * |
| *****************************************************************************/ |
| |
| |
| /** |
| * osl_comment_idump function: |
| * this function displays an osl_comment_t structure (*comment) into a |
| * file (file, possibly stdout) in a way that trends to be understandable. It |
| * includes an indentation level (level) in order to work with others |
| * idump functions. |
| * \param[in] file The file where the information has to be printed. |
| * \param[in] comment The comment structure to print. |
| * \param[in] level Number of spaces before printing, for each line. |
| */ |
| void osl_comment_idump(FILE * file, osl_comment_p comment, int level) { |
| int j; |
| char * tmp; |
| |
| // Go to the right level. |
| for (j = 0; j < level; j++) |
| fprintf(file, "|\t"); |
| |
| if (comment != NULL) |
| fprintf(file, "+-- osl_comment_t\n"); |
| else |
| fprintf(file, "+-- NULL comment\n"); |
| |
| if (comment != NULL) { |
| // Go to the right level. |
| for(j = 0; j <= level; j++) |
| fprintf(file, "|\t"); |
| |
| // Display the comment message (without any carriage return). |
| tmp = strdup(comment->comment); |
| for (j = 0; j < strlen(tmp); j++) |
| if (tmp[j] == '\n') |
| tmp[j] = ' '; |
| fprintf(file, "comment: %s\n", tmp); |
| free(tmp); |
| } |
| |
| // The last line. |
| for (j = 0; j <= level; j++) |
| fprintf(file, "|\t"); |
| fprintf(file, "\n"); |
| } |
| |
| |
| /** |
| * osl_comment_dump function: |
| * this function prints the content of an osl_comment_t structure |
| * (*comment) into a file (file, possibly stdout). |
| * \param[in] file The file where the information has to be printed. |
| * \param[in] comment The comment structure to print. |
| */ |
| void osl_comment_dump(FILE * file, osl_comment_p comment) { |
| osl_comment_idump(file, comment, 0); |
| } |
| |
| |
| /** |
| * osl_comment_sprint function: |
| * this function prints the content of an osl_comment_t structure |
| * (*comment) into a string (returned) in the OpenScop textual format. |
| * \param[in] comment The comment structure to print. |
| * \return A string containing the OpenScop dump of the comment structure. |
| */ |
| char * osl_comment_sprint(osl_comment_p comment) { |
| int high_water_mark = OSL_MAX_STRING; |
| char * string = NULL; |
| char * buffer; |
| |
| if (comment != NULL) { |
| OSL_malloc(string, char *, high_water_mark * sizeof(char)); |
| OSL_malloc(buffer, char *, OSL_MAX_STRING * sizeof(char)); |
| string[0] = '\0'; |
| |
| // Print the comment. |
| sprintf(buffer, "%s", comment->comment); |
| osl_util_safe_strcat(&string, buffer, &high_water_mark); |
| |
| // Keep only the memory space we need. |
| OSL_realloc(string, char *, (strlen(string) + 1) * sizeof(char)); |
| free(buffer); |
| } |
| |
| return string; |
| } |
| |
| |
| /***************************************************************************** |
| * Reading function * |
| *****************************************************************************/ |
| |
| /** |
| * osl_comment_sread function: |
| * this function reads a comment structure from a string complying to the |
| * OpenScop textual format and returns a pointer to this comment structure. |
| * The input parameter is updated to the position in the input string this |
| * function reach right after reading the comment structure. |
| * \param[in,out] input The input string where to find a comment. |
| * Updated to the position after what has been read. |
| * \return A pointer to the comment structure that has been read. |
| */ |
| osl_comment_p osl_comment_sread(char ** input) { |
| osl_comment_p comment; |
| |
| if (*input == NULL) { |
| OSL_debug("no comment optional tag"); |
| return NULL; |
| } |
| |
| if (strlen(*input) > OSL_MAX_STRING) |
| OSL_error("comment too long"); |
| |
| // Build the comment structure |
| comment = osl_comment_malloc(); |
| OSL_strdup(comment->comment, *input); |
| |
| // Update the input pointer (everything has been read). |
| input += strlen(*input); |
| |
| return comment; |
| } |
| |
| |
| /*+*************************************************************************** |
| * Memory allocation/deallocation function * |
| *****************************************************************************/ |
| |
| |
| /** |
| * osl_comment_malloc function: |
| * this function allocates the memory space for an osl_comment_t |
| * structure and sets its fields with default values. Then it returns a |
| * pointer to the allocated space. |
| * \return A pointer to an empty comment structure with fields set to |
| * default values. |
| */ |
| osl_comment_p osl_comment_malloc() { |
| osl_comment_p comment; |
| |
| OSL_malloc(comment, osl_comment_p, sizeof(osl_comment_t)); |
| comment->comment = NULL; |
| |
| return comment; |
| } |
| |
| |
| /** |
| * osl_comment_free function: |
| * this function frees the allocated memory for an osl_comment_t |
| * structure. |
| * \param[in,out] comment The pointer to the comment structure to free. |
| */ |
| void osl_comment_free(osl_comment_p comment) { |
| if (comment != NULL) { |
| if(comment->comment != NULL) |
| free(comment->comment); |
| free(comment); |
| } |
| } |
| |
| |
| /*+*************************************************************************** |
| * Processing functions * |
| *****************************************************************************/ |
| |
| |
| /** |
| * osl_comment_clone function: |
| * this function builds and returns a "hard copy" (not a pointer copy) of an |
| * osl_comment_t data structure. |
| * \param[in] comment The pointer to the comment structure to clone. |
| * \return A pointer to the clone of the comment structure. |
| */ |
| osl_comment_p osl_comment_clone(osl_comment_p comment) { |
| osl_comment_p clone; |
| |
| if (comment == NULL) |
| return NULL; |
| |
| clone = osl_comment_malloc(); |
| OSL_strdup(clone->comment, comment->comment); |
| |
| return clone; |
| } |
| |
| |
| /** |
| * osl_comment_equal function: |
| * this function returns true if the two comment structures are the same |
| * (content-wise), false otherwise. |
| * \param[in] c1 The first comment structure. |
| * \param[in] c2 The second comment structure. |
| * \return 1 if c1 and c2 are the same (content-wise), 0 otherwise. |
| */ |
| int osl_comment_equal(osl_comment_p c1, osl_comment_p c2) { |
| |
| if (c1 == c2) |
| return 1; |
| |
| if (((c1 == NULL) && (c2 != NULL)) || ((c1 != NULL) && (c2 == NULL))) |
| return 0; |
| |
| if (strcmp(c1->comment, c2->comment)) |
| return 0; |
| |
| return 1; |
| } |
| |
| |
| /** |
| * osl_comment_interface function: |
| * this function creates an interface structure corresponding to the comment |
| * extension and returns it). |
| * \return An interface structure for the comment extension. |
| */ |
| osl_interface_p osl_comment_interface() { |
| osl_interface_p interface = osl_interface_malloc(); |
| |
| interface->URI = strdup(OSL_URI_COMMENT); |
| interface->idump = (osl_idump_f)osl_comment_idump; |
| interface->sprint = (osl_sprint_f)osl_comment_sprint; |
| interface->sread = (osl_sread_f)osl_comment_sread; |
| interface->malloc = (osl_malloc_f)osl_comment_malloc; |
| interface->free = (osl_free_f)osl_comment_free; |
| interface->clone = (osl_clone_f)osl_comment_clone; |
| interface->equal = (osl_equal_f)osl_comment_equal; |
| |
| return interface; |
| } |
| |
