include/SDL_loadso.h
author Sam Lantinga <slouken@libsdl.org>
Wed, 17 May 2006 18:57:04 +0000
changeset 1850 d5d3a6fe05a1
parent 1358 c71e05b4dc2e
child 1662 782fd950bd46
child 1895 c121d94672cb
child 4159 a1b03ba2fcd0
permissions -rw-r--r--
Fixed thread callback calling conventions, updated OS/2 DLL name to SDL12.dll
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
648
12a21d82a060 Exposed SDL_LoadObject(), SDL_LoadFunction(), and SDL_UnloadObject() APIs
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
     1
/*
12a21d82a060 Exposed SDL_LoadObject(), SDL_LoadFunction(), and SDL_UnloadObject() APIs
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
     2
    SDL - Simple DirectMedia Layer
1312
c9b51268668f Updated copyright information and removed rcs id lines (problematic in branch merges)
Sam Lantinga <slouken@libsdl.org>
parents: 769
diff changeset
     3
    Copyright (C) 1997-2006 Sam Lantinga
648
12a21d82a060 Exposed SDL_LoadObject(), SDL_LoadFunction(), and SDL_UnloadObject() APIs
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
     4
12a21d82a060 Exposed SDL_LoadObject(), SDL_LoadFunction(), and SDL_UnloadObject() APIs
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
     5
    This library is free software; you can redistribute it and/or
1312
c9b51268668f Updated copyright information and removed rcs id lines (problematic in branch merges)
Sam Lantinga <slouken@libsdl.org>
parents: 769
diff changeset
     6
    modify it under the terms of the GNU Lesser General Public
648
12a21d82a060 Exposed SDL_LoadObject(), SDL_LoadFunction(), and SDL_UnloadObject() APIs
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
     7
    License as published by the Free Software Foundation; either
1312
c9b51268668f Updated copyright information and removed rcs id lines (problematic in branch merges)
Sam Lantinga <slouken@libsdl.org>
parents: 769
diff changeset
     8
    version 2.1 of the License, or (at your option) any later version.
648
12a21d82a060 Exposed SDL_LoadObject(), SDL_LoadFunction(), and SDL_UnloadObject() APIs
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
     9
12a21d82a060 Exposed SDL_LoadObject(), SDL_LoadFunction(), and SDL_UnloadObject() APIs
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
    10
    This library is distributed in the hope that it will be useful,
12a21d82a060 Exposed SDL_LoadObject(), SDL_LoadFunction(), and SDL_UnloadObject() APIs
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
    11
    but WITHOUT ANY WARRANTY; without even the implied warranty of
12a21d82a060 Exposed SDL_LoadObject(), SDL_LoadFunction(), and SDL_UnloadObject() APIs
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
    12
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
1312
c9b51268668f Updated copyright information and removed rcs id lines (problematic in branch merges)
Sam Lantinga <slouken@libsdl.org>
parents: 769
diff changeset
    13
    Lesser General Public License for more details.
648
12a21d82a060 Exposed SDL_LoadObject(), SDL_LoadFunction(), and SDL_UnloadObject() APIs
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
    14
1312
c9b51268668f Updated copyright information and removed rcs id lines (problematic in branch merges)
Sam Lantinga <slouken@libsdl.org>
parents: 769
diff changeset
    15
    You should have received a copy of the GNU Lesser General Public
c9b51268668f Updated copyright information and removed rcs id lines (problematic in branch merges)
Sam Lantinga <slouken@libsdl.org>
parents: 769
diff changeset
    16
    License along with this library; if not, write to the Free Software
c9b51268668f Updated copyright information and removed rcs id lines (problematic in branch merges)
Sam Lantinga <slouken@libsdl.org>
parents: 769
diff changeset
    17
    Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
648
12a21d82a060 Exposed SDL_LoadObject(), SDL_LoadFunction(), and SDL_UnloadObject() APIs
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
    18
12a21d82a060 Exposed SDL_LoadObject(), SDL_LoadFunction(), and SDL_UnloadObject() APIs
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
    19
    Sam Lantinga
12a21d82a060 Exposed SDL_LoadObject(), SDL_LoadFunction(), and SDL_UnloadObject() APIs
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
    20
    slouken@libsdl.org
12a21d82a060 Exposed SDL_LoadObject(), SDL_LoadFunction(), and SDL_UnloadObject() APIs
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
    21
*/
12a21d82a060 Exposed SDL_LoadObject(), SDL_LoadFunction(), and SDL_UnloadObject() APIs
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
    22
