a0a8b6ebe3e95d523687291265e3cc18248de4df
[scilab.git] / scilab / modules / dynamic_link / includes / dynamiclibrary_windows.h
1 /*
2  * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
3  * Copyright (C) 2007 - INRIA - Allan CORNET
4  *
5  * This file must be used under the terms of the CeCILL.
6  * This source file is licensed as described in the file COPYING, which
7  * you should have received as part of this distribution.  The terms
8  * are also available at
9  * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt
10  *
11  */
12 #ifndef __DYNAMICLIBRARY_WINDOWS_H__
13 #define __DYNAMICLIBRARY_WINDOWS_H__
14
15 //avoid declaration on macro min/max
16 #define NOMINMAX
17 #include <Windows.h>
18 #undef NOMINMAX
19 #include "dynlib_dynamic_link.h"
20
21 #include "BOOL.h"
22
23 typedef HINSTANCE DynLibHandle;
24 typedef FARPROC DynLibFuncPtr;
25
26 /**
27 * Maps the specified executable module into the address space of the calling process
28 * @param name of dynamic library
29 * @return Handle to the loaded library
30 */
31 DYNAMIC_LINK_IMPEXP DynLibHandle LoadDynLibrary(char *libname);
32
33 /**
34 * Maps the specified executable module into the address space of the calling process
35 * @param name of dynamic library (wide char)
36 * @return Handle to the loaded library
37 */
38 DYNAMIC_LINK_IMPEXP DynLibHandle LoadDynLibraryW(wchar_t *libname);
39
40
41 /**
42 * Decrements the reference count of the loaded dynamic-link library
43 * @param Handle to the loaded library
44 * @return BOOL If the function succeeds, the return value is nonzero
45 */
46 DYNAMIC_LINK_IMPEXP BOOL FreeDynLibrary(DynLibHandle hInstance);
47
48 /**
49 * Retrieves the address of an exported function
50 * @param Handle to the loaded library
51 * @param string that specifies the function
52 * @return
53 */
54 DYNAMIC_LINK_IMPEXP DynLibFuncPtr GetDynLibFuncPtr(DynLibHandle hInstance, const char *funcName);
55
56 /**
57 * return last dynamic linking error
58 * @return a string
59 */
60 DYNAMIC_LINK_IMPEXP char * GetLastDynLibError(void);
61
62 typedef int (*PROC_GATEWAY) (void);
63
64 typedef enum { DYN_GW_NO_ERROR = 0,
65                DYN_GW_LOAD_LIBRARY_ERROR = 1,
66                DYN_GW_PTR_FUNCTION_ERROR = 2,
67                DYN_GW_CALL_FUNCTION_ERROR = 3
68
69              } dynamic_gateway_error_code;
70
71 typedef enum { DYNLIB_NAME_FORMAT_AUTO = 0,
72                DYNLIB_NAME_FORMAT_1 = 1,
73                DYNLIB_NAME_FORMAT_2 = 2,
74                DYNLIB_NAME_FORMAT_3 = 3
75              } dynlib_name_format;
76
77 #define FORMATGATEWAYLIBNAME_1 L"%ls%ls"
78 #define FORMATGATEWAYLIBNAME_2 L"sci%ls%ls"
79 #define FORMATGATEWAYLIBNAME_3 L"libsci%ls%ls"
80
81 /**
82 * Build name of dynamic library based on module name
83 * @param[in] module name
84 * @param[in] generated dynamic lib name type
85 * @return name of dynamic library
86 */
87 DYNAMIC_LINK_IMPEXP wchar_t* buildModuleDynLibraryNameW(const wchar_t* _pwstModuleName, dynlib_name_format _iType);
88 DYNAMIC_LINK_IMPEXP char* buildModuleDynLibraryName(const char* _pstModuleName, dynlib_name_format _iType);
89
90 #endif /* __DYNAMICLIBRARY_WINDOWS_H__ */
91