TerminalIndex.h

 
#ifndef MFRAME_9F073801_76A1_4702_AB62_31A0D6EF56A5
#define MFRAME_9F073801_76A1_4702_AB62_31A0D6EF56A5
 
/* ***************************************************************************************
 * Include
 */
 
//----------------------------------------------------------------------------------------
#include "./../lang/Object.h"
#include "./../term/TerminalControl.h"
#include "./../term/TerminalHelper.h"
#include "./../util/PArraySet.h"
 
//----------------------------------------------------------------------------------------
 
/* ***************************************************************************************
 * Namespace
 */
namespace ufm::term {
  class TerminalIndex;
}  // namespace ufm::util
 
/* ***************************************************************************************
 * Class/Interface/Struct/Enum
 */
 
class ufm::term::TerminalIndex : public ufm::lang::Object,
                                 public ufm::term::TerminalListener,
                                 public ufm::lang::NonCopyable {
  /* *************************************************************************************
   * Variable
   */
 private:
  ufm::util::PArraySet      vListenerSet;   
  ufm::term::TerminalHelper vHelper;        
  const char*               vName;          
  const char*               vDescription;   
 
  /* *************************************************************************************
   * Abstract Method
   */
 
  /* *************************************************************************************
   * Construct Method
   */
 public:
  TerminalIndex(ufm::util::PArraySet pArraySet,
                const char*          name        = "",
                const char*          description = "") noexcept;
 
  inline TerminalIndex(int         length      = 16,
                       const char* name        = "",
                       const char* description = "")
      : TerminalIndex(ufm::util::PArraySet(length), name, description) {
    return;
  }
 
  inline TerminalIndex(ufm::lang::Memory memory,
                       const char*       name        = "",
                       const char*       description = "")
      : TerminalIndex(ufm::util::PArraySet(static_cast<ufm::lang::Memory&&>(memory)),
                      name,
                      description) {
    return;
  }
 
  virtual ~TerminalIndex(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:
  bool addListener(ufm::term::TerminalListener& listener);
 
  ufm::term::TerminalListener* removeListener(const char* command);
 
  bool removeListener(ufm::term::TerminalListener& listener);
 
  void clear(void);
 
  inline void setName(const char* name) {
    this->vName = (name == nullptr) ? "" : name;
    this->vHelper.setIndexName(name);
    return;
  }
 
  inline const char* getName(void) const {
    return this->vName;
  }
 
  inline void setDescription(const char* description) {
    this->vDescription = (description == nullptr) ? "" : description;
  }
 
  /* *************************************************************************************
   * Protected Method
   */
 
  /* *************************************************************************************
   * Private Method
   */
 
  /* *************************************************************************************
   * Static Variable
   */
 
  /* *************************************************************************************
   * Static Method
   */
};
 
/* ***************************************************************************************
 * End of file
 */
 
#endif /* MFRAME_9F073801_76A1_4702_AB62_31A0D6EF56A5 */