1 | // |
---|
2 | // Debugger.h |
---|
3 | // |
---|
4 | // $Id: //poco/1.3/Foundation/include/Poco/Debugger.h#1 $ |
---|
5 | // |
---|
6 | // Library: Foundation |
---|
7 | // Package: Core |
---|
8 | // Module: Debugger |
---|
9 | // |
---|
10 | // Definition of the Debugger class. |
---|
11 | // |
---|
12 | // Copyright (c) 2004-2006, Applied Informatics Software Engineering GmbH. |
---|
13 | // and Contributors. |
---|
14 | // |
---|
15 | // Permission is hereby granted, free of charge, to any person or organization |
---|
16 | // obtaining a copy of the software and accompanying documentation covered by |
---|
17 | // this license (the "Software") to use, reproduce, display, distribute, |
---|
18 | // execute, and transmit the Software, and to prepare derivative works of the |
---|
19 | // Software, and to permit third-parties to whom the Software is furnished to |
---|
20 | // do so, all subject to the following: |
---|
21 | // |
---|
22 | // The copyright notices in the Software and this entire statement, including |
---|
23 | // the above license grant, this restriction and the following disclaimer, |
---|
24 | // must be included in all copies of the Software, in whole or in part, and |
---|
25 | // all derivative works of the Software, unless such copies or derivative |
---|
26 | // works are solely in the form of machine-executable object code generated by |
---|
27 | // a source language processor. |
---|
28 | // |
---|
29 | // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
---|
30 | // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
---|
31 | // FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT |
---|
32 | // SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE |
---|
33 | // FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE, |
---|
34 | // ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER |
---|
35 | // DEALINGS IN THE SOFTWARE. |
---|
36 | // |
---|
37 | |
---|
38 | |
---|
39 | #ifndef Foundation_Debugger_INCLUDED |
---|
40 | #define Foundation_Debugger_INCLUDED |
---|
41 | |
---|
42 | |
---|
43 | #include "Poco/Foundation.h" |
---|
44 | |
---|
45 | |
---|
46 | namespace Poco { |
---|
47 | |
---|
48 | |
---|
49 | class Foundation_API Debugger |
---|
50 | /// The Debugger class provides an interface to the debugger. |
---|
51 | /// The presence of a debugger can be checked for, |
---|
52 | /// messages can be written to the debugger's log window |
---|
53 | /// and a break into the debugger can be enforced. |
---|
54 | /// The methods only work if the program is compiled |
---|
55 | /// in debug mode (the macro _DEBUG is defined). |
---|
56 | { |
---|
57 | public: |
---|
58 | static bool isAvailable(); |
---|
59 | /// Returns true if a debugger is available, false otherwise. |
---|
60 | /// On Windows, this function uses the IsDebuggerPresent() |
---|
61 | /// function. |
---|
62 | /// On Unix, this function returns true if the environment |
---|
63 | /// variable POCO_ENABLE_DEBUGGER is set. |
---|
64 | /// On OpenVMS, this function always returns true in debug, |
---|
65 | /// mode, false otherwise. |
---|
66 | |
---|
67 | static void message(const std::string& msg); |
---|
68 | /// Writes a message to the debugger log, if available, otherwise to |
---|
69 | /// standard error output. |
---|
70 | |
---|
71 | static void message(const std::string& msg, const char* file, int line); |
---|
72 | /// Writes a message to the debugger log, if available, otherwise to |
---|
73 | /// standard error output. |
---|
74 | |
---|
75 | static void enter(); |
---|
76 | /// Breaks into the debugger, if it is available. |
---|
77 | /// On Windows, this is done using the DebugBreak() function. |
---|
78 | /// On Unix, the SIGINT signal is raised. |
---|
79 | /// On OpenVMS, the SS$_DEBUG signal is raised. |
---|
80 | |
---|
81 | static void enter(const std::string& msg); |
---|
82 | /// Writes a debug message to the debugger log and breaks into it. |
---|
83 | |
---|
84 | static void enter(const std::string& msg, const char* file, int line); |
---|
85 | /// Writes a debug message to the debugger log and breaks into it. |
---|
86 | |
---|
87 | static void enter(const char* file, int line); |
---|
88 | /// Writes a debug message to the debugger log and breaks into it. |
---|
89 | }; |
---|
90 | |
---|
91 | |
---|
92 | } // namespace Poco |
---|
93 | |
---|
94 | |
---|
95 | #endif // Foundation_Debugger_INCLUDED |
---|