cmdio_util.h

[詳解]

 
 
// Copyright(c) 2023-2025 Design Engineering Laboratory, Saitama University
// Released under the MIT license
// https://opensource.org/licenses/mit-license.php
 
#ifndef DESIGNLAB_CMDIO_UTIL_H_
#define DESIGNLAB_CMDIO_UTIL_H_
 
#include <format>
#include <string>
#include <utility>
 
#include "boot_mode.h"
#include "output_detail.h"
 
 
// ----------------------------------------------------------------
//
// 色付きで出力をしたくない場合，あるいはうまく動作しない場合は，
// 以下のマクロをコメントアウトすること．
//
// ----------------------------------------------------------------
 
#define DESIGNLAB_USE_COLOR_OUTPUT
 
 
namespace designlab
{
 
class CmdIOUtil final
{
public:
    CmdIOUtil() = delete;                               
    CmdIOUtil(const CmdIOUtil&) = delete;               
    CmdIOUtil& operator=(const CmdIOUtil&) = delete;    
    CmdIOUtil(CmdIOUtil&&) = delete;                    
 
 
    static void SetOutputLimit(OutputDetail limit);
 
    static void DoOutput(bool do_output);
 
 
    static void Output(const std::string& str, OutputDetail detail);
 
    static inline void DebugOutput(const std::string& str)
    {
        Output(str, OutputDetail::kDebug);
    }
 
    static inline void InfoOutput(const std::string& str)
    {
        Output(str, OutputDetail::kInfo);
    }
 
    static inline void WarningOutput(const std::string& str)
    {
        Output(str, OutputDetail::kWarning);
    }
 
    static inline void ErrorOutput(const std::string& str)
    {
        Output(str, OutputDetail::kError);
    }
 
    static inline void SystemOutput(const std::string& str)
    {
        Output(str, OutputDetail::kSystem);
    }
 
    template <typename... Args>
    static void FormatOutput(OutputDetail detail, const std::format_string<Args...> str, Args&&... args)
    {
        const std::string formatted_str = std::format(str, std::forward<Args>(args)...);
        Output(formatted_str, detail);
    }
 
    template <typename... Args>
    static void SpacedFormatOutput(OutputDetail detail, const std::format_string<Args...> str, Args&&... args)
    {
        const std::string formatted_str = std::format(str, std::forward<Args>(args)...);
        SpacedOutput(formatted_str, detail);
    }
 
    static void SpacedOutput(const std::string& str, OutputDetail detail);
 
    static void OutputCenter(const std::string& str, OutputDetail detail);
 
    static void OutputRight(const std::string& str, OutputDetail detail);
 
 
    static void OutputNewLine(int num, OutputDetail detail);
 
    static void OutputHorizontalLine(
        const std::string& line_visual, OutputDetail detail);
 
    static void OutputTitle(const std::string& title_name, bool output_copy_right = false);
 
 
    static void WaitAnyKey(const std::string& str = "Waiting for input.");
 
    static int InputInt(int min, int max, int default_num, const std::string& str = "Please enter an integer.");
 
    static bool InputYesNo(const std::string& str = "Are you sure?");
 
    static std::string InputDirName(const std::string& str = "Enter a directory name. (Japanese is not recommended).");
 
private:
    static constexpr int kHorizontalLineLength = 100;  
 
    static OutputDetail output_limit;
 
    static bool do_output;
 
    static bool is_initialized;
};
 
}  // namespace designlab
 
 
#endif  // DESIGNLAB_CMDIO_UTIL_H_