summaryrefslogtreecommitdiffstats
path: root/xpcom/components/nsComponentManagerUtils.h
blob: b6f15aabaae076f1299980ac8399b3bbe1413666 (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
/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* vim: set ts=8 sts=2 et sw=2 tw=80: */
/* This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */

#ifndef nsComponentManagerUtils_h__
#define nsComponentManagerUtils_h__

#include "nscore.h"
#include "nsCOMPtr.h"

#include "nsIFactory.h"

nsresult CallCreateInstance(const nsCID& aCID, const nsIID& aIID,
                            void** aResult);

nsresult CallCreateInstance(const char* aContractID, const nsIID& aIID,
                            void** aResult);

nsresult CallGetClassObject(const nsCID& aCID, const nsIID& aIID,
                            void** aResult);

nsresult CallGetClassObject(const char* aContractID, const nsIID& aIID,
                            void** aResult);

class MOZ_STACK_CLASS nsCreateInstanceByCID final : public nsCOMPtr_helper {
 public:
  nsCreateInstanceByCID(const nsCID& aCID, nsresult* aErrorPtr)
      : mCID(aCID), mErrorPtr(aErrorPtr) {}

  virtual nsresult NS_FASTCALL operator()(const nsIID&, void**) const override;

 private:
  const nsCID& mCID;
  nsresult* mErrorPtr;
};

class MOZ_STACK_CLASS nsCreateInstanceByContractID final
    : public nsCOMPtr_helper {
 public:
  nsCreateInstanceByContractID(const char* aContractID, nsresult* aErrorPtr)
      : mContractID(aContractID), mErrorPtr(aErrorPtr) {}

  virtual nsresult NS_FASTCALL operator()(const nsIID&, void**) const override;

 private:
  const char* mContractID;
  nsresult* mErrorPtr;
};

class MOZ_STACK_CLASS nsCreateInstanceFromFactory final
    : public nsCOMPtr_helper {
 public:
  nsCreateInstanceFromFactory(nsIFactory* aFactory, nsresult* aErrorPtr)
      : mFactory(aFactory), mErrorPtr(aErrorPtr) {}

  virtual nsresult NS_FASTCALL operator()(const nsIID&, void**) const override;

 private:
  nsIFactory* MOZ_NON_OWNING_REF mFactory;
  nsresult* mErrorPtr;
};

inline const nsCreateInstanceByCID do_CreateInstance(const nsCID& aCID,
                                                     nsresult* aError = 0) {
  return nsCreateInstanceByCID(aCID, aError);
}

inline const nsCreateInstanceByContractID do_CreateInstance(
    const char* aContractID, nsresult* aError = 0) {
  return nsCreateInstanceByContractID(aContractID, aError);
}

inline const nsCreateInstanceFromFactory do_CreateInstance(
    nsIFactory* aFactory, nsresult* aError = 0) {
  return nsCreateInstanceFromFactory(aFactory, aError);
}

class MOZ_STACK_CLASS nsGetClassObjectByCID final : public nsCOMPtr_helper {
 public:
  nsGetClassObjectByCID(const nsCID& aCID, nsresult* aErrorPtr)
      : mCID(aCID), mErrorPtr(aErrorPtr) {}

  virtual nsresult NS_FASTCALL operator()(const nsIID&, void**) const override;

 private:
  const nsCID& mCID;
  nsresult* mErrorPtr;
};

class MOZ_STACK_CLASS nsGetClassObjectByContractID final
    : public nsCOMPtr_helper {
 public:
  nsGetClassObjectByContractID(const char* aContractID, nsresult* aErrorPtr)
      : mContractID(aContractID), mErrorPtr(aErrorPtr) {}

  virtual nsresult NS_FASTCALL operator()(const nsIID&, void**) const override;

 private:
  const char* mContractID;
  nsresult* mErrorPtr;
};

/**
 * do_GetClassObject can be used to improve performance of callers
 * that call |CreateInstance| many times.  They can cache the factory
 * and call do_CreateInstance or CallCreateInstance with the cached
 * factory rather than having the component manager retrieve it every
 * time.
 */
inline const nsGetClassObjectByCID do_GetClassObject(const nsCID& aCID,
                                                     nsresult* aError = 0) {
  return nsGetClassObjectByCID(aCID, aError);
}

inline const nsGetClassObjectByContractID do_GetClassObject(
    const char* aContractID, nsresult* aError = 0) {
  return nsGetClassObjectByContractID(aContractID, aError);
}

// type-safe shortcuts for calling |CreateInstance|
template <class DestinationType>
inline nsresult CallCreateInstance(const nsCID& aClass,
                                   DestinationType** aDestination) {
  MOZ_ASSERT(aDestination, "null parameter");

  return CallCreateInstance(aClass, NS_GET_TEMPLATE_IID(DestinationType),
                            reinterpret_cast<void**>(aDestination));
}

template <class DestinationType>
inline nsresult CallCreateInstance(const char* aContractID,
                                   DestinationType** aDestination) {
  MOZ_ASSERT(aContractID, "null parameter");
  MOZ_ASSERT(aDestination, "null parameter");

  return CallCreateInstance(aContractID, NS_GET_TEMPLATE_IID(DestinationType),
                            reinterpret_cast<void**>(aDestination));
}

template <class DestinationType>
inline nsresult CallCreateInstance(nsIFactory* aFactory,
                                   DestinationType** aDestination) {
  MOZ_ASSERT(aFactory, "null parameter");
  MOZ_ASSERT(aDestination, "null parameter");

  return aFactory->CreateInstance(nullptr, NS_GET_TEMPLATE_IID(DestinationType),
                                  reinterpret_cast<void**>(aDestination));
}

template <class DestinationType>
inline nsresult CallGetClassObject(const nsCID& aClass,
                                   DestinationType** aDestination) {
  MOZ_ASSERT(aDestination, "null parameter");

  return CallGetClassObject(aClass, NS_GET_TEMPLATE_IID(DestinationType),
                            reinterpret_cast<void**>(aDestination));
}

template <class DestinationType>
inline nsresult CallGetClassObject(const char* aContractID,
                                   DestinationType** aDestination) {
  MOZ_ASSERT(aDestination, "null parameter");

  return CallGetClassObject(aContractID, NS_GET_TEMPLATE_IID(DestinationType),
                            reinterpret_cast<void**>(aDestination));
}

#endif /* nsComponentManagerUtils_h__ */