如何用支持 LINE 和 FILE 的内联函数替换我的 C++ 异常宏？

Question

我目前正在阅读 Scott Meyers 的 Effective C++ 一书。它说对于类似函数的宏，我应该更喜欢 inline 函数而不是 #define。

现在我尝试编写一个内联函数来替换我的异常宏。我的旧宏看起来像这样：

#define __EXCEPTION(aMessage) \
{ \
    std::ostringstream stream; \
    stream << "EXCEPTION: " << aMessage << ", file " <<__FILE__ << " line " << __LINE__; \
    throw ExceptionImpl(stream.str()); \
}

我的新内联函数是这样的：

inline void __EXCEPTION(const std::string aMessage)
{
   std::ostringstream stream;
   stream << "EXCEPTION: " << aMessage << ", file " <<__FILE__ << " line " << __LINE__;
   throw ExceptionImpl(stream.str());
}

正如一些人可能已经预料到的那样，现在 __FILE__ 和 __LINE__ 宏没有用了，因为它们总是引用带有内联函数定义的 C++ 文件。

有什么办法可以避免这种行为，还是我应该坚持使用我的旧宏？我在这里阅读了这个主题，我已经怀疑我的第二个示例可能无法正常工作：

Behavior of __LINE__ in inline functions
__FILE__, __LINE__, and __FUNCTION__ usage in C++

Answer 1

不要使用 __（双下划线），因为它是保留的。有一个 inline 功能更好。
然而，这里你需要混合使用宏和函数，因此你可以执行以下操作：

#define MY_EXCEPTION(aMessage) MyException(aMessage, __FILE__, __LINE__) 

inline void MyException(const std::string aMessage,
                        const char* fileName,
                        const std::size_t lineNumber)
{
   std::ostringstream stream;
   stream << "EXCEPTION: " << aMessage << ", file " << fileName << " line " << lineNumber;
   throw ExceptionImpl(stream.str());
}

Answer 2

请注意，与 inline 函数相比，在您的案例中使用 #define 类似函数的宏还有另一个区别。您可以在宏的调用中使用流式运算符和参数来组成您的消息文本：

__EXCEPTION( "My message with a value " << val )

但大多数时候我需要这样的东西，它是为了检查特定条件（如断言）。所以你可以用类似的东西扩展@iammilind的例子：

#define MY_EXCEPTION_COND( cond )                  \
    if (bool(cond) == false)                       \
    {                                              \
        std::string _s( #cond " == false" );       \
        MyException(_s, __FILE__, __LINE__);       \
    }

或者一些更专业的东西，其中还打印了值：

template <typename T>
inline void MyExceptionValueCompare(const T&          a,
                                    const T&          b,
                                    const char*       fileName,
                                    const std::size_t lineNumber)
{
    if (a != b)
    {
        std::ostringstream stream;
        stream << "EXCEPTION: " << a << " != " << b << ", file " << fileName << " line " << lineNumber;
        throw ExceptionImpl(stream.str());
    }
}

#define MY_EXCEPTION_COMP( a, b )  MyExceptionValueCompare(a, b, __FILE__, __LINE__)

您可能想了解的另一种方法是 Microsoft 在 Microsoft::VisualStudio::CppUnitTestFramework 命名空间 (VC\UnitTest\Include\CppUnitTestAssert.h) 中使用其 __LineInfo class。参见 https://msdn.microsoft.com/en-us/library/hh694604.aspx

Answer 3

我看到这是一个老问题，但我认为在异常宏中打印该行的方法存在根本性缺陷，我认为我有更好的选择。我假设宏的使用类似于以下代码：

try {
    /// code 
    throw;
} 
catch (...) { __EXCEPTION(aMessage); }

使用这种方法，宏会打印异常 为 catch'ed 的位置。 但为了进行故障排除和调试，异常 为 throw'n 通常更有用。

要获取该信息，我们可以将 __FILE__ 和 __LINE__ 宏附加到异常。然而，我们仍然无法完全摆脱宏，但我们至少得到了准确的抛出位置：

#include <iostream>
#include <exception>
#include <string>

#define MY_THROW(msg) throw my_error(__FILE__, __LINE__, msg)

struct my_error : std::exception
{
    my_error(const std::string & f, int l, const std::string & m)
        :   file(f)
        ,   line(l)
        ,   message(m)
    {}
    std::string file;
    int line;
    std::string message;

    char const * what() const throw() { return message.c_str(); }
};

void my_exceptionhandler()
{
    try {
        throw; // re-throw the exception and capture the correct type
    } 
    catch (my_error & e)
    {
        std::cout << "Exception: " << e.what() << " in line: " << e.line << std::endl;
    }
}

int main()
{
    try {

        MY_THROW("error1");

    } catch(...) { my_exceptionhandler(); }
}

如果我们愿意使用 boost::exception，还有一个可能的改进：我们至少可以在我们自己的代码中摆脱宏定义。整个程序变得更短，代码执行和错误处理的位置可以很好地分开：

#include <iostream>
#include <boost/exception/all.hpp>

typedef boost::error_info<struct tag_error_msg, std::string> error_message;
struct error : virtual std::exception, virtual boost::exception { };
struct my_error:            virtual error { };

void my_exceptionhandler()
{
    using boost::get_error_info;

    try {
        throw;
    }
    catch(boost::exception & e)
    {
        char const * const * file = get_error_info<boost::throw_file>(e);
        int const * line = get_error_info<boost::throw_line>(e);
        char const * const * throw_func = get_error_info<boost::throw_function>(e);
        std::cout << diagnostic_information(e, false) 
                  << " in File: " << *file << "(" << *line << ")"
                     " in Function: " << *throw_func;
    }
}

int main()
{
    try {

        BOOST_THROW_EXCEPTION(my_error() << error_message("Test error"));

    } catch(...) { my_exceptionhandler(); }
}

Answer 4

使用 std::experimental::source_location，你可以这样做：

#include <experimental/source_location>

void THROW_EX(const std::string_view& message,
              const std::experimental::source_location& location
                  = std::experimental::source_location::current())
{
    std::ostringstream stream;
    stream << "EXCEPTION: " << message
           << ", file " << location.file_name()
           << " line " << location.line();
    throw ExceptionImpl(stream.str());
}

如何用支持 LINE 和 FILE 的内联函数替换我的 C++ 异常宏？

How can I replace my c++ exception macro with an inline function with LINE and FILE support?

c++

exception

macros

c-preprocessor

inline

如何用支持 __LINE__ 和 __FILE__ 的内联函数替换我的 C++ 异常宏？

How can I replace my c++ exception macro with an inline function with __LINE__ and __FILE__ support?

c++

exception

macros

c-preprocessor

inline

如何用支持 LINE 和 FILE 的内联函数替换我的 C++ 异常宏？

How can I replace my c++ exception macro with an inline function with LINE and FILE support?