compiler/luci/log/include/luci/Log.h

   1 /*
   2  * Copyright (c) 2020 Samsung Electronics Co., Ltd. All Rights Reserved
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  *    http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 #ifndef __LUCI_LOG_H__
  18 #define __LUCI_LOG_H__
  19
  20 #include <hermes.h>
  21
  22 namespace luci
  23 {
  24
  25 /**
  26  * @brief Logger Implementation
  27  */
  28 class Logger final : public hermes::Source
  29 {
  30 public:
  31   Logger(hermes::Context *ctx);
  32   ~Logger();
  33 };
  34
  35 /**
  36  * @brief Logger Configuration
  37  *
  38  * Users are able to turn logging on/off via LUCI_LOG environment variable.
  39  */
  40 class LoggerConfig final : public hermes::Config
  41 {
  42 public:
  43   LoggerConfig();
  44
  45 public:
  46   void configure(const hermes::Source *, hermes::Source::Setting &) const final;
  47   void configure(const Logger *, hermes::Source::Setting &) const;
  48
  49 private:
  50   bool _show_warn = true;
  51   int _show_verbose = 0;
  52 };
  53
  54 } // namespace luci
  55
  56 #include "luci/LoggingContext.h"
  57
  58 /**
  59  * HOW TO USE:
  60  *
  61  *   LOGGER(l);
  62  *
  63  *   INFO(l) << "Hello, World" << std::endl;
  64  *
  65  */
  66 #define LOGGER(name) ::luci::Logger name{::luci::LoggingContext::get()};
  67
  68 // TODO Support FATAL, ERROR
  69 #define INFO(name) HERMES_VERBOSE(name, 3)
  70 #define WARN(name) HERMES_VERBOSE(name, 2)
  71 #define VERBOSE(name, lv) HERMES_VERBOSE(name, lv)
  72
  73 // WARNING!
  74 //
  75 //   THE CURRENT IMPLEMENTATION IS NOT THREAD SAFE.
  76 //
  77
  78 #endif // __LUCI_LOG_H__