UT_UniversalLogSink.h

Go to the documentation of this file.

/*
 * PROPRIETARY INFORMATION.  This software is proprietary to
 * Side Effects Software Inc., and is not to be reproduced,
 * transmitted, or disclosed in any way without written permission.
 *
 * NAME:        UT_UniversalLogSink.h ( FS Library, C++)
 *
 * COMMENTS:
 *
 */

#ifndef __UT_UniversalLogSink__
#define __UT_UniversalLogSink__

#include "UT_API.h"
#include "UT_Function.h"
#include "UT_Lock.h"
#include "UT_SharedPtr.h"
#include "UT_StringSet.h"
#include "UT_UniversalLogEntry.h"

class UT_StringArray;
class UT_StringHolder;
class UT_UniversalLogFileSink;
class UT_UniversalLogInMemorySink;

/// This class exists to amalgamate logging information from a variety of
/// sources (UT_UniversalLogSource objects). Log entries can be fetched and
/// filtered to present the user with just the logging they are interested in.
class UT_API UT_UniversalLogSink
{
public:
    using LogEntryFilterCallback = UT_Function<bool(
            const UT_UniversalLogEntry&)>;

                         UT_UniversalLogSink();
    virtual             ~UT_UniversalLogSink();

    /// Each sink creates its own source objects, and can only have one source
    /// of any given type.
    void                 connect(const UT_StringHolder &source_name);
    void                 disconnect(const UT_StringHolder &source_name);
    void                 disconnectAll();
    void                 getConnectedSourceNames(UT_StringArray &source_names);

    void setFilterEntryCallback(const LogEntryFilterCallback &callback)
    { myLogEntryFilterCallback = callback; }

    /// Record a message from a log source.
    void                 log(const UT_UniversalLogEntry &entry);

protected:
    virtual void         doLog(const UT_UniversalLogEntry &entry) = 0;

private:
    UT_StringSet                 mySources;
    UT_Lock                      mySourcesLock;
    LogEntryFilterCallback       myLogEntryFilterCallback;
};

// Functions related to the default in memory and file logs.
UT_API bool
UThasAnyDefaultLogInMemorySources();
UT_API bool
UThasAnyDefaultLogFileSources();
UT_API bool
UTisDefaultLogInMemorySource(const UT_StringRef &source_name);
UT_API bool
UTisDefaultLogFileSource(const UT_StringRef &source_name);
UT_API const UT_SharedPtr<UT_UniversalLogInMemorySink> &
UTgetDefaultLogInMemorySink(bool create_from_env, bool force_create);
UT_API const UT_SharedPtr<UT_UniversalLogFileSink> &
UTgetDefaultLogFileSink(bool create);

#endif