extensions/metrics/src/nsProfileCollector.h

   1 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 /* vim:set ts=2 sw=2 sts=2 et cindent: */
   3 /* ***** BEGIN LICENSE BLOCK *****
   4  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   5  *
   6  * The contents of this file are subject to the Mozilla Public License Version
   7  * 1.1 (the "License"); you may not use this file except in compliance with
   8  * the License. You may obtain a copy of the License at
   9  * http://www.mozilla.org/MPL/
  10  *
  11  * Software distributed under the License is distributed on an "AS IS" basis,
  12  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  13  * for the specific language governing rights and limitations under the
  14  * License.
  15  *
  16  * The Original Code is the Metrics extension.
  17  *
  18  * The Initial Developer of the Original Code is Google Inc.
  19  * Portions created by the Initial Developer are Copyright (C) 2006
  20  * the Initial Developer. All Rights Reserved.
  21  *
  22  * Contributor(s):
  23  *  Brian Ryner <bryner@brianryner.com>
  24  *
  25  * Alternatively, the contents of this file may be used under the terms of
  26  * either the GNU General Public License Version 2 or later (the "GPL"), or
  27  * 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
  39 #ifndef nsProfileCollector_h_
  40 #define nsProfileCollector_h_
  41
  42 #include "nsIMetricsCollector.h"
  43
  44 class nsISupports;
  45 class nsIMetricsEventItem;
  46 class nsIPropertyBag;
  47
  48 // This file defines the profile collector class, which generates
  49 // a profile event at application startup.  The profile event logs
  50 // various information about the user's software and hardware configuration.
  51
  52 class nsProfileCollector : public nsIMetricsCollector
  53 {
  54  public:
  55   NS_DECL_ISUPPORTS
  56   NS_DECL_NSIMETRICSCOLLECTOR
  57
  58   nsProfileCollector();
  59
  60  private:
  61   class PluginEnumerator;
  62   class ExtensionEnumerator;
  63   class BookmarkCounter;
  64
  65   ~nsProfileCollector();
  66
  67   // These methods each create a particular item and append it to the profile.
  68   nsresult LogCPU(nsIMetricsEventItem *profile);
  69   nsresult LogMemory(nsIMetricsEventItem *profile);
  70   nsresult LogOS(nsIMetricsEventItem *profile);
  71   nsresult LogInstall(nsIMetricsEventItem *profile);
  72   nsresult LogExtensions(nsIMetricsEventItem *profile);
  73   nsresult LogPlugins(nsIMetricsEventItem *profile);
  74   nsresult LogDisplay(nsIMetricsEventItem *profile);
  75   nsresult LogBookmarks(nsIMetricsEventItem *profile);
  76
  77   void LogBookmarkLocation(nsIMetricsEventItem *bookmarksItem,
  78                            const nsACString &location,
  79                            BookmarkCounter *counter,
  80                            PRInt64 root, PRBool deep);
  81
  82   // Track whether we've logged the profile yet this session.
  83   PRBool mLoggedProfile;
  84 };
  85
  86 #define NS_PROFILECOLLECTOR_CLASSNAME "Profile Collector"
  87 #define NS_PROFILECOLLECTOR_CID \
  88 { 0x9d5d472d, 0x88c7, 0x4cb2, {0xa6, 0xfb, 0x1f, 0x8e, 0x4d, 0xb5, 0x7e, 0x7e}}
  89
  90 #endif  // nsProfileCollector_h_