/* ltdl.h -- generic dlopen functions

[0] Fix | Delete

[1] Fix | Delete

Copyright (C) 1998-2000, 2004-2005, 2007-2008, 2011-2015 Free

[2] Fix | Delete

Software Foundation, Inc.

[3] Fix | Delete

Written by Thomas Tanner, 1998

[4] Fix | Delete

[5] Fix | Delete

NOTE: The canonical source of this file is maintained with the

[6] Fix | Delete

GNU Libtool package. Report bugs to bug-libtool@gnu.org.

[7] Fix | Delete

[8] Fix | Delete

GNU Libltdl is free software; you can redistribute it and/or

[9] Fix | Delete

modify it under the terms of the GNU Lesser General Public

[10] Fix | Delete

License as published by the Free Software Foundation; either

[11] Fix | Delete

version 2 of the License, or (at your option) any later version.

[12] Fix | Delete

[13] Fix | Delete

As a special exception to the GNU Lesser General Public License,

[14] Fix | Delete

if you distribute this file as part of a program or library that

[15] Fix | Delete

is built using GNU Libtool, you may include this file under the

[16] Fix | Delete

same distribution terms that you use for the rest of that program.

[17] Fix | Delete

[18] Fix | Delete

GNU Libltdl is distributed in the hope that it will be useful,

[19] Fix | Delete

but WITHOUT ANY WARRANTY; without even the implied warranty of

[20] Fix | Delete

MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the

[21] Fix | Delete

GNU Lesser General Public License for more details.

[22] Fix | Delete

[23] Fix | Delete

You should have received a copy of the GNU Lesser General Public

[24] Fix | Delete

License along with GNU Libltdl; see the file COPYING.LIB. If not, a

[25] Fix | Delete

copy can be downloaded from http://www.gnu.org/licenses/lgpl.html,

[26] Fix | Delete

or obtained by writing to the Free Software Foundation, Inc.,

[27] Fix | Delete

51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.

[28] Fix | Delete

*/

[29] Fix | Delete

[30] Fix | Delete

/* Only include this header file once. */

[31] Fix | Delete

#if !defined LTDL_H

[32] Fix | Delete

#define LTDL_H 1

[33] Fix | Delete

[34] Fix | Delete

#include <libltdl/lt_system.h>

[35] Fix | Delete

#include <libltdl/lt_error.h>

[36] Fix | Delete

#include <libltdl/lt_dlloader.h>

[37] Fix | Delete

[38] Fix | Delete

LT_BEGIN_C_DECLS

[39] Fix | Delete

[40] Fix | Delete

[41] Fix | Delete

/* LT_STRLEN can be used safely on NULL pointers. */

[42] Fix | Delete

#define LT_STRLEN(s) (((s) && (s)[0]) ? strlen (s) : 0)

[43] Fix | Delete

[44] Fix | Delete



[45] Fix | Delete

/* --- DYNAMIC MODULE LOADING API --- */

[46] Fix | Delete

[47] Fix | Delete

[48] Fix | Delete

typedef struct lt__handle *lt_dlhandle; /* A loaded module. */

[49] Fix | Delete

[50] Fix | Delete

/* Initialisation and finalisation functions for libltdl. */

[51] Fix | Delete

LT_SCOPE int lt_dlinit (void);

[52] Fix | Delete

LT_SCOPE int lt_dlexit (void);

[53] Fix | Delete

[54] Fix | Delete

/* Module search path manipulation. */

[55] Fix | Delete

LT_SCOPE int lt_dladdsearchdir (const char *search_dir);

[56] Fix | Delete

LT_SCOPE int lt_dlinsertsearchdir (const char *before,

[57] Fix | Delete

const char *search_dir);

[58] Fix | Delete

LT_SCOPE int lt_dlsetsearchpath (const char *search_path);

[59] Fix | Delete

LT_SCOPE const char *lt_dlgetsearchpath (void);

[60] Fix | Delete

LT_SCOPE int lt_dlforeachfile (

[61] Fix | Delete

const char *search_path,

[62] Fix | Delete

int (*func) (const char *filename, void *data),

[63] Fix | Delete

void *data);

[64] Fix | Delete

[65] Fix | Delete

/* User module loading advisors. */

[66] Fix | Delete

LT_SCOPE int lt_dladvise_init (lt_dladvise *advise);

[67] Fix | Delete

LT_SCOPE int lt_dladvise_destroy (lt_dladvise *advise);

[68] Fix | Delete

LT_SCOPE int lt_dladvise_ext (lt_dladvise *advise);

[69] Fix | Delete

LT_SCOPE int lt_dladvise_resident (lt_dladvise *advise);

[70] Fix | Delete

LT_SCOPE int lt_dladvise_local (lt_dladvise *advise);

[71] Fix | Delete

LT_SCOPE int lt_dladvise_global (lt_dladvise *advise);

[72] Fix | Delete

LT_SCOPE int lt_dladvise_preload (lt_dladvise *advise);

[73] Fix | Delete

[74] Fix | Delete

/* Portable libltdl versions of the system dlopen() API. */

[75] Fix | Delete

LT_SCOPE lt_dlhandle lt_dlopen (const char *filename);

[76] Fix | Delete

LT_SCOPE lt_dlhandle lt_dlopenext (const char *filename);

[77] Fix | Delete

LT_SCOPE lt_dlhandle lt_dlopenadvise (const char *filename,

[78] Fix | Delete

lt_dladvise advise);

[79] Fix | Delete

