OpenScop  0.9.0
interface.h
Go to the documentation of this file.
00001 
00002     /*+-----------------------------------------------------------------**
00003      **                       OpenScop Library                          **
00004      **-----------------------------------------------------------------**
00005      **                          interface.h                            **
00006      **-----------------------------------------------------------------**
00007      **                   First version: 15/07/2011                     **
00008      **-----------------------------------------------------------------**
00009 
00010  
00011  *****************************************************************************
00012  * OpenScop: Structures and formats for polyhedral tools to talk together    *
00013  *****************************************************************************
00014  *    ,___,,_,__,,__,,__,,__,,_,__,,_,__,,__,,___,_,__,,_,__,                *
00015  *    /   / /  //  //  //  // /   / /  //  //   / /  // /  /|,_,             *
00016  *   /   / /  //  //  //  // /   / /  //  //   / /  // /  / / /\             *
00017  *  |~~~|~|~~~|~~~|~~~|~~~|~|~~~|~|~~~|~~~|~~~|~|~~~|~|~~~|/_/  \            *
00018  *  | G |C| P | = | L | P |=| = |C| = | = | = |=| = |=| C |\  \ /\           *
00019  *  | R |l| o | = | e | l |=| = |a| = | = | = |=| = |=| L | \# \ /\          *
00020  *  | A |a| l | = | t | u |=| = |n| = | = | = |=| = |=| o | |\# \  \         *
00021  *  | P |n| l | = | s | t |=| = |d| = | = | = | |   |=| o | | \# \  \        *
00022  *  | H | | y |   | e | o | | = |l|   |   | = | |   | | G | |  \  \  \       *
00023  *  | I | |   |   | e |   | |   | |   |   |   | |   | |   | |   \  \  \      *
00024  *  | T | |   |   |   |   | |   | |   |   |   | |   | |   | |    \  \  \     *
00025  *  | E | |   |   |   |   | |   | |   |   |   | |   | |   | |     \  \  \    *
00026  *  | * |*| * | * | * | * |*| * |*| * | * | * |*| * |*| * | /      \* \  \   *
00027  *  | O |p| e | n | S | c |o| p |-| L | i | b |r| a |r| y |/        \  \ /   *
00028  *  '---'-'---'---'---'---'-'---'-'---'---'---'-'---'-'---'          '--'    *
00029  *                                                                           *
00030  * Copyright (C) 2008 University Paris-Sud 11 and INRIA                      *
00031  *                                                                           *
00032  * (3-clause BSD license)                                                    *
00033  * Redistribution and use in source  and binary forms, with or without       *
00034  * modification, are permitted provided that the following conditions        *
00035  * are met:                                                                  *
00036  *                                                                           *
00037  * 1. Redistributions of source code must retain the above copyright notice, *
00038  *    this list of conditions and the following disclaimer.                  *
00039  * 2. Redistributions in binary form must reproduce the above copyright      *
00040  *    notice, this list of conditions and the following disclaimer in the    *
00041  *    documentation and/or other materials provided with the distribution.   *
00042  * 3. The name of the author may not be used to endorse or promote products  *
00043  *    derived from this software without specific prior written permission.  *
00044  *                                                                           *
00045  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR      *
00046  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES *
00047  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.   *
00048  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,          *
00049  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT  *
00050  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, *
00051  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY     *
00052  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT       *
00053  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF  *
00054  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.         *
00055  *                                                                           *
00056  * OpenScop Library, a library to manipulate OpenScop formats and data       *
00057  * structures. Written by:                                                   *
00058  * Cedric Bastoul     <Cedric.Bastoul@u-psud.fr> and                         *
00059  * Louis-Noel Pouchet <Louis-Noel.pouchet@inria.fr>                          *
00060  *                                                                           *
00061  *****************************************************************************/
00062 
00063 
00064 #ifndef OSL_INTERFACE_H
00065 # define OSL_INTERFACE_H
00066 
00067 # include <stdio.h>
00068 
00069 # if defined(__cplusplus)
00070 extern "C"
00071   {
00072 # endif
00073 
00074 
00075 typedef void   (*osl_idump_f) (FILE *, void *, int);
00076 typedef char * (*osl_sprint_f)(void *);
00077 typedef void * (*osl_sread_f) (char **);
00078 typedef void * (*osl_malloc_f)();
00079 typedef void   (*osl_free_f)  (void *);
00080 typedef void * (*osl_clone_f) (void *);
00081 typedef int    (*osl_equal_f) (void *, void *);
00082 
00083 
00089 struct osl_interface {
00090   char * URI;                  
00091   osl_idump_f  idump;          
00092   osl_sprint_f sprint;         
00093   osl_sread_f  sread;          
00094   osl_malloc_f malloc;         
00095   osl_free_f   free;           
00096   osl_clone_f  clone;          
00097   osl_equal_f  equal;          
00098   struct osl_interface * next; 
00099 };
00100 typedef struct osl_interface   osl_interface_t;
00101 typedef struct osl_interface * osl_interface_p;
00102 
00103 
00104 /*+***************************************************************************
00105  *                          Structure display function                       *
00106  *****************************************************************************/
00107 void            osl_interface_idump(FILE *, osl_interface_p, int);
00108 void            osl_interface_dump(FILE *, osl_interface_p);
00109 
00110 
00111 /*****************************************************************************
00112  *                               Reading function                            *
00113  *****************************************************************************/
00114 
00115 
00116 /*+***************************************************************************
00117  *                    Memory allocation/deallocation function                *
00118  *****************************************************************************/
00119 void            osl_interface_add(osl_interface_p *, osl_interface_p);
00120 osl_interface_p osl_interface_malloc();
00121 void            osl_interface_free(osl_interface_p);
00122 
00123 
00124 /*+***************************************************************************
00125  *                            Processing functions                           *
00126  *****************************************************************************/
00127 int             osl_interface_number(osl_interface_p);
00128 osl_interface_p osl_interface_nclone(osl_interface_p, int);
00129 osl_interface_p osl_interface_clone(osl_interface_p);
00130 int             osl_interface_equal(osl_interface_p, osl_interface_p);
00131 osl_interface_p osl_interface_lookup(osl_interface_p, char *);
00132 osl_interface_p osl_interface_get_default_registry();
00133 
00134 # if defined(__cplusplus)
00135   }
00136 # endif
00137 
00138 #endif /* define OSL_INTERFACE_H */