如何在可变参数模板函数中使用 source_location？

Question

C++20 特性std::source_location 用于捕获有关调用函数的上下文的信息。 当我尝试将它与可变参数模板函数一起使用时，我遇到了一个问题：我看不到放置 source_location 参数的地方。

以下不起作用，因为可变参数必须在末尾：

// doesn't work
template <typename... Args>
void debug(Args&&... args,
           const std::source_location& loc = std::source_location::current());

以下也不起作用，因为调用者将被插入其中的参数搞砸：

// doesn't work either, because ...
template <typename... Args>
void debug(const std::source_location& loc = std::source_location::current(),
           Args&&... args);

// the caller will get confused
debug(42); // error: cannot convert 42 to std::source_location

我在comment 中得知std::source_location 可以与可变参数模板无缝协作，但我很难弄清楚如何使用。如何将std::source_location 与可变参数模板函数一起使用？

Answer 1

第一个表单可以通过添加deduction guide：

template <typename... Ts>
struct debug
{    
    debug(Ts&&... ts, const std::source_location& loc = std::source_location::current());
};

template <typename... Ts>
debug(Ts&&...) -> debug<Ts...>;

测试：

int main()
{
    debug(5, 'A', 3.14f, "foo");
}

DEMO

Answer 2

如果您的函数在可变参数之前有一个固定参数，例如 printf 格式字符串，您可以将该参数包装在一个结构中，该结构在其构造函数中捕获 source_location：

struct FormatWithLocation {
  const char* value;
  std::source_location loc;

  FormatWithLocation(const char* s,
                     const std::source_location& l = std::source_location::current())
      : value(s), loc(l) {}
};

template <typename... Args>
void debug(FormatWithLocation fmt, Args&&... args) {
  printf("%s:%d] ", fmt.loc.file_name(), fmt.loc.line());
  printf(fmt.value, args...);
}

int main() { debug("hello %s\n", "world"); }

Answer 3

只需将您的参数放在一个元组中，不需要宏。

#include <source_location>
#include <tuple>

template <typename... Args>
void debug(
    std::tuple<Args...> args,
    const std::source_location& loc = std::source_location::current())
{
    std::cout 
        << "debug() called from source location "
        << loc.file_name() << ":" << loc.line()  << '\n';
}

还有这个works^*。

从技术上讲，你可以写：

template <typename T>
void debug(
    T arg, 
    const std::source_location& loc = std::source_location::current())
{
    std::cout 
        << "debug() called from source location "
        << loc.file_name() << ":" << loc.line()  << '\n';
}

但是你可能不得不跳过一些障碍来获取参数类型。

---

_{* 在链接到的示例中，我使用<experimental/source_location>，因为这是编译器现在接受的。另外，我添加了一些用于打印参数元组的代码。}

Answer 4

template <typename... Args>
void debug(Args&&... args,
           const std::source_location& loc = std::source_location::current());

“有效”，但需要指定模板参数，因为没有最后一个，所以不可演绎：

debug<int>(42);

Demo

可能的（不完美的）替代方案包括：

• 使用带有硬编码限制的重载（“处理”可变参数的旧方法）：

  // 0 arguments
  void debug(const std::source_location& loc = std::source_location::current());
  
  // 1 argument
  template <typename T0>
  void debug(T0&& t0,
             const std::source_location& loc = std::source_location::current());
  
  // 2 arguments
  template <typename T0, typename T1>
  void debug(T0&& t0, T1&& t1,
             const std::source_location& loc = std::source_location::current());
  
  // ...
  

  Demo

• 将source_location 放在首位，不带默认值：

  template <typename... Args>
  void debug(const std::source_location& loc, Args&&... args);
  

  和

  debug(std::source_location::current(), 42);
  

  Demo

• 类似于重载，但只是使用元组作为组

  template <typename Tuple>
  void debug(Tuple&& t,
             const std::source_location& loc = std::source_location::current());
  

  或

  template <typename ... Ts>
  void debug(const std::tuple<Ts...>& t,
             const std::source_location& loc = std::source_location::current());
  

  有用法

  debug(std::make_tuple(42));
  

  Demo

Answer 5

不是一个很好的解决方案，但是...将可变参数放在 std::tuple 中怎么样？

我的意思是……像

template <typename... Args>
void debug (std::tuple<Args...> && t_args,
            std::source_location const & loc = std::source_location::current());

不幸的是，这样你必须显式调用std::make_tuple来调用它

debug(std::make_tuple(1, 2l, 3ll));

Answer 6

你可以试试：

#include <iostream>
#include <experimental/source_location>

struct log
{
  log(std::experimental::source_location location = std::experimental::source_location::current()) : location { location } {}

  template<typename... Args>
  void operator() (Args... args)
  {
    std::cout << location.function_name() << std::endl;
    std::cout << location.line() << std::endl;
  }

  std::experimental::source_location location;
};

int main() 
{
  log()("asdf");
  log()(1);
}

DEMO