user_feedback.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 "hal_core/defines.h"
 
#include <atomic>
#include <string>
 
namespace hal
{
    class UIPluginInterface;
 
    namespace user_feedback
    {
        void report_progress(int percent, const std::string& message);
 
        class LayoutLocker
        {
        public:
            LayoutLocker();
            ~LayoutLocker();
 
            LayoutLocker(const LayoutLocker&)            = delete;
            LayoutLocker& operator=(const LayoutLocker&) = delete;
 
        private:
            UIPluginInterface* m_ui_plugin;
        };
 
        class ProgressScope
        {
        public:
            explicit ProgressScope(const std::string& message);
 
            ~ProgressScope();
 
            ProgressScope(const ProgressScope&)            = delete;
            ProgressScope& operator=(const ProgressScope&) = delete;
 
        private:
            static std::atomic<u32> s_depth;
        };
 
        class ProgressPrinter
        {
        public:
            explicit ProgressPrinter(const std::string& message, u32 max_detail_size = 0);
 
            ~ProgressPrinter();
 
            ProgressPrinter(const ProgressPrinter&)            = delete;
            ProgressPrinter& operator=(const ProgressPrinter&) = delete;
 
            void report(float progress, const std::string& detail = "");
 
            void set_message(const std::string& message);
 
            void clear();
 
            void reset();
 
        private:
            static int get_terminal_width();
 
            ProgressScope m_scope;
 
            std::string m_message;
 
            std::string m_last_detail;
 
            u32 m_printed_progress;
 
            u32 m_bar_width;
 
            u32 m_max_detail_size;
 
            int m_last_percentage;
 
            int m_terminal_width;
        };
    }    // namespace user_feedback
}    // namespace hal