LibraryDYLD.h

Go to the documentation of this file.

/****************** <VPR heading BEGIN do not edit this line> *****************
 *
 * VR Juggler Portable Runtime
 *
 * Original Authors:
 *   Allen Bierbaum, Patrick Hartling, Kevin Meinert, Carolina Cruz-Neira
 *
 * -----------------------------------------------------------------
 * File:          $RCSfile$
 * Date modified: $Date: 2005-01-17 22:34:01 -0600 (Mon, 17 Jan 2005) $
 * Version:       $Revision: 16635 $
 * -----------------------------------------------------------------
 *
 ****************** <VPR heading END do not edit this line> ******************/

/*************** <auto-copyright.pl BEGIN do not edit this line> **************
 *
 * VR Juggler is (C) Copyright 1998-2005 by Iowa State University
 *
 * Original Authors:
 *   Allen Bierbaum, Christopher Just,
 *   Patrick Hartling, Kevin Meinert,
 *   Carolina Cruz-Neira, Albert Baker
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Library General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Library General Public License for more details.
 *
 * You should have received a copy of the GNU Library General Public
 * License along with this library; if not, write to the
 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
 * Boston, MA 02111-1307, USA.
 *
 *************** <auto-copyright.pl END do not edit this line> ***************/

#ifndef _VPR_LIBRARY_DYLD_H_
#define _VPR_LIBRARY_DYLD_H_

#include <vpr/vprConfig.h>

#include <stdlib.h>
#include <string>

#include <vpr/Util/Assert.h>
#include <vpr/Util/ReturnStatus.h>

#if defined (__GNUC__) && __GNUC__ > 3
#define dl_restrict __restrict
#else
#define dl_restrict
#endif


namespace vpr
{

class LibraryDYLD
{
public:
   LibraryDYLD(const std::string& name)
      : mName(name)
      , mLibrary(NULL)
   {
      ;
   }

   LibraryDYLD()
      : mName("")
      , mLibrary(NULL)
   {
      ;
   }

   LibraryDYLD(const LibraryDYLD& lib)
      : mName("")
      , mLibrary(NULL)
   {
      copy(lib);
   }

   ~LibraryDYLD()
   {
      if ( NULL != mLibrary )
      {
         unload();
      }
   }

   LibraryDYLD& operator=(const LibraryDYLD& lib)
   {
      copy(lib);
      return *this;
   }

   const std::string& getName() const
   {
      return mName;
   }

   vpr::ReturnStatus load();

   vpr::ReturnStatus unload();

   bool isLoaded() const
   {
      return mLibrary != NULL;
   }


   void* findSymbol(const char* symbolName)
   {
      // If no library has been loaded yet, do it now.  This is done to mimic
      // the NSPR behavior.
      if ( NULL == mLibrary )
      {
         load();
         vprASSERT(NULL != mLibrary && "Could not load any library");
      }

      return internalDlsym(mLibrary, symbolName);
   }

   void* findSymbol(const std::string& symbolName)
   {
      return findSymbol(symbolName.c_str());
   }


   static void* findSymbolAndLibrary(const char* symbolName, LibraryDYLD& lib);

   static void* findSymbolAndLibrary(const std::string& symbolName,
                                     LibraryDYLD& lib)
   {
      return findSymbolAndLibrary(symbolName.c_str(), lib);
   }

protected:
   void copy(const LibraryDYLD& lib)
   {
      this->mName    = lib.mName;
      this->mLibrary = lib.mLibrary;
   }

   void* internalDlopen(const char* filename, int flag);

   const char* internalDlerror();

   void* internalDlsym(void* dl_restrict handle,
                       const char* dl_restrict symbol);

   int internalDlclose(void* handle);

private:
   std::string mName;      
   void*       mLibrary;   
};

} // End of vpr namespace


#endif /* _VPR_LIBRARY_DYLD_H_ */

---