[hermes] Introduce Severity class (#3551)

This commit introduces Severity class which denotes the severity of
each event.

Signed-off-by: Jonghyun Park <jh1302.park@samsung.com>

diff --git a/contrib/hermes/include/hermes.h b/contrib/hermes/include/hermes.h
index 2108aee..3a9fcd2 100644 (file)
--- a/contrib/hermes/include/hermes.h
+++ b/contrib/hermes/include/hermes.h
@@ -17,6 +17,7 @@
 #ifndef __HERMES_H__
 #define __HERMES_H__
 
+#include "hermes/core/Severity.h"
 // TO BE FILLED
 
 #endif // __HERMES_H__

diff --git a/contrib/hermes/include/hermes/core/Severity.h b/contrib/hermes/include/hermes/core/Severity.h
new file mode 100644 (file)
index 0000000..25de35d
--- /dev/null
+++ b/contrib/hermes/include/hermes/core/Severity.h
@@ -0,0 +1,83 @@
+/*
+ * Copyright (c) 2019 Samsung Electronics Co., Ltd. All Rights Reserved
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#ifndef __HERMES_SEVERITY_H__
+#define __HERMES_SEVERITY_H__
+
+#include <cstdint>
+
+namespace hermes
+{
+
+/**
+ * FATAL > ERROR > WARN > INFO > VERBOSE
+ *
+ * Hermes deliberately declares SeverityCategory as "enum" (instead of "enum class")
+ * in order to reduce namespace nesting.
+ */
+enum SeverityCategory : uint16_t
+{
+  FATAL = 0,
+  ERROR = 1,
+  WARN = 2,
+  INFO = 3,
+  VERBOSE = 4,
+};
+
+class Severity final
+{
+public:
+  friend Severity fatal(void);
+  friend Severity error(void);
+  friend Severity warn(void);
+  friend Severity info(void);
+  friend Severity verbose(uint16_t level);
+
+private:
+  /**
+   * Use below "factory" helpers.
+   */
+  Severity(SeverityCategory cat, uint16_t lvl) : _cat{cat}, _lvl{lvl}
+  {
+    // DO NOTHING
+  }
+
+public:
+  const SeverityCategory &category(void) const { return _cat; }
+
+  /**
+   * @brief Verbose level
+   *
+   * "level" is fixed as 0 for all the categories except VERBOSE.
+   *
+   * 0 (most significant) <--- level ---> 65535 (least significant)
+   */
+  const uint16_t &level(void) const { return _lvl; }
+
+private:
+  SeverityCategory _cat;
+  uint16_t _lvl;
+};
+
+inline Severity fatal(void) { return Severity{FATAL, 0}; }
+inline Severity error(void) { return Severity{ERROR, 0}; }
+inline Severity warn(void) { return Severity{WARN, 0}; }
+inline Severity info(void) { return Severity{INFO, 0}; }
+inline Severity verbose(uint16_t level) { return Severity{VERBOSE, level}; }
+
+} // namespace hermes
+
+#endif // __HERMES_SEVERITY_H__

diff --git a/contrib/hermes/src/core/Severity.test.cpp b/contrib/hermes/src/core/Severity.test.cpp
new file mode 100644 (file)
index 0000000..44fb800
--- /dev/null
+++ b/contrib/hermes/src/core/Severity.test.cpp
@@ -0,0 +1,59 @@
+/*
+ * Copyright (c) 2019 Samsung Electronics Co., Ltd. All Rights Reserved
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#include "hermes/core/Severity.h"
+
+#include <gtest/gtest.h>
+
+TEST(SeverityTest, fatal)
+{
+  auto severity = hermes::fatal();
+
+  ASSERT_EQ(severity.category(), hermes::FATAL);
+  ASSERT_EQ(severity.level(), 0);
+}
+
+TEST(SeverityTest, error)
+{
+  auto severity = hermes::error();
+
+  ASSERT_EQ(severity.category(), hermes::ERROR);
+  ASSERT_EQ(severity.level(), 0);
+}
+
+TEST(SeverityTest, warn)
+{
+  auto severity = hermes::warn();
+
+  ASSERT_EQ(severity.category(), hermes::WARN);
+  ASSERT_EQ(severity.level(), 0);
+}
+
+TEST(SeverityTest, info)
+{
+  auto severity = hermes::info();
+
+  ASSERT_EQ(severity.category(), hermes::INFO);
+  ASSERT_EQ(severity.level(), 0);
+}
+
+TEST(SeverityTest, verbose)
+{
+  auto severity = hermes::verbose(100);
+
+  ASSERT_EQ(severity.category(), hermes::VERBOSE);
+  ASSERT_EQ(severity.level(), 100);
+}