12a21d82a060 Exposed SDL_LoadObject(), SDL_LoadFunction(), and SDL_UnloadObject() APIs
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
    23
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
12a21d82a060 Exposed SDL_LoadObject(), SDL_LoadFunction(), and SDL_UnloadObject() APIs
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
    24
/* System dependent library loading routines                           */
12a21d82a060 Exposed SDL_LoadObject(), SDL_LoadFunction(), and SDL_UnloadObject() APIs
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
    25
649
81c74904f51f Added some notes from the benefit of my experience. :)
Sam Lantinga <slouken@libsdl.org>
parents: 648
diff changeset
    26
/* Some things to keep in mind:                                        
81c74904f51f Added some notes from the benefit of my experience. :)
Sam Lantinga <slouken@libsdl.org>
parents: 648
diff changeset
    27
   - These functions only work on C function names.  Other languages may
81c74904f51f Added some notes from the benefit of my experience. :)
Sam Lantinga <slouken@libsdl.org>
parents: 648
diff changeset
    28
     have name mangling and intrinsic language support that varies from
81c74904f51f Added some notes from the benefit of my experience. :)
Sam Lantinga <slouken@libsdl.org>
parents: 648
diff changeset
    29
     compiler to compiler.
81c74904f51f Added some notes from the benefit of my experience. :)
Sam Lantinga <slouken@libsdl.org>
parents: 648
diff changeset
    30
   - Make sure you declare your function pointers with the same calling
81c74904f51f Added some notes from the benefit of my experience. :)
Sam Lantinga <slouken@libsdl.org>
parents: 648
diff changeset
    31
     convention as the actual library function.  Your code will crash
81c74904f51f Added some notes from the benefit of my experience. :)
Sam Lantinga <slouken@libsdl.org>
parents: 648
diff changeset
    32
     mysteriously if you do not do this.
81c74904f51f Added some notes from the benefit of my experience. :)
Sam Lantinga <slouken@libsdl.org>
parents: 648
diff changeset
    33
   - Avoid namespace collisions.  If you load a symbol from the library,
81c74904f51f Added some notes from the benefit of my experience. :)
Sam Lantinga <slouken@libsdl.org>
parents: 648
diff changeset
    34
     it is not defined whether or not it goes into the global symbol
81c74904f51f Added some notes from the benefit of my experience. :)
Sam Lantinga <slouken@libsdl.org>
parents: 648
diff changeset
    35
     namespace for the application.  If it does and it conflicts with
81c74904f51f Added some notes from the benefit of my experience. :)
Sam Lantinga <slouken@libsdl.org>
parents: 648
diff changeset
    36
     symbols in your code or other shared libraries, you will not get
81c74904f51f Added some notes from the benefit of my experience. :)
Sam Lantinga <slouken@libsdl.org>
parents: 648
diff changeset
    37
     the results you expect. :)
81c74904f51f Added some notes from the benefit of my experience. :)
Sam Lantinga <slouken@libsdl.org>
parents: 648
diff changeset
    38
*/
81c74904f51f Added some notes from the benefit of my experience. :)
Sam Lantinga <slouken@libsdl.org>
parents: 648
diff changeset
    39
81c74904f51f Added some notes from the benefit of my experience. :)
Sam Lantinga <slouken@libsdl.org>
parents: 648
diff changeset
    40
648
12a21d82a060 Exposed SDL_LoadObject(), SDL_LoadFunction(), and SDL_UnloadObject() APIs
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
    41
#ifndef _SDL_loadso_h
12a21d82a060 Exposed SDL_LoadObject(), SDL_LoadFunction(), and SDL_UnloadObject() APIs
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
    42
#define _SDL_loadso_h
12a21d82a060 Exposed SDL_LoadObject(), SDL_LoadFunction(), and SDL_UnloadObject() APIs
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
    43
1356
67114343400d *** empty log message ***
Sam Lantinga <slouken@libsdl.org>
parents: 1312
diff changeset
    44
#include "SDL_stdinc.h"
1358
c71e05b4dc2e More header massaging... works great on Windows. ;-)
Sam Lantinga <slouken@libsdl.org>
parents: 1356
diff changeset
    45
#include "SDL_error.h"
1356
67114343400d *** empty log message ***
Sam Lantinga <slouken@libsdl.org>
parents: 1312
diff changeset
    46
648
12a21d82a060 Exposed SDL_LoadObject(), SDL_LoadFunction(), and SDL_UnloadObject() APIs
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
    47
#include "begin_code.h"
12a21d82a060 Exposed SDL_LoadObject(), SDL_LoadFunction(), and SDL_UnloadObject() APIs
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
    48
