mirror of
https://github.com/mozilla/gecko-dev.git
synced 2024-11-07 12:15:51 +00:00
292 lines
10 KiB
C++
292 lines
10 KiB
C++
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
|
|
/*
|
|
* The contents of this file are subject to the Netscape Public License
|
|
* Version 1.1 (the "NPL"); you may not use this file except in
|
|
* compliance with the NPL. You may obtain a copy of the NPL at
|
|
* http://www.mozilla.org/NPL/
|
|
*
|
|
* Software distributed under the NPL is distributed on an "AS IS" basis,
|
|
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the NPL
|
|
* for the specific language governing rights and limitations under the
|
|
* NPL.
|
|
*
|
|
* The Initial Developer of this code under the NPL is Netscape
|
|
* Communications Corporation. Portions created by Netscape are
|
|
* Copyright (C) 1998 Netscape Communications Corporation. All Rights
|
|
* Reserved.
|
|
*/
|
|
|
|
#ifndef nsComponentManagerUtils_h__
|
|
#define nsComponentManagerUtils_h__
|
|
|
|
#ifndef nsCOMPtr_h__
|
|
#include "nsCOMPtr.h"
|
|
#endif
|
|
|
|
#ifndef OBSOLETE_MODULE_LOADING
|
|
/*
|
|
* Prototypes for dynamic library export functions. Your DLL/DSO needs to export
|
|
* these methods to play in the component world.
|
|
*
|
|
* THIS IS OBSOLETE. Look at nsIModule.idl
|
|
*/
|
|
|
|
extern "C" NS_EXPORT nsresult NSGetFactory(nsISupports* aServMgr,
|
|
const nsCID &aClass,
|
|
const char *aClassName,
|
|
const char *aProgID,
|
|
nsIFactory **aFactory);
|
|
extern "C" NS_EXPORT PRBool NSCanUnload(nsISupports* aServMgr);
|
|
extern "C" NS_EXPORT nsresult NSRegisterSelf(nsISupports* aServMgr, const char *fullpath);
|
|
extern "C" NS_EXPORT nsresult NSUnregisterSelf(nsISupports* aServMgr, const char *fullpath);
|
|
|
|
typedef nsresult (*nsFactoryProc)(nsISupports* aServMgr,
|
|
const nsCID &aClass,
|
|
const char *aClassName,
|
|
const char *aProgID,
|
|
nsIFactory **aFactory);
|
|
typedef PRBool (*nsCanUnloadProc)(nsISupports* aServMgr);
|
|
typedef nsresult (*nsRegisterProc)(nsISupports* aServMgr, const char *path);
|
|
typedef nsresult (*nsUnregisterProc)(nsISupports* aServMgr, const char *path);
|
|
#endif /* OBSOLETE_MODULE_LOADING */
|
|
|
|
#define NS_COMPONENTMANAGER_CID \
|
|
{ /* 91775d60-d5dc-11d2-92fb-00e09805570f */ \
|
|
0x91775d60, \
|
|
0xd5dc, \
|
|
0x11d2, \
|
|
{0x92, 0xfb, 0x00, 0xe0, 0x98, 0x05, 0x57, 0x0f} \
|
|
}
|
|
|
|
#define NS_COMPONENTMANAGER_PROGID "xpcom.componentmanager.1"
|
|
|
|
extern NS_COM nsresult
|
|
NS_GetGlobalComponentManager(nsIComponentManager* *result);
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
// Global Static Component Manager Methods
|
|
// (for when you need to link with xpcom)
|
|
|
|
class NS_COM nsComponentManager {
|
|
public:
|
|
static nsresult Initialize(void);
|
|
|
|
// Finds a factory for a specific class ID
|
|
static nsresult FindFactory(const nsCID &aClass,
|
|
nsIFactory **aFactory);
|
|
|
|
// Get the singleton class object that implements the CID aClass
|
|
static nsresult GetClassObject(const nsCID &aClass, const nsIID &aIID,
|
|
void **aResult);
|
|
|
|
// Finds a class ID for a specific Program ID
|
|
static nsresult ProgIDToClassID(const char *aProgID,
|
|
nsCID *aClass);
|
|
|
|
// Finds a Program ID for a specific class ID
|
|
// caller frees the result with delete[]
|
|
static nsresult CLSIDToProgID(nsCID *aClass,
|
|
char* *aClassName,
|
|
char* *aProgID);
|
|
|
|
// Creates a class instance for a specific class ID
|
|
static nsresult CreateInstance(const nsCID &aClass,
|
|
nsISupports *aDelegate,
|
|
const nsIID &aIID,
|
|
void **aResult);
|
|
|
|
// Convenience routine, creates a class instance for a specific ProgID
|
|
static nsresult CreateInstance(const char *aProgID,
|
|
nsISupports *aDelegate,
|
|
const nsIID &aIID,
|
|
void **aResult);
|
|
|
|
// Manually registry a factory for a class
|
|
static nsresult RegisterFactory(const nsCID &aClass,
|
|
const char *aClassName,
|
|
const char *aProgID,
|
|
nsIFactory *aFactory,
|
|
PRBool aReplace);
|
|
|
|
// Manually register a dynamically loaded component.
|
|
// The libraryPersistentDescriptor is what gets passed to the library
|
|
// self register function from ComponentManager. The format of this string
|
|
// is the same as nsIFile::GetPath()
|
|
//
|
|
// This function will go away in favour of RegisterComponentSpec. In fact,
|
|
// it internally turns around and calls RegisterComponentSpec.
|
|
static nsresult RegisterComponent(const nsCID &aClass,
|
|
const char *aClassName,
|
|
const char *aProgID,
|
|
const char *aLibraryPersistentDescriptor,
|
|
PRBool aReplace,
|
|
PRBool aPersist);
|
|
|
|
// Register a component using its FileSpec as its identification
|
|
// This is the more prevalent use.
|
|
static nsresult RegisterComponentSpec(const nsCID &aClass,
|
|
const char *aClassName,
|
|
const char *aProgID,
|
|
nsIFile *aLibrary,
|
|
PRBool aReplace,
|
|
PRBool aPersist);
|
|
|
|
// Register a component using its dllName. This could be a dll name with
|
|
// no path so that LD_LIBRARY_PATH on unix or PATH on win can load it. Or
|
|
// this could be a code fragment name on the Mac.
|
|
static nsresult RegisterComponentLib(const nsCID &aClass,
|
|
const char *aClassName,
|
|
const char *aProgID,
|
|
const char *adllName,
|
|
PRBool aReplace,
|
|
PRBool aPersist);
|
|
|
|
|
|
// Manually unregister a factory for a class
|
|
static nsresult UnregisterFactory(const nsCID &aClass,
|
|
nsIFactory *aFactory);
|
|
|
|
// Manually unregister a dynamically loaded component
|
|
static nsresult UnregisterComponent(const nsCID &aClass,
|
|
const char *aLibrary);
|
|
|
|
// Manually unregister a dynamically loaded component
|
|
static nsresult UnregisterComponentSpec(const nsCID &aClass,
|
|
nsIFile *aLibrarySpec);
|
|
|
|
// Unload dynamically loaded factories that are not in use
|
|
static nsresult FreeLibraries(void);
|
|
//////////////////////////////////////////////////////////////////////////////
|
|
// DLL registration support
|
|
|
|
// If directory is NULL, then AutoRegister will try registering components
|
|
// in the default components directory.
|
|
static nsresult AutoRegister(PRInt32 when, nsIFile* directory);
|
|
static nsresult AutoRegisterComponent(PRInt32 when, nsIFile *component);
|
|
static nsresult AutoUnregisterComponent(PRInt32 when, nsIFile *component);
|
|
|
|
// Is the given CID currently registered?
|
|
static nsresult IsRegistered(const nsCID &aClass,
|
|
PRBool *aRegistered);
|
|
|
|
// Get an enumeration of all the CIDs
|
|
static nsresult EnumerateCLSIDs(nsIEnumerator** aEmumerator);
|
|
|
|
// Get an enumeration of all the ProgIDs
|
|
static nsresult EnumerateProgIDs(nsIEnumerator** aEmumerator);
|
|
|
|
};
|
|
|
|
|
|
class NS_COM nsCreateInstanceByCID : public nsCOMPtr_helper
|
|
{
|
|
public:
|
|
nsCreateInstanceByCID( const nsCID& aCID, nsISupports* aOuter, nsresult* aErrorPtr )
|
|
: mCID(aCID),
|
|
mOuter(aOuter),
|
|
mErrorPtr(aErrorPtr)
|
|
{
|
|
// nothing else to do here
|
|
}
|
|
|
|
virtual nsresult operator()( const nsIID&, void** ) const;
|
|
|
|
private:
|
|
const nsCID& mCID;
|
|
nsISupports* mOuter;
|
|
nsresult* mErrorPtr;
|
|
};
|
|
|
|
class NS_COM nsCreateInstanceByProgID : public nsCOMPtr_helper
|
|
{
|
|
public:
|
|
nsCreateInstanceByProgID( const char* aProgID, nsISupports* aOuter, nsresult* aErrorPtr )
|
|
: mProgID(aProgID),
|
|
mOuter(aOuter),
|
|
mErrorPtr(aErrorPtr)
|
|
{
|
|
// nothing else to do here
|
|
}
|
|
|
|
virtual nsresult operator()( const nsIID&, void** ) const;
|
|
|
|
private:
|
|
const char* mProgID;
|
|
nsISupports* mOuter;
|
|
nsresult* mErrorPtr;
|
|
};
|
|
|
|
class NS_COM nsCreateInstanceFromCategory : public nsCOMPtr_helper
|
|
{
|
|
public:
|
|
nsCreateInstanceFromCategory(const char *aCategory, const char *aEntry,
|
|
nsISupports *aOuter, nsresult *aErrorPtr)
|
|
: mCategory(aCategory),
|
|
mEntry(aEntry),
|
|
mErrorPtr(aErrorPtr)
|
|
{
|
|
// nothing else to do;
|
|
}
|
|
virtual nsresult operator()( const nsIID&, void** ) const;
|
|
virtual ~nsCreateInstanceFromCategory() {};
|
|
|
|
private:
|
|
const char *mCategory;
|
|
const char *mEntry;
|
|
nsISupports *mOuter;
|
|
nsresult *mErrorPtr;
|
|
};
|
|
|
|
inline
|
|
const nsCreateInstanceByCID
|
|
do_CreateInstance( const nsCID& aCID, nsresult* error = 0 )
|
|
{
|
|
return nsCreateInstanceByCID(aCID, 0, error);
|
|
}
|
|
|
|
inline
|
|
const nsCreateInstanceByCID
|
|
do_CreateInstance( const nsCID& aCID, nsISupports* aOuter, nsresult* error = 0 )
|
|
{
|
|
return nsCreateInstanceByCID(aCID, aOuter, error);
|
|
}
|
|
|
|
inline
|
|
const nsCreateInstanceByProgID
|
|
do_CreateInstance( const char* aProgID, nsresult* error = 0 )
|
|
{
|
|
return nsCreateInstanceByProgID(aProgID, 0, error);
|
|
}
|
|
|
|
inline
|
|
const nsCreateInstanceByProgID
|
|
do_CreateInstance( const char* aProgID, nsISupports* aOuter, nsresult* error = 0 )
|
|
{
|
|
return nsCreateInstanceByProgID(aProgID, aOuter, error);
|
|
}
|
|
|
|
inline
|
|
const nsCreateInstanceFromCategory
|
|
do_CreateInstanceFromCategory( const char *aCategory, const char *aEntry,
|
|
nsresult *aErrorPtr = 0)
|
|
{
|
|
return nsCreateInstanceFromCategory(aCategory, aEntry, 0, aErrorPtr);
|
|
}
|
|
|
|
inline
|
|
const nsCreateInstanceFromCategory
|
|
do_CreateInstanceFromCategory( const char *aCategory, const char *aEntry,
|
|
nsISupports *aOuter, nsresult *aErrorPtr = 0)
|
|
{
|
|
return nsCreateInstanceFromCategory(aCategory, aEntry, aOuter, aErrorPtr);
|
|
}
|
|
|
|
/* keys for registry use */
|
|
extern const char xpcomKeyName[];
|
|
extern const char xpcomComponentsKeyName[];
|
|
extern const char lastModValueName[];
|
|
extern const char fileSizeValueName[];
|
|
extern const char nativeComponentType[];
|
|
|
|
#endif /* nsComponentManagerUtils_h__ */
|