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