gecko-dev/xpcom/public/nsIFactory.h

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/*
 * The contents of this file are subject to the Netscape Public License
 * Version 1.0 (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 __nsIFactory_h
#define __nsIFactory_h

#include "prtypes.h"
#include "nsISupports.h"

/*
 * Datatypes and helper macros
 */

typedef nsID nsCID;

// Define an CID
#define NS_DEFINE_CID(_name, _cidspec) \
  const nsCID _name = _cidspec

#define REFNSCID const nsCID&

/*
 * nsIFactory interface
 */

// {00000001-0000-0000-c000-000000000046}
#define NS_IFACTORY_IID \
{ 0x00000001, 0x0000, 0x0000, \
  { 0xc0, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x46 } }

class nsIFactory: public nsISupports {
public:
  static const nsIID& IID() { static nsIID iid = NS_IFACTORY_IID; return iid; }

  NS_IMETHOD CreateInstance(nsISupports *aOuter,
                            REFNSIID aIID,
                            void **aResult) = 0;

  NS_IMETHOD LockFactory(PRBool aLock) = 0;
};

/**
 * nsIFactory2 allows passing in a signature token when creating an
 * instance. This allows instance recycling.
 */

// {19997C41-A343-11d1-B665-00805F8A2676}
#define NS_IFACTORY2_IID \
{ 0x19997c41, 0xa343, 0x11d1, \
  { 0xb6, 0x65, 0x0, 0x80, 0x5f, 0x8a, 0x26, 0x76 } }

class nsIFactory2: public nsIFactory {
public:
  static const nsIID& IID() { static nsIID iid = NS_IFACTORY2_IID; return iid; }

  NS_IMETHOD CreateInstance2(nsISupports *aOuter,
                             REFNSIID aIID,
                             void *aSignature,
                             void **aResult) = 0;
};

#endif