File: errortypes.h

package info (click to toggle)
cppcheck 2.17.1-2
  • links: PTS, VCS
  • area: main
  • in suites: sid, trixie
  • size: 25,384 kB
  • sloc: cpp: 263,341; python: 19,737; ansic: 7,953; sh: 1,018; makefile: 996; xml: 994; cs: 291
file content (135 lines) | stat: -rw-r--r-- 4,146 bytes parent folder | download
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
126
127
128
129
130
131
132
133
134
135
/* -*- C++ -*-
 * Cppcheck - A tool for static C/C++ code analysis
 * Copyright (C) 2007-2024 Cppcheck team.
 *
 * This program 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 of the License, or
 * (at your option) any later version.
 *
 * This program 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 this program.  If not, see <http://www.gnu.org/licenses/>.
 */

//---------------------------------------------------------------------------
#ifndef errortypesH
#define errortypesH
//---------------------------------------------------------------------------

#include "config.h"

#include <cstdint>
#include <stdexcept>
#include <list>
#include <string>
#include <utility>

/// @addtogroup Core
/// @{
class Token;

/** @brief Simple container to be thrown when internal error is detected. */
struct CPPCHECKLIB InternalError {
    enum Type : std::uint8_t {AST, SYNTAX, UNKNOWN_MACRO, INTERNAL, LIMIT, INSTANTIATION};

    InternalError(const Token *tok, std::string errorMsg, Type type = INTERNAL);
    InternalError(const Token *tok, std::string errorMsg, std::string details, Type type = INTERNAL);

    const Token *token;
    std::string errorMessage;
    std::string details;
    Type type;
    std::string id;
};

class TerminateException : public std::runtime_error {
public:
    TerminateException() : std::runtime_error("terminate") {}
};

enum class Certainty : std::uint8_t {
    normal, inconclusive
};

enum class Checks : std::uint8_t {
    unusedFunction, missingInclude, internalCheck
};

/** @brief enum class for severity. Used when reporting errors. */
enum class Severity : std::uint8_t {
    /**
     * No severity (default value).
     */
    none,
    /**
     * Programming error.
     * This indicates severe error like memory leak etc.
     * The error is certain.
     */
    error,
    /**
     * Warning.
     * Used for dangerous coding style that can cause severe runtime errors.
     * For example: forgetting to initialize a member variable in a constructor.
     */
    warning,
    /**
     * Style warning.
     * Used for general code cleanup recommendations. Fixing these
     * will not fix any bugs but will make the code easier to maintain.
     * For example: redundant code, unreachable code, etc.
     */
    style,
    /**
     * Performance warning.
     * Not an error as is but suboptimal code and fixing it probably leads
     * to faster performance of the compiled code.
     */
    performance,
    /**
     * Portability warning.
     * This warning indicates the code is not properly portable for
     * different platforms and bitnesses (32/64 bit). If the code is meant
     * to compile in different platforms and bitnesses these warnings
     * should be fixed.
     */
    portability,
    /**
     * Checking information.
     * Information message about the checking (process) itself. These
     * messages inform about header files not found etc issues that are
     * not errors in the code but something user needs to know.
     */
    information,
    /**
     * Debug message.
     * Debug-mode message useful for the developers.
     */
    debug,
    /**
     * Internal message.
     * Message will not be shown to the user.
     * Tracking what checkers is executed, tracking suppressed critical errors, etc.
     */
    internal
};

CPPCHECKLIB std::string severityToString(Severity severity);
CPPCHECKLIB Severity severityFromString(const std::string &severity);

struct CWE {
    explicit CWE(unsigned short cweId) : id(cweId) {}
    unsigned short id;
};

using ErrorPathItem = std::pair<const Token *, std::string>;
using ErrorPath = std::list<ErrorPathItem>;

/// @}
//---------------------------------------------------------------------------
#endif // errortypesH