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