终端类，实现一个基于 RamFS 的基本命令行接口 Terminal class implementing a basic command-line interface based on RamFS More...

#include <terminal.hpp>

Collaboration diagram for LibXR::Terminal< READ_BUFF_SIZE, MAX_LINE_SIZE, MAX_ARG_NUMBER, MAX_HISTORY_NUMBER >:

[legend]

Public Types
enum class	Mode : uint8_t { CRLF = 0 , LF = 1 , CR = 2 }
	终端换行模式 Line feed modes for the terminal More...

Public Member Functions
	Terminal (LibXR::RamFS &ramfs, RamFS::Dir current_dir=nullptr, ReadPort read_port=STDIO::read_, WritePort *write_port=STDIO::write_, Mode MODE=Mode::CRLF)
	终端构造函数，初始化文件系统、I/O 端口和当前目录 Constructor to initialize the terminal with file system, I/O ports, and current directory

void	LineFeed ()
	执行换行操作 Performs a line feed operation

void	UpdateDisplayPosition ()
	更新光标位置 Updates cursor position

bool	CanDisplayChar ()
	检查是否可以显示字符 Checks if a character can be displayed

bool	CanDeleteChar ()
	检查是否可以删除字符 Checks if a character can be deleted

void	AddCharToInputLine (char data)
	向输入行中添加字符，支持在光标位置插入 Adds a character to the input line, supports insertion at the cursor position

void	DisplayChar (char data)
	在终端上显示字符，并根据历史记录模式进行相应操作 Displays a character on the terminal and updates accordingly if history mode is active

void	RemoveCharFromInputLine ()
	从输入行中删除字符，支持在光标位置删除 Removes a character from the input line, supports deletion at the cursor position

void	DeleteChar ()
	处理删除字符操作，支持回退删除，并在历史模式下更新显示 Handles the delete character operation, supports backspace deletion, and updates display in history mode

void	ShowHeader ()
	显示终端提示符，包括当前目录信息 Displays the terminal prompt, including the current directory information

void	ClearLine ()
	清除当前行 Clears the current line

void	Clear ()
	清除整个终端屏幕 Clears the entire terminal screen

void	ShowHistory ()
	显示历史记录中的输入行，更新终端显示 Displays the input line from history and updates the terminal display

void	CopyHistoryToInputLine ()
	将历史命令复制到输入行，并重置历史索引和光标偏移 Copies the history command to the input line and resets history index and cursor offset

void	AddHistory ()
	将当前输入行添加到历史记录 Adds the current input line to the history

void	GetArgs ()
	解析输入行，将其拆分为参数数组 Parses the input line and splits it into argument array

RamFS::Dir *	Path2Dir (char *path)
	将路径字符串解析为目录对象 Converts a path string into a directory object

RamFS::File *	Path2File (char *path)
	将路径字符串解析为文件对象 Converts a path string into a file object

void	ExecuteCommand ()
	解析并执行输入的命令 Parses and executes the entered command

void	Parse (RawData &raw_data)
	解析输入数据流，将其转换为字符并处理 Parses the input data stream, converting it into characters and processing them

void	HandleAnsiCharacter (char data)
	解析输入数据流，将其转换为字符并处理 Parses the input data stream, converting it into characters and processing them

void	AutoComplete ()
	实现命令自动补全，匹配目录或文件名 Implements command auto-completion by matching directories or file names

void	HandleControlCharacter (char data)
	处理控制字符，包括换行、删除、制表符等 Handles control characters such as newline, delete, and tab

void	HandleCharacter (char data)
	处理输入字符，根据类型调用相应的处理函数 Handles input characters, dispatching them to the appropriate handler

Static Public Member Functions
static void	ThreadFun (Terminal *term)
	终端线程函数，以独立线程方式持续驱动终端 Terminal thread function, continuously drives the terminal as an independent thread

static void	TaskFun (Terminal *term)
	终端任务函数，以定时器任务方式驱动终端 Terminal task function, drives the terminal using a scheduled task

Data Fields
ReadOperation::OperationPollingStatus	read_status_

WriteOperation::OperationPollingStatus	write_status_

const Mode	MODE
	终端换行模式 Terminal line feed mode

WriteOperation	write_op_
	终端写操作 Terminal write operation

ReadPort *	read_
	读取端口 Read port

WritePort *	write_
	写入端口 Write port

RamFS &	ramfs_
	关联的文件系统 Associated file system

char	read_buff_ [READ_BUFF_SIZE]
	读取缓冲区 Read buffer

RamFS::Dir *	current_dir_
	当前目录 Current directory

uint8_t	flag_ansi_ = 0
	ANSI 控制字符状态 ANSI control character state.

int	offset_ = 0
	光标偏移 Cursor offset

Stack< char >	input_line_
	输入行缓冲区 Input line buffer

char *	arg_tab_ [MAX_ARG_NUMBER]
	命令参数列表 Command argument list

size_t	arg_number_ = 0
	参数数量 Number of arguments

Queue< LibXR::String< MAX_LINE_SIZE > >	history_
	历史命令 History of commands

int	history_index_ = -1
	当前历史索引 Current history index

bool	linefeed_flag_ = false
	换行标志 Line feed flag

Private Member Functions
char *	StrchrRev (char *str, char c)
	反向查找字符串中的特定字符 Finds a specific character in a string from the end

Static Private Attributes
static constexpr char	CLEAR_ALL []
	清屏命令 Clear screen command

static constexpr char	CLEAR_LINE []
	清除当前行命令 Clear current line command

static constexpr char	CLEAR_BEHIND []
	清除光标后内容命令 Clear content after cursor command

static constexpr char	KEY_RIGHT [] = "\033[C"
	右箭头键 Right arrow key

static constexpr char	KEY_LEFT [] = "\033[D"
	左箭头键 Left arrow key

static constexpr char	KEY_SAVE [] = "\033[s"
	保存光标位置 Save cursor position

static constexpr char	KEY_LOAD [] = "\033[u"
	恢复光标位置 Restore cursor position

static constexpr char	DELETE_CHAR []
	退格删除字符 Backspace delete character

Detailed Description

template<size_t READ_BUFF_SIZE = 32, size_t MAX_LINE_SIZE = READ_BUFF_SIZE, size_t MAX_ARG_NUMBER = 5, size_t MAX_HISTORY_NUMBER = 5>
class LibXR::Terminal< READ_BUFF_SIZE, MAX_LINE_SIZE, MAX_ARG_NUMBER, MAX_HISTORY_NUMBER >

终端类，实现一个基于 RamFS 的基本命令行接口 Terminal class implementing a basic command-line interface based on RamFS

Template Parameters

READ_BUFF_SIZE	读取缓冲区大小 Read buffer size
MAX_LINE_SIZE	最大输入行长度 Maximum input line size
MAX_ARG_NUMBER	最大参数数量 Maximum number of arguments
MAX_HISTORY_NUMBER	最大历史记录数量 Maximum number of command history records

Definition at line 30 of file terminal.hpp.

Member Enumeration Documentation

◆ Mode

template<size_t READ_BUFF_SIZE = 32, size_t MAX_LINE_SIZE = READ_BUFF_SIZE, size_t MAX_ARG_NUMBER = 5, size_t MAX_HISTORY_NUMBER = 5>

enum class LibXR::Terminal::Mode : uint8_t

