File: VariantOverrides.swift

package info (click to toggle)
swiftlang 6.0.3-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 2,519,992 kB
  • sloc: cpp: 9,107,863; ansic: 2,040,022; asm: 1,135,751; python: 296,500; objc: 82,456; f90: 60,502; lisp: 34,951; pascal: 19,946; sh: 18,133; perl: 7,482; ml: 4,937; javascript: 4,117; makefile: 3,840; awk: 3,535; xml: 914; fortran: 619; cs: 573; ruby: 573
file content (61 lines) | stat: -rw-r--r-- 1,916 bytes parent folder | download
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
/*
 This source file is part of the Swift.org open source project

 Copyright (c) 2021 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 Swift project authors
*/

import Foundation

/// Defines the overrides for variants of documentation content.
///
/// This class can be used to accumulate override information while encoding a tree of objects.
///
/// ## Topics
///
/// ### Applying Patches
///
/// - ``RenderNodeVariantOverridesApplier``
public class VariantOverrides: Codable {
    /// The values of the variants, organized by trait.
    public var values = [VariantOverride]()
    
    /// Whether the collection of overrides is empty.
    public var isEmpty: Bool { values.isEmpty }
    
    /// Initializes a value given overrides.
    public init(values: [VariantOverride] = []) {
        add(contentsOf: values)
    }
    
    /// Adds the given override.
    public func add(_ variantOverride: VariantOverride) {
        if let index = values.firstIndex(where: { variantOverride.traits == $0.traits }) {
            values[index].patch.append(contentsOf: variantOverride.patch)
        } else {
            values.append(variantOverride)
        }
    }
    
    /// Adds the given overrides.
    public func add(
        contentsOf variantOverrides: some Collection<VariantOverride>
    ) {
        for variantOverride in variantOverrides {
            add(variantOverride)
        }
    }
    
    public func encode(to encoder: Encoder) throws {
        var container = encoder.singleValueContainer()
        try container.encode(values)
    }
    
    public required init(from decoder: Decoder) throws {
        let container = try decoder.singleValueContainer()
        self.values = try container.decode([VariantOverride].self)
    }
}