DSFQuickActionBar+Window.swift

//
//  DSFQuickActionBar+Window.swift
//
//  Copyright © 2022 Darren Ford. All rights reserved.
//
//  MIT license
//
//  Permission is hereby granted, free of charge, to any person obtaining a copy
//  of this software and associated documentation files (the "Software"), to
//  deal in the Software without restriction, including without limitation the
//  rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
//  sell copies of the Software, and to permit persons to whom the Software is
//  furnished to do so, subject to the following conditions:
//
//  The above copyright notice and this permission notice shall be included in
//  all copies or substantial portions of the Software.
//
//  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
//  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
//  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
//  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
//  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
//  FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
//  IN THE SOFTWARE.
//

import AppKit
import DSFAppearanceManager

extension DSFQuickActionBar {
	@objc(DSFQuickActionBarWindow) class Window: EphemeralWindow {
		// The actionbar instance
		var quickActionBar: DSFQuickActionBar!

		// To minimise the number of calls during edit
		let debouncer = DSFDebounce(seconds: 0.2)

		// Allow the window to become key
		override var canBecomeKey: Bool { return true }
		override var canBecomeMain: Bool { return true }

		override func resignFirstResponder() -> Bool {
			return true
		}

		var showKeyboardShortcuts: Bool = false

		// The placeholder text for the edit field
		var placeholderText: String = "" {
			didSet {
				self.editLabel.placeholderString = self.placeholderText
			}
		}

		private var _currentSearchText: String = ""
		private(set) var currentSearchText: String {
			get { _currentSearchText }
			set {
				_currentSearchText = newValue
				self.editLabel.stringValue = newValue
			}
		}

		// Primary container
		private lazy var primaryStack: NSStackView = {
			let stack = NSStackView()
			stack.identifier = NSUserInterfaceItemIdentifier("primary")
			stack.translatesAutoresizingMaskIntoConstraints = false
			stack.orientation = .vertical
			stack.edgeInsets = NSEdgeInsets(top: 8, left: 8, bottom: 8, right: 8)

			stack.setContentHuggingPriority(.required, for: .horizontal)
			stack.setContentHuggingPriority(.required, for: .vertical)
			stack.setContentCompressionResistancePriority(.defaultHigh, for: .vertical)

			stack.setHuggingPriority(.required, for: .vertical)

			stack.needsLayout = true

			return stack
		}()

		// The edit label
		internal lazy var editLabel: NSTextField = {
			let t = NSTextField()
			t.translatesAutoresizingMaskIntoConstraints = false
			t.wantsLayer = true
			t.drawsBackground = false
			t.isBordered = false
			t.isBezeled = false
			t.font = NSFont.systemFont(ofSize: 24, weight: .light)
			t.textColor = NSColor.textColor
			t.alignment = .left
			t.isEnabled = true
			t.isEditable = true
			t.isSelectable = true
			t.placeholderString = DSFQuickActionBar.DefaultPlaceholderString

			t.focusRingType = .none

			t.setContentHuggingPriority(.defaultLow, for: .horizontal)
			t.setContentHuggingPriority(.defaultHigh, for: .vertical)
			t.setContentCompressionResistancePriority(.defaultLow, for: .horizontal)
			t.setContentCompressionResistancePriority(.defaultHigh, for: .vertical)

			return t
		}()

		// The upper left image
		private lazy var searchImage: NSImageView = {
			let imageView = NSImageView()
			imageView.translatesAutoresizingMaskIntoConstraints = false
			imageView.setContentHuggingPriority(.defaultLow, for: .horizontal)
			imageView.setContentHuggingPriority(.defaultLow, for: .vertical)
			imageView.addConstraint(NSLayoutConstraint(item: imageView, attribute: .width, relatedBy: .equal, toItem: nil, attribute: .width, multiplier: 1, constant: 24))
			imageView.addConstraint(NSLayoutConstraint(item: imageView, attribute: .height, relatedBy: .equal, toItem: nil, attribute: .height, multiplier: 1, constant: 28))
			imageView.imageScaling = .scaleProportionallyUpOrDown

			let image = self.quickActionBar.searchImage!
			imageView.image = image
			return imageView
		}()

		// The stack of '[image] | [edit field]'
		private lazy var searchStack: NSStackView = {
			let stack = NSStackView()
			stack.translatesAutoresizingMaskIntoConstraints = false
			stack.orientation = .horizontal

			if let _ = self.quickActionBar.searchImage {
				stack.addArrangedSubview(searchImage)
			}

			stack.addArrangedSubview(editLabel)
			editLabel.setContentHuggingPriority(.defaultLow, for: .horizontal)
			editLabel.setContentHuggingPriority(.defaultHigh, for: .vertical)

			stack.setContentHuggingPriority(.defaultHigh, for: .horizontal)
			stack.setContentHuggingPriority(.defaultHigh, for: .vertical)

			stack.setHuggingPriority(.required, for: .vertical)

			return stack
		}()