/* Set up for C function definitions, even when using C++ */
12a21d82a060 Exposed SDL_LoadObject(), SDL_LoadFunction(), and SDL_UnloadObject() APIs
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
    49
#ifdef __cplusplus
12a21d82a060 Exposed SDL_LoadObject(), SDL_LoadFunction(), and SDL_UnloadObject() APIs
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
    50
extern "C" {
12a21d82a060 Exposed SDL_LoadObject(), SDL_LoadFunction(), and SDL_UnloadObject() APIs
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
    51
#endif
12a21d82a060 Exposed SDL_LoadObject(), SDL_LoadFunction(), and SDL_UnloadObject() APIs
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
    52
12a21d82a060 Exposed SDL_LoadObject(), SDL_LoadFunction(), and SDL_UnloadObject() APIs
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
    53
/* This function dynamically loads a shared object and returns a pointer
12a21d82a060 Exposed SDL_LoadObject(), SDL_LoadFunction(), and SDL_UnloadObject() APIs
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
    54
 * to the object handle (or NULL if there was an error).
12a21d82a060 Exposed SDL_LoadObject(), SDL_LoadFunction(), and SDL_UnloadObject() APIs
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
    55
 * The 'sofile' parameter is a system dependent name of the object file.
12a21d82a060 Exposed SDL_LoadObject(), SDL_LoadFunction(), and SDL_UnloadObject() APIs
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
    56
 */
12a21d82a060 Exposed SDL_LoadObject(), SDL_LoadFunction(), and SDL_UnloadObject() APIs
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
    57
extern DECLSPEC void * SDLCALL SDL_LoadObject(const char *sofile);
12a21d82a060 Exposed SDL_LoadObject(), SDL_LoadFunction(), and SDL_UnloadObject() APIs
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
    58
12a21d82a060 Exposed SDL_LoadObject(), SDL_LoadFunction(), and SDL_UnloadObject() APIs
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
    59
/* Given an object handle, this function looks up the address of the
12a21d82a060 Exposed SDL_LoadObject(), SDL_LoadFunction(), and SDL_UnloadObject() APIs
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
    60
 * named function in the shared object and returns it.  This address
12a21d82a060 Exposed SDL_LoadObject(), SDL_LoadFunction(), and SDL_UnloadObject() APIs
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
    61
 * is no longer valid after calling SDL_UnloadObject().
12a21d82a060 Exposed SDL_LoadObject(), SDL_LoadFunction(), and SDL_UnloadObject() APIs
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
    62
 */
12a21d82a060 Exposed SDL_LoadObject(), SDL_LoadFunction(), and SDL_UnloadObject() APIs
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
    63
extern DECLSPEC void * SDLCALL SDL_LoadFunction(void *handle, const char *name);
12a21d82a060 Exposed SDL_LoadObject(), SDL_LoadFunction(), and SDL_UnloadObject() APIs
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
    64
12a21d82a060 Exposed SDL_LoadObject(), SDL_LoadFunction(), and SDL_UnloadObject() APIs
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
    65
/* Unload a shared object from memory */
12a21d82a060 Exposed SDL_LoadObject(), SDL_LoadFunction(), and SDL_UnloadObject() APIs
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
    66
extern DECLSPEC void SDLCALL SDL_UnloadObject(void *handle);
12a21d82a060 Exposed SDL_LoadObject(), SDL_LoadFunction(), and SDL_UnloadObject() APIs
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
    67
12a21d82a060 Exposed SDL_LoadObject(), SDL_LoadFunction(), and SDL_UnloadObject() APIs
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
    68
/* Ends C function definitions when using C++ */
12a21d82a060 Exposed SDL_LoadObject(), SDL_LoadFunction(), and SDL_UnloadObject() APIs
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
    69
#ifdef __cplusplus
12a21d82a060 Exposed SDL_LoadObject(), SDL_LoadFunction(), and SDL_UnloadObject() APIs
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
    70
}
12a21d82a060 Exposed SDL_LoadObject(), SDL_LoadFunction(), and SDL_UnloadObject() APIs
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
    71
#endif
12a21d82a060 Exposed SDL_LoadObject(), SDL_LoadFunction(), and SDL_UnloadObject() APIs
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
    72
#include "close_code.h"
12a21d82a060 Exposed SDL_LoadObject(), SDL_LoadFunction(), and SDL_UnloadObject() APIs
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
    73
12a21d82a060 Exposed SDL_LoadObject(), SDL_LoadFunction(), and SDL_UnloadObject() APIs
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
    74
#endif /* _SDL_loadso_h */