MEDversionedApi.cxx

Aller à la documentation de ce fichier.
00001 /*  This file is part of MED.
00002  *
00003  *  COPYRIGHT (C) 1999 - 2011  EDF R&D, CEA/DEN
00004  *  MED is free software: you can redistribute it and/or modify
00005  *  it under the terms of the GNU Lesser General Public License as published by
00006  *  the Free Software Foundation, either version 3 of the License, or
00007  *  (at your option) any later version.
00008  *
00009  *  MED is distributed in the hope that it will be useful,
00010  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
00011  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00012  *  GNU Lesser General Public License for more details.
00013  *
00014  *  You should have received a copy of the GNU Lesser General Public License
00015  *  along with MED.  If not, see <http://www.gnu.org/licenses/>.
00016  */
00017 #include "MEDversionedApi.hxx"
00018 
00019 // extern "C" {
00020 #include "med_versioned.h"
00021 #include <med_utils.h>
00022 // }
00023 
00024 using namespace std;
00025 
00026 static MED_VERSIONED_API & MedVersionedApi=MED_VERSIONED_API::Instance();
00027 
00028 MED_VERSIONED_API& MED_VERSIONED_API::Instance() {
00029   static MED_VERSIONED_API obj;
00030   return obj;
00031 }
00032 
00033 void MED_VERSIONED_API::f77ApiIsSet() {
00034   //SSCRUTE ("initMedVersionedApiF thing");
00035   _f77ApiIsSet=true;
00036 }
00037 
00038 // Le mécanisme de driver permet de faire évoluer la représentation des informations
00039 // dans les fichiers MED nouvellement crées en restant
00040 // capable de lire/écrire des fichiers MED avec des représentations antérieures.
00041 // Cela permet donc une compatibilité ascendante en lecture/écriture des fichiers.
00042 //
00043 // 1) Les modifications d'implémentations d'une routine qui rendent impossible/incohérent
00044 // la lecture d'anciens fichiers avec les nouvelles modifications du modèle interne necessitent
00045 // le versionement de la routine dans cette table.
00046 //
00047 // 2) Les modifications d'implémentations d'une routine qui rendent impossible/incohérent
00048 // la lecture de nouveaux fichiers avec les anciennes bibliothèques doivent également faire
00049 // l'objet d'un  versionement dans cette table et non juste une modification dans les versions existantes.
00050 //
00051 // Ex : L'implémentation de MEDchampEcr entre 232 et 233 pour l'écriture des champs aux noeuds par maille.
00052 //    La nouvelle bibliothèque est capable de lire les anciens fichiers qui ne contiennent pas cette fonctionnalité.
00053 //    Cependant les anciennes bibliothèques ne sont pas capable de relire un fichier produit en 233 même
00054 //    si l'utilisateur veut ignorer la lecture de tels champs. En effet, MEDnChamp et MEDchampInfo nous indiqueront 
00055 //    la présence de champs qui seront illisible pour l'ancienne implémentation de l'API !
00056 //
00057 // Ceci permet à la nouvelle bibliothèque (233) qui lit un fichier 232 de se comporter comme la bibliothèque 232 
00058 // et éviter toute corrompuption du modèle 232.
00059 // Dans l'exemple précedent, si cette fonctionnalité n'avait pas eu d'impact sur le comportement
00060 // de MEDnChamp et MEDchampInfo en 232, il n'aurait pas été necessaire de versionner cette routine.
00061 // La seule protection possible pour les bibliothèques antérieures est de refuser la lecture de fichier MED dont le mineur
00062 // est supérieur à celui de la bibliothèque courante. (l'exemple précédent est versionné sur le release au lieu du mineur, 
00063 // la règle de versionement MED n'a pas été respectée).
00064 //
00065 // Les routines versionnées dont les numéros n'existent pas dans la version courante de la bibliothèque
00066 // n'ont pas étés modifiées depuis la version de la bibliothèque qui correspond à leur numéro de versionement.
00067 // Lorsque les routines wrappers (MEDchampEcr pour MEDchampEcr231,MEDchampEcr232,MEDchampEcr233) demandent leur implémentation
00068 // à getVersionedApi en fonction de la version avec laquelle le fichier traité à été crée, la première implémentation 
00069 // dont le numéro de versionement est inférieur ou égal à celui du fichier est renvoyé.
00070 // getVersionedApi gère les ruptures de compatibilité globale de bibliothèques (ex : on ne relit
00071 // pas de fichiers < 220 avec les biblioth�ques 2.3.x.
00072 // Dans ce mécanisme, il est également necessaire de se protéger d'une lecture de fichier dont le mineur du numéro
00073 // de version serait supérieur à celui de la bibliothèque.
00074 
00075 
00076 //
00077 // ******** POLITIQUE DE VERSIONEMENT DE LA BIBLIOTHEQUE MED ******
00078 //
00079 // Le versionement de la bibliothèque MED dans le fichier Makefile.am n'indique rien
00080 // sur la compatibilité/incompatibilité descendante.
00081 // Seule la capacité des anciens programmes à utiliser cette nouvelle bibliothèque dynamique est indiquée (ce qui
00082 // sera toujours le cas avec le système de driver si l'API utilisateur ne change pas (sauf ajout)).
00083 // Si l'API utilisateur change, le versionement libtool indique l'incompatibilité des anciens programmes à utiliser
00084 // la nouvelle biblioth�que. Le numéro de version majeur de la bibliothèque devrait également être incrémenté.
00085 // Si une nouvelle version majeure d'hdf est utilisée et qu'elle est incompatible avec l'ancienne le numéro majeur devrait
00086 // être également augmenté.
00087 //
00088 // Si le numéro de version mineur de la bibliothèque avec laquelle le fichier a été crée est supèrieur à celui de la
00089 // version de bibliothèque utilisée la bibliothèque doit renvoyer une erreur.
00090 //
00091 // Ceci implique qu'un ajout dans la table de versionement suppose l'incrément du numéro mineur de
00092 // la bibliothèque pour plus de lisiblité par les utilisateurs quand à l'incompatibilité descendante :
00093 // Une version de numéro mineur antérieur à celui de la bibliotèque MED courante ne pourra relire un fichier nouvellement
00094 // crée par cette nouvelle version. Celà suppose également que les numéros de versions dont seuls la partie
00095 // release change ne devrait pas apparaitre dans cette table. Ils correspondent à des corrections de BUG
00096 // qui n'entrainent pas une incompatibilité descendante.
00097 //
00098 // Ceci n'a pas toujours été respecté, ex1: 231, 232, 233
00099 // Par contre, ex2: 233 peut relire du 234
00100 //
00101 //
00102 // En résumé le versionement dans MED doit fonctionner de la manière suivante à partir de la 2.3.4 :
00103 //
00104 // -  x.y.z+1 indique qu'il s'agit d'une correction de BUG qui n'engendre pas d'évolution du modèle
00105 // ni d'incompatibilité de lecture de fichier avec x.y.z. Aucune nouvelle routine ne doit apparaître
00106 // dans la table de versionement. Les programmes compilés avec medx.y.z peuvent utiliser medx.y.z+1 sans
00107 // recompilation. Il y a donc compatibilité ascendante et descendante entre x.y.z  et x.y.z+1
00108 //
00109 // - x.y+1.z indique qu'il s'agit d'une correction de BUG et/ou évolution qui engendre soit une évolution
00110 // du modèle interne ou une incohérence avec l'utilisation de l'implémentation medx.y.z pour un fichier x.y+1.z.
00111 //  L'API de la bibliothèque ne change pas. Le système de driver permet la compatibilité ascendante.
00112 //  Il n'est pas necessaire de recompiler les programmes pour bénéficier de cette nouvelle version
00113 //  de la bibliothèque. Il n'y a pas de compatibilité descendante entre x.y+1.z x.y.z
00114 //
00115 // - x+1.y.z indique que l'API MED a changé ou que la version d'HDF utilisée n'est pas compatible
00116 //   avec celle de x.y.z. La documentation indique si les drivers permettent d'assurer la compatibilité
00117 //   ascendante. Il n'y a pas de compatibilité descendante avec x.y.z. Les programmes doivent être recompilés
00118 //   et certainement modifiés pour fonctionner avec x+1.Y.z
00119 //
00120 
00121 
00122 
00123 // REM : Ce container singleton est complété par les symboles fortran
00124 //       à l'appel de edfouv(...) dans la partie fortran de la bibliothèque.
00125 //       La méthode  f77ApiIsSet est alors appelée.
00126 //
00127 MED_VERSIONED_API::MED_VERSIONED_API() : map<keyType,
00128                                              MedFuncType>(),
00129                                          _f77ApiIsSet(false)
00130 {
00131   map<keyType,MedFuncType > &
00132     table  = ( map<keyType,
00133                MedFuncType > & ) *this ;
00134    table[ "MEDchampEcr231" ]           = MEDchampEcr231 ;
00135    table[ "MEDchampEcr232" ]           = MEDchampEcr232 ;
00136    table[ "MEDchampEcr233" ]           = MEDchampEcr233 ;
00137    table[ "MEDjointCr231" ]            = MEDjointCr231 ;
00138    table[ "MEDjointCr232" ]            = MEDjointCr232 ;
00139    table[ "MEDfamCr231" ]              = MEDfamCr231 ;
00140    table[ "MEDfamCr232" ]              = MEDfamCr232 ;
00141    table[ "_MEDdatasetNumEcrire231" ]  = _MEDdatasetNumEcrire231 ;
00142    table[ "_MEDdatasetNumEcrire232" ]  = _MEDdatasetNumEcrire232 ;
00143    table[ "_MEDdatasetNumLire231" ]    = _MEDdatasetNumLire231 ;
00144    table[ "_MEDdatasetNumLire232" ]    = _MEDdatasetNumLire232 ;
00145 }
00146 
00147 
00148 MedFuncType MED_VERSIONED_API::operator[]( const keyType & c ) const
00149 {
00150   map<keyType,MedFuncType > &table = (map<keyType,
00151                                    MedFuncType >&)*this ;
00152 
00153   map<keyType,MedFuncType >::iterator it = table.find( c );
00154   if ( it == table.end() ) return (MedFuncType) NULL;
00155   return (*it).second;
00156 }
00157 
00158 
00159 extern "C" {
00160   MedFuncType getVersionedApi(const char * const keycharpart,
00161                               const char * const keynumpart) {
00162     return MedVersionedApi[std::string(keycharpart)+std::string(keynumpart)];
00163   }
00164 
00165   void f77ApiIsSet(void * obj) {
00166     static_cast<MED_VERSIONED_API*>(obj)->f77ApiIsSet();
00167   }
00168 }

Généré le Mon May 16 17:10:23 2011 pour MED fichier par  doxygen 1.6.1