src/gmxlib/vmddlopen.h

   1 /* -*- mode: c; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4; c-file-style: "stroustrup"; -*-
   2  *
   3  *
   4  * This file is part of Gromacs        Copyright (c) 1991-2008
   5  * David van der Spoel, Erik Lindahl, Berk Hess, University of Groningen.
   6  *
   7  * This program is free software; you can redistribute it and/or
   8  * modify it under the terms of the GNU General Public License
   9  * as published by the Free Software Foundation; either version 2
  10  * of the License, or (at your option) any later version.
  11  *
  12  * To help us fund GROMACS development, we humbly ask that you cite
  13  * the research papers on the package. Check out http://www.gromacs.org
  14  *
  15  * And Hey:
  16  * Gnomes, ROck Monsters And Chili Sauce
  17  */
  18
  19 /***************************************************************************
  20  *cr
  21  *cr            (C) Copyright 1995-2009 The Board of Trustees of the
  22  *cr                        University of Illinois
  23  *cr                         All Rights Reserved
  24  *cr
  25 Developed by:           Theoretical and Computational Biophysics Group
  26                         University of Illinois at Urbana-Champaign
  27                         http://www.ks.uiuc.edu/
  28
  29 Permission is hereby granted, free of charge, to any person obtaining a copy of
  30 this software and associated documentation files (the Software), to deal with
  31 the Software without restriction, including without limitation the rights to
  32 use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
  33 of the Software, and to permit persons to whom the Software is furnished to
  34 do so, subject to the following conditions:
  35
  36 Redistributions of source code must retain the above copyright notice,
  37 this list of conditions and the following disclaimers.
  38
  39 Redistributions in binary form must reproduce the above copyright notice,
  40 this list of conditions and the following disclaimers in the documentation
  41 and/or other materials provided with the distribution.
  42
  43 Neither the names of Theoretical and Computational Biophysics Group,
  44 University of Illinois at Urbana-Champaign, nor the names of its contributors
  45 may be used to endorse or promote products derived from this Software without
  46 specific prior written permission.
  47
  48 THE SOFTWARE IS PROVIDED AS IS, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  49 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  50 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
  51 THE CONTRIBUTORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
  52 OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
  53 ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
  54 OTHER DEALINGS WITH THE SOFTWARE.
  55  ***************************************************************************/
  56
  57 /***************************************************************************
  58  * RCS INFORMATION:
  59  *
  60  *      $RCSfile: vmddlopen.h,v $
  61  *      $Author: johns $        $Locker:  $             $State: Exp $
  62  *      $Revision: 1.9 $      $Date: 2009/07/07 02:40:05 $
  63  *
  64  ***************************************************************************
  65  * DESCRIPTION:
  66  *   Routines for loading dynamic link libraries and shared object files
  67  *   on various platforms, abstracting from machine dependent APIs.
  68  *
  69  * LICENSE:
  70  *   UIUC Open Source License
  71  *   http://www.ks.uiuc.edu/Research/vmd/plugins/pluginlicense.html
  72  *
  73  ***************************************************************************/
  74
  75 /*
  76  * vmddlopen: thin multi-platform wrapper around dlopen/LoadLibrary
  77  */
  78
  79 #ifndef VMD_DLOPEN__
  80
  81 #ifdef __cplusplus
  82 extern "C" {
  83 #endif
  84
  85 /* Try to open the specified library.  All symbols must be resolved or the
  86  * load will fail (RTLD_NOW).
  87  */
  88 void *vmddlopen(const char *fname);
  89
  90 /* Try to load the specified symbol using the given handle.  Returns NULL if
  91  * the symbol cannot be loaded.
  92  */
  93 void *vmddlsym(void *h, const char *sym);
  94
  95 /* Unload the library.  Return 0 on success, nonzero on error.
  96  */
  97 int vmddlclose(void *h);
  98
  99 /* Return last error from any of the above functions.  Not thread-safe on
 100  * Windows due to static buffer in our code.
 101  */
 102 const char *vmddlerror(void);
 103
 104 #ifdef __cplusplus
 105 }
 106 #endif
 107
 108 #endif
 109