error.h 10.4 KB
Newer Older
1
2
#ifndef _SPEL_ERROR_H_
#define _SPEL_ERROR_H_
3
4
5

#include <string>
#include <iostream>
6
#include <exception>
7
8
9
#include <set>
#include <utility>
#include <sstream>
10
#include <thread>
Damien Leroux's avatar
Damien Leroux committed
11
#include <mutex>
12
#include <condition_variable>
13
#include <vector>
14
#include <deque>
15
16
17
extern "C" {
#include <unistd.h>
}
18
19
20
21
22
23
24

#define _WHITE "\x1b[37;1m"
#define _RED "\x1b[31;1m"
#define _YELLOW "\x1b[33;1m"
#define _CYAN "\x1b[36;1m"
#define _NORMAL "\x1b[0;m"

25
26
#define MSG_HANDLER_IS_SYNCED

27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
enum msg_channel { Out, Err, Log };

struct message_struc {
    msg_channel channel;
    std::string message;
};

typedef std::shared_ptr<message_struc> message_handle;

/*#define MAKE_MESSAGE(_dest_, _expr_) do { std::stringstream __s; __s << _expr_; _dest_ = __s.str(); } while (0)*/
#define MESSAGE(_expr_) dynamic_cast<std::stringstream*>(&(std::stringstream() << _expr_))->str()
/*#define CREATE_MESSAGE(_var_, _channel_, _expr_) message_handle _var_(new message_struc {_channel_, MESSAGE(_expr_)});*/
#define CREATE_MESSAGE(_channel_, _what_) msg_handler_t::enqueue(message_handle{new message_struc {_channel_, _what_}});



struct ostream_manager {
44
45
    /* FIXME indent/dedent must be managed by this very class... Maybe use \x1 for indent and \x2 for dedent... */

46
47
48
49
    /* inspired from http://stackoverflow.com/questions/22042414/c-stream-insert-string-after-newline */
    class HeaderInserter : public std::streambuf {
        std::streambuf* dest;
        bool start_of_line;
50
        int indent;
51
52
53
54
55
56
57
    protected:
        int overflow(int ch) override;

    public:
        HeaderInserter(std::streambuf* dest)
            : dest(dest)
            , start_of_line(true)
58
            , indent(0)
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
        {}
    };

    class ForbidOutput : public std::streambuf {
    protected:
        int overflow(int) override
        {
            /* Direct output is forbidden */
            /*throw std::ios_base::failure("Direct output is forbidden");*/
            abort();
        }
    };

    std::streambuf* old_cout_rdbuf;
    std::streambuf* old_clog_rdbuf;
    std::streambuf* old_cerr_rdbuf;
    HeaderInserter hi;
    ForbidOutput forbid;
    std::ostream cerr, cout, clog;

    ostream_manager()
        : old_cout_rdbuf(std::cout.rdbuf())
        , old_clog_rdbuf(std::clog.rdbuf())
        , old_cerr_rdbuf(std::cerr.rdbuf())
        , hi(old_cout_rdbuf)
        , forbid()
        , cerr(old_cerr_rdbuf), cout(old_cout_rdbuf), clog(&hi)
    {
        std::clog.rdbuf(&forbid);
        std::cout.rdbuf(&forbid);
        std::cerr.rdbuf(&forbid);
    }

    ~ostream_manager()
    {
        std::clog.rdbuf(old_clog_rdbuf);
        std::cout.rdbuf(old_cout_rdbuf);
        std::cerr.rdbuf(old_cerr_rdbuf);
    }
};

struct message_queue : public ostream_manager {
    typedef std::mutex mutex_type;
    typedef std::unique_lock<mutex_type> scoped_lock_type;

    std::deque<message_handle> m_queue;
    mutex_type m_mutex;
106
    mutex_type m_stream_mutex;
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
    std::condition_variable m_condition;

    bool m_stop;

    std::thread m_thread;

    message_queue()
        : ostream_manager()
        , m_queue()
        , m_mutex()
        , m_condition()
        , m_stop(false)
        , m_thread([this] () { run(); })
    {
    }

    ~message_queue()
    {
        {
            scoped_lock_type lock(m_mutex);
            m_stop = true;
        }
        m_condition.notify_one();
        m_thread.join();
    }

