summaryrefslogtreecommitdiff
path: root/dviware/dvi2bitmap/verbosity.h
blob: f398d1b8c955824e422b96f2a8a7a8f82f149a40 (plain)
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
/* This file is part of dvi2bitmap; see README for copyrights and licence */

#ifndef VERBOSITY_HEADER_READ
#define VERBOSITY_HEADER_READ 1

/**
 * Expresses a verbosity level.  Several classes report a different
 * level of detail depending on the value of some internal verbosity
 * variable, usually set with a function such as {@link
 * DviFile#verbosity}.
 *
 * <p>The initial value of this is always <code>normal</code>.  The
 * value <code>everything</code> is the highest level (but not
 * <em>necessarily</em> higher than <code>debug</code>; the value
 * <code>silent</code> causes the class to produce no output at all.
 *
 * <p>The values are ordered, so that 
 * <pre>
 *   enum verbosities verbosity_;
 *   ...
 *   if (verbosity_ > normal) {
 *     // chatter
 *   }
 * </pre>
 * is a good way of testing whether the verbosity level is above normal.
 */
enum verbosities { silent, quiet, normal, debug, everything };
// leave `everything' as the last in this enum

#endif