git.saurik.com Git - wxWidgets.git/blame_incremental

Commit	Line	Data
	1	///////////////////////////////////////////////////////////////////////////////
	2	// Name: oleutils.h
	3	// Purpose: OLE helper routines, OLE debugging support &c
	4	// Author: Vadim Zeitlin
	5	// Modified by:
	6	// Created: 19.02.1998
	7	// RCS-ID: $Id$
	8	// Copyright: (c) 1998 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>
	9	// Licence: wxWindows licence
	10	///////////////////////////////////////////////////////////////////////////////
	11
	12	#ifndef _WX_OLEUTILS_H
	13	#define _WX_OLEUTILS_H
	14
	15	#ifdef __GNUG__
	16	#pragma interface "oleutils.h"
	17	#endif
	18
	19	#include "wx/defs.h"
	20
	21	#if wxUSE_NORLANDER_HEADERS
	22	#include <ole2.h>
	23	#endif
	24
	25	// ============================================================================
	26	// General purpose functions and macros
	27	// ============================================================================
	28
	29	// ----------------------------------------------------------------------------
	30	// misc helper functions/macros
	31	// ----------------------------------------------------------------------------
	32
	33	// release the interface pointer (if !NULL)
	34	inline void ReleaseInterface(IUnknown *pIUnk)
	35	{
	36	if ( pIUnk != NULL )
	37	pIUnk->Release();
	38	}
	39
	40	// release the interface pointer (if !NULL) and make it NULL
	41	#define RELEASE_AND_NULL(p) if ( (p) != NULL ) { p->Release(); p = NULL; };
	42
	43	// return TRUE if the iid is in the array
	44	extern bool IsIidFromList(REFIID riid, const IID *aIids[], size_t nCount);
	45
	46	// ============================================================================
	47	// IUnknown implementation helpers
	48	// ============================================================================
	49
	50	/*
	51	The most dumb implementation of IUnknown methods. We don't support
	52	aggregation nor containment, but for 99% of cases this simple
	53	implementation is quite enough.
	54
	55	Usage is trivial: here is all you should have
	56	1) DECLARE_IUNKNOWN_METHODS in your (IUnknown derived!) class declaration
	57	2) BEGIN/END_IID_TABLE with ADD_IID in between for all interfaces you
	58	support (at least all for which you intent to return 'this' from QI,
	59	i.e. you should derive from IFoo if you have ADD_IID(Foo)) somewhere else
	60	3) IMPLEMENT_IUNKNOWN_METHODS somewhere also
	61
	62	These macros are quite simple: AddRef and Release are trivial and QI does
	63	lookup in a static member array of IIDs and returns 'this' if it founds
	64	the requested interface in it or E_NOINTERFACE if not.
	65	*/
	66
	67	/*
	68	wxAutoULong: this class is used for automatically initalising m_cRef to 0
	69	*/
	70	class wxAutoULong
	71	{
	72	public:
	73	wxAutoULong(ULONG value = 0) : m_Value(value) { }
	74
	75	operator ULONG&() { return m_Value; }
	76	ULONG& operator=(ULONG value) { return m_Value = value; }
	77
	78	wxAutoULong& operator++() { ++m_Value; return *this; }
	79	const wxAutoULong operator++( int ) { wxAutoULong temp = *this; ++m_Value; return temp; }
	80
	81	wxAutoULong& operator--() { --m_Value; return *this; }
	82	const wxAutoULong operator--( int ) { wxAutoULong temp = *this; --m_Value; return temp; }
	83
	84	private:
	85	ULONG m_Value;
	86	};
	87
	88	// declare the methods and the member variable containing reference count
	89	// you must also define the ms_aIids array somewhere with BEGIN_IID_TABLE
	90	// and friends (see below)
	91
	92	#define DECLARE_IUNKNOWN_METHODS \
	93	public: \
	94	STDMETHODIMP QueryInterface(REFIID, void **); \
	95	STDMETHODIMP_(ULONG) AddRef(); \
	96	STDMETHODIMP_(ULONG) Release(); \
	97	private: \
	98	static const IID *ms_aIids[]; \
	99	wxAutoULong m_cRef
	100
	101	// macros for declaring supported interfaces
	102	// NB: you should write ADD_INTERFACE(Foo) and not ADD_INTERFACE(IID_IFoo)!
	103	#define BEGIN_IID_TABLE(cname) const IID *cname::ms_aIids[] = {
	104	#define ADD_IID(iid) &IID_I##iid,
	105	#define END_IID_TABLE }
	106
	107	// implementation is as straightforward as possible
	108	// Parameter: classname - the name of the class
	109	#define IMPLEMENT_IUNKNOWN_METHODS(classname) \
	110	STDMETHODIMP classname::QueryInterface(REFIID riid, void **ppv) \
	111	{ \
	112	wxLogQueryInterface(_T(#classname), riid); \
	113	\
	114	if ( IsIidFromList(riid, ms_aIids, WXSIZEOF(ms_aIids)) ) { \
	115	*ppv = this; \
	116	AddRef(); \
	117	\
	118	return S_OK; \
	119	} \
	120	else { \
	121	*ppv = NULL; \
	122	\
	123	return (HRESULT) E_NOINTERFACE; \
	124	} \
	125	} \
	126	\
	127	STDMETHODIMP_(ULONG) classname::AddRef() \
	128	{ \
	129	wxLogAddRef(_T(#classname), m_cRef); \
	130	\
	131	return ++m_cRef; \
	132	} \
	133	\
	134	STDMETHODIMP_(ULONG) classname::Release() \
	135	{ \
	136	wxLogRelease(_T(#classname), m_cRef); \
	137	\
	138	if ( --m_cRef == 0 ) { \
	139	delete this; \
	140	return 0; \
	141	} \
	142	else \
	143	return m_cRef; \
	144	}
	145
	146	// ============================================================================
	147	// Debugging support
	148	// ============================================================================
	149
	150	// VZ: I don't know it's not done for compilers other than VC++ but I leave it
	151	// as is. Please note, though, that tracing OLE interface calls may be
	152	// incredibly useful when debugging OLE programs.
	153	#if defined(__WXDEBUG__) && ( ( defined(__VISUALC__) && (__VISUALC__ >= 1000) ) \|\| defined(__MWERKS__) )
	154	// ----------------------------------------------------------------------------
	155	// All OLE specific log functions have DebugTrace level (as LogTrace)
	156	// ----------------------------------------------------------------------------
	157
	158	// tries to translate riid into a symbolic name, if possible
	159	void wxLogQueryInterface(const wxChar *szInterface, REFIID riid);
	160
	161	// these functions print out the new value of reference counter
	162	void wxLogAddRef (const wxChar *szInterface, ULONG cRef);
	163	void wxLogRelease(const wxChar *szInterface, ULONG cRef);
	164
	165	#else //!WXDEBUG
	166	#define wxLogQueryInterface(szInterface, riid)
	167	#define wxLogAddRef(szInterface, cRef)
	168	#define wxLogRelease(szInterface, cRef)
	169	#endif //WXDEBUG
	170
	171	#endif //_WX_OLEUTILS_H
	172

1

///////////////////////////////////////////////////////////////////////////////

2

// Name: oleutils.h

3

// Purpose: OLE helper routines, OLE debugging support &c

4

// Author: Vadim Zeitlin

5

// Modified by:

6

// Created: 19.02.1998

7

// RCS-ID: $Id$

8

9

// Licence: wxWindows licence

10

///////////////////////////////////////////////////////////////////////////////

11

12

#ifndef _WX_OLEUTILS_H

13

#define _WX_OLEUTILS_H

14

15

#ifdef __GNUG__

16

#pragma interface "oleutils.h"

#endif

#include "wx/defs.h"

#if wxUSE_NORLANDER_HEADERS

#include <ole2.h>

#endif

// ============================================================================

26

// General purpose functions and macros

27

// ============================================================================

28

29

// ----------------------------------------------------------------------------

30

// misc helper functions/macros

31

// ----------------------------------------------------------------------------

32

33

// release the interface pointer (if !NULL)

34

inline void ReleaseInterface(IUnknown *pIUnk)

{

if ( pIUnk != NULL )

pIUnk->Release();

}

// release the interface pointer (if !NULL) and make it NULL

41

#define RELEASE_AND_NULL(p) if ( (p) != NULL ) { p->Release(); p = NULL; };

42

43

// return TRUE if the iid is in the array

44

extern bool IsIidFromList(REFIID riid, const IID *aIids[], size_t nCount);

45

46

// ============================================================================

47

// IUnknown implementation helpers

48

// ============================================================================

49

50

/*

51

The most dumb implementation of IUnknown methods. We don't support

52

aggregation nor containment, but for 99% of cases this simple

53

implementation is quite enough.

54

55

Usage is trivial: here is all you should have

56

1) DECLARE_IUNKNOWN_METHODS in your (IUnknown derived!) class declaration

57

2) BEGIN/END_IID_TABLE with ADD_IID in between for all interfaces you

58

support (at least all for which you intent to return 'this' from QI,

59

i.e. you should derive from IFoo if you have ADD_IID(Foo)) somewhere else

60

3) IMPLEMENT_IUNKNOWN_METHODS somewhere also

61

62

These macros are quite simple: AddRef and Release are trivial and QI does

63

lookup in a static member array of IIDs and returns 'this' if it founds

64

the requested interface in it or E_NOINTERFACE if not.

*/

/*

wxAutoULong: this class is used for automatically initalising m_cRef to 0

*/

class wxAutoULong

{

public:

wxAutoULong(ULONG value = 0) : m_Value(value) { }

74

75

operator ULONG&() { return m_Value; }

76

ULONG& operator=(ULONG value) { return m_Value = value; }

77

78

wxAutoULong& operator++() { ++m_Value; return *this; }

79

const wxAutoULong operator++( int ) { wxAutoULong temp = *this; ++m_Value; return temp; }

80

81

wxAutoULong& operator--() { --m_Value; return *this; }

82

const wxAutoULong operator--( int ) { wxAutoULong temp = *this; --m_Value; return temp; }

private:

ULONG m_Value;

};

// declare the methods and the member variable containing reference count

89

// you must also define the ms_aIids array somewhere with BEGIN_IID_TABLE

90

// and friends (see below)

91

92

#define DECLARE_IUNKNOWN_METHODS \

93

public: \

94

STDMETHODIMP QueryInterface(REFIID, void **); \

95

STDMETHODIMP_(ULONG) AddRef(); \

96

STDMETHODIMP_(ULONG) Release(); \

97

private: \

98

static const IID *ms_aIids[]; \

99

wxAutoULong m_cRef

100

101

// macros for declaring supported interfaces

102

// NB: you should write ADD_INTERFACE(Foo) and not ADD_INTERFACE(IID_IFoo)!

103

#define BEGIN_IID_TABLE(cname) const IID *cname::ms_aIids[] = {

104

#define ADD_IID(iid) &IID_I##iid,

105

#define END_IID_TABLE }

106

107

// implementation is as straightforward as possible

108

// Parameter: classname - the name of the class

109

#define IMPLEMENT_IUNKNOWN_METHODS(classname) \

110

STDMETHODIMP classname::QueryInterface(REFIID riid, void **ppv) \

111

{ \

112

wxLogQueryInterface(_T(#classname), riid); \

113

\

114

if ( IsIidFromList(riid, ms_aIids, WXSIZEOF(ms_aIids)) ) { \

*ppv = this; \

AddRef(); \

\

return S_OK; \

} \

else { \

*ppv = NULL; \

\

return (HRESULT) E_NOINTERFACE; \

} \

} \

\

STDMETHODIMP_(ULONG) classname::AddRef() \

128

{ \

129

wxLogAddRef(_T(#classname), m_cRef); \

\

return ++m_cRef; \

} \

\

STDMETHODIMP_(ULONG) classname::Release() \

135

{ \

136

wxLogRelease(_T(#classname), m_cRef); \

137

\

138

if ( --m_cRef == 0 ) { \

delete this; \

return 0; \

} \

else \

return m_cRef; \

}

// ============================================================================

147

// Debugging support

148

// ============================================================================

149

150

// VZ: I don't know it's not done for compilers other than VC++ but I leave it

151

// as is. Please note, though, that tracing OLE interface calls may be

152

// incredibly useful when debugging OLE programs.

153

#if defined(__WXDEBUG__) && ( ( defined(__VISUALC__) && (__VISUALC__ >= 1000) ) || defined(__MWERKS__) )

154

// ----------------------------------------------------------------------------

155

// All OLE specific log functions have DebugTrace level (as LogTrace)

156

// ----------------------------------------------------------------------------

157

158

// tries to translate riid into a symbolic name, if possible

159

void wxLogQueryInterface(const wxChar *szInterface, REFIID riid);

160

161

// these functions print out the new value of reference counter

162

void wxLogAddRef (const wxChar *szInterface, ULONG cRef);

163

void wxLogRelease(const wxChar *szInterface, ULONG cRef);

164

165

#else //!WXDEBUG

166

#define wxLogQueryInterface(szInterface, riid)

167

#define wxLogAddRef(szInterface, cRef)

168

#define wxLogRelease(szInterface, cRef)

169

#endif //WXDEBUG

170

171

#endif //_WX_OLEUTILS_H

172