include/osl/generic.h

   1
   2     /*+-----------------------------------------------------------------**
   3      **                       OpenScop Library                          **
   4      **-----------------------------------------------------------------**
   5      **                           generic.h                             **
   6      **-----------------------------------------------------------------**
   7      **                   First version: 26/11/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_generic_H
  65 # define OSL_generic_H
  66
  67 # include <osl/interface.h>
  68
  69 # if defined(__cplusplus)
  70 extern "C"
  71   {
  72 # endif
  73
  74
  75 /**
  76  * The osl_generic_t structure stores OpenScop data and operations with
  77  * no pre-defined type. The information is accessible through the data pointer
  78  * while the type and operations are accessible through the interface pointer.
  79  * A generic is a also a node of a NULL-terminated linked list of generics.
  80  */
  81 struct osl_generic {
  82   void * data;               /**< Pointer to the data. */
  83   osl_interface_p interface; /**< Interface to work with the data. */
  84   struct osl_generic * next; /**< Pointer to the next generic. */
  85 };
  86 typedef struct osl_generic               osl_generic_t;
  87 typedef struct osl_generic       *       osl_generic_p;
  88 typedef struct osl_generic const         osl_const_generic_t;
  89 typedef struct osl_generic       * const osl_generic_const_p;
  90 typedef struct osl_generic const *       osl_const_generic_p;
  91 typedef struct osl_generic const * const osl_const_generic_const_p;
  92
  93
  94 /*+***************************************************************************
  95  *                          Structure display function                       *
  96  *****************************************************************************/
  97 void          osl_generic_idump(FILE *, osl_generic_p, int);
  98 void          osl_generic_dump(FILE *, osl_generic_p);
  99 void          osl_generic_print(FILE *, osl_generic_p);
 100 char*         osl_generic_sprint(osl_generic_p);
 101
 102 // SCoPLib Compatibility
 103 void          osl_generic_print_options_scoplib(FILE *, osl_generic_p);
 104
 105
 106 /*****************************************************************************
 107  *                               Reading function                            *
 108  *****************************************************************************/
 109 osl_generic_p osl_generic_sread(char **, osl_interface_p);
 110 osl_generic_p osl_generic_sread_one(char **, osl_interface_p);
 111 osl_generic_p osl_generic_read_one(FILE *, osl_interface_p);
 112 osl_generic_p osl_generic_read(FILE *, osl_interface_p);
 113
 114
 115 /*+***************************************************************************
 116  *                    Memory allocation/deallocation function                *
 117  *****************************************************************************/
 118 void          osl_generic_add(osl_generic_p*, osl_generic_p);
 119 void          osl_generic_remove_node(osl_generic_p*, osl_generic_p);
 120 void          osl_generic_remove(osl_generic_p*, char *);
 121 osl_generic_p osl_generic_malloc();
 122 void          osl_generic_free(osl_generic_p);
 123
 124
 125 /*+***************************************************************************
 126  *                            Processing functions                           *
 127  *****************************************************************************/
 128 int           osl_generic_number(osl_generic_p);
 129 osl_generic_p osl_generic_clone(osl_generic_p);
 130 osl_generic_p osl_generic_nclone(osl_generic_p, int);
 131 int           osl_generic_equal(osl_generic_p, osl_generic_p);
 132 int           osl_generic_has_URI(osl_const_generic_const_p,
 133                                   char const * const);
 134 void *        osl_generic_lookup(osl_generic_p, char const * const);
 135 osl_generic_p osl_generic_shell(void *, osl_interface_p);
 136 int           osl_generic_count(osl_generic_p);
 137
 138
 139 # if defined(__cplusplus)
 140   }
 141 # endif
 142
 143 #endif /* define OSL_generic_H */