nsISupportsBase.h
上传用户:goldcmy89
上传日期:2017-12-03
资源大小:2246k
文件大小:4k
源码类别:

PlugIns编程

开发平台:

Visual C++

  1. /* ***** BEGIN LICENSE BLOCK *****
  2.  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
  3.  *
  4.  * The contents of this file are subject to the Mozilla Public License Version
  5.  * 1.1 (the "License"); you may not use this file except in compliance with
  6.  * the License. You may obtain a copy of the License at
  7.  * http://www.mozilla.org/MPL/
  8.  *
  9.  * Software distributed under the License is distributed on an "AS IS" basis,
  10.  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  11.  * for the specific language governing rights and limitations under the
  12.  * License.
  13.  *
  14.  * The Original Code is XPCOM.
  15.  *
  16.  * The Initial Developer of the Original Code is Netscape Communications Corp.
  17.  * Portions created by the Initial Developer are Copyright (C) 2001
  18.  * the Initial Developer. All Rights Reserved.
  19.  *
  20.  * Contributor(s):
  21.  *
  22.  * Alternatively, the contents of this file may be used under the terms of
  23.  * either the GNU General Public License Version 2 or later (the "GPL"), or
  24.  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  25.  * in which case the provisions of the GPL or the LGPL are applicable instead
  26.  * of those above. If you wish to allow use of your version of this file only
  27.  * under the terms of either the GPL or the LGPL, and not to allow others to
  28.  * use your version of this file under the terms of the MPL, indicate your
  29.  * decision by deleting the provisions above and replace them with the notice
  30.  * and other provisions required by the GPL or the LGPL. If you do not delete
  31.  * the provisions above, a recipient may use your version of this file under
  32.  * the terms of any one of the MPL, the GPL or the LGPL.
  33.  *
  34.  * ***** END LICENSE BLOCK ***** */
  35. #ifndef nsISupportsBase_h__
  36. #define nsISupportsBase_h__
  37. #ifndef nscore_h___
  38. #include "nscore.h"
  39. #endif
  40. #ifndef nsID_h__
  41. #include "nsID.h"
  42. #endif
  43. /*@{*/
  44. /**
  45.  * IID for the nsISupports interface
  46.  * {00000000-0000-0000-c000-000000000046}
  47.  *
  48.  * To maintain binary compatibility with COM's IUnknown, we define the IID
  49.  * of nsISupports to be the same as that of COM's IUnknown.
  50.  */
  51. #define NS_ISUPPORTS_IID                                                      
  52.   { 0x00000000, 0x0000, 0x0000,                                               
  53.     {0xc0, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x46} }
  54. /**
  55.  * Reference count values
  56.  *
  57.  * This is the return type for AddRef() and Release() in nsISupports.
  58.  * IUnknown of COM returns an unsigned long from equivalent functions.
  59.  * The following ifdef exists to maintain binary compatibility with
  60.  * IUnknown.
  61.  */
  62. #if defined(XP_WIN) && PR_BYTES_PER_LONG == 4
  63. typedef unsigned long nsrefcnt;
  64. #else
  65. typedef PRUint32 nsrefcnt;
  66. #endif
  67. /**
  68.  * Basic component object model interface. Objects which implement
  69.  * this interface support runtime interface discovery (QueryInterface)
  70.  * and a reference counted memory model (AddRef/Release). This is
  71.  * modelled after the win32 IUnknown API.
  72.  */
  73. class NS_NO_VTABLE nsISupports {
  74. public:
  75.   /**
  76.    * @name Methods
  77.    */
  78.   //@{
  79.   /**
  80.    * A run time mechanism for interface discovery.
  81.    * @param aIID [in] A requested interface IID
  82.    * @param aInstancePtr [out] A pointer to an interface pointer to
  83.    * receive the result.
  84.    * @return <b>NS_OK</b> if the interface is supported by the associated
  85.    * instance, <b>NS_NOINTERFACE</b> if it is not.
  86.    * <b>NS_ERROR_INVALID_POINTER</b> if <i>aInstancePtr</i> is <b>NULL</b>.
  87.    */
  88.   NS_IMETHOD QueryInterface(REFNSIID aIID, void** aInstancePtr) = 0;
  89.   /**
  90.    * Increases the reference count for this interface.
  91.    * The associated instance will not be deleted unless
  92.    * the reference count is returned to zero.
  93.    *
  94.    * @return The resulting reference count.
  95.    */
  96.   NS_IMETHOD_(nsrefcnt) AddRef(void) = 0;
  97.   /**
  98.    * Decreases the reference count for this interface.
  99.    * Generally, if the reference count returns to zero,
  100.    * the associated instance is deleted.
  101.    *
  102.    * @return The resulting reference count.
  103.    */
  104.   NS_IMETHOD_(nsrefcnt) Release(void) = 0;
  105.   //@}
  106. };
  107. /*@}*/
  108. #endif