LogTableModel.h

Go to the documentation of this file.

/*
* This file is part of ArmarX.
*
* ArmarX is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License version 2 as
* published by the Free Software Foundation.
*
* ArmarX is distributed in the hope that it will be useful, but
* WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
* @package    ArmarX::
* @author     Mirko Waechter ( mirko.waechter at kit dot edu)
* @date       2012
* @copyright  http://www.gnu.org/licenses/gpl-2.0.txt
*             GNU General Public License
*/
 
#pragma once
 
#include <QAbstractTableModel>
#include <QColor>
 
// ArmarX
#include <ArmarXCore/core/logging/Logging.h>
#include <ArmarXCore/core/services/tasks/RunningTask.h>
#include <ArmarXCore/interface/core/Log.h>
 
#include "LogMarkerRegistry.h"
 
// C++
#include <mutex>
#include <vector>
 
namespace armarx
{
    // Identifies a filterable log column. The integer values match the model's column
    // indices (see data() / headerData()).
    enum class LogColumn : int
    {
        Time = 0,
        Component = 1,
        Tag = 2,
        Verbosity = 3,
        Message = 4,
        File = 5,
        Function = 6,
        Group = 7,
        Unknown = -1
    };
 
    // How a filter value is compared against a column: as a substring (for manual,
    // user-typed filters) or as a whole-value match (for auto-generated per-component /
    // per-group filters, which must isolate exactly one component/group).
    enum class MatchMode
    {
        Contains,
        Exact
    };
 
    // A single active filter criterion: which column, the value to match against, and how.
    struct LogFilter
    {
        LogColumn column = LogColumn::Unknown;
        std::string value;
        MatchMode mode = MatchMode::Contains;
    };
 
    class LogTableModel : public QAbstractTableModel
    {
        Q_OBJECT
    public:
        enum class UserRoles : int
        {
            FullMsgRole = Qt::UserRole + 1
        };
 
        explicit LogTableModel(QObject* parent = 0);
        int rowCount(const QModelIndex& parent = QModelIndex()) const override;
        int columnCount(const QModelIndex& parent = QModelIndex()) const override;
        QVariant data(const QModelIndex& index, int role) const override;
        QVariant headerData(int section, Qt::Orientation orientation, int role) const override;
        bool setData(const QModelIndex& index, const QVariant& value, int role) override;
        Qt::ItemFlags flags(const QModelIndex& index) const override;
        void updateView();
        bool insertRows(int row, int count, const QModelIndex& parent) override;
 
        void addFilter(const std::string& columnName,
                       const std::string& filter,
                       MatchMode mode = MatchMode::Contains);
        void reapplyAllFilters();
        void resetFilters();
        bool rowContainsString(int row, const QString& searchStr) const;
        bool msgContainsString(const LogMessage& logMsg, QString searchStr) const;
 
        void search(const QString& searchStr);
 
        QString
        getCurrentSearchStr()
        {
            return activeSearchStr;
        }
 
        MessageType
        getMaxNewLogLevelType()
        {
            return maxNewLogLevelType;
        }
 
        int getColumn(const std::string& columnName) const;
        int clearData();
 
        //! Upper bound on retained log entries. 0 disables the bound. When the buffer
        //! grows past maxEntries by a small headroom factor, the oldest entries are
        //! trimmed back down to maxEntries.
        void setMaxEntries(std::size_t maxEntries);
 
        const std::vector<LogFilter>&
        getFilters() const
        {
            return activeFilters;
        }
 
        // thread-unsafe access!
        const LogMessage& getLogEntry(size_t row) const;
 
        //! Number of display lines of the message column for the given row (precomputed).
        int lineCountAt(int row) const;
 
        //! Attach the shared pin registry. The model then shows registry markers that are
        //! not already present as native rows (injected, in time position), colors pinned
        //! rows, and refreshes whenever the registry changes.
        void setMarkerRegistry(LogMarkerRegistry* registry);
 
        //! Display row of the (first) line identical to \p message, or -1 if not shown.
        int rowForMessage(const LogMessage& message) const;
 
        //! Whether this model holds \p message as a *native* (non-injected) row. Used by the
        //! viewer to expire pins once their source line has aged out of every buffer.
        bool containsNativeLine(const LogMessage& message) const;
 
        //! Whether the given display row is currently pinned (has a label color).
        bool isRowMarked(int row) const;
 
 
    signals:
 
    protected slots:
 
    public slots:
        bool addEntry(const LogMessage& entry, int* entriesAdded = NULL);
        int addEntries(const std::vector<LogMessage>& entryList, const QString& filterStr);
        //! Rebuild the set of injected pin rows and re-color native rows (full reset).
        void refreshMarkers();
 
    protected:
        bool applyFilter(const LogFilter& filter, const LogMessage& logMsg);
        bool applyFilters(const LogMessage& logMsg);
        //! Trim the oldest entries once the buffer exceeds its bound (see setMaxEntries).
        void enforceMaxEntries();
 
    private:
        //! A stored log message plus display data derived once at insert time, so the
        //! hot data() / rendering paths do not recompute it on every repaint.
        struct LogEntry
        {
            LogMessage message;
            QString timeString;         //!< formatted time column (0)
            QString displayMessage;     //!< truncated message column (4)
            int lineCount = 1;          //!< number of display lines in displayMessage
            bool matchesSearch = false; //!< whether the entry matches the active search
            bool injected = false;      //!< true if this is an injected pin (not native here)
            QColor markerColor;         //!< valid iff pinned; the pin's row background color
        };
 
        //! Build a LogEntry with all derived display fields (time/message/search/marker).
        LogEntry buildLogEntry(const LogMessage& message) const;
 
        QString activeSearchStr;
        int newEntryCount;
        MessageType maxNewLogLevelType;
        std::vector<LogFilter> activeFilters;
 
        //! Retained-entry bound; 0 disables it. Default matches the previous (never
        //! wired up) MAX_BUFFER_SIZE.
        std::size_t maxEntries = 10000;
 
        std::vector<LogEntry> logEntries;
        mutable std::mutex logEntriesMutex;
 
        //! Shared pin registry (non-owning); nullptr until setMarkerRegistry().
        LogMarkerRegistry* markerRegistry = nullptr;
 
        RunningTask<LogTableModel>::pointer_type searchResultTask;
    };
} // namespace armarx