Merge pull request #5714 from alexischr/update_bockbuild
[mono.git] / mono / metadata / assembly.h
1 /**
2  * \file
3  */
4
5 #ifndef _MONONET_METADATA_ASSEMBLY_H_ 
6 #define _MONONET_METADATA_ASSEMBLY_H_
7
8 #include <mono/utils/mono-error.h>
9 #include <mono/metadata/image.h>
10
11 MONO_BEGIN_DECLS
12
13 MONO_API void          mono_assemblies_init     (void);
14 MONO_API void          mono_assemblies_cleanup  (void);
15 MONO_RT_EXTERNAL_ONLY
16 MONO_API MonoAssembly *mono_assembly_open       (const char *filename,
17                                         MonoImageOpenStatus *status);
18 MONO_RT_EXTERNAL_ONLY
19 MONO_API MonoAssembly *mono_assembly_open_full (const char *filename,
20                                         MonoImageOpenStatus *status,
21                                         mono_bool refonly);
22 MONO_API MonoAssembly* mono_assembly_load       (MonoAssemblyName *aname, 
23                                         const char       *basedir, 
24                                         MonoImageOpenStatus *status);
25 MONO_API MonoAssembly* mono_assembly_load_full (MonoAssemblyName *aname, 
26                                         const char       *basedir, 
27                                         MonoImageOpenStatus *status,
28                                         mono_bool refonly);
29 MONO_API MonoAssembly* mono_assembly_load_from  (MonoImage *image, const char *fname,
30                                         MonoImageOpenStatus *status);
31 MONO_API MonoAssembly* mono_assembly_load_from_full  (MonoImage *image, const char *fname,
32                                         MonoImageOpenStatus *status,
33                                         mono_bool refonly);
34
35 MONO_API MonoAssembly* mono_assembly_load_with_partial_name (const char *name, MonoImageOpenStatus *status);
36
37 MONO_API MonoAssembly* mono_assembly_loaded     (MonoAssemblyName *aname);
38 MONO_API MonoAssembly* mono_assembly_loaded_full (MonoAssemblyName *aname, mono_bool refonly);
39 MONO_API void          mono_assembly_get_assemblyref (MonoImage *image, int index, MonoAssemblyName *aname);
40 MONO_API void          mono_assembly_load_reference (MonoImage *image, int index);
41 MONO_API void          mono_assembly_load_references (MonoImage *image, MonoImageOpenStatus *status);
42 MONO_RT_EXTERNAL_ONLY MONO_API MonoImage*    mono_assembly_load_module (MonoAssembly *assembly, uint32_t idx);
43 MONO_API void          mono_assembly_close      (MonoAssembly *assembly);
44 MONO_API void          mono_assembly_setrootdir (const char *root_dir);
45 MONO_API MONO_CONST_RETURN char *mono_assembly_getrootdir (void);
46 MONO_API char         *mono_native_getrootdir (void);
47 MONO_API void          mono_assembly_foreach    (MonoFunc func, void* user_data);
48 MONO_API void          mono_assembly_set_main   (MonoAssembly *assembly);
49 MONO_API MonoAssembly *mono_assembly_get_main   (void);
50 MONO_API MonoImage    *mono_assembly_get_image  (MonoAssembly *assembly);
51 MONO_API MonoAssemblyName *mono_assembly_get_name (MonoAssembly *assembly);
52 MONO_API mono_bool      mono_assembly_fill_assembly_name (MonoImage *image, MonoAssemblyName *aname);
53 MONO_API mono_bool      mono_assembly_names_equal (MonoAssemblyName *l, MonoAssemblyName *r);
54 MONO_API char*         mono_stringify_assembly_name (MonoAssemblyName *aname);
55
56 /* Installs a function which is called each time a new assembly is loaded. */
57 typedef void  (*MonoAssemblyLoadFunc)         (MonoAssembly *assembly, void* user_data);
58 MONO_API void          mono_install_assembly_load_hook (MonoAssemblyLoadFunc func, void* user_data);
59
60 /* 
61  * Installs a new function which is used to search the list of loaded 
62  * assemblies for a given assembly name.
63  */
64 typedef MonoAssembly *(*MonoAssemblySearchFunc)         (MonoAssemblyName *aname, void* user_data);
65 MONO_API void          mono_install_assembly_search_hook (MonoAssemblySearchFunc func, void* user_data);
66 MONO_API void         mono_install_assembly_refonly_search_hook (MonoAssemblySearchFunc func, void* user_data);
67
68 MONO_API MonoAssembly* mono_assembly_invoke_search_hook (MonoAssemblyName *aname);
69
70 /*
71  * Installs a new search function which is used as a last resort when loading 
72  * an assembly fails. This could invoke AssemblyResolve events.
73  */
74 MONO_API void          
75 mono_install_assembly_postload_search_hook (MonoAssemblySearchFunc func, void* user_data);
76
77 MONO_API void          
78 mono_install_assembly_postload_refonly_search_hook (MonoAssemblySearchFunc func, void* user_data);
79
80
81 /* Installs a function which is called before a new assembly is loaded
82  * The hook are invoked from last hooked to first. If any of them returns
83  * a non-null value, that will be the value returned in mono_assembly_load */
84 typedef MonoAssembly * (*MonoAssemblyPreLoadFunc) (MonoAssemblyName *aname,
85                                                    char **assemblies_path,
86                                                    void* user_data);
87
88 MONO_API void          mono_install_assembly_preload_hook (MonoAssemblyPreLoadFunc func,
89                                                   void* user_data);
90 MONO_API void          mono_install_assembly_refonly_preload_hook (MonoAssemblyPreLoadFunc func,
91                                                   void* user_data);
92
93 MONO_API void          mono_assembly_invoke_load_hook (MonoAssembly *ass);
94
95 MONO_API MonoAssemblyName* mono_assembly_name_new             (const char *name);
96 MONO_API const char*       mono_assembly_name_get_name        (MonoAssemblyName *aname);
97 MONO_API const char*       mono_assembly_name_get_culture     (MonoAssemblyName *aname);
98 MONO_API uint16_t          mono_assembly_name_get_version     (MonoAssemblyName *aname,
99                                                       uint16_t *minor, uint16_t *build, uint16_t *revision);
100 MONO_API mono_byte*        mono_assembly_name_get_pubkeytoken (MonoAssemblyName *aname);
101 MONO_API void              mono_assembly_name_free            (MonoAssemblyName *aname);
102
103 typedef struct {
104         const char *name;
105         const unsigned char *data;
106         const unsigned int size;
107 } MonoBundledAssembly;
108
109 MONO_API void          mono_register_bundled_assemblies (const MonoBundledAssembly **assemblies);
110 MONO_API void          mono_register_config_for_assembly (const char* assembly_name, const char* config_xml);
111 MONO_API void          mono_register_symfile_for_assembly (const char* assembly_name, const mono_byte *raw_contents, int size);
112 MONO_API void         mono_register_machine_config (const char *config_xml);
113
114 MONO_API void          mono_set_rootdir (void);
115 MONO_API void          mono_set_dirs (const char *assembly_dir, const char *config_dir);
116 MONO_API void          mono_set_assemblies_path (const char* path);
117 MONO_END_DECLS
118
119 #endif
120