git.sesse.net Git - casparcg/blob - common/log.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 "os/stack_trace.h"
  25 #include "utf.h"
  26 #include "thread_info.h"
  27 #include "enum_class.h"
  28
  29 #include <boost/log/trivial.hpp>
  30 #include <boost/log/expressions.hpp>
  31 #include <boost/log/sources/global_logger_storage.hpp>
  32 #include <boost/log/sources/severity_channel_logger.hpp>
  33 #include <boost/exception/all.hpp>
  34 #include <boost/property_tree/ptree_fwd.hpp>
  35
  36 #include <string>
  37 #include <locale>
  38 #include <functional>
  39 #include <memory>
  40
  41 namespace caspar { namespace log {
  42
  43 namespace internal{
  44 void init();
  45 std::wstring get_call_stack();
  46 }
  47
  48 const char* remove_source_prefix(const char* file);
  49
  50 template<typename T>
  51 inline void replace_nonprintable(std::basic_string<T, std::char_traits<T>, std::allocator<T>>& str, T with)
  52 {
  53         std::locale loc;
  54         std::replace_if(str.begin(), str.end(), [&](T c)->bool {
  55                 return
  56                         (!std::isprint(c, loc)
  57                         && c != '\r'
  58                         && c != '\n')
  59                         || c > static_cast<T>(127);
  60         }, with);
  61 }
  62
  63 template<typename T>
  64 inline std::basic_string<T> replace_nonprintable_copy(std::basic_string<T, std::char_traits<T>, std::allocator<T>> str, T with)
  65 {
  66         replace_nonprintable(str, with);
  67         return str;
  68 }
  69
  70 void add_file_sink(const std::wstring& file, const boost::log::filter& filter);
  71 std::shared_ptr<void> add_preformatted_line_sink(std::function<void(std::string line)> formatted_line_sink);
  72
  73 enum class log_category
  74 {
  75         normal                  = 1,
  76         calltrace               = 2,
  77         communication   = 4
  78 };
  79 ENUM_ENABLE_BITWISE(log_category)
  80 BOOST_LOG_ATTRIBUTE_KEYWORD(category, "Channel", ::caspar::log::log_category)
  81
  82 typedef boost::log::sources::wseverity_channel_logger_mt<boost::log::trivial::severity_level, log_category> caspar_logger;
  83
  84 BOOST_LOG_INLINE_GLOBAL_LOGGER_INIT(logger, caspar_logger)
  85 {
  86         internal::init();
  87         return caspar_logger(
  88                         boost::log::keywords::severity = boost::log::trivial::trace,
  89                         boost::log::keywords::channel = log_category::normal);
  90 }
  91
  92 #define CASPAR_LOG(lvl)\
  93         BOOST_LOG_CHANNEL_SEV(::caspar::log::logger::get(), ::caspar::log::log_category::normal,                ::boost::log::trivial::lvl)
  94 #define CASPAR_LOG_CALL(lvl)\
  95         BOOST_LOG_CHANNEL_SEV(::caspar::log::logger::get(), ::caspar::log::log_category::calltrace,             ::boost::log::trivial::lvl)
  96 #define CASPAR_LOG_COMMUNICATION(lvl)\
  97         BOOST_LOG_CHANNEL_SEV(::caspar::log::logger::get(), ::caspar::log::log_category::communication, ::boost::log::trivial::lvl)
  98
  99 #define CASPAR_LOG_CALL_STACK() try{\
 100                 CASPAR_LOG(info) << L"callstack (" << caspar::get_thread_info().name << L"):\n" << caspar::get_call_stack();\
 101         }\
 102         catch(...){}
 103
 104 #define CASPAR_LOG_CURRENT_EXCEPTION() try{\
 105                 CASPAR_LOG(error) << caspar::u16(boost::current_exception_diagnostic_information()) << L"Caught at (" << caspar::get_thread_info().name << L"):\n" << caspar::get_call_stack();\
 106         }\
 107         catch(...){}
 108
 109 #define CASPAR_LOG_CURRENT_EXCEPTION_AT_LEVEL(lvl) try{\
 110                 CASPAR_LOG(lvl) << caspar::u16(boost::current_exception_diagnostic_information()) << L"Caught at (" << caspar::get_thread_info().name << L"):\n" << caspar::get_call_stack();\
 111         }\
 112         catch(...){}
 113
 114 void set_log_level(const std::wstring& lvl);
 115 void set_log_category(const std::wstring& cat, bool enabled);
 116
 117 void print_child(
 118                 boost::log::trivial::severity_level level,
 119                 const std::wstring& indent,
 120                 const std::wstring& elem,
 121                 const boost::property_tree::wptree& tree);
 122
 123 }}