File: Card.swift

package info (click to toggle)
swiftlang 6.1.3-1
  • links: PTS, VCS
  • area: main
  • in suites: forky
  • size: 2,791,532 kB
  • sloc: cpp: 9,901,743; ansic: 2,201,431; asm: 1,091,827; python: 308,252; objc: 82,166; f90: 80,126; lisp: 38,358; pascal: 25,559; sh: 20,429; ml: 5,058; perl: 4,745; makefile: 4,484; awk: 3,535; javascript: 3,018; xml: 918; fortran: 664; cs: 573; ruby: 396
file content (37 lines) | stat: -rw-r--r-- 1,232 bytes parent folder | download | duplicates (2)
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
//===----------------------------------------------------------------------===//
//
// This source file is part of the Swift open source project
//
// Copyright (c) 2014-2021 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
//
//===----------------------------------------------------------------------===//

/// A terminal menu that takes up the whole terminal, accepting input and
/// rendering in response.
protocol Card {
    /// Render the contents to be printed to the terminal.
    func render() -> String

    /// Accept a line of input from the user's terminal and provide
    /// an optional ``CardEvent`` which can alter the card stack.
    func acceptLineInput<S: StringProtocol>(_ line: S) async -> CardEvent?

    /// The input prompt to present to the user when accepting a line of input.
    var inputPrompt: String? { get }
}

extension Card {
    var defaultPrompt: String {
        return "Press enter to continue."
    }
}

extension Card {
    var inputPrompt: String? {
        return defaultPrompt
    }
}