include/openscop/names.h

   1
   2     /*+-----------------------------------------------------------------**
   3      **                       OpenScop Library                          **
   4      **-----------------------------------------------------------------**
   5      **                      extensions/names.h                         **
   6      **-----------------------------------------------------------------**
   7      **                   First version: 18/05/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 OPENSCOP_NAMES_H
  65 # define OPENSCOP_NAMES_H
  66
  67 # include <openscop/macros.h>
  68 # include <openscop/util.h>
  69 # include <openscop/strings.h>
  70
  71 # if defined(__cplusplus)
  72 extern "C"
  73   {
  74 # endif
  75
  76
  77 /**
  78  * The openscop_names_t structure stores the various names (names of iterators,
  79  * parameters...) necessary to generate a code from the OpenScop data
  80  * structure. The term "name" is generic and corresponds to a pointer to the
  81  * information necessary to generate the code. A name may be a string of
  82  * characters (char *) or a pointer to anything else. For textual tools
  83  * convenience, the default type is (char *), but it may be casted to your
  84  * preferred type iff the "textual" field is 0.
  85  */
  86 struct openscop_names {
  87   int textual;        /**< 1 if names are character strings, 0 otherwise. */
  88   int nb_parameters;  /**< Number of parameters names. */
  89   int nb_iterators;   /**< Number of iterators names. */
  90   int nb_scattdims;   /**< Number of scattering dimensions names. */
  91   char ** parameters; /**< Array of nb_parameters parameter names. */
  92   char ** iterators;  /**< Array of nb_iterators iterator names. */
  93   char ** scattdims;  /**< Array of nb_scattdims scattering dimension names. */
  94
  95   // The following is not part of the OpenScop specification (internal use).
  96   int nb_localdims;   //   Number of local dimension names.
  97   int nb_arrays;      //   Number of array names.
  98   char ** localdims;  //   Array of nb_locals local dimension names.
  99   char ** arrays;     //   Array of nb_arrays array dimension names.
 100 };
 101 typedef struct openscop_names   openscop_names_t;
 102 typedef struct openscop_names * openscop_names_p;
 103
 104
 105 /*+***************************************************************************
 106  *                          Structure display function                       *
 107  *****************************************************************************/
 108 void             openscop_names_idump(FILE *, openscop_names_p, int);
 109 void             openscop_names_dump(FILE *, openscop_names_p);
 110 void             openscop_names_print(FILE *, openscop_names_p);
 111
 112
 113 /*****************************************************************************
 114  *                               Reading function                            *
 115  *****************************************************************************/
 116 openscop_names_p openscop_names_read(FILE *);
 117
 118
 119 /*+***************************************************************************
 120  *                    Memory allocation/deallocation function                *
 121  *****************************************************************************/
 122 openscop_names_p openscop_names_malloc();
 123 void             openscop_names_free(openscop_names_p);
 124
 125
 126 /*+***************************************************************************
 127  *                            Processing functions                           *
 128  *****************************************************************************/
 129 openscop_names_p openscop_names_clone(openscop_names_p);
 130 int              openscop_names_equal(openscop_names_p, openscop_names_p);
 131 int              openscop_names_integrity_check(openscop_names_p,int,int,int);
 132
 133
 134 # if defined(__cplusplus)
 135   }
 136 # endif
 137
 138 #endif /* define OPENSCOP_NAMES_H */