		// The results view
		lazy var results: DSFQuickActionBar.ResultsView = {
			let r = DSFQuickActionBar.ResultsView()
			r.translatesAutoresizingMaskIntoConstraints = false
			r.setContentHuggingPriority(.defaultLow, for: .horizontal)
			r.quickActionBar = self.quickActionBar
			r.showKeyboardShortcuts = self.showKeyboardShortcuts
			r.configure()

			return r
		}()

		// Is set to true when the user 'activates' an item in the result list
		internal var userDidActivateItem: Bool = false
	}
}

extension DSFQuickActionBar.Window {
	@inlinable func reloadData() {
		self.results.reloadData()
	}
}

internal extension DSFQuickActionBar.Window {
	// Build the quick action bar display
	func setup(parentWindow: NSWindow? = nil, initialSearchText: String?) {
		self.autorecalculatesKeyViewLoop = true

		// Make sure we adopt the effective appearance
		UsingEffectiveAppearance(ofWindow: parentWindow) {

			primaryStack.translatesAutoresizingMaskIntoConstraints = false
			primaryStack.setContentHuggingPriority(.required, for: .horizontal)
			primaryStack.setContentHuggingPriority(.required, for: .vertical)

			self.contentView = primaryStack

			self.backgroundColor = NSColor.clear
			self.isOpaque = true

			// We set 'titled' here AND 'borderless' as it seems to give us a bolder
			// drop shadow than just 'borderless' itself. How odd!
			self.styleMask = [.titled, .fullSizeContentView, .borderless]

			// Make sure the user cannot move the window
			self.isMovable = false
			self.isMovableByWindowBackground = false

			primaryStack.wantsLayer = true
			let baseLayer = primaryStack.layer!

			baseLayer.cornerRadius = 10
			baseLayer.backgroundColor = NSColor.windowBackgroundColor.cgColor
			baseLayer.borderColor = NSColor.controlColor.cgColor
			baseLayer.borderWidth = 1

			primaryStack.needsLayout = true

			primaryStack.addArrangedSubview(searchStack)

			results.isHidden = true
			primaryStack.addArrangedSubview(results)

			editLabel.delegate = self

			self.makeFirstResponder(editLabel)
			self.invalidateShadow()
			self.level = .floating

			if let parent = parentWindow {
				self.order(.above, relativeTo: parent.windowNumber)
			}

			self.primaryStack.layoutSubtreeIfNeeded()

			if let initialSearchText = initialSearchText {
				self.currentSearchText = initialSearchText
			}

			self.textChanged()
		}
	}
}

extension DSFQuickActionBar.Window {
	// Called when the user presses 'escape' when the window is present
	override func cancelOperation(_: Any?) {
		// Tell the window to lose its initial responder status, which will close it.
		self.resignMain()
	}

	// Called from the results view when the user presses the left arrow
	func pressedLeftArrowInResultsView() {
		self.makeFirstResponder(self.editLabel)
	}
}

extension DSFQuickActionBar.Window: NSTextFieldDelegate {
	func controlTextDidChange(_: Notification) {
		self.debouncer.debounce { [weak self] in
			self?.textChanged()
		}
	}

	func textChanged() {
		guard let contentSource = self.quickActionBar.contentSource else { return }

		let currentSearch = self.editLabel.stringValue
		self._currentSearchText = currentSearch

		// Get a list of the identifiers than match
		let identifiers = contentSource.quickActionBar(
			self.quickActionBar,
			itemsForSearchTerm: currentSearch
		)

		// And update the display list
		self.results.currentSearchTerm = currentSearch
		self.results.identifiers = identifiers
	}

	func control(_: NSControl, textView _: NSTextView, doCommandBy commandSelector: Selector) -> Bool {
		if commandSelector == #selector(moveDown(_:)) {
			return self.results.selectNextSelectableRow()
		}
		else if commandSelector == #selector(moveUp(_:)) {
			return self.results.selectPreviousSelectableRow()
		}
		else if commandSelector == #selector(insertNewline(_:)) {
			let currentRowSelection = self.results.selectedRow
			guard currentRowSelection >= 0 else { return false }
			self.results.rowAction()
			return true
		}
		else if self.showKeyboardShortcuts,
				  let event = self.currentEvent,
				  event.modifierFlags.contains(.command),
				  let chars = event.characters,
				  let index = Int(chars)
		{
			return self.results.performShortcutAction(for: index)
		}

		return false
	}
}