5 | The following modes may (or may not) work but are not supported officially.
6 |
Using PBInvoke with PowerBuilder 5 (PBInvoke supports only PB 6 and above)
7 |
Machine code targets (DLL builds)
8 |
Web and .Net targets (WinForm, WebForm, JSP, Web services ...)
9 |
10 |
Only P-code (PBD) builds are supported.
11 |
12 |
Unimplemented features
13 |
14 | The following features will be implemented in one of the future versions of PBInvoke.
15 |
16 |
.Net interop (calls to external .Net classes, not under .Net targets)
17 |
Java interop (calls to external Java classes)
18 |
Calls via function pointers (now only named DLL functions and PB callbacks can be called)
19 |
Double, float as a return type for callbacks. However pointers to such types are supported as a return type.
20 |
Any struct of size of more than 4 bytes as a return type for any function.
21 | However pointers to such structures are supported as a return type.
22 |
C++ classes, structures inherited from other structures.
23 |
24 |
WinAPI is most widely used as external functions in PowerBuilder.
4 |
5 |
WinAPI constants
6 |
PBInvoke provides an object with many WinAPI constants, n_pi_winapi.
7 | The constants can be used without instantiation of the object via syntax:
8 |
9 | n_pi_winapi.CONSTANT_NAME
10 |
11 |
12 |
Working with callbacks
32 |
33 |
34 |
35 |
36 |
--------------------------------------------------------------------------------
/doc/handling-tchar.html:
--------------------------------------------------------------------------------
1 |
Handling TCHAR and TSTR. Unicode/ANSI function name suffixes
2 |
When at least one of parameter types or return type of a declared DLL function is based on TCHAR type,
3 | then PBInvoke automatically appends a suffix "A" or "W" to the function's name and treats TCHAR as char or wchar_t
4 | depending on PowerBuilder version.
5 |
In Unicode versions (PB10 and above), the "W" suffix is appended and TCHAR=wchar_t,
6 |
In ANSI version (PB9 and below) , the "A" suffix is appended and TCHAR=char.
7 |
8 |
If the function with the suffix does not exist in the DLL, then PBInvoke tries to find the function without the prefix.
9 |
10 |
Example:
11 |
12 | lnv_CreateDirectory = lnv_kernel32.of_declare_method(&
13 | "BOOL CreateDirectory(LPCTSTR lpPathName, LPSECURITY_ATTRIBUTES lpSecurityAttributes);")
14 | // The exact meaning of the declaration above depends on PB version:
15 | // in PB9: BOOL CreateDirectoryA(const char *lpPathName, LPSECURITY_ATTRIBUTES lpSecurityAttributes)
16 | // in PB10: BOOL CreateDirectoryW(const wchar_t *lpPathName, LPSECURITY_ATTRIBUTES lpSecurityAttributes)
17 |
18 |
19 |
45 | $text =~ s/(\]*\>)\s+/$1/gsi;
46 |
47 | mkpath($outDir);
48 | WriteFile("$outDir/$file", $text);
49 | }
50 |
51 | sub colorize {
52 | my ($text) = @_;
53 | $text =~ s!(//.*)$!$1!gm;
54 | $text =~ s!(/\*.*?\*/)!$1!gms;
55 | return $text;
56 | }
--------------------------------------------------------------------------------
/projects/tester1/ReadMe.txt:
--------------------------------------------------------------------------------
1 | ========================================================================
2 | CONSOLE APPLICATION : tester1 Project Overview
3 | ========================================================================
4 |
5 | AppWizard has created this tester1 application for you.
6 |
7 | This file contains a summary of what you will find in each of the files that
8 | make up your tester1 application.
9 |
10 |
11 | tester1.vcproj
12 | This is the main project file for VC++ projects generated using an Application Wizard.
13 | It contains information about the version of Visual C++ that generated the file, and
14 | information about the platforms, configurations, and project features selected with the
15 | Application Wizard.
16 |
17 | tester1.cpp
18 | This is the main application source file.
19 |
20 | /////////////////////////////////////////////////////////////////////////////
21 | Other standard files:
22 |
23 | StdAfx.h, StdAfx.cpp
24 | These files are used to build a precompiled header (PCH) file
25 | named tester1.pch and a precompiled types file named StdAfx.obj.
26 |
27 | /////////////////////////////////////////////////////////////////////////////
28 | Other notes:
29 |
30 | AppWizard uses "TODO:" comments to indicate parts of the source code you
31 | should add to or customize.
32 |
33 | /////////////////////////////////////////////////////////////////////////////
34 |
--------------------------------------------------------------------------------
/src/types/RawType.h:
--------------------------------------------------------------------------------
1 |
2 | #pragma once
3 |
4 | #include "BaseType.h"
5 |
6 | // Generic plain C type
7 | class RawType: public BaseType
8 | {
9 | private:
10 | protected:
11 | RawType(const string &typeSignature, size_t sizeOf = sizeof(DWORD));
12 | size_t m_sizeOf;
13 | string m_typeSignature;
14 |
15 | void setSizeOf(size_t sizeOf) { m_sizeOf = sizeOf; }
16 | public:
17 | virtual int getSizeOf() { return m_sizeOf; }
18 | //virtual void setData(ExecutionContext *context, BYTE * cBuf, BYTE * pbBuf);
19 | //virtual void getData(ExecutionContext *context, BYTE * cBuf, BYTE *pbBuf);
20 | virtual void executeMethod(ExecutionContext *context, DWORD methodAddr, BYTE * retBuf, BYTE *paramBuf, int paramBufSize, bool isStdCall);
21 | virtual int getItemOffset(int itemIndex) {return 0;}
22 | virtual void allocateBuffer(ExecutionContext *context, BYTE * &buf, int itemCount = 1);
23 | virtual string getTypeSignature(const string& pointerSig = "");
24 | virtual void setZeroData(ExecutionContext *context, BYTE * buf);
25 | virtual int getExplicitAlign() { return 0; }
26 | virtual int getAlign() { return getSizeOf(); }
27 | // unimplemented (throw)
28 | virtual void getArrayData(ExecutionContext *context, BYTE * cBuf, BYTE *pbBuf, int &arrayLen, DataCharset charset);
29 | virtual void setArrayData(ExecutionContext *context, BYTE * &cBuf, BYTE *pbBuf, int arrayLen, DataCharset charset);
30 | virtual size_t strLen(ExecutionContext *context, BYTE * buf, int arrayLen, DataCharset charset) { return 0;}
31 | };
32 |
--------------------------------------------------------------------------------
/projects/libPBInvoke_vc9/ReadMe.txt:
--------------------------------------------------------------------------------
1 | ========================================================================
2 | DYNAMIC LINK LIBRARY : libPBInvoke
3 | ========================================================================
4 |
5 |
6 | AppWizard has created this libPBInvoke DLL for you.
7 |
8 | This file contains a summary of what you will find in each of the files that
9 | make up your libPBInvoke application.
10 |
11 | libPBInvoke.dsp
12 | This file (the project file) contains information at the project level and
13 | is used to build a single project or subproject. Other users can share the
14 | project (.dsp) file, but they should export the makefiles locally.
15 |
16 | libPBInvoke.cpp
17 | This is the main DLL source file.
18 |
19 | When created, this DLL does not export any symbols. As a result, it
20 | will not produce a .lib file when it is built. If you wish this project
21 | to be a project dependency of some other project, you will either need to
22 | add code to export some symbols from the DLL so that an export library
23 | will be produced, or you can check the "doesn't produce lib" checkbox in
24 | the Linker settings page for this project.
25 |
26 | /////////////////////////////////////////////////////////////////////////////
27 | Other standard files:
28 |
29 | StdAfx.h, StdAfx.cpp
30 | These files are used to build a precompiled header (PCH) file
31 | named libPBInvoke.pch and a precompiled types file named StdAfx.obj.
32 |
33 |
34 | /////////////////////////////////////////////////////////////////////////////
35 | Other notes:
36 |
37 | AppWizard uses "TODO:" to indicate parts of the source code you
38 | should add to or customize.
39 |
40 |
41 | /////////////////////////////////////////////////////////////////////////////
42 |
--------------------------------------------------------------------------------
/projects/libPBInvoke_vc9/libPBInvoke.sln:
--------------------------------------------------------------------------------
1 |
2 | Microsoft Visual Studio Solution File, Format Version 10.00
3 | # Visual Studio 2008
4 | Project("{8BC9CEB8-8B4A-11D0-8D11-00A0C91BC942}") = "libPBInvoke", "libPBInvoke.vcproj", "{9585C981-9C24-4AAC-A7CA-43D2844F02B3}"
5 | EndProject
6 | Project("{8BC9CEB8-8B4A-11D0-8D11-00A0C91BC942}") = "tester1", "..\tester1\tester1.vcproj", "{7E21D89F-5276-45A4-91E4-61D5C170FF0E}"
7 | EndProject
8 | Global
9 | GlobalSection(SolutionConfigurationPlatforms) = preSolution
10 | Debug|Win32 = Debug|Win32
11 | Release|Win32 = Release|Win32
12 | ReleaseDemo|Win32 = ReleaseDemo|Win32
13 | EndGlobalSection
14 | GlobalSection(ProjectConfigurationPlatforms) = postSolution
15 | {9585C981-9C24-4AAC-A7CA-43D2844F02B3}.Debug|Win32.ActiveCfg = Debug|Win32
16 | {9585C981-9C24-4AAC-A7CA-43D2844F02B3}.Debug|Win32.Build.0 = Debug|Win32
17 | {9585C981-9C24-4AAC-A7CA-43D2844F02B3}.Release|Win32.ActiveCfg = Release|Win32
18 | {9585C981-9C24-4AAC-A7CA-43D2844F02B3}.Release|Win32.Build.0 = Release|Win32
19 | {9585C981-9C24-4AAC-A7CA-43D2844F02B3}.ReleaseDemo|Win32.ActiveCfg = ReleaseDemo|Win32
20 | {9585C981-9C24-4AAC-A7CA-43D2844F02B3}.ReleaseDemo|Win32.Build.0 = ReleaseDemo|Win32
21 | {7E21D89F-5276-45A4-91E4-61D5C170FF0E}.Debug|Win32.ActiveCfg = Debug|Win32
22 | {7E21D89F-5276-45A4-91E4-61D5C170FF0E}.Debug|Win32.Build.0 = Debug|Win32
23 | {7E21D89F-5276-45A4-91E4-61D5C170FF0E}.Release|Win32.ActiveCfg = Release|Win32
24 | {7E21D89F-5276-45A4-91E4-61D5C170FF0E}.Release|Win32.Build.0 = Release|Win32
25 | {7E21D89F-5276-45A4-91E4-61D5C170FF0E}.ReleaseDemo|Win32.ActiveCfg = ReleaseDemo|Win32
26 | {7E21D89F-5276-45A4-91E4-61D5C170FF0E}.ReleaseDemo|Win32.Build.0 = ReleaseDemo|Win32
27 | EndGlobalSection
28 | GlobalSection(SolutionProperties) = preSolution
29 | HideSolutionNode = FALSE
30 | EndGlobalSection
31 | EndGlobal
32 |
--------------------------------------------------------------------------------
/doc/genhelp/unsupported.html:
--------------------------------------------------------------------------------
1 |
2 |
3 | Unsupported and unimplemented PBInvoke features
4 |
5 |
6 |
7 |
15 | The following modes may (or may not) work but are not supported officially.
16 |
Using PBInvoke with PowerBuilder 5 (PBInvoke supports only PB 6 and above)
17 |
Machine code targets (DLL builds)
18 |
Web and .Net targets (WinForm, WebForm, JSP, Web services ...)
19 |
20 |
Only P-code (PBD) builds are supported.
21 |
22 |
Unimplemented features
23 |
24 | The following features will be implemented in one of the future versions of PBInvoke.
25 |
26 |
.Net interop (calls to external .Net classes, not under .Net targets)
27 |
Java interop (calls to external Java classes)
28 |
Calls via function pointers (now only named DLL functions and PB callbacks can be called)
29 |
Double, float as a return type for callbacks. However pointers to such types are supported as a return type.
30 |
Any struct of size of more than 4 bytes as a return type for any function.
31 | However pointers to such structures are supported as a return type.
32 |
C++ classes, structures inherited from other structures.
33 |
34 |
WinAPI is most widely used as external functions in PowerBuilder.
14 |
15 |
WinAPI constants
16 |
PBInvoke provides an object with many WinAPI constants, n_pi_winapi.
17 | The constants can be used without instantiation of the object via syntax:
18 |
Handling TCHAR and TSTR. Unicode/ANSI function name suffixes
12 |
When at least one of parameter types or return type of a declared DLL function is based on TCHAR type,
13 | then PBInvoke automatically appends a suffix "A" or "W" to the function's name and treats TCHAR as char or wchar_t
14 | depending on PowerBuilder version.
15 |
In Unicode versions (PB10 and above), the "W" suffix is appended and TCHAR=wchar_t,
16 |
In ANSI version (PB9 and below) , the "A" suffix is appended and TCHAR=char.
17 |
18 |
If the function with the suffix does not exist in the DLL, then PBInvoke tries to find the function without the prefix.
19 |
20 |
Example:
21 |
lnv_CreateDirectory = lnv_kernel32.of_declare_method(&
22 | "BOOL CreateDirectory(LPCTSTR lpPathName, LPSECURITY_ATTRIBUTES lpSecurityAttributes);")
23 | // The exact meaning of the declaration above depends on PB version:
24 | // in PB9: BOOL CreateDirectoryA(const char *lpPathName, LPSECURITY_ATTRIBUTES lpSecurityAttributes)
25 | // in PB10: BOOL CreateDirectoryW(const wchar_t *lpPathName, LPSECURITY_ATTRIBUTES lpSecurityAttributes)
26 |
4 | When a function parameter is declared as char* or wchar_t*,
5 | PBInvoke automatically converts the charset of the string if PowerBuilder
6 | native strings have different charset.
7 |
8 |
9 | lnv_fn1 = lnv_somelib.of_declare_method("int strlen(char*s)")
10 | lnv_fn2 = lnv_somelib.of_declare_method("int wcslen(wchar_t*s)")
11 |
12 | // in PB9
13 | ll_len = lnv_fn1.of_invoke("test") // no conversion, both caller and callee are ANSI
14 | ll_len = lnv_fn2.of_invoke("test") // implicitly converts the string from ANSI to Unicode
15 |
16 | // in PB10+
17 | ll_len = lnv_fn1.of_invoke("test") // implicitly converts the string from Unicode to ANSI
18 | ll_len = lnv_fn2.of_invoke("test") // no conversion, both caller and callee are Unicode
19 |
20 |
21 | Combinations of char and wchar_t in one function are supported as well.
22 |
23 | lnv_fn = lnv_somelib.of_declare_method("void some_fn(char*s1, wchar_t*s2)")
24 | // in PB9
25 | lb_res = lnv_fn.of_invoke("test1", "test2") // "test1" - no conversion
26 | // "test2" - ANSI -> Unicode
27 | // in PB10 - vice versa
28 |
29 |
30 |
Passing numeric address of string instead of string
35 |
36 | If you got an address of some string as a numeric value, for example as a result of calling another function,
37 | you can pass this number instead of a PB string value. Passing 0 or null value gives NULL string pointers.
38 |
If a numeric address is passed instead of a string then no charset conversion is done.
39 |
40 |
41 | lnv_fn = lnv_somelib.of_declare_method("void some_fn(char*s)")
42 |
43 | lnv_s = lnv_core.of_create_value_of(LPSTR) // LPSTR is char* in WinAPI
44 | lnv_fn.of_invoke(lnv_s.of_get_ptr()) // of_get_ptr() gets the numeric value of the pointer
45 |
46 | // incorrect use:
47 | lnv_s = lnv_core.of_create_value_of(LPWSTR) // LPWSTR is wchar_t* in WinAPI
48 | lnv_fn.of_invoke(lnv_s.of_get_ptr()) // WRONG! because no conversion is done,
49 | // and the function expects char* and not wchar_t*
50 | // passing NULL
51 | lnv_fn.of_invoke(0)
52 | SetNull(ls_null)
53 | lnv_fn.of_invoke(ls_null)
54 |
55 |
56 |
57 |
See also
58 |
Handling TCHAR and TSTR. Unicode/ANSI function name suffixes
59 |
60 |
--------------------------------------------------------------------------------
/doc/supported-data-types.html:
--------------------------------------------------------------------------------
1 |
Supported data types
2 |
3 |
Simple types
4 |
5 | The folowing C/C++ types are supported
6 |
7 |
short, int, long, longlong and their signed/unsigned versions
8 |
char, wchar_t - character types
9 |
double, float
10 |
void - return type for procedures
11 |
12 |
13 |
Structure types
14 |
15 |
16 |
struct - a record of fields of any type
17 |
union - a struct whose fields share the same memory.
18 |
19 | For structs/unions the packing attribute can be specified. See the reference.
20 |
21 |
Pointer types
22 |
23 |
pointer to type (*)
24 |
reference to type (&)
25 |
26 |
27 |
28 |
Function prototypes
29 |
30 |
external function prototype
31 |
pointer to function (callback).
32 |
33 | For functions and function pointers a few attributes are supported. See the reference.
34 |
35 |
36 |
User-defined types
37 | A developer can declare any custom C type using one or more C typedef operators separated by ";" and
38 | passed as a string to n_pi_core.of_declare(), as follows:
39 |
40 | n_pi_core lnv_core
41 | lnv_core.of_declare(" &
42 | typedef void *LPCITEMIDLIST, *LPITEMIDLIST; &
43 | typedef int (CALLBACK* BFFCALLBACK)(HWND hwnd, UINT uMsg, LPARAM lParam, LPARAM lpData); &
44 | ")
45 |
46 |
47 |
48 |
WinAPI types
49 |
The most widely used WinAPI types are predeclared in PBInvoke.
50 |
Double, float as a return type for callbacks. However pointers to such types are supported as a return type.
58 |
Any struct of size of more than 4 bytes as a return type for any function.
59 | However pointers to such structures are supported as a return type.
60 |
Classes.
61 |
Structures inherited from other structures.
62 |
63 |
Unpack PbInvoke.PBL and libPbInvoke.DLL for your PowerBuilder version (or closest older version) to your project folder.
6 |
Add PbInvoke.PBL to application's library list.
7 |
Make a migration.
8 |
Make a full build.
9 |
10 |
11 |
Initialize PBInvoke
12 | If libPbInvoke.DLL is not in the PATH nor in the current directory then you'll need to specify the path to it
13 | in application's open event before any other call to the library:
14 |
15 | n_pi_loader lnv_loader // autoinstantiated
16 | lnv_loader.of_preload_dll("modules\libPBInvoke.dll")
17 |
18 | Note, you can change the path only, and not the DLL name because it is hard-coded in the external function declarations.
19 |
20 |
21 |
Declare DLL function
22 |
23 | This code can be placed in any convenient script. Usually it's executed once per application session
24 | and its results are cached somewhere (e.g. in instance/shared variables).
25 |
26 | n_pi_core lnv_core
27 | n_pi_library lnv_user32
28 | n_pi_method lnv_SendMessage
29 |
30 | lnv_user32 = lnv_core.of_declare_library("user32.dll")
31 |
32 | lnv_SendMessage = lnv_user32.of_declare_method(&
33 | "LRESULT WINAPI SendMessage(HWND hWnd, UINT Msg, WPARAM wParam, LPARAM lParam) ")
34 |
35 |
36 | Note, that the declaration is a C function prototype which can be directly copied from C header files
37 | or from documentation such as MSDN.
38 |
39 | HWND, UINT etc. are Windows types. Many such types are predefined in PBInvoke.
40 | But if you get "Type 'XXXX' not found" error message, then you'll need to define the type yourself
41 | before using it in declarations.
42 |
43 | n_pi_core lnv_core
44 | lnv_core.of_declare("typedef int NEWTYPE"); // this is just an example; for real typedef you'll need to
45 | // see the documentation or header files for DLL you call.
46 |
47 | ...of_declare_method(...)
48 |
49 |
50 |
51 |
4 | PBInvoke is a PowerBuilder library for calling external DLL functions with arbitrary
5 | parameter and return types - structures, unions, pointers, etc. including
6 | function pointers to PowerBuilder methods callable from DLL code as callbacks.
7 |
8 |
9 |
PBInvoke goals
10 |
11 |
12 |
Allow PowerBuilder developers to work in PowerScript with complex data structures without
13 | writing wrapper DLLs in other languages such as C/C++.
14 |
15 |
Make declarations of external functions ANSI/Unicode-independent which avoids migration issues
16 | when using the same code across ANSI and Unicode versions of PowerBuilder.
17 |
18 |
Support any C/C++ data type (except classes). This includes complex nested data types involving
19 | structs, unions, pointers, simple types and their combinations.
20 |
21 |
Support not only STDCALL calling convention, but also CDECL which is default in C/C++ programs.
22 |
23 |
Allow PB code to be called from external functions as callbacks with full access to passed parameters.
24 |
25 |
Support wide range of PowerBuilder versions from PB 6 to PB 11.5 and any future version.
26 |
27 |
28 |
29 |
30 |
Why not use native PowerBuilder external functions?
31 |
32 | PowerBuilder support of external functions has the following restrictions
33 | which make developers write wrapper code in C/C++ and compile it with third party compilers.
34 |
35 |
No support for PowerBuilder callbacks.
36 |
No support for unions and pointers to complex data types in structures.
37 |
External function declarations depend on string encoding expected by functions.
38 | Often a charset conversion is required between ANSI PB and Unicode DLL and vice versa.
39 | PowerScript attrubute ';ansi' is available only in PB10+ and makes the source code incompatible with older PB versions.
40 | PBInvoke automatically handles the encoding stuff (including function name suffixes such as A/W in WinAPI).
41 |
42 |
43 |
44 |
Why not use PowerBuilder extensions (PBNI)?
45 |
46 |
47 |
PBNI is available only as of PB9.
48 |
PBNI requires knowledge of C++.
49 |
PBNI extensions are quite hard to write and debug.
50 |
PBNI requires separate DLLs for ANSI and Unicode versions.
51 |
14 |
15 | The folowing C/C++ types are supported
16 |
17 |
short, int, long, longlong and their signed/unsigned versions
18 |
char, wchar_t - character types
19 |
double, float
20 |
void - return type for procedures
21 |
22 |
23 |
Structure types
24 |
25 |
26 |
struct - a record of fields of any type
27 |
union - a struct whose fields share the same memory.
28 |
29 | For structs/unions the packing attribute can be specified. See the reference.
30 |
31 |
Pointer types
32 |
33 |
pointer to type (*)
34 |
reference to type (&)
35 |
36 |
37 |
38 |
Function prototypes
39 |
40 |
external function prototype
41 |
pointer to function (callback).
42 |
43 | For functions and function pointers a few attributes are supported. See the reference.
44 |
45 |
46 |
User-defined types
47 | A developer can declare any custom C type using one or more C typedef operators separated by ";" and
48 | passed as a string to n_pi_core.of_declare(), as follows:
49 |
Double, float as a return type for callbacks. However pointers to such types are supported as a return type.
67 |
Any struct of size of more than 4 bytes as a return type for any function.
68 | However pointers to such structures are supported as a return type.
69 |
Classes.
70 |
Structures inherited from other structures.
71 |
72 |
Unpack PbInvoke.PBL and libPbInvoke.DLL for your PowerBuilder version (or closest older version) to your project folder.
16 |
Add PbInvoke.PBL to application's library list.
17 |
Make a migration.
18 |
Make a full build.
19 |
20 |
21 |
Initialize PBInvoke
22 | If libPbInvoke.DLL is not in the PATH nor in the current directory then you'll need to specify the path to it
23 | in application's open event before any other call to the library:
24 |
27 | Note, you can change the path only, and not the DLL name because it is hard-coded in the external function declarations.
28 |
29 |
30 |
Declare DLL function
31 |
32 | This code can be placed in any convenient script. Usually it's executed once per application session
33 | and its results are cached somewhere (e.g. in instance/shared variables).
34 |
43 |
44 | Note, that the declaration is a C function prototype which can be directly copied from C header files
45 | or from documentation such as MSDN.
46 |
47 | HWND, UINT etc. are Windows types. Many such types are predefined in PBInvoke.
48 | But if you get "Type 'XXXX' not found" error message, then you'll need to define the type yourself
49 | before using it in declarations.
50 |
n_pi_core lnv_core
51 | lnv_core.of_declare("typedef int NEWTYPE"); // this is just an example; for real typedef you'll need to
52 | // see the documentation or header files for DLL you call.
53 |
54 | ...of_declare_method(...)
55 |
14 | When a function parameter is declared as char* or wchar_t*,
15 | PBInvoke automatically converts the charset of the string if PowerBuilder
16 | native strings have different charset.
17 |
18 |
lnv_fn1 = lnv_somelib.of_declare_method("int strlen(char*s)")
19 | lnv_fn2 = lnv_somelib.of_declare_method("int wcslen(wchar_t*s)")
20 |
21 | // in PB9
22 | ll_len = lnv_fn1.of_invoke("test") // no conversion, both caller and callee are ANSI
23 | ll_len = lnv_fn2.of_invoke("test") // implicitly converts the string from ANSI to Unicode
24 |
25 | // in PB10+
26 | ll_len = lnv_fn1.of_invoke("test") // implicitly converts the string from Unicode to ANSI
27 | ll_len = lnv_fn2.of_invoke("test") // no conversion, both caller and callee are Unicode
28 |
29 |
30 | Combinations of char and wchar_t in one function are supported as well.
31 |
Passing numeric address of string instead of string
43 |
44 | If you got an address of some string as a numeric value, for example as a result of calling another function,
45 | you can pass this number instead of a PB string value. Passing 0 or null value gives NULL string pointers.
46 |
If a numeric address is passed instead of a string then no charset conversion is done.
47 |
48 |
lnv_fn = lnv_somelib.of_declare_method("void some_fn(char*s)")
49 |
50 | lnv_s = lnv_core.of_create_value_of(LPSTR) // LPSTR is char* in WinAPI
51 | lnv_fn.of_invoke(lnv_s.of_get_ptr()) // of_get_ptr() gets the numeric value of the pointer
52 |
53 | // incorrect use:
54 | lnv_s = lnv_core.of_create_value_of(LPWSTR) // LPWSTR is wchar_t* in WinAPI
55 | lnv_fn.of_invoke(lnv_s.of_get_ptr()) // WRONG! because no conversion is done,
56 | // and the function expects char* and not wchar_t*
57 | // passing NULL
58 | lnv_fn.of_invoke(0)
59 | SetNull(ls_null)
60 | lnv_fn.of_invoke(ls_null)
61 |
62 |
14 | PBInvoke is a PowerBuilder library for calling external DLL functions with arbitrary
15 | parameter and return types - structures, unions, pointers, etc. including
16 | function pointers to PowerBuilder methods callable from DLL code as callbacks.
17 |
18 |
19 |
PBInvoke goals
20 |
21 |
22 |
Allow PowerBuilder developers to work in PowerScript with complex data structures without
23 | writing wrapper DLLs in other languages such as C/C++.
24 |
25 |
Make declarations of external functions ANSI/Unicode-independent which avoids migration issues
26 | when using the same code across ANSI and Unicode versions of PowerBuilder.
27 |
28 |
Support any C/C++ data type (except classes). This includes complex nested data types involving
29 | structs, unions, pointers, simple types and their combinations.
30 |
31 |
Support not only STDCALL calling convention, but also CDECL which is default in C/C++ programs.
32 |
33 |
Allow PB code to be called from external functions as callbacks with full access to passed parameters.
34 |
35 |
Support wide range of PowerBuilder versions from PB 6 to PB 11.5 and any future version.
36 |
37 |
38 |
39 |
40 |
Why not use native PowerBuilder external functions?
41 |
42 | PowerBuilder support of external functions has the following restrictions
43 | which make developers write wrapper code in C/C++ and compile it with third party compilers.
44 |
45 |
No support for PowerBuilder callbacks.
46 |
No support for unions and pointers to complex data types in structures.
47 |
External function declarations depend on string encoding expected by functions.
48 | Often a charset conversion is required between ANSI PB and Unicode DLL and vice versa.
49 | PowerScript attrubute ';ansi' is available only in PB10+ and makes the source code incompatible with older PB versions.
50 | PBInvoke automatically handles the encoding stuff (including function name suffixes such as A/W in WinAPI).
51 |
52 |
53 |
54 |
Why not use PowerBuilder extensions (PBNI)?
55 |
56 |
57 |
PBNI is available only as of PB9.
58 |
PBNI requires knowledge of C++.
59 |
PBNI extensions are quite hard to write and debug.
60 |
PBNI requires separate DLLs for ANSI and Unicode versions.
61 |
Using the product indicates your acknowledgment that you have read this
13 | license and agree to its terms.
14 |
15 | By installing, copying or otherwise using the SOFTWARE, you agree to be
16 | bound by the terms of this LICENSE.
17 |
18 | Warning: The SOFTWARE is protected by copyright laws and international
19 | copyright treaties, as well as other intellectual property laws and treaties.
20 | The SOFTWARE is licensed, not sold.
21 |
22 | The copyright holder of the SOFTWARE is Anatoly Moskovsky <avm@sqlbatch.com>
23 |
24 | The program is a shareware. You may evaluate it for period of 30 days.
25 | After this period you may not use the Software unless you pay the
26 | registration fee. You may share the unregistered Software with other
27 | people only if the Software is distributed in this original setup package.
28 | You may not give the registration numbers or registered versions of
29 | this software to other people nor use other people's registration/registered
30 | version.
31 |
32 | GRANT OF LICENSE
33 |
34 | This LICENSE grants you the following rights:
35 |
36 | a. Single Application License. You may create commercial applications based on
37 | PBInvoke and distribute them with your executables. No royalties required.
38 | One license is required per application. This is enforced by binding
39 | PBInvoke to application's executable name.
40 | You may NOT create a distributable component/library that include PBInvoke.
41 |
42 | b. Multi Application License. You may create commercial applications based on
43 | PBInvoke and distribute them with your executables. No royalties required.
44 | Any number of applications are allowed with one license.
45 | You may NOT create a distributable component/library that include PBInvoke.
46 |
47 | c. Library License. You may create unlimited number of commercial applications,
48 | components or libraries based on PBInvoke and distribute them in any form,
49 | provided the original PBInvoke code is not modified. No royalties required.
50 |
51 | d. You may use the product by any number of developers in your organization
52 | at a time.
53 |
54 | e. You may use the trial version for the limited purposes of
55 | demonstrations, trials and design time evaluations and running a
56 | product tour. You may not use the trial version to produce commercial
57 | works.
58 |
59 | f. You may not decompile, disassemble or otherwise reverse engineer
60 | the SOFTWARE.
61 |
62 | g. You may not rent or lease the SOFTWARE.
63 |
64 | h. You may NOT transfer any of your rights under this LICENSE.
65 |
66 | i. Without prejudice to any other rights, the copyright holder may terminate
67 | this LICENSE if you fail to comply with the terms and conditions of
68 | this LICENSE. In such event, you must destroy all copies of the SOFTWARE
69 | and provide sufficient proof thereof to the copyright holder.
70 |
71 |
72 | NO WARRANTIES.
73 | The copyright holder expressly disclaims any warranty for the SOFTWARE PRODUCT.
74 | THE SOFTWARE PRODUCT AND ANY RELATED DOCUMENTATION IS PROVIDED "AS IS"
75 | WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
76 | WITHOUT LIMITATION, THE IMPLIED WARRANTIES OR MERCHANTABILITY, FITNESS
77 | FOR A PARTICULAR PURPOSE, OR NONINFRINGEMENT.
78 | THE ENTIRE RISK ARISING OUT OF USE OR PERFORMANCE OF THE SOFTWARE PRODUCT
79 | REMAINS WITH YOU.
80 | NO LIABILITY FOR CONSEQUENTIAL DAMAGES. IN NO EVENT SHALL THE COPYRIGHT HOLDER
81 | OR ITS SUPPLIERS BE LIABLE FOR ANY SPECIAL, INCIDENTAL, INDIRECT, OR
82 | CONSEQUENTIAL DAMAGES WHATSOEVER (INCLUDING, WITHOUT LIMITATION, DAMAGES
83 | FOR LOSS OF BUSINESS PROFITS, BUSINESS INTERRUPTION, LOSS OF BUSINESS
84 | INFORMATION, OR ANY OTHER PECUNIARY LOSS) ARISING OUT OF THE USE OF
85 | OR INABILITY TO USE THE SOFTWARE PRODUCT
86 |
87 |
PBInvoke supports full access to C++ structs/unions from PowerBuilder.
4 |
5 |
Because there is no equivalents for unions and field types such
6 | as pointers to structures and function pointers in PowerBuilder,
7 | PBInvoke have a special object for storing such values: n_pi_value.
8 |
9 |
Working with nested structures and unions.
10 |
Suppose you have the following structure declaration:
11 | n_pi_core lnv_core
12 | lnv_core.of_declare("struct MYSTR { union { int ival; char* sval;} u; char ch;}")
13 |
14 | This is a structure MYSTR which has a field of type char, 'ch', and a field of type union 'u',
15 | which itself has two fields 'ival' and 'sval', which share the same memory.
16 |
17 |
Some examples of working with the structure:
18 | n_pi_core lnv_core
19 | n_pi_value lnv_str
20 |
21 | // Create an instance of the structure in memory
22 | // In C++: MYSTR str;
23 | lnv_str = lnv_core.of_create_value_of("MYSTR");
24 |
25 | // Fill the structure's memory with zero bytes.
26 | // Note, however, that of_create_value_of() does it anyway.
27 | // C++: memset(&str, sizeof(MYSTR), 0);
28 | lnv_str.of_set(0)
29 |
30 | // Assign to sval field of the union
31 | // C++: str.u.sval = "test";
32 | lnv_str.of_item("u").of_set("sval", "test")
33 |
34 | A few words regarding what does n_pi_value.of_item do.
35 | When you call of_item("fieldname"), a n_pi_value is returned which is a reference to the field.
36 | No data is copied. When you modify this reference, the original structure is modified.
37 |
of_item() is used most often for accessing nested structures.
38 | If you have a field of a simple type (string, numeric) you use of_get("field")/of_set("field", value)
39 | instead of of_item("field").
40 |
Also note, that field name in of_item(), of_get(), of_set() is case sensitive.
41 |
42 | // Read the value of ival which now holds the pointer to the string "test" because ival and sval share their memory.
43 | // C++: int i = str.u.ival;
44 | ll_i = lnv_str.of_item("u").of_get("ival")
45 |
46 | // Assign to ch field of the structure
47 | // C++: str.ch = 'A';
48 | lnv_str.of_set("ch", "A")
49 | lnv_str.of_set(2, "A") // Fields can also be accessed by a 1-based index in order of their declarations.
50 |
51 | // Pass the structure as a parameter to a function:
52 | // C++: void fn1(MYSTR s) { }
53 | // fn1(str)
54 | n_pi_method lnv_fn1
55 | lnv_fn1 = lnv_somedll.of_declare_method("void fn1(MYSTR s)")
56 | lnv_fn1.of_invoke(lnv_str) // lnv_str's value is copied.
57 |
58 | // Pass the structure as a pointer parameter to a function:
59 | // C++: void fn2(MYSTR *s) { s->u.sval = "fn2"; };
60 | // fn2(&str)
61 | lnv_fn2 = lnv_somedll.of_declare_method("void fn2(MYSTR *s)")
62 | lnv_fn2.of_invoke(lnv_str) // implicitly gets the address of the structure
63 | //or
64 | lnv_fn2.of_invoke(lnv_str.of_get_addr()) // which is the same, but explicit.
65 |
66 | // If the structure is modified in fn2 we'll see those changes
67 | String ls_mod
68 | ls_mod = lnv_str.of_item("u").of_get("sval") // returns "fn2"
69 |
70 |
71 |
72 |
Working with pointers to structures as fields.
73 | Pointers to a type require dereferencing in order to allow access to the value they point to.
74 |
75 |
76 | lnv_core.of_declare("struct N { int a;}") // declare a struct
77 | lnv_core.of_declare("struct S { N* n;}") // declare a struct with nested pointer to a struct
78 | // create an instance
79 | // C++: S str;
80 | lnv_str = lnv_core.of_create_value_of("S")
81 |
82 | // init the pointer n with the address of an instance of N
83 | // C++: s.n = new N();
84 | lnv_str.of_set("n", lnv_core.of_create_value_of("N"))
85 |
86 | // access the nested field, a
87 | // C++: str.n->a = 123;
88 | lnv_str.of_item("n").of_deref().of_set("a", 123)
89 |
90 | // get the nested structure as separate reference
91 | // C++: N &n = *str.n;
92 | lnv_n = lnv_str.of_item("n").of_deref() // note this is just a reference, not a copy.
93 |
94 | //Now lnv_n.of_get("a") is the same as lnv_str.of_item("n").of_deref().of_get("a")
95 |
96 |
97 |
PBInvoke supports full access to C++ structs/unions from PowerBuilder.
14 |
15 |
Because there is no equivalents for unions and field types such
16 | as pointers to structures and function pointers in PowerBuilder,
17 | PBInvoke have a special object for storing such values: n_pi_value.
18 |
19 |
Working with nested structures and unions.
20 |
Suppose you have the following structure declaration:
21 |
n_pi_core lnv_core
22 | lnv_core.of_declare("struct MYSTR { union { int ival; char* sval;} u; char ch;}")
23 |
24 | This is a structure MYSTR which has a field of type char, 'ch', and a field of type union 'u',
25 | which itself has two fields 'ival' and 'sval', which share the same memory.
26 |
27 |
Some examples of working with the structure:
28 |
n_pi_core lnv_core
29 | n_pi_value lnv_str
30 |
31 | // Create an instance of the structure in memory
32 | // In C++: MYSTR str;
33 | lnv_str = lnv_core.of_create_value_of("MYSTR");
34 |
35 | // Fill the structure's memory with zero bytes.
36 | // Note, however, that of_create_value_of() does it anyway.
37 | // C++: memset(&str, sizeof(MYSTR), 0);
38 | lnv_str.of_set(0)
39 |
40 | // Assign to sval field of the union
41 | // C++: str.u.sval = "test";
42 | lnv_str.of_item("u").of_set("sval", "test")
43 |
44 | A few words regarding what does n_pi_value.of_item do.
45 | When you call of_item("fieldname"), a n_pi_value is returned which is a reference to the field.
46 | No data is copied. When you modify this reference, the original structure is modified.
47 |
of_item() is used most often for accessing nested structures.
48 | If you have a field of a simple type (string, numeric) you use of_get("field")/of_set("field", value)
49 | instead of of_item("field").
50 |
Also note, that field name in of_item(), of_get(), of_set() is case sensitive.
51 |
// Read the value of ival which now holds the pointer to the string "test" because ival and sval share their memory.
52 | // C++: int i = str.u.ival;
53 | ll_i = lnv_str.of_item("u").of_get("ival")
54 |
55 | // Assign to ch field of the structure
56 | // C++: str.ch = 'A';
57 | lnv_str.of_set("ch", "A")
58 | lnv_str.of_set(2, "A") // Fields can also be accessed by a 1-based index in order of their declarations.
59 |
60 | // Pass the structure as a parameter to a function:
61 | // C++: void fn1(MYSTR s) { }
62 | // fn1(str)
63 | n_pi_method lnv_fn1
64 | lnv_fn1 = lnv_somedll.of_declare_method("void fn1(MYSTR s)")
65 | lnv_fn1.of_invoke(lnv_str) // lnv_str's value is copied.
66 |
67 | // Pass the structure as a pointer parameter to a function:
68 | // C++: void fn2(MYSTR *s) { s->u.sval = "fn2"; };
69 | // fn2(&str)
70 | lnv_fn2 = lnv_somedll.of_declare_method("void fn2(MYSTR *s)")
71 | lnv_fn2.of_invoke(lnv_str) // implicitly gets the address of the structure
72 | //or
73 | lnv_fn2.of_invoke(lnv_str.of_get_addr()) // which is the same, but explicit.
74 |
75 | // If the structure is modified in fn2 we'll see those changes
76 | String ls_mod
77 | ls_mod = lnv_str.of_item("u").of_get("sval") // returns "fn2"
78 |
79 |
80 |
81 |
Working with pointers to structures as fields.
82 | Pointers to a type require dereferencing in order to allow access to the value they point to.
83 |
84 |
lnv_core.of_declare("struct N { int a;}") // declare a struct
85 | lnv_core.of_declare("struct S { N* n;}") // declare a struct with nested pointer to a struct
86 | // create an instance
87 | // C++: S str;
88 | lnv_str = lnv_core.of_create_value_of("S")
89 |
90 | // init the pointer n with the address of an instance of N
91 | // C++: s.n = new N();
92 | lnv_str.of_set("n", lnv_core.of_create_value_of("N"))
93 |
94 | // access the nested field, a
95 | // C++: str.n->a = 123;
96 | lnv_str.of_item("n").of_deref().of_set("a", 123)
97 |
98 | // get the nested structure as separate reference
99 | // C++: N &n = *str.n;
100 | lnv_n = lnv_str.of_item("n").of_deref() // note this is just a reference, not a copy.
101 |
102 | //Now lnv_n.of_get("a") is the same as lnv_str.of_item("n").of_deref().of_get("a")
103 |
PowerBuilder does not support PowerScript code to be directly called from external functions.
4 |
5 |
As of PB9 there is a possibility to write a C++ extension for that task using PBNI.
6 | However, implementing callbacks using PBNI has the following limitations:
7 |
PBNI requires knowledge of C++ from PowerBuilder developer
8 |
PBNI extensions are quite hard to write and debug.
9 |
PBNI requires separate DLLs for ANSI and Unicode versions.
10 |
PBNI is available only as of PB9.
11 |
Also, there are additional limitations not related to PBNI.
12 |
It's hard to implement (even in C++) passing of context data to the callback if the caller does not support that.
13 |
A charset conversion is needed when the caller is ANSI and PB is Unicode and vice versa.
14 |
15 |
PBInvoke has support for declaring and using callbacks directly in PowerScript code
16 | without these limitations.
17 |
18 |
Callback declaration
19 |
In order to declare a callback you need the following steps:
20 |
Inherit a custom class from n_pi_method
21 |
In the constructor event, call of_declare_callback() with a callback type declaration
22 | or a type name (in case the type was declared earlier).
23 |
44 | Use n_pi_method.of_get_addr() to get the numeric value of the callback address ready to be passed to
45 | an external function which accepts function pointers of this type.
46 |
47 |
Accessing callback parameters and returning result
58 |
59 |
In the ue_callback event, callback parameters can be retrieved by
60 | calling of_get_param("paramname").
61 |
62 |
The return value is passed to the caller of the callback using usual RETURN operator.
63 | Note, that PBInvoke does not support the following types as return types of callbacks:
64 |
float(real), double
65 |
longlong
66 |
structs/unions of size of more than 4 bytes
67 |
However, pointers or references to those type are supported.
68 |
69 |
All context data needed by a callback can be stored in the instance variables of the callback object
89 | (which is a descendant of n_pi_method).
90 |
That is possible because PBInvoke generates a unique phisical address (function pointer) for
91 | each callback object, and when an external function calls your callback via that address, PBInvoke maps that call
92 | exactly to your object.
93 |
94 |
95 |
Performance of callbacks
96 |
Marshalling parameters between C++ and PB is a slow operation (compared to PB external functions calls) due to
97 | the flexibility PBInvoke provides. If a PB callback is used as a handler for intercepting GUI messages
98 | (e.g. via calling SetWindowsHookEx), then it may cause slow repaint of UI, or even a hang for a long time,
99 | because UI generates huge amount of messages, most of which are ignored by the callback but take time for marshalling.
100 |
101 |
PBInvoke provides an optimization for that case. For callbacks used with SetWindowsHookEx WinAPI
102 | function, it's possible to setup a filter for message ID's which are processed by the callback.
103 | If a message ID does not pass the filter, the PowerScript code of the callback will not be called and all the processing
104 | will be done in C++ according to the rules described in MSDN for SetWindowsHookEx hooks: call
105 | CallNextHookEx.
106 |
In order to activate the message filter you must call of_set_windows_hook_filter() immediately
107 | after calling SetWindowsHookEx().
108 |
hook_handle - hook handle returned by SetWindowsHookEx()
115 |
hook_type - one of supported by PBInvoke hook types (WH_CALLWNDPROCRET, WH_CALLWNDPROC, WH_GETMESSAGE)
116 |
message_id_array[] - array of long integers filled with accepted message ID's
117 |
118 |
119 |
Example:
120 | // This code is part of CustomSaveAs sample, which demonstrates
121 | // using callbacks for customizing Windows Shell 'Save As' dialog.
122 | Long ll_hInstance, ll_hThreadID
123 |
124 | ll_hInstance = inv_GetWindowLong.of_invoke(al_windowhandle, n_pi_winapi.GWL_HINSTANCE)
125 | ll_hThreadID = inv_GetCurrentThreadId.of_invoke()
126 |
127 | il_hHook = inv_SetWindowsHookEx.of_invoke(n_pi_winapi.WH_CALLWNDPROCRET, this.of_get_addr(), ll_hInstance, ll_hThreadID)
128 |
129 | // IMPORTANT! As number of messages sent to UI related windows hooks is really huge,
130 | // processing them all in PowerScript is inefficient, and probably will hang the UI.
131 | // PBInvoke can efficiently filter hook messages by message id.
132 | // The following call enables this feature.
133 | // of_set_windows_hook_filter must be called immediately after SetWindowsHookEx()
134 | // The args: hook handle, hook type, and array of message ids which pass via filter to the hook.
135 | of_set_windows_hook_filter(il_hHook, n_pi_winapi.WH_CALLWNDPROCRET, &
136 | {n_pi_winapi.CB_ADDSTRING, n_pi_winapi.CB_SETCURSEL} )
137 |
138 | // Currently only WH_CALLWNDPROCRET, WH_CALLWNDPROC, WH_GETMESSAGE hook types are
139 | // supported with this filtering feature
140 |
141 |
142 |
See also
143 |
Calling DLL functions using PBInvoke
144 |
145 |
146 |
--------------------------------------------------------------------------------
/src/Runtime.h:
--------------------------------------------------------------------------------
1 | #pragma once
2 |
3 | #pragma warning (disable:4786)
4 | #include
5 |
6 | #include
7 |
8 | //#include "DataTypes.h"
9 | #include "types/BaseType.h"
10 | #include "types/MethodType.h"
11 | #include "MethodInstance.h"
12 |
13 | using namespace std;
14 |
15 |
16 | class ParamStorage;
17 | class IRuntimeExceptionRegistry;
18 |
19 | class RuntimeException
20 | {
21 | public:
22 | string formatErrorMessage(const string &prefix, const string &suffix, DWORD error);
23 | RuntimeException(const string &msg = "", DWORD lastOsError = 0);
24 | RuntimeException(IRuntimeExceptionRegistry *registry, const string &msg = "", DWORD lastOsError = 0);
25 | inline string& getMessage() { return m_message; }
26 | private:
27 | string m_message;
28 | void init(IRuntimeExceptionRegistry *registry, const string &msg = "", DWORD lastOsError = 0);
29 | };
30 |
31 | class IRuntimeExceptionRegistry{
32 | public:
33 | /** Register exception */
34 | virtual void registerException(RuntimeException &e) = 0;
35 | virtual string getLastException() = 0;
36 | virtual void clearLastExceptionMessage() = 0;
37 | };
38 |
39 | class ExecutionContext: public IRuntimeExceptionRegistry
40 | {
41 | public:
42 | ExecutionContext() {}
43 | virtual ~ExecutionContext();
44 |
45 | /**
46 | Converts ANSI string to Unicode.
47 | Allocates memory if needed. Memory is freed auto on scope exit.
48 |
49 | @param srcString source ANSI string with trailing zero char.
50 | @param strLen length of srcString in characters.
51 | @param buf preallocated buffer
52 | */
53 | wchar_t* convertAtoW(const char *srcString, int strLen = -1, wchar_t *buf = NULL);
54 |
55 | /**
56 | Converts ANSI string length to Unicode string length.
57 | No memory is allocated.
58 |
59 | @param srcString source ANSI string with trailing zero char.
60 | @param strLen length of srcString in characters (not counting zero char).
61 |
62 | @return length of Unicode string in characters (not counting zero char)
63 | */
64 | int strlenAtoW(const char *srcString, int strLen = -1);
65 |
66 | /**
67 | Converts Unicode string to ANSI.
68 | Allocates memory if needed. Memory is freed auto on scope exit.
69 |
70 | @param srcString source Unicode string with trailing zero char.
71 | @param strLen length of srcString in characters.
72 | @param buf preallocated buffer
73 | */
74 | char* convertWtoA(const wchar_t *srcString, int strLen = -1, char *buf = NULL);
75 |
76 | /**
77 | Converts Unicode string length to ANSI string length.
78 | No memory is allocated.
79 |
80 | @param srcString source Unicode string with trailing zero char.
81 | @param strLen length of srcString in characters (not counting zero char).
82 |
83 | @return length of Unicode string in characters (not counting zero char)
84 | */
85 | int strlenWtoA(const wchar_t *srcString, int strLen = -1);
86 |
87 | /** Register exception text */
88 | void registerException(RuntimeException &e);
89 |
90 |
91 | virtual string getLastException();
92 |
93 | virtual void clearLastExceptionMessage() { m_lastExceptionMessage = ""; }
94 |
95 | /**
96 | Allocates buffer for data, pointers to which are passed as params.
97 | Callers of setParam must copy data to the buffer in order to pass the pointer to it as param.
98 | This is needed for re-entrance.
99 | These buffers are freed automatically on ParamStorage scope's exit
100 |
101 | @param size Buffer size in bytes.
102 |
103 | @return Pointer to allocated buffer
104 | */
105 | BYTE * allocateBuffer(int size, int align = 1);
106 |
107 | virtual void clear();
108 |
109 | protected:
110 | /** Allocated param buffers */
111 | vector m_buffers;
112 |
113 | /** Allocated param buffers sizes*/
114 | vector m_bufferSizes;
115 |
116 | /** The last exception occured during calls to ExecutionContext.
117 | TODO store previous exceptions */
118 | string m_lastExceptionMessage;
119 |
120 | void clearBuffers();
121 | };
122 |
123 | /**
124 | Class implementing storage of and access to params of a method .
125 | TODO merge to class Method
126 |
127 | */
128 | class ParamStorage: public ExecutionContext {
129 | public:
130 | BYTE * getParamAddr(int paramIndex);
131 | /**
132 | Ctor.
133 |
134 | @param paramTypes Array of param Types (metadata)
135 | */
136 | //ParamStorage(vector ¶mTypes, BYTE* argsPtr = NULL);
137 | ParamStorage(vector ¶ms, BYTE* argsPtr = NULL);
138 | ParamStorage() : m_storageType(Type()) {}
139 |
140 | /**
141 | Dtor.
142 | */
143 | virtual ~ParamStorage();
144 |
145 |
146 | /**
147 | Frees the allocated buffers and clears the params values.
148 | Must be called before re-using the ParamStorage instance.
149 | */
150 | //void clearParamData();
151 |
152 | virtual void clear();
153 |
154 | size_t getArgStackSize();
155 | inline void setArgsPtr(BYTE *argsPtr) { m_paramDataPtr = argsPtr; }
156 |
157 | void dumpData(const string &text = "");
158 | protected:
159 |
160 | /** Packed params binary values ready to be passed to a C function */
161 | blob m_paramDataBuf;
162 | BYTE* m_paramDataPtr;
163 |
164 | private:
165 |
166 | /** Init */
167 | void init();
168 |
169 | protected:
170 | /** Storage metadata */
171 | Type m_storageType;
172 |
173 |
174 | /** Param offsets in m_paramData */
175 | vector m_paramPointers;
176 |
177 | };
178 |
179 | class Library: public ExecutionContext {
180 | public:
181 | Library(const string &libraryName, bool delayLoad = false);
182 | virtual ~Library();
183 | DWORD getMethodAddr(const string &methodName, bool enableTCharSuffix = true);
184 | Type& getMethodType(const string &methodName);
185 | MethodInstance* createMethodInstance(const string& methodDecl, bool enableTCharSuffix);
186 | //MethodType* createMethodType(char * methodName, char *returnType,
187 | // char *paramTypes[], int paramCount, bool isStdCall = true, bool isUnicode = false);
188 |
189 | // IRuntimeExceptionRegistry
190 | /** Register exception */
191 |
192 | private:
193 | void ensureIsLoaded();
194 | string m_libraryName;
195 | HMODULE m_libraryHandle;
196 | string m_nameSpace;
197 | };
198 |
199 |
200 | class Method: public ParamStorage
201 | {
202 | public:
203 | BYTE* getReturnValueAddr();
204 | virtual void clear();
205 |
206 | void invoke(MethodInstance *methodInstance);
207 | Method(MethodType *methodType, BYTE* argsPtr = NULL);
208 | virtual ~Method();
209 | inline MethodType *getMethodType() { return m_methodType; }
210 | private:
211 | MethodType *m_methodType;
212 | vector m_returnValue;
213 | };
214 |
215 | typedef boost::shared_ptr MethodContextPtr;
--------------------------------------------------------------------------------