avoid declaration on macro min/max
[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 #include "dynlib_dynamic_link.h"
19
20 #include "BOOL.h"
21
22 typedef HINSTANCE DynLibHandle;
23 typedef FARPROC DynLibFuncPtr;
24
25 /**
26 * Maps the specified executable module into the address space of the calling process
27 * @param name of dynamic library
28 * @return Handle to the loaded library
29 */
30 DYNAMIC_LINK_IMPEXP DynLibHandle LoadDynLibrary(char *libname);
31
32 /**
33 * Maps the specified executable module into the address space of the calling process
34 * @param name of dynamic library (wide char)
35 * @return Handle to the loaded library
36 */
37 DYNAMIC_LINK_IMPEXP DynLibHandle LoadDynLibraryW(wchar_t *libname);
38
39
40 /**
41 * Decrements the reference count of the loaded dynamic-link library
42 * @param Handle to the loaded library
43 * @return BOOL If the function succeeds, the return value is nonzero
44 */
45 DYNAMIC_LINK_IMPEXP BOOL FreeDynLibrary(DynLibHandle hInstance);
46
47 /**
48 * Retrieves the address of an exported function
49 * @param Handle to the loaded library
50 * @param string that specifies the function
51 * @return
52 */
53 DYNAMIC_LINK_IMPEXP DynLibFuncPtr GetDynLibFuncPtr(DynLibHandle hInstance, char *funcName);
54
55 /**
56 * return last dynamic linking error
57 * @return a string
58 */
59 DYNAMIC_LINK_IMPEXP char * GetLastDynLibError(void);
60
61 typedef int (*PROC_GATEWAY) (void);
62
63 typedef enum { DYN_GW_NO_ERROR = 0,
64                DYN_GW_LOAD_LIBRARY_ERROR = 1,
65                DYN_GW_PTR_FUNCTION_ERROR = 2,
66                DYN_GW_CALL_FUNCTION_ERROR = 3
67
68              } dynamic_gateway_error_code;
69
70 typedef enum { DYNLIB_NAME_FORMAT_AUTO = 0,
71                DYNLIB_NAME_FORMAT_1 = 1,
72                DYNLIB_NAME_FORMAT_2 = 2,
73                DYNLIB_NAME_FORMAT_3 = 3
74              } dynlib_name_format;
75
76 #define FORMATGATEWAYLIBNAME_1 L"%ls%ls"
77 #define FORMATGATEWAYLIBNAME_2 L"sci%ls%ls"
78 #define FORMATGATEWAYLIBNAME_3 L"libsci%ls%ls"
79
80 /**
81 * Build name of dynamic library based on module name
82 * @param[in] module name
83 * @param[in] generated dynamic lib name type
84 * @return name of dynamic library
85 */
86 DYNAMIC_LINK_IMPEXP wchar_t* buildModuleDynLibraryNameW(const wchar_t* _pwstModuleName, dynlib_name_format _iType);
87 DYNAMIC_LINK_IMPEXP char* buildModuleDynLibraryName(const char* _pstModuleName, dynlib_name_format _iType);
88
89 #endif /* __DYNAMICLIBRARY_WINDOWS_H__ */
90