使用可变参数模板函数在类周围实现基于pImpl的包装器

时间:2019-06-09 18:13:20

标签: c++ templates wrapper variadic-templates pimpl-idiom

摘要

我正在编写一个库和一个客户端应用程序。在该库中,我试图为另一个静态链接的第三方库(特别是spdlog)编写包装,并尝试使用pImpl习惯用法将其完全隐藏在客户端应用程序中。问题在于第三方库使用可变参数模板函数,因此我也需要在库中。

背景

我第一次尝试使用包装程序非常简单,但是后来我的客户端应用程序出现“ No such file or directory”错误,因为第三方标头包含在库的标头中。

接下来,我尝试创建一个pImpl类并进行编译,但是在客户端中,我再次遇到“未定义引用”链接器错误。

将实现的源代码拖到包装程序的标头中,使我重新回到最初的“无此类文件”问题。在研究了这一点之后,我开始认为不可能围绕可变参数模板进行包装,但是我不确定。这是我第一次尝试创建可变函数/模板。

示例代码

这是我的项目目前的状态:

为了简洁起见,几乎所有名称空间,函数名称,标头等都已被编辑(或删除)。

客户端应用程序-sandbox.cpp

#include "sandbox.h"
#include <logger.h>  //  <-- This is all I want clients to see.

int Sandbox::run() {
    LOG_INFO("Hello World!");        // My library is providing this.
    LOG_INFO("Hello {}", "indeed!"); // And, this variable input function.
    return 0;
}

我的图书馆-logger.h

class LoggerImp;  // Forward declaration of implementation.

class LIB_EXPORT Logger {
  public:

    /* Constructors, destructor, etc. */

    template <typename... Args>
    void info(const char * fmt, Args &... args);

    void info(const char * msg) { this->info("{}", msg); }

    /* Other logging functions: trace, error, etc. */

  private:
    LoggerImp * _imp;
};

static Logger coreLogger("Core");
static Logger clientLogger("App");

#define LOG_INFO(args...) clientLogger.info(args)
/* Other such convenience definitions. */

我的图书馆-logger.cpp

#include "logger.h"
#include "loggerimp.h"

Logger::Logger(std::string name) { _imp = new LoggerImp(name, this); }
Logger::~Logger() { delete _imp; }

template <typename... Args>
void Logger::info(const char * fmt, Args &... args) {
    _imp->info(fmt, args...);
}

我的图书馆-loggerimp.h

#include "logger.h"
#include <spdlog/spdlog.h>
#include <spdlog/sinks/stdout_color_sinks.h>

class LoggerImp {
  public:
    explicit LoggerImp(string name, Logger * pubInterface) :
        _pubInterface(pubInterface) {  // Back pointer.
        _sink   = make_shared<spdlog::sinks::stdout_color_sink_mt>();
        _logger = make_shared<spdlog::logger>(name, _sink);
        spdlog::initialize_logger(_logger);
        // The above three lines create the actual logging object
        // that my library is wrapping and hiding from its clients.
    }

    template <typename... Args>
    inline void info(const char * fmt, const Args &... args) {
        _logger->info(fmt, args...);  // Third-party logging function.
    }
}

预期结果

如上所述,我只希望库的客户端能够包含诸如<logger.h>之类的标头,并且不需要配置其项目来查找和处理库的所有依赖项,但是由于我目前使用第三方工具(使用可变参数模板),鉴于模板的“不是真正的功能”性质,我看不出有什么方法可以将其隐藏在客户端中。

1 个答案:

答案 0 :(得分:2)

您可以在头文件中执行类型擦除操作,并在impl源文件中处理类型擦除类型。

这是两个例子:

1。使用std :: any

进行类型擦除
// log.hpp
#pragma once

#include <any>
#include <vector>
#include <utility>

struct Log {
  Log(int a);
  ~Log();

  template <class... A>
  void log(A&&... a) {
    log_impl({std::any(std::forward<A>(a))...});
  }

private:
  void log_impl(std::vector<std::any> v);
  struct Impl;
  Impl* impl_;
};

// log.cpp
#include "log.hpp"
#include <iostream>
#include <boost/mp11.hpp>

struct Log::Impl {
  int a;
};

void Log::log_impl(std::vector<std::any> v) {
  std::cout << impl_->a << " ";
  for (auto&& i : v) {
    bool b = false;
    using namespace boost::mp11;
    mp_for_each<mp_list<int, const char*, double>>(
        [&](auto t) {
          if (!b) {
            try {
              std::cout << std::any_cast<decltype(t)>(i) << " ";
              b = true;
            } catch (std::bad_any_cast&) {
            }
          }
        });
    if (!b) {
      std::cout << "UNKNOWN ";
    }
  }
  std::cout << std::endl;
}

Log::Log(int a) : impl_(new Log::Impl{a}) {}
Log::~Log() { delete impl_; }


// client.cpp
#include "log.hpp"

struct A {
  char a;
};
std::ostream& operator<<(std::ostream& os, const A& a) { os << a.a; }

int main() {
  Log a(555);
  a.log(11, "222");    // output: 555 11 222 
  a.log(A{'a'}, 3.3);  // output: 555 UNKNOWN 3.3 
}

2。使用std :: function进行类型擦除

// log.hpp
#pragma once

#include <vector>
#include <utility>
#include <functional>
#include <iostream>

struct Log {
  Log(int a);
  ~Log();

  template <class... A>
  void log(A&&... a) {
    log_impl({[&a](std::ostream& os) { os << std::forward<A>(a); }...});
  }

private:
  void log_impl(std::vector<std::function<void(std::ostream&)>> v);
  struct Impl;
  Impl* impl_;
};


// log.cpp
#include "log.hpp"
#include <iostream>

struct Log::Impl {
  int a;
};

void Log::log_impl(std::vector<std::function<void(std::ostream&)>> v) {
  std::cout << impl_->a;
  for (auto&& i : v) {
    std::cout << ' ';
    i(std::cout);
  }
  std::cout << std::endl;
}

Log::Log(int a) : impl_(new Log::Impl{a}) {}
Log::~Log() { delete impl_; }


// client.cpp
#include "log.hpp"

struct A {
  char a;
};
std::ostream& operator<<(std::ostream& os, const A& a) { os << a.a; }

int main() {
  Log a(555);
  a.log(11, "222");    // output: 555 11 222
  a.log(A{'a'}, 3.3);  // output: 555 a 3.3
}

为类型删除的类型提供fmt :: formatter

下面是提供fmt custom formatter的示例 用于类型删除的类型。

namespace {
struct erased_type : std::vector<std::any> {};
} // namespace

namespace fmt {
template <>
struct formatter<erased_type> {
  template <typename ParseContext>
  constexpr auto parse(ParseContext &ctx) { return ctx.begin(); }

  template <typename FormatContext>
  auto format(const erased_type &v, FormatContext &ctx) {
    auto ctx_itr = ctx.begin();
    for (auto&& i : v) {
      bool b = false;
      using namespace boost::mp11;
      mp_for_each<mp_list<int, const char*, double>>([&](auto t) {
        if (!b) {
          try {
            format_to(ctx_itr, " {}", std::any_cast<decltype(t)>(i));
            b = true;
            ctx_itr++;
          } catch (std::bad_any_cast&) {
          }
        }
      });
      if (!b) {
        format_to(ctx_itr++, " UNKNOWN");
      }
    }
    return ctx_itr;
  }
};
}

void Log::log_impl(std::vector<std::any> v) {
  spdlog::info("{} {}", impl_->a, erased_type{std::move(v)});
}