OpenScop  0.9.0
scop.h
Go to the documentation of this file.
00001 
00002     /*+-----------------------------------------------------------------**
00003      **                       OpenScop Library                          **
00004      **-----------------------------------------------------------------**
00005      **                            scop.h                               **
00006      **-----------------------------------------------------------------**
00007      **                   First version: 30/04/2008                     **
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 /*+****************************************************************************
00065  *  THIS FILE HAS BEEN AUTOMATICALLY GENERATED FROM scop.h.in BY configure    *
00066  ******************************************************************************/
00067 
00068 
00069 #ifndef OSL_SCOP_H
00070 # define OSL_SCOP_H
00071 
00072 # include <unistd.h>
00073 
00074 # define OSL_RELEASE "0.9.0"
00075 
00076 # include <osl/relation.h>
00077 # include <osl/interface.h>
00078 # include <osl/generic.h>
00079 # include <osl/statement.h>
00080 
00081 
00082 # if defined(__cplusplus)
00083 extern "C"
00084   {
00085 # endif
00086 
00087 
00097 struct osl_scop {
00098   int version;               
00099   char * language;           
00100   osl_relation_p context;    
00101   osl_generic_p parameters;  
00102   osl_statement_p statement; 
00103   osl_interface_p registry;  
00104   osl_generic_p extension;   
00105   void * usr;                
00107   struct osl_scop * next;    
00108 };
00109 typedef struct osl_scop   osl_scop_t;
00110 typedef struct osl_scop * osl_scop_p;
00111 
00112 
00113 /*+***************************************************************************
00114  *                          Structure display function                       *
00115  *****************************************************************************/
00116 void       osl_scop_idump(FILE *, osl_scop_p, int);
00117 void       osl_scop_dump(FILE *, osl_scop_p);
00118 void       osl_scop_print(FILE *, osl_scop_p);
00119 
00120 // SCoPLib Compatibility
00121 void       osl_scop_print_scoplib(FILE *, osl_scop_p);
00122 
00123 
00124 /*****************************************************************************
00125  *                               Reading function                            *
00126  *****************************************************************************/
00127 osl_scop_p osl_scop_pread(FILE *, osl_interface_p, int);
00128 osl_scop_p osl_scop_read(FILE *);
00129 
00130 
00131 /*+***************************************************************************
00132  *                    Memory allocation/deallocation function                *
00133  *****************************************************************************/
00134 osl_scop_p osl_scop_malloc();
00135 void       osl_scop_free(osl_scop_p);
00136 
00137 
00138 /*+***************************************************************************
00139  *                            Processing functions                           *
00140  *****************************************************************************/
00141 void       osl_scop_add(osl_scop_p *, osl_scop_p);
00142 size_t     osl_scop_number(osl_scop_p);
00143 osl_scop_p osl_scop_clone(osl_scop_p);
00144 int        osl_scop_equal(osl_scop_p, osl_scop_p);
00145 int        osl_scop_integrity_check(osl_scop_p);
00146 int        osl_scop_check_compatible_scoplib(osl_scop_p);
00147 int        osl_scop_get_nb_parameters(osl_scop_p);
00148 void       osl_scop_register_extension(osl_scop_p, osl_interface_p);
00149 void       osl_scop_get_attributes(osl_scop_p,
00150                                    int *, int *, int *, int *, int *);
00151 void       osl_scop_normalize_scattering(osl_scop_p);
00152 
00153 osl_names_p osl_scop_names(osl_scop_p scop);
00154 
00155 # if defined(__cplusplus)
00156   }
00157 # endif
00158 
00159 #endif /* define OSL_SCOP_H */