error.h 12.2 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
extern "C" {
#include <unistd.h>
Damien Leroux's avatar
WIP.    
Damien Leroux committed
17
#include <sys/ioctl.h>
18
}
19
20
21

#define _WHITE "\x1b[37;1m"
#define _RED "\x1b[31;1m"
Damien Leroux's avatar
WIP.    
Damien Leroux committed
22
#define _GREEN "\x1b[32;1m"
23
24
25
26
#define _YELLOW "\x1b[33;1m"
#define _CYAN "\x1b[36;1m"
#define _NORMAL "\x1b[0;m"

27
28
#define MSG_HANDLER_IS_SYNCED

29
30
31
32
33
34
35
36
37
38
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)*/
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56

static inline std::string __fetch_string(const std::ostream& os)
{
    return dynamic_cast<const std::stringstream*>(&os)->str();
}


static inline
std::ostream& operator << (std::ostream& os, const std::vector<double>& v)
{
    std::string sep = "";
    for (auto x: v) { os << sep << x; sep = " "; }
    return os;
}



#define MESSAGE(_expr_) __fetch_string(std::stringstream() << _expr_)
57
/*#define CREATE_MESSAGE(_var_, _channel_, _expr_) message_handle _var_(new message_struc {_channel_, MESSAGE(_expr_)});*/
Damien Leroux's avatar
Damien Leroux committed
58
59

#ifndef SPELL_UNSAFE_OUTPUT
60
#define CREATE_MESSAGE(_channel_, _what_) msg_handler_t::enqueue(message_handle{new message_struc {_channel_, _what_}});
Damien Leroux's avatar
Damien Leroux committed
61
62
63
64
65
66
67
68
69
70
71
72
73
#else
#define CREATE_MESSAGE(_channel_, _what_) switch(_channel_) { \
        case msg_channel::Out: \
            std::cout << _what_; \
            break; \
        case msg_channel::Err: \
            std::cerr << _what_; \
            break; \
        case msg_channel::Log: \
            std::clog << _what_; \
            break; \
    };
#endif
74
75


76
77
78
79
80
81
struct DirectOutputIsForbidden : public std::runtime_error {
    DirectOutputIsForbidden()
        : std::runtime_error("Direct output to std::cerr, cour, or clog is forbidden. Use CREATE_MESSAGE(channel, MESSAGE(expression)) instead.")
    {}
};

82
83

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

86
87
88
89
    /* 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;
90
        int indent;
91
92
93
94
95
96
97
    protected:
        int overflow(int ch) override;

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

    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)
    {
127
#ifndef SPELL_UNSAFE_OUTPUT
128
129
130
        std::clog.rdbuf(&forbid);
        std::cout.rdbuf(&forbid);
        std::cerr.rdbuf(&forbid);
131
#endif
132
133
134
135
    }

    ~ostream_manager()
    {
136
#ifndef SPELL_UNSAFE_OUTPUT
137
138
139
        std::clog.rdbuf(old_clog_rdbuf);
        std::cout.rdbuf(old_cout_rdbuf);
        std::cerr.rdbuf(old_cerr_rdbuf);
140
#endif
141
142
143
144
145
146
147
148
149
    }
};

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;
150
    mutex_type m_stream_mutex;
151
    std::condition_variable m_condition;
Damien Leroux's avatar
Damien Leroux committed
152
    std::condition_variable m_flush_condition;
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184

    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();
    }

185
186
    void lock_stream() { m_stream_mutex.lock(); }
    void unlock_stream() { m_stream_mutex.unlock(); }
187

188
    void run();
Damien Leroux's avatar
Damien Leroux committed
189
190
191
192
193
194
195
196
197

    void wait_for_flush()
    {
        scoped_lock_type lock(m_mutex);
        while (!m_queue.empty()) {
            m_flush_condition.wait(lock);
        }

    }
198
199
200
};


201
struct msg_handler_t {
202
#ifdef MSG_HANDLER_IS_SYNCED
203
204
    typedef std::recursive_mutex lock_type;
    typedef std::unique_lock<lock_type> scoped_lock_type;
205
206
207
208
209
210
211
212
213
#else
    typedef struct {
        void lock() {}
        void unlock() {}
    } lock_type;
    typedef struct _slt {
        _slt(lock_type&) {}
    } scoped_lock_type;
#endif
214

215
216
217
218
    struct state_t {
        bool color;
        std::set<std::string> workarounds;
        int count;
219
        int debug_indent;
220
        std::vector<std::function<void()>> hooks;
221
        message_queue queue;
222
223
224
225
226
227

        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 : ""; }

228
229
        state_t()
            : color(!!isatty(fileno(stdout))), workarounds(), count(0), debug_indent(0), hooks()
230
            , queue()
231
        {
232
            /*std::cout << "Message handler instance created." << std::endl;*/
233
        }
234
235
		~state_t()
        {}
236
237
        void check(bool fatal);
        void reset();
238
        void run_hooks() { for (auto& f: hooks) { f(); } }
239
240
241
242
243
244
245
246
247
248
249
250
251
252
    };

    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(); }
253

254
255
256
    static void hook(std::function<void()>&& f) { instance().hooks.push_back(f); }
    static void run_hooks() { instance().run_hooks(); }

