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::cmdio {
 
void SetOutputLimit(OutputDetail limit);
 
void DoOutput(bool do_output);
 
void Output(const std::string& str, OutputDetail detail);
 
inline void DebugOutput(const std::string& str) {
  Output(str, OutputDetail::kDebug);
}
 
inline void InfoOutput(const std::string& str) {
  Output(str, OutputDetail::kInfo);
}
 
inline void WarningOutput(const std::string& str) {
  Output(str, OutputDetail::kWarning);
}
 
inline void ErrorOutput(const std::string& str) {
  Output(str, OutputDetail::kError);
}
 
inline void SystemOutput(const std::string& str) {
  Output(str, OutputDetail::kSystem);
}
 
void SpacedOutput(const std::string& str, OutputDetail detail);
 
template <typename... Args>
void OutputF(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>
inline void DebugOutputF(const std::format_string<Args...> str,
                         Args&&... args) {
  OutputF(OutputDetail::kDebug, str, std::forward<Args>(args)...);
}
 
template <typename... Args>
inline void InfoOutputF(const std::format_string<Args...> str, Args&&... args) {
  OutputF(OutputDetail::kInfo, str, std::forward<Args>(args)...);
}
 
template <typename... Args>
inline void WarningOutputF(const std::format_string<Args...> str,
                           Args&&... args) {
  OutputF(OutputDetail::kWarning, str, std::forward<Args>(args)...);
}
 
template <typename... Args>
inline void ErrorOutputF(const std::format_string<Args...> str,
                         Args&&... args) {
  OutputF(OutputDetail::kError, str, std::forward<Args>(args)...);
}
 
template <typename... Args>
inline void SystemOutputF(const std::format_string<Args...> str,
                          Args&&... args) {
  OutputF(OutputDetail::kSystem, str, std::forward<Args>(args)...);
}
 
template <typename... Args>
void SpacedOutputF(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);
}
 
void OutputCenter(const std::string& str, OutputDetail detail);
 
void OutputRight(const std::string& str, OutputDetail detail);
 
void OutputNewLine(int num, OutputDetail detail);
 
void OutputHorizontalLine(const std::string& line_visual, OutputDetail detail);
 
void OutputTitle(const std::string& title_name, bool output_copy_right = false);
 
void WaitAnyKey(const std::string& str = "Waiting for input.");
 
int InputInt(int min, int max, int default_num,
             const std::string& str = "Please enter an integer.");
 
bool InputYesNo(const std::string& str = "Are you sure?");
 
std::string InputDirName(
    const std::string& str =
        "Enter a directory name. (Japanese is not recommended).");
 
constexpr int kHorizontalLineLength = 100;  
 
}  // namespace designlab::cmdio
 
#endif  // DESIGNLAB_CMDIO_UTIL_H_