strong

终端换行模式 Line feed modes for the terminal

Enumerator
CRLF	回车换行 Carriage Return + Line Feed (\r )
LF	仅换行 Line Feed ( )
CR	仅回车 Carriage Return (\r)

Definition at line 73 of file terminal.hpp.

  {
    CRLF = 0,  
    LF = 1,    
    CR = 2     
  };

Constructor & Destructor Documentation

◆ Terminal()

template<size_t READ_BUFF_SIZE = 32, size_t MAX_LINE_SIZE = READ_BUFF_SIZE, size_t MAX_ARG_NUMBER = 5, size_t MAX_HISTORY_NUMBER = 5>

LibXR::Terminal< READ_BUFF_SIZE, MAX_LINE_SIZE, MAX_ARG_NUMBER, MAX_HISTORY_NUMBER >::Terminal	(	LibXR::RamFS &	ramfs,
		RamFS::Dir *	current_dir = `nullptr`,
		ReadPort *	read_port = `STDIO::read_`,
		WritePort *	write_port = `STDIO::write_`,
		Mode	MODE = `Mode::CRLF`
	)

inline

终端构造函数，初始化文件系统、I/O 端口和当前目录 Constructor to initialize the terminal with file system, I/O ports, and current directory

Parameters

ramfs	关联的 RamFS 文件系统 Associated RamFS file system
current_dir	当前目录（默认为根目录）Current directory (default: root)
read_port	读取端口（默认使用标准输入）Read port (default: standard input)
write_port	写入端口（默认使用标准输出）Write port (default: standard output)
MODE	终端换行模式（默认 CRLF）Terminal line feed mode (default: CRLF)

Definition at line 90 of file terminal.hpp.

      : read_status_(ReadOperation::OperationPollingStatus::READY),
        write_status_(WriteOperation::OperationPollingStatus::READY),
        MODE(MODE),
        write_op_(write_status_),
        read_(read_port),
        write_(write_port),
        ramfs_(ramfs),
        current_dir_(current_dir ? current_dir : &ramfs_.root_),
        input_line_(MAX_LINE_SIZE + 1),
        history_(MAX_HISTORY_NUMBER)
  {
  }

Member Function Documentation

◆ AddCharToInputLine()

template<size_t READ_BUFF_SIZE = 32, size_t MAX_LINE_SIZE = READ_BUFF_SIZE, size_t MAX_ARG_NUMBER = 5, size_t MAX_HISTORY_NUMBER = 5>

void LibXR::Terminal< READ_BUFF_SIZE, MAX_LINE_SIZE, MAX_ARG_NUMBER, MAX_HISTORY_NUMBER >::AddCharToInputLine ( char data )

inline

向输入行中添加字符，支持在光标位置插入 Adds a character to the input line, supports insertion at the cursor position

Parameters

data	要添加的字符 The character to add

Definition at line 178 of file terminal.hpp.

  {
    if (offset_ == 0)
    {
      input_line_.Push(data);
    }
    else
    {
      input_line_.Insert(data, input_line_.Size() + offset_);
    }
    input_line_[input_line_.Size()] = '\0';
  }

◆ AddHistory()

template<size_t READ_BUFF_SIZE = 32, size_t MAX_LINE_SIZE = READ_BUFF_SIZE, size_t MAX_ARG_NUMBER = 5, size_t MAX_HISTORY_NUMBER = 5>

void LibXR::Terminal< READ_BUFF_SIZE, MAX_LINE_SIZE, MAX_ARG_NUMBER, MAX_HISTORY_NUMBER >::AddHistory ( )

inline

将当前输入行添加到历史记录 Adds the current input line to the history

Definition at line 350 of file terminal.hpp.

  {
    input_line_.Push('\0');
 
    if (history_.EmptySize() == 0)
    {
      history_.Pop();
    }
    history_.Push(*reinterpret_cast<String<MAX_LINE_SIZE> *>(&input_line_[0]));
  }

◆ AutoComplete()

template<size_t READ_BUFF_SIZE = 32, size_t MAX_LINE_SIZE = READ_BUFF_SIZE, size_t MAX_ARG_NUMBER = 5, size_t MAX_HISTORY_NUMBER = 5>

void LibXR::Terminal< READ_BUFF_SIZE, MAX_LINE_SIZE, MAX_ARG_NUMBER, MAX_HISTORY_NUMBER >::AutoComplete ( )

inline

实现命令自动补全，匹配目录或文件名 Implements command auto-completion by matching directories or file names

Definition at line 627 of file terminal.hpp.

  {
    /* skip space */
    char *path = &input_line_[0];
    while (*path == ' ')
    {
      path++;
    }
 
    /* find last '/' in first argument */
    char *tmp = path, *path_end = path;
 
    while (*tmp != ' ' && *tmp != '\0')
    {
      if (*tmp == '/')
      {
        path_end = tmp;
      }
      tmp++;
    }
 
    /* return if not need complete */
    if (tmp - &input_line_[0] != static_cast<int>(input_line_.Size() + offset_))
    {
      return;
    }
 
    /* get start of prefix */
    char *prefix_start = nullptr;
    RamFS::Dir *dir = nullptr;
 
    if (path_end == path)
    {
      dir = current_dir_;
      prefix_start = path_end;
    }
    else
    {
      prefix_start = path_end + 1;
    }
 
    /* find dir*/
    if (dir == nullptr)
    {
      *path_end = '\0';
      dir = Path2Dir(path);
      *path_end = '/';
      if (dir == nullptr)
      {
        return;
      }
    }
 
    /* prepre for match */
    RBTree<const char *>::Node<RamFS::FsNode> *ans_node = nullptr;
    uint32_t number = 0;
    size_t same_char_number = 0;
 
    if (*prefix_start == '/')
    {
      prefix_start++;
    }
 
    int prefix_len = static_cast<int>(tmp - prefix_start);
 
    auto foreach_fun_find = [&](RBTree<const char *>::Node<RamFS::FsNode> &node)
    {
      if (strncmp(node->name, prefix_start, prefix_len) == 0)
      {
        ans_node = &node;
        number++;
      }
 
      return ErrorCode::OK;
    };
 
    /* start match */
    (*dir)->rbt.Foreach<RamFS::FsNode>(foreach_fun_find);
 
    if (number == 0)
    {
      return;
    }
    else if (number == 1)
    {
      auto name_len = strlen(ans_node->data_.name);
      for (size_t i = 0; i < name_len - prefix_len; i++)
      {
        DisplayChar(ans_node->data_.name[i + prefix_len]);
      }
    }
    else
    {
      ans_node = nullptr;
      LineFeed();
 
      auto foreach_fun_show = [&](RBTree<const char *>::Node<RamFS::FsNode> &node)
      {
        if (strncmp(node->name, prefix_start, prefix_len) == 0)
        {
          auto name_len = strlen(node->name);
          (*this->write_)(ConstRawData(node->name, name_len), this->write_op_);
          this->LineFeed();
          if (ans_node == nullptr)
          {
            ans_node = &node;
            same_char_number = name_len;
            return ErrorCode::OK;
          }
 
          for (size_t i = 0; i < name_len; i++)
          {
            if (node->name[i] != ans_node->data_.name[i])
            {
              same_char_number = i;
              break;
            }
          }
 
          if (same_char_number > name_len)
          {
            name_len = same_char_number;
          }
 
          ans_node = &node;
        }
 
        return ErrorCode::OK;
      };
 
      (*dir)->rbt.Foreach<RamFS::FsNode>(foreach_fun_show);
 
      ShowHeader();
      (*write_)(ConstRawData(&input_line_[0], input_line_.Size()), write_op_);
 
      for (size_t i = 0; i < same_char_number - prefix_len; i++)
      {
        DisplayChar(ans_node->data_.name[i + prefix_len]);
      }
    }
  }

