PEP 55 Update license on source files to current license text and date
[tpot/pegasus/.git] / src / Pegasus / Common / DynamicLibrary.h
1 //%2003////////////////////////////////////////////////////////////////////////
2 //
3 // Copyright (c) 2000, 2001, 2002  BMC Software, Hewlett-Packard Development
4 // Company, L. P., IBM Corp., The Open Group, Tivoli Systems.
5 // Copyright (c) 2003 BMC Software; Hewlett-Packard Development Company, L. P.;
6 // IBM Corp.; EMC Corporation, The Open Group.
7 //
8 // Permission is hereby granted, free of charge, to any person obtaining a copy
9 // of this software and associated documentation files (the "Software"), to
10 // deal in the Software without restriction, including without limitation the
11 // rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
12 // sell copies of the Software, and to permit persons to whom the Software is
13 // furnished to do so, subject to the following conditions:
14 // 
15 // THE ABOVE COPYRIGHT NOTICE AND THIS PERMISSION NOTICE SHALL BE INCLUDED IN
16 // ALL COPIES OR SUBSTANTIAL PORTIONS OF THE SOFTWARE. THE SOFTWARE IS PROVIDED
17 // "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT
18 // LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
19 // PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
20 // HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
21 // ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
22 // WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
23 //
24 //==============================================================================
25 //
26 // Author: Chip Vincent (cvincent@us.ibm.com)
27 //
28 // Modified By:
29 //
30 //%/////////////////////////////////////////////////////////////////////////////
31
32 #ifndef Pegasus_DynamicLibrary_h
33 #define Pegasus_DynamicLibrary_h
34
35 #include <Pegasus/Common/Config.h>
36 #include <Pegasus/Common/Exception.h>
37 #include <Pegasus/Common/String.h>
38
39 #include <Pegasus/Common/Linkage.h>
40
41 #if defined(PEGASUS_PLATFORM_WIN32_IX86_MSVC)
42 #include <windows.h>
43 #endif
44
45 #if defined(PEGASUS_PLATFORM_ZOS_ZSERIES_IBM)
46 #include <dll.h>
47 #endif
48
49 PEGASUS_NAMESPACE_BEGIN
50
51 class PEGASUS_COMMON_LINKAGE DynamicLibrary
52 {
53 public:
54     #if defined(PEGASUS_PLATFORM_WIN32_IX86_MSVC)
55     typedef HMODULE LIBRARY_HANDLE;
56     typedef int LIBRARY_SYMBOL;
57     #elif defined(PEGASUS_OS_LINUX) || defined(PEGASUS_OS_AIX) || defined(PEGASUS_OS_HPUX) || defined(PEGASUS_OS_SOLARIS)
58     typedef void * LIBRARY_HANDLE;
59     typedef void * LIBRARY_SYMBOL;
60     #elif defined(PEGASUS_OS_OS400)
61     typedef int LIBRARY_HANDLE;
62     typedef void * LIBRARY_SYMBOL;
63     #elif defined(PEGASUS_OS_ZOS)
64     typedef dllhandle * LIBRARY_HANDLE;
65     typedef void * LIBRARY_SYMBOL;
66     #endif
67
68 public:
69     DynamicLibrary(void);
70     DynamicLibrary(const DynamicLibrary & library);
71     explicit DynamicLibrary(const String & fileName);
72     virtual ~DynamicLibrary(void);
73
74     DynamicLibrary & operator=(const DynamicLibrary & library);
75
76     virtual Boolean load(void);
77     virtual Boolean unload(void);
78
79     virtual Boolean isLoaded(void) const;
80
81     String getFileName(void) const;
82     LIBRARY_HANDLE getHandle(void) const;
83     LIBRARY_SYMBOL getSymbol(const String & symbolName);
84
85 private:
86     String _fileName;
87     LIBRARY_HANDLE _handle;
88
89 };
90
91 PEGASUS_NAMESPACE_END
92
93 #endif