swift-mirror/stdlib/public/Windows/WinSDK.swift

//===----------------------------------------------------------------------===//
//
// This source file is part of the Swift.org open source project
//
// Copyright (c) 2014 - 2018 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
//
//===----------------------------------------------------------------------===//

@_exported import ucrt
@_exported import _GUIDDef
@_exported import WinSDK // Clang module

// WinBase.h
@inlinable
public var HANDLE_FLAG_INHERIT: DWORD {
  0x00000001
}

// WinBase.h
@inlinable
public var STARTF_USESTDHANDLES: DWORD {
  0x00000100
}

// WinBase.h
@inlinable
public var INFINITE: DWORD {
  DWORD(bitPattern: -1)
}

// WinBase.h
@inlinable
public var WAIT_OBJECT_0: DWORD {
  0
}

// WinBase.h
@inlinable
public var STD_INPUT_HANDLE: DWORD {
  DWORD(bitPattern: -10)
}

@inlinable
public var STD_OUTPUT_HANDLE: DWORD {
  DWORD(bitPattern: -11)
}

@inlinable
public var STD_ERROR_HANDLE: DWORD {
  DWORD(bitPattern: -12)
}

// handleapi.h
@inlinable
public var INVALID_HANDLE_VALUE: HANDLE {
  unsafe HANDLE(bitPattern: -1)!
}

// shellapi.h
@inlinable
public var FOF_NO_UI: FILEOP_FLAGS {
  FILEOP_FLAGS(FOF_SILENT | FOF_NOCONFIRMATION | FOF_NOERRORUI | FOF_NOCONFIRMMKDIR)
}

// winioctl.h
@inlinable
public var FSCTL_SET_REPARSE_POINT: DWORD {
  0x900a4
}

@inlinable
public var FSCTL_GET_REPARSE_POINT: DWORD {
  0x900a8
}

@inlinable
public var FSCTL_DELETE_REPARSE_POINT: DWORD {
  0x900ac
}

// WinSock2.h
@inlinable
public var INVALID_SOCKET: SOCKET {
  SOCKET(bitPattern: -1)
}

@inlinable
public var FIONBIO: Int32 {
  Int32(bitPattern: 0x8004667e)
}

// WinUser.h
@inlinable
public var CW_USEDEFAULT: Int32 {
  Int32(bitPattern: 2147483648)
}

@inlinable
public var QS_MOUSE: UINT {
  UINT(QS_MOUSEMOVE | QS_MOUSEBUTTON)
}

@inlinable
public var QS_INPUT: UINT {
  QS_MOUSE | UINT(QS_KEY | QS_RAWINPUT | QS_TOUCH | QS_POINTER)
}

@inlinable
public var QS_ALLEVENTS: UINT {
  QS_INPUT | UINT(QS_POSTMESSAGE | QS_TIMER | QS_PAINT | QS_HOTKEY)
}

@inlinable
public var QS_ALLINPUT: UINT {
  QS_INPUT | UINT(QS_POSTMESSAGE | QS_TIMER | QS_PAINT | QS_HOTKEY | QS_SENDMESSAGE)
}

@inlinable
public var WS_OVERLAPPEDWINDOW: UINT {
  UINT(WS_OVERLAPPED | WS_CAPTION | WS_SYSMENU | WS_THICKFRAME | WS_MINIMIZEBOX | WS_MAXIMIZEBOX)
}

@inlinable
public var WS_POPUPWINDOW: UINT {
  UINT(numericCast(WS_POPUP) | WS_BORDER | WS_SYSMENU)
}

// fileapi.h
@inlinable
public var INVALID_FILE_ATTRIBUTES: DWORD {
  DWORD(bitPattern: -1)
}

