1/*
2 Simple DirectMedia Layer
3 Copyright (C) 1997-2022 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
50extern "C" {
51#endif
52
53/**
54 * Dynamically load a shared object.
55 *
56 * \param sofile a system-dependent name of the object file
57 * \returns an opaque pointer to the object handle or NULL if there was an
58 * error; call SDL_GetError() for more information.
59 *
60 * \since This function is available since SDL 2.0.0.
61 *
62 * \sa SDL_LoadFunction
63 * \sa SDL_UnloadObject
64 */
65extern DECLSPEC void *SDLCALL SDL_LoadObject(const char *sofile);
66
67/**
68 * Look up the address of the named function in a shared object.
69 *
70 * This function pointer is no longer valid after calling SDL_UnloadObject().
71 *
72 * This function can only look up C function names. Other languages may have
73 * name mangling and intrinsic language support that varies from compiler to
74 * compiler.
75 *
76 * Make sure you declare your function pointers with the same calling
77 * convention as the actual library function. Your code will crash
78 * mysteriously if you do not do this.
79 *
80 * If the requested function doesn't exist, NULL is returned.
81 *
82 * \param handle a valid shared object handle returned by SDL_LoadObject()
83 * \param name the name of the function to look up
84 * \returns a pointer to the function or NULL if there was an error; call
85 * SDL_GetError() for more information.
86 *
87 * \since This function is available since SDL 2.0.0.
88 *
89 * \sa SDL_LoadObject
90 * \sa SDL_UnloadObject
91 */
92extern DECLSPEC void *SDLCALL SDL_LoadFunction(void *handle,
93 const char *name);
94
95/**
96 * Unload a shared object from memory.
97 *
98 * \param handle a valid shared object handle returned by SDL_LoadObject()
99 *
100 * \since This function is available since SDL 2.0.0.
101 *
102 * \sa SDL_LoadFunction
103 * \sa SDL_LoadObject
104 */
105extern DECLSPEC void SDLCALL SDL_UnloadObject(void *handle);
106
107/* Ends C function definitions when using C++ */
108#ifdef __cplusplus
109}
110#endif
111#include "close_code.h"
112
113#endif /* SDL_loadso_h_ */
114
115/* vi: set ts=4 sw=4 expandtab: */
116