git.sesse.net Git - casparcg/blob - common/except.h

   1 /*
   2 * Copyright (c) 2011 Sveriges Television AB <info@casparcg.com>
   3 *
   4 * This file is part of CasparCG (www.casparcg.com).
   5 *
   6 * CasparCG is free software: you can redistribute it and/or modify
   7 * it under the terms of the GNU General Public License as published by
   8 * the Free Software Foundation, either version 3 of the License, or
   9 * (at your option) any later version.
  10 *
  11 * CasparCG is distributed in the hope that it will be useful,
  12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14 * GNU General Public License for more details.
  15 *
  16 * You should have received a copy of the GNU General Public License
  17 * along with CasparCG. If not, see <http://www.gnu.org/licenses/>.
  18 *
  19 * Author: Robert Nagy, ronag89@gmail.com
  20 */
  21
  22 #pragma once
  23
  24 #include "utf.h"
  25
  26 #include "os/stack_trace.h"
  27
  28 #include <exception>
  29 #include <list>
  30
  31 #include <boost/exception/all.hpp>
  32 #include <boost/exception/error_info.hpp>
  33 #include <boost/throw_exception.hpp>
  34 #include <boost/noncopyable.hpp>
  35
  36 namespace caspar {
  37
  38 typedef boost::error_info<struct tag_arg_name_info,             std::string>    arg_name_info_t;
  39 typedef boost::error_info<struct tag_arg_value_info,    std::string>    arg_value_info_t;
  40 typedef boost::error_info<struct tag_msg_info,                  std::string>    msg_info_t;
  41 typedef boost::error_info<struct tag_call_stack_info,   std::string>    call_stack_info_t;
  42 typedef boost::error_info<struct tag_error_info,                std::string>    error_info_t;
  43 typedef boost::error_info<struct tag_source_info,               std::string>    source_info_t;
  44 typedef boost::error_info<struct tag_file_name_info,    std::string>    file_name_info_t;
  45 typedef boost::error_info<struct tag_context_info,              std::string>    context_info_t;
  46
  47 template<typename T>
  48 inline arg_name_info_t          arg_name_info(const T& str)             {return arg_name_info_t(u8(str));}
  49 template<typename T>
  50 inline arg_value_info_t         arg_value_info(const T& str)    {return arg_value_info_t(u8(str));}
  51 template<typename T>
  52 inline msg_info_t                       msg_info(const T& str)                  {return msg_info_t(u8(str));}
  53 template<typename T>
  54 inline call_stack_info_t        call_stack_info(const T& str)   {return call_stack_info_t(u8(str));}
  55 template<typename T>
  56 inline error_info_t                     error_info(const T& str)                {return error_info_t(u8(str));}
  57 template<typename T>
  58 inline source_info_t            source_info(const T& str)               {return source_info_t(u8(str));}
  59 template<typename T>
  60 inline file_name_info_t         file_name_info(const T& str)    {return file_name_info_t(u8(str));}
  61 template<typename T>
  62 inline context_info_t           context_info(const T& str)              {return context_info_t(u8(str));}
  63
  64 typedef boost::error_info<struct tag_line_info, size_t>                                         line_info;
  65 typedef boost::error_info<struct tag_nested_exception_, std::exception_ptr> nested_exception;
  66
  67 struct caspar_exception                 : virtual boost::exception, virtual std::exception
  68 {
  69         caspar_exception(){}
  70         const char* what() const throw() override
  71         {
  72                 return boost::diagnostic_information_what(*this);
  73         }
  74 };
  75
  76 struct io_error                                 : virtual caspar_exception {};
  77 struct directory_not_found              : virtual io_error {};
  78 struct file_not_found                   : virtual io_error {};
  79 struct file_read_error          : virtual io_error {};
  80 struct file_write_error         : virtual io_error {};
  81
  82 struct invalid_argument                 : virtual caspar_exception {};
  83 struct null_argument                    : virtual invalid_argument {};
  84 struct out_of_range                             : virtual invalid_argument {};
  85 struct programming_error                : virtual caspar_exception {};
  86 struct bad_alloc                                : virtual caspar_exception {};
  87
  88 struct invalid_operation                : virtual caspar_exception {};
  89 struct operation_failed                 : virtual caspar_exception {};
  90 struct timed_out                                : virtual caspar_exception {};
  91
  92 struct not_implemented                  : virtual caspar_exception {};
  93
  94 struct user_error                               : virtual caspar_exception {};
  95 struct expected_user_error              : virtual user_error {};
  96 struct not_supported                    : virtual user_error {};
  97
  98 std::string get_context();
  99
 100 class scoped_context : boost::noncopyable
 101 {
 102 public:
 103         scoped_context();
 104         scoped_context(std::string msg);
 105         template <typename Str>
 106         scoped_context(Str msg)
 107                 : scoped_context(u8(std::move(msg)))
 108         {
 109         }
 110
 111         ~scoped_context();
 112         void replace_msg(std::string msg);
 113         template <typename Str>
 114         void replace_msg(std::string msg)
 115         {
 116                 replace_msg(u8(std::move(msg)));
 117         }
 118         void clear_msg();
 119 private:
 120         std::list<std::string>& for_thread_;
 121         std::string*                    msg_;
 122 };
 123
 124 #define _CASPAR_GENERATE_UNIQUE_IDENTIFIER_CAT(name, line) name##line
 125 #define _CASPAR_GENERATE_UNIQUE_IDENTIFIER(name, line) _CASPAR_GENERATE_UNIQUE_IDENTIFIER_CAT(name, line)
 126 #define CASPAR_SCOPED_CONTEXT_MSG(ctx_msg) ::caspar::scoped_context _CASPAR_GENERATE_UNIQUE_IDENTIFIER(SCOPED_CONTEXT, __LINE__)(u8(ctx_msg));
 127
 128 #define CASPAR_THROW_EXCEPTION(e) BOOST_THROW_EXCEPTION(e << call_stack_info(caspar::get_call_stack()) << context_info(get_context()))
 129
 130 std::string get_message_and_context(const caspar_exception& e);
 131
 132 }
 133