// CommCtrl.h
public let WC_BUTTONW: [WCHAR] = Array<WCHAR>("Button".utf16)
public let WC_COMBOBOXW: [WCHAR] = Array<WCHAR>("ComboBox".utf16)
public let WC_EDITW: [WCHAR] = Array<WCHAR>("Edit".utf16)
public let WC_HEADERW: [WCHAR] = Array<WCHAR>("SysHeader32".utf16)
public let WC_LISTBOXW: [WCHAR] = Array<WCHAR>("ListBox".utf16)
public let WC_LISTVIEWW: [WCHAR] = Array<WCHAR>("SysListView32".utf16)
public let WC_SCROLLBARW: [WCHAR] = Array<WCHAR>("ScrollBar".utf16)
public let WC_STATICW: [WCHAR] = Array<WCHAR>("Static".utf16)
public let WC_TABCONTROLW: [WCHAR] = Array<WCHAR>("SysTabControl32".utf16)
public let WC_TREEVIEWW: [WCHAR] = Array<WCHAR>("SysTreeView32".utf16)

public let ANIMATE_CLASSW: [WCHAR] = Array<WCHAR>("SysAnimate32".utf16)
public let HOTKEY_CLASSW: [WCHAR] = Array<WCHAR>("msctls_hotkey32".utf16)
public let PROGRESS_CLASSW: [WCHAR] = Array<WCHAR>("msctls_progress32".utf16)
public let STATUSCLASSNAMEW: [WCHAR] = Array<WCHAR>("msctls_statusbar32".utf16)
public let TOOLBARW_CLASSW: [WCHAR] = Array<WCHAR>("ToolbarWindow32".utf16)
public let TRACKBAR_CLASSW: [WCHAR] = Array<WCHAR>("msctls_trackbar32".utf16)
public let UPDOWN_CLASSW: [WCHAR] = Array<WCHAR>("msctls_updown32".utf16)

// consoleapi.h
@inlinable
public var PROC_THREAD_ATTRIBUTE_PSEUDOCONSOLE: DWORD_PTR {
  0x00020016
}

// windef.h
@inlinable
public var DPI_AWARENESS_CONTEXT_UNAWARE: DPI_AWARENESS_CONTEXT {
  unsafe DPI_AWARENESS_CONTEXT(bitPattern: -1)!
}

@inlinable
public var DPI_AWARENESS_CONTEXT_SYSTEM_AWARE: DPI_AWARENESS_CONTEXT {
  unsafe DPI_AWARENESS_CONTEXT(bitPattern: -2)!
}

@inlinable
public var DPI_AWARENESS_CONTEXT_PER_MONITOR_AWARE: DPI_AWARENESS_CONTEXT {
  unsafe DPI_AWARENESS_CONTEXT(bitPattern: -3)!
}

@inlinable
public var DPI_AWARENESS_CONTEXT_PER_MONITOR_AWARE_V2: DPI_AWARENESS_CONTEXT {
  unsafe DPI_AWARENESS_CONTEXT(bitPattern: -4)!
}

@inlinable
public var DPI_AWARENESS_CONTEXT_UNAWARE_GDISCALED: DPI_AWARENESS_CONTEXT {
  unsafe DPI_AWARENESS_CONTEXT(bitPattern: -5)!
}

// winreg.h
@inlinable
public var HKEY_CLASSES_ROOT: HKEY {
  unsafe HKEY(bitPattern: UInt(0x80000000))!
}

@inlinable
public var HKEY_CURRENT_USER: HKEY {
  unsafe HKEY(bitPattern: UInt(0x80000001))!
}

@inlinable
public var HKEY_LOCAL_MACHINE: HKEY {
  unsafe HKEY(bitPattern: UInt(0x80000002))!
}

@inlinable
public var HKEY_USERS: HKEY {
  unsafe HKEY(bitPattern: UInt(0x80000003))!
}

@inlinable
public var HKEY_PERFORMANCE_DATA: HKEY {
  unsafe HKEY(bitPattern: UInt(0x80000004))!
}

@inlinable
public var HKEY_PERFORMANCE_TEXT: HKEY {
  unsafe HKEY(bitPattern: UInt(0x80000050))!
}

