WPILibC++ 2023.4.3
Errors.h
Go to the documentation of this file.
1// Copyright (c) FIRST and other WPILib contributors.
2// Open Source Software; you can modify and/or share it under the terms of
3// the WPILib BSD license file in the root directory of this project.
4
5#pragma once
6
7#include <stdint.h>
8
9#include <memory>
10#include <stdexcept>
11#include <string>
12
13#include <fmt/format.h>
14
15namespace frc {
16
17/**
18 * Runtime error exception.
19 */
20class RuntimeError : public std::runtime_error {
21 public:
22 RuntimeError(int32_t code, std::string&& loc, std::string&& stack,
23 std::string&& message);
24 RuntimeError(int32_t code, const char* fileName, int lineNumber,
25 const char* funcName, std::string&& stack,
26 std::string&& message);
27
28 int32_t code() const noexcept { return m_data->code; }
29 const char* loc() const noexcept { return m_data->loc.c_str(); }
30 const char* stack() const noexcept { return m_data->stack.c_str(); }
31
32 /**
33 * Reports error to Driver Station (using HAL_SendError).
34 */
35 void Report() const;
36
37 private:
38 struct Data {
40 std::string loc;
41 std::string stack;
42 };
43 std::shared_ptr<Data> m_data;
44};
45
46/**
47 * Gets error message string for an error code.
48 */
50
51/**
52 * Reports an error to the driver station (using HAL_SendError).
53 * Generally the FRC_ReportError wrapper macro should be used instead.
54 *
55 * @param[out] status error code
56 * @param[in] fileName source file name
57 * @param[in] lineNumber source line number
58 * @param[in] funcName source function name
59 * @param[in] format error message format
60 * @param[in] args error message format args
61 */
62void ReportErrorV(int32_t status, const char* fileName, int lineNumber,
63 const char* funcName, fmt::string_view format,
64 fmt::format_args args);
65
66/**
67 * Reports an error to the driver station (using HAL_SendError).
68 * Generally the FRC_ReportError wrapper macro should be used instead.
69 *
70 * @param[out] status error code
71 * @param[in] fileName source file name
72 * @param[in] lineNumber source line number
73 * @param[in] funcName source function name
74 * @param[in] format error message format
75 * @param[in] args error message format args
76 */
77template <typename... Args>
78inline void ReportError(int32_t status, const char* fileName, int lineNumber,
79 const char* funcName, fmt::string_view format,
80 Args&&... args) {
81 ReportErrorV(status, fileName, lineNumber, funcName, format,
82 fmt::make_format_args(args...));
83}
84
85/**
86 * Makes a runtime error exception object. This object should be thrown
87 * by the caller. Generally the FRC_MakeError wrapper macro should be used
88 * instead.
89 *
90 * @param[out] status error code
91 * @param[in] fileName source file name
92 * @param[in] lineNumber source line number
93 * @param[in] funcName source function name
94 * @param[in] format error message format
95 * @param[in] args error message format args
96 * @return runtime error object
97 */
98[[nodiscard]] RuntimeError MakeErrorV(int32_t status, const char* fileName,
99 int lineNumber, const char* funcName,
101 fmt::format_args args);
102
103template <typename... Args>
104[[nodiscard]] inline RuntimeError MakeError(
105 int32_t status, const char* fileName, int lineNumber, const char* funcName,
106 fmt::string_view format, Args&&... args) {
107 return MakeErrorV(status, fileName, lineNumber, funcName, format,
108 fmt::make_format_args(args...));
109}
110
111namespace err {
112#define S(label, offset, message) inline constexpr int label = offset;
113#include "frc/WPIErrors.mac"
114#undef S
115} // namespace err
116
117namespace warn {
118#define S(label, offset, message) inline constexpr int label = offset;
119#include "frc/WPIWarnings.mac"
120#undef S
121} // namespace warn
122} // namespace frc
123
124// C++20 relaxed the number of arguments to variadics, but Apple Clang's
125// warnings haven't caught up yet: https://stackoverflow.com/a/67996331
126#ifdef __clang__
127#pragma clang diagnostic ignored "-Wgnu-zero-variadic-macro-arguments"
128#endif
129
130/**
131 * Reports an error to the driver station (using HAL_SendError).
132 *
133 * @param[out] status error code
134 * @param[in] format error message format
135 */
136#define FRC_ReportError(status, format, ...) \
137 do { \
138 if ((status) != 0) { \
139 ::frc::ReportError(status, __FILE__, __LINE__, __FUNCTION__, \
140 FMT_STRING(format) __VA_OPT__(, ) __VA_ARGS__); \
141 } \
142 } while (0)
143
144/**
145 * Makes a runtime error exception object. This object should be thrown
146 * by the caller.
147 *
148 * @param[out] status error code
149 * @param[in] format error message format
150 * @return runtime error object
151 */
152#define FRC_MakeError(status, format, ...) \
153 ::frc::MakeError(status, __FILE__, __LINE__, __FUNCTION__, \
154 FMT_STRING(format) __VA_OPT__(, ) __VA_ARGS__)
155
156/**
157 * Checks a status code and depending on its value, either throws a
158 * RuntimeError exception, calls ReportError, or does nothing (if no error).
159 *
160 * @param[out] status error code
161 * @param[in] format error message format
162 */
163#define FRC_CheckErrorStatus(status, format, ...) \
164 do { \
165 if ((status) < 0) { \
166 throw ::frc::MakeError(status, __FILE__, __LINE__, __FUNCTION__, \
167 FMT_STRING(format) __VA_OPT__(, ) __VA_ARGS__); \
168 } else if ((status) > 0) { \
169 ::frc::ReportError(status, __FILE__, __LINE__, __FUNCTION__, \
170 FMT_STRING(format) __VA_OPT__(, ) __VA_ARGS__); \
171 } \
172 } while (0)
173
174#define FRC_AssertMessage(condition, format, ...) \
175 do { \
176 if (!(condition)) { \
177 throw ::frc::MakeError(err::AssertionFailure, __FILE__, __LINE__, \
178 __FUNCTION__, \
179 FMT_STRING(format) __VA_OPT__(, ) __VA_ARGS__); \
180 } \
181 } while (0)
182
183#define FRC_Assert(condition) FRC_AssertMessage(condition, #condition)
and restrictions which apply to each piece of software is included later in this file and or inside of the individual applicable source files The disclaimer of warranty in the WPILib license above applies to all code in and nothing in any of the other licenses gives permission to use the names of FIRST nor the names of the WPILib contributors to endorse or promote products derived from this software The following pieces of software have additional or alternate and or Google Inc All rights reserved Redistribution and use in source and binary with or without are permitted provided that the following conditions are this list of conditions and the following disclaimer *Redistributions in binary form must reproduce the above copyright this list of conditions and the following disclaimer in the documentation and or other materials provided with the distribution *Neither the name of Google Inc 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 BUT NOT LIMITED 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 OR CONSEQUENTIAL WHETHER IN STRICT OR EVEN IF ADVISED OF THE POSSIBILITY OF SUCH January AND DISTRIBUTION Definitions License shall mean the terms and conditions for and distribution as defined by Sections through of this document Licensor shall mean the copyright owner or entity authorized by the copyright owner that is granting the License Legal Entity shall mean the union of the acting entity and all other entities that control are controlled by or are under common control with that entity For the purposes of this definition control direct or to cause the direction or management of such whether by contract or including but not limited to software source code
Definition: ThirdPartyNotices.txt:113
Runtime error exception.
Definition: Errors.h:20
RuntimeError(int32_t code, const char *fileName, int lineNumber, const char *funcName, std::string &&stack, std::string &&message)
const char * stack() const noexcept
Definition: Errors.h:30
const char * loc() const noexcept
Definition: Errors.h:29
int32_t code() const noexcept
Definition: Errors.h:28
RuntimeError(int32_t code, std::string &&loc, std::string &&stack, std::string &&message)
void Report() const
Reports error to Driver Station (using HAL_SendError).
basic_string_view< char > string_view
Definition: core.h:520
constexpr auto make_format_args(Args &&... args) -> format_arg_store< Context, remove_cvref_t< Args >... >
\rst Constructs a ~fmtformat_arg_store object that contains references to arguments and can be implic...
Definition: core.h:1916
basic_format_args< format_context > format_args
An alias to basic_format_args<format_context>.
Definition: core.h:2062
::int32_t int32_t
Definition: Meta.h:57
Definition: AprilTagFieldLayout.h:22
RuntimeError MakeError(int32_t status, const char *fileName, int lineNumber, const char *funcName, fmt::string_view format, Args &&... args)
Definition: Errors.h:104
RuntimeError MakeErrorV(int32_t status, const char *fileName, int lineNumber, const char *funcName, fmt::string_view format, fmt::format_args args)
Makes a runtime error exception object.
void ReportError(int32_t status, const char *fileName, int lineNumber, const char *funcName, fmt::string_view format, Args &&... args)
Reports an error to the driver station (using HAL_SendError).
Definition: Errors.h:78
void ReportErrorV(int32_t status, const char *fileName, int lineNumber, const char *funcName, fmt::string_view format, fmt::format_args args)
Reports an error to the driver station (using HAL_SendError).
const char * GetErrorMessage(int32_t *code)
Gets error message string for an error code.
GHC_FS_API file_status status(const path &p, std::error_code &ec) noexcept
Definition: filesystem.hpp:4892
auto format(wformat_string< T... > fmt, T &&... args) -> std::wstring
Definition: xchar.h:87