LT_SCOPE void * lt_dlsym (lt_dlhandle handle, const char *name);

[80] Fix | Delete

LT_SCOPE const char *lt_dlerror (void);

[81] Fix | Delete

LT_SCOPE int lt_dlclose (lt_dlhandle handle);

[82] Fix | Delete

[83] Fix | Delete

[84] Fix | Delete

[85] Fix | Delete

/* --- PRELOADED MODULE SUPPORT --- */

[86] Fix | Delete

[87] Fix | Delete

[88] Fix | Delete

/* A preopened symbol. Arrays of this type comprise the exported

[89] Fix | Delete

symbols for a dlpreopened module. */

[90] Fix | Delete

typedef struct {

[91] Fix | Delete

const char *name;

[92] Fix | Delete

void *address;

[93] Fix | Delete

} lt_dlsymlist;

[94] Fix | Delete

[95] Fix | Delete

typedef int lt_dlpreload_callback_func (lt_dlhandle handle);

[96] Fix | Delete

[97] Fix | Delete

LT_SCOPE int lt_dlpreload (const lt_dlsymlist *preloaded);

[98] Fix | Delete

LT_SCOPE int lt_dlpreload_default (const lt_dlsymlist *preloaded);

[99] Fix | Delete

LT_SCOPE int lt_dlpreload_open (const char *originator,

[100] Fix | Delete

lt_dlpreload_callback_func *func);

[101] Fix | Delete

[102] Fix | Delete

#define lt_preloaded_symbols lt__PROGRAM__LTX_preloaded_symbols

[103] Fix | Delete

/* Ensure C linkage. */

[104] Fix | Delete

extern LT_DLSYM_CONST lt_dlsymlist lt__PROGRAM__LTX_preloaded_symbols[];

[105] Fix | Delete

[106] Fix | Delete

#define LTDL_SET_PRELOADED_SYMBOLS() \

[107] Fix | Delete

lt_dlpreload_default(lt_preloaded_symbols)

[108] Fix | Delete

[109] Fix | Delete

[110] Fix | Delete

[111] Fix | Delete



[112] Fix | Delete

/* --- MODULE INFORMATION --- */

[113] Fix | Delete

[114] Fix | Delete

[115] Fix | Delete

/* Associating user data with loaded modules. */

[116] Fix | Delete

typedef void * lt_dlinterface_id;

[117] Fix | Delete

typedef int lt_dlhandle_interface (lt_dlhandle handle, const char *id_string);

[118] Fix | Delete

[119] Fix | Delete

LT_SCOPE lt_dlinterface_id lt_dlinterface_register (const char *id_string,

[120] Fix | Delete

lt_dlhandle_interface *iface);

[121] Fix | Delete

LT_SCOPE void lt_dlinterface_free (lt_dlinterface_id key);

[122] Fix | Delete

LT_SCOPE void * lt_dlcaller_set_data (lt_dlinterface_id key,

[123] Fix | Delete

lt_dlhandle handle, void *data);

[124] Fix | Delete

LT_SCOPE void * lt_dlcaller_get_data (lt_dlinterface_id key,

[125] Fix | Delete

lt_dlhandle handle);

[126] Fix | Delete

[127] Fix | Delete

[128] Fix | Delete

/* Read only information pertaining to a loaded module. */

[129] Fix | Delete

typedef struct {

[130] Fix | Delete

char * filename; /* file name */

[131] Fix | Delete

char * name; /* module name */

[132] Fix | Delete

int ref_count; /* number of times lt_dlopened minus

[133] Fix | Delete

number of times lt_dlclosed. */

[134] Fix | Delete

unsigned int is_resident:1; /* module can't be unloaded. */

[135] Fix | Delete

unsigned int is_symglobal:1; /* module symbols can satisfy

[136] Fix | Delete

subsequently loaded modules. */

[137] Fix | Delete

unsigned int is_symlocal:1; /* module symbols are only available

[138] Fix | Delete

locally. */

[139] Fix | Delete

} lt_dlinfo;

[140] Fix | Delete

[141] Fix | Delete

LT_SCOPE const lt_dlinfo *lt_dlgetinfo (lt_dlhandle handle);

[142] Fix | Delete

[143] Fix | Delete

LT_SCOPE lt_dlhandle lt_dlhandle_iterate (lt_dlinterface_id iface,

[144] Fix | Delete

lt_dlhandle place);

[145] Fix | Delete

LT_SCOPE lt_dlhandle lt_dlhandle_fetch (lt_dlinterface_id iface,

[146] Fix | Delete

const char *module_name);

[147] Fix | Delete

LT_SCOPE int lt_dlhandle_map (lt_dlinterface_id iface,

[148] Fix | Delete

int (*func) (lt_dlhandle handle, void *data),

[149] Fix | Delete

void *data);

[150] Fix | Delete

[151] Fix | Delete

[152] Fix | Delete

[153] Fix | Delete

/* Deprecated module residency management API. */

[154] Fix | Delete

LT_SCOPE int lt_dlmakeresident (lt_dlhandle handle);

[155] Fix | Delete

LT_SCOPE int lt_dlisresident (lt_dlhandle handle);

[156] Fix | Delete

[157] Fix | Delete

#define lt_ptr void *

[158] Fix | Delete

[159] Fix | Delete

LT_END_C_DECLS

[160] Fix | Delete

[161] Fix | Delete

#endif /*!defined LTDL_H*/

[162] Fix | Delete

[163] Fix | Delete