include/SDL_loadso.h
author Sam Lantinga <slouken@libsdl.org>
Thu, 13 Feb 2014 11:05:24 -0800
changeset 8210 581caa876b2e
parent 8149 681eb46b8ac4
child 8215 54555ad9342c
permissions -rw-r--r--
Added SDL_GetLoadedModule to do the equivalent of GetModuleHandle/dlload(NOLOAD)

CR: Jorgen
     1 /*
     2   Simple DirectMedia Layer
     3   Copyright (C) 1997-2014 Sam Lantinga <slouken@libsdl.org>
     4 
     5   This software is provided 'as-is', without any express or implied
     6   warranty.  In no event will the authors be held liable for any damages
     7   arising from the use of this software.
     8 
     9   Permission is granted to anyone to use this software for any purpose,
    10   including commercial applications, and to alter it and redistribute it
    11   freely, subject to the following restrictions:
    12 
    13   1. The origin of this software must not be misrepresented; you must not
    14      claim that you wrote the original software. If you use this software
    15      in a product, an acknowledgment in the product documentation would be
    16      appreciated but is not required.
    17   2. Altered source versions must be plainly marked as such, and must not be
    18      misrepresented as being the original software.
    19   3. This notice may not be removed or altered from any source distribution.
    20 */
    21 
    22 /**
    23  *  \file SDL_loadso.h
    24  *
    25  *  System dependent library loading routines
    26  *
    27  *  Some things to keep in mind:
    28  *  \li These functions only work on C function names.  Other languages may
    29  *      have name mangling and intrinsic language support that varies from
    30  *      compiler to compiler.
    31  *  \li Make sure you declare your function pointers with the same calling
    32  *      convention as the actual library function.  Your code will crash
    33  *      mysteriously if you do not do this.
    34  *  \li Avoid namespace collisions.  If you load a symbol from the library,
    35  *      it is not defined whether or not it goes into the global symbol
    36  *      namespace for the application.  If it does and it conflicts with
    37  *      symbols in your code or other shared libraries, you will not get
    38  *      the results you expect. :)
    39  */
    40 
    41 #ifndef _SDL_loadso_h
    42 #define _SDL_loadso_h
    43 
    44 #include "SDL_stdinc.h"
    45 #include "SDL_error.h"
    46 
    47 #include "begin_code.h"
    48 /* Set up for C function definitions, even when using C++ */
    49 #ifdef __cplusplus
    50 extern "C" {
    51 #endif
    52 
    53 /**
    54  *  This function dynamically loads a shared object and returns a pointer
    55  *  to the object handle (or NULL if there was an error).
    56  *  The 'sofile' parameter is a system dependent name of the object file.
    57  */
    58 extern DECLSPEC void *SDLCALL SDL_LoadObject(const char *sofile);
    59 
    60 /**
    61  *  This function returns a handle to an already-loaded shared object and 
    62  *  returns a pointer to the object handle. If the object file was not loaded
    63  *  the function returns NULL. This function adds a reference to the shared
    64  *  object, so the caller should call SDL_UnloadObject when they are finished
    65  *  with this reference to ensure that the object can be unloaded.
    66  *  The 'sofile' parameter is a system dependent name of the object file.
    67  */
    68 extern DECLSPEC void *SDLCALL SDL_GetLoadedObject(const char *sofile);
    69 
    70 /**
    71  *  Given an object handle, this function looks up the address of the
    72  *  named function in the shared object and returns it.  This address
    73  *  is no longer valid after calling SDL_UnloadObject().
    74  */
    75 extern DECLSPEC void *SDLCALL SDL_LoadFunction(void *handle,
    76                                                const char *name);
    77 
    78 /**
    79  *  Unload a shared object from memory.
    80  */
    81 extern DECLSPEC void SDLCALL SDL_UnloadObject(void *handle);
    82 
    83 /* Ends C function definitions when using C++ */
    84 #ifdef __cplusplus
    85 }
    86 #endif
    87 #include "close_code.h"
    88 
    89 #endif /* _SDL_loadso_h */
    90 
    91 /* vi: set ts=4 sw=4 expandtab: */