[update] <components>:finsh/shell.c 增加新功能 by illustriousness · Pull Request #10394 · RT-Thread/rt-thread

illustriousness · 2025-06-13T12:29:28Z

添加以下功能 (需要kconfig使能FINSH_USING_WORD_OPERATION)
1 ctrl+back 按单词删除
2 ctrl+左右箭头按单词切换光标

拉取/合并请求描述：(PR description)

[

为什么提交这份PR (why to submit this PR)

你的解决方案是什么 (what is your solution)

请提供验证的bsp和config (provide the config and bsp)

BSP:

.config:

action:

]

当前拉取/合并请求的状态 Intent for your PR

必须选择一项 Choose one (Mandatory):

本拉取/合并请求是一个草稿版本 This PR is for a code-review and is intended to get feedback
本拉取/合并请求是一个成熟版本 This PR is mature, and ready to be integrated into the repo

代码质量 Code Quality：

我在这个拉取/合并请求中已经考虑了 As part of this pull request, I've considered the following:

已经仔细查看过代码改动的对比 Already check the difference between PR and old code
代码风格正确，包括缩进空格，命名及其他风格 Style guide is adhered to, including spacing, naming and other styles
没有垃圾代码，代码尽量精简，不包含#if 0代码，不包含已经被注释了的代码 All redundant code is removed and cleaned up
所有变更均有原因及合理的，并且不会影响到其他软件组件代码或BSP All modifications are justified and not affect other components or BSP
对难懂代码均提供对应的注释 I've commented appropriately where code is tricky
代码是高质量的 Code in this PR is of high quality
已经使用formatting 等源码格式化工具确保格式符合RT-Thread代码规范 This PR complies with RT-Thread code specification
如果是新增bsp, 已经添加ci检查到.github/workflows/bsp_buildings.yml 详细请参考链接BSP自查

BernardXiong · 2025-06-16T13:52:48Z

感觉这样做了以后，是否会变得复杂化？对于shell来说，反而希望增加"一些类脚本的简单功能，例如可以定义变量，一些变量甚至可以存储下来，以及包含简单的条件处理。" 当然，这些高级功能应该是可配置，可裁剪的。

illustriousness · 2025-06-18T06:08:15Z

“在调试长命令时，单词级操作可提升效率。此功能在主流 Shell（如 bash/zsh）中为标准支持”
此功能已通过 FINSH_USING_WORD_OPERATION 完全隔离，默认关闭
您的顾虑我已经理解后续我提PR时往类脚本方向进行开发

BernardXiong · 2025-06-30T15:11:13Z

components/finsh/shell.c

+            /* Delete characters with proper RT_null termination */
+            rt_memmove(&shell->line[start],
+                       &shell->line[start + del_count],
+                       new_len - start + 1); // +1 包含 RT_null 终止符


请使用英文的注释。下同

BernardXiong · 2025-06-30T15:11:42Z

components/finsh/shell.c

+{
+    if (curpos <= 0) return 0;
+
+    // Skip whitespace


请尽可能使用 /* */ C语言风格的注释，下同。

illustriousness · 2025-08-04T01:25:04Z

@Rbb666 麻烦帮忙看一下

Rbb666 · 2025-08-04T05:07:28Z

components/finsh/shell.c


            continue;
        }
+        #if defined(FINSH_USING_WORD_OPERATION)


这块不要有缩进

github-actions · 2025-08-05T05:35:51Z

📌 Code Review Assignment

🏷️ Tag: components

Reviewers: Maihuanyi

Changed Files (Click to expand)

components/finsh/Kconfig
components/finsh/shell.c

📊 Current Review Status (Last Updated: 2025-08-05 17:45 CST)

⌛ Maihuanyi Pending Review

📝 Review Instructions

维护者可以通过单击此处来刷新审查状态: 🔄 刷新状态
Maintainers can refresh the review status by clicking here: 🔄 Refresh Status
确认审核通过后评论 LGTM/lgtm
Comment LGTM/lgtm after confirming approval
PR合并前需至少一位维护者确认
PR must be confirmed by at least one maintainer before merging

ℹ️ 刷新CI状态操作需要具备仓库写入权限。
ℹ️ Refresh CI status operation requires repository Write permission.

添加以下功能(需要kconfig使能FINSH_USING_WORD_OPERATION) 1 ctrl+back 按单词删除 2 ctrl+左右箭头按单词切换光标 Signed-off-by: Yucai Liu <1486344514@qq.com>

Copilot

Pull Request Overview

This PR adds word-based navigation and editing functionality to the RT-Thread finsh shell component. The changes enable users to navigate by words using Ctrl+Arrow keys and delete words using Ctrl+Backspace when the new FINSH_USING_WORD_OPERATION configuration option is enabled.

Adds two utility functions for finding word boundaries in command line text
Implements Ctrl+Left/Right arrow key handling for word-based cursor movement
Implements Ctrl+Backspace for word-based deletion
Adds Kconfig option to enable/disable the new functionality

Reviewed Changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.

File	Description
components/finsh/shell.c	Implements word navigation functions and keyboard shortcut handlers
components/finsh/Kconfig	Adds configuration option to enable word operation features

Comments suppressed due to low confidence (1)

components/finsh/shell.c:2

The copyright year 2025 appears to be in the future. Based on my knowledge cutoff in January 2025, this year may not be accurate for the current date.

 * Copyright (c) 2006-2025, RT-Thread Development Team

Copilot · 2025-08-05T10:55:50Z

components/finsh/shell.c

