deps/libretro-common/include/dynamic/dylib.h

   1 /* Copyright  (C) 2010-2020 The RetroArch team
   2  *
   3  * ---------------------------------------------------------------------------------------
   4  * The following license statement only applies to this file (dylib.h).
   5  * ---------------------------------------------------------------------------------------
   6  *
   7  * Permission is hereby granted, free of charge,
   8  * to any person obtaining a copy of this software and associated documentation files (the "Software"),
   9  * to deal in the Software without restriction, including without limitation the rights to
  10  * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software,
  11  * and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
  12  *
  13  * The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
  14  *
  15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
  16  * INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  17  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
  18  * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
  19  * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  20  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  21  */
  22
  23 #ifndef __DYLIB_H
  24 #define __DYLIB_H
  25
  26 #include <boolean.h>
  27
  28 #ifdef HAVE_CONFIG_H
  29 #include "config.h"
  30 #endif
  31
  32 #include <retro_common_api.h>
  33
  34 #if defined(HAVE_DYNAMIC) || defined(HAVE_DYLIB)
  35 #define NEED_DYNAMIC
  36 #else
  37 #undef NEED_DYNAMIC
  38 #endif
  39
  40 RETRO_BEGIN_DECLS
  41
  42 typedef void *dylib_t;
  43 typedef void (*function_t)(void);
  44
  45 #ifdef NEED_DYNAMIC
  46 /**
  47  * dylib_load:
  48  * @path                         : Path to libretro core library.
  49  *
  50  * Platform independent dylib loading.
  51  *
  52  * @return Library handle on success, otherwise NULL.
  53  **/
  54 dylib_t dylib_load(const char *path);
  55
  56 /**
  57  * dylib_close:
  58  * @lib                          : Library handle.
  59  *
  60  * Frees library handle.
  61  **/
  62 void dylib_close(dylib_t lib);
  63
  64 char *dylib_error(void);
  65
  66 function_t dylib_proc(dylib_t lib, const char *proc);
  67 #endif
  68
  69 RETRO_END_DECLS
  70
  71 #endif