include/osl/interface.h

   1
   2     /*+-----------------------------------------------------------------**
   3      **                       OpenScop Library                          **
   4      **-----------------------------------------------------------------**
   5      **                          interface.h                            **
   6      **-----------------------------------------------------------------**
   7      **                   First version: 15/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_INTERFACE_H
  65 # define OSL_INTERFACE_H
  66
  67 # include <osl/macros.h>
  68
  69 # if defined(__cplusplus)
  70 extern "C"
  71   {
  72 # endif
  73
  74
  75 typedef void   (*osl_idump_f) (FILE *, void *, int);
  76 typedef void   (*osl_dump_f)  (FILE *, void *);
  77 typedef char * (*osl_sprint_f)(void *);
  78 typedef void * (*osl_sread_f) (char *);
  79 typedef void * (*osl_malloc_f)();
  80 typedef void   (*osl_free_f)  (void *);
  81 typedef void * (*osl_clone_f) (void *);
  82 typedef int    (*osl_equal_f) (void *, void *);
  83
  84
  85 /**
  86  * The osl_interface structure stores the URI and base
  87  * functions pointers an openscop object implementation has to offer. It
  88  * is a node in a NULL-terminated list of interfaces.
  89  */
  90 struct osl_interface {
  91   char * URI;                  /**< Unique identifier string */
  92   osl_idump_f  idump;          /**< Pointer to idump function */
  93   osl_dump_f   dump;           /**< Pointer to dump function */
  94   osl_sprint_f sprint;         /**< Pointer to sprint function */
  95   osl_sread_f  sread;          /**< Pointer to sread function */
  96   osl_malloc_f malloc;         /**< Pointer to malloc function */
  97   osl_free_f   free;           /**< Pointer to free function */
  98   osl_clone_f  clone;          /**< Pointer to clone function */
  99   osl_equal_f  equal;          /**< Pointer to equal function */
 100   struct osl_interface * next; /**< Next interface in the list */
 101 };
 102 typedef struct osl_interface   osl_interface_t;
 103 typedef struct osl_interface * osl_interface_p;
 104
 105
 106 /*+***************************************************************************
 107  *                          Structure display function                       *
 108  *****************************************************************************/
 109 void            osl_interface_idump(FILE *, osl_interface_p, int);
 110 void            osl_interface_dump(FILE *, osl_interface_p);
 111
 112
 113 /*****************************************************************************
 114  *                               Reading function                            *
 115  *****************************************************************************/
 116
 117
 118 /*+***************************************************************************
 119  *                    Memory allocation/deallocation function                *
 120  *****************************************************************************/
 121 void            osl_interface_add(osl_interface_p *, osl_interface_p);
 122 osl_interface_p osl_interface_malloc();
 123 void            osl_interface_free(osl_interface_p);
 124
 125
 126 /*+***************************************************************************
 127  *                            Processing functions                           *
 128  *****************************************************************************/
 129 osl_interface_p osl_interface_nclone(osl_interface_p, int);
 130 osl_interface_p osl_interface_clone(osl_interface_p);
 131 int             osl_interface_equal(osl_interface_p, osl_interface_p);
 132 osl_interface_p osl_interface_lookup(osl_interface_p, char *);
 133
 134 # if defined(__cplusplus)
 135   }
 136 # endif
 137
 138 #endif /* define OSL_INTERFACE_H */