◆ CanDeleteChar()

template<size_t READ_BUFF_SIZE = 32, size_t MAX_LINE_SIZE = READ_BUFF_SIZE, size_t MAX_ARG_NUMBER = 5, size_t MAX_HISTORY_NUMBER = 5>

bool LibXR::Terminal< READ_BUFF_SIZE, MAX_LINE_SIZE, MAX_ARG_NUMBER, MAX_HISTORY_NUMBER >::CanDeleteChar ( )

inline

检查是否可以删除字符 Checks if a character can be deleted

Returns: bool 是否可以删除字符 Whether the character can be deleted

Definition at line 171 of file terminal.hpp.

171{ return input_line_.Size() + offset_ > 0; }

◆ CanDisplayChar()

template<size_t READ_BUFF_SIZE = 32, size_t MAX_LINE_SIZE = READ_BUFF_SIZE, size_t MAX_ARG_NUMBER = 5, size_t MAX_HISTORY_NUMBER = 5>

bool LibXR::Terminal< READ_BUFF_SIZE, MAX_LINE_SIZE, MAX_ARG_NUMBER, MAX_HISTORY_NUMBER >::CanDisplayChar ( )

inline

检查是否可以显示字符 Checks if a character can be displayed

Returns: bool 是否可以显示字符 Whether the character can be displayed

Definition at line 164 of file terminal.hpp.

164{ return input_line_.EmptySize() > 1; }

LibXR::Stack::EmptySize

uint32_t EmptySize() const

获取栈的剩余可用空间 / Returns the remaining available space in the stack

Definition stack.hpp:63

◆ Clear()

template<size_t READ_BUFF_SIZE = 32, size_t MAX_LINE_SIZE = READ_BUFF_SIZE, size_t MAX_ARG_NUMBER = 5, size_t MAX_HISTORY_NUMBER = 5>

void LibXR::Terminal< READ_BUFF_SIZE, MAX_LINE_SIZE, MAX_ARG_NUMBER, MAX_HISTORY_NUMBER >::Clear ( )

inline

清除整个终端屏幕 Clears the entire terminal screen

Definition at line 307 of file terminal.hpp.

307{ (*write_)(ConstRawData(CLEAR_ALL), write_op_); }

LibXR::Terminal::CLEAR_ALL

static constexpr char CLEAR_ALL[]

清屏命令 Clear screen command

Definition terminal.hpp:33

◆ ClearLine()

template<size_t READ_BUFF_SIZE = 32, size_t MAX_LINE_SIZE = READ_BUFF_SIZE, size_t MAX_ARG_NUMBER = 5, size_t MAX_HISTORY_NUMBER = 5>

void LibXR::Terminal< READ_BUFF_SIZE, MAX_LINE_SIZE, MAX_ARG_NUMBER, MAX_HISTORY_NUMBER >::ClearLine ( )

inline

清除当前行 Clears the current line

Definition at line 301 of file terminal.hpp.

301{ (*write_)(ConstRawData(CLEAR_LINE), write_op_); }

LibXR::Terminal::CLEAR_LINE

static constexpr char CLEAR_LINE[]

清除当前行命令 Clear current line command

Definition terminal.hpp:35

◆ CopyHistoryToInputLine()

template<size_t READ_BUFF_SIZE = 32, size_t MAX_LINE_SIZE = READ_BUFF_SIZE, size_t MAX_ARG_NUMBER = 5, size_t MAX_HISTORY_NUMBER = 5>

void LibXR::Terminal< READ_BUFF_SIZE, MAX_LINE_SIZE, MAX_ARG_NUMBER, MAX_HISTORY_NUMBER >::CopyHistoryToInputLine ( )

inline

将历史命令复制到输入行，并重置历史索引和光标偏移 Copies the history command to the input line and resets history index and cursor offset

Definition at line 335 of file terminal.hpp.

  {
    input_line_.Reset();
    for (size_t i = 0; i < history_[-history_index_ - 1].Length(); i++)
    {
      input_line_.Push(history_[-history_index_ - 1][i]);
    }
    history_index_ = -1;
    offset_ = 0;
  }

◆ DeleteChar()

template<size_t READ_BUFF_SIZE = 32, size_t MAX_LINE_SIZE = READ_BUFF_SIZE, size_t MAX_ARG_NUMBER = 5, size_t MAX_HISTORY_NUMBER = 5>

void LibXR::Terminal< READ_BUFF_SIZE, MAX_LINE_SIZE, MAX_ARG_NUMBER, MAX_HISTORY_NUMBER >::DeleteChar ( )

inline

处理删除字符操作，支持回退删除，并在历史模式下更新显示 Handles the delete character operation, supports backspace deletion, and updates display in history mode

Definition at line 248 of file terminal.hpp.

  {
    bool use_history = false;
 
    if (history_index_ >= 0)
    {
      CopyHistoryToInputLine();
      use_history = true;
    }
 
    if (CanDeleteChar())
    {
      RemoveCharFromInputLine();
      if (use_history)
      {
        ShowHistory();
      }
      else
      {
        (*write_)(ConstRawData(DELETE_CHAR), write_op_);
      }
 
      if (offset_ != 0)
      {
        UpdateDisplayPosition();
      }
    }
  }

◆ DisplayChar()

template<size_t READ_BUFF_SIZE = 32, size_t MAX_LINE_SIZE = READ_BUFF_SIZE, size_t MAX_ARG_NUMBER = 5, size_t MAX_HISTORY_NUMBER = 5>

void LibXR::Terminal< READ_BUFF_SIZE, MAX_LINE_SIZE, MAX_ARG_NUMBER, MAX_HISTORY_NUMBER >::DisplayChar ( char data )

inline

在终端上显示字符，并根据历史记录模式进行相应操作 Displays a character on the terminal and updates accordingly if history mode is active

Parameters

data	要显示的字符 The character to display

Definition at line 197 of file terminal.hpp.

  {
    bool use_history = false;
 
    if (history_index_ >= 0)
    {
      CopyHistoryToInputLine();
      use_history = true;
    }
 
    if (CanDisplayChar())
    {
      AddCharToInputLine(data);
      if (use_history)
      {
        ShowHistory();
      }
      else
      {
        (*write_)(ConstRawData(input_line_[input_line_.Size() - 1 + offset_]), write_op_);
      }
      if (offset_ != 0)
      {
        UpdateDisplayPosition();
      }
    }
  }

◆ ExecuteCommand()

template<size_t READ_BUFF_SIZE = 32, size_t MAX_LINE_SIZE = READ_BUFF_SIZE, size_t MAX_ARG_NUMBER = 5, size_t MAX_HISTORY_NUMBER = 5>

void LibXR::Terminal< READ_BUFF_SIZE, MAX_LINE_SIZE, MAX_ARG_NUMBER, MAX_HISTORY_NUMBER >::ExecuteCommand ( )

