1// Copyright (c) 2011 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// This is a cross platform interface for helper functions related to
6// debuggers.  You should use this to test if you're running under a debugger,
7// and if you would like to yield (breakpoint) into the debugger.
8
9#ifndef BASE_DEBUG_DEBUGGER_H
10#define BASE_DEBUG_DEBUGGER_H
11
12#include "base/base_export.h"
13
14namespace base {
15namespace debug {
16
17// Waits wait_seconds seconds for a debugger to attach to the current process.
18// When silent is false, an exception is thrown when a debugger is detected.
19BASE_EXPORT bool WaitForDebugger(int wait_seconds, bool silent);
20
21// Returns true if the given process is being run under a debugger.
22//
23// On OS X, the underlying mechanism doesn't work when the sandbox is enabled.
24// To get around this, this function caches its value.
25//
26// WARNING: Because of this, on OS X, a call MUST be made to this function
27// BEFORE the sandbox is enabled.
28BASE_EXPORT bool BeingDebugged();
29
30// Break into the debugger, assumes a debugger is present.
31BASE_EXPORT void BreakDebugger();
32
33// Used in test code, this controls whether showing dialogs and breaking into
34// the debugger is suppressed for debug errors, even in debug mode (normally
35// release mode doesn't do this stuff --  this is controlled separately).
36// Normally UI is not suppressed.  This is normally used when running automated
37// tests where we want a crash rather than a dialog or a debugger.
38BASE_EXPORT void SetSuppressDebugUI(bool suppress);
39BASE_EXPORT bool IsDebugUISuppressed();
40
41}  // namespace debug
42}  // namespace base
43
44#endif  // BASE_DEBUG_DEBUGGER_H
45