mirror of
https://github.com/mozilla/gecko-dev.git
synced 2024-11-02 07:05:24 +00:00
136 lines
6.2 KiB
C++
136 lines
6.2 KiB
C++
/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
|
|
/* ***** BEGIN LICENSE BLOCK *****
|
|
* Version: NPL 1.1/GPL 2.0/LGPL 2.1
|
|
*
|
|
* The contents of this file are subject to the Netscape Public License
|
|
* Version 1.1 (the "License"); you may not use this file except in
|
|
* compliance with the License. You may obtain a copy of the License at
|
|
* http://www.mozilla.org/NPL/
|
|
*
|
|
* Software distributed under the License is distributed on an "AS IS" basis,
|
|
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
|
|
* for the specific language governing rights and limitations under the
|
|
* License.
|
|
*
|
|
* The Original Code is Mozilla Communicator client code.
|
|
*
|
|
* The Initial Developer of the Original Code is
|
|
* Netscape Communications Corporation.
|
|
* Portions created by the Initial Developer are Copyright (C) 1998
|
|
* the Initial Developer. All Rights Reserved.
|
|
*
|
|
* Contributor(s):
|
|
*
|
|
* Alternatively, the contents of this file may be used under the terms of
|
|
* either the GNU General Public License Version 2 or later (the "GPL"), or
|
|
* the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
|
|
* in which case the provisions of the GPL or the LGPL are applicable instead
|
|
* of those above. If you wish to allow use of your version of this file only
|
|
* under the terms of either the GPL or the LGPL, and not to allow others to
|
|
* use your version of this file under the terms of the NPL, indicate your
|
|
* decision by deleting the provisions above and replace them with the notice
|
|
* and other provisions required by the GPL or the LGPL. If you do not delete
|
|
* the provisions above, a recipient may use your version of this file under
|
|
* the terms of any one of the NPL, the GPL or the LGPL.
|
|
*
|
|
* ***** END LICENSE BLOCK ***** */
|
|
|
|
#ifndef nsXPComFactory_h__
|
|
#define nsXPComFactory_h__
|
|
|
|
#include "nsIFactory.h"
|
|
|
|
/*
|
|
* This file contains a macro for the implementation of a simple XPCOM factory.
|
|
*
|
|
* To implement a factory for a given component, you need to declare the
|
|
* factory class using the NS_DEF_FACTORY() macro.
|
|
*
|
|
* The first macro argument is the name for the factory.
|
|
*
|
|
* The second macro argument is a function (provided by you) which
|
|
* can be called by your DLL's NSGetFactory(...) entry point.
|
|
*
|
|
* Example:
|
|
*
|
|
* NS_DEF_FACTORY(SomeComponent,SomeComponentImpl)
|
|
*
|
|
* Declares:
|
|
*
|
|
* class nsSomeComponentFactory : public nsIFactory {};
|
|
*
|
|
* NOTE that the NS_DEF_FACTORY takes care of enforcing the "ns" prefix
|
|
* and appending the "Factory" suffix to the given name.
|
|
*
|
|
* To use the new factory:
|
|
*
|
|
* nsresult NS_New_SomeComponent_Factory(nsIFactory** aResult)
|
|
* {
|
|
* nsresult rv = NS_OK;
|
|
* nsIFactory* inst = new nsSomeComponentFactory;
|
|
* if (NULL == inst) {
|
|
* rv = NS_ERROR_OUT_OF_MEMORY;
|
|
* } else {
|
|
* NS_ADDREF(inst);
|
|
* }
|
|
* *aResult = inst;
|
|
* return rv;
|
|
* }
|
|
*
|
|
* NOTE:
|
|
* ----
|
|
* The factories created by this macro are not thread-safe and do not
|
|
* support aggregation.
|
|
*
|
|
*/
|
|
#define NS_DEF_FACTORY(_name,_type) \
|
|
class ns##_name##Factory : public nsIFactory \
|
|
{ \
|
|
public: \
|
|
NS_DECL_ISUPPORTS \
|
|
\
|
|
ns##_name##Factory() { NS_INIT_ISUPPORTS(); } \
|
|
\
|
|
NS_IMETHOD CreateInstance(nsISupports *aOuter, \
|
|
const nsIID &aIID, \
|
|
void **aResult) \
|
|
{ \
|
|
nsresult rv; \
|
|
\
|
|
_type * inst; \
|
|
\
|
|
if (NULL == aResult) { \
|
|
rv = NS_ERROR_NULL_POINTER; \
|
|
goto done; \
|
|
} \
|
|
*aResult = NULL; \
|
|
if (NULL != aOuter) { \
|
|
rv = NS_ERROR_NO_AGGREGATION; \
|
|
goto done; \
|
|
} \
|
|
\
|
|
NS_NEWXPCOM(inst, _type); \
|
|
if (NULL == inst) { \
|
|
rv = NS_ERROR_OUT_OF_MEMORY; \
|
|
goto done; \
|
|
} \
|
|
NS_ADDREF(inst); \
|
|
rv = inst->QueryInterface(aIID, aResult); \
|
|
NS_RELEASE(inst); \
|
|
\
|
|
done: \
|
|
return rv; \
|
|
} \
|
|
\
|
|
NS_IMETHOD LockFactory(PRBool aLock) \
|
|
{ \
|
|
return NS_OK; \
|
|
} \
|
|
\
|
|
protected: \
|
|
virtual ~ns##_name##Factory() {} \
|
|
}; \
|
|
NS_IMPL_ISUPPORTS1(ns##_name##Factory, nsIFactory);
|
|
|
|
#endif /* nsXPComFactory_h__ */
|