[Top][All Lists]
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
HEAD ltdl documentation patch
From: |
Robert Boehne |
Subject: |
HEAD ltdl documentation patch |
Date: |
Sat, 09 Jun 2001 16:34:28 -0500 |
Hello,
As I've been working on the documetation for HEAD libtool with
tag support, I've also found that the docs for the interface of
libltdl were somewhat out of date. As I'm not intimately familiar
with libltdl I'd like someone to look this over before it's committed.
Robert
ChangeLog entry:
2001-06-09 Robert Boehne <address@hidden>
* docs/libtool.texi: Updated the libltdl interface documentation
to bring it up to date.
--
Robert Boehne Software Engineer
Ricardo Software Chicago Technical Center
TEL: (630)789-0003 x. 238
FAX: (630)789-0127
email: address@hidden
ChangeLog entry:
2001-06-09 Robert Boehne <address@hidden>
* docs/libtool.texi: Updated the libltdl interface documentation
to bring it up to date.
Index: doc/libtool.texi
===================================================================
RCS file: /cvsroot/libtool/libtool/doc/libtool.texi,v
retrieving revision 1.116
diff -u -r1.116 libtool.texi
--- doc/libtool.texi 2001/04/05 23:43:39 1.116
+++ doc/libtool.texi 2001/06/09 21:30:57
@@ -1683,7 +1683,7 @@
@end defvar
@defvar LDFLAGS
-The flags to be used by @code{ltconfig} when it links a program. If
+The flags to be used by @code{libtool} when it links a program. If
this is not set, @code{AC_PROG_LIBTOOL} will not use any such flags. It
affects only the way @code{AC_PROG_LIBTOOL} runs tests, not the produced
@code{libtool}.
@@ -2779,13 +2779,13 @@
Return 0 on success.
@end deftypefun
address@hidden lt_ptr lt_dlsym (lt_dlhandle @var{handle}, const char
address@hidden)
address@hidden lt_ptr_t lt_dlsym (lt_dlhandle @var{handle}, const char
address@hidden)
Return the address in the module @var{handle}, where the symbol given
by the null-terminated string @var{name} is loaded.
If the symbol cannot be found, @code{NULL} is returned.
@end deftypefun
address@hidden {const char *}lt_dlerror (void)
address@hidden {const char *} lt_dlerror (void)
Return a human readable string describing the most
recent error that occurred from any of libltdl's functions.
Return @code{NULL} if no errors have occurred since initialization
@@ -3143,21 +3143,21 @@
@noindent
The following types are defined in @file{ltdl.h}:
address@hidden {Type} lt_module
address@hidden is a dlloader dependent module.
address@hidden {Type} lt_module_t
address@hidden is a dlloader dependent module.
The dynamic module loader extensions communicate using these low
level types.
@end deftp
address@hidden {Type} lt_dlloader
address@hidden is a handle for module loader types.
address@hidden {Type} lt_dlloader_t
address@hidden is a handle for module loader types.
@end deftp
address@hidden {Type} lt_dlloader_data
address@hidden is used for specifying loader instance data.
address@hidden {Type} lt_dlloader_data_t
address@hidden is used for specifying loader instance data.
@end deftp
address@hidden {Type} {struct} lt_user_dlloader @address@hidden char
address@hidden;} @w{lt_module_open address@hidden;address@hidden
address@hidden;} @w{lt_find_sym address@hidden;} @w{lt_dlloader_exit
address@hidden;} @w{lt_dlloader_data @var{dlloader_data};} @}
address@hidden {Type} {struct} lt_user_dlloader @address@hidden char
address@hidden;} @w{lt_module_open_t address@hidden;} @w{lt_module_close_t
address@hidden;} @w{lt_find_sym_t address@hidden;} @w{lt_dlloader_exit_t
address@hidden;} @}
If you want to define a new way to open dynamic modules, and have the
@code{lt_dlopen} @sc{api} use it, you need to instantiate one of these
structures and pass it to @code{lt_dlloader_add}. You can pass whatever
@@ -3166,18 +3166,18 @@
the function pointer fields.
@end deftypefn
address@hidden {Type} lt_module lt_module_open (@w{lt_user_data
@var{loader_data},} @w{const char address@hidden)
-The type of the loader function for an @code{lt_dlloader} module
address@hidden {Type} lt_module_t lt_module_open_t (@w{const char
address@hidden)
+The type of the loader function for an @code{lt_dlloader_t} module
loader. The value set in the dlloader_data field of the @code{struct
lt_user_dlloader} structure will be passed into this function in the
@var{loader_data} parameter. Implementation of such a function should
attempt to load the named module, and return an @code{lt_module}
-suitable for passing in to the associated @code{lt_module_close} and
+suitable for passing in to the associated @code{lt_module_close_t} and
@code{lt_sym_find} function pointers. If the function fails it should
return @code{NULL}, and set the error message with @code{lt_dlseterror}.
@end deftypefn
address@hidden {Type} int lt_module_close (@w{lt_dlloader_data
@var{loader_data},} @w{lt_module @var{module}})
address@hidden {Type} int lt_module_close_t (@w{lt_dlloader_data
@var{loader_data},} @w{lt_module @var{module}})
The type of the unloader function for a user defined module loader.
Implementatation of such a function should attempt to release
any resources tied up by the @var{module} module, and then unload it
@@ -3185,14 +3185,14 @@
message with @code{lt_dlseterror} and return non-zero.
@end deftypefn
address@hidden {Type} lt_ptr lt_find_sym (@w{lt_user_data @var{loader_data},}
@w{lt_module @var{module},} @w{const char address@hidden)
address@hidden {Type} lt_ptr_t lt_find_sym_t (@w{lt_module_t @var{module},}
@w{const char address@hidden)
The type of the symbol lookup function for a user defined module loader.
Implementation of such a function should return the address of the named
@var{symbol} in the module @var{module}, or else set the error message
with @code{lt_dlseterror} and return @code{NULL} if lookup fails.
@end deftypefn
address@hidden {Type} int lt_dlloader_exit (@w{lt_user_data @var{loader_data}})
address@hidden {Type} int lt_dlloader_exit_t (@w{lt_dlloader_data_t
@var{loader_data}})
The type of the finalisation function for a user defined module loader.
Implementation of such a function should free any resources associated
with the loader, including any user specified data in the
@@ -3218,7 +3218,7 @@
dlloader.module_close = myloader_close;
dlloader.find_sym = myloader_find_sym.
dlloader.dlloader_exit = myloader_exit;
- dlloader.dlloader_data = (lt_user_data)myloader_function;
+ dlloader.dlloader_data = (lt_dlloader_data_t)myloader_function;
/* Add my loader as the default module loader. */
if (lt_dlloader_add (lt_dlloader_next (NULL), &dlloader, "myloader") != 0)
@@ -3241,7 +3241,7 @@
libltdl provides the following functions for writing your own module
loaders:
address@hidden int lt_dlloader_add (@w{lt_dlloader address@hidden,}
@w{lt_user_dlloader address@hidden,} @w{const char address@hidden)
address@hidden int lt_dlloader_add (@w{lt_dlloader_t address@hidden,}
@w{lt_user_dlloader address@hidden,} @w{const char address@hidden)
Add a new module loader to the list of all loaders, either as the
last loader (if @var{place} is @code{NULL}), else immediately before the
loader passed as @var{place}. @var{loader_name} will be returned by
@@ -3274,7 +3274,7 @@
@end example
@end deftypefun
address@hidden {lt_dlloader *}lt_dlloader_next (@w{lt_dlloader address@hidden)
address@hidden {lt_dlloader_t *}lt_dlloader_next (@w{lt_dlloader_t
address@hidden)
Iterate over the module loaders, returning the first loader if @var{place} is
@code{NULL}, and the next one on subsequent calls. The handle is for use with
@code{lt_dlloader_add}.
@@ -3288,7 +3288,7 @@
@end example
@end deftypefun
address@hidden {lt_dlloader *}lt_dlloader_find (@w{const char address@hidden)
address@hidden {lt_dlloader_t *}lt_dlloader_find (@w{const char address@hidden)
Return the first loader with a matching @var{loader_name} identifier, or else
@code{NULL}, if the identifier is not found.
@@ -3307,14 +3307,14 @@
@end example
@end deftypefun
address@hidden {const char *}lt_dlloader_name (@w{lt_dlloader address@hidden)
address@hidden {const char *}lt_dlloader_name (@w{lt_dlloader_t address@hidden)
Return the identifying name of @var{PLACE}, as obtained from
@code{lt_dlloader_next} or @code{lt_dlloader_find}. If this function fails,
it will return @code{NULL} and set an error for retrieval with
@code{lt_dlerror}.
@end deftypefun
address@hidden {lt_user_data *}lt_dlloader_data (@w{lt_dlloader address@hidden)
address@hidden {lt_dlloader_data_t *}lt_dlloader_data (@w{lt_dlloader_t
address@hidden)
Return the address of the @code{dlloader_data} of @var{PLACE}, as
obtained from @code{lt_dlloader_next} or @code{lt_dlloader_find}. If
this function fails, it will return @code{NULL} and set an error for
- HEAD ltdl documentation patch,
Robert Boehne <=