ufm::term::TerminalCommandClearScreen 類別 參考文件

終端機清屏命令類別 更多...

#include <TerminalCommandClearScreen.h>

類別ufm::term::TerminalCommandClearScreen的繼承圖:

公開方法(Public Methods)
	TerminalCommandClearScreen (const char *command=TEXT_COMMAND) noexcept
	建構新的終端機清屏命令物件
virtual	~TerminalCommandClearScreen (void) override
	解構終端機清屏命令物件
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
	當按下 Tab 鍵時執行自動補全功能
公開方法(Public Methods) 繼承自 ufm::lang::Object
void *	operator new (size_t n)
	使用運算子 new 分配記憶體
void *	operator new (size_t n, void *p)
	在指定記憶體上調用運算子 new
virtual ufm::lang::Object &	getObject (void) override
	取得對應的 Object 物件
void	delay (int milliseconds) const
	延遲指定的毫秒數進行執行緒等待
bool	equals (Object *object) const
	判斷與另一物件是否為相同參照（指標型態比較）
bool	equals (Object &object) const
	判斷與另一物件是否為相同參照（參照型態比較）
void	wait (void) const
	使當前線程等待直到被通知
bool	wait (int timeout) const
	等待通知或超時
bool	yield (void) const
	讓執行緒讓渡控制權給同優先權的下一個執行緒
int	lock (void) const
	核心鎖定，鎖定期間禁止線程切換
int	unlock (void) const
	核心解鎖
ufm::sys::Thread *	currentThread (void) const
	取得當前執行緒指標
virtual int	hashcode (void) const
	返回對象的哈希碼值。支持這種方法是為了散列表，如HashMap提供的那樣。
公開方法(Public Methods) 繼承自 ufm::lang::Interface
virtual	~Interface (void)=default
	虛擬析構函式

靜態公開屬性
static constexpr const char *const	TEXT_COMMAND = "cls"
	預設命令名稱

詳細描述

終端機清屏命令類別

此類別實作了終端機的清屏功能，提供清除終端機螢幕內容的命令。 繼承自 ufm::lang::Object 和 ufm::term::TerminalListener， 作為終端機命令監聽器來處理清屏相關的操作。

• 預設命令名稱為 "cls"
• 支援 Tab 鍵自動補全功能
• 提供命令執行和描述功能

作者

ZxyKira

日期

2020

版本

1.0

建構子與解構子說明文件

TerminalCommandClearScreen()

ufm::term::TerminalCommandClearScreen::TerminalCommandClearScreen ( const char * command = TEXT_COMMAND )

noexcept

建構新的終端機清屏命令物件

初始化一個新的清屏命令物件，可以指定自訂的命令名稱。 如果未提供命令名稱，將使用預設的 "cls" 命令。

參數

command

命令字串，預設為 TEXT_COMMAND ("cls")

註

此建構子標記為 noexcept，保證不會拋出例外

~TerminalCommandClearScreen()

virtual ufm::term::TerminalCommandClearScreen::~TerminalCommandClearScreen ( void )

overridevirtual

解構終端機清屏命令物件

清理物件資源並執行必要的清理作業。 此解構子為虛擬函式，確保正確的多型解構行為。

函式成員說明文件

getCommand()

virtual const char * ufm::term::TerminalCommandClearScreen::getCommand ( void ) const

overridevirtual

取得命令名稱。

傳回值

const char* 命令名稱。

實作 ufm::term::TerminalListener.

getDescription()

virtual const char * ufm::term::TerminalCommandClearScreen::getDescription ( void ) const

overridevirtual

取得命令描述。

傳回值

const char* 命令描述。

實作 ufm::term::TerminalListener.

onCommand()

virtual bool ufm::term::TerminalCommandClearScreen::onCommand ( ufm::util::LineReader & lineReader, ufm::term::TerminalControl & control )

overridevirtual

執行命令。

參數

lineReader	當前行讀取器。
control	控制介面。

傳回值

true 執行成功。

false 執行失敗。

實作 ufm::term::TerminalListener.

onTabComplete()

virtual bool ufm::term::TerminalCommandClearScreen::onTabComplete ( ufm::util::LineReader & lineReader, ufm::lang::Appendable & appendable, ufm::term::TerminalControl & control )

overridevirtual

當按下 Tab 鍵時執行自動補全功能

當使用者在終端機中按下 Tab 鍵時，此方法會被呼叫來提供命令補全功能。 可以根據當前輸入的內容提供適當的補全建議。

參數

lineReader	當前行讀取器，包含使用者已輸入的內容
appendable	用於輸出補全結果的可附加介面
control	終端機控制介面，用於操作終端機狀態

傳回值

true 補全成功，已提供補全選項

false 補全失敗或無可用的補全選項

實作 ufm::term::TerminalListener.

---

此類別(class) 文件是由下列檔案中產生:

• TerminalCommandClearScreen.h