inline

解析并执行输入的命令 Parses and executes the entered command

Definition at line 467 of file terminal.hpp.

  {
    AddHistory();
 
    GetArgs();
 
    if (arg_number_ < 1 || arg_number_ > MAX_ARG_NUMBER)
    {
      return;
    }
 
    if (strcmp(arg_tab_[0], "cd") == 0)
    {
      RamFS::Dir *dir = Path2Dir(arg_tab_[1]);
      if (dir != nullptr)
      {
        current_dir_ = dir;
      }
      LineFeed();
      return;
    }
 
    if (strcmp(arg_tab_[0], "ls") == 0)
    {
      auto ls_fun = [&](RBTree<const char *>::Node<RamFS::FsNode> &item)
      {
        switch (item->type)
        {
          case RamFS::FsNodeType::DIR:
            (*(this->write_))(ConstRawData("d "), this->write_op_);
            break;
          case RamFS::FsNodeType::FILE:
            (*(this->write_))(ConstRawData("f "), this->write_op_);
            break;
          case RamFS::FsNodeType::DEVICE:
            (*(this->write_))(ConstRawData("c "), this->write_op_);
            break;
          case RamFS::FsNodeType::STORAGE:
            (*(this->write_))(ConstRawData("b "), this->write_op_);
            break;
          default:
            (*(this->write_))(ConstRawData("? "), this->write_op_);
            break;
        }
        (*(this->write_))(ConstRawData(item.data_.name), this->write_op_);
        this->LineFeed();
        return ErrorCode::OK;
      };
 
      current_dir_->data_.rbt.Foreach<RamFS::FsNode>(ls_fun);
      return;
    }
 
    auto ans = Path2File(arg_tab_[0]);
    if (ans == nullptr)
    {
      (*write_)(ConstRawData("Command not found."), write_op_);
      LineFeed();
      return;
    }
 
    if ((*ans)->type != RamFS::FileType::EXEC)
    {
      (*write_)(ConstRawData("Not an executable file."), write_op_);
      LineFeed();
      return;
    }
 
    (*ans)->Run(arg_number_, arg_tab_);
  }

◆ GetArgs()

template<size_t READ_BUFF_SIZE = 32, size_t MAX_LINE_SIZE = READ_BUFF_SIZE, size_t MAX_ARG_NUMBER = 5, size_t MAX_HISTORY_NUMBER = 5>

void LibXR::Terminal< READ_BUFF_SIZE, MAX_LINE_SIZE, MAX_ARG_NUMBER, MAX_HISTORY_NUMBER >::GetArgs ( )

inline

解析输入行，将其拆分为参数数组 Parses the input line and splits it into argument array

Definition at line 365 of file terminal.hpp.

  {
    for (int i = 0; input_line_[i] != '\0'; i++)
    {
      if (input_line_[i] == ' ')
      {
        input_line_[i] = '\0';
      }
      else if (i == 0 || input_line_[i - 1] == '\0')
      {
        if (arg_number_ >= MAX_ARG_NUMBER)
        {
          return;
        }
        arg_tab_[arg_number_++] = &input_line_[i];
      }
    }
  }

◆ HandleAnsiCharacter()

template<size_t READ_BUFF_SIZE = 32, size_t MAX_LINE_SIZE = READ_BUFF_SIZE, size_t MAX_ARG_NUMBER = 5, size_t MAX_HISTORY_NUMBER = 5>

void LibXR::Terminal< READ_BUFF_SIZE, MAX_LINE_SIZE, MAX_ARG_NUMBER, MAX_HISTORY_NUMBER >::HandleAnsiCharacter ( char data )

inline

解析输入数据流，将其转换为字符并处理 Parses the input data stream, converting it into characters and processing them

Parameters

raw_data 输入的原始数据 Input raw data

Definition at line 559 of file terminal.hpp.

  {
    if (flag_ansi_ == 1)
    {
      if (isprint(data))
      {
        flag_ansi_++;
      }
      else
      {
        flag_ansi_ = 0;
      }
    }
    else if (flag_ansi_ == 2)
    {
      switch (data)
      {
        case 'A':
          if (history_index_ < int(history_.Size()) - 1)
          {
            history_index_++;
            ShowHistory();
          }
          break;
        case 'B':
          if (history_index_ >= 0)
          {
            history_index_--;
            ShowHistory();
          }
          break;
        case 'C':
          if (history_index_ >= 0)
          {
            CopyHistoryToInputLine();
            ShowHistory();
          }
          if (offset_ < 0)
          {
            offset_++;
            (*write_)(ConstRawData(KEY_RIGHT, sizeof(KEY_RIGHT) - 1), write_op_);
          }
 
          break;
        case 'D':
          if (history_index_ >= 0)
          {
            CopyHistoryToInputLine();
            ShowHistory();
          }
          if (offset_ + input_line_.Size() > 0)
          {
            offset_--;
            (*write_)(ConstRawData(KEY_LEFT, sizeof(KEY_LEFT) - 1), write_op_);
          }
          break;
        default:
          break;
      }
 
      flag_ansi_ = 0;
    }
  }

◆ HandleCharacter()

template<size_t READ_BUFF_SIZE = 32, size_t MAX_LINE_SIZE = READ_BUFF_SIZE, size_t MAX_ARG_NUMBER = 5, size_t MAX_HISTORY_NUMBER = 5>

void LibXR::Terminal< READ_BUFF_SIZE, MAX_LINE_SIZE, MAX_ARG_NUMBER, MAX_HISTORY_NUMBER >::HandleCharacter ( char data )

inline

处理输入字符，根据类型调用相应的处理函数 Handles input characters, dispatching them to the appropriate handler

Parameters

data	输入的字符 The input character

Definition at line 824 of file terminal.hpp.

  {
    if (flag_ansi_)
    {
      HandleAnsiCharacter(data);
    }
    else if (isprint(data))
    {
      DisplayChar(data);
    }
    else
    {
      HandleControlCharacter(data);
    }
  }

◆ HandleControlCharacter()

template<size_t READ_BUFF_SIZE = 32, size_t MAX_LINE_SIZE = READ_BUFF_SIZE, size_t MAX_ARG_NUMBER = 5, size_t MAX_HISTORY_NUMBER = 5>

void LibXR::Terminal< READ_BUFF_SIZE, MAX_LINE_SIZE, MAX_ARG_NUMBER, MAX_HISTORY_NUMBER >::HandleControlCharacter ( char data )

inline

处理控制字符，包括换行、删除、制表符等 Handles control characters such as newline, delete, and tab

Parameters

data	输入的控制字符 The input control character

Definition at line 774 of file terminal.hpp.

  {
    if (data != '\r' && data != '\n')
    {
      linefeed_flag_ = false;
    }
 
    switch (data)
    {
      case '\n':
      case '\r':
        if (linefeed_flag_)
        {
          linefeed_flag_ = false;
          return;
        }
        if (history_index_ >= 0)
        {
          CopyHistoryToInputLine();
        }
        LineFeed();
        if (input_line_.Size() > 0)
        {
          ExecuteCommand();
          arg_number_ = 0;
        }
        ShowHeader();
        input_line_.Reset();
        input_line_[0] = '\0';
        offset_ = 0;
        break;
      case 0x7f:
        DeleteChar();
        break;
      case '\t':
        AutoComplete();
        break;
      case '\033':
        flag_ansi_ = 1;
        break;
      default:
        break;
    }
  }

