summaryrefslogtreecommitdiff
path: root/gnuradio-runtime/include/gnuradio/error_handler.h
blob: 2d6a8c388304ad0677a82e100200984207e605a1 (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
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
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
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
/* -*- c++ -*- */
/*
 * Copyright 2005,2013 Free Software Foundation, Inc.
 *
 * This file is part of GNU Radio
 *
 * GNU Radio is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 3, or (at your option)
 * any later version.
 *
 * GNU Radio is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with GNU Radio; see the file COPYING.  If not, write to
 * the Free Software Foundation, Inc., 51 Franklin Street,
 * Boston, MA 02110-1301, USA.
 */
/*
 * This code is based on error.hh from the "Click Modular Router".
 * Original copyright follows:
 */
/*
 * error.{cc,hh} -- flexible classes for error reporting
 * Eddie Kohler
 *
 * Copyright (c) 1999-2000 Massachusetts Institute of Technology
 *
 * Permission is hereby granted, free of charge, to any person obtaining a
 * copy of this software and associated documentation files (the "Software"),
 * to deal in the Software without restriction, subject to the conditions
 * listed in the Click LICENSE file. These conditions include: you must
 * preserve this copyright notice, and you cannot mention the copyright
 * holders in advertising related to the Software without their permission.
 * The Software is provided WITHOUT ANY WARRANTY, EXPRESS OR IMPLIED. This
 * notice is a summary of the Click LICENSE file; the license in that file is
 * legally binding.
 */

#ifndef INCLUDED_GR_ERROR_HANDLER_H
#define INCLUDED_GR_ERROR_HANDLER_H

#include <gnuradio/api.h>
#include <stdarg.h>
#include <string>
#include <cstdio>  // for FILE

namespace gr {

  /*!
   * \brief abstract error handler
   * \ingroup base
   */
  class GR_RUNTIME_API error_handler
  {
  public:
    enum seriousness {
      ERR_DEBUG		= 0x00000000,
      ERR_MESSAGE	= 0x00010000,
      ERR_WARNING	= 0x00020000,
      ERR_ERROR		= 0x00030000,
      ERR_FATAL		= 0x00040000
    };

    error_handler() {}
    virtual ~error_handler();

    static error_handler *default_handler();
    static error_handler *silent_handler();

    static bool has_default_handler();
    static void set_default_handler(error_handler *errh);

    void debug(const char *format, ...);
    void message(const char *format, ...);
    void warning(const char *format, ...);
    void error(const char *format, ...);
    void fatal(const char *format, ...);

    virtual int nwarnings() const = 0;
    virtual int nerrors() const = 0;
    virtual void reset_counts() = 0;

    void verror(seriousness s, const char *format, va_list);
    void verror_text(seriousness s, const std::string &text);

  protected:
    virtual void count_error(seriousness s) = 0;
    virtual void handle_text(seriousness s, const std::string &str) = 0;
    std::string make_text(seriousness s, const char *format, va_list);
  };


  class GR_RUNTIME_API base_error_handler : public error_handler
  {
    int d_nwarnings;
    int d_nerrors;

  public:
    base_error_handler() : d_nwarnings(0), d_nerrors(0) {}
    int nwarnings() const { return d_nwarnings; }
    int nerrors() const   { return d_nerrors; }
    void reset_counts()   { d_nwarnings = d_nerrors = 0; }
    void count_error(seriousness s);
  };

  class GR_RUNTIME_API file_error_handler : public base_error_handler
  {
    FILE *d_file;
    int d_fd;

  public:
    file_error_handler(FILE *file);
    file_error_handler(int file_descriptor);
    ~file_error_handler();

    void handle_text(seriousness s, const std::string &str);
  };

} /* namespace gr */

#endif /* INCLUDED_GR_ERROR_HANDLER_H */