OpenScop  0.9.0
comment.h
Go to the documentation of this file.
1 
2  /*+-----------------------------------------------------------------**
3  ** OpenScop Library **
4  **-----------------------------------------------------------------**
5  ** extensions/comment.h **
6  **-----------------------------------------------------------------**
7  ** First version: 07/12/2010 **
8  **-----------------------------------------------------------------**
9 
10 
11  *****************************************************************************
12  * OpenScop: Structures and formats for polyhedral tools to talk together *
13  *****************************************************************************
14  * ,___,,_,__,,__,,__,,__,,_,__,,_,__,,__,,___,_,__,,_,__, *
15  * / / / // // // // / / / // // / / // / /|,_, *
16  * / / / // // // // / / / // // / / // / / / /\ *
17  * |~~~|~|~~~|~~~|~~~|~~~|~|~~~|~|~~~|~~~|~~~|~|~~~|~|~~~|/_/ \ *
18  * | G |C| P | = | L | P |=| = |C| = | = | = |=| = |=| C |\ \ /\ *
19  * | R |l| o | = | e | l |=| = |a| = | = | = |=| = |=| L | \# \ /\ *
20  * | A |a| l | = | t | u |=| = |n| = | = | = |=| = |=| o | |\# \ \ *
21  * | P |n| l | = | s | t |=| = |d| = | = | = | | |=| o | | \# \ \ *
22  * | H | | y | | e | o | | = |l| | | = | | | | G | | \ \ \ *
23  * | I | | | | e | | | | | | | | | | | | | \ \ \ *
24  * | T | | | | | | | | | | | | | | | | | \ \ \ *
25  * | E | | | | | | | | | | | | | | | | | \ \ \ *
26  * | * |*| * | * | * | * |*| * |*| * | * | * |*| * |*| * | / \* \ \ *
27  * | O |p| e | n | S | c |o| p |-| L | i | b |r| a |r| y |/ \ \ / *
28  * '---'-'---'---'---'---'-'---'-'---'---'---'-'---'-'---' '--' *
29  * *
30  * Copyright (C) 2008 University Paris-Sud 11 and INRIA *
31  * *
32  * (3-clause BSD license) *
33  * Redistribution and use in source and binary forms, with or without *
34  * modification, are permitted provided that the following conditions *
35  * are met: *
36  * *
37  * 1. Redistributions of source code must retain the above copyright notice, *
38  * this list of conditions and the following disclaimer. *
39  * 2. Redistributions in binary form must reproduce the above copyright *
40  * notice, this list of conditions and the following disclaimer in the *
41  * documentation and/or other materials provided with the distribution. *
42  * 3. The name of the author may not be used to endorse or promote products *
43  * derived from this software without specific prior written permission. *
44  * *
45  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR *
46  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES *
47  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. *
48  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, *
49  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT *
50  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, *
51  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY *
52  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT *
53  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF *
54  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. *
55  * *
56  * OpenScop Library, a library to manipulate OpenScop formats and data *
57  * structures. Written by: *
58  * Cedric Bastoul <Cedric.Bastoul@u-psud.fr> and *
59  * Louis-Noel Pouchet <Louis-Noel.pouchet@inria.fr> *
60  * *
61  *****************************************************************************/
62 
63 
64 #ifndef OSL_COMMENT_H
65 # define OSL_COMMENT_H
66 
67 # include <stdio.h>
68 # include <osl/interface.h>
69 
70 # if defined(__cplusplus)
71 extern "C"
72  {
73 # endif
74 
75 
76 # define OSL_URI_COMMENT "comment"
77 
78 
83 struct osl_comment {
84  char * comment;
85 };
86 typedef struct osl_comment osl_comment_t;
87 typedef struct osl_comment * osl_comment_p;
88 
89 
90 /*+***************************************************************************
91  * Structure display function *
92  *****************************************************************************/
93 void osl_comment_idump(FILE *, osl_comment_p, int);
94 void osl_comment_dump(FILE *, osl_comment_p);
95 char * osl_comment_sprint(osl_comment_p);
96 
97 
98 /*****************************************************************************
99  * Reading function *
100  *****************************************************************************/
101 osl_comment_p osl_comment_sread(char **);
102 
103 
104 /*+***************************************************************************
105  * Memory allocation/deallocation function *
106  *****************************************************************************/
107 osl_comment_p osl_comment_malloc();
108 void osl_comment_free(osl_comment_p);
109 
110 
111 /*+***************************************************************************
112  * Processing functions *
113  *****************************************************************************/
114 osl_comment_p osl_comment_clone(osl_comment_p);
115 int osl_comment_equal(osl_comment_p, osl_comment_p);
117 
118 
119 # if defined(__cplusplus)
120  }
121 # endif
122 
123 #endif /* define OSL_COMMENT_H */
osl_comment_p osl_comment_sread(char **)
Definition: comment.c:178
char * comment
Definition: comment.h:84
osl_comment_p osl_comment_malloc()
Definition: comment.c:213
void osl_comment_free(osl_comment_p)
Definition: comment.c:229
int osl_comment_equal(osl_comment_p, osl_comment_p)
Definition: comment.c:271
void osl_comment_dump(FILE *, osl_comment_p)
Definition: comment.c:130
osl_interface_p osl_comment_interface()
Definition: comment.c:297
void osl_comment_idump(FILE *, osl_comment_p, int)
Definition: comment.c:88
char * osl_comment_sprint(osl_comment_p)
Definition: comment.c:142
osl_comment_p osl_comment_clone(osl_comment_p)
Definition: comment.c:250
struct osl_comment * osl_comment_p
Definition: comment.h:87