◆ LineFeed()

template<size_t READ_BUFF_SIZE = 32, size_t MAX_LINE_SIZE = READ_BUFF_SIZE, size_t MAX_ARG_NUMBER = 5, size_t MAX_HISTORY_NUMBER = 5>

void LibXR::Terminal< READ_BUFF_SIZE, MAX_LINE_SIZE, MAX_ARG_NUMBER, MAX_HISTORY_NUMBER >::LineFeed ( )

inline

执行换行操作 Performs a line feed operation

Definition at line 130 of file terminal.hpp.

  {
    if (MODE == Mode::CRLF)
    {
      (*write_)(ConstRawData("\r\n"), write_op_);
    }
    else if (MODE == Mode::LF)
    {
      (*write_)(ConstRawData('\n'), write_op_);
    }
    else if (MODE == Mode::CR)
    {
      (*write_)(ConstRawData('\r'), write_op_);
    }
  }

◆ Parse()

template<size_t READ_BUFF_SIZE = 32, size_t MAX_LINE_SIZE = READ_BUFF_SIZE, size_t MAX_ARG_NUMBER = 5, size_t MAX_HISTORY_NUMBER = 5>

void LibXR::Terminal< READ_BUFF_SIZE, MAX_LINE_SIZE, MAX_ARG_NUMBER, MAX_HISTORY_NUMBER >::Parse ( RawData & raw_data )

inline

解析输入数据流，将其转换为字符并处理 Parses the input data stream, converting it into characters and processing them

Parameters

raw_data 输入的原始数据 Input raw data

Definition at line 544 of file terminal.hpp.

  {
    char *buff = static_cast<char *>(raw_data.addr_);
    for (size_t i = 0; i < raw_data.size_; i++)
    {
      HandleCharacter(buff[i]);
    }
  }

◆ Path2Dir()

template<size_t READ_BUFF_SIZE = 32, size_t MAX_LINE_SIZE = READ_BUFF_SIZE, size_t MAX_ARG_NUMBER = 5, size_t MAX_HISTORY_NUMBER = 5>

RamFS::Dir * LibXR::Terminal< READ_BUFF_SIZE, MAX_LINE_SIZE, MAX_ARG_NUMBER, MAX_HISTORY_NUMBER >::Path2Dir ( char * path )

inline

将路径字符串解析为目录对象 Converts a path string into a directory object

Parameters

path	目录路径字符串 The directory path string

Returns: RamFS::Dir* 解析出的目录指针，若找不到则返回 nullptr Pointer to the resolved directory, or nullptr if not found

Definition at line 391 of file terminal.hpp.

  {
    size_t index = 0;
    RamFS::Dir *dir = current_dir_;
 
    if (*path == '/')
    {
      index++;
      dir = &ramfs_.root_;
    }
 
    for (size_t i = 0; i < MAX_LINE_SIZE; i++)
    {
      auto tmp = strchr(path + index, '/');
      if (tmp == nullptr)
      {
        return dir->FindDir(path + index);
      }
      else if (tmp == path + index)
      {
        return nullptr;
      }
      else
      {
        tmp[0] = '\0';
        dir = dir->FindDir(path + index);
        tmp[0] = '/';
        index += tmp - path + 1;
        if (path[index] == '\0' || dir == nullptr)
        {
          return dir;
        }
      }
    }
 
    return nullptr;
  }

◆ Path2File()

template<size_t READ_BUFF_SIZE = 32, size_t MAX_LINE_SIZE = READ_BUFF_SIZE, size_t MAX_ARG_NUMBER = 5, size_t MAX_HISTORY_NUMBER = 5>

RamFS::File * LibXR::Terminal< READ_BUFF_SIZE, MAX_LINE_SIZE, MAX_ARG_NUMBER, MAX_HISTORY_NUMBER >::Path2File ( char * path )

inline

将路径字符串解析为文件对象 Converts a path string into a file object

Parameters

path	文件路径字符串 The file path string

Returns: RamFS::File* 解析出的文件指针，若找不到则返回 nullptr Pointer to the resolved file, or nullptr if not found

Definition at line 436 of file terminal.hpp.

  {
    auto name = StrchrRev(path, '/');
 
    if (name == nullptr)
    {
      return current_dir_->FindFile(path);
    }
 
    if (name[1] == '\0')
    {
      return nullptr;
    }
 
    *name = '\0';
    RamFS::Dir *dir = Path2Dir(path);
    *name = '/';
    if (dir != nullptr)
    {
      return dir->FindFile(name + 1);
    }
    else
    {
      return nullptr;
    }
  }

◆ RemoveCharFromInputLine()

template<size_t READ_BUFF_SIZE = 32, size_t MAX_LINE_SIZE = READ_BUFF_SIZE, size_t MAX_ARG_NUMBER = 5, size_t MAX_HISTORY_NUMBER = 5>

void LibXR::Terminal< READ_BUFF_SIZE, MAX_LINE_SIZE, MAX_ARG_NUMBER, MAX_HISTORY_NUMBER >::RemoveCharFromInputLine ( )

inline

从输入行中删除字符，支持在光标位置删除 Removes a character from the input line, supports deletion at the cursor position

Definition at line 230 of file terminal.hpp.

  {
    if (offset_ == 0)
    {
      input_line_.Pop();
    }
    else
    {
      input_line_.Delete(input_line_.Size() + offset_ - 1);
    }
    input_line_[input_line_.Size()] = '\0';
  }

◆ ShowHeader()

template<size_t READ_BUFF_SIZE = 32, size_t MAX_LINE_SIZE = READ_BUFF_SIZE, size_t MAX_ARG_NUMBER = 5, size_t MAX_HISTORY_NUMBER = 5>

void LibXR::Terminal< READ_BUFF_SIZE, MAX_LINE_SIZE, MAX_ARG_NUMBER, MAX_HISTORY_NUMBER >::ShowHeader ( )

inline

显示终端提示符，包括当前目录信息 Displays the terminal prompt, including the current directory information

Definition at line 281 of file terminal.hpp.

  {
    (*write_)(ConstRawData(ramfs_.root_->name, strlen(ramfs_.root_->name)), write_op_);
    if (current_dir_ == &ramfs_.root_)
    {
      (*write_)(ConstRawData(":/"), write_op_);
    }
    else
    {
      (*write_)(ConstRawData(":"), write_op_);
      (*write_)(ConstRawData(current_dir_->data_.name), write_op_);
    }
 
    (*write_)(ConstRawData("$ "), write_op_);
  }

◆ ShowHistory()

template<size_t READ_BUFF_SIZE = 32, size_t MAX_LINE_SIZE = READ_BUFF_SIZE, size_t MAX_ARG_NUMBER = 5, size_t MAX_HISTORY_NUMBER = 5>

void LibXR::Terminal< READ_BUFF_SIZE, MAX_LINE_SIZE, MAX_ARG_NUMBER, MAX_HISTORY_NUMBER >::ShowHistory ( )

inline

显示历史记录中的输入行，更新终端显示 Displays the input line from history and updates the terminal display

