include/SDL_loadso.h
author Sam Lantinga <slouken@libsdl.org>
Mon, 19 Oct 2009 13:31:58 +0000
changeset 3407 d3baf5ac4e37
parent 2859 99210400e8b9
child 3697 f7b03b6838cb
permissions -rw-r--r--
Partial fix for bug #859

Header file update from Ken for improved doxygen output
     1 /*
     2     SDL - Simple DirectMedia Layer
     3     Copyright (C) 1997-2009 Sam Lantinga
     4 
     5     This library is free software; you can redistribute it and/or
     6     modify it under the terms of the GNU Lesser General Public
     7     License as published by the Free Software Foundation; either
     8     version 2.1 of the License, or (at your option) any later version.
     9 
    10     This library is distributed in the hope that it will be useful,
    11     but WITHOUT ANY WARRANTY; without even the implied warranty of
    12     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
    13     Lesser General Public License for more details.
    14 
    15     You should have received a copy of the GNU Lesser General Public
    16     License along with this library; if not, write to the Free Software
    17     Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
    18 
    19     Sam Lantinga
    20     slouken@libsdl.org
    21 */
    22 
    23 /**
    24  *  \file SDL_loadso.h
    25  *
    26  *  System dependent library loading routines
    27  *
    28  *  Some things to keep in mind:                                        
    29  *  \li These functions only work on C function names.  Other languages may
    30  *      have name mangling and intrinsic language support that varies from
    31  *      compiler to compiler.
    32  *  \li Make sure you declare your function pointers with the same calling
    33  *      convention as the actual library function.  Your code will crash
    34  *      mysteriously if you do not do this.
    35  *  \li Avoid namespace collisions.  If you load a symbol from the library,
    36  *      it is not defined whether or not it goes into the global symbol
    37  *      namespace for the application.  If it does and it conflicts with
    38  *      symbols in your code or other shared libraries, you will not get
    39  *      the results you expect. :)
    40  */
    41 
    42 #ifndef _SDL_loadso_h
    43 #define _SDL_loadso_h
    44 
    45 #include "SDL_stdinc.h"
    46 #include "SDL_error.h"
    47 
    48 #include "begin_code.h"
    49 /* Set up for C function definitions, even when using C++ */
    50 #ifdef __cplusplus
    51 /* *INDENT-OFF* */
    52 extern "C" {
    53 /* *INDENT-ON* */
    54 #endif
    55 
    56 /**
    57  *  This function dynamically loads a shared object and returns a pointer
    58  *  to the object handle (or NULL if there was an error).
    59  *  The 'sofile' parameter is a system dependent name of the object file.
    60  */
    61 extern DECLSPEC void *SDLCALL SDL_LoadObject(const char *sofile);
    62 
    63 /**
    64  *  Given an object handle, this function looks up the address of the
    65  *  named function in the shared object and returns it.  This address
    66  *  is no longer valid after calling SDL_UnloadObject().
    67  */
    68 extern DECLSPEC void *SDLCALL SDL_LoadFunction(void *handle,
    69                                                const char *name);
    70 
    71 /**
    72  *  Unload a shared object from memory.
    73  */
    74 extern DECLSPEC void SDLCALL SDL_UnloadObject(void *handle);
    75 
    76 /* Ends C function definitions when using C++ */
    77 #ifdef __cplusplus
    78 /* *INDENT-OFF* */
    79 }
    80 /* *INDENT-ON* */
    81 #endif
    82 #include "close_code.h"
    83 
    84 #endif /* _SDL_loadso_h */
    85 
    86 /* vi: set ts=4 sw=4 expandtab: */