TerminalHelper.h

 
#ifndef MFRAME_E78A4B41_6A12_45BD_B662_73EDE44F403A
#define MFRAME_E78A4B41_6A12_45BD_B662_73EDE44F403A
 
/* ***************************************************************************************
 * Include
 */
 
//----------------------------------------------------------------------------------------
#include "../lang/Object.h"
#include "./../term/TerminalListener.h"
#include "./../util/Collection.h"
 
//----------------------------------------------------------------------------------------
 
/* ***************************************************************************************
 * Namespace
 */
namespace ufm::term {
  class TerminalHelper;
}  // namespace ufm::term
 
/* ***************************************************************************************
 * Class/Interface/Struct/Enum
 */
 
class ufm::term::TerminalHelper : public ufm::lang::Object,
                                  public ufm::term::TerminalListener {
  /* *************************************************************************************
   * Variable
   */
 private:
  ufm::util::Collection<ufm::term::TerminalListener*>&
              vListeners;  
  const char* vIndexName;  
 
  /* *************************************************************************************
   * Abstract Method
   */
 
  /* *************************************************************************************
   * Construct Method
   */
 public:
  TerminalHelper(ufm::util::Collection<ufm::term::TerminalListener*>& listeners,
                 const char* indexName = "") noexcept;
 
  virtual ~TerminalHelper(void) override;
 
  /* *************************************************************************************
   * Operator Method
   */
 
  /* *************************************************************************************
   * Override - ufm::term::TerminalListener
   */
 public:
  virtual const char* getCommand(void) const override;
 
  virtual const char* getDescription(void) const override;
 
  virtual bool onCommand(ufm::util::LineReader&      lineReader,
                         ufm::term::TerminalControl& control) override;
 
  virtual bool onTabComplete(ufm::util::LineReader&      lineReader,
                             ufm::lang::Appendable&      appendable,
                             ufm::term::TerminalControl& control) override;
 
  /* *************************************************************************************
   * Public Method
   */
 public:
  inline void setIndexName(const char* indexName) {
    this->vIndexName = (indexName == nullptr) ? "" : indexName;
    return;
  }
 
  const char* getIndexName(void) const {
    return this->vIndexName;
  }
 
  /* *************************************************************************************
   * Protected Method
   */
 
  /* *************************************************************************************
   * Private Method
   */
 private:
  int showMatch(ufm::io::PrintStream& out, const char* key);
 
  /* *************************************************************************************
   * Static Variable
   */
 
  /* *************************************************************************************
   * Static Method
   */
};
 
/* ***************************************************************************************
 * End of file
 */
 
#endif /* MFRAME_E78A4B41_6A12_45BD_B662_73EDE44F403A */