Definition at line 313 of file terminal.hpp.

  {
    ClearLine();
    ShowHeader();
    offset_ = 0;
    if (history_index_ >= 0)
    {
      (*write_)(ConstRawData(history_[-history_index_ - 1].Raw(),
                             history_[-history_index_ - 1].Length()),
                write_op_);
    }
    else
    {
      (*write_)(ConstRawData(&input_line_[0], input_line_.Size()), write_op_);
    }
  }

◆ StrchrRev()

template<size_t READ_BUFF_SIZE = 32, size_t MAX_LINE_SIZE = READ_BUFF_SIZE, size_t MAX_ARG_NUMBER = 5, size_t MAX_HISTORY_NUMBER = 5>

char * LibXR::Terminal< READ_BUFF_SIZE, MAX_LINE_SIZE, MAX_ARG_NUMBER, MAX_HISTORY_NUMBER >::StrchrRev	(	char *	str,
		char	c
	)

inlineprivate

反向查找字符串中的特定字符 Finds a specific character in a string from the end

Parameters

str	输入字符串 Input string
c	要查找的字符 Character to find

Returns: char* 指向找到的字符的指针，如果未找到返回 nullptr Pointer to the found character, nullptr if not found

Definition at line 54 of file terminal.hpp.

  {
    auto len = strlen(str);
    for (int i = static_cast<int>(len - 1); i >= 0; i--)
    {
      if (str[i] == c)
      {
        return str + i;
      }
    }
    return nullptr;
  }

◆ TaskFun()

template<size_t READ_BUFF_SIZE = 32, size_t MAX_LINE_SIZE = READ_BUFF_SIZE, size_t MAX_ARG_NUMBER = 5, size_t MAX_HISTORY_NUMBER = 5>

static void LibXR::Terminal< READ_BUFF_SIZE, MAX_LINE_SIZE, MAX_ARG_NUMBER, MAX_HISTORY_NUMBER >::TaskFun ( Terminal< READ_BUFF_SIZE, MAX_LINE_SIZE, MAX_ARG_NUMBER, MAX_HISTORY_NUMBER > * term )

inlinestatic

终端任务函数，以定时器任务方式驱动终端 Terminal task function, drives the terminal using a scheduled task

该函数用于以定时任务（或轮询方式）驱动终端，适用于资源受限的系统。它不会持续运行，而是在定时器触发或系统任务调度时运行，执行一次数据读取和解析后返回。

This function drives the terminal using a scheduled task (or polling mode), making it suitable for resource-constrained systems. Unlike the thread-based approach, it only runs when scheduled (e.g., triggered by a timer) and processes available input data before returning.

Parameters

term	指向 Terminal 实例的指针 Pointer to the Terminal instance

Definition at line 890 of file terminal.hpp.

  {
    RawData buff = term->read_buff_;
    buff.size_ = LibXR::min(LibXR::max(1u, term->read_->Size()), READ_BUFF_SIZE);
 
    ReadOperation op(term->read_status_);
 
    while (true)
    {
      switch (term->read_status_)
      {
        case ReadOperation::OperationPollingStatus::READY:
          buff.size_ = LibXR::min(LibXR::max(1u, term->read_->Size()), READ_BUFF_SIZE);
          (*term->read_)(buff, op);
          continue;
        case ReadOperation::OperationPollingStatus::RUNNING:
          return;
        case ReadOperation::OperationPollingStatus::DONE:
          buff.size_ = term->read_->read_size_;
          if (buff.size_ > 0)
          {
            term->Parse(buff);
          }
          buff.size_ = LibXR::min(LibXR::max(1u, term->read_->Size()), READ_BUFF_SIZE);
          (*term->read_)(buff, op);
          return;
      }
    }
  }

◆ ThreadFun()

template<size_t READ_BUFF_SIZE = 32, size_t MAX_LINE_SIZE = READ_BUFF_SIZE, size_t MAX_ARG_NUMBER = 5, size_t MAX_HISTORY_NUMBER = 5>

static void LibXR::Terminal< READ_BUFF_SIZE, MAX_LINE_SIZE, MAX_ARG_NUMBER, MAX_HISTORY_NUMBER >::ThreadFun ( Terminal< READ_BUFF_SIZE, MAX_LINE_SIZE, MAX_ARG_NUMBER, MAX_HISTORY_NUMBER > * term )

inlinestatic

终端线程函数，以独立线程方式持续驱动终端 Terminal thread function, continuously drives the terminal as an independent thread

该函数用于以独立线程的方式驱动终端，持续从输入流读取数据并解析，适用于高实时性应用。它会在循环中不断检查输入流的大小，并在数据可用时进行解析。

This function runs as a separate thread to continuously drive the terminal, reading and parsing input data in a loop. It is suitable for high real-time applications. It continuously checks the input stream size and processes data when available.

Parameters

term	指向 Terminal 实例的指针 Pointer to the Terminal instance

Definition at line 856 of file terminal.hpp.

  {
    RawData buff = term->read_buff_;
    buff.size_ = LibXR::min(LibXR::max(1u, term->read_->Size()), READ_BUFF_SIZE);
 
    Semaphore sem;
    ReadOperation op(sem);
 
    while (true)
    {
      buff.size_ = LibXR::min(LibXR::max(1u, term->read_->Size()), READ_BUFF_SIZE);
      if ((*term->read_)(buff, op) == ErrorCode::OK)
      {
        buff.size_ = term->read_->read_size_;
        term->Parse(buff);
      }
    }
  }

◆ UpdateDisplayPosition()

template<size_t READ_BUFF_SIZE = 32, size_t MAX_LINE_SIZE = READ_BUFF_SIZE, size_t MAX_ARG_NUMBER = 5, size_t MAX_HISTORY_NUMBER = 5>

void LibXR::Terminal< READ_BUFF_SIZE, MAX_LINE_SIZE, MAX_ARG_NUMBER, MAX_HISTORY_NUMBER >::UpdateDisplayPosition ( )

inline

更新光标位置 Updates cursor position

Definition at line 150 of file terminal.hpp.

  {
    (*write_)(ConstRawData(KEY_SAVE), write_op_);
    (*write_)(ConstRawData(CLEAR_BEHIND), write_op_);
    (*write_)(ConstRawData(&input_line_[input_line_.Size() + offset_], -offset_),
              write_op_);
    (*write_)(ConstRawData(KEY_LOAD), write_op_);
  }

Field Documentation

◆ arg_number_

template<size_t READ_BUFF_SIZE = 32, size_t MAX_LINE_SIZE = READ_BUFF_SIZE, size_t MAX_ARG_NUMBER = 5, size_t MAX_HISTORY_NUMBER = 5>

size_t LibXR::Terminal< READ_BUFF_SIZE, MAX_LINE_SIZE, MAX_ARG_NUMBER, MAX_HISTORY_NUMBER >::arg_number_ = 0

参数数量 Number of arguments

Definition at line 121 of file terminal.hpp.

◆ arg_tab_

template<size_t READ_BUFF_SIZE = 32, size_t MAX_LINE_SIZE = READ_BUFF_SIZE, size_t MAX_ARG_NUMBER = 5, size_t MAX_HISTORY_NUMBER = 5>

char* LibXR::Terminal< READ_BUFF_SIZE, MAX_LINE_SIZE, MAX_ARG_NUMBER, MAX_HISTORY_NUMBER >::arg_tab_[MAX_ARG_NUMBER]

命令参数列表 Command argument list

