Add support for the observation framework

Sources/Adwaita/Model/Data Flow/Binding.swift

@@ -146,3 +146,12 @@ extension Binding where Value: MutableCollection, Value.Element: Identifiable {
  }
 
 }
+
+extension Binding: CustomStringConvertible where Value: CustomStringConvertible {
+
+ /// A textual description of the wrapped value.
+ public var description: String {
+ wrappedValue.description
+ }
+
+}

Sources/Adwaita/Model/Enumerations/Icon.swift

@@ -9,7 +9,7 @@ import Foundation
 
 // swiftlint:disable type_body_length file_length
 /// An icon.
-public enum Icon {
+public enum Icon: CustomStringConvertible {
 
  /// A preinstalled icon.
  /// - Parameter icon: The default icon.
@@ -28,6 +28,9 @@ public enum Icon {
  }
  }
 
+ /// A textual description of the icon.
+ public var description: String { string }
+
  /// A preinstalled icon.
  public enum DefaultIcon: String {
  // swiftlint:disable missing_docs identifier_name

Sources/Adwaita/Model/Extensions/Array.swift

@@ -12,6 +12,23 @@ extension Array: AnyView where Element == AnyView {
  /// The array's view body is the array itself.
  public var viewContent: Body { self }
 
+ /// Get the debug tree for an array of views.
+ /// - Parameter parameters: Whether the widget parameters should be visible in the tree.
+ /// - Returns: The tree.
+ public func getBodyDebugTree(parameters: Bool) -> String {
+ var description = ""
+ for view in self {
+ let viewDescription: String
+ if let widget = view as? Widget {
+ viewDescription = widget.getViewDescription(parameters: parameters)
+ } else {
+ viewDescription = view.getDebugTree(parameters: parameters)
+ }
+ description += viewDescription
+ }
+ return description
+ }
+
  /// Get a widget from a collection of views.
  /// - Parameter modifiers: Modify views before being updated.
  /// - Returns: A widget.

Sources/Adwaita/Model/Extensions/DefaultStringInterpolation.swift

@@ -0,0 +1,35 @@
+//
+// DefaultStringInterpolation.swift
+// Adwaita
+//
+// Created by david-swift on 01.05.24.
+//
+// Thanks to Eneko Alonso, Pyry Jahkola, cukr for the comments in this Swift forum discussion:
+// "Multi-line string nested indentation with interpolation"
+// https://forums.swift.org/t/multi-line-string-nested-indentation-with-interpolation/36933
+//
+
+extension DefaultStringInterpolation {
+
+ /// Preserve the indentation in a multi line string.
+ /// - Parameter string: The string.
+ ///
+ /// Use it the following way:
+ /// """
+ /// Hello
+ /// \(indented: "World\n Test")
+ /// """
+ public mutating func appendInterpolation(indented string: String) {
+ // swiftlint:disable compiler_protocol_init
+ let indent = String(stringInterpolation: self).reversed().prefix { " \t".contains($0) }
+ // swiftlint:enable compiler_protocol_init
+ if indent.isEmpty {
+ appendInterpolation(string)
+ } else {
+ appendLiteral(
+ string.split(separator: "\n", omittingEmptySubsequences: false).joined(separator: "\n" + indent)
+ )
+ }
+ }
+
+}

Sources/Adwaita/Model/Extensions/Optional.swift

@@ -0,0 +1,15 @@
+//
+// Optional.swift
+// Adwaita
+//
+// Created by david-swift on 01.05.20204.
+//
+
+extension Optional: CustomStringConvertible where Wrapped: CustomStringConvertible {
+
+ /// A textual description of the wrapped value.
+ public var description: String {
+ self?.description ?? "nil"
+ }
+
+}

Sources/Adwaita/Model/User Interface/View/AnyView.swift

@@ -15,6 +15,20 @@ public protocol AnyView {
 
 extension AnyView {
 
+ /// Get the view's debug tree.
+ /// - Parameter parameters: Whether the widget parameters should be included in the debug tree.
+ /// - Returns: A textual description.
+ public func getDebugTree(parameters: Bool) -> String {
+ if let body = self as? Body {
+ return body.getBodyDebugTree(parameters: parameters)
+ }
+ return """
+ \(Self.self) {
+ \(indented: viewContent.getBodyDebugTree(parameters: parameters))
+ }
+ """
+ }
+
  func getModified(modifiers: [(AnyView) -> AnyView]) -> AnyView {
  var modified: AnyView = self
  for modifier in modifiers {

Sources/Adwaita/Model/User Interface/View/Widget.swift

@@ -8,6 +8,10 @@
 /// A widget is a view that know about its GTUI widget.
 public protocol Widget: AnyView {
 
+ /// The debug tree parameters.
+ var debugTreeParameters: [(String, value: CustomStringConvertible)] { get }
+ /// The debug tree's content.
+ var debugTreeContent: [(String, body: Body)] { get }
  /// The view storage.
  /// - Parameter modifiers: Modify views before being updated.
  func container(modifiers: [(AnyView) -> AnyView]) -> ViewStorage
@@ -25,4 +29,29 @@ extension Widget {
  /// A widget's view is empty.
  public var viewContent: Body { [] }
 
+ /// A description of the view.
+ public func getViewDescription(parameters: Bool) -> String {
+ var content = ""
+ for element in debugTreeContent {
+ if content.isEmpty {
+ content += """
+ {
+ \(indented: element.body.getDebugTree(parameters: parameters))
+ }
+ """
+ } else {
+ content += """
+ \(element.0): {
+ \(indented: element.body.getDebugTree(parameters: parameters))
+ }
+ """
+ }
+ }
+ if parameters {
+ let parametersString = debugTreeParameters.map { "\($0.0): \($0.value)" }.joined(separator: ", ")
+ return "\(Self.self)(\(parametersString))\(content)"
+ }
+ return "\(Self.self)\(content)"
+ }
+
 }

Sources/Adwaita/View/Dialogs/AboutDialog.swift

@@ -29,6 +29,24 @@ struct AboutDialog: Widget {
  /// The link for opening issues.
  var issues: URL?
 
+ /// The debug tree parameters.
+ var debugTreeParameters: [(String, value: CustomStringConvertible)] {
+ [
+ ("visible", value: visible),
+ ("appName", value: appName),
+ ("developer", value: developer),
+ ("version", value: version),
+ ("icon", value: icon),
+ ("website", value: website),
+ ("issues", value: issues)
+ ]
+ }
+
+ /// The debug tree's content.
+ var debugTreeContent: [(String, body: Body)] {
+ [("child", body: [child])]
+ }
+
  /// The ID for the dialog's storage.
  let dialogID = "dialog"
 

Sources/Adwaita/View/Dialogs/AlertDialog.swift

@@ -33,6 +33,22 @@ public struct AlertDialog: Widget {
  /// The child view.
  var child: AnyView
 
+ /// The debug tree parameters.
+ public var debugTreeParameters: [(String, value: CustomStringConvertible)] {
+ [
+ ("visible", value: visible),
+ ("id", value: id),
+ ("heading", value: heading),
+ ("body", value: body),
+ ("responses", value: responses)
+ ]
+ }
+
+ /// The debug tree's content.
+ public var debugTreeContent: [(String, body: Body)] {
+ [("child", body: [child])]
+ }
+
  /// Information about a response.
  struct Response: Identifiable {
 

Sources/Adwaita/View/Dialogs/Dialog.swift

@@ -30,6 +30,22 @@ struct Dialog: Widget {
  /// The ID for the content's storage.
  let contentID = "content"
 
+ /// The debug tree parameters.
+ var debugTreeParameters: [(String, value: CustomStringConvertible)] {
+ [
+ ("visible", value: visible),
+ ("id", value: id),
+ ("title", value: title),
+ ("width", value: width),
+ ("height", value: height)
+ ]
+ }
+
+ /// The debug tree's content.
+ var debugTreeContent: [(String, body: Body)] {
+ [("child", body: [child]), ("content", body: content)]
+ }
+
  /// Get the container of the child.
  /// - Parameter modifiers: Modify views before being updated.
  /// - Returns: The view storage.

Sources/Adwaita/View/ForEach.swift

@@ -18,6 +18,21 @@ public struct ForEach<Element>: Widget where Element: Identifiable {
  /// Whether the list is horizontal.
  var horizontal: Bool
 
+ /// The debug tree parameters.
+ public var debugTreeParameters: [(String, value: CustomStringConvertible)] {
+ [
+ ("elements", value: elements),
+ ("horizontal", value: horizontal)
+ ]
+ }
+
+ /// The debug tree's content.
+ public var debugTreeContent: [(String, body: Body)] {
+ elements.map { element in
+ ("\(element)", body: content(element))
+ }
+ }
+
  /// Initialize `ForEach`.
  public init(_ elements: [Element], horizontal: Bool = false, @ViewBuilder content: @escaping (Element) -> Body) {
  self.elements = elements

Sources/Adwaita/View/Generated/ActionRow.swift

@@ -2,7 +2,7 @@
 // ActionRow.swift
 // Adwaita
 //
-// Created by auto-generation on 28.04.24.
+// Created by auto-generation on 02.05.24.
 //
 
 import CAdw
@@ -104,6 +104,20 @@ public struct ActionRow: Widget {
  /// The window.
  var window: GTUIApplicationWindow?
 
+ /// The debug tree parameters.
+ public var debugTreeParameters: [(String, value: CustomStringConvertible)] {
+ [("iconName", value: "\(iconName)"), ("subtitle", value: "\(subtitle)"), ("subtitleLines", value: "\(subtitleLines)"), ("subtitleSelectable", value: "\(subtitleSelectable)"), ("title", value: "\(title)"), ("titleLines", value: "\(titleLines)"), ("titleSelectable", value: "\(titleSelectable)"), ("useMarkup", value: "\(useMarkup)"), ("useUnderline", value: "\(useUnderline)"), ("activated", value: "\(activated)"), ("app", value: "\(app)"), ("window", value: "\(window)")]
+ }
+
+ /// The debug tree's content.
+ public var debugTreeContent: [(String, body: Body)] {
+ var content: [(String, body: Body)] = [("activatableWidget", body: self.activatableWidget?() ?? []),]
+
+ content.append(("suffix", body: self.suffix()))
+ content.append(("prefix", body: self.prefix()))
+ return content
+ }
+
  /// Initialize `ActionRow`.
  public init() {
  }

Sources/Adwaita/View/Generated/Avatar.swift

@@ -2,7 +2,7 @@
 // Avatar.swift
 // Adwaita
 //
-// Created by auto-generation on 28.04.24.
+// Created by auto-generation on 02.05.24.
 //
 
 import CAdw
@@ -55,6 +55,18 @@ public struct Avatar: Widget {
  /// The window.
  var window: GTUIApplicationWindow?
 
+ /// The debug tree parameters.
+ public var debugTreeParameters: [(String, value: CustomStringConvertible)] {
+ [("iconName", value: "\(iconName)"), ("showInitials", value: "\(showInitials)"), ("size", value: "\(size)"), ("text", value: "\(text)"), ("app", value: "\(app)"), ("window", value: "\(window)")]
+ }
+
+ /// The debug tree's content.
+ public var debugTreeContent: [(String, body: Body)] {
+ var content: [(String, body: Body)] = []
+
+ return content
+ }
+
  /// Initialize `Avatar`.
  public init(showInitials: Bool, size: Int) {
  self.showInitials = showInitials

Sources/Adwaita/View/Generated/Banner.swift

@@ -2,7 +2,7 @@
 // Banner.swift
 // Adwaita
 //
-// Created by auto-generation on 28.04.24.
+// Created by auto-generation on 02.05.24.
 //
 
 import CAdw
@@ -60,6 +60,18 @@ public struct Banner: Widget {
  /// The window.
  var window: GTUIApplicationWindow?
 
+ /// The debug tree parameters.
+ public var debugTreeParameters: [(String, value: CustomStringConvertible)] {
+ [("buttonLabel", value: "\(buttonLabel)"), ("revealed", value: "\(revealed)"), ("title", value: "\(title)"), ("useMarkup", value: "\(useMarkup)"), ("buttonClicked", value: "\(buttonClicked)"), ("app", value: "\(app)"), ("window", value: "\(window)")]
+ }
+
+ /// The debug tree's content.
+ public var debugTreeContent: [(String, body: Body)] {
+ var content: [(String, body: Body)] = []
+
+ return content
+ }
+
  /// Initialize `Banner`.
  public init(title: String) {
  self.title = title

Sources/Adwaita/View/Generated/Bin.swift

@@ -2,7 +2,7 @@
 // Bin.swift
 // Adwaita
 //
-// Created by auto-generation on 28.04.24.
+// Created by auto-generation on 02.05.24.
 //
 
 import CAdw
@@ -31,6 +31,18 @@ public struct Bin: Widget {
  /// The window.
  var window: GTUIApplicationWindow?
 
+ /// The debug tree parameters.
+ public var debugTreeParameters: [(String, value: CustomStringConvertible)] {
+ [("app", value: "\(app)"), ("window", value: "\(window)")]
+ }
+
+ /// The debug tree's content.
+ public var debugTreeContent: [(String, body: Body)] {
+ var content: [(String, body: Body)] = [("child", body: self.child?() ?? []),]
+
+ return content
+ }
+
  /// Initialize `Bin`.
  public init() {
  }