OpenScop  0.9.0
strings.h
Go to the documentation of this file.
1 
2  /*+-----------------------------------------------------------------**
3  ** OpenScop Library **
4  **-----------------------------------------------------------------**
5  ** strings.h **
6  **-----------------------------------------------------------------**
7  ** First version: 13/07/2011 **
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_STRINGS_H
65 # define OSL_STRINGS_H
66 
67 # include <stdio.h>
68 # include <osl/interface.h>
69 
70 # if defined(__cplusplus)
71 extern "C"
72  {
73 # endif
74 
75 # define OSL_URI_STRINGS "strings"
76 
77 /* The "strings" type is simply a NULL-terminated array of C character
78  * strings, i.e. a char **. It is encapsulated into a structure to allow
79  * its manipulation through a generic type.
80  */
81 struct osl_strings {
82  char ** string;
83 };
84 typedef struct osl_strings osl_strings_t;
85 typedef struct osl_strings * osl_strings_p;
86 typedef struct osl_strings const osl_const_strings_t;
87 typedef struct osl_strings * const osl_strings_const_p;
88 typedef struct osl_strings const * osl_const_strings_p;
89 typedef struct osl_strings const * const osl_const_strings_const_p;
90 
91 
92 /*+***************************************************************************
93  * Structure display function *
94  *****************************************************************************/
95 void osl_strings_idump(FILE *, osl_strings_p, int);
96 void osl_strings_dump(FILE *, osl_strings_p);
97 char * osl_strings_sprint(osl_strings_p);
98 void osl_strings_print(FILE *, osl_strings_p);
99 
100 
101 /*****************************************************************************
102  * Reading function *
103  *****************************************************************************/
104 osl_strings_p osl_strings_sread(char **);
105 osl_strings_p osl_strings_read(FILE *);
106 
107 /*+***************************************************************************
108  * Memory allocation/deallocation function *
109  *****************************************************************************/
110 osl_strings_p osl_strings_malloc();
111 void osl_strings_free(osl_strings_p);
112 
113 /*+***************************************************************************
114  * Processing functions *
115  *****************************************************************************/
116 osl_strings_p osl_strings_clone(osl_strings_p);
117 void osl_strings_add(osl_strings_p, char const * const);
118 size_t osl_strings_find(osl_strings_p, char const * const);
119 int osl_strings_equal(osl_strings_p, osl_strings_p);
120 size_t osl_strings_size(osl_const_strings_const_p);
121 osl_strings_p osl_strings_encapsulate(char *);
123 osl_strings_p osl_strings_generate(char *, int);
124 
125 
126 # if defined(__cplusplus)
127  }
128 # endif
129 
130 # if defined(__cplusplus)
131 #include <vector>
132 #include <string>
133 
134 namespace osl
135 {
141  inline
142  std::vector<std::string> osl_strings_to_cpp(osl_const_strings_const_p s) {
143  if (s != nullptr && s->string != nullptr) {
144  return std::vector<std::string>(s->string,
145  s->string + osl_strings_size(s));
146  }
147  else { return std::vector<std::string>(); }
148  }
149 }
150 # endif
151 
152 #endif /* define OSL_STRINGS_H */
void osl_strings_dump(FILE *, osl_strings_p)
Definition: strings.c:119
osl_interface_p osl_strings_interface()
Definition: strings.c:450
std::vector< std::string > osl_strings_to_cpp(osl_const_strings_const_p s)
Convert osl_strings to std::vector<std::string>
Definition: strings.h:142
struct osl_strings * osl_strings_p
Definition: strings.h:85
char ** string
Definition: strings.h:82
struct osl_strings const osl_const_strings_t
Definition: strings.h:86
void osl_strings_free(osl_strings_p)
Definition: strings.c:299
int osl_strings_equal(osl_strings_p, osl_strings_p)
Definition: strings.c:387
void osl_strings_add(osl_strings_p, char const *const)
Definition: strings.c:370
osl_strings_p osl_strings_malloc()
Definition: strings.c:283
osl_strings_p osl_strings_generate(char *, int)
Definition: strings.c:475
void osl_strings_idump(FILE *, osl_strings_p, int)
Definition: strings.c:89
struct osl_strings const *const osl_const_strings_const_p
Definition: strings.h:89
osl_strings_p osl_strings_sread(char **)
Definition: strings.c:194
struct osl_strings const * osl_const_strings_p
Definition: strings.h:88
osl_strings_p osl_strings_encapsulate(char *)
Definition: strings.c:433
char * osl_strings_sprint(osl_strings_p)
Definition: strings.c:131
osl_strings_p osl_strings_clone(osl_strings_p)
Definition: strings.c:328
size_t osl_strings_find(osl_strings_p, char const *const)
Definition: strings.c:355
struct osl_strings *const osl_strings_const_p
Definition: strings.h:87
void osl_strings_print(FILE *, osl_strings_p)
Definition: strings.c:166
osl_strings_p osl_strings_read(FILE *)
Definition: strings.c:259
size_t osl_strings_size(osl_const_strings_const_p)
Definition: strings.c:413