BPicture: Fix archive constructor.
[haiku.git] / src / add-ons / kernel / bus_managers / acpi / acpica / components / utilities / utprint.c
blob543bad8fcea8183fd16fd5b227ea76cac93a1c5c
1 /******************************************************************************
3 * Module Name: utprint - Formatted printing routines
5 *****************************************************************************/
7 /******************************************************************************
9 * 1. Copyright Notice
11 * Some or all of this work - Copyright (c) 1999 - 2014, Intel Corp.
12 * All rights reserved.
14 * 2. License
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.
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
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;
37 * The above copyright and patent license is granted only if the following
38 * conditions are met:
40 * 3. Conditions
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.
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.
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.
72 * 3.4. Intel retains all right, title, and interest in and to the Original
73 * Intel Code.
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.
80 * 4. Disclaimer and Export Compliance
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.
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.
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.
114 *****************************************************************************/
116 #include "acpi.h"
117 #include "accommon.h"
119 #define _COMPONENT ACPI_UTILITIES
120 ACPI_MODULE_NAME ("utprint")
123 #define ACPI_FORMAT_SIGN 0x01
124 #define ACPI_FORMAT_SIGN_PLUS 0x02
125 #define ACPI_FORMAT_SIGN_PLUS_SPACE 0x04
126 #define ACPI_FORMAT_ZERO 0x08
127 #define ACPI_FORMAT_LEFT 0x10
128 #define ACPI_FORMAT_UPPER 0x20
129 #define ACPI_FORMAT_PREFIX 0x40
132 /* Local prototypes */
134 static ACPI_SIZE
135 AcpiUtBoundStringLength (
136 const char *String,
137 ACPI_SIZE Count);
139 static char *
140 AcpiUtBoundStringOutput (
141 char *String,
142 const char *End,
143 char c);
145 static char *
146 AcpiUtFormatNumber (
147 char *String,
148 char *End,
149 UINT64 Number,
150 UINT8 Base,
151 INT32 Width,
152 INT32 Precision,
153 UINT8 Type);
155 static char *
156 AcpiUtPutNumber (
157 char *String,
158 UINT64 Number,
159 UINT8 Base,
160 BOOLEAN Upper);
163 /* Module globals */
165 static const char AcpiGbl_LowerHexDigits[] = "0123456789abcdef";
166 static const char AcpiGbl_UpperHexDigits[] = "0123456789ABCDEF";
169 /*******************************************************************************
171 * FUNCTION: AcpiUtBoundStringLength
173 * PARAMETERS: String - String with boundary
174 * Count - Boundary of the string
176 * RETURN: Length of the string. Less than or equal to Count.
178 * DESCRIPTION: Calculate the length of a string with boundary.
180 ******************************************************************************/
182 static ACPI_SIZE
183 AcpiUtBoundStringLength (
184 const char *String,
185 ACPI_SIZE Count)
187 UINT32 Length = 0;
190 while (*String && Count)
192 Length++;
193 String++;
194 Count--;
197 return (Length);
201 /*******************************************************************************
203 * FUNCTION: AcpiUtBoundStringOutput
205 * PARAMETERS: String - String with boundary
206 * End - Boundary of the string
207 * c - Character to be output to the string
209 * RETURN: Updated position for next valid character
211 * DESCRIPTION: Output a character into a string with boundary check.
213 ******************************************************************************/
215 static char *
216 AcpiUtBoundStringOutput (
217 char *String,
218 const char *End,
219 char c)
222 if (String < End)
224 *String = c;
227 ++String;
228 return (String);
232 /*******************************************************************************
234 * FUNCTION: AcpiUtPutNumber
236 * PARAMETERS: String - Buffer to hold reverse-ordered string
237 * Number - Integer to be converted
238 * Base - Base of the integer
239 * Upper - Whether or not using upper cased digits
241 * RETURN: Updated position for next valid character
243 * DESCRIPTION: Convert an integer into a string, note that, the string holds a
244 * reversed ordered number without the trailing zero.
246 ******************************************************************************/
248 static char *
249 AcpiUtPutNumber (
250 char *String,
251 UINT64 Number,
252 UINT8 Base,
253 BOOLEAN Upper)
255 const char *Digits;
256 UINT64 DigitIndex;
257 char *Pos;
260 Pos = String;
261 Digits = Upper ? AcpiGbl_UpperHexDigits : AcpiGbl_LowerHexDigits;
263 if (Number == 0)
265 *(Pos++) = '0';
267 else
269 while (Number)
271 (void) AcpiUtDivide (Number, Base, &Number, &DigitIndex);
272 *(Pos++) = Digits[DigitIndex];
276 /* *(Pos++) = '0'; */
277 return (Pos);
281 /*******************************************************************************
283 * FUNCTION: AcpiUtScanNumber
285 * PARAMETERS: String - String buffer
286 * NumberPtr - Where the number is returned
288 * RETURN: Updated position for next valid character
290 * DESCRIPTION: Scan a string for a decimal integer.
292 ******************************************************************************/
294 const char *
295 AcpiUtScanNumber (
296 const char *String,
297 UINT64 *NumberPtr)
299 UINT64 Number = 0;
302 while (ACPI_IS_DIGIT (*String))
304 Number *= 10;
305 Number += *(String++) - '0';
308 *NumberPtr = Number;
309 return (String);
313 /*******************************************************************************
315 * FUNCTION: AcpiUtPrintNumber
317 * PARAMETERS: String - String buffer
318 * Number - The number to be converted
320 * RETURN: Updated position for next valid character
322 * DESCRIPTION: Print a decimal integer into a string.
324 ******************************************************************************/
326 const char *
327 AcpiUtPrintNumber (
328 char *String,
329 UINT64 Number)
331 char AsciiString[20];
332 const char *Pos1;
333 char *Pos2;
336 Pos1 = AcpiUtPutNumber (AsciiString, Number, 10, FALSE);
337 Pos2 = String;
339 while (Pos1 != AsciiString)
341 *(Pos2++) = *(--Pos1);
344 *Pos2 = 0;
345 return (String);
349 /*******************************************************************************
351 * FUNCTION: AcpiUtFormatNumber
353 * PARAMETERS: String - String buffer with boundary
354 * End - Boundary of the string
355 * Number - The number to be converted
356 * Base - Base of the integer
357 * Width - Field width
358 * Precision - Precision of the integer
359 * Type - Special printing flags
361 * RETURN: Updated position for next valid character
363 * DESCRIPTION: Print an integer into a string with any base and any precision.
365 ******************************************************************************/
367 static char *
368 AcpiUtFormatNumber (
369 char *String,
370 char *End,
371 UINT64 Number,
372 UINT8 Base,
373 INT32 Width,
374 INT32 Precision,
375 UINT8 Type)
377 char *Pos;
378 char Sign;
379 char Zero;
380 BOOLEAN NeedPrefix;
381 BOOLEAN Upper;
382 INT32 i;
383 char ReversedString[66];
386 /* Parameter validation */
388 if (Base < 2 || Base > 16)
390 return (NULL);
393 if (Type & ACPI_FORMAT_LEFT)
395 Type &= ~ACPI_FORMAT_ZERO;
398 NeedPrefix = ((Type & ACPI_FORMAT_PREFIX) && Base != 10) ? TRUE : FALSE;
399 Upper = (Type & ACPI_FORMAT_UPPER) ? TRUE : FALSE;
400 Zero = (Type & ACPI_FORMAT_ZERO) ? '0' : ' ';
402 /* Calculate size according to sign and prefix */
404 Sign = '\0';
405 if (Type & ACPI_FORMAT_SIGN)
407 if ((INT64) Number < 0)
409 Sign = '-';
410 Number = - (INT64) Number;
411 Width--;
413 else if (Type & ACPI_FORMAT_SIGN_PLUS)
415 Sign = '+';
416 Width--;
418 else if (Type & ACPI_FORMAT_SIGN_PLUS_SPACE)
420 Sign = ' ';
421 Width--;
424 if (NeedPrefix)
426 Width--;
427 if (Base == 16)
429 Width--;
433 /* Generate full string in reverse order */
435 Pos = AcpiUtPutNumber (ReversedString, Number, Base, Upper);
436 i = ACPI_PTR_DIFF (Pos, ReversedString);
438 /* Printing 100 using %2d gives "100", not "00" */
440 if (i > Precision)
442 Precision = i;
445 Width -= Precision;
447 /* Output the string */
449 if (!(Type & (ACPI_FORMAT_ZERO | ACPI_FORMAT_LEFT)))
451 while (--Width >= 0)
453 String = AcpiUtBoundStringOutput (String, End, ' ');
456 if (Sign)
458 String = AcpiUtBoundStringOutput (String, End, Sign);
460 if (NeedPrefix)
462 String = AcpiUtBoundStringOutput (String, End, '0');
463 if (Base == 16)
465 String = AcpiUtBoundStringOutput (String, End,
466 Upper ? 'X' : 'x');
469 if (!(Type & ACPI_FORMAT_LEFT))
471 while (--Width >= 0)
473 String = AcpiUtBoundStringOutput (String, End, Zero);
477 while (i <= --Precision)
479 String = AcpiUtBoundStringOutput (String, End, '0');
481 while (--i >= 0)
483 String = AcpiUtBoundStringOutput (String, End,
484 ReversedString[i]);
486 while (--Width >= 0)
488 String = AcpiUtBoundStringOutput (String, End, ' ');
491 return (String);
495 /*******************************************************************************
497 * FUNCTION: AcpiUtVsnprintf
499 * PARAMETERS: String - String with boundary
500 * Size - Boundary of the string
501 * Format - Standard printf format
502 * Args - Argument list
504 * RETURN: Number of bytes actually written.
506 * DESCRIPTION: Formatted output to a string using argument list pointer.
508 ******************************************************************************/
511 AcpiUtVsnprintf (
512 char *String,
513 ACPI_SIZE Size,
514 const char *Format,
515 va_list Args)
517 UINT8 Base = 10;
518 UINT8 Type = 0;
519 INT32 Width = -1;
520 INT32 Precision = -1;
521 char Qualifier = 0;
522 UINT64 Number;
523 char *Pos;
524 char *End;
525 char c;
526 const char *s;
527 const void *p;
528 INT32 Length;
529 int i;
532 Pos = String;
533 End = String + Size;
535 for (; *Format; ++Format)
537 if (*Format != '%')
539 Pos = AcpiUtBoundStringOutput (Pos, End, *Format);
540 continue;
543 /* Process sign */
547 ++Format;
548 if (*Format == '#')
550 Type |= ACPI_FORMAT_PREFIX;
552 else if (*Format == '0')
554 Type |= ACPI_FORMAT_ZERO;
556 else if (*Format == '+')
558 Type |= ACPI_FORMAT_SIGN_PLUS;
560 else if (*Format == ' ')
562 Type |= ACPI_FORMAT_SIGN_PLUS_SPACE;
564 else if (*Format == '-')
566 Type |= ACPI_FORMAT_LEFT;
568 else
570 break;
572 } while (1);
574 /* Process width */
576 Width = -1;
577 if (ACPI_IS_DIGIT (*Format))
579 Format = AcpiUtScanNumber (Format, &Number);
580 Width = (INT32) Number;
582 else if (*Format == '*')
584 ++Format;
585 Width = va_arg (Args, int);
586 if (Width < 0)
588 Width = -Width;
589 Type |= ACPI_FORMAT_LEFT;
593 /* Process precision */
595 Precision = -1;
596 if (*Format == '.')
598 ++Format;
599 if (ACPI_IS_DIGIT(*Format))
601 Format = AcpiUtScanNumber (Format, &Number);
602 Precision = (INT32) Number;
604 else if (*Format == '*')
606 ++Format;
607 Precision = va_arg (Args, int);
609 if (Precision < 0)
611 Precision = 0;
615 /* Process qualifier */
617 Qualifier = -1;
618 if (*Format == 'h' || *Format == 'l' || *Format == 'L')
620 Qualifier = *Format;
621 ++Format;
623 if (Qualifier == 'l' && *Format == 'l')
625 Qualifier = 'L';
626 ++Format;
630 switch (*Format)
632 case '%':
634 Pos = AcpiUtBoundStringOutput (Pos, End, '%');
635 continue;
637 case 'c':
639 if (!(Type & ACPI_FORMAT_LEFT))
641 while (--Width > 0)
643 Pos = AcpiUtBoundStringOutput (Pos, End, ' ');
647 c = (char) va_arg (Args, int);
648 Pos = AcpiUtBoundStringOutput (Pos, End, c);
650 while (--Width > 0)
652 Pos = AcpiUtBoundStringOutput (Pos, End, ' ');
654 continue;
656 case 's':
658 s = va_arg (Args, char *);
659 if (!s)
661 s = "<NULL>";
663 Length = AcpiUtBoundStringLength (s, Precision);
664 if (!(Type & ACPI_FORMAT_LEFT))
666 while (Length < Width--)
668 Pos = AcpiUtBoundStringOutput (Pos, End, ' ');
671 for (i = 0; i < Length; ++i)
673 Pos = AcpiUtBoundStringOutput (Pos, End, *s);
674 ++s;
676 while (Length < Width--)
678 Pos = AcpiUtBoundStringOutput (Pos, End, ' ');
680 continue;
682 case 'o':
684 Base = 8;
685 break;
687 case 'X':
689 Type |= ACPI_FORMAT_UPPER;
691 case 'x':
693 Base = 16;
694 break;
696 case 'd':
697 case 'i':
699 Type |= ACPI_FORMAT_SIGN;
701 case 'u':
703 break;
705 case 'p':
707 if (Width == -1)
709 Width = 2 * sizeof (void *);
710 Type |= ACPI_FORMAT_ZERO;
713 p = va_arg (Args, void *);
714 Pos = AcpiUtFormatNumber (Pos, End,
715 ACPI_TO_INTEGER (p), 16, Width, Precision, Type);
716 continue;
718 default:
720 Pos = AcpiUtBoundStringOutput (Pos, End, '%');
721 if (*Format)
723 Pos = AcpiUtBoundStringOutput (Pos, End, *Format);
725 else
727 --Format;
729 continue;
732 if (Qualifier == 'L')
734 Number = va_arg (Args, UINT64);
735 if (Type & ACPI_FORMAT_SIGN)
737 Number = (INT64) Number;
740 else if (Qualifier == 'l')
742 Number = va_arg (Args, unsigned long);
743 if (Type & ACPI_FORMAT_SIGN)
745 Number = (INT32) Number;
748 else if (Qualifier == 'h')
750 Number = (UINT16) va_arg (Args, int);
751 if (Type & ACPI_FORMAT_SIGN)
753 Number = (INT16) Number;
756 else
758 Number = va_arg (Args, unsigned int);
759 if (Type & ACPI_FORMAT_SIGN)
761 Number = (signed int) Number;
765 Pos = AcpiUtFormatNumber (Pos, End, Number, Base,
766 Width, Precision, Type);
769 if (Size > 0)
771 if (Pos < End)
773 *Pos = '\0';
775 else
777 End[-1] = '\0';
781 return (ACPI_PTR_DIFF (Pos, String));
785 /*******************************************************************************
787 * FUNCTION: AcpiUtSnprintf
789 * PARAMETERS: String - String with boundary
790 * Size - Boundary of the string
791 * Format, ... - Standard printf format
793 * RETURN: Number of bytes actually written.
795 * DESCRIPTION: Formatted output to a string.
797 ******************************************************************************/
800 AcpiUtSnprintf (
801 char *String,
802 ACPI_SIZE Size,
803 const char *Format,
804 ...)
806 va_list Args;
807 int Length;
810 va_start (Args, Format);
811 Length = AcpiUtVsnprintf (String, Size, Format, Args);
812 va_end (Args);
814 return (Length);
818 #ifdef ACPI_APPLICATION
819 /*******************************************************************************
821 * FUNCTION: AcpiUtFileVprintf
823 * PARAMETERS: File - File descriptor
824 * Format - Standard printf format
825 * Args - Argument list
827 * RETURN: Number of bytes actually written.
829 * DESCRIPTION: Formatted output to a file using argument list pointer.
831 ******************************************************************************/
834 AcpiUtFileVprintf (
835 ACPI_FILE File,
836 const char *Format,
837 va_list Args)
839 ACPI_CPU_FLAGS Flags;
840 int Length;
843 Flags = AcpiOsAcquireLock (AcpiGbl_PrintLock);
844 Length = AcpiUtVsnprintf (AcpiGbl_PrintBuffer,
845 sizeof (AcpiGbl_PrintBuffer), Format, Args);
847 (void) AcpiOsWriteFile (File, AcpiGbl_PrintBuffer, Length, 1);
848 AcpiOsReleaseLock (AcpiGbl_PrintLock, Flags);
850 return (Length);
854 /*******************************************************************************
856 * FUNCTION: AcpiUtFilePrintf
858 * PARAMETERS: File - File descriptor
859 * Format, ... - Standard printf format
861 * RETURN: Number of bytes actually written.
863 * DESCRIPTION: Formatted output to a file.
865 ******************************************************************************/
868 AcpiUtFilePrintf (
869 ACPI_FILE File,
870 const char *Format,
871 ...)
873 va_list Args;
874 int Length;
877 va_start (Args, Format);
878 Length = AcpiUtFileVprintf (File, Format, Args);
879 va_end (Args);
881 return (Length);
883 #endif