1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873
|
//===--- StaticPrint.swift ------------------------------------------------===//
//
// This source file is part of the Swift.org open source project
//
// Copyright (c) 2021 Apple Inc. and the Swift project authors
// Licensed under Apache License v2.0 with Runtime Library Exception
//
// See https://swift.org/LICENSE.txt for license information
// See https://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
//
//===----------------------------------------------------------------------===//
#if SWIFT_STDLIB_STATIC_PRINT
import SwiftShims
extension String {
/// Replace all percents "%" in the string by "%%" so that the string can be
/// interpreted as a C format string. This function is constant evaluable
/// and its semantics is modeled within the evaluator.
@inlinable
internal var percentEscapedString: String {
@_semantics("string.escapePercent.get")
@_effects(readonly)
@_optimize(none)
get {
return self
.split(separator: "%", omittingEmptySubsequences: false)
.joined(separator: "%%")
}
}
}
extension ConstantVPrintFInterpolation {
/// Defines interpolation for UnsafeRawBufferPointer.
///
/// Do not call this function directly.
///
/// - Parameters:
/// - pointer: The interpolated expression of type `UnsafeRawBufferPointer`,
/// which is autoclosured.
@_semantics("constant_evaluable")
@inlinable
@_optimize(none)
@_semantics("oslog.requires_constant_arguments")
public mutating func appendInterpolation(
_ pointer: @autoclosure @escaping () -> UnsafeRawBufferPointer
) {
appendInterpolation(pointer().baseAddress!)
}
/// Defines interpolation for UnsafeRawPointer.
///
/// Do not call this function directly.
///
/// - Parameters:
/// - pointer: The interpolated expression of type `UnsafeRawPointer`, which is autoclosured.
@_semantics("constant_evaluable")
@inlinable
@_optimize(none)
@_semantics("oslog.requires_constant_arguments")
public mutating func appendInterpolation(
_ pointer: @autoclosure @escaping () -> UnsafeRawPointer
) {
formatString += "%p"
arguments.append(pointer)
}
}
@frozen
public struct ConstantVPrintFIntegerFormatting {
/// The base to use for the string representation. `radix` must be at least 2
/// and at most 36. The default is 10.
@usableFromInline
internal var radix: Int
/// When set, a `+` will be printed for all non-negative integers.
@usableFromInline
internal var explicitPositiveSign: Bool
/// When set, a prefix: 0b or 0o or 0x will be added when the radix is 2, 8 or
/// 16 respectively.
@usableFromInline
internal var includePrefix: Bool
/// Whether to use uppercase letters to represent numerals
/// greater than 9 (default is to use lowercase).
@usableFromInline
internal var uppercase: Bool
/// Minimum number of digits to display. Numbers having fewer digits than
/// minDigits will be displayed with leading zeros.
@usableFromInline
internal var minDigits: (() -> Int)?
/// Initializes all stored properties.
///
/// - Parameters:
/// - radix: The base to use for the string representation. `radix` must be
/// at least 2 and at most 36. The default is 10.
/// - explicitPositiveSign: Pass `true` to add a + sign to non-negative
/// numbers. Default is `false`.
/// - includePrefix: Pass `true` to add a prefix: 0b, 0o, 0x to corresponding
/// radices. Default is `false`.
/// - uppercase: Pass `true` to use uppercase letters to represent numerals
/// greater than 9, or `false` to use lowercase letters. The default is
/// `false`.
/// - minDigits: minimum number of digits to display. Numbers will be
/// prefixed with zeros if necessary to meet the minimum. The default is 1.
@_transparent
@usableFromInline
internal init(
radix: Int = 10,
explicitPositiveSign: Bool = false,
includePrefix: Bool = false,
uppercase: Bool = false,
minDigits: (() -> Int)?
) {
self.radix = radix
self.explicitPositiveSign = explicitPositiveSign
self.includePrefix = includePrefix
self.uppercase = uppercase
self.minDigits = minDigits
}
/// Displays an interpolated integer as a decimal number with the specified number
/// of digits and an optional sign.
///
/// The parameter `explicitPositiveSign` must be a boolean literal. The
/// parameter `minDigits` can be an arbitrary expression.
///
/// - Parameters:
/// - explicitPositiveSign: Pass `true` to add a + sign to non-negative
/// numbers.
/// - minDigits: minimum number of digits to display. Numbers will be
/// prefixed with zeros if necessary to meet the minimum.
@_semantics("constant_evaluable")
@inlinable
@_optimize(none)
public static func decimal(
explicitPositiveSign: Bool = false,
minDigits: @escaping @autoclosure () -> Int
) -> ConstantVPrintFIntegerFormatting {
return ConstantVPrintFIntegerFormatting(
radix: 10,
explicitPositiveSign: explicitPositiveSign,
minDigits: minDigits)
}
/// Displays an interpolated integer as a decimal number with an optional sign.
///
/// The parameter `explicitPositiveSign` must be a boolean literal.
///
/// - Parameters:
/// - explicitPositiveSign: Pass `true` to add a + sign to non-negative
/// numbers.
@_semantics("constant_evaluable")
@inlinable
@_optimize(none)
public static func decimal(
explicitPositiveSign: Bool = false
) -> ConstantVPrintFIntegerFormatting {
return ConstantVPrintFIntegerFormatting(
radix: 10,
explicitPositiveSign: explicitPositiveSign,
minDigits: nil)
}
/// Displays an interpolated integer as a decimal number. This is the default format for
/// integers.
@_semantics("constant_evaluable")
@inlinable
@_optimize(none)
public static var decimal: ConstantVPrintFIntegerFormatting { .decimal() }
/// Displays an interpolated unsigned integer as a hexadecimal number with the
/// specified parameters. This formatting option should be used only with unsigned
/// integers.
///
/// All parameters except `minDigits` should be boolean literals. `minDigits`
/// can be an arbitrary expression.
///
/// - Parameters:
/// - explicitPositiveSign: Pass `true` to add a + sign to non-negative
/// numbers.
/// - includePrefix: Pass `true` to add a prefix 0x.
/// - uppercase: Pass `true` to use uppercase letters to represent numerals
/// greater than 9, or `false` to use lowercase letters. The default is `false`.
/// - minDigits: minimum number of digits to display. Numbers will be
/// prefixed with zeros if necessary to meet the minimum.
@_semantics("constant_evaluable")
@inlinable
@_optimize(none)
public static func hex(
explicitPositiveSign: Bool = false,
includePrefix: Bool = false,
uppercase: Bool = false,
minDigits: @escaping @autoclosure () -> Int
) -> ConstantVPrintFIntegerFormatting {
return ConstantVPrintFIntegerFormatting(
radix: 16,
explicitPositiveSign: explicitPositiveSign,
includePrefix: includePrefix,
uppercase: uppercase,
minDigits: minDigits)
}
/// Displays an interpolated unsigned integer as a hexadecimal number with the specified
/// parameters. This formatting option should be used only with unsigned integers.
///
/// All parameters should be boolean literals.
///
/// - Parameters:
/// - explicitPositiveSign: Pass `true` to add a + sign to non-negative
/// numbers.
/// - includePrefix: Pass `true` to add a prefix 0x.
/// - uppercase: Pass `true` to use uppercase letters to represent numerals
/// greater than 9, or `false` to use lowercase letters. The default is `false`.
@_semantics("constant_evaluable")
@inlinable
@_optimize(none)
public static func hex(
explicitPositiveSign: Bool = false,
includePrefix: Bool = false,
uppercase: Bool = false
) -> ConstantVPrintFIntegerFormatting {
return ConstantVPrintFIntegerFormatting(
radix: 16,
explicitPositiveSign: explicitPositiveSign,
includePrefix: includePrefix,
uppercase: uppercase,
minDigits: nil)
}
/// Displays an interpolated unsigned integer as a hexadecimal number.
/// This formatting option should be used only with unsigned integers.
@_semantics("constant_evaluable")
@inlinable
@_optimize(none)
public static var hex: ConstantVPrintFIntegerFormatting { .hex() }
/// Displays an interpolated unsigned integer as an octal number with the specified
/// parameters. This formatting option should be used only with unsigned
/// integers.
///
/// All parameters except `minDigits` should be boolean literals. `minDigits`
/// can be an arbitrary expression.
///
/// - Parameters:
/// - explicitPositiveSign: Pass `true` to add a + sign to non-negative
/// numbers.
/// - includePrefix: Pass `true` to add a prefix 0o.
/// - uppercase: Pass `true` to use uppercase letters to represent numerals
/// greater than 9, or `false` to use lowercase letters. The default is `false`.
/// - minDigits: minimum number of digits to display. Numbers will be
/// prefixed with zeros if necessary to meet the minimum.
@_semantics("constant_evaluable")
@inlinable
@_optimize(none)
public static func octal(
explicitPositiveSign: Bool = false,
includePrefix: Bool = false,
uppercase: Bool = false,
minDigits: @autoclosure @escaping () -> Int
) -> ConstantVPrintFIntegerFormatting {
ConstantVPrintFIntegerFormatting(
radix: 8,
explicitPositiveSign: explicitPositiveSign,
includePrefix: includePrefix,
uppercase: uppercase,
minDigits: minDigits)
}
/// Displays an interpolated unsigned integer as an octal number with the specified parameters.
/// This formatting option should be used only with unsigned integers.
///
/// All parameters must be boolean literals.
///
/// - Parameters:
/// - explicitPositiveSign: Pass `true` to add a + sign to non-negative
/// numbers.
/// - includePrefix: Pass `true` to add a prefix 0o.
/// - uppercase: Pass `true` to use uppercase letters to represent numerals
/// greater than 9, or `false` to use lowercase letters.
@_semantics("constant_evaluable")
@inlinable
@_optimize(none)
public static func octal(
explicitPositiveSign: Bool = false,
includePrefix: Bool = false,
uppercase: Bool = false
) -> ConstantVPrintFIntegerFormatting {
ConstantVPrintFIntegerFormatting(
radix: 8,
explicitPositiveSign: explicitPositiveSign,
includePrefix: includePrefix,
uppercase: uppercase,
minDigits: nil)
}
/// Displays an interpolated unsigned integer as an octal number.
/// This formatting option should be used only with unsigned integers.
@_semantics("constant_evaluable")
@inlinable
@_optimize(none)
public static var octal: ConstantVPrintFIntegerFormatting { .octal() }
}
extension ConstantVPrintFIntegerFormatting {
/// The prefix for the radix in the Swift literal syntax.
@_semantics("constant_evaluable")
@inlinable
@_optimize(none)
internal var _prefix: String {
guard includePrefix else { return "" }
switch radix {
case 2: return "0b"
case 8: return "0o"
case 16: return "0x"
default: return ""
}
}
}
extension ConstantVPrintFIntegerFormatting {
/// Returns a fprintf-compatible length modifier for a given argument type.
@_semantics("constant_evaluable")
@inlinable
@_optimize(none)
internal static func formatSpecifierLengthModifier<I: FixedWidthInteger>(
_ type: I.Type
) -> String? {
// IEEE Std 1003.1-2017, length modifiers:
switch type {
// hh - d, i, o, u, x, or X conversion specifier applies to
// (signed|unsigned) char
case is CChar.Type: return "hh"
case is CUnsignedChar.Type: return "hh"
// h - d, i, o, u, x, or X conversion specifier applies to
// (signed|unsigned) short
case is CShort.Type: return "h"
case is CUnsignedShort.Type: return "h"
case is CInt.Type: return ""
case is CUnsignedInt.Type: return ""
// l - d, i, o, u, x, or X conversion specifier applies to
// (signed|unsigned) long
case is CLong.Type: return "l"
case is CUnsignedLong.Type: return "l"
// ll - d, i, o, u, x, or X conversion specifier applies to
// (signed|unsigned) long long
case is CLongLong.Type: return "ll"
case is CUnsignedLongLong.Type: return "ll"
default: return nil
}
}
/// Constructs an os_log format specifier for the given `type`.
@_semantics("constant_evaluable")
@_alwaysEmitIntoClient
@_optimize(none)
@_effects(readonly)
internal func formatSpecifier<I: FixedWidthInteger>(
for type: I.Type,
attributes: String
) -> String {
// Based on IEEE Std 1003.1-2017
// `d`/`i` is the only signed integral conversions allowed
if (type.isSigned && radix != 10) {
fatalError("Signed integers must be formatted using .decimal")
}
// IEEE: Each conversion specification is introduced by the '%' character
// after which the following appear in sequence:
// 1. Zero or more flags (in any order), which modify the meaning of the
// conversion specification.
// 2. An optional minimum field width (for alignment). If the converted
// value has fewer bytes than the field width, it shall be padded with
// <space> characters by default on the left; it shall be padded on the
// right if the left-adjustment flag ( '-' ), is given to the
// field width.
// 3. An optional precision that gives the minimum number of digits to
// display for the d, i, o, u, x, and X conversion specifiers.
// 4. An optional length modifier that specifies the size of the argument.
// 5. A conversion specifier character that indicates the type of
// conversion to be applied.
// Use Swift style prefixes rather than fprintf style prefixes.
var specification = _prefix
specification += "%"
//
// 1. Flags
//
// Use `+` flag if signed, otherwise prefix a literal `+` for unsigned.
if explicitPositiveSign {
// IEEE: `+` The result of a signed conversion shall always begin with a
// sign ( '+' or '-' )
if type.isSigned {
specification += "+"
} else {
var newSpecification = "+"
newSpecification += specification
specification = newSpecification
}
}
// 3. Precision
// Default precision for integers is 1, otherwise use requested precision.
// The precision could be a dynamic value.
// Therefore, use a star here and pass it as an additional argument.
if let _ = minDigits {
specification += ".*"
}
// 4. Length modifier
guard let lengthModifier =
ConstantVPrintFIntegerFormatting.formatSpecifierLengthModifier(type) else {
fatalError("Integer type has unknown byte length")
}
specification += lengthModifier
// 5. The conversion specifier
switch radix {
case 10:
specification += type.isSigned ? "d" : "u"
case 8:
specification += "o"
case 16:
specification += uppercase ? "X" : "x"
default:
fatalError("radix must be 10, 8 or 16")
}
return specification
}
}
@frozen
@usableFromInline
internal struct ConstantVPrintFArguments {
@usableFromInline
internal var argumentClosures: [(([Int]) -> ()) -> ()]
@_semantics("constant_evaluable")
@inlinable
@_optimize(none)
internal init() {
argumentClosures = []
}
/// `append` for other types must be implemented by extensions.
}
extension ConstantVPrintFInterpolation {
/// Defines interpolation for expressions of type Int.
///
/// Do not call this function directly. It will be called automatically when interpolating
/// a value of type `Int` in the string interpolations passed to the log APIs.
///
/// - Parameters:
/// - number: The interpolated expression of type Int, which is autoclosured.
/// - format: A formatting option available for integer types, defined by the
/// type: `ConstantVPrintFIntegerFormatting`. The default is `.decimal`.
@_semantics("constant_evaluable")
@inlinable
@_optimize(none)
@_semantics("oslog.requires_constant_arguments")
public mutating func appendInterpolation(
_ number: @autoclosure @escaping () -> Int,
format: ConstantVPrintFIntegerFormatting = .decimal
) {
appendInteger(number, format: format)
}
// Define appendInterpolation overloads for fixed-size integers.
@_semantics("constant_evaluable")
@inlinable
@_optimize(none)
@_semantics("oslog.requires_constant_arguments")
public mutating func appendInterpolation(
_ number: @autoclosure @escaping () -> Int8,
format: ConstantVPrintFIntegerFormatting = .decimal
) {
appendInteger(number, format: format)
}
@_semantics("constant_evaluable")
@inlinable
@_optimize(none)
@_semantics("oslog.requires_constant_arguments")
public mutating func appendInterpolation(
_ number: @autoclosure @escaping () -> Int16,
format: ConstantVPrintFIntegerFormatting = .decimal
) {
appendInteger(number, format: format)
}
@_semantics("constant_evaluable")
@inlinable
@_optimize(none)
@_semantics("oslog.requires_constant_arguments")
public mutating func appendInterpolation(
_ number: @autoclosure @escaping () -> Int32,
format: ConstantVPrintFIntegerFormatting = .decimal
) {
appendInteger(number, format: format)
}
@_semantics("constant_evaluable")
@inlinable
@_optimize(none)
@_semantics("oslog.requires_constant_arguments")
public mutating func appendInterpolation(
_ number: @autoclosure @escaping () -> Int64,
format: ConstantVPrintFIntegerFormatting = .decimal
) {
appendInteger(number, format: format)
}
/// Defines interpolation for expressions of type UInt.
///
/// Do not call this function directly. It will be called automatically when interpolating
/// a value of type `Int` in the string interpolations passed to the log APIs.
///
/// - Parameters:
/// - number: The interpolated expression of type UInt, which is autoclosured.
/// - format: A formatting option available for integer types, defined by the
/// type `ConstantVPrintFIntegerFormatting`.
@_semantics("constant_evaluable")
@inlinable
@_optimize(none)
@_semantics("oslog.requires_constant_arguments")
public mutating func appendInterpolation(
_ number: @autoclosure @escaping () -> UInt,
format: ConstantVPrintFIntegerFormatting = .decimal
) {
appendInteger(number, format: format)
}
// Define appendInterpolation overloads for unsigned integers.
@_semantics("constant_evaluable")
@inlinable
@_optimize(none)
@_semantics("oslog.requires_constant_arguments")
public mutating func appendInterpolation(
_ number: @autoclosure @escaping () -> UInt8,
format: ConstantVPrintFIntegerFormatting = .decimal
) {
appendInteger(number, format: format)
}
@_semantics("constant_evaluable")
@inlinable
@_optimize(none)
@_semantics("oslog.requires_constant_arguments")
public mutating func appendInterpolation(
_ number: @autoclosure @escaping () -> UInt16,
format: ConstantVPrintFIntegerFormatting = .decimal
) {
appendInteger(number, format: format)
}
@_semantics("constant_evaluable")
@inlinable
@_optimize(none)
@_semantics("oslog.requires_constant_arguments")
public mutating func appendInterpolation(
_ number: @autoclosure @escaping () -> UInt32,
format: ConstantVPrintFIntegerFormatting = .decimal
) {
appendInteger(number, format: format)
}
@_semantics("constant_evaluable")
@inlinable
@_optimize(none)
@_semantics("oslog.requires_constant_arguments")
public mutating func appendInterpolation(
_ number: @autoclosure @escaping () -> UInt64,
format: ConstantVPrintFIntegerFormatting = .decimal
) {
appendInteger(number, format: format)
}
/// Defines interpolation for expressions of type Int.
///
/// Do not call this function directly. It will be called automatically when interpolating
/// a value of type `Int` in the string interpolations passed to the log APIs.
///
/// - Parameters:
/// - number: The interpolated expression of type Int, which is autoclosured.
/// - format: A formatting option available for integer types, defined by the
/// type: `ConstantVPrintFIntegerFormatting`. The default is `.decimal`.
/// - attributes: A string that specifies an attribute for the interpolated value,
/// which can be used to provide additional information about the interpolated
/// value to tools such as Xcode that can process and render os_log and os_signpost
/// messages. An example of an attribute is "xcode:size-in-bytes". If the target tool
/// that processes these messages doesn't understand the attribute it would be ignored.
@_semantics("constant_evaluable")
@_alwaysEmitIntoClient
@_optimize(none)
@_semantics("oslog.requires_constant_arguments")
public mutating func appendInterpolation<T: FixedWidthInteger>(
_ number: @autoclosure @escaping () -> T,
format: ConstantVPrintFIntegerFormatting = .decimal,
attributes: String
) {
appendInteger(number, format: format, attributes: attributes)
}
/// Given an integer, create and append a format specifier for the integer to the
/// format string property. Also, append the integer along with necessary headers
/// to the ConstantVPrintFArguments property.
@_semantics("constant_evaluable")
@_alwaysEmitIntoClient
@_optimize(none)
internal mutating func appendInteger<T>(
_ number: @escaping () -> T,
format: ConstantVPrintFIntegerFormatting,
attributes: String = ""
) where T: FixedWidthInteger {
formatString += format.formatSpecifier(for: T.self, attributes: attributes)
arguments.append(number)
}
}
@frozen
public struct ConstantVPrintFInterpolation : StringInterpolationProtocol {
/// A format string constructed from the given string interpolation to be
/// passed to vprintf
@usableFromInline
internal var formatString: String
@usableFromInline
internal var arguments: ConstantVPrintFArguments
// Some methods defined below are marked @_optimize(none) to prevent inlining
// of string internals (such as String._StringGuts) which will interfere with
// constant evaluation and folding. Note that these methods will be inlined,
// constant evaluated/folded and optimized in the context of a caller.
@_semantics("oslog.interpolation.init")
@_semantics("constant_evaluable")
@inlinable
@_optimize(none)
public init(literalCapacity: Int, interpolationCount: Int) {
// Since the format string and the arguments array are fully constructed
// at compile time, the parameters are ignored.
formatString = ""
arguments = ConstantVPrintFArguments()
}
@_semantics("constant_evaluable")
@inlinable
@_optimize(none)
public mutating func appendLiteral(_ literal: String) {
formatString += literal.percentEscapedString
}
/// `appendInterpolation` conformances will be added by extensions to this type.
}
extension ConstantVPrintFInterpolation {
/// Defines interpolation for expressions of type String.
///
/// Do not call this function directly. It will be called automatically when interpolating
/// a value of type `String` in the string interpolations passed to the log APIs.
///
/// - Parameters:
/// - argumentString: The interpolated expression of type String, which is autoclosured.
@_semantics("constant_evaluable")
@_alwaysEmitIntoClient
@_optimize(none)
@_semantics("oslog.requires_constant_arguments")
public mutating func appendInterpolation(
_ argumentString: @autoclosure @escaping () -> String
) {
formatString += "%s"
arguments.append(argumentString)
}
}
extension ConstantVPrintFInterpolation {
/// Defines interpolation for values conforming to CustomStringConvertible. The values
/// are displayed using the description methods on them.
///
/// Do not call this function directly. It will be called automatically when interpolating
/// a value conforming to CustomStringConvertible in the string interpolations passed
/// to the log APIs.
///
/// - Parameters:
/// - value: The interpolated expression conforming to CustomStringConvertible.
@_optimize(none)
@_transparent
@_semantics("oslog.requires_constant_arguments")
public mutating func appendInterpolation<T : CustomStringConvertible>(
_ value: @autoclosure @escaping () -> T
) {
appendInterpolation(value().description)
}
/// Defines interpolation for meta-types.
///
/// Do not call this function directly. It will be called automatically when interpolating
/// a value of type `Any.Type` in the string interpolations passed to the log APIs.
///
/// - Parameters:
/// - value: An interpolated expression of type Any.Type, which is autoclosured.
@_semantics("constant_evaluable")
@inlinable
@_optimize(none)
@_semantics("oslog.requires_constant_arguments")
public mutating func appendInterpolation(
_ value: @autoclosure @escaping () -> Any.Type
) {
appendInterpolation(_typeName(value(), qualified: false))
}
}
extension UnsafeRawPointer: CVarArg {
/// Transform `self` into a series of machine words that can be
/// appropriately interpreted by C varargs.
@inlinable // c-abi
public var _cVarArgEncoding: [Int] {
return _encodeBitsAsWords(self)
}
}
extension ConstantVPrintFArguments {
/// Append an (autoclosured) interpolated expression of type `UnsafeRawPointer`, passed
/// to `ConstantVPrintFMessage.appendInterpolation`, to the array of closures tracked
/// by this instance.
@_semantics("constant_evaluable")
@inlinable
@_optimize(none)
internal mutating func append(_ value: @escaping () -> UnsafeRawPointer) {
argumentClosures.append({ continuation in
continuation(value()._cVarArgEncoding)
})
}
}
extension ConstantVPrintFArguments {
@_semantics("constant_evaluable")
@inlinable
@_optimize(none)
internal mutating func append(_ value: @escaping () -> String) {
argumentClosures.append({ continuation in
value().withCString { str in
continuation(str._cVarArgEncoding)
}
})
}
}
extension ConstantVPrintFArguments {
@_semantics("constant_evaluable")
@inlinable
@_optimize(none)
internal mutating func append<T>(
_ value: @escaping () -> T
) where T: FixedWidthInteger {
argumentClosures.append({ continuation in
continuation(_encodeBitsAsWords(value()))
})
}
}
@frozen @_semantics("oslog.message.type")
public struct ConstantVPrintFMessage :
ExpressibleByStringInterpolation, ExpressibleByStringLiteral
{
public let interpolation: ConstantVPrintFInterpolation
@inlinable
@_optimize(none)
@_semantics("oslog.message.init_interpolation")
@_semantics("constant_evaluable")
public init(stringInterpolation: ConstantVPrintFInterpolation) {
var s = stringInterpolation
s.appendLiteral("\n")
self.interpolation = s
}
@inlinable
@_optimize(none)
@_semantics("oslog.message.init_stringliteral")
@_semantics("constant_evaluable")
public init(stringLiteral value: String) {
var s = ConstantVPrintFInterpolation(
literalCapacity: 1,
interpolationCount: 0
)
s.appendLiteral(value)
s.appendLiteral("\n")
self.interpolation = s
}
}
internal func constant_vprintf_backend_recurse(
fmt: UnsafePointer<CChar>,
argumentClosures: ArraySlice<(([Int]) -> ()) -> ()>,
args: inout [CVarArg]
) {
if let closure = argumentClosures.first {
closure { newArg in
args.append(contentsOf: newArg)
constant_vprintf_backend_recurse(
fmt: fmt,
argumentClosures: argumentClosures.dropFirst(),
args: &args
)
}
} else {
_ = withVaList(args) { valist in
_swift_stdlib_vprintf(fmt, valist)
}
}
}
@inline(never) @usableFromInline
internal func constant_vprintf_backend(
fmt: UnsafePointer<CChar>,
argumentClosures: [(([Int]) -> ()) -> ()]
) {
var args:[CVarArg] = []
if let closure = argumentClosures.first {
closure { newArg in
args.append(contentsOf: newArg)
constant_vprintf_backend_recurse(
fmt: fmt,
argumentClosures: argumentClosures.dropFirst(),
args: &args
)
}
} else {
constant_vprintf_backend_recurse(
fmt: fmt,
argumentClosures: ArraySlice(argumentClosures),
args: &args
)
}
}
@_semantics("oslog.requires_constant_arguments")
@inlinable
@_transparent
@_alwaysEmitIntoClient
@_optimize(none)
public func print(_ message: ConstantVPrintFMessage) {
let formatString = message.interpolation.formatString
let argumentClosures = message.interpolation.arguments.argumentClosures
if Bool(_builtinBooleanLiteral: Builtin.ifdef_SWIFT_STDLIB_PRINT_DISABLED()) { return }
let formatStringPointer = _getGlobalStringTablePointer(formatString)
constant_vprintf_backend(
fmt: formatStringPointer,
argumentClosures: argumentClosures
)
}
#endif
|