include/rtems/error.hpp

0001 /* SPDX-License-Identifier: BSD-2-Clause */
0002
0003 /**
0004  * @file
0005  *
0006  * @ingroup RTEMSC++
0007  *
0008  * @brief RTEMS Error exception.
0009  *
0010  * Provide an error exception for RTEMS errors.
0011  */
0012
0013 /*
0014  * Copyright (C) 2020 Chris Johns (http://contemporary.software)
0015  *
0016  * Redistribution and use in source and binary forms, with or without
0017  * modification, are permitted provided that the following conditions
0018  * are met:
0019  * 1. Redistributions of source code must retain the above copyright
0020  *    notice, this list of conditions and the following disclaimer.
0021  * 2. Redistributions in binary form must reproduce the above copyright
0022  *    notice, this list of conditions and the following disclaimer in the
0023  *    documentation and/or other materials provided with the distribution.
0024  *
0025  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
0026  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
0027  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
0028  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
0029  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
0030  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
0031  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
0032  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
0033  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
0034  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
0035  * POSSIBILITY OF SUCH DAMAGE.
0036  */
0037
0038 #if !defined(RTEMS_ERROR_HPP)
0039 #define RTEMS_ERROR_HPP
0040
0041 #include <stdexcept>
0042 #include <string>
0043
0044 #include <rtems/error.h>
0045
0046 namespace rtems
0047 {
0048   class runtime_error :
0049     public std::runtime_error
0050   {
0051     const rtems_status_code sc;
0052   public:
0053     runtime_error(const rtems_status_code sc);
0054     runtime_error(const rtems_status_code sc, const std::string& what);
0055     runtime_error(const rtems_status_code sc, const char* what);
0056     ~runtime_error();
0057   };
0058
0059   /**
0060    * Throw a rtems::runtime_error exception if the RTEMS status code is
0061    * not RTEMS_SUCCESSFUL.
0062    */
0063   void runtime_error_check(const rtems_status_code sc);
0064   void runtime_error_check(const rtems_status_code sc, const std::string& what);
0065   void runtime_error_check(const rtems_status_code sc, const char* what);
0066 };
0067
0068 #endif