File: DynamicLibrary.hh

package info (click to toggle)
3dwm 0.3.1-8
  • links: PTS
  • area: main
  • in suites: woody
  • size: 3,368 kB
  • ctags: 2,547
  • sloc: cpp: 11,981; sh: 7,850; ansic: 851; makefile: 287; yacc: 135; lex: 92
file content (121 lines) | stat: -rw-r--r-- 3,093 bytes parent folder | download
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
/* ------------------------------------------------------------------------
 * DynamicLibrary.hh
 *
 * This file is part of 3Dwm: The Three-Dimensional User Environment.
 *
 * 3Dwm: The Three-Dimensional User Environment:
 *	<http://www.3dwm.org>
 *
 * Chalmers Medialab
 * 	<http://www.medialab.chalmers.se>
 * 
 * ------------------------------------------------------------------------
 * File created 2000-07-25 by Niklas Elmqvist.
 *
 * Copyright (c) 2000 Niklas Elmqvist <elm@3dwm.org>.
 * ------------------------------------------------------------------------
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 * 
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 * 
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
 * USA
 * ------------------------------------------------------------------------
 */

#ifndef _DYNAMICLIBRARY_HH_
#define _DYNAMICLIBRARY_HH_

// -- System Includes
#include <string>

// -- Class Declarations

/**
 * Simple dynamic link library (DLL) abstraction.
 **/
class DynamicLibrary {
    
public:

    /**
     * Default constructor.
     **/
    DynamicLibrary() : _handle(0) { }
    

    /**
     * Constructor.
     *
     * @param library filename (must be in path or in local dir).
     * @param now resolve symbols immediately if true, else on-demand.
     **/
    DynamicLibrary(const std::string &library, bool now = true) {
	open(library, now);
    }

    
    /**
     * Destructor.
     **/
    ~DynamicLibrary() { close(); }

    
    /**
     * Open a dynamic link library (DLL) given a filename. 
     * 
     * @param library filename (must be in path or in local dir).
     * @param now resolve symbols immediately if true, else on-demand.
     **/
    void open(const std::string &library, bool now = true);
    
    
    /**
     * Close the library.
     **/
    void close();

    
    /**
     * Retrieve the library name.
     *
     * @return the library name as a string.
     **/
    const std::string &getName() { return _name; }

    
    /**
     * Resolve a symbol in the library and return it.
     * 
     * @param symbol the symbol to resolve.
     * @return a pointer to the entity. 
     **/
    void *resolve(const std::string &symbol);

    
    /**
     * Is the library open and ready to be used?
     * 
     * @return true if it is, false otherwise.
     **/
    bool isOpen() { return _handle; }
    
protected:
    
    /// Library handle
    void *_handle;

    /// Library name
    std::string _name;

};

#endif /* DynamicLibrary.hh */