aboutsummaryrefslogtreecommitdiff
path: root/Sources/SwiftChessNeo/Player.swift
blob: 45f3145b7033125a046603090a6110bad41a1de5 (plain)
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
//
//  Player.swift
//  Sage
//
//  Copyright 2016-2017 Nikolai Vazquez
//  Modified by SuperGeroy
//
//  Licensed under the Apache License, Version 2.0 (the "License");
//  you may not use this file except in compliance with the License.
//  You may obtain a copy of the License at
//
//      http://www.apache.org/licenses/LICENSE-2.0
//
//  Unless required by applicable law or agreed to in writing, software
//  distributed under the License is distributed on an "AS IS" BASIS,
//  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
//  See the License for the specific language governing permissions and
//  limitations under the License.
//

/// A chess game player.
public struct Player: Equatable, CustomStringConvertible {

    /// A player kind.
    public enum Kind: String, CustomStringConvertible {

        /// Human player kind.
        case human = "Human"

        /// Computer player kind.
        case computer = "Computer"

        /// Boolean indicating `self` is a human.
        public var isHuman: Bool {
            return self == .human
        }

        /// Boolean indicating `self` is a computer.
        public var isComputer: Bool {
            return self == .computer
        }

        /// A textual representation of this instance.
        public var description: String {
            return rawValue
        }

    }

    /// The player's kind.
    public var kind: Kind

    /// The player's name.
    public var name: String?

    /// The player's elo rating.
    public var elo: UInt?

    /// A textual representation of this instance.
    public var description: String {
        return "Player(kind: \(kind), name: \(name._altDescription), elo: \(elo._altDescription))"
    }

    /// Create a player with `kind` and `name`.
    ///
    /// - parameter kind: The player's kind. Default is human.
    /// - parameter name: The player's name. Default is `nil`.
    /// - parameter elo: The player's elo rating. Default is `nil`.
    public init(kind: Kind = .human, name: String? = nil, elo: UInt? = nil) {
        self.kind = kind
        self.name = name
        self.elo = elo
    }

}

/// Returns `true` if the players are the same.
public func == (lhs: Player, rhs: Player) -> Bool {
    return lhs.kind == rhs.kind
        && lhs.name == rhs.name
        && lhs.elo  == rhs.elo
}