Intravision/reactos
1
0
Fork 0
mirror of https://github.com/reactos/reactos.git synced 2025-04-04 20:50:41 +00:00
Code Issues Projects Releases Packages Wiki Activity

[NTOS:KD:KDBG] Isolate the read-line (prompt) functionality in a separate file.

Browse source 
Rename KdbpReadCommand as KdIoReadLine. Extract the last-command
repetition functionality out of KdIoReadLine and put it where it
belongs: only in the KDBG command main loop KdbpCliMainLoop.
This commit is contained in:
Hermès Bélusca-Maïto 2023-03-20 17:49:15 +01:00
parent 430d7ebb93
commit f3dd713382
No known key found for this signature in database
GPG key ID: 3B2539C65E7B93D0
8 changed files with 226 additions and 192 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
ntoskrnl/kd/kdio.c
View file

@ -12,6 +12,7 @@
#include <ntoskrnl.h>
#include <reactos/buildno.h>
#include "kd.h"
#include "kdterminal.h"
#define NDEBUG
#include <debug.h>
@ -779,7 +780,7 @@ KdReceivePacket(
* in which case the string is simply truncated without NULL-termination.
*/
ResponseString.Length =
(USHORT)KdbpReadCommand(ResponseString.Buffer,
(USHORT)KdIoReadLine(ResponseString.Buffer,
ResponseString.MaximumLength);
if (!(KdbDebugState & KD_DEBUG_KDSERIAL))

1
ntoskrnl/kd/kdmain.c
View file

@ -9,6 +9,7 @@
#include <ntoskrnl.h>
#include "kd.h"
#define NDEBUG
#include <debug.h>

166
ntoskrnl/kd/kdprompt.c Normal file
View file

@ -0,0 +1,166 @@
/*
* PROJECT: ReactOS KDBG Kernel Debugger Terminal Driver
* LICENSE: GPL-2.0-or-later (https://spdx.org/licenses/GPL-2.0-or-later)
* PURPOSE: Terminal line-editing (Prompt) interface
* COPYRIGHT: Copyright 2001-2004 David Welch <welch@cwcom.net>
* Copyright 2004-2005 Gregor Anich <blight@blight.eu.org>
* Copyright 2022-2023 Hermès Bélusca-Maïto <hermes.belusca-maito@reactos.org>
*/
/* INCLUDES ******************************************************************/
#include <ntoskrnl.h>
#include "kdterminal.h"
/* FUNCTIONS *****************************************************************/
/**
* @brief Reads a line of user input from the terminal.
*
* @param[out] Buffer
* Buffer where to store the input. Trailing newlines are removed.
*
* @param[in] Size
* Size of @p Buffer.
*
* @return
* Returns the number of characters stored, not counting the NULL terminator.
*
* @note Accepts only \n newlines, \r is ignored.
**/
SIZE_T
KdIoReadLine(
_Out_ PCHAR Buffer,
_In_ SIZE_T Size)
{
PCHAR Orig = Buffer;
ULONG ScanCode = 0;
CHAR Key;
static CHAR NextKey = ANSI_NULL;
BOOLEAN EchoOn;
LONG CmdHistIndex = -1; // Start at end of history.
/* Bail out if the buffer is zero-sized */
if (Size == 0)
return 0;
EchoOn = ((KdbDebugState & KD_DEBUG_KDNOECHO) == 0);
for (;;)
{
ScanCode = 0;
if (KdbDebugState & KD_DEBUG_KDSERIAL)
{
Key = (!NextKey ? KdbpGetCharSerial() : NextKey);
NextKey = ANSI_NULL;
if (Key == KEY_ESC) /* ESC */
{
Key = KdbpGetCharSerial();
if (Key == '[')
{
Key = KdbpGetCharSerial();
switch (Key)
{
case 'A':
ScanCode = KEY_SCAN_UP;
break;
case 'B':
ScanCode = KEY_SCAN_DOWN;
break;
case 'C':
break;
case 'D':
break;
}
}
}
}
else
{
Key = (!NextKey ? KdbpGetCharKeyboard(&ScanCode) : NextKey);
NextKey = ANSI_NULL;
}
/* Check for return or newline */
if ((Key == '\r') || (Key == '\n'))
{
if (Key == '\r')
{
/*
* We might need to discard the next '\n' which most clients
* should send after \r. Wait a bit to make sure we receive it.
*/
KeStallExecutionProcessor(100000);
if (KdbDebugState & KD_DEBUG_KDSERIAL)
NextKey = KdbpTryGetCharSerial(5);
else
NextKey = KdbpTryGetCharKeyboard(&ScanCode, 5);
if (NextKey == '\n' || NextKey == -1) /* \n or no response at all */
NextKey = ANSI_NULL;
}
*Buffer = ANSI_NULL;
KdIoPuts("\n");
return (SIZE_T)(Buffer - Orig);
}
else if (Key == KEY_BS || Key == KEY_DEL)
{
/* Erase the last character */
if (Buffer > Orig)
{
Buffer--;
*Buffer = ANSI_NULL;
if (EchoOn)
KdIoPrintf("%c %c", KEY_BS, KEY_BS);
else
KdIoPrintf(" %c", KEY_BS);
}
}
else if (ScanCode == KEY_SCAN_UP || ScanCode == KEY_SCAN_DOWN)
{
PCSTR CmdHistory = KdbGetHistoryEntry(&CmdHistIndex,
(ScanCode == KEY_SCAN_DOWN));
if (CmdHistory)
{
SIZE_T i;
/* Erase the whole line */
while (Buffer > Orig)
{
Buffer--;
*Buffer = ANSI_NULL;
if (EchoOn)
KdIoPrintf("%c %c", KEY_BS, KEY_BS);
else
KdIoPrintf(" %c", KEY_BS);
}
/* Copy and display the history entry */
i = min(strlen(CmdHistory), Size - 1);
memcpy(Orig, CmdHistory, i);
Orig[i] = ANSI_NULL;
Buffer = Orig + i;
KdIoPuts(Orig);
}
}
else
{
/* Do not accept characters anymore if the buffer is full */
if ((SIZE_T)(Buffer - Orig) >= (Size - 1))
continue;
if (EchoOn)
KdIoPrintf("%c", Key);
*Buffer = Key;
Buffer++;
}
}
}
/* EOF */

2
ntoskrnl/kd/kdserial.c
View file

@ -34,3 +34,5 @@ KdbpTryGetCharSerial(
return Result;
}
/* EOF */

29
ntoskrnl/kd/kdterminal.h Normal file
View file

@ -0,0 +1,29 @@
/*
* PROJECT: ReactOS KDBG Kernel Debugger Terminal Driver
* LICENSE: GPL-2.0-or-later (https://spdx.org/licenses/GPL-2.0-or-later)
* PURPOSE: KD Terminal Driver public header
* COPYRIGHT: Copyright 2023 Hermès Bélusca-Maïto <hermes.belusca-maito@reactos.org>
*/
#pragma once
#define KEY_BS 8
#define KEY_ESC 27
#define KEY_DEL 127
#define KEY_SCAN_UP 72
#define KEY_SCAN_DOWN 80
/* Scan codes of keyboard keys */
#define KEYSC_END 0x004f
#define KEYSC_PAGEUP 0x0049
#define KEYSC_PAGEDOWN 0x0051
#define KEYSC_HOME 0x0047
#define KEYSC_ARROWUP 0x0048 // == KEY_SCAN_UP
SIZE_T
KdIoReadLine(
_Out_ PCHAR Buffer,
_In_ SIZE_T Size);
/* EOF */

5
ntoskrnl/kdbg/kdb.h
View file

@ -113,11 +113,6 @@ KdbGetHistoryEntry(
_Inout_ PLONG NextIndex,
_In_ BOOLEAN Next);
SIZE_T
KdbpReadCommand(
_Out_ PCHAR Buffer,
_In_ SIZE_T Size);
VOID
KdbpPager(
_In_ PCHAR Buffer,

207
ntoskrnl/kdbg/kdb_cli.c
View file

@ -29,26 +29,13 @@
/* INCLUDES ******************************************************************/
#include <ntoskrnl.h>
#include "../kd/kdterminal.h"
#define NDEBUG
#include <debug.h>
/* DEFINES *******************************************************************/
#define KEY_BS 8
#define KEY_ESC 27
#define KEY_DEL 127
#define KEY_SCAN_UP 72
#define KEY_SCAN_DOWN 80
/* Scan codes of keyboard keys: */
#define KEYSC_END 0x004f
#define KEYSC_PAGEUP 0x0049
#define KEYSC_PAGEDOWN 0x0051
#define KEYSC_HOME 0x0047
#define KEYSC_ARROWUP 0x0048
#define KDB_ENTER_CONDITION_TO_STRING(cond) \
((cond) == KdbDoNotEnter ? "never" : \
((cond) == KdbEnterAlways ? "always" : \
@ -3253,172 +3240,6 @@ KdbpPrintUnicodeString(
}
/**
* @brief Reads a line of user input from the terminal.
*
* @param[out] Buffer
* Buffer where to store the input. Trailing newlines are removed.
*
* @param[in] Size
* Size of \a Buffer.
*
* @return
* Returns the number of characters stored, not counting the NULL terminator.
*
* @note Accepts only \n newlines, \r is ignored.
**/
SIZE_T
KdbpReadCommand(
_Out_ PCHAR Buffer,
_In_ SIZE_T Size)
{
PCHAR Orig = Buffer;
ULONG ScanCode = 0;
CHAR Key;
BOOLEAN EchoOn;
static CHAR LastCommand[1024];
static CHAR NextKey = '\0';
LONG CmdHistIndex = -1; // Start at end of history.
/* Bail out if the buffer is zero-sized */
if (Size == 0)
return 0;
EchoOn = ((KdbDebugState & KD_DEBUG_KDNOECHO) == 0);
for (;;)
{
if (KdbDebugState & KD_DEBUG_KDSERIAL)
{
Key = (NextKey == '\0') ? KdbpGetCharSerial() : NextKey;
NextKey = '\0';
ScanCode = 0;
if (Key == KEY_ESC) /* ESC */
{
Key = KdbpGetCharSerial();
if (Key == '[')
{
Key = KdbpGetCharSerial();
switch (Key)
{
case 'A':
ScanCode = KEY_SCAN_UP;
break;
case 'B':
ScanCode = KEY_SCAN_DOWN;
break;
case 'C':
break;
case 'D':
break;
}
}
}
}
else
{
ScanCode = 0;
Key = (NextKey == '\0') ? KdbpGetCharKeyboard(&ScanCode) : NextKey;
NextKey = '\0';
}
/* Check for return or newline */
if ((Key == '\r') || (Key == '\n'))
{
if (Key == '\r')
{
/*
* We might need to discard the next '\n' which most clients
* should send after \r. Wait a bit to make sure we receive it.
*/
KeStallExecutionProcessor(100000);
if (KdbDebugState & KD_DEBUG_KDSERIAL)
NextKey = KdbpTryGetCharSerial(5);
else
NextKey = KdbpTryGetCharKeyboard(&ScanCode, 5);
if (NextKey == '\n' || NextKey == -1) /* \n or no response at all */
NextKey = '\0';
}
KdpDprintf("\n");
/*
* Repeat the last command if the user presses enter. Reduces the
* risk of RSI when single-stepping.
*/
if (Buffer != Orig)
{
KdbRepeatLastCommand = TRUE;
*Buffer = '\0';
RtlStringCbCopyA(LastCommand, sizeof(LastCommand), Orig);
}
else if (KdbRepeatLastCommand)
RtlStringCbCopyA(Buffer, Size, LastCommand);
else
*Buffer = '\0';
return (SIZE_T)(Buffer - Orig);
}
else if (Key == KEY_BS || Key == KEY_DEL)
{
/* Erase the last character */
if (Buffer > Orig)
{
Buffer--;
*Buffer = '\0';
if (EchoOn)
KdpDprintf("%c %c", KEY_BS, KEY_BS);
else
KdpDprintf(" %c", KEY_BS);
}
}
else if (ScanCode == KEY_SCAN_UP || ScanCode == KEY_SCAN_DOWN)
{
PCSTR CmdHistory = KdbGetHistoryEntry(&CmdHistIndex,
(ScanCode == KEY_SCAN_DOWN));
if (CmdHistory)
{
SIZE_T i;
/* Erase the whole line */
while (Buffer > Orig)
{
Buffer--;
*Buffer = '\0';
if (EchoOn)
KdpDprintf("%c %c", KEY_BS, KEY_BS);
else
KdpDprintf(" %c", KEY_BS);
}
i = min(strlen(CmdHistory), Size - 1);
memcpy(Orig, CmdHistory, i);
Orig[i] = '\0';
Buffer = Orig + i;
KdpDprintf("%s", Orig);
}
}
else
{
/* Don't accept any key if the buffer is full */
if ((SIZE_T)(Buffer - Orig) >= (Size - 1))
continue;
if (EchoOn)
KdpDprintf("%c", Key);
*Buffer = Key;
Buffer++;
}
}
}
BOOLEAN
NTAPI
KdbRegisterCliCallback(
@ -3567,8 +3388,10 @@ VOID
KdbpCliMainLoop(
IN BOOLEAN EnteredOnSingleStep)
{
static CHAR Command[1024];
BOOLEAN Continue;
SIZE_T CmdLen;
static CHAR Command[1024];
static CHAR LastCommand[1024] = "";
if (EnteredOnSingleStep)
{
@ -3603,11 +3426,27 @@ KdbpCliMainLoop(
KdbNumberOfRowsPrinted = KdbNumberOfColsPrinted = 0;
/* Print the prompt */
KdbpPrint(KdbPromptString.Buffer);
KdpDprintf(KdbPromptString.Buffer);
/* Read a command and remember it */
KdbpReadCommand(Command, sizeof(Command));
/*
* Read a command. Repeat the last one if the user pressed Enter.
* This reduces the risk of RSI when single-stepping!
*/
CmdLen = KdIoReadLine(Command, sizeof(Command));
if (CmdLen > 0) // i.e. (*Command != ANSI_NULL)
{
/* Save this new last command */
KdbRepeatLastCommand = TRUE;
RtlStringCbCopyA(LastCommand, sizeof(LastCommand), Command);
/* Remember it */
KdbpCommandHistoryAppend(Command);
}
else if (KdbRepeatLastCommand)
{
/* The user directly pressed Enter */
RtlStringCbCopyA(Command, sizeof(Command), LastCommand);
}
/* Reset the number of rows/cols printed and output aborted state */
KdbNumberOfRowsPrinted = KdbNumberOfColsPrinted = 0;

1
ntoskrnl/ntos.cmake
View file

@ -413,6 +413,7 @@ if(NOT _WINKD_)
list(APPEND SOURCE
${REACTOS_SOURCE_DIR}/ntoskrnl/kd/kdio.c
${REACTOS_SOURCE_DIR}/ntoskrnl/kd/kdmain.c
${REACTOS_SOURCE_DIR}/ntoskrnl/kd/kdprompt.c
${REACTOS_SOURCE_DIR}/ntoskrnl/kd/kdps2kbd.c
${REACTOS_SOURCE_DIR}/ntoskrnl/kd/kdserial.c)