Add minimalistic protected-headers support
[gpgol.git] / src / dispcache.h
1 /* @file dispcache.h
2  * @brief Cache for IDispatch objects that are reusable.
3  *
4  * Copyright (C) 2018 Intevation GmbH
5  *
6  * This file is part of GpgOL.
7  *
8  * GpgOL is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU Lesser General Public
10  * License as published by the Free Software Foundation; either
11  * version 2.1 of the License, or (at your option) any later version.
12  *
13  * GpgOL is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16  * GNU Lesser General Public License for more details.
17  *
18  * You should have received a copy of the GNU Lesser General Public License
19  * along with this program; if not, see <http://www.gnu.org/licenses/>.
20  */
21 #ifndef DISPCACHE_H
22 #define DISPCACHE_H
23
24 #include "config.h"
25
26 #include <memory>
27
28 #include "oomhelp.h"
29
30 class GpgolAddin;
31
32 class DispCache
33 {
34     friend class GpgolAddin;
35 protected:
36     DispCache ();
37
38 public:
39     /* Accessor. Returns the instance carried by
40        gpgoladdin. */
41     static DispCache *instance ();
42
43     /* Add a IDispatch with the id id to the cache.
44
45        The IDispatch is released on destruction of
46        the cache.
47
48        Id's are meant to be defined in dialogs.h
49     */
50     void addDisp (int id, LPDISPATCH obj);
51
52     /* Get the according IDispatch object. */
53     LPDISPATCH getDisp (int id);
54
55 private:
56     class Private;
57     std::shared_ptr<Private> d;
58 };
59
60 #endif