xpcom/base/nsTraceRefcntImpl.h

   1 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   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 Communicator client 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  *   L. David Baron <dbaron@dbaron.org>
  24  *
  25  * Alternatively, the contents of this file may be used under the terms of
  26  * either of the GNU General Public License Version 2 or later (the "GPL"),
  27  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  28  * in which case the provisions of the GPL or the LGPL are applicable instead
  29  * of those above. If you wish to allow use of your version of this file only
  30  * under the terms of either the GPL or the LGPL, and not to allow others to
  31  * use your version of this file under the terms of the MPL, indicate your
  32  * decision by deleting the provisions above and replace them with the notice
  33  * and other provisions required by the GPL or the LGPL. If you do not delete
  34  * the provisions above, a recipient may use your version of this file under
  35  * the terms of any one of the MPL, the GPL or the LGPL.
  36  *
  37  * ***** END LICENSE BLOCK ***** */
  38 #ifndef nsTraceRefcntImpl_h___
  39 #define nsTraceRefcntImpl_h___
  40
  41 #include <stdio.h> // for FILE
  42 #include "nsITraceRefcnt.h"
  43
  44 class nsTraceRefcntImpl : public nsITraceRefcnt
  45 {
  46 public:
  47   NS_DECL_ISUPPORTS
  48   NS_DECL_NSITRACEREFCNT
  49
  50   static NS_COM void Startup();
  51   static NS_COM void Shutdown();
  52
  53   enum StatisticsType {
  54     ALL_STATS,
  55     NEW_STATS
  56   };
  57
  58   static NS_COM nsresult DumpStatistics(StatisticsType type = ALL_STATS,
  59                                         FILE* out = 0);
  60
  61   static NS_COM void ResetStatistics(void);
  62
  63   static NS_COM void DemangleSymbol(const char * aSymbol,
  64                                     char * aBuffer,
  65                                     int aBufLen);
  66
  67   static NS_COM void WalkTheStack(FILE* aStream);
  68   /**
  69    * Tell nsTraceRefcnt whether refcounting, allocation, and destruction
  70    * activity is legal.  This is used to trigger assertions for any such
  71    * activity that occurs because of static constructors or destructors.
  72    */
  73   static NS_COM void SetActivityIsLegal(PRBool aLegal);
  74
  75   static NS_METHOD Create(nsISupports* outer, const nsIID& aIID, void* *aInstancePtr);
  76 };
  77
  78 #define NS_TRACE_REFCNT_CONTRACTID "@mozilla.org/xpcom/trace-refcnt;1"
  79 #define NS_TRACE_REFCNT_CLASSNAME  "nsTraceRefcnt Interface"
  80 #define NS_TRACE_REFCNT_CID                          \
  81 { /* e3e7511e-a395-4924-94b1-d527861cded4 */         \
  82     0xe3e7511e,                                      \
  83     0xa395,                                          \
  84     0x4924,                                          \
  85     {0x94, 0xb1, 0xd5, 0x27, 0x86, 0x1c, 0xde, 0xd4} \
  86 }                                                    \
  87
  88 ////////////////////////////////////////////////////////////////////////////////
  89 // And now for that utility that you've all been asking for...
  90
  91 extern "C" NS_COM void
  92 NS_MeanAndStdDev(double n, double sumOfValues, double sumOfSquaredValues,
  93                  double *meanResult, double *stdDevResult);
  94
  95 ////////////////////////////////////////////////////////////////////////////////
  96 #endif