src/chrome/browser/chrome_browser_main.h

   1 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 #ifndef CHROME_BROWSER_CHROME_BROWSER_MAIN_H_
   6 #define CHROME_BROWSER_CHROME_BROWSER_MAIN_H_
   7
   8 #include "base/basictypes.h"
   9 #include "base/memory/scoped_ptr.h"
  10 #include "base/metrics/field_trial.h"
  11 #include "base/tracked_objects.h"
  12 #include "chrome/browser/chrome_browser_field_trials.h"
  13 #include "chrome/browser/chrome_process_singleton.h"
  14 #include "chrome/browser/first_run/first_run.h"
  15 #include "chrome/browser/process_singleton.h"
  16 #include "chrome/browser/task_profiler/auto_tracking.h"
  17 #include "chrome/browser/ui/startup/startup_browser_creator.h"
  18 #include "content/public/browser/browser_main_parts.h"
  19 #include "content/public/common/main_function_params.h"
  20
  21 class ActiveTabTracker;
  22 class BrowserProcessImpl;
  23 class ChromeBrowserMainExtraParts;
  24 class FieldTrialSynchronizer;
  25 class MetricsService;
  26 class PrefService;
  27 class Profile;
  28 class StartupBrowserCreator;
  29 class StartupTimeBomb;
  30 class ShutdownWatcherHelper;
  31 class ThreeDAPIObserver;
  32 class TranslateManager;
  33
  34 namespace chrome_browser {
  35 // For use by ShowMissingLocaleMessageBox.
  36 extern const char kMissingLocaleDataTitle[];
  37 extern const char kMissingLocaleDataMessage[];
  38 }
  39
  40 namespace chrome_browser_metrics {
  41 class TrackingSynchronizer;
  42 }
  43
  44 namespace performance_monitor {
  45 class StartupTimer;
  46 }
  47
  48 class ChromeBrowserMainParts : public content::BrowserMainParts {
  49  public:
  50   virtual ~ChromeBrowserMainParts();
  51
  52   // Add additional ChromeBrowserMainExtraParts.
  53   virtual void AddParts(ChromeBrowserMainExtraParts* parts);
  54
  55  protected:
  56   explicit ChromeBrowserMainParts(
  57       const content::MainFunctionParams& parameters);
  58
  59   // content::BrowserMainParts overrides.
  60   // These are called in-order by content::BrowserMainLoop.
  61   // Each stage calls the same stages in any ChromeBrowserMainExtraParts added
  62   // with AddParts() from ChromeContentBrowserClient::CreateBrowserMainParts.
  63   virtual void PreEarlyInitialization() OVERRIDE;
  64   virtual void PostEarlyInitialization() OVERRIDE;
  65   virtual void ToolkitInitialized() OVERRIDE;
  66   virtual void PreMainMessageLoopStart() OVERRIDE;
  67   virtual void PostMainMessageLoopStart() OVERRIDE;
  68   virtual int PreCreateThreads() OVERRIDE;
  69   virtual void PreMainMessageLoopRun() OVERRIDE;
  70   virtual bool MainMessageLoopRun(int* result_code) OVERRIDE;
  71   virtual void PostMainMessageLoopRun() OVERRIDE;
  72   virtual void PostDestroyThreads() OVERRIDE;
  73
  74   // Additional stages for ChromeBrowserMainExtraParts. These stages are called
  75   // in order from PreMainMessageLoopRun(). See implementation for details.
  76   virtual void PreProfileInit();
  77   virtual void PostProfileInit();
  78   virtual void PreBrowserStart();
  79   virtual void PostBrowserStart();
  80
  81   // Override this in subclasses to initialize platform specific field trials.
  82   virtual void SetupPlatformFieldTrials();
  83
  84   // Displays a warning message that we can't find any locale data files.
  85   virtual void ShowMissingLocaleMessageBox() = 0;
  86
  87   const content::MainFunctionParams& parameters() const {
  88     return parameters_;
  89   }
  90   const CommandLine& parsed_command_line() const {
  91     return parsed_command_line_;
  92   }
  93
  94   Profile* profile() { return profile_; }
  95
  96   const PrefService* local_state() const { return local_state_; }
  97
  98  private:
  99   // Methods for |SetupMetricsAndFieldTrials()| --------------------------------
 100
 101   // Constructs metrics service and does related initialization, including
 102   // creation of field trials. Call only after labs have been converted to
 103   // switches.
 104   void SetupMetricsAndFieldTrials();
 105
 106   // Starts recording of metrics. This can only be called after we have a file
 107   // thread.
 108   void StartMetricsRecording();
 109
 110   // Returns true if the user opted in to sending metric reports.
 111   bool IsMetricsReportingEnabled();
 112
 113   // Record time from process startup to present time in an UMA histogram.
 114   void RecordBrowserStartupTime();
 115
 116   // Records a time value to an UMA histogram in the context of the
 117   // PreReadExperiment field-trial. This also reports to the appropriate
 118   // sub-histogram (_PreRead(Enabled|Disabled)).
 119   void RecordPreReadExperimentTime(const char* name, base::TimeDelta time);
 120
 121   // Methods for Main Message Loop -------------------------------------------
 122
 123   int PreCreateThreadsImpl();
 124   int PreMainMessageLoopRunImpl();
 125
 126   // Members initialized on construction ---------------------------------------
 127
 128   const content::MainFunctionParams parameters_;
 129   const CommandLine& parsed_command_line_;
 130   int result_code_;
 131
 132   // Create StartupTimeBomb object for watching jank during startup.
 133   scoped_ptr<StartupTimeBomb> startup_watcher_;
 134
 135   // Create ShutdownWatcherHelper object for watching jank during shutdown.
 136   // Please keep |shutdown_watcher| as the first object constructed, and hence
 137   // it is destroyed last.
 138   scoped_ptr<ShutdownWatcherHelper> shutdown_watcher_;
 139
 140   // A timer to hold data regarding startup and session restore times for
 141   // PerformanceMonitor so that we don't have to start the entire
 142   // PerformanceMonitor at browser startup.
 143   scoped_ptr<performance_monitor::StartupTimer> startup_timer_;
 144
 145   // Creating this object starts tracking the creation and deletion of Task
 146   // instance. This MUST be done before main_message_loop, so that it is
 147   // destroyed after the main_message_loop.
 148   task_profiler::AutoTracking tracking_objects_;
 149
 150   // Statistical testing infrastructure for the entire browser. NULL until
 151   // SetupMetricsAndFieldTrials is called.
 152   scoped_ptr<base::FieldTrialList> field_trial_list_;
 153
 154   ChromeBrowserFieldTrials browser_field_trials_;
 155
 156   // Vector of additional ChromeBrowserMainExtraParts.
 157   // Parts are deleted in the inverse order they are added.
 158   std::vector<ChromeBrowserMainExtraParts*> chrome_extra_parts_;
 159
 160   // Members initialized after / released before main_message_loop_ ------------
 161
 162   scoped_ptr<BrowserProcessImpl> browser_process_;
 163   scoped_refptr<chrome_browser_metrics::TrackingSynchronizer>
 164       tracking_synchronizer_;
 165 #if !defined(OS_ANDROID)
 166   // Browser creation happens on the Java side in Android.
 167   scoped_ptr<StartupBrowserCreator> browser_creator_;
 168
 169   // Android doesn't support multiple browser processes, so it doesn't implement
 170   // ProcessSingleton.
 171   scoped_ptr<ChromeProcessSingleton> process_singleton_;
 172
 173   // Android's first run is done in Java instead of native.
 174   scoped_ptr<first_run::MasterPrefs> master_prefs_;
 175 #endif
 176   TranslateManager* translate_manager_;
 177   Profile* profile_;
 178   bool run_message_loop_;
 179   ProcessSingleton::NotifyResult notify_result_;
 180   scoped_ptr<ThreeDAPIObserver> three_d_observer_;
 181
 182   // Initialized in SetupMetricsAndFieldTrials.
 183   scoped_refptr<FieldTrialSynchronizer> field_trial_synchronizer_;
 184
 185   // Members initialized in PreMainMessageLoopRun, needed in
 186   // PreMainMessageLoopRunThreadsCreated.
 187   PrefService* local_state_;
 188   base::FilePath user_data_dir_;
 189
 190 #if !defined(OS_ANDROID)
 191   scoped_ptr<ActiveTabTracker> active_tab_tracker_;
 192 #endif
 193
 194   // Members needed across shutdown methods.
 195   bool restart_last_session_;
 196
 197   // Tests can set this to true to disable restricting cookie access in the
 198   // network stack, as this can only be done once.
 199   static bool disable_enforcing_cookie_policies_for_tests_;
 200
 201   DISALLOW_COPY_AND_ASSIGN(ChromeBrowserMainParts);
 202 };
 203
 204 #endif  // CHROME_BROWSER_CHROME_BROWSER_MAIN_H_