Definition at line 120 of file terminal.hpp.

◆ CLEAR_ALL

template<size_t READ_BUFF_SIZE = 32, size_t MAX_LINE_SIZE = READ_BUFF_SIZE, size_t MAX_ARG_NUMBER = 5, size_t MAX_HISTORY_NUMBER = 5>

constexpr char LibXR::Terminal< READ_BUFF_SIZE, MAX_LINE_SIZE, MAX_ARG_NUMBER, MAX_HISTORY_NUMBER >::CLEAR_ALL[]

staticconstexprprivate

Initial value:

=

"\033[2J\033[1H"

清屏命令 Clear screen command

Definition at line 33 of file terminal.hpp.

◆ CLEAR_BEHIND

template<size_t READ_BUFF_SIZE = 32, size_t MAX_LINE_SIZE = READ_BUFF_SIZE, size_t MAX_ARG_NUMBER = 5, size_t MAX_HISTORY_NUMBER = 5>

constexpr char LibXR::Terminal< READ_BUFF_SIZE, MAX_LINE_SIZE, MAX_ARG_NUMBER, MAX_HISTORY_NUMBER >::CLEAR_BEHIND[]

staticconstexprprivate

Initial value:

=

"\033[K"

清除光标后内容命令 Clear content after cursor command

Definition at line 37 of file terminal.hpp.

◆ CLEAR_LINE

template<size_t READ_BUFF_SIZE = 32, size_t MAX_LINE_SIZE = READ_BUFF_SIZE, size_t MAX_ARG_NUMBER = 5, size_t MAX_HISTORY_NUMBER = 5>

constexpr char LibXR::Terminal< READ_BUFF_SIZE, MAX_LINE_SIZE, MAX_ARG_NUMBER, MAX_HISTORY_NUMBER >::CLEAR_LINE[]

staticconstexprprivate

Initial value:

=

"\033[2K\r"

清除当前行命令 Clear current line command

Definition at line 35 of file terminal.hpp.

◆ current_dir_

template<size_t READ_BUFF_SIZE = 32, size_t MAX_LINE_SIZE = READ_BUFF_SIZE, size_t MAX_ARG_NUMBER = 5, size_t MAX_HISTORY_NUMBER = 5>

RamFS::Dir* LibXR::Terminal< READ_BUFF_SIZE, MAX_LINE_SIZE, MAX_ARG_NUMBER, MAX_HISTORY_NUMBER >::current_dir_

当前目录 Current directory

Definition at line 116 of file terminal.hpp.

◆ DELETE_CHAR

template<size_t READ_BUFF_SIZE = 32, size_t MAX_LINE_SIZE = READ_BUFF_SIZE, size_t MAX_ARG_NUMBER = 5, size_t MAX_HISTORY_NUMBER = 5>

constexpr char LibXR::Terminal< READ_BUFF_SIZE, MAX_LINE_SIZE, MAX_ARG_NUMBER, MAX_HISTORY_NUMBER >::DELETE_CHAR[]

staticconstexprprivate

Initial value:

=

"\b \b"

退格删除字符 Backspace delete character

Definition at line 43 of file terminal.hpp.

◆ flag_ansi_

template<size_t READ_BUFF_SIZE = 32, size_t MAX_LINE_SIZE = READ_BUFF_SIZE, size_t MAX_ARG_NUMBER = 5, size_t MAX_HISTORY_NUMBER = 5>

uint8_t LibXR::Terminal< READ_BUFF_SIZE, MAX_LINE_SIZE, MAX_ARG_NUMBER, MAX_HISTORY_NUMBER >::flag_ansi_ = 0

ANSI 控制字符状态 ANSI control character state.

Definition at line 117 of file terminal.hpp.

◆ history_

template<size_t READ_BUFF_SIZE = 32, size_t MAX_LINE_SIZE = READ_BUFF_SIZE, size_t MAX_ARG_NUMBER = 5, size_t MAX_HISTORY_NUMBER = 5>

Queue<LibXR::String<MAX_LINE_SIZE> > LibXR::Terminal< READ_BUFF_SIZE, MAX_LINE_SIZE, MAX_ARG_NUMBER, MAX_HISTORY_NUMBER >::history_

历史命令 History of commands

Definition at line 122 of file terminal.hpp.

◆ history_index_

template<size_t READ_BUFF_SIZE = 32, size_t MAX_LINE_SIZE = READ_BUFF_SIZE, size_t MAX_ARG_NUMBER = 5, size_t MAX_HISTORY_NUMBER = 5>

int LibXR::Terminal< READ_BUFF_SIZE, MAX_LINE_SIZE, MAX_ARG_NUMBER, MAX_HISTORY_NUMBER >::history_index_ = -1

当前历史索引 Current history index

Definition at line 123 of file terminal.hpp.

◆ input_line_

template<size_t READ_BUFF_SIZE = 32, size_t MAX_LINE_SIZE = READ_BUFF_SIZE, size_t MAX_ARG_NUMBER = 5, size_t MAX_HISTORY_NUMBER = 5>

Stack<char> LibXR::Terminal< READ_BUFF_SIZE, MAX_LINE_SIZE, MAX_ARG_NUMBER, MAX_HISTORY_NUMBER >::input_line_

输入行缓冲区 Input line buffer

Definition at line 119 of file terminal.hpp.

◆ KEY_LEFT

template<size_t READ_BUFF_SIZE = 32, size_t MAX_LINE_SIZE = READ_BUFF_SIZE, size_t MAX_ARG_NUMBER = 5, size_t MAX_HISTORY_NUMBER = 5>

constexpr char LibXR::Terminal< READ_BUFF_SIZE, MAX_LINE_SIZE, MAX_ARG_NUMBER, MAX_HISTORY_NUMBER >::KEY_LEFT[] = "\033[D"

staticconstexprprivate

左箭头键 Left arrow key

Definition at line 40 of file terminal.hpp.

◆ KEY_LOAD

template<size_t READ_BUFF_SIZE = 32, size_t MAX_LINE_SIZE = READ_BUFF_SIZE, size_t MAX_ARG_NUMBER = 5, size_t MAX_HISTORY_NUMBER = 5>

constexpr char LibXR::Terminal< READ_BUFF_SIZE, MAX_LINE_SIZE, MAX_ARG_NUMBER, MAX_HISTORY_NUMBER >::KEY_LOAD[] = "\033[u"

staticconstexprprivate

恢复光标位置 Restore cursor position

Definition at line 42 of file terminal.hpp.

◆ KEY_RIGHT

template<size_t READ_BUFF_SIZE = 32, size_t MAX_LINE_SIZE = READ_BUFF_SIZE, size_t MAX_ARG_NUMBER = 5, size_t MAX_HISTORY_NUMBER = 5>

constexpr char LibXR::Terminal< READ_BUFF_SIZE, MAX_LINE_SIZE, MAX_ARG_NUMBER, MAX_HISTORY_NUMBER >::KEY_RIGHT[] = "\033[C"

staticconstexprprivate

右箭头键 Right arrow key

Definition at line 39 of file terminal.hpp.

◆ KEY_SAVE

template<size_t READ_BUFF_SIZE = 32, size_t MAX_LINE_SIZE = READ_BUFF_SIZE, size_t MAX_ARG_NUMBER = 5, size_t MAX_HISTORY_NUMBER = 5>

