1 /*
 2  *   Copyright (c) 2010, Michael Lehn
 3  *
 4  *   All rights reserved.
 5  *
 6  *   Redistribution and use in source and binary forms, with or without
 7  *   modification, are permitted provided that the following conditions
 8  *   are met:
 9  *
10  *   1) Redistributions of source code must retain the above copyright
11  *      notice, this list of conditions and the following disclaimer.
12  *   2) Redistributions in binary form must reproduce the above copyright
13  *      notice, this list of conditions and the following disclaimer in
14  *      the documentation and/or other materials provided with the
15  *      distribution.
16  *   3) Neither the name of the FLENS development group nor the names of
17  *      its contributors may be used to endorse or promote products derived
18  *      from this software without specific prior written permission.
19  *
20  *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21  *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22  *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
23  *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
24  *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
25  *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
26  *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
27  *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
28  *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
29  *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
30  *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31  */
32 
33 #ifndef FLENS_DEBUG_AUX_CLOSURELOG_H
34 #define FLENS_DEBUG_AUX_CLOSURELOG_H 1
35 
36 #include <fstream>
37 #include <flens/debug/aux/variablepool.h>
38 
39 namespace flens { namespace verbose {
40 
41 // forward declaration
42 class ClosureLogStream;
43 
44 struct ClosureLog
45 {
46     public:
47         static void
48         start(const char *filename = "flens.log"bool clearLog = true);
49 
50         static void
51         stop();
52 
53         static void
54         separator();
55 
56         static bool
57         createEntry();
58 
59         static bool
60         openEntry();
61 
62         static bool
63         started();
64 
65         static void
66         closeEntry();
67 
68         static void
69         setTag(const char *tag);
70 
71         static void
72         unsetTag();
73 
74         static ClosureLogStream &
75         append(bool startNewLine = true);
76 
77         static VariablePool     variablePool;
78 
79     private:
80         static bool             _started;
81         static int              _indentLevel;
82         static std::string      _tag;
83         static std::ofstream    _out;
84         static ClosureLogStream _closureLogStream;
85 };
86 
87 } } // namespace verbose, namespace flens
88 
89 #endif // FLENS_DEBUG_AUX_CLOSURELOG_H