Files
swift-mirror/stdlib/public/core/UnavailableStringAPIs.swift.gyb
Ben Cohen 9ee856f386 [stdlib][WIP] Eliminate (Closed)CountableRange using conditional conformance (#13342)
* Make Range conditionally a Collection

* Convert ClosedRange to conditionally a collection

* De-gyb Range/ClosedRange, refactoring some methods.

* Remove use of Countable{Closed}Range from stdlib

* Remove Countable use from Foundation

* Fix test errors and warnings resulting from Range/CountableRange collapse

* fix prespecialize test for new mangling

* Update CoreAudio use of CountableRange

* Update SwiftSyntax use of CountableRange

* Restore ClosedRange.Index: Hashable conformance

* Move fixed typechecker slowness test for array-of-ranges from slow to fast, yay

* Apply Doug's patch to loosen test to just check for error
2018-02-01 20:59:28 -08:00

72 lines
2.8 KiB
Plaintext

//===----------------------------------------------------------------------===//
//
// This source file is part of the Swift.org open source project
//
// Copyright (c) 2014 - 2017 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
//
//===----------------------------------------------------------------------===//
%{
stringSubscriptComment = """
/// Subscripting strings with integers is not available.
///
/// The concept of "the `i`th character in a string" has
/// different interpretations in different libraries and system
/// components. The correct interpretation should be selected
/// according to the use case and the APIs involved, so `String`
/// cannot be subscripted with an integer.
///
/// Swift provides several different ways to access the character
/// data stored inside strings.
///
/// - `String.utf8` is a collection of UTF-8 code units in the
/// string. Use this API when converting the string to UTF-8.
/// Most POSIX APIs process strings in terms of UTF-8 code units.
///
/// - `String.utf16` is a collection of UTF-16 code units in
/// string. Most Cocoa and Cocoa touch APIs process strings in
/// terms of UTF-16 code units. For example, instances of
/// `NSRange` used with `NSAttributedString` and
/// `NSRegularExpression` store substring offsets and lengths in
/// terms of UTF-16 code units.
///
/// - `String.unicodeScalars` is a collection of Unicode scalars.
/// Use this API when you are performing low-level manipulation
/// of character data.
///
/// - `String.characters` is a collection of extended grapheme
/// clusters, which are an approximation of user-perceived
/// characters.
///
/// Note that when processing strings that contain human-readable
/// text, character-by-character processing should be avoided to
/// the largest extent possible. Use high-level locale-sensitive
/// Unicode algorithms instead, for example,
/// `String.localizedStandardCompare()`,
/// `String.localizedLowercaseString`,
/// `String.localizedStandardRangeOfString()` etc."""
}%
extension String {
${stringSubscriptComment}
@available(
*, unavailable,
message: "cannot subscript String with an Int, see the documentation comment for discussion")
public subscript(i: Int) -> Character {
Builtin.unreachable()
}
${stringSubscriptComment}
@available(
*, unavailable,
message: "cannot subscript String with an integer range, see the documentation comment for discussion")
public subscript<R: RangeExpression>(bounds: R) -> String where R.Bound == Int {
Builtin.unreachable()
}
}