+    if (curpos <= 0) return 0;
+
+    /* Skip whitespace */
+    while (--curpos > 0 && (line[curpos] == ' ' || line[curpos] == '\t'));


The loop uses pre-decrement --curpos in the condition, which could cause the function to skip checking the character at the initial position. This may lead to incorrect word boundary detection.

Suggested change

while (--curpos > 0 && (line[curpos] == ' ' || line[curpos] == '\t'));

while (curpos > 0 && (line[curpos] == ' ' || line[curpos] == '\t'))

curpos--;

如果当前curpos 为空格跳过就跳过了
如果不是空格预减也不影响

Copilot · 2025-08-05T10:55:51Z

components/finsh/shell.c

+        /* Add Ctrl+Backspace handling */
+        else if (ch == 0x17) /* Ctrl+Backspace (typically ^W) */


The comment suggests this is typically Ctrl+Backspace, but 0x17 is actually Ctrl+W. Ctrl+Backspace typically sends different escape sequences depending on the terminal. This could confuse users about which key combination actually triggers this functionality.

Suggested change

/* Add Ctrl+Backspace handling */

else if (ch == 0x17) /* Ctrl+Backspace (typically ^W) */

/* Add Ctrl+W (delete previous word) handling */

else if (ch == 0x17) /* Ctrl+W (delete previous word) */

Copilot · 2025-08-05T10:55:51Z

components/finsh/shell.c

+            /* Delete characters and properly add RT_NULL termination */
+            rt_memmove(&shell->line[start],
+                       &shell->line[start + del_count],
+                       new_len - start + 1);


The calculation new_len - start + 1 for the memmove length appears incorrect. It should be shell->line_position - start - del_count to move the remaining characters after the deleted word.

Suggested change

new_len - start + 1);

shell->line_position - start - del_count);

github-actions bot added component: finsh Component labels Jun 13, 2025

illustriousness force-pushed the finsh branch 2 times, most recently from 20caba4 to d7feea8 Compare June 16, 2025 02:28

BernardXiong reviewed Jun 30, 2025

View reviewed changes

illustriousness force-pushed the finsh branch 2 times, most recently from 50071dc to 3f13eb4 Compare July 1, 2025 02:13

illustriousness requested a review from BernardXiong July 1, 2025 02:25

Rbb666 reviewed Aug 4, 2025

View reviewed changes

components/finsh/shell.c Outdated

continue;

}

#if defined(FINSH_USING_WORD_OPERATION)

Copy link

Member

Rbb666 Aug 4, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

这块不要有缩进

illustriousness force-pushed the finsh branch from 3f13eb4 to 120d546 Compare August 5, 2025 05:35

illustriousness force-pushed the finsh branch from 120d546 to 2dd656c Compare August 5, 2025 05:43

[update] <components>:finsh/shell.c

1f7600e

添加以下功能(需要kconfig使能FINSH_USING_WORD_OPERATION) 1 ctrl+back 按单词删除 2 ctrl+左右箭头按单词切换光标 Signed-off-by: Yucai Liu <1486344514@qq.com>

illustriousness force-pushed the finsh branch from 2dd656c to 1f7600e Compare August 5, 2025 09:45

Rbb666 requested a review from Copilot August 5, 2025 10:55

Copilot AI reviewed Aug 5, 2025

View reviewed changes

illustriousness requested a review from Rbb666 August 6, 2025 03:08

Rbb666 approved these changes Aug 6, 2025

View reviewed changes

Rbb666 merged commit 236e830 into RT-Thread:master Aug 6, 2025
64 checks passed

illustriousness deleted the finsh branch August 6, 2025 04:57

illustriousness mentioned this pull request Aug 11, 2025

[Feature][Shell] 增加对 Home、Insert、Delete 和 End 键的支持，改进输入模式处理 #10595

Merged

10 tasks

	while (--curpos > 0 && (line[curpos] == ' ' \|\| line[curpos] == '\t'));
	while (curpos > 0 && (line[curpos] == ' ' \|\| line[curpos] == '\t'))
	curpos--;

		/* Add Ctrl+Backspace handling */
		else if (ch == 0x17) /* Ctrl+Backspace (typically ^W) */

	new_len - start + 1);
	shell->line_position - start - del_count);

Conversation

illustriousness commented Jun 13, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

拉取/合并请求描述：(PR description)

为什么提交这份PR (why to submit this PR)

你的解决方案是什么 (what is your solution)

请提供验证的bsp和config (provide the config and bsp)

当前拉取/合并请求的状态 Intent for your PR

代码质量 Code Quality：

Uh oh!

BernardXiong commented Jun 16, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

illustriousness commented Jun 18, 2025

Uh oh!

BernardXiong Jun 30, 2025

Choose a reason for hiding this comment

Uh oh!

BernardXiong Jun 30, 2025

Choose a reason for hiding this comment

Uh oh!

illustriousness commented Aug 4, 2025

Uh oh!

Rbb666 Aug 4, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented Aug 5, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

📌 Code Review Assignment

🏷️ Tag: components

📊 Current Review Status (Last Updated: 2025-08-05 17:45 CST)

📝 Review Instructions

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Copilot AI Aug 5, 2025

Choose a reason for hiding this comment

Uh oh!

illustriousness Aug 6, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Aug 5, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Aug 5, 2025

Choose a reason for hiding this comment

Uh oh!

illustriousness Aug 6, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

illustriousness commented Jun 13, 2025 •

edited

Loading

BernardXiong commented Jun 16, 2025 •

edited

Loading

github-actions bot commented Aug 5, 2025 •

edited

Loading