257
258
259
260
    static void indent() { instance().debug_indent += 3; }
    static void dedent() { instance().debug_indent -= 3; }
    static int get_indent() { return instance().debug_indent; }

261
    static void enqueue(const message_handle& mh) { instance().queue.enqueue(mh); }
Damien Leroux's avatar
Damien Leroux committed
262
    static void wait_for_flush() { instance().queue.wait_for_flush(); }
263

Damien Leroux's avatar
WIP.    
Damien Leroux committed
264
265
266
267
268
269
270
    static int termcols()
    {
        struct winsize w;
        ioctl(0, TIOCGWINSZ, &w);
        return w.ws_col;
    }

271
    static lock_type mutex;
272
273
};

274
275
276
277
inline
int ostream_manager::HeaderInserter::overflow(int ch)
{
    int retval = 0;
278
279
280
281
282
    if (ch == 1) {
        indent += 3;
    } else if (ch == 2) {
        indent -= 3 * (indent > 0);
    } else if (ch != traits_type::eof()) {
283
        if (start_of_line) {
284
            for (int i = 0; i < indent; ++i) {
285
286
287
288
289
290
291
292
293
                dest->sputc(' ');
            }
        }
        retval = dest->sputc( ch );
        start_of_line = ch == '\n';
    }
    return retval;
}

294
295
296
inline
void message_queue::run()
{
Damien Leroux's avatar
Damien Leroux committed
297
    message_handle  next;
298
299
    while (true)
    {
Damien Leroux's avatar
Damien Leroux committed
300
301
        {
            scoped_lock_type lock(m_mutex);
302

Damien Leroux's avatar
Damien Leroux committed
303
            m_condition.wait(lock, [this]() { return m_stop || !m_queue.empty(); });
304

Damien Leroux's avatar
Damien Leroux committed
305
306
307
            /*while (!m_stop && m_queue.empty()) {*/
                /*m_condition.wait(lock);*/
            /*}*/
308

Damien Leroux's avatar
Damien Leroux committed
309
310
311
            if (m_stop && m_queue.empty()) {
                return;
            }
312

Damien Leroux's avatar
Damien Leroux committed
313
314
            next = m_queue.front();
            m_queue.pop_front();
315

Damien Leroux's avatar
Damien Leroux committed
316
317
318
319
320
        }
        if (next->message == "\x3") {
            m_flush_condition.notify_one();
            continue;
        } else if (next->message.size() == 0) {
321
322
            continue;
        }
Damien Leroux's avatar
Damien Leroux committed
323
324
325
        std::ostream& channel = next->channel == msg_channel::Out ? cout
                              : next->channel == msg_channel::Log ? clog
                              : cerr;
326
327
328
329
330
331
332
        lock_stream();
        channel << next->message << std::flush;
        unlock_stream();
        msg_handler_t::run_hooks();
    }
}

333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
#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)
354

Damien Leroux's avatar
Damien Leroux committed
355
356
357
358
359
#define MSG_QUEUE_FLUSH() do { \
    CREATE_MESSAGE(msg_channel::Log, "\x3"); \
    msg_handler_t::wait_for_flush(); \
} while (0)

360
#if 0
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
#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);\
387
        std::clog << _msg_expr_ << std::endl;\
388
389
        msg_handler_t::run_hooks();\
    } while(0)
390
#endif
391

392
393
#define MSG_DEBUG_INDENT CREATE_MESSAGE(msg_channel::Log, "\x1")
#define MSG_DEBUG_DEDENT CREATE_MESSAGE(msg_channel::Log, "\x2")
394

395
396
struct scoped_indent { scoped_indent() { MSG_DEBUG_INDENT; } ~scoped_indent() { MSG_DEBUG_DEDENT; } };

397
398
inline void msg_handler_t::state_t::check(bool fatal)
{
399
    msg_handler_t::scoped_lock_type _(msg_handler_t::mutex);
400
    if (count > 0) {
401
402
403
404
        CREATE_MESSAGE(msg_channel::Err, MESSAGE(
                info() << "[MSG] " << count << " error"
                << (count > 1 ? "s were" : " was")
                << " reported. Suggestions to fix this:" << std::endl));
405
        for (auto& w: workarounds) {
406
            CREATE_MESSAGE(msg_channel::Err, MESSAGE(info() << "      - " << w << normal() << std::endl));
407
408
        }
        if (fatal) {
409
            CREATE_MESSAGE(msg_channel::Out, MESSAGE(normal() <<"At least one fatal error encountered. Aborting process." << std::endl));
410
411
412
413
414
415
416
417
418
419
            exit(-count);
        } else {
            reset();
        }
    }
}

inline void msg_handler_t::state_t::reset()
{
    if (workarounds.size()) {
420
        MSG_WARNING(workarounds.size() << " workarounds silently discarded");
421
422
423
424
425
426
427
428
429
430
431
    }
    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 : "")

432
433
434
435
436
437
#ifdef NDEBUG
#define DUMP_FILE_LINE()
#else
#define DUMP_FILE_LINE() MSG_DEBUG(__FILE__ << ':' << __LINE__)
#endif

438
439
#endif