libtcod
Loading...
Searching...
No Matches
error.hpp
Go to the documentation of this file.
1/* BSD 3-Clause License
2 *
3 * Copyright © 2008-2025, Jice and the libtcod contributors.
4 * All rights reserved.
5 *
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions are met:
8 *
9 * 1. Redistributions of source code must retain the above copyright notice,
10 * this list of conditions and the following disclaimer.
11 *
12 * 2. Redistributions in binary form must reproduce the above copyright notice,
13 * this list of conditions and the following disclaimer in the documentation
14 * and/or other materials provided with the distribution.
15 *
16 * 3. Neither the name of the copyright holder nor the names of its
17 * contributors may be used to endorse or promote products derived from
18 * this software without specific prior written permission.
19 *
20 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
21 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
24 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
29 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
30 * POSSIBILITY OF SUCH DAMAGE.
31 */
34#pragma once
35#ifndef LIBTCOD_ERROR_HPP_
36#define LIBTCOD_ERROR_HPP_
37
38#include <exception>
39#include <filesystem>
40#include <stdexcept>
41#include <string>
42
43#include "error.h"
44namespace tcod {
50inline TCOD_Error set_error(const std::string& msg) { return TCOD_set_errorv(msg.c_str()); }
51inline TCOD_Error set_error(const std::exception& e) { return TCOD_set_errorv(e.what()); }
57inline int check_throw_error(int error) {
58 if (error >= 0) {
59 return error;
60 }
61 std::string error_msg = TCOD_get_error();
62 switch (error) {
63 case TCOD_E_ERROR:
64 default:
65 throw std::runtime_error(error_msg);
66 break;
68 throw std::invalid_argument(error_msg);
69 break;
70 }
71}
73 return static_cast<TCOD_Error>(check_throw_error(static_cast<int>(error)));
74}
78inline void check_path(const std::filesystem::path& path) {
79 if (!std::filesystem::exists(path)) {
80 throw std::runtime_error(std::string("File not found:\n") + std::filesystem::absolute(path).string());
81 }
82}
83} // namespace tcod
84#endif // LIBTCOD_ERROR_HPP_
Error handling module.
TCOD_Error
An enum of libtcod error codes.
Definition error.h:48
@ TCOD_E_INVALID_ARGUMENT
The function failed because a given input argument was invalid.
Definition error.h:66
@ TCOD_E_ERROR
The error code for generic runtime errors.
Definition error.h:62
#define TCOD_set_errorv(msg)
Set an error with version, file, and line info added to the output.
Definition error.h:124
const char * TCOD_get_error(void)
Return the last error message.
The libtcod namespace.
Definition bresenham.hpp:157
TCOD_Error set_error(const std::string &msg)
Set an error message and return a relevant error code, usually -1.
Definition error.hpp:50
void check_path(const std::filesystem::path &path)
Throw an exception if the given path does not exist.
Definition error.hpp:78
int check_throw_error(int error)
Check and throw error messages.
Definition error.hpp:57