closurelog.h (flens/debug/auxiliary/closurelog.h)

      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
<doc 44
     45
     46
<doc 47
     48
     49
<doc 50
     51
     52
<doc 53
     54
     55
<doc 56
     57
     58
<doc 59
     60
     61
<doc 62
     63
     64
<doc 65
     66
     67
<doc 68
     69
     70
<doc 71
     72
     73
<doc 74
     75
     76
     77
     78
     79
     80
     81
     82
     83
     84
     85
     86
     87
     88
     89

/*
*   Copyright (c) 2010, Michael Lehn
*
*   All rights reserved.
*
*   Redistribution and use in source and binary forms, with or without
*   modification, are permitted provided that the following conditions
*   are met:
*
*   1) Redistributions of source code must retain the above copyright
*      notice, this list of conditions and the following disclaimer.
*   2) Redistributions in binary form must reproduce the above copyright
*      notice, this list of conditions and the following disclaimer in
*      the documentation and/or other materials provided with the
*      distribution.
*   3) Neither the name of the FLENS development group nor the names of
*      its contributors may be used to endorse or promote products derived
*      from this software without specific prior written permission.
*
*   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
*   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
*   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
*   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
*   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
*   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
*   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
*   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
*   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
*   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
*   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/

#ifndef FLENS_DEBUG_AUXILIARY_CLOSURELOG_H
#define FLENS_DEBUG_AUXILIARY_CLOSURELOG_H 1

#include <fstream>
#include <flens/debug/auxiliary/variablepool.h>

namespace flens { namespace verbose {

// forward declaration
class ClosureLogStream;

struct ClosureLog
{
    public:
        static void
        start(const char *filename = "flens.log", bool clearLog = true);

        static void
        stop();

        static void
        separator();

        static bool
        createEntry();

        static bool
        openEntry();

        static bool
        started();

        static void
        closeEntry();

        static void
        setTag(const char *tag);

        static void
        unsetTag();

        static ClosureLogStream &
        append(bool startNewLine = true);

        static VariablePool     variablePool;

    private:
        static bool             _started;
        static int              _indentLevel;
        static std::string      _tag;
        static std::ofstream    _out;
        static ClosureLogStream _closureLogStream;
};

} } // namespace verbose, namespace flens

#endif // FLENS_DEBUG_AUXILIARY_CLOSURELOG_H