src/OpenFOAM/db/dynamicLibrary/dlLibraryTable/dlLibraryTable.C

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 2011 OpenFOAM Foundation
   6      \\/     M anipulation  |
   7 -------------------------------------------------------------------------------
   8 License
   9     This file is part of OpenFOAM.
  10
  11     OpenFOAM is free software: you can redistribute it and/or modify it
  12     under the terms of the GNU General Public License as published by
  13     the Free Software Foundation, either version 3 of the License, or
  14     (at your option) any later version.
  15
  16     OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
  17     ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  18     FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  19     for more details.
  20
  21     You should have received a copy of the GNU General Public License
  22     along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
  23
  24 \*---------------------------------------------------------------------------*/
  25
  26 #include "dlLibraryTable.H"
  27 #include "OSspecific.H"
  28 #include "long.H"
  29
  30 // * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
  31
  32 defineTypeNameAndDebug(Foam::dlLibraryTable, 0);
  33
  34
  35 // * * * * * * * * * * * * * * * * Constructors  * * * * * * * * * * * * * * //
  36
  37 Foam::dlLibraryTable::dlLibraryTable()
  38 {}
  39
  40
  41 Foam::dlLibraryTable::dlLibraryTable
  42 (
  43     const dictionary& dict,
  44     const word& libsEntry
  45 )
  46 {
  47     open(dict, libsEntry);
  48 }
  49
  50
  51 // * * * * * * * * * * * * * * * * Destructor  * * * * * * * * * * * * * * * //
  52
  53 Foam::dlLibraryTable::~dlLibraryTable()
  54 {
  55     forAllReverse(libPtrs_, i)
  56     {
  57         if (libPtrs_[i])
  58         {
  59             if (debug)
  60             {
  61                 Info<< "dlLibraryTable::~dlLibraryTable() : closing "
  62                     << libNames_[i]
  63                     << " with handle " << long(libPtrs_[i]) << endl;
  64             }
  65             dlClose(libPtrs_[i]);
  66         }
  67     }
  68 }
  69
  70
  71 // * * * * * * * * * * * * * * * Member Functions  * * * * * * * * * * * * * //
  72
  73 bool Foam::dlLibraryTable::open
  74 (
  75     const fileName& functionLibName,
  76     const bool verbose
  77 )
  78 {
  79     if (functionLibName.size())
  80     {
  81         void* functionLibPtr = dlOpen(functionLibName, verbose);
  82
  83         if (debug)
  84         {
  85             Info<< "dlLibraryTable::open : opened " << functionLibName
  86                 << " resulting in handle " << long(functionLibPtr) << endl;
  87         }
  88
  89         if (!functionLibPtr)
  90         {
  91             if (verbose)
  92             {
  93                 WarningIn
  94                 (
  95                     "dlLibraryTable::open(const fileName&, const bool)"
  96                 )   << "could not load " << functionLibName
  97                     << endl;
  98             }
  99
 100             return false;
 101         }
 102         else
 103         {
 104             libPtrs_.append(functionLibPtr);
 105             libNames_.append(functionLibName);
 106             return true;
 107         }
 108     }
 109     else
 110     {
 111         return false;
 112     }
 113 }
 114
 115
 116 bool Foam::dlLibraryTable::close
 117 (
 118     const fileName& functionLibName,
 119     const bool verbose
 120 )
 121 {
 122     label index = -1;
 123     forAllReverse(libNames_, i)
 124     {
 125         if (libNames_[i] == functionLibName)
 126         {
 127             index = i;
 128             break;
 129         }
 130     }
 131
 132     if (index != -1)
 133     {
 134         if (debug)
 135         {
 136             Info<< "dlLibraryTable::close : closing " << functionLibName
 137                 << " with handle " << long(libPtrs_[index]) << endl;
 138         }
 139
 140         bool ok = dlClose(libPtrs_[index]);
 141
 142         libPtrs_[index] = NULL;
 143         libNames_[index] = fileName::null;
 144
 145         if (!ok)
 146         {
 147             if (verbose)
 148             {
 149                 WarningIn
 150                 (
 151                     "dlLibraryTable::close(const fileName&)"
 152                 )   << "could not close " << functionLibName
 153                     << endl;
 154             }
 155
 156             return false;
 157         }
 158
 159         return true;
 160     }
 161     return false;
 162 }
 163
 164
 165 void* Foam::dlLibraryTable::findLibrary(const fileName& functionLibName)
 166 {
 167     label index = -1;
 168     forAllReverse(libNames_, i)
 169     {
 170         if (libNames_[i] == functionLibName)
 171         {
 172             index = i;
 173             break;
 174         }
 175     }
 176
 177     if (index != -1)
 178     {
 179         return libPtrs_[index];
 180     }
 181     return NULL;
 182 }
 183
 184
 185 bool Foam::dlLibraryTable::open
 186 (
 187     const dictionary& dict,
 188     const word& libsEntry
 189 )
 190 {
 191     if (dict.found(libsEntry))
 192     {
 193         fileNameList libNames(dict.lookup(libsEntry));
 194
 195         bool allOpened = !libNames.empty();
 196
 197         forAll(libNames, i)
 198         {
 199             allOpened = dlLibraryTable::open(libNames[i]) && allOpened;
 200         }
 201
 202         return allOpened;
 203     }
 204     else
 205     {
 206         return false;
 207     }
 208 }
 209
 210
 211 // ************************************************************************* //