logger_widget.h

Go to the documentation of this file.

// MIT License
// 
// Copyright (c) 2019 Ruhr University Bochum, Chair for Embedded Security. All Rights reserved.
// Copyright (c) 2019 Marc Fyrbiak, Sebastian Wallat, Max Hoffmann ("ORIGINAL AUTHORS"). All rights reserved.
// Copyright (c) 2021 Max Planck Institute for Security and Privacy. All Rights reserved.
// Copyright (c) 2021 Jörn Langheinrich, Julian Speith, Nils Albartus, René Walendy, Simon Klix ("ORIGINAL AUTHORS"). All Rights reserved.
// 
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
// 
// The above copyright notice and this permission notice shall be included in all
// copies or substantial portions of the Software.
// 
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
// SOFTWARE.
 
#pragma once
 
#include "gui/channel_manager/channel_item.h"
#include "gui/content_widget/content_widget.h"
#include "hal_core/utilities/log.h"
#include "gui/gui_utils/graphics.h"
#include "gui/searchbar/searchoptions.h"
 
#include <QLabel>
#include <QMenu>
#include <QPlainTextEdit>
#include <QString>
#include <QToolButton>
#include <QWidget>
#include <QtCore/qreadwritelock.h>
#include <QScrollBar>
#include <QPushButton>
 
namespace hal
{
    class LoggerMarshall;
    class ChannelSelector;
    class Searchbar;
 
    class LoggerWidget : public ContentWidget
    {
        Q_OBJECT
        Q_PROPERTY(QString searchIconPath READ searchIconPath WRITE setSearchIconPath)
        Q_PROPERTY(QString searchIconStyle READ searchIconStyle WRITE setSearchIconStyle)
 
    public:
        LoggerWidget(QWidget* parent = nullptr);
        ~LoggerWidget() override;
 
        virtual void setupToolbar(Toolbar* toolbar) override;
 
        QPlainTextEdit* getPlainTextEdit();
 
        void resizeEvent(QResizeEvent* event) override;
 
        QString searchIconPath() const;
 
        QString searchIconStyle() const;
 
        void setSearchIconPath(const QString &path);
 
        void setSearchIconStyle(const QString &style);
 
    public Q_SLOTS:
        void handleCurrentChannelUpdated(spdlog::level::level_enum t, QString const& msg);
 
        void handleChannelUpdated(spdlog::level::level_enum t, const std::string& logger_name, std::string const& msg);
 
        void handleCurrentFilterChanged(int p);
 
        void handleSeverityChanged(bool state);
 
        void handleSearchChanged(QString filter, int SearchOptions);
 
        void handleFirstUserInteraction(int value);
 
        void handleCustomChannel();
 
        void toggleSearchbar();
        bool isMatching(QString searchString, QString stringToCheck);
 
    private:
        Searchbar* mSearchbar;
        SearchOptions mSearchOptions;
        QAction* mSearchAction;
 
        QString mSearchIconPath;
        QString mSearchIconStyle;
 
        void saveSettings();
        void restoreSettings();
 
        void scrollToBottom();
 
        QPlainTextEdit* mPlainTextEdit;
 
        ChannelSelector* mSelector;
        QLabel* mChannelLabel;
 
        QPushButton* mMuteButton;
        QPushButton* mVerboseButton;
        QPushButton* mDebugButton;
        QPushButton* mInfoButton;
        QPushButton* mWarningButton;
        QPushButton* mErrorButton;
 
        bool mInfoSeverity;
        bool mWarningSeverity;
        bool mErrorSeverity;
        bool mDebugSeverity;
 
        QString mSearchFilter;
 
        LoggerMarshall* mLogMarshall;
        int mCurrentChannelIndex = -2;
        std::string mCurrentChannel;
        QReadWriteLock mLock;
        QScrollBar* mPlainTextEditScrollbar;
        bool mUserInteractedWithScrollbar;
    };
}