log_core.h

/*********************************************************************************************************************************************/
/*  DocWire SDK: Award-winning modern data processing in C++20. SourceForge Community Choice & Microsoft support. AI-driven processing.      */
/*  Supports nearly 100 data formats, including email boxes and OCR. Boost efficiency in text extraction, web data extraction, data mining,  */
/*  document analysis. Offline processing possible for security and confidentiality                                                          */
/*                                                                                                                                           */
/*  Copyright (c) SILVERCODERS Ltd, http://silvercoders.com                                                                                  */
/*  Project homepage: https://github.com/docwire/docwire                                                                                     */
/*                                                                                                                                           */
/*  SPDX-License-Identifier: GPL-2.0-only OR LicenseRef-DocWire-Commercial                                                                   */
/*********************************************************************************************************************************************/
 
#ifndef DOCWIRE_LOG_CORE_H
#define DOCWIRE_LOG_CORE_H
 
#include "core_export.h"
#include "serialization_base.h"
#include "source_location.h"
#include <functional>
#include <span>
#include <string>
#include <string_view>
 
namespace docwire::log
{
 
class DOCWIRE_CORE_EXPORT record
{
public:
    record(source_location location, serialization::array&& context);
    ~record();
 
    record(const record&) = delete;
    record& operator=(const record&) = delete;
 
    source_location m_location;
    serialization::array m_context;
};
 
DOCWIRE_CORE_EXPORT void set_filter(const std::string& filter_spec);
 
DOCWIRE_CORE_EXPORT std::string get_filter();
 
DOCWIRE_CORE_EXPORT void set_sink(std::function<void(const log::record&)> callback);
 
DOCWIRE_CORE_EXPORT std::function<void(const record&)> get_sink();
 
DOCWIRE_CORE_EXPORT serialization::object create_base_metadata(source_location location);
 
namespace detail
{
// This is an internal helper function for the log_entry macro.
DOCWIRE_CORE_EXPORT bool is_enabled(const source_location& location, std::span<const std::string_view> entry_tags);
DOCWIRE_CORE_EXPORT bool is_logging_enabled();
}
 
} // namespace docwire::log
 
#endif // DOCWIRE_LOG_CORE_H