.. _program_listing_file_libtcod_error.h:

Program Listing for File error.h
================================

|exhale_lsh| :ref:`Return to documentation for file <file_libtcod_error.h>` (``libtcod/error.h``)

.. |exhale_lsh| unicode:: U+021B0 .. UPWARDS ARROW WITH TIP LEFTWARDS

.. code-block:: cpp

   /* BSD 3-Clause License
    *
    * Copyright © 2008-2025, Jice and the libtcod contributors.
    * All rights reserved.
    *
    * Redistribution and use in source and binary forms, with or without
    * modification, are permitted provided that the following conditions are met:
    *
    * 1. Redistributions of source code must retain the above copyright notice,
    *    this list of conditions and the following disclaimer.
    *
    * 2. Redistributions in binary form must reproduce the above copyright notice,
    *    this list of conditions and the following disclaimer in the documentation
    *    and/or other materials provided with the distribution.
    *
    * 3. Neither the name of the copyright holder 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 WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
    * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
    * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
    * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
    * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
    * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
    * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
    * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
    * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
    * POSSIBILITY OF SUCH DAMAGE.
    */
   #pragma once
   #ifndef LIBTCOD_ERROR_H_
   #define LIBTCOD_ERROR_H_
   #include "config.h"
   #include "version.h"
   typedef enum TCOD_Error {
     TCOD_E_OK = 0,
     TCOD_E_ERROR = -1,
     TCOD_E_INVALID_ARGUMENT = -2,
     TCOD_E_OUT_OF_MEMORY = -3,
     TCOD_E_REQUIRES_ATTENTION = -4,
     TCOD_E_WARN = 1,
   } TCOD_Error;
   #ifdef __cplusplus
   extern "C" {
   #endif  // __cplusplus
   
   TCOD_NODISCARD
   TCODLIB_API const char* TCOD_get_error(void);
   
   TCODLIB_API TCOD_Error TCOD_set_error(const char* msg);
   TCODLIB_FORMAT(1, 2)
   TCODLIB_API TCOD_Error TCOD_set_errorf(const char* fmt, ...);
   TCODLIB_API void TCOD_clear_error(void);
   #define TCOD_set_errorv(msg) TCOD_set_errorf("%s:%i\n%s", TCOD_STRVERSIONNAME " " __FILE__, __LINE__, (msg))
   #define TCOD_set_errorvf(fmt, ...) \
     TCOD_set_errorf("%s:%i\n" fmt, TCOD_STRVERSIONNAME " " __FILE__, __LINE__, __VA_ARGS__)
   #ifdef __cplusplus
   }  // extern "C"
   #endif  // __cplusplus
   #endif  // LIBTCOD_ERROR_H_