SPB Git

Repository Public

StudioInspector.swift 17.7 KB 297 lines swift

1// ORIX DJ2// File: App/Sources/Features/AutomationStudio/StudioInspector.swift3// Description: Right pane of the Automation Studio (what the validated script needs, documentation for the symbol4//              under the caret, simulation settings) and the presets gallery.5//6// Author: Simon-Pierre Boucher7// Contact: contact@spboucher.ai8import ORIXDJCore9import SwiftUI1011struct StudioInspectorView: View {12    @Environment(AppModel.self) private var model13    let studio: AutomationStudioState1415    private func field(_ title: LocalizedStringKey, _ value: String) -> some View {16        HStack(alignment: .firstTextBaseline, spacing: 6) {17            Text(title).font(.system(size: 11)).foregroundStyle(ORIX.Palette.textSecondary).frame(width: 78, alignment: .leading)18            Text(verbatim: value).font(ORIX.Typeface.value).foregroundStyle(ORIX.Palette.textPrimary).frame(maxWidth: .infinity, alignment: .leading)19        }20        .accessibilityElement(children: .combine)21    }2223    var body: some View {24        ScrollView {25            VStack(alignment: .leading, spacing: ORIX.Space.sm) {26                script27                Divider().overlay(ORIX.Palette.hairline)28                documentation29                Divider().overlay(ORIX.Palette.hairline)30                simulation31            }32            .padding(ORIX.Space.sm)33        }34        .background(ORIX.Palette.surface)35        .accessibilityIdentifier("automation-inspector")36    }3738    // MARK: Script3940    @ViewBuilder private var script: some View {41        SectionLabel("Script")42        if let doc = model.activeDocument {43            if let validation = studio.validations[doc.id] {44                let result = validation.result45                if let program = result.program {46                    let name = studio.automationName(for: doc.id, program: program)47                    if program.automations.count > 1 {48                        Picker("Automation", selection: Binding(get: { name ?? "" }, set: { studio.selectedAutomation[doc.id] = $0 })) {49                            ForEach(program.automations, id: \.name) { a in Text(verbatim: a.name).tag(a.name) }50                        }51                        .controlSize(.small)52                        .help("The automation that Run, Simulate and Debug start.")53                        .accessibilityIdentifier("automation-inspector-automation")54                    }55                    if let automation = name.flatMap({ program.automation(named: $0) }) {56                        let req = automation.requirements57                        field("Automation", automation.name)58                        HStack(alignment: .center, spacing: 6) {59                            Text("Decks").font(.system(size: 11)).foregroundStyle(ORIX.Palette.textSecondary).frame(width: 78, alignment: .leading)60                            if req.decks.isEmpty { Text("none").font(ORIX.Typeface.value).foregroundStyle(ORIX.Palette.textPrimary) }61                            ForEach(req.decks.sorted(), id: \.self) { d in DeckBadge(index: d, size: 18) }62                            Spacer(minLength: 0)63                        }64                        field("Effects", req.effects.isEmpty ? "none" : req.effects.sorted().joined(separator: ", "))65                        field("Length", req.lengthBeats.map(StudioFormat.length) ?? "runs until stopped")66                        field("Start", automation.quantize == .none ? "immediately" : "on the next \(automation.quantize.rawValue)")67                        if req.usesEvents { field("Events", "waits for events") }68                        if req.usesAbsoluteTime { field("Timing", "uses seconds (not tempo-relative)") }69                    }70                    if result.warnings.isEmpty {71                        Label("Valid", systemImage: "checkmark.circle.fill").font(.system(size: 11, weight: .medium)).foregroundStyle(ORIX.Palette.success)72                    }73                } else {74                    Label("\(result.errors.count) error\(result.errors.count == 1 ? "" : "s"): see Problems", systemImage: "xmark.octagon.fill")75                        .font(.system(size: 11, weight: .medium)).foregroundStyle(ORIX.Palette.danger)76                }77                ForEach(Array(result.warnings.enumerated()), id: \.offset) { _, w in78                    Button { studio.jump(to: w.location.line, column: w.location.column, in: doc.id, model: model) } label: {79                        HStack(alignment: .firstTextBaseline, spacing: 5) {80                            Image(systemName: "exclamationmark.triangle.fill").font(.system(size: 10)).foregroundStyle(ORIX.Palette.warning)81                            Text(verbatim: "Line \(w.location.line): \(w.message)").font(.system(size: 11)).foregroundStyle(ORIX.Palette.textPrimary).multilineTextAlignment(.leading)82                        }83                    }84                    .buttonStyle(.plain)85                }86                if validation.source != doc.source { Text("Re-validating…").font(.system(size: 10)).foregroundStyle(ORIX.Palette.textTertiary) }87            } else {88                Text("Validating…").font(.system(size: 11)).foregroundStyle(ORIX.Palette.textTertiary)89            }90        }91    }9293    // MARK: Documentation9495    /// Documentation for the longest prefix of the path that the reference knows.96    static func documentation(for path: String) -> (path: String, text: String)? {97        var parts = path.split(separator: ".").map(String.init)98        while !parts.isEmpty {99            let candidate = parts.joined(separator: ".")100            if let doc = Autocomplete.documentation(for: candidate) { return (candidate, doc) }101            parts.removeLast()102        }103        return nil104    }105106    @ViewBuilder private var documentation: some View {107        SectionLabel("Documentation")108        let path = studio.hoverPath ?? studio.caretPath109        if let path, let doc = Self.documentation(for: path) {110            VStack(alignment: .leading, spacing: 4) {111                Text(verbatim: doc.path).font(ORIX.Typeface.mono.weight(.semibold)).foregroundStyle(ORIX.Palette.accentSecondary)112                Text(verbatim: doc.text).font(.system(size: 11)).foregroundStyle(ORIX.Palette.textPrimary).textSelection(.enabled).fixedSize(horizontal: false, vertical: true)113                Text(studio.hoverPath != nil ? "Under the pointer" : "At the caret").font(.system(size: 10)).foregroundStyle(ORIX.Palette.textTertiary)114            }115            .accessibilityIdentifier("automation-inspector-doc")116        } else {117            Text("Place the caret on a path such as deck.A.volume, or point at it, to read its reference entry.")118                .font(.system(size: 11)).foregroundStyle(ORIX.Palette.textTertiary).fixedSize(horizontal: false, vertical: true)119        }120    }121122    // MARK: Simulation settings123124    @ViewBuilder private var simulation: some View {125        @Bindable var studio = studio126        SectionLabel("Simulation settings")127        Text("Used by Simulate and Debug. The simulated rig never touches audio.").font(.system(size: 10)).foregroundStyle(ORIX.Palette.textTertiary).fixedSize(horizontal: false, vertical: true)128        HStack(spacing: 6) {129            Text("Tempo").font(.system(size: 11)).foregroundStyle(ORIX.Palette.textSecondary).frame(width: 78, alignment: .leading)130            TextField("Tempo", value: Binding(get: { studio.settings.bpm }, set: { studio.settings.bpm = min(400, max(20, $0)) }), format: .number.precision(.fractionLength(0 ... 2)))131                .textFieldStyle(.roundedBorder).frame(width: 64).multilineTextAlignment(.trailing).monospacedDigit().controlSize(.small)132                .accessibilityIdentifier("automation-sim-bpm")133            Text(verbatim: "BPM").font(.system(size: 11)).foregroundStyle(ORIX.Palette.textSecondary)134        }135        HStack(spacing: 6) {136            Text("Stop after").font(.system(size: 11)).foregroundStyle(ORIX.Palette.textSecondary).frame(width: 78, alignment: .leading)137            TextField("Maximum beats", value: Binding(get: { studio.settings.maxBeats }, set: { studio.settings.maxBeats = min(100_000, max(1, $0)) }), format: .number.precision(.fractionLength(0)))138                .textFieldStyle(.roundedBorder).frame(width: 64).multilineTextAlignment(.trailing).monospacedDigit().controlSize(.small)139                .accessibilityIdentifier("automation-sim-maxbeats")140            Text("beats").font(.system(size: 11)).foregroundStyle(ORIX.Palette.textSecondary)141        }142        VStack(alignment: .leading, spacing: 4) {143            ForEach(0 ..< ScriptSchema.deckCount, id: \.self) { d in144                HStack(spacing: 8) {145                    DeckBadge(index: d, size: 18)146                    Toggle("Loaded", isOn: Binding(get: { studio.settings.deckLoaded[d] }, set: { studio.settings.deckLoaded[d] = $0; if !$0 { studio.settings.deckPlaying[d] = false } }))147                        .accessibilityLabel("Deck \(deckLetters[d]) loaded")148                    Toggle("Playing", isOn: Binding(get: { studio.settings.deckPlaying[d] }, set: { studio.settings.deckPlaying[d] = $0 }))149                        .disabled(!studio.settings.deckLoaded[d])150                        .accessibilityLabel("Deck \(deckLetters[d]) playing")151                }152                .toggleStyle(.checkbox).font(.system(size: 11)).controlSize(.small)153            }154        }155        .accessibilityElement(children: .contain).accessibilityIdentifier("automation-sim-decks")156        HStack {157            Text("Triggers to fire").font(.system(size: 11)).foregroundStyle(ORIX.Palette.textSecondary)158            Spacer()159            StudioIconButton(title: "Add Trigger", symbol: "plus") { studio.settings.triggers.append(SimTrigger(beat: 8, number: 1)) }160                .accessibilityIdentifier("automation-sim-add-trigger")161        }162        if studio.settings.triggers.isEmpty {163            Text("None. Add one to test scripts that wait for on trigger(n).").font(.system(size: 10)).foregroundStyle(ORIX.Palette.textTertiary).fixedSize(horizontal: false, vertical: true)164        }165        ForEach($studio.settings.triggers) { $trigger in166            HStack(spacing: 4) {167                Text("Trigger").font(.system(size: 11)).foregroundStyle(ORIX.Palette.textSecondary)168                Picker("Trigger number", selection: $trigger.number) {169                    ForEach(1 ... ScriptSchema.triggerCount, id: \.self) { n in Text(verbatim: "\(n)").tag(n) }170                }171                .labelsHidden().fixedSize().controlSize(.small)172                Text("at beat").font(.system(size: 11)).foregroundStyle(ORIX.Palette.textSecondary)173                TextField("Beat", value: $trigger.beat, format: .number.precision(.fractionLength(0 ... 2)))174                    .textFieldStyle(.roundedBorder).frame(width: 54).multilineTextAlignment(.trailing).monospacedDigit().controlSize(.small)175                Spacer(minLength: 0)176                Button { studio.settings.triggers.removeAll { $0.id == trigger.id } } label: { Image(systemName: "minus.circle") }177                    .buttonStyle(.borderless).accessibilityLabel("Remove trigger")178            }179        }180    }181}182183// MARK: - Presets gallery184185/// What compiling a preset tells about it.186struct PresetFacts: Sendable {187    var decks: [String]188    var effects: [String]189    var lengthBeats: Double?190    var usesEvents: Bool191    var compiles: Bool192}193194struct PresetsGalleryView: View {195    @Environment(AppModel.self) private var model196    let studio: AutomationStudioState197    @State private var search = ""198    @State private var facts: [String: PresetFacts] = [:]199200    private func matches(_ p: ScriptPreset) -> Bool {201        let words = LibraryText.fold(search).split(separator: " ")202        let haystack = LibraryText.fold(p.name + " " + p.summary + " " + p.category.rawValue)203        return words.allSatisfy { haystack.contains($0) }204    }205206    var body: some View {207        VStack(spacing: 0) {208            HStack(spacing: ORIX.Space.xs) {209                SectionLabel("Presets")210                Text("Ordinary ORIX Script. Opening one creates an editable copy; the presets themselves never change.")211                    .font(.system(size: 11)).foregroundStyle(ORIX.Palette.textTertiary).lineLimit(1)212                Spacer(minLength: 4)213                HStack(spacing: 4) {214                    Image(systemName: "magnifyingglass").font(.system(size: 11)).foregroundStyle(ORIX.Palette.textTertiary)215                    TextField("Search presets", text: $search).textFieldStyle(.plain).font(.system(size: 12))216                        .accessibilityIdentifier("automation-presets-search")217                }218                .padding(.horizontal, 8).frame(width: 220, height: 26)219                .background(ORIX.Palette.well, in: RoundedRectangle(cornerRadius: ORIX.Radius.chip))220            }221            .padding(.horizontal, ORIX.Space.sm).frame(height: 38)222            .background(ORIX.Palette.surface)223            Divider().overlay(ORIX.Palette.hairline)224            ScrollView {225                LazyVStack(alignment: .leading, spacing: ORIX.Space.sm) {226                    let shown = PresetLibrary.all.filter(matches)227                    if shown.isEmpty { Text("No preset matches.").font(.system(size: 12)).foregroundStyle(ORIX.Palette.textTertiary) }228                    ForEach(PresetCategory.allCases, id: \.self) { category in229                        let items = shown.filter { $0.category == category }230                        if !items.isEmpty {231                            Text(verbatim: category.rawValue).font(ORIX.Typeface.title).foregroundStyle(ORIX.Palette.textPrimary)232                            LazyVGrid(columns: [GridItem(.adaptive(minimum: 270, maximum: 420), spacing: ORIX.Space.xs, alignment: .top)], alignment: .leading, spacing: ORIX.Space.xs) {233                                ForEach(items) { preset in card(preset) }234                            }235                        }236                    }237                }238                .padding(ORIX.Space.sm)239            }240        }241        .background(ORIX.Palette.canvas)242        .task {243            guard facts.isEmpty else { return }244            // Every preset is compiled once, off the main thread, to read its real requirements.245            facts = await Task.detached(priority: .userInitiated) {246                var out: [String: PresetFacts] = [:]247                for p in PresetLibrary.all {248                    let result = ScriptCompiler.compile(p.source)249                    if let a = result.program?.automations.first {250                        out[p.name] = PresetFacts(decks: a.requirements.deckLetters, effects: a.requirements.effects.sorted(), lengthBeats: a.requirements.lengthBeats, usesEvents: a.requirements.usesEvents, compiles: true)251                    } else { out[p.name] = PresetFacts(decks: [], effects: [], lengthBeats: nil, usesEvents: false, compiles: false) }252                }253                return out254            }.value255        }256        .accessibilityElement(children: .contain).accessibilityIdentifier("automation-presets")257    }258259    private func card(_ preset: ScriptPreset) -> some View {260        let f = facts[preset.name]261        return VStack(alignment: .leading, spacing: 6) {262            Text(verbatim: preset.name).font(.system(size: 13, weight: .semibold)).foregroundStyle(ORIX.Palette.textPrimary).lineLimit(1)263            Text(verbatim: preset.summary).font(.system(size: 11)).foregroundStyle(ORIX.Palette.textSecondary).lineLimit(3).frame(maxWidth: .infinity, minHeight: 40, alignment: .topLeading)264            HStack(spacing: 4) {265                if let f {266                    if !f.compiles { Label("Does not compile", systemImage: "xmark.octagon.fill").font(.system(size: 10)).foregroundStyle(ORIX.Palette.danger) }267                    ForEach(f.decks, id: \.self) { letter in if let i = deckLetters.firstIndex(of: letter) { DeckBadge(index: i, size: 16) } }268                    if f.compiles {269                        Text(verbatim: f.lengthBeats.map { StudioFormat.number($0) + " beats · " + StudioFormat.number($0 / 4) + " bars" } ?? (f.usesEvents ? "until stopped (events)" : "until stopped"))270                            .font(ORIX.Typeface.caption).foregroundStyle(ORIX.Palette.textSecondary).lineLimit(1)271                    }272                } else { Text("Compiling…").font(ORIX.Typeface.caption).foregroundStyle(ORIX.Palette.textTertiary) }273                Spacer(minLength: 0)274            }275            .frame(height: 18)276            Text(verbatim: (f?.effects.isEmpty ?? true) ? "No effect" : f!.effects.joined(separator: ", ")).font(.system(size: 10, design: .monospaced)).foregroundStyle(ORIX.Palette.textTertiary).lineLimit(1)277            HStack(spacing: 6) {278                StudioIconButton(title: "Open in Editor", symbol: "doc.badge.plus", showsTitle: true) {279                    model.newDocument(name: preset.name, source: preset.source, origin: .preset); studio.mode = .editor280                }281                .accessibilityIdentifier("automation-preset-open-\(preset.name)")282                StudioIconButton(title: "Simulate", symbol: "chart.xyaxis.line", showsTitle: true) { studio.simulate(source: preset.source, title: preset.name, docID: nil) }283                    .accessibilityIdentifier("automation-preset-simulate-\(preset.name)")284                StudioIconButton(title: "Run", symbol: "play.fill", tint: ORIX.Palette.success, showsTitle: true) {285                    studio.requestRun(source: preset.source, automation: nil, title: preset.name, origin: "preset", model: model)286                }287                .accessibilityIdentifier("automation-preset-run-\(preset.name)")288            }289        }290        .padding(ORIX.Space.sm)291        .background(ORIX.Palette.surface, in: RoundedRectangle(cornerRadius: ORIX.Radius.card, style: .continuous))292        .overlay(RoundedRectangle(cornerRadius: ORIX.Radius.card, style: .continuous).strokeBorder(ORIX.Palette.hairline))293        .accessibilityElement(children: .contain)294        .accessibilityLabel(Text(verbatim: preset.name))295    }296}297
Files main
Menu

Theme