chrome/common/logging_chrome.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_COMMON_LOGGING_CHROME_H__
   6 #define CHROME_COMMON_LOGGING_CHROME_H__
   7
   8 #include <string>
   9 #include <vector>
  10
  11 #include "base/logging.h"
  12 #include "base/time/time.h"
  13
  14 class CommandLine;
  15
  16 namespace base {
  17 class FilePath;
  18 }
  19
  20 namespace logging {
  21
  22 // Call to initialize logging for Chrome. This sets up the chrome-specific
  23 // logfile naming scheme and might do other things like log modules and
  24 // setting levels in the future.
  25 //
  26 // The main process might want to delete any old log files on startup by
  27 // setting delete_old_log_file, but the renderer processes should not, or
  28 // they will delete each others' logs.
  29 //
  30 // XXX
  31 // Setting suppress_error_dialogs to true disables any dialogs that would
  32 // normally appear for assertions and crashes, and makes any catchable
  33 // errors (namely assertions) available via GetSilencedErrorCount()
  34 // and GetSilencedError().
  35 void InitChromeLogging(const CommandLine& command_line,
  36                        OldFileDeletionState delete_old_log_file);
  37
  38 #if defined(OS_CHROMEOS)
  39 // Get the log file location.
  40 base::FilePath GetSessionLogFile(const CommandLine& command_line);
  41
  42 // Redirects chrome logging to the appropriate session log dir.
  43 void RedirectChromeLogging(const CommandLine& command_line);
  44 #endif
  45
  46 // Call when done using logging for Chrome.
  47 void CleanupChromeLogging();
  48
  49 // Returns the fully-qualified name of the log file.
  50 base::FilePath GetLogFileName();
  51
  52 // Returns true when error/assertion dialogs are to be shown,
  53 // false otherwise.
  54 bool DialogsAreSuppressed();
  55
  56 typedef std::vector<std::wstring> AssertionList;
  57
  58 // Gets the list of fatal assertions in the current log file, and
  59 // returns the number of fatal assertions.  (If you don't care
  60 // about the actual list of assertions, you can pass in NULL.)
  61 // NOTE: Since this reads the log file to determine the assertions,
  62 // this operation is O(n) over the length of the log.
  63 // NOTE: This can fail if the file is locked for writing.  However,
  64 // this is unlikely as this function is most useful after
  65 // the program writing the log has terminated.
  66 size_t GetFatalAssertions(AssertionList* assertions);
  67
  68 // Inserts timestamp before file extension in the format
  69 // "_yymmdd-hhmmss".
  70 base::FilePath GenerateTimestampedName(const base::FilePath& base_path,
  71                                        base::Time timestamp);
  72 }  // namespace logging
  73
  74 #endif  // CHROME_COMMON_LOGGING_CHROME_H_