TextException.h

Go to the documentation of this file.

/*
 * Copyright (C) 1996-2025 The Squid Software Foundation and contributors
 *
 * Squid software is distributed under GPLv2+ license and includes
 * contributions from numerous individuals and organizations.
 * Please see the COPYING and CONTRIBUTORS files for details.
 */
 
#ifndef SQUID_SRC_BASE_TEXTEXCEPTION_H
#define SQUID_SRC_BASE_TEXTEXCEPTION_H
 
#include "base/Assure.h"
#include "base/Here.h"
 
#include <stdexcept>
 
class SBuf;
 
class TextException: public std::runtime_error
{
 
public:
    TextException(const char *message, const SourceLocation &location):
        std::runtime_error(message),
        where(location)
    {}
 
    TextException(SBuf message, const SourceLocation &location);
 
    TextException(const TextException &) = default;
    TextException(TextException &&) = default;
    TextException& operator=(const TextException &) = default;
 
    /* std::runtime_error API */
    ~TextException() throw() override;
    const char *what() const throw() override;
 
    SourceLocationId id() const { return where.id(); }
 
    std::ostream &print(std::ostream &) const;
 
    SourceLocation where;
 
    // TODO: Add support for arbitrary (re)thrower-supplied details:
    // std::tuple<Details...> details;
};
 
std::ostream &CurrentException(std::ostream &);
 
std::ostream &CurrentExceptionExtra(std::ostream &);
 
std::ostream &operator <<(std::ostream &, const TextException &);
 
#define TexcHere(msg) TextException((msg), Here())
 
#define Must3(condition, description, location) \
    Assure_(3, (condition), ("check failed: " description), (location))
 
#define Must(condition) Must3((condition), #condition, Here())
 
#define SWALLOW_EXCEPTIONS(code) \
    try { \
        code \
    } catch (...) { \
        debugs(0, DBG_IMPORTANT, "ERROR: Squid BUG: ignoring exception;" << \
               Debug::Extra << "bug location: " << Here() << \
               Debug::Extra << "ignored exception: " << CurrentException); \
    }
 
#endif /* SQUID_SRC_BASE_TEXTEXCEPTION_H */