feat: Introduce a pattern for handling mapping between enum values and names (facebookincubator#13988)

Summary:
X-link: facebookincubator/axiom#24

Pull Request resolved: facebookincubator#13988

In the header file, declare the enum class and a XxxName struct:

```
enum class Foo {...};

struct FooName {
  static std::string_view toName(Foo foo);
  static Foo toFoo(std::string_view name);
};
```

In the .cpp file, implement XxxName's methods:

```
#include "velox/common/Enums.h"

namespace {
folly::F14FastMap<Foo, std::string> fooNames() {
  return {
      {Foo::kFirst, "FIRST"},
      {Foo::kSecond, "SECOND"},
       ...
  };
}
} // namespace

// static
std::string_view FooName::toName(Foo foo) {
  static const auto kNames = fooNames();
  auto it = kNames.find(foo);
  VELOX_CHECK(
      it != kNames.end(),
      "Invalid enum value: {}",
      static_cast<int>(foo));
  return it->second.c_str();
}

// static
Foo FooName::toFoo(std::string_view name) {
  static const auto kEnums = Enums::invertMap(fooNames());

  auto it = kEnums.find(name);
  VELOX_CHECK(it != kEnums.end(), "Invalid enum name: {}", name);
  return it->second;
}
```

To reduce boiler plate code required to implement this pattern, introduce helper macros.

.h

```
#include "velox/common/Enums.h"

enum class Foo {...};

VELOX_DEFINE_ENUM_NAME(Foo);
```

.cpp

```
namespace {
folly::F14FastMap<Foo, std::string> fooNames() {
  return {
      {Foo::kFirst, "FIRST"},
      {Foo::kSecond, "SECOND"},
       ...
  };
}
} // namespace

VELOX_DECLARE_ENUM_NAME(Foo, fooNames);
```

Migrate all enums in PlanNode.h to the new pattern.

Reviewed By: oerling

Differential Revision: D77654609

fbshipit-source-id: 6dbd779a17f5da788532734dd2fc6a9cc3e8883d

Author: mbasmanova

velox/common/Enums.h

@@ -0,0 +1,119 @@
+/*
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * 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.
+ */
+#pragma once
+
+#include "folly/container/F14Map.h"
+#include "velox/common/base/Exceptions.h"
+
+namespace facebook::velox {
+
+struct Enums {
+  /// Helper function to invert a mapping from enum type to name.
+  template <typename E>
+  static folly::F14FastMap<std::string, E> invertMap(
+      const folly::F14FastMap<E, std::string>& mapping) {
+    folly::F14FastMap<std::string, E> inverted;
+    for (const auto& [key, value] : mapping) {
+      bool ok = inverted.emplace(value, key).second;
+      VELOX_USER_CHECK(
+          ok, "Cannot invert a map with duplicate values: {}", value);
+    }
+    return inverted;
+  }
+};
+
+} // namespace facebook::velox
+
+/// Helper macros to implement bi-direction mappings between enum values and
+/// names.
+///
+/// Usage:
+///
+/// In the header file, define the enum:
+///
+/// #include "velox/common/Enums.h"
+///
+/// enum class Foo {...};
+///
+/// VELOX_DEFINE_ENUM_NAME(Foo);
+///
+/// In the cpp file, define the mapping:
+///
+/// namespace {
+/// folly::F14FastMap<Foo, std::string> fooNames() {
+///   return {
+///       {Foo::kFirst, "FIRST"},
+///       {Foo::kSecond, "SECOND"},
+///        ...
+///   };
+/// }
+/// } // namespace
+///
+/// VELOX_DECLARE_ENUM_NAME(Foo, fooNames);
+///
+/// In the client code, use FooName::toName(Foo::kFirst) to get the name of the
+/// enum and FooName::toFoo("FIRST") to get the enum value.
+///
+/// Use _EMBEDDED_ versions of the macros to define enums embedded in other
+/// classes.
+
+#define VELOX_DECLARE_ENUM_NAME(EnumType)                \
+  struct EnumType##Name {                                \
+    static std::string_view toName(EnumType value);      \
+    static EnumType to##EnumType(std::string_view name); \
+  };
+
+#define VELOX_DEFINE_ENUM_NAME(EnumType, Names)                             \
+  std::string_view EnumType##Name::toName(EnumType value) {                 \
+    static const auto kNames = Names();                                     \
+    auto it = kNames.find(value);                                           \
+    VELOX_CHECK(                                                            \
+        it != kNames.end(),                                                 \
+        "Invalid enum value: {}",                                           \
+        static_cast<int>(value));                                           \
+    return it->second.c_str();                                              \
+  }                                                                         \
+                                                                            \
+  EnumType EnumType##Name::to##EnumType(std::string_view name) {            \
+    static const auto kValues = facebook::velox::Enums::invertMap(Names()); \
+                                                                            \
+    auto it = kValues.find(name);                                           \
+    VELOX_CHECK(it != kValues.end(), "Invalid enum name: {}", name);        \
+    return it->second;                                                      \
+  }
+
+#define VELOX_DECLARE_EMBEDDED_ENUM_NAME(EnumType) \
+  static std::string_view toName(EnumType value);  \
+  static EnumType to##EnumType(std::string_view name);
+
+#define VELOX_DEFINE_EMBEDDED_ENUM_NAME(Class, EnumType, Names)             \
+  std::string_view Class::toName(Class::EnumType value) {                   \
+    static const auto kNames = Names();                                     \
+    auto it = kNames.find(value);                                           \
+    VELOX_CHECK(                                                            \
+        it != kNames.end(),                                                 \
+        "Invalid enum value: {}",                                           \
+        static_cast<int>(value));                                           \
+    return it->second.c_str();                                              \
+  }                                                                         \
+                                                                            \
+  Class::EnumType Class::to##EnumType(std::string_view name) {              \
+    static const auto kValues = facebook::velox::Enums::invertMap(Names()); \
+                                                                            \
+    auto it = kValues.find(name);                                           \
+    VELOX_CHECK(it != kValues.end(), "Invalid enum name: {}", name);        \
+    return it->second;                                                      \
+  }