constexpr char LibXR::Terminal< READ_BUFF_SIZE, MAX_LINE_SIZE, MAX_ARG_NUMBER, MAX_HISTORY_NUMBER >::KEY_SAVE[] = "\033[s"

staticconstexprprivate

保存光标位置 Save cursor position

Definition at line 41 of file terminal.hpp.

◆ linefeed_flag_

template<size_t READ_BUFF_SIZE = 32, size_t MAX_LINE_SIZE = READ_BUFF_SIZE, size_t MAX_ARG_NUMBER = 5, size_t MAX_HISTORY_NUMBER = 5>

bool LibXR::Terminal< READ_BUFF_SIZE, MAX_LINE_SIZE, MAX_ARG_NUMBER, MAX_HISTORY_NUMBER >::linefeed_flag_ = false

换行标志 Line feed flag

Definition at line 124 of file terminal.hpp.

◆ MODE

template<size_t READ_BUFF_SIZE = 32, size_t MAX_LINE_SIZE = READ_BUFF_SIZE, size_t MAX_ARG_NUMBER = 5, size_t MAX_HISTORY_NUMBER = 5>

const Mode LibXR::Terminal< READ_BUFF_SIZE, MAX_LINE_SIZE, MAX_ARG_NUMBER, MAX_HISTORY_NUMBER >::MODE

终端换行模式 Terminal line feed mode

Definition at line 109 of file terminal.hpp.

◆ offset_

template<size_t READ_BUFF_SIZE = 32, size_t MAX_LINE_SIZE = READ_BUFF_SIZE, size_t MAX_ARG_NUMBER = 5, size_t MAX_HISTORY_NUMBER = 5>

int LibXR::Terminal< READ_BUFF_SIZE, MAX_LINE_SIZE, MAX_ARG_NUMBER, MAX_HISTORY_NUMBER >::offset_ = 0

光标偏移 Cursor offset

Definition at line 118 of file terminal.hpp.

◆ ramfs_

template<size_t READ_BUFF_SIZE = 32, size_t MAX_LINE_SIZE = READ_BUFF_SIZE, size_t MAX_ARG_NUMBER = 5, size_t MAX_HISTORY_NUMBER = 5>

RamFS& LibXR::Terminal< READ_BUFF_SIZE, MAX_LINE_SIZE, MAX_ARG_NUMBER, MAX_HISTORY_NUMBER >::ramfs_

关联的文件系统 Associated file system

Definition at line 113 of file terminal.hpp.

◆ read_

template<size_t READ_BUFF_SIZE = 32, size_t MAX_LINE_SIZE = READ_BUFF_SIZE, size_t MAX_ARG_NUMBER = 5, size_t MAX_HISTORY_NUMBER = 5>

ReadPort* LibXR::Terminal< READ_BUFF_SIZE, MAX_LINE_SIZE, MAX_ARG_NUMBER, MAX_HISTORY_NUMBER >::read_

读取端口 Read port

Definition at line 111 of file terminal.hpp.

◆ read_buff_

template<size_t READ_BUFF_SIZE = 32, size_t MAX_LINE_SIZE = READ_BUFF_SIZE, size_t MAX_ARG_NUMBER = 5, size_t MAX_HISTORY_NUMBER = 5>

char LibXR::Terminal< READ_BUFF_SIZE, MAX_LINE_SIZE, MAX_ARG_NUMBER, MAX_HISTORY_NUMBER >::read_buff_[READ_BUFF_SIZE]

读取缓冲区 Read buffer

Definition at line 114 of file terminal.hpp.

◆ read_status_

template<size_t READ_BUFF_SIZE = 32, size_t MAX_LINE_SIZE = READ_BUFF_SIZE, size_t MAX_ARG_NUMBER = 5, size_t MAX_HISTORY_NUMBER = 5>

ReadOperation::OperationPollingStatus LibXR::Terminal< READ_BUFF_SIZE, MAX_LINE_SIZE, MAX_ARG_NUMBER, MAX_HISTORY_NUMBER >::read_status_

Definition at line 106 of file terminal.hpp.

◆ write_

template<size_t READ_BUFF_SIZE = 32, size_t MAX_LINE_SIZE = READ_BUFF_SIZE, size_t MAX_ARG_NUMBER = 5, size_t MAX_HISTORY_NUMBER = 5>

WritePort* LibXR::Terminal< READ_BUFF_SIZE, MAX_LINE_SIZE, MAX_ARG_NUMBER, MAX_HISTORY_NUMBER >::write_

写入端口 Write port

Definition at line 112 of file terminal.hpp.

◆ write_op_

template<size_t READ_BUFF_SIZE = 32, size_t MAX_LINE_SIZE = READ_BUFF_SIZE, size_t MAX_ARG_NUMBER = 5, size_t MAX_HISTORY_NUMBER = 5>

WriteOperation LibXR::Terminal< READ_BUFF_SIZE, MAX_LINE_SIZE, MAX_ARG_NUMBER, MAX_HISTORY_NUMBER >::write_op_

终端写操作 Terminal write operation

Definition at line 110 of file terminal.hpp.

◆ write_status_

template<size_t READ_BUFF_SIZE = 32, size_t MAX_LINE_SIZE = READ_BUFF_SIZE, size_t MAX_ARG_NUMBER = 5, size_t MAX_HISTORY_NUMBER = 5>

WriteOperation::OperationPollingStatus LibXR::Terminal< READ_BUFF_SIZE, MAX_LINE_SIZE, MAX_ARG_NUMBER, MAX_HISTORY_NUMBER >::write_status_

Definition at line 107 of file terminal.hpp.

The documentation for this class was generated from the following file:

src/middleware/terminal.hpp

Public Types

Public Member Functions

Static Public Member Functions

Data Fields

Private Member Functions

Static Private Attributes

Detailed Description

Member Enumeration Documentation

◆ Mode

Constructor & Destructor Documentation

◆ Terminal()

Member Function Documentation

◆ AddCharToInputLine()

◆ AddHistory()

◆ AutoComplete()

◆ CanDeleteChar()

◆ CanDisplayChar()

◆ Clear()

◆ ClearLine()

◆ CopyHistoryToInputLine()

◆ DeleteChar()

◆ DisplayChar()

◆ ExecuteCommand()

◆ GetArgs()

◆ HandleAnsiCharacter()

◆ HandleCharacter()

◆ HandleControlCharacter()

◆ LineFeed()

◆ Parse()

◆ Path2Dir()

◆ Path2File()

◆ RemoveCharFromInputLine()

◆ ShowHeader()

◆ ShowHistory()

◆ StrchrRev()

◆ TaskFun()

◆ ThreadFun()

◆ UpdateDisplayPosition()

Field Documentation

◆ arg_number_

◆ arg_tab_

◆ CLEAR_ALL

◆ CLEAR_BEHIND

◆ CLEAR_LINE

◆ current_dir_

◆ DELETE_CHAR

◆ flag_ansi_

◆ history_

◆ history_index_

◆ input_line_

◆ KEY_LEFT

◆ KEY_LOAD

◆ KEY_RIGHT

◆ KEY_SAVE

◆ linefeed_flag_

◆ MODE

◆ offset_

◆ ramfs_

◆ read_

◆ read_buff_

◆ read_status_

◆ write_

◆ write_op_

◆ write_status_