xpcom/components/nsIModule.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /* ***** BEGIN LICENSE BLOCK *****
   3  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   4  *
   5  * The contents of this file are subject to the Mozilla Public License Version
   6  * 1.1 (the "License"); you may not use this file except in compliance with
   7  * the License. You may obtain a copy of the License at
   8  * http://www.mozilla.org/MPL/
   9  *
  10  * Software distributed under the License is distributed on an "AS IS" basis,
  11  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  12  * for the specific language governing rights and limitations under the
  13  * License.
  14  *
  15  * The Original Code is mozilla.org code.
  16  *
  17  * The Initial Developer of the Original Code is
  18  * Netscape Communications Corporation.
  19  * Portions created by the Initial Developer are Copyright (C) 1998
  20  * the Initial Developer. All Rights Reserved.
  21  *
  22  * Contributor(s):
  23  *
  24  * Alternatively, the contents of this file may be used under the terms of
  25  * either of the GNU General Public License Version 2 or later (the "GPL"),
  26  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  27  * in which case the provisions of the GPL or the LGPL are applicable instead
  28  * of those above. If you wish to allow use of your version of this file only
  29  * under the terms of either the GPL or the LGPL, and not to allow others to
  30  * use your version of this file under the terms of the MPL, indicate your
  31  * decision by deleting the provisions above and replace them with the notice
  32  * and other provisions required by the GPL or the LGPL. If you do not delete
  33  * the provisions above, a recipient may use your version of this file under
  34  * the terms of any one of the MPL, the GPL or the LGPL.
  35  *
  36  * ***** END LICENSE BLOCK ***** */
  37
  38 #include "nsISupports.idl"
  39
  40 interface nsIFile;
  41 interface nsIComponentManager;
  42
  43 /**
  44  * The nsIModule interface.
  45  */
  46
  47 [scriptable, uuid(7392D032-5371-11d3-994E-00805FD26FEE)]
  48 interface nsIModule : nsISupports
  49 {
  50     /**
  51      * Object Instance Creation
  52      *
  53      * Obtains a Class Object from a nsIModule for a given CID and IID pair.
  54      * This class object can either be query to a nsIFactory or a may be
  55      * query to a nsIClassInfo.
  56      *
  57      * @param aCompMgr  : The global component manager
  58      * @param aClass    : ClassID of object instance requested
  59      * @param aIID      : IID of interface requested
  60      *
  61      */
  62     void getClassObject(in nsIComponentManager aCompMgr,
  63                         in nsCIDRef aClass,
  64                         in nsIIDRef aIID,
  65                         [retval, iid_is(aIID)] out nsQIResult aResult);
  66
  67
  68     /**
  69      * One time registration callback
  70      *
  71      * When the nsIModule is discovered, this method will be
  72      * called so that any setup registration can be preformed.
  73      *
  74      * @param aCompMgr  : The global component manager
  75      * @param aLocation : The location of the nsIModule on disk
  76      * @param aLoaderStr: Opaque loader specific string
  77      * @param aType     : Loader Type being used to load this module
  78      */
  79     void registerSelf(in nsIComponentManager aCompMgr,
  80                       in nsIFile aLocation,
  81                       in string aLoaderStr,
  82                       in string aType);
  83     /**
  84      * One time unregistration callback
  85      *
  86      * When the nsIModule is being unregistered, this method will be
  87      * called so that any unregistration can be preformed
  88      *
  89      * @param aCompMgr   : The global component manager
  90      * @param aLocation  : The location of the nsIModule on disk
  91      * @param aLoaderStr : Opaque loader specific string
  92      *
  93      */
  94    void unregisterSelf(in nsIComponentManager aCompMgr,
  95                         in nsIFile aLocation,
  96                         in string  aLoaderStr);
  97
  98    /**
  99     * Module load management
 100     *
 101     * @param aCompMgr  : The global component manager
 102     *
 103     * @return indicates to the caller if the module can be unloaded.
 104     *           Returning PR_TRUE isn't a guarantee that the module will be
 105     *           unloaded. It constitues only willingness of the module to be
 106     *           unloaded.  It is very important to ensure that no outstanding
 107     *       references to the module's code/data exist before returning
 108     *       PR_TRUE.
 109     *           Returning PR_FALSE guaratees that the module won't be unloaded.
 110     */
 111     boolean canUnload(in nsIComponentManager aCompMgr);
 112 };
 113
 114