prompt.hpp

Go to the documentation of this file.

/*
* cpp-terminal
* C++ library for writing multi-platform terminal applications.
*
* SPDX-FileCopyrightText: 2019-2024 cpp-terminal
*
* SPDX-License-Identifier: MIT
*/
 
#pragma once
 
#include "cpp-terminal/terminal.hpp"
#include "cpp-terminal/window.hpp"
 
#include <functional>
 
namespace Term
{
 
// indicates the results of prompt_blocking() and prompt_non_blocking
enum class Result
{
  Yes,     
  No,      
  Error,   
  None,    
  Abort,   
  Invalid  
};
 
Result prompt(const std::string& message, const std::string& first_option, const std::string& second_option, const std::string& prompt_indicator, bool);
 
// indicates the results of prompt_simple()
enum class Result_simple
{
 
  Yes,   
  No,    
  Abort  
};
 
Result_simple prompt_simple(const std::string& message);
 
/* Multiline prompt */
 
// This model contains all the information about the state of the prompt in an
// abstract way, irrespective of where or how it is rendered.
class Model
{
public:
  std::string              prompt_string;  // The string to show as the prompt
  std::vector<std::string> lines{""};      // The current input string in the prompt as a vector of lines, without '\n' at the end.
  // The current cursor position in the "input" string, starting from (1,1)
  std::size_t              cursor_col{1};
  std::size_t              cursor_row{1};
};
 
std::string concat(const std::vector<std::string>&);
 
std::vector<std::string> split(const std::string&);
 
void print_left_curly_bracket(Term::Window&, const std::size_t&, const std::size_t&, const std::size_t&);
 
void render(Term::Window&, const Model&, const std::size_t&);
 
std::string prompt_multiline(const std::string&, std::vector<std::string>&, std::function<bool(std::string)>&);
}  // namespace Term