1
2    /*+-----------------------------------------------------------------**
3     **                       OpenScop Library                          **
4     **-----------------------------------------------------------------**
5     **                    extensions/scatnames.h                       **
6     **-----------------------------------------------------------------**
7     **                   First version: 03/12/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_SCATNAMES_H
65# define OSL_SCATNAMES_H
66
67# include <stdio.h>
68# include <osl/interface.h>
69# include <osl/strings.h>
70
71# if defined(__cplusplus)
72extern "C"
73  {
74# endif
75
76
77# define OSL_URI_SCATNAMES        "scatnames"
78
79
80/**
81 * The osl_scatnames_t structure stores a scatnames extention to the core
82 * OpenScop representation. It is devoted to store the scattering dimension
83 * names in a textual form. The names are stored using an osl_strings_t
84 * structure and their order in the array corresponds to their dimension
85 * order.
86 */
87struct osl_scatnames {
88  osl_strings_p names;  /**< List of textual scattering dimension names. */
89};
90typedef struct osl_scatnames   osl_scatnames_t;
91typedef struct osl_scatnames * osl_scatnames_p;
92
93
94/*+***************************************************************************
95 *                          Structure display function                       *
96 *****************************************************************************/
97void            osl_scatnames_idump(FILE *, osl_scatnames_p, int);
98void            osl_scatnames_dump(FILE *, osl_scatnames_p);
99char *          osl_scatnames_sprint(osl_scatnames_p);
100
101
102/*****************************************************************************
103 *                               Reading function                            *
104 *****************************************************************************/
105osl_scatnames_p osl_scatnames_sread(char **);
106
107
108/*+***************************************************************************
109 *                    Memory allocation/deallocation function                *
110 *****************************************************************************/
111osl_scatnames_p osl_scatnames_malloc();
112void            osl_scatnames_free(osl_scatnames_p);
113
114
115/*+***************************************************************************
116 *                            Processing functions                           *
117 *****************************************************************************/
118osl_scatnames_p osl_scatnames_clone(osl_scatnames_p);
119int             osl_scatnames_equal(osl_scatnames_p, osl_scatnames_p);
120osl_interface_p osl_scatnames_interface();
121
122
123# if defined(__cplusplus)
124  }
125# endif
126
127#endif /* define OSL_SCATNAMES_H */
128