//
//  Element.swift
//  LiveSnapshot
//
//  Created by Indragie Karunaratne on 3/30/19.
//  Copyright © 2019 Indragie Karunaratne. All rights reserved.
//

import Foundation
import CoreGraphics

/// Provides identifying information for an element that is displayed in the
/// view debugger.
@objc(IAVDElementLabel) public final class ElementLabel: NSObject {
    /// Classification for an element that determines how it is represented
    /// in the view debugger.
    @objc(IAVDElementClassification) public enum Classification: Int {
        /// An element of normal importance.
        case normal
        
        /// An element of higher importance that is highlighted
        case important
    }
    
    /// A human readable name for the element.
    @objc public let name: String?
    
    /// Classification for an element that determines how it is represented
    /// in the view debugger.
    @objc public let classification: Classification
    
    /// Constructs a new `Element`
    ///
    /// - Parameters:
    ///   - name: A human readable name for the element
    ///   - classification: Classification for an element that determines how it
    /// is represented in the view debugger.
    @objc public init(name: String?, classification: Classification = .normal) {
        self.name = name
        self.classification = classification
    }
}

/// A UI element that can be snapshotted.
@objc(IAVDElement) public protocol Element {
    /// Identifying information for the element, like its name and classification.
    var label: ElementLabel { get }
    
    /// A shortened description of the element.
    var shortDescription: String { get }
    
    /// The full length description of the element.
    var description: String { get }
    
    /// The frame of the element in its parent's coordinate space.
    var frame: CGRect { get }
    
    /// Whether the element is hidden from view or not.
    var isHidden: Bool { get }
    
    /// A snapshot image of the element in its current state.
    var snapshotImage: CGImage? { get }
    
    /// The child elements of the element.
    var children: [Element] { get }
}