summaryrefslogtreecommitdiff
path: root/src/pdll.h
blob: 22d74557661eb36634de0342ea5abc3d195ef5bf (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
////////////////////////////////////////////////////////////////////////////////////////////////////
//  Class:  PDll                                                                                                    //
//  Authors: MicHael Galkovsky                                                                           //
//  Date:    April 14, 1998                                                                                  //
//  Company:  Pervasive Software                                                                    //
//  Purpose:    Base class to wrap dynamic use of dll                                          //
//////////////////////////////////////////////////////////////////////////////////////////////

#if !defined (_PDLL_H_)
#define _PDLL_H_

#include <windows.h>
#include <winbase.h>

#include <windows_error.h>
#include <tchar.h>
#include <sstream>


#define FUNC_LOADED 3456

//function declarations according to the number of parameters
//define the type
//declare a variable of that type
//declare a member function by the same name as the dll function
//check for dll handle
//if this is the first call to the function then try to load it
//if not then if the function was loaded successfully make a call to it
//otherwise return a nullptr cast to the return parameter.

#define DECLARE_FUNCTION0(CallType, retVal, FuncName) \
    typedef  retVal (CallType* TYPE_##FuncName)(); \
    TYPE_##FuncName m_##FuncName; \
    short m_is##FuncName; \
    retVal FuncName() \
    { \
        if (m_dllHandle) \
        { \
            if (FUNC_LOADED != m_is##FuncName) \
            {\
                m_##FuncName = nullptr; \
                m_##FuncName = (TYPE_##FuncName)GetProcAddress(m_dllHandle, #FuncName); \
                m_is##FuncName = FUNC_LOADED;\
            }\
            if (nullptr != m_##FuncName) \
                return m_##FuncName(); \
            else \
                return (retVal)nullptr; \
        } \
        else \
            return (retVal)nullptr; \
    }

#define DECLARE_FUNCTION1(CallType,retVal, FuncName, Param1) \
    typedef  retVal (CallType* TYPE_##FuncName)(Param1); \
    TYPE_##FuncName m_##FuncName; \
    short m_is##FuncName;\
    retVal FuncName(Param1 p1) \
    { \
        if (m_dllHandle) \
        { \
            if (FUNC_LOADED != m_is##FuncName) \
            {\
                m_##FuncName = nullptr; \
                m_##FuncName = (TYPE_##FuncName)GetProcAddress(m_dllHandle, #FuncName); \
                m_is##FuncName = FUNC_LOADED;\
            }\
            if (nullptr != m_##FuncName) \
                return m_##FuncName(p1); \
            else \
                return (retVal)nullptr; \
        } \
        else \
            return (retVal)nullptr; \
    }

#define DECLARE_FUNCTION2(CallType,retVal, FuncName, Param1, Param2) \
    typedef  retVal (CallType* TYPE_##FuncName)(Param1, Param2); \
    TYPE_##FuncName m_##FuncName; \
    short m_is##FuncName;\
    retVal FuncName (Param1 p1, Param2 p2) \
    {\
        if (m_dllHandle)\
        {\
            if (FUNC_LOADED != m_is##FuncName) \
            {\
                m_##FuncName = nullptr; \
                m_##FuncName = (TYPE_##FuncName)GetProcAddress(m_dllHandle, #FuncName); \
                m_is##FuncName = FUNC_LOADED;\
            }\
            if (nullptr != m_##FuncName) \
                return m_##FuncName(p1, p2); \
            else \
                return (retVal)nullptr; \
        } \
        else\
            return (retVal)nullptr; \
    }

#define DECLARE_FUNCTION3(CallType,retVal, FuncName, Param1, Param2, Param3) \
    typedef  retVal (CallType* TYPE_##FuncName)(Param1, Param2, Param3); \
    TYPE_##FuncName m_##FuncName; \
    short m_is##FuncName;\
    retVal FuncName (Param1 p1, Param2 p2, Param3 p3) \
    {\
        if (m_dllHandle)\
        {\
            if (FUNC_LOADED != m_is##FuncName) \
            {\
                m_##FuncName = nullptr; \
                m_##FuncName = (TYPE_##FuncName)GetProcAddress(m_dllHandle, #FuncName); \
                m_is##FuncName = FUNC_LOADED; \
            }\
            if (nullptr != m_##FuncName) \
                return m_##FuncName(p1, p2, p3);\
            else \
                return (retVal)nullptr; \
        } \
        else\
            return (retVal)nullptr; \
    }

#define DECLARE_FUNCTION4(CallType,retVal, FuncName, Param1, Param2, Param3, Param4) \
    typedef  retVal (CallType* TYPE_##FuncName)(Param1, Param2, Param3, Param4); \
    TYPE_##FuncName m_##FuncName; \
    short m_is##FuncName;\
    retVal FuncName (Param1 p1, Param2 p2, Param3 p3, Param4 p4) \
    {\
        if (m_dllHandle)\
        {\
            if (FUNC_LOADED != m_is##FuncName) \
            {\
                m_##FuncName = nullptr; \
                m_##FuncName = (TYPE_##FuncName)GetProcAddress(m_dllHandle, #FuncName); \
                m_is##FuncName = FUNC_LOADED;\
            }\
            if (nullptr != m_##FuncName) \
                return m_##FuncName(p1, p2, p3, p4);\
            else \
                return (retVal)nullptr; \
        } \
        else\
            return (retVal)nullptr; \
    }

#define DECLARE_FUNCTION5(CallType,retVal, FuncName, Param1, Param2, Param3, Param4, Param5) \
    typedef  retVal (CallType* TYPE_##FuncName)(Param1, Param2, Param3, Param4, Param5); \
    TYPE_##FuncName m_##FuncName; \
    short m_is##FuncName; \
    retVal FuncName (Param1 p1, Param2 p2, Param3 p3, Param4 p4, Param5 p5) \
    {\
        if (m_dllHandle)\
        {\
            if (FUNC_LOADED != m_is##FuncName) \
            {\
                m_##FuncName = nullptr; \
                m_##FuncName = (TYPE_##FuncName)GetProcAddress(m_dllHandle, #FuncName); \
                m_is##FuncName = FUNC_LOADED;\
            }\
            if (nullptr != m_##FuncName) \
                return m_##FuncName(p1, p2, p3, p4, p5);\
            else \
                return (retVal)nullptr; \
        } \
        else\
            return (retVal)nullptr; \
    }

#define DECLARE_FUNCTION6(CallType,retVal, FuncName, Param1, Param2, Param3, Param4, Param5, Param6) \
    typedef  retVal (CallType* TYPE_##FuncName)(Param1, Param2, Param3, Param4, Param5, Param6); \
    TYPE_##FuncName m_##FuncName; \
    short m_is##FuncName;\
    retVal FuncName (Param1 p1, Param2 p2, Param3 p3, Param4 p4, Param5 p5, Param6 p6) \
    {\
        if (m_dllHandle)\
        {\
            if (FUNC_LOADED != m_is##FuncName) \
            {\
                m_##FuncName = nullptr; \
                m_##FuncName = (TYPE_##FuncName)GetProcAddress(m_dllHandle, #FuncName); \
                m_is##FuncName = FUNC_LOADED;\
            }\
            if (nullptr != m_##FuncName) \
                return m_##FuncName(p1, p2, p3, p4, p5, p6);\
            else \
                return (retVal)nullptr; \
        } \
        else\
            return (retVal)nullptr; \
    }

#define DECLARE_FUNCTION7(CallType,retVal, FuncName, Param1, Param2, Param3, Param4, Param5, Param6, Param7) \
    typedef  retVal (CallType* TYPE_##FuncName)(Param1, Param2, Param3, Param4, Param5, Param6, Param7); \
    TYPE_##FuncName m_##FuncName; \
    short m_is##FuncName;\
    retVal FuncName (Param1 p1, Param2 p2, Param3 p3, Param4 p4, Param5 p5, Param6 p6, Param7 p7) \
    {\
        if (m_dllHandle)\
        {\
            if (FUNC_LOADED != m_is##FuncName) \
            {\
                m_##FuncName = nullptr; \
                m_##FuncName = (TYPE_##FuncName)GetProcAddress(m_dllHandle, #FuncName); \
                m_is##FuncName = FUNC_LOADED;\
            }\
            if (nullptr != m_##FuncName) \
                return m_##FuncName(p1, p2, p3, p4, p5, p6, p7);\
            else \
                return (retVal)nullptr; \
        } \
        else\
            return (retVal)nullptr; \
    }

#define DECLARE_FUNCTION8(CallType,retVal, FuncName, Param1, Param2, Param3, Param4, Param5, Param6, Param7, Param8) \
    typedef  retVal (CallType* TYPE_##FuncName)(Param1, Param2, Param3, Param4, Param5, Param6, Param7, Param8); \
    TYPE_##FuncName m_##FuncName; \
    short m_is##FuncName;\
    retVal FuncName (Param1 p1, Param2 p2, Param3 p3, Param4 p4, Param5 p5, Param6 p6, Param7 p7, Param8 p8) \
    {\
        if (m_dllHandle)\
        {\
            if (FUNC_LOADED != m_is##FuncName) \
            {\
                m_##FuncName = nullptr; \
                m_##FuncName = (TYPE_##FuncName)GetProcAddress(m_dllHandle, #FuncName); \
                m_is##FuncName = FUNC_LOADED;\
            }\
            if (nullptr != m_##FuncName) \
                return m_##FuncName(p1, p2, p3, p4, p5, p6, p7, p8);\
            else \
                return (retVal)nullptr; \
        }\
        else\
            return (retVal)nullptr; \
    }

#define DECLARE_FUNCTION9(CallType,retVal, FuncName, Param1, Param2, Param3, Param4, Param5, Param6, Param7, Param8, Param9) \
    typedef  retVal (CallType* TYPE_##FuncName)(Param1, Param2, Param3, Param4, Param5, Param6, Param7, Param8, Param9); \
    TYPE_##FuncName m_##FuncName; \
    short m_is##FuncName; \
    retVal FuncName (Param1 p1, Param2 p2, Param3 p3, Param4 p4, Param5 p5, Param6 p6, Param7 p7, Param8 p8, Param9 p9) \
    {\
        if (m_dllHandle)\
        {\
            if (FUNC_NAME != m_is##FuncName) \
            {\
                m_##FuncName = nullptr; \
                m_##FuncName = (TYPE_##FuncName)GetProcAddress(m_dllHandle, #FuncName); \
                m_is##FuncName = FUNC_LOADED;\
            }\
            if (nullptr != m_##FuncName) \
                return m_##FuncName(p1, p2, p3, p4, p5, p6, p7, p8, p9);\
            else \
                return (retVal)nullptr; \
        }\
        else\
            return (retVal)nullptr; \
    }

#define DECLARE_FUNCTION10(CallType,retVal, FuncName, Param1, Param2, Param3, Param4, Param5, Param6, Param7, Param8, Param9, Param10) \
    typedef  retVal (CallType* TYPE_##FuncName)FuncName(Param1, Param2, Param3, Param4, Param5, Param6, Param7, Param8, Param9, Param10); \
    TYPE_##FuncName m_##FuncName; \
    short m_is##FuncName;\
    retVal FuncName (Param1 p1, Param2 p2, Param3 p3, Param4 p4, Param5 p5, Param6 p6, Param7 p7, Param8 p8, Param9 p9, Param10 p10) \
    {\
        if (m_dllHandle)\
        {\
            if (FUNC_LOADED != m_is##FuncName) \
            {\
                m_##FuncName = nullptr; \
                m_##FuncName = (TYPE_##FuncName)GetProcAddress(m_dllHandle, #FuncName); \
                m_is##FuncName = FUNC_LOADED;\
            }\
            if (nullptr != m_##FuncName) \
                return m_##FuncName(p1, p2, p3, p4, p5, p6, p7, p8, p9, p10);\
            else \
                return (retVal)nullptr; \
        }\
        else                    \
            return (retVal)nullptr;\
    }

//declare constructors and LoadFunctions
#define DECLARE_CLASS(ClassName) \
    public: \
    ClassName (LPCTSTR name){LoadDll(name);} \
    ClassName () {PDLL();}

class PDLL
{
protected:
  HINSTANCE m_dllHandle;
private:
    LPTSTR m_dllName;
    int m_refCount;

public:

    PDLL()
    {
        m_dllHandle = nullptr;
        m_dllName = nullptr;
        m_refCount = 0;
    }

    //A nullptr here means the name has already been set
    void LoadDll(LPCTSTR name, bool showMsg = true)
    {
        if (name)
            SetDllName(name);

        //try to load
        m_dllHandle = LoadLibrary(m_dllName);

        if (m_dllHandle == nullptr && showMsg)
        {
          std::ostringstream message;
          message << "failed to load dll: " << ::GetLastError();
          throw std::runtime_error(message.str().c_str());
        }
    }

    bool SetDllName(LPCTSTR newName)
    {
        bool retVal = false;

        //we allow name resets only if the current DLL handle is invalid
        //once they've hooked into a DLL, the  name cannot be changed
        if (!m_dllHandle)
        {
            if (m_dllName)
            {
                delete []m_dllName;
                m_dllName = nullptr;
            }

            //They may be setting this null (e.g., uninitialize)
            if (newName)
            {
                m_dllName = new TCHAR[_tcslen(newName) + 1];
                _tcscpy(m_dllName, newName);
            }
            retVal = true;
        }
        return retVal;
    }

    virtual bool Initialize(short showMsg = 1)
    {

        bool retVal = false;

        //Add one to our internal reference counter
        m_refCount++;

        if (m_refCount == 1 && m_dllName) //if this is first time, load the DLL
        {
            //we are assuming the name is already set
            LoadDll(nullptr, showMsg);
            retVal = (m_dllHandle != nullptr);
        }
        return retVal;
    }

    virtual void Uninitialize(void)
    {
        //If we're already completely unintialized, early exit
        if (!m_refCount)
            return;
        //if this is the last time this instance has been unitialized,
        //then do a full uninitialization
        m_refCount--;

        if (m_refCount < 1)
        {
            if (m_dllHandle)
            {
                FreeLibrary(m_dllHandle);
                m_dllHandle = nullptr;
            }

            SetDllName(nullptr); //clear out the name & free memory
        }
    }

    virtual ~PDLL()
    {
        //force this to be a true uninitialize
        m_refCount = 1;
        Uninitialize();

        //free name
        if (m_dllName)
        {
            delete [] m_dllName;
            m_dllName = nullptr;
        }
    }

};
#endif