xref: /illumos-gate/usr/src/cmd/acpi/common/acgetline.c (revision 35786f68)
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 - 2018, 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 extern UINT32               AcpiGbl_NextCmdNum;
193 
194 /* Erase a single character on the input command line */
195 
196 #define ACPI_CLEAR_CHAR() \
197     putchar (_ASCII_BACKSPACE); \
198     putchar (_ASCII_SPACE); \
199     putchar (_ASCII_BACKSPACE);
200 
201 /* Backup cursor by Count positions */
202 
203 #define ACPI_BACKUP_CURSOR(i, Count) \
204     for (i = 0; i < (Count); i++) \
205         {putchar (_ASCII_BACKSPACE);}
206 
207 
208 /******************************************************************************
209  *
210  * FUNCTION:    AcpiAcClearLine
211  *
212  * PARAMETERS:  EndOfLine           - Current end-of-line index
213  *              CursorPosition      - Current cursor position within line
214  *
215  * RETURN:      None
216  *
217  * DESCRIPTION: Clear the entire command line the hard way, but probably the
218  *              most portable.
219  *
220  *****************************************************************************/
221 
222 static void
AcpiAcClearLine(UINT32 EndOfLine,UINT32 CursorPosition)223 AcpiAcClearLine (
224     UINT32                  EndOfLine,
225     UINT32                  CursorPosition)
226 {
227     UINT32                  i;
228 
229 
230     if (CursorPosition < EndOfLine)
231     {
232         /* Clear line from current position to end of line */
233 
234         for (i = 0; i < (EndOfLine - CursorPosition); i++)
235         {
236             putchar (' ');
237         }
238     }
239 
240     /* Clear the entire line */
241 
242     for (; EndOfLine > 0; EndOfLine--)
243     {
244         ACPI_CLEAR_CHAR ();
245     }
246 }
247 
248 
249 /******************************************************************************
250  *
251  * FUNCTION:    AcpiOsGetLine
252  *
253  * PARAMETERS:  Buffer              - Where to return the command line
254  *              BufferLength        - Maximum length of Buffer
255  *              BytesRead           - Where the actual byte count is returned
256  *
257  * RETURN:      Status and actual bytes read
258  *
259  * DESCRIPTION: Get the next input line from the terminal. NOTE: terminal
260  *              is expected to be in a mode that supports line-editing (raw,
261  *              noecho). This function is intended to be very portable. Also,
262  *              it uses the history support implemented in the AML debugger.
263  *
264  *****************************************************************************/
265 
266 ACPI_STATUS
AcpiOsGetLine(char * Buffer,UINT32 BufferLength,UINT32 * BytesRead)267 AcpiOsGetLine (
268     char                    *Buffer,
269     UINT32                  BufferLength,
270     UINT32                  *BytesRead)
271 {
272     char                    *NextCommand;
273     UINT32                  MaxCommandIndex = AcpiGbl_NextCmdNum - 1;
274     UINT32                  CurrentCommandIndex = MaxCommandIndex;
275     UINT32                  PreviousCommandIndex = MaxCommandIndex;
276     int                     InputChar;
277     UINT32                  CursorPosition = 0;
278     UINT32                  EndOfLine = 0;
279     UINT32                  i;
280 
281 
282     /* Always clear the line buffer before we read a new line */
283 
284     memset (Buffer, 0, BufferLength);
285 
286     /*
287      * This loop gets one character at a time (except for esc sequences)
288      * until a newline or error is detected.
289      *
290      * Note: Don't attempt to write terminal control ESC sequences, even
291      * though it makes certain things more difficult.
292      */
293     while (1)
294     {
295         if (EndOfLine >= (BufferLength - 1))
296         {
297             return (AE_BUFFER_OVERFLOW);
298         }
299 
300         InputChar = getchar ();
301         switch (InputChar)
302         {
303         default: /* This is the normal character case */
304 
305             /* Echo the character (at EOL) and copy it to the line buffer */
306 
307             if (EndOfLine == CursorPosition)
308             {
309                 putchar (InputChar);
310                 Buffer[EndOfLine] = (char) InputChar;
311 
312                 EndOfLine++;
313                 CursorPosition++;
314                 Buffer[EndOfLine] = 0;
315                 continue;
316             }
317 
318             /* Insert character into the middle of the buffer */
319 
320             memmove (&Buffer[CursorPosition + 1], &Buffer[CursorPosition],
321                 (EndOfLine - CursorPosition + 1));
322 
323             Buffer [CursorPosition] = (char) InputChar;
324             Buffer [EndOfLine + 1] = 0;
325 
326             /* Display the new part of line starting at the new character */
327 
328             fprintf (stdout, "%s", &Buffer[CursorPosition]);
329 
330             /* Restore cursor */
331 
332             ACPI_BACKUP_CURSOR (i, EndOfLine - CursorPosition);
333             CursorPosition++;
334             EndOfLine++;
335             continue;
336 
337         case _ASCII_DEL: /* Backspace key */
338 
339             if (!EndOfLine) /* Any characters on the command line? */
340             {
341                 continue;
342             }
343 
344             if (EndOfLine == CursorPosition) /* Erase the final character */
345             {
346                 ACPI_CLEAR_CHAR ();
347                 EndOfLine--;
348                 CursorPosition--;
349                 continue;
350             }
351 
352             if (!CursorPosition) /* Do not backup beyond start of line */
353             {
354                 continue;
355             }
356 
357             /* Remove the character from the line */
358 
359             memmove (&Buffer[CursorPosition - 1], &Buffer[CursorPosition],
360                 (EndOfLine - CursorPosition + 1));
361 
362             /* Display the new part of line starting at the new character */
363 
364             putchar (_ASCII_BACKSPACE);
365             fprintf (stdout, "%s ", &Buffer[CursorPosition - 1]);
366 
367             /* Restore cursor */
368 
369             ACPI_BACKUP_CURSOR (i, EndOfLine - CursorPosition + 1);
370             EndOfLine--;
371 
372             if (CursorPosition > 0)
373             {
374                 CursorPosition--;
375             }
376             continue;
377 
378         case _ASCII_NEWLINE: /* Normal exit case at end of command line */
379         case _ASCII_NUL:
380 
381             /* Return the number of bytes in the command line string */
382 
383             if (BytesRead)
384             {
385                 *BytesRead = EndOfLine;
386             }
387 
388             /* Echo, terminate string buffer, and exit */
389 
390             putchar (InputChar);
391             Buffer[EndOfLine] = 0;
392             return (AE_OK);
393 
394         case _ASCII_TAB:
395 
396             /* Ignore */
397 
398             continue;
399 
400         case EOF:
401 
402             return (AE_ERROR);
403 
404         case _ASCII_ESCAPE:
405 
406             /* Check for escape sequences of the form "ESC[x" */
407 
408             InputChar = getchar ();
409             if (InputChar != _ASCII_LEFT_BRACKET)
410             {
411                 continue; /* Ignore this ESC, does not have the '[' */
412             }
413 
414             /* Get the code following the ESC [ */
415 
416             InputChar = getchar (); /* Backup one character */
417             switch (InputChar)
418             {
419             case _ASCII_LEFT_ARROW:
420 
421                 if (CursorPosition > 0)
422                 {
423                     putchar (_ASCII_BACKSPACE);
424                     CursorPosition--;
425                 }
426                 continue;
427 
428             case _ASCII_RIGHT_ARROW:
429                 /*
430                  * Move one character forward. Do this without sending
431                  * ESC sequence to the terminal for max portability.
432                  */
433                 if (CursorPosition < EndOfLine)
434                 {
435                     /* Backup to start of line and print the entire line */
436 
437                     ACPI_BACKUP_CURSOR (i, CursorPosition);
438                     fprintf (stdout, "%s", Buffer);
439 
440                     /* Backup to where the cursor should be */
441 
442                     CursorPosition++;
443                     ACPI_BACKUP_CURSOR (i, EndOfLine - CursorPosition);
444                 }
445                 continue;
446 
447             case _ASCII_UP_ARROW:
448 
449                 /* If no commands available or at start of history list, ignore */
450 
451                 if (!CurrentCommandIndex)
452                 {
453                     continue;
454                 }
455 
456                 /* Manage our up/down progress */
457 
458                 if (CurrentCommandIndex > PreviousCommandIndex)
459                 {
460                     CurrentCommandIndex = PreviousCommandIndex;
461                 }
462 
463                 /* Get the historical command from the debugger */
464 
465                 NextCommand = AcpiDbGetHistoryByIndex (CurrentCommandIndex);
466                 if (!NextCommand)
467                 {
468                     return (AE_ERROR);
469                 }
470 
471                 /* Make this the active command and echo it */
472 
473                 AcpiAcClearLine (EndOfLine, CursorPosition);
474                 strcpy (Buffer, NextCommand);
475                 fprintf (stdout, "%s", Buffer);
476                 EndOfLine = CursorPosition = strlen (Buffer);
477 
478                 PreviousCommandIndex = CurrentCommandIndex;
479                 CurrentCommandIndex--;
480                 continue;
481 
482             case _ASCII_DOWN_ARROW:
483 
484                 if (!MaxCommandIndex) /* Any commands available? */
485                 {
486                     continue;
487                 }
488 
489                 /* Manage our up/down progress */
490 
491                 if (CurrentCommandIndex < PreviousCommandIndex)
492                 {
493                     CurrentCommandIndex = PreviousCommandIndex;
494                 }
495 
496                 /* If we are the end of the history list, output a clear new line */
497 
498                 if ((CurrentCommandIndex + 1) > MaxCommandIndex)
499                 {
500                     AcpiAcClearLine (EndOfLine, CursorPosition);
501                     EndOfLine = CursorPosition = 0;
502                     PreviousCommandIndex = CurrentCommandIndex;
503                     continue;
504                 }
505 
506                 PreviousCommandIndex = CurrentCommandIndex;
507                 CurrentCommandIndex++;
508 
509                  /* Get the historical command from the debugger */
510 
511                 NextCommand = AcpiDbGetHistoryByIndex (CurrentCommandIndex);
512                 if (!NextCommand)
513                 {
514                     return (AE_ERROR);
515                 }
516 
517                 /* Make this the active command and echo it */
518 
519                 AcpiAcClearLine (EndOfLine, CursorPosition);
520                 strcpy (Buffer, NextCommand);
521                 fprintf (stdout, "%s", Buffer);
522                 EndOfLine = CursorPosition = strlen (Buffer);
523                 continue;
524 
525             case 0x31:
526             case 0x32:
527             case 0x33:
528             case 0x34:
529             case 0x35:
530             case 0x36:
531                 /*
532                  * Ignore the various keys like insert/delete/home/end, etc.
533                  * But we must eat the final character of the ESC sequence.
534                  */
535                 InputChar = getchar ();
536                 continue;
537 
538             default:
539 
540                 /* Ignore random escape sequences that we don't care about */
541 
542                 continue;
543             }
544             continue;
545         }
546     }
547 }
548