swift-mirror/stdlib/core/StaticString.swift

//===----------------------------------------------------------------------===//
//
// This source file is part of the Swift.org open source project
//
// Copyright (c) 2014 - 2015 Apple Inc. and the Swift project authors
// Licensed under Apache License v2.0 with Runtime Library Exception
//
// See http://swift.org/LICENSE.txt for license information
// See http://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
//
//===----------------------------------------------------------------------===//

// Implementation Note: Because StaticString is used in the
// implementation of assert() and fatal(), we keep it extremely close
// to the bare metal.  In particular, because we use only Builtin
// types, we are guaranteed that no assertions are involved in its
// construction.  This feature is crucial for preventing infinite
// recursion even in non-asserting cases.

/// An extremely simple string designed to represent something
/// "statically knowable".
public struct StaticString
  : _BuiltinExtendedGraphemeClusterLiteralConvertible,
    ExtendedGraphemeClusterLiteralConvertible,
    _BuiltinStringLiteralConvertible, StringLiteralConvertible {
  var _start: Builtin.RawPointer
  var _byteSize: Builtin.Word
  var _isASCII: Builtin.Int1

  public var start: UnsafePointer<UInt8> {
    return UnsafePointer(_start)
  }

  public var byteSize: UWord {
    return UWord(_byteSize)
  }

  public var isASCII: Bool {
    return Bool(_isASCII)
  }

  public init() {
    self = ""
  }

  init(
    start: Builtin.RawPointer, byteSize: Builtin.Word, isASCII: Builtin.Int1
  ) {
    self._start = start
    self._byteSize = byteSize
    self._isASCII = isASCII
  }

  public
  static func _convertFromBuiltinExtendedGraphemeClusterLiteral(
    start: Builtin.RawPointer,
    byteSize: Builtin.Word,
    isASCII: Builtin.Int1) -> StaticString {

    return _convertFromBuiltinStringLiteral(
        start, byteSize: byteSize, isASCII: isASCII)
  }

  public static func convertFromExtendedGraphemeClusterLiteral(
      value: StaticString) -> StaticString {
    return value
  }

  public
  static func _convertFromBuiltinStringLiteral(
    start: Builtin.RawPointer, byteSize: Builtin.Word, isASCII: Builtin.Int1
  ) -> StaticString {
    return StaticString(start: start, byteSize: byteSize, isASCII: isASCII)
  }

  public
  static func convertFromStringLiteral(value: StaticString) -> StaticString {
    return value
  }
}