@inlinable
public var HKEY_PERFORMANCE_NLSTEXT: HKEY {
  unsafe HKEY(bitPattern: UInt(0x80000060))!
}

@inlinable
public var HKEY_CURRENT_CONFIG: HKEY {
  unsafe HKEY(bitPattern: UInt(0x80000005))!
}

@inlinable
public var HKEY_DYN_DATA: HKEY {
  unsafe HKEY(bitPattern: UInt(0x80000006))!
}

@inlinable
public var HKEY_CURRENT_USER_LOCAL_SETTINGS: HKEY {
  unsafe HKEY(bitPattern: UInt(0x80000007))!
}

// Richedit.h
public let MSFTEDIT_CLASS: [WCHAR] = Array<WCHAR>("RICHEDIT50W".utf16)

// Swift Convenience
public extension FILETIME {
  var time_t: time_t {
    let NTTime: Int64 = Int64(self.dwLowDateTime) | (Int64(self.dwHighDateTime) << 32)
    return (NTTime - 116444736000000000) / 10000000
  }

  init(from time: time_t) {
    let UNIXTime: Int64 = ((time * 10000000) + 116444736000000000)
    self = FILETIME(dwLowDateTime: DWORD(UNIXTime & 0xffffffff),
                    dwHighDateTime: DWORD((UNIXTime >> 32) & 0xffffffff))
  }
}

// WindowsBool

/// The `BOOL` type declared in WinDefs.h and used throughout WinSDK
///
/// The C type is a typedef for `int`.
@frozen
public struct WindowsBool: ExpressibleByBooleanLiteral {
  @usableFromInline
  var _value: Int32

  /// The value of `self`, expressed as a `Bool`.
  @_transparent
  public var boolValue: Bool {
    return !(_value == 0)
  }

  @_transparent
  public init(booleanLiteral value: Bool) {
    self.init(value)
  }

  /// Create an instance initialized to `value`.
  @_transparent
  public init(_ value: Bool) {
    self._value = value ? 1 : 0
  }
}

#if SWIFT_ENABLE_REFLECTION
extension WindowsBool: CustomReflectable {
  /// Returns a mirror that reflects `self`.
  public var customMirror: Mirror {
    return Mirror(reflecting: boolValue)
  }
}
#endif

@_unavailableInEmbedded
extension WindowsBool: CustomStringConvertible {
  /// A textual representation of `self`.
  public var description: String {
    return self.boolValue.description
  }
}

extension WindowsBool: Equatable {
  @_transparent
  public static func ==(lhs: WindowsBool, rhs: WindowsBool) -> Bool {
    return lhs.boolValue == rhs.boolValue
  }
}

@_transparent
public // COMPILER_INTRINSIC
func _convertBoolToWindowsBool(_ b: Bool) -> WindowsBool {
  return WindowsBool(b)
}

@_transparent
public // COMPILER_INTRINSIC
func _convertWindowsBoolToBool(_ b: WindowsBool) -> Bool {
  return b.boolValue
}

// GUID

extension GUID {
  @usableFromInline @_transparent
  internal var uint128Value: UInt128 {
    unsafe withUnsafeBytes(of: self) { buffer in
      // GUID is 32-bit-aligned only, so use loadUnaligned().
      unsafe buffer.baseAddress!.loadUnaligned(as: UInt128.self)
    }
  }
}

// These conformances are marked @retroactive because the GUID type nominally
// comes from the _GUIDDef clang module rather than the WinSDK clang module.

extension GUID: @retroactive Equatable {
  // When C++ interop is enabled, Swift imports a == operator from guiddef.h
  // that conflicts with the definition of == here, so we've renamed it to
  // __equals to avoid the conflict.
  @_transparent
  @_implements(Equatable, ==(_:_:))
  public static func __equals(lhs: Self, rhs: Self) -> Bool {
    lhs.uint128Value == rhs.uint128Value
  }
}

extension GUID: @retroactive Hashable {
  @_transparent
  public func hash(into hasher: inout Hasher) {
    hasher.combine(uint128Value)
  }
}