    void enqueue(const message_handle& mh)
    {
        scoped_lock_type slt(m_mutex);
        m_queue.push_back(mh);
        m_condition.notify_one();
    }

140
141
    void lock_stream() { m_stream_mutex.lock(); }
    void unlock_stream() { m_stream_mutex.unlock(); }
142

143
    void run();
144
145
146
};


147
struct msg_handler_t {
148
#ifdef MSG_HANDLER_IS_SYNCED
149
150
    typedef std::recursive_mutex lock_type;
    typedef std::unique_lock<lock_type> scoped_lock_type;
151
152
153
154
155
156
157
158
159
#else
    typedef struct {
        void lock() {}
        void unlock() {}
    } lock_type;
    typedef struct _slt {
        _slt(lock_type&) {}
    } scoped_lock_type;
#endif
160

161
162
163
164
    struct state_t {
        bool color;
        std::set<std::string> workarounds;
        int count;
165
        int debug_indent;
166
        std::vector<std::function<void()>> hooks;
167
        message_queue queue;
168
169
170
171
172
173

        const char* error() { ++count; return color ? _RED : ""; }
        const char* warning() { return color ? _YELLOW : ""; }
        const char* info() { return color ? _CYAN : ""; }
        const char* normal() { return color ? _NORMAL : ""; }

174
175
        state_t()
            : color(!!isatty(fileno(stdout))), workarounds(), count(0), debug_indent(0), hooks()
176
            , queue()
177
        {
178
            /*std::cout << "Message handler instance created." << std::endl;*/
179
        }
180
181
		~state_t()
        {}
182
183
        void check(bool fatal);
        void reset();
184
        void run_hooks() { for (auto& f: hooks) { f(); } }
185
186
187
188
189
190
191
192
193
194
195
196
197
198
    };

    static state_t& instance() { static state_t _; return _; }

    static void set_color(bool _) { instance().color = _; }
    static bool color() { return instance().color; }

    static const char* e() { return instance().error(); }
    static const char* w() { return instance().warning(); }
    static const char* i() { return instance().info(); }
    static const char* n() { return instance().normal(); }

    static void check(bool fatal) { instance().check(fatal); }
    static void reset() { instance().reset(); }
199

200
201
202
    static void hook(std::function<void()>&& f) { instance().hooks.push_back(f); }
    static void run_hooks() { instance().run_hooks(); }

203
204
205
206
    static void indent() { instance().debug_indent += 3; }
    static void dedent() { instance().debug_indent -= 3; }
    static int get_indent() { return instance().debug_indent; }

207
208
    static void enqueue(const message_handle& mh) { instance().queue.enqueue(mh); }

209
    static lock_type mutex;
210
211
};

212
213
214
215
inline
int ostream_manager::HeaderInserter::overflow(int ch)
{
    int retval = 0;
216
217
218
219
220
    if (ch == 1) {
        indent += 3;
    } else if (ch == 2) {
        indent -= 3 * (indent > 0);
    } else if (ch != traits_type::eof()) {
221
        if (start_of_line) {
222
            for (int i = 0; i < indent; ++i) {
223
224
225
226
227
228
229
230
231
                dest->sputc(' ');
            }
        }
        retval = dest->sputc( ch );
        start_of_line = ch == '\n';
    }
    return retval;
}

232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
inline
void message_queue::run()
{
    while (true)
    {
        scoped_lock_type lock(m_mutex);

        while (!m_stop && m_queue.empty()) {
            m_condition.wait(lock);
        }

        if (m_stop && m_queue.empty()) {
            return;
        }

        message_handle next = m_queue.front();
        m_queue.pop_front();

        std::ostream& channel = next->channel == msg_channel::Out ? cout
                              : next->channel == msg_channel::Log ? clog
                              : cerr;

        lock.unlock();
        if (next->message.size() == 0) {
            continue;
        }
        lock_stream();
        channel << next->message << std::flush;
        unlock_stream();
        msg_handler_t::run_hooks();
    }
}

265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
#define MSG_ERROR(_msg_expr_, _workaround_expr_) \
    do {\
        CREATE_MESSAGE(msg_channel::Err, MESSAGE(msg_handler_t::e() << "[ERR] " << _msg_expr_ << msg_handler_t::n() << std::endl));\
        std::stringstream s; s << _workaround_expr_;\
        if (s.str().size()) { msg_handler_t::instance().workarounds.insert(s.str()); }\
} while (0)

#define MSG_WARNING(_msg_expr_) \
    do {\
        CREATE_MESSAGE(msg_channel::Out, MESSAGE(msg_handler_t::w() << "[WRN] " << _msg_expr_ << msg_handler_t::n() << std::endl));\
} while (0)

#define MSG_INFO(_msg_expr_) \
    do {\
        CREATE_MESSAGE(msg_channel::Out, MESSAGE(msg_handler_t::i() << "[MSG] " << _msg_expr_ << msg_handler_t::n() << std::endl));\
} while (0)

#define MSG_DEBUG(_msg_expr_) \
    do {\
        CREATE_MESSAGE(msg_channel::Log, MESSAGE(_msg_expr_ << std::endl));\
} while (0)
286

287
#if 0
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
#define MSG_ERROR(_msg_expr_, _workaround_expr_) \
    do {\
        {msg_handler_t::scoped_lock_type _(msg_handler_t::mutex);\
        std::cerr << msg_handler_t::e() << "[ERR] " << _msg_expr_ << msg_handler_t::n() << std::endl;}\
        std::stringstream s; s << _workaround_expr_;\
        if (s.str().size()) { msg_handler_t::instance().workarounds.insert(s.str()); }\
        msg_handler_t::run_hooks();\
} while (0)

#define MSG_WARNING(_msg_expr_) \
    do {\
        msg_handler_t::scoped_lock_type _(msg_handler_t::mutex);\
        std::cerr << msg_handler_t::w() << "[WRN] " << _msg_expr_ << msg_handler_t::n() << std::endl;\
        msg_handler_t::run_hooks();\
    } while(0)

#define MSG_INFO(_msg_expr_) \
    do {\
        msg_handler_t::scoped_lock_type _(msg_handler_t::mutex);\
        std::cout << msg_handler_t::i() << "[MSG] " << _msg_expr_ << msg_handler_t::n() << std::endl;\
        msg_handler_t::run_hooks();\
    } while(0)

#define MSG_DEBUG(_msg_expr_) \
    do {\
        msg_handler_t::scoped_lock_type _(msg_handler_t::mutex);\
314
        std::clog << _msg_expr_ << std::endl;\
315
316
        msg_handler_t::run_hooks();\
    } while(0)
317
#endif
318

319
320
#define MSG_DEBUG_INDENT CREATE_MESSAGE(msg_channel::Log, "\x1")
#define MSG_DEBUG_DEDENT CREATE_MESSAGE(msg_channel::Log, "\x2")
321
322
323

inline void msg_handler_t::state_t::check(bool fatal)
{
324
    msg_handler_t::scoped_lock_type _(msg_handler_t::mutex);
325
    if (count > 0) {
326
327
328
329
        CREATE_MESSAGE(msg_channel::Err, MESSAGE(
                info() << "[MSG] " << count << " error"
                << (count > 1 ? "s were" : " was")
                << " reported. Suggestions to fix this:" << std::endl));
330
        for (auto& w: workarounds) {
331
            CREATE_MESSAGE(msg_channel::Err, MESSAGE(info() << "      - " << w << normal() << std::endl));
332
333
        }
        if (fatal) {
334
            CREATE_MESSAGE(msg_channel::Out, MESSAGE(normal() <<"At least one fatal error encountered. Aborting process." << std::endl));
335
336
337
338
339
340
341
342
343
344
            exit(-count);
        } else {
            reset();
        }
    }
}

inline void msg_handler_t::state_t::reset()
{
    if (workarounds.size()) {
345
        MSG_WARNING(workarounds.size() << " workarounds silently discarded");
346
347
348
349
350
351
352
353
354
355
356
    }
    count = 0;
    workarounds.clear();
}

#define WHITE (msg_handler_t::instance().color ? _WHITE : "")
#define YELLOW (msg_handler_t::instance().color ? _YELLOW : "")
#define RED (msg_handler_t::instance().color ? _RED : "")
#define CYAN (msg_handler_t::instance().color ? _CYAN : "")
#define NORMAL (msg_handler_t::instance().color ? _NORMAL : "")

357
358
359
360
361
362
#ifdef NDEBUG
#define DUMP_FILE_LINE()
#else
#define DUMP_FILE_LINE() MSG_DEBUG(__FILE__ << ':' << __LINE__)
#endif

363
364
#endif