Back to index

lightning-sunbird  0.9+nobinonly
nsProfileCollector.h
Go to the documentation of this file.
00001 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
00002 /* vim:set ts=2 sw=2 sts=2 et cindent: */
00003 /* ***** BEGIN LICENSE BLOCK *****
00004  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
00005  *
00006  * The contents of this file are subject to the Mozilla Public License Version
00007  * 1.1 (the "License"); you may not use this file except in compliance with
00008  * the License. You may obtain a copy of the License at
00009  * http://www.mozilla.org/MPL/
00010  *
00011  * Software distributed under the License is distributed on an "AS IS" basis,
00012  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
00013  * for the specific language governing rights and limitations under the
00014  * License.
00015  *
00016  * The Original Code is the Metrics extension.
00017  *
00018  * The Initial Developer of the Original Code is Google Inc.
00019  * Portions created by the Initial Developer are Copyright (C) 2006
00020  * the Initial Developer. All Rights Reserved.
00021  *
00022  * Contributor(s):
00023  *  Brian Ryner <bryner@brianryner.com>
00024  *
00025  * Alternatively, the contents of this file may be used under the terms of
00026  * either the GNU General Public License Version 2 or later (the "GPL"), or
00027  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
00028  * in which case the provisions of the GPL or the LGPL are applicable instead
00029  * of those above. If you wish to allow use of your version of this file only
00030  * under the terms of either the GPL or the LGPL, and not to allow others to
00031  * use your version of this file under the terms of the MPL, indicate your
00032  * decision by deleting the provisions above and replace them with the notice
00033  * and other provisions required by the GPL or the LGPL. If you do not delete
00034  * the provisions above, a recipient may use your version of this file under
00035  * the terms of any one of the MPL, the GPL or the LGPL.
00036  *
00037  * ***** END LICENSE BLOCK ***** */
00038 
00039 #ifndef nsProfileCollector_h_
00040 #define nsProfileCollector_h_
00041 
00042 #include "nsIMetricsCollector.h"
00043 
00044 class nsISupports;
00045 class nsIMetricsEventItem;
00046 class nsIPropertyBag;
00047 #ifndef MOZ_PLACES
00048 class nsIRDFResource;
00049 #endif
00050 
00051 // This file defines the profile collector class, which generates
00052 // a profile event at application startup.  The profile event logs
00053 // various information about the user's software and hardware configuration.
00054 
00055 class nsProfileCollector : public nsIMetricsCollector
00056 {
00057  public:
00058   NS_DECL_ISUPPORTS
00059   NS_DECL_NSIMETRICSCOLLECTOR
00060 
00061   nsProfileCollector();
00062 
00063  private:
00064   class PluginEnumerator;
00065   class ExtensionEnumerator;
00066   class BookmarkCounter;
00067 
00068   ~nsProfileCollector();
00069 
00070   // These methods each create a particular item and append it to the profile.
00071   nsresult LogCPU(nsIMetricsEventItem *profile);
00072   nsresult LogMemory(nsIMetricsEventItem *profile);
00073   nsresult LogOS(nsIMetricsEventItem *profile);
00074   nsresult LogInstall(nsIMetricsEventItem *profile);
00075   nsresult LogExtensions(nsIMetricsEventItem *profile);
00076   nsresult LogPlugins(nsIMetricsEventItem *profile);
00077   nsresult LogDisplay(nsIMetricsEventItem *profile);
00078   nsresult LogBookmarks(nsIMetricsEventItem *profile);
00079 
00080 #ifdef MOZ_PLACES
00081   void LogBookmarkLocation(nsIMetricsEventItem *bookmarksItem,
00082                            const nsACString &location,
00083                            BookmarkCounter *counter,
00084                            PRInt64 root, PRBool deep);
00085 #else
00086   void LogBookmarkLocation(nsIMetricsEventItem *bookmarksItem,
00087                            const nsACString &location,
00088                            BookmarkCounter *counter,
00089                            nsIRDFResource *root, PRBool deep);
00090 #endif
00091 
00092   // Track whether we've logged the profile yet this session.
00093   PRBool mLoggedProfile;
00094 };
00095 
00096 #define NS_PROFILECOLLECTOR_CLASSNAME "Profile Collector"
00097 #define NS_PROFILECOLLECTOR_CID \
00098 { 0x9d5d472d, 0x88c7, 0x4cb2, {0xa6, 0xfb, 0x1f, 0x8e, 0x4d, 0xb5, 0x7e, 0x7e}}
00099 
00100 #endif  // nsProfileCollector_h_