Add osl_relation_add function
[openscop.git] / include / osl / relation_list.h
bloba6e5883525485a555c153e9b7945bce824fbc874
2 /*+-----------------------------------------------------------------**
3 ** OpenScop Library **
4 **-----------------------------------------------------------------**
5 ** relation_list.h **
6 **-----------------------------------------------------------------**
7 ** First version: 08/10/2010 **
8 **-----------------------------------------------------------------**
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 *****************************************************************************/
64 #ifndef OSL_RELATION_LIST_H
65 # define OSL_RELATION_LIST_H
67 # include <stdio.h>
68 # include <osl/relation.h>
71 # if defined(__cplusplus)
72 extern "C"
74 # endif
77 /**
78 * The osl_relation_list_t structure describes a (NULL-terminated
79 * linked) list of relations.
81 struct osl_relation_list {
82 osl_relation_p elt; /**< An element of the list. */
83 struct osl_relation_list * next; /**< Pointer to the next element
84 of the list.*/
86 typedef struct osl_relation_list osl_relation_list_t;
87 typedef struct osl_relation_list * osl_relation_list_p;
90 /*+***************************************************************************
91 * Structure display function *
92 *****************************************************************************/
93 void osl_relation_list_idump(FILE *, osl_relation_list_p, int);
94 void osl_relation_list_dump(FILE *, osl_relation_list_p);
95 void osl_relation_list_pprint_elts(FILE *, osl_relation_list_p, osl_names_p);
96 void osl_relation_list_pprint(FILE *, osl_relation_list_p, osl_names_p);
97 void osl_relation_list_print(FILE *, osl_relation_list_p);
100 /*****************************************************************************
101 * Reading function *
102 *****************************************************************************/
103 osl_relation_list_p osl_relation_list_pread(FILE *, int);
104 osl_relation_list_p osl_relation_list_read(FILE *);
107 /*+***************************************************************************
108 * Memory allocation/deallocation function *
109 *****************************************************************************/
110 osl_relation_list_p osl_relation_list_malloc();
111 void osl_relation_list_free(osl_relation_list_p);
114 /*+***************************************************************************
115 * Processing functions *
116 *****************************************************************************/
117 osl_relation_list_p osl_relation_list_node(osl_relation_p);
118 osl_relation_list_p osl_relation_list_clone(osl_relation_list_p);
119 osl_relation_list_p osl_relation_list_concat(osl_relation_list_p,
120 osl_relation_list_p);
121 void osl_relation_list_add(osl_relation_list_p *,
122 osl_relation_list_p);
123 void osl_relation_list_push(osl_relation_list_p *,
124 osl_relation_list_p);
125 osl_relation_list_p osl_relation_list_pop(osl_relation_list_p *);
126 void osl_relation_list_dup(osl_relation_list_p *);
127 void osl_relation_list_drop(osl_relation_list_p *);
128 void osl_relation_list_destroy(osl_relation_list_p *);
129 int osl_relation_list_equal(osl_relation_list_p,
130 osl_relation_list_p);
131 int osl_relation_list_integrity_check(osl_relation_list_p,
132 int, int, int, int);
133 void osl_relation_list_set_type(osl_relation_list_p, int);
134 osl_relation_list_p osl_relation_list_filter(osl_relation_list_p, int);
135 int osl_relation_list_count(osl_relation_list_p);
136 void osl_relation_list_get_attributes(osl_relation_list_p,
137 int *, int *, int *,
138 int *, int *);
139 # if defined(__cplusplus)
141 # endif
142 #endif /* define OSL_RELATION_LIST_H */