File: ListItemContainer.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 (54 lines) | stat: -rw-r--r-- 1,993 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
/*
 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
*/

/// A markup element that can contain only `ListItem`s as children and require no other information.
public protocol ListItemContainer: BlockMarkup {
    /// Create a list from a sequence of items.
    init<Items: Sequence>(_ items: Items) where  Items.Element == ListItem
}

// MARK: - Public API

public extension ListItemContainer {
    /// Create a list with one item.
    init(_ item: ListItem) {
        self.init(CollectionOfOne(item))
    }
    /// Create a list with the given `ListItem`s.
    init(_ items: ListItem...) {
        self.init(items)
    }

    /// The items of the list.
    ///
    /// - Precondition: All children of a `ListItemContainer`
    ///   must be a `ListItem`.
    var listItems: LazyMapSequence<MarkupChildren, ListItem> {
        return children.lazy.map { $0 as! ListItem }
    }

    /// Replace all list items with a sequence of items.
    mutating func setListItems<Items: Sequence>(_ newItems: Items) where Items.Element == ListItem {
        replaceItemsInRange(0..<childCount, with: newItems)
    }

    /// Replace list items in a range with a sequence of items.
    mutating func replaceItemsInRange<Items: Sequence>(_ range: Range<Int>, with incomingItems: Items) where Items.Element == ListItem {
        var rawChildren = raw.markup.copyChildren()
        rawChildren.replaceSubrange(range, with: incomingItems.map { $0.raw.markup })
        let newRaw = raw.markup.withChildren(rawChildren)
        _data = _data.replacingSelf(newRaw)
    }

    /// Append an item to the list.
    mutating func appendItem(_ item: ListItem) {
        replaceItemsInRange(childCount..<childCount, with: CollectionOfOne(item))
    }
}