72c777adf97b7fc734c44e6601cb1ec31c6454b5
[captive.git] / src / libcaptive / include / captive / ldr_exports.h
1 /* $Id$
2  * Include file for reactos ldr/ (loader) to be used from ke/exports.c of libcaptive
3  * Copyright (C) 2002 Jan Kratochvil <project-captive@jankratochvil.net>
4  * 
5  * This program is free software; you can redistribute it and/or modify
6  * it under the terms of the GNU General Public License as published by
7  * the Free Software Foundation; exactly version 2 of June 1991 is required
8  * 
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  * 
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software
16  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
17  */
18
19
20 #ifndef _CAPTIVE_LDR_EXPORTS_H
21 #define _CAPTIVE_LDR_EXPORTS_H 1
22
23
24 #include <glib/gtypes.h>
25 /* NEVER include any captive/reactos include file as we are included
26  * from libcaptive/ke/exports.c which conflicts on any export symbol declaration.
27  */
28
29
30 G_BEGIN_DECLS
31
32 /**
33  * captive_kernel_exports:
34  *
35  * Export complete libcaptive modules to reactos. It is done by *.def files used
36  * by dlltool(1) of Mingw32 compiler suite. We use native host OS compiler and
37  * we also have just a limited set of functions over reactos itself.
38  * We use our captive_ModuleList_add_builtin() to simulate PE headers exporting
39  * our symbols; this export simulation is invocated from this function.
40  *
41  * This function is generated automatically from #exports.captivesym file
42  * by #captivesym.pl script.
43  *
44  * Multiple calls of this function are forbidden. See also captive_kernel_patches().
45  *
46  * Returns: %TRUE if the export was successful.
47  */
48 gboolean captive_kernel_exports(void);
49
50
51 /**
52  * captive_kernel_patches:
53  *
54  * Patches W32 libraries by libcaptive functions. It is done by *.def files used
55  * by dlltool(1) of Mingw32 compiler suite. We use native host OS compiler and
56  * we also have just a limited set of functions over reactos itself.
57  * We use our captive_ModuleList_patch() to modify existing module function
58  * tables generated from captive_ModuleList_add_builtin().
59  *
60  * This function is generated automatically from #exports.captivesym file
61  * by #captivesym.pl script.
62  *
63  * Multiple calls of this function are forbidden. See also captive_kernel_exports().
64  *
65  * Returns: %TRUE if the export was successful.
66  */
67 gboolean captive_kernel_patches(void);
68
69
70 struct captive_ModuleList_patchpoint {
71         guint8 *orig_w32_func;  /* direct pointer to W32 binary entry point */
72         guint8 *orig_w32_2ndinstr;      /* direct pointer to W32 binary second instruction after entry point */
73         void (*wrap_wrap_func)(void);   /* address of 'exports.c' debug-printing outer function */
74         guint8 orig_w32_func_byte;
75         guint8 orig_w32_2ndinstr_byte;
76         gboolean through_w32_func;      /* pass once through 'orig_w32_func' entry point without redirection to 'wrap_wrap_func' */
77         };
78
79 gboolean captive_ModuleList_add_builtin(const gchar *FullName_utf8,...);
80 gboolean captive_ModuleList_patch(const gchar *FullName_utf8,...);
81
82 G_END_DECLS
83
84
85 #endif /* _CAPTIVE_LDR_EXPORTS_H */