1 /****************************************************************************** 2 * 3 * Module Name: acgetline - local line editing 4 * 5 *****************************************************************************/ 6 7 /****************************************************************************** 8 * 9 * 1. Copyright Notice 10 * 11 * Some or all of this work - Copyright (c) 1999 - 2021, Intel Corp. 12 * All rights reserved. 13 * 14 * 2. License 15 * 16 * 2.1. This is your license from Intel Corp. under its intellectual property 17 * rights. You may have additional license terms from the party that provided 18 * you this software, covering your right to use that party's intellectual 19 * property rights. 20 * 21 * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a 22 * copy of the source code appearing in this file ("Covered Code") an 23 * irrevocable, perpetual, worldwide license under Intel's copyrights in the 24 * base code distributed originally by Intel ("Original Intel Code") to copy, 25 * make derivatives, distribute, use and display any portion of the Covered 26 * Code in any form, with the right to sublicense such rights; and 27 * 28 * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent 29 * license (with the right to sublicense), under only those claims of Intel 30 * patents that are infringed by the Original Intel Code, to make, use, sell, 31 * offer to sell, and import the Covered Code and derivative works thereof 32 * solely to the minimum extent necessary to exercise the above copyright 33 * license, and in no event shall the patent license extend to any additions 34 * to or modifications of the Original Intel Code. No other license or right 35 * is granted directly or by implication, estoppel or otherwise; 36 * 37 * The above copyright and patent license is granted only if the following 38 * conditions are met: 39 * 40 * 3. Conditions 41 * 42 * 3.1. Redistribution of Source with Rights to Further Distribute Source. 43 * Redistribution of source code of any substantial portion of the Covered 44 * Code or modification with rights to further distribute source must include 45 * the above Copyright Notice, the above License, this list of Conditions, 46 * and the following Disclaimer and Export Compliance provision. In addition, 47 * Licensee must cause all Covered Code to which Licensee contributes to 48 * contain a file documenting the changes Licensee made to create that Covered 49 * Code and the date of any change. Licensee must include in that file the 50 * documentation of any changes made by any predecessor Licensee. Licensee 51 * must include a prominent statement that the modification is derived, 52 * directly or indirectly, from Original Intel Code. 53 * 54 * 3.2. Redistribution of Source with no Rights to Further Distribute Source. 55 * Redistribution of source code of any substantial portion of the Covered 56 * Code or modification without rights to further distribute source must 57 * include the following Disclaimer and Export Compliance provision in the 58 * documentation and/or other materials provided with distribution. In 59 * addition, Licensee may not authorize further sublicense of source of any 60 * portion of the Covered Code, and must include terms to the effect that the 61 * license from Licensee to its licensee is limited to the intellectual 62 * property embodied in the software Licensee provides to its licensee, and 63 * not to intellectual property embodied in modifications its licensee may 64 * make. 65 * 66 * 3.3. Redistribution of Executable. Redistribution in executable form of any 67 * substantial portion of the Covered Code or modification must reproduce the 68 * above Copyright Notice, and the following Disclaimer and Export Compliance 69 * provision in the documentation and/or other materials provided with the 70 * distribution. 71 * 72 * 3.4. Intel retains all right, title, and interest in and to the Original 73 * Intel Code. 74 * 75 * 3.5. Neither the name Intel nor any other trademark owned or controlled by 76 * Intel shall be used in advertising or otherwise to promote the sale, use or 77 * other dealings in products derived from or relating to the Covered Code 78 * without prior written authorization from Intel. 79 * 80 * 4. Disclaimer and Export Compliance 81 * 82 * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED 83 * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE 84 * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE, 85 * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY 86 * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY 87 * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A 88 * PARTICULAR PURPOSE. 89 * 90 * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES 91 * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR 92 * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT, 93 * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY 94 * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL 95 * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS 96 * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY 97 * LIMITED REMEDY. 98 * 99 * 4.3. Licensee shall not export, either directly or indirectly, any of this 100 * software or system incorporating such software without first obtaining any 101 * required license or other approval from the U. S. Department of Commerce or 102 * any other agency or department of the United States Government. In the 103 * event Licensee exports any such software from the United States or 104 * re-exports any such software from a foreign destination, Licensee shall 105 * ensure that the distribution and export/re-export of the software is in 106 * compliance with all laws, regulations, orders, or other restrictions of the 107 * U.S. Export Administration Regulations. Licensee agrees that neither it nor 108 * any of its subsidiaries will export/re-export any technical data, process, 109 * software, or service, directly or indirectly, to any country for which the 110 * United States government or any agency thereof requires an export license, 111 * other governmental approval, or letter of assurance, without first obtaining 112 * such license, approval or letter. 113 * 114 ***************************************************************************** 115 * 116 * Alternatively, you may choose to be licensed under the terms of the 117 * following license: 118 * 119 * Redistribution and use in source and binary forms, with or without 120 * modification, are permitted provided that the following conditions 121 * are met: 122 * 1. Redistributions of source code must retain the above copyright 123 * notice, this list of conditions, and the following disclaimer, 124 * without modification. 125 * 2. Redistributions in binary form must reproduce at minimum a disclaimer 126 * substantially similar to the "NO WARRANTY" disclaimer below 127 * ("Disclaimer") and any redistribution must be conditioned upon 128 * including a substantially similar Disclaimer requirement for further 129 * binary redistribution. 130 * 3. Neither the names of the above-listed copyright holders nor the names 131 * of any contributors may be used to endorse or promote products derived 132 * from this software without specific prior written permission. 133 * 134 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 135 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 136 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 137 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 138 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 139 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 140 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 141 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 142 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 143 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 144 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 145 * 146 * Alternatively, you may choose to be licensed under the terms of the 147 * GNU General Public License ("GPL") version 2 as published by the Free 148 * Software Foundation. 149 * 150 *****************************************************************************/ 151 152 #include "acpi.h" 153 #include "accommon.h" 154 #include "amlcode.h" 155 #include "acparser.h" 156 #include "acdebug.h" 157 158 /* 159 * This is an os-independent implementation of line-editing services needed 160 * by the AcpiExec utility. It uses getchar() and putchar() and the existing 161 * history support provided by the AML debugger. It assumes that the terminal 162 * is in the correct line-editing mode such as raw and noecho. The OSL 163 * interface AcpiOsInitialize should do this. AcpiOsTerminate should put the 164 * terminal back into the original mode. 165 */ 166 #define _COMPONENT ACPI_OS_SERVICES 167 ACPI_MODULE_NAME ("acgetline") 168 169 170 /* Local prototypes */ 171 172 static void 173 AcpiAcClearLine ( 174 UINT32 EndOfLine, 175 UINT32 CursorPosition); 176 177 /* Various ASCII constants */ 178 179 #define _ASCII_NUL 0 180 #define _ASCII_BACKSPACE 0x08 181 #define _ASCII_TAB 0x09 182 #define _ASCII_ESCAPE 0x1B 183 #define _ASCII_SPACE 0x20 184 #define _ASCII_LEFT_BRACKET 0x5B 185 #define _ASCII_DEL 0x7F 186 #define _ASCII_UP_ARROW 'A' 187 #define _ASCII_DOWN_ARROW 'B' 188 #define _ASCII_RIGHT_ARROW 'C' 189 #define _ASCII_LEFT_ARROW 'D' 190 #define _ASCII_NEWLINE '\n' 191 192 /* Erase a single character on the input command line */ 193 194 #define ACPI_CLEAR_CHAR() \ 195 putchar (_ASCII_BACKSPACE); \ 196 putchar (_ASCII_SPACE); \ 197 putchar (_ASCII_BACKSPACE); 198 199 /* Backup cursor by Count positions */ 200 201 #define ACPI_BACKUP_CURSOR(i, Count) \ 202 for (i = 0; i < (Count); i++) \ 203 {putchar (_ASCII_BACKSPACE);} 204 205 206 /****************************************************************************** 207 * 208 * FUNCTION: AcpiAcClearLine 209 * 210 * PARAMETERS: EndOfLine - Current end-of-line index 211 * CursorPosition - Current cursor position within line 212 * 213 * RETURN: None 214 * 215 * DESCRIPTION: Clear the entire command line the hard way, but probably the 216 * most portable. 217 * 218 *****************************************************************************/ 219 220 static void 221 AcpiAcClearLine ( 222 UINT32 EndOfLine, 223 UINT32 CursorPosition) 224 { 225 UINT32 i; 226 227 228 if (CursorPosition < EndOfLine) 229 { 230 /* Clear line from current position to end of line */ 231 232 for (i = 0; i < (EndOfLine - CursorPosition); i++) 233 { 234 putchar (' '); 235 } 236 } 237 238 /* Clear the entire line */ 239 240 for (; EndOfLine > 0; EndOfLine--) 241 { 242 ACPI_CLEAR_CHAR (); 243 } 244 } 245 246 247 /****************************************************************************** 248 * 249 * FUNCTION: AcpiOsGetLine 250 * 251 * PARAMETERS: Buffer - Where to return the command line 252 * BufferLength - Maximum length of Buffer 253 * BytesRead - Where the actual byte count is returned 254 * 255 * RETURN: Status and actual bytes read 256 * 257 * DESCRIPTION: Get the next input line from the terminal. NOTE: terminal 258 * is expected to be in a mode that supports line-editing (raw, 259 * noecho). This function is intended to be very portable. Also, 260 * it uses the history support implemented in the AML debugger. 261 * 262 *****************************************************************************/ 263 264 ACPI_STATUS 265 AcpiOsGetLine ( 266 char *Buffer, 267 UINT32 BufferLength, 268 UINT32 *BytesRead) 269 { 270 char *NextCommand; 271 UINT32 MaxCommandIndex = AcpiGbl_NextCmdNum - 1; 272 UINT32 CurrentCommandIndex = MaxCommandIndex; 273 UINT32 PreviousCommandIndex = MaxCommandIndex; 274 int InputChar; 275 UINT32 CursorPosition = 0; 276 UINT32 EndOfLine = 0; 277 UINT32 i; 278 279 280 /* Always clear the line buffer before we read a new line */ 281 282 memset (Buffer, 0, BufferLength); 283 284 /* 285 * This loop gets one character at a time (except for esc sequences) 286 * until a newline or error is detected. 287 * 288 * Note: Don't attempt to write terminal control ESC sequences, even 289 * though it makes certain things more difficult. 290 */ 291 while (1) 292 { 293 if (EndOfLine >= (BufferLength - 1)) 294 { 295 return (AE_BUFFER_OVERFLOW); 296 } 297 298 InputChar = getchar (); 299 switch (InputChar) 300 { 301 default: /* This is the normal character case */ 302 303 /* Echo the character (at EOL) and copy it to the line buffer */ 304 305 if (EndOfLine == CursorPosition) 306 { 307 putchar (InputChar); 308 Buffer[EndOfLine] = (char) InputChar; 309 310 EndOfLine++; 311 CursorPosition++; 312 Buffer[EndOfLine] = 0; 313 continue; 314 } 315 316 /* Insert character into the middle of the buffer */ 317 318 memmove (&Buffer[CursorPosition + 1], &Buffer[CursorPosition], 319 (EndOfLine - CursorPosition + 1)); 320 321 Buffer [CursorPosition] = (char) InputChar; 322 Buffer [EndOfLine + 1] = 0; 323 324 /* Display the new part of line starting at the new character */ 325 326 fprintf (stdout, "%s", &Buffer[CursorPosition]); 327 328 /* Restore cursor */ 329 330 ACPI_BACKUP_CURSOR (i, EndOfLine - CursorPosition); 331 CursorPosition++; 332 EndOfLine++; 333 continue; 334 335 case _ASCII_DEL: /* Backspace key */ 336 337 if (!EndOfLine) /* Any characters on the command line? */ 338 { 339 continue; 340 } 341 342 if (EndOfLine == CursorPosition) /* Erase the final character */ 343 { 344 ACPI_CLEAR_CHAR (); 345 EndOfLine--; 346 CursorPosition--; 347 continue; 348 } 349 350 if (!CursorPosition) /* Do not backup beyond start of line */ 351 { 352 continue; 353 } 354 355 /* Remove the character from the line */ 356 357 memmove (&Buffer[CursorPosition - 1], &Buffer[CursorPosition], 358 (EndOfLine - CursorPosition + 1)); 359 360 /* Display the new part of line starting at the new character */ 361 362 putchar (_ASCII_BACKSPACE); 363 fprintf (stdout, "%s ", &Buffer[CursorPosition - 1]); 364 365 /* Restore cursor */ 366 367 ACPI_BACKUP_CURSOR (i, EndOfLine - CursorPosition + 1); 368 EndOfLine--; 369 370 if (CursorPosition > 0) 371 { 372 CursorPosition--; 373 } 374 continue; 375 376 case _ASCII_NEWLINE: /* Normal exit case at end of command line */ 377 case _ASCII_NUL: 378 379 /* Return the number of bytes in the command line string */ 380 381 if (BytesRead) 382 { 383 *BytesRead = EndOfLine; 384 } 385 386 /* Echo, terminate string buffer, and exit */ 387 388 putchar (InputChar); 389 Buffer[EndOfLine] = 0; 390 return (AE_OK); 391 392 case _ASCII_TAB: 393 394 /* Ignore */ 395 396 continue; 397 398 case EOF: 399 400 return (AE_ERROR); 401 402 case _ASCII_ESCAPE: 403 404 /* Check for escape sequences of the form "ESC[x" */ 405 406 InputChar = getchar (); 407 if (InputChar != _ASCII_LEFT_BRACKET) 408 { 409 continue; /* Ignore this ESC, does not have the '[' */ 410 } 411 412 /* Get the code following the ESC [ */ 413 414 InputChar = getchar (); /* Backup one character */ 415 switch (InputChar) 416 { 417 case _ASCII_LEFT_ARROW: 418 419 if (CursorPosition > 0) 420 { 421 putchar (_ASCII_BACKSPACE); 422 CursorPosition--; 423 } 424 continue; 425 426 case _ASCII_RIGHT_ARROW: 427 /* 428 * Move one character forward. Do this without sending 429 * ESC sequence to the terminal for max portability. 430 */ 431 if (CursorPosition < EndOfLine) 432 { 433 /* Backup to start of line and print the entire line */ 434 435 ACPI_BACKUP_CURSOR (i, CursorPosition); 436 fprintf (stdout, "%s", Buffer); 437 438 /* Backup to where the cursor should be */ 439 440 CursorPosition++; 441 ACPI_BACKUP_CURSOR (i, EndOfLine - CursorPosition); 442 } 443 continue; 444 445 case _ASCII_UP_ARROW: 446 447 /* If no commands available or at start of history list, ignore */ 448 449 if (!CurrentCommandIndex) 450 { 451 continue; 452 } 453 454 /* Manage our up/down progress */ 455 456 if (CurrentCommandIndex > PreviousCommandIndex) 457 { 458 CurrentCommandIndex = PreviousCommandIndex; 459 } 460 461 /* Get the historical command from the debugger */ 462 463 NextCommand = AcpiDbGetHistoryByIndex (CurrentCommandIndex); 464 if (!NextCommand) 465 { 466 return (AE_ERROR); 467 } 468 469 /* Make this the active command and echo it */ 470 471 AcpiAcClearLine (EndOfLine, CursorPosition); 472 strcpy (Buffer, NextCommand); 473 fprintf (stdout, "%s", Buffer); 474 EndOfLine = CursorPosition = strlen (Buffer); 475 476 PreviousCommandIndex = CurrentCommandIndex; 477 CurrentCommandIndex--; 478 continue; 479 480 case _ASCII_DOWN_ARROW: 481 482 if (!MaxCommandIndex) /* Any commands available? */ 483 { 484 continue; 485 } 486 487 /* Manage our up/down progress */ 488 489 if (CurrentCommandIndex < PreviousCommandIndex) 490 { 491 CurrentCommandIndex = PreviousCommandIndex; 492 } 493 494 /* If we are the end of the history list, output a clear new line */ 495 496 if ((CurrentCommandIndex + 1) > MaxCommandIndex) 497 { 498 AcpiAcClearLine (EndOfLine, CursorPosition); 499 EndOfLine = CursorPosition = 0; 500 PreviousCommandIndex = CurrentCommandIndex; 501 continue; 502 } 503 504 PreviousCommandIndex = CurrentCommandIndex; 505 CurrentCommandIndex++; 506 507 /* Get the historical command from the debugger */ 508 509 NextCommand = AcpiDbGetHistoryByIndex (CurrentCommandIndex); 510 if (!NextCommand) 511 { 512 return (AE_ERROR); 513 } 514 515 /* Make this the active command and echo it */ 516 517 AcpiAcClearLine (EndOfLine, CursorPosition); 518 strcpy (Buffer, NextCommand); 519 fprintf (stdout, "%s", Buffer); 520 EndOfLine = CursorPosition = strlen (Buffer); 521 continue; 522 523 case 0x31: 524 case 0x32: 525 case 0x33: 526 case 0x34: 527 case 0x35: 528 case 0x36: 529 /* 530 * Ignore the various keys like insert/delete/home/end, etc. 531 * But we must eat the final character of the ESC sequence. 532 */ 533 (void) getchar (); 534 continue; 535 536 default: 537 538 /* Ignore random escape sequences that we don't care about */ 539 540 continue; 541 } 542 continue; 543 } 544 } 545 } 546