File: sbuild-log.h

package info (click to toggle)
schroot 1.6.4-4
  • links: PTS, VCS
  • area: main
  • in suites: wheezy
  • size: 6,684 kB
  • sloc: cpp: 21,427; sh: 12,516; makefile: 829; ansic: 231; sed: 16
file content (145 lines) | stat: -rw-r--r-- 3,105 bytes parent folder | download | duplicates (6)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
/* Copyright © 2005-2007  Roger Leigh <rleigh@debian.org>
 *
 * schroot is free software: you can redistribute it and/or modify it
 * under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * schroot is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see
 * <http://www.gnu.org/licenses/>.
 *
 *********************************************************************/

#ifndef SBUILD_LOG_H
#define SBUILD_LOG_H

#include <ostream>

namespace sbuild
{

  /// Debugging level.
  enum debug_level
    {
      DEBUG_NONE = -1,   ///< No debugging.
      DEBUG_NOTICE = 1,  ///< Notification messages.
      DEBUG_INFO = 2,    ///< Informational messages.
      DEBUG_WARNING = 3, ///< Warning messages.
      DEBUG_CRITICAL = 4 ///< Critical messages.
    };

  /**
   * Log an informational message.
   *
   * @returns an ostream.
   */
  std::ostream&
  log_info ();

  /**
   * Log a warning message.
   *
   * @returns an ostream.
   */
  std::ostream&
  log_warning ();

  /**
   * Log an error message.
   *
   * @returns an ostream.
   */
  std::ostream&
  log_error ();

  /**
   * Log a debug message.
   *
   * @param level the debug level of the message being logged.
   * @returns an ostream.  This will be a valid stream if level is
   * greater or equal to debug_level, or else a null stream will be
   * returned, resulting in no output.
   */
  std::ostream&
  log_debug (debug_level level);

  /**
   * Log an informational message to the Controlling TTY.
   *
   * @returns an ostream.
   */
  std::ostream&
  log_ctty_info ();

  /**
   * Log a warning message to the Controlling TTY.
   *
   * @returns an ostream.
   */
  std::ostream&
  log_ctty_warning ();

  /**
   * Log an error message to the Controlling TTY.
   *
   * @returns an ostream.
   */
  std::ostream&
  log_ctty_error ();

  /**
   * Log an exception as a warning.
   *
   * @param e the exception to log.
   */
  void
  log_exception_warning (std::exception const& e);

  /**
   * Log an exception as an error.
   *
   * @param e the exception to log.
   */
  void
  log_exception_error (std::exception const& e);

  /**
   * Log an exception as a warning to the Controlling TTY.
   *
   * @param e the exception to log.
   */
  void
  log_ctty_exception_warning (std::exception const& e);

  /**
   * Log an exception as an error to the Controlling TTY.
   *
   * @param e the exception to log.
   */
  void
  log_ctty_exception_error (std::exception const& e);

  /**
   * Log an unknown exception as an error.
   */
  void
  log_unknown_exception_error ();

  /// The debugging level in use.
  extern debug_level debug_log_level;

}

#endif /* SBUILD_LOG_H */

/*
 * Local Variables:
 * mode:C++
 * End:
 */