KeymapBrowser.class.st

"
A KeymapBrowser  shows a list of all defined keymappings.
It shows a filterable list of keymap shortcuts,  name and categories.
Use the context menu to browse the method that defines the shortcut.
"
Class {
	#name : #KeymapBrowser,
	#superclass : #SpPresenter,
	#instVars : [
		'clearFilterButton',
		'filterField',
		'kmTable'
	],
	#category : #'Spec2-Tools-Keymapping'
}

{ #category : #specs }
KeymapBrowser class >> defaultSpec [
	<spec>
	^ SpBoxLayout newVertical
		add:
			(SpBoxLayout newHorizontal
				add: #filterField;
				add: #clearFilterButton withConstraints: [ :constraints | constraints width: 25 ])
			withConstraints: [ :constraints | constraints height: self toolbarHeight ];
		add: #kmTable;
		yourself
]

{ #category : #'system menu' }
KeymapBrowser class >> keymapBrowserMenuOn: aBuilder [ 
	"I build a menu"
	<worldMenu>
	(aBuilder item: #'Keymap Browser')
		parent: #System;
		order: 4;
		icon: self taskbarIcon;
		action: [ self new openWithSpec ];
		help: 'List all know shortcuts and Keymapping categories.'.
]

{ #category : #accessing }
KeymapBrowser class >> taskbarIconName [
	^ #keymapBrowserIcon
]

{ #category : #private }
KeymapBrowser >> browseDefinitionOfSelectedShortcut [
	| selection action class selector |
	selection := self kmTable selection selectedItem ifNil: [ ^ self ].
	action := selection realValue keymap action ifNil: [ ^ self ].
	class := action method methodClass.
	selector := action method selector.
	Smalltalk tools browser
		openOnClass: class
		selector: selector
		highlight: selection shortcutName
]

{ #category : #accessing }
KeymapBrowser >> clearFilterButton [
	^ clearFilterButton
]

{ #category : #accessing }
KeymapBrowser >> clearFilterButton: anObject [
	clearFilterButton := anObject
]

{ #category : #private }
KeymapBrowser >> collectAllShortcuts [
	self kmTable items: self shortcuts
]

{ #category : #initialization }
KeymapBrowser >> connectPresenters [
	filterField
		whenTextChangedDo: [ :text | 
			clearFilterButton enabled: text isNotEmpty.
			self setFilter: text ].
	clearFilterButton action: [ filterField text: '' ]
]

{ #category : #accessing }
KeymapBrowser >> filterField [
	^ filterField
]

{ #category : #accessing }
KeymapBrowser >> filterField: anObject [
	filterField := anObject
]

{ #category : #api }
KeymapBrowser >> initialExtent [
	^ 600@300
]

{ #category : #initialization }
KeymapBrowser >> initializePresenters [
	kmTable := self newTable.
	kmTable
		addColumn: (SpStringTableColumn title: 'Shortcut' evaluated: [ :aKMShortcutDeclaration | aKMShortcutDeclaration realValue shortcut asString ]);
		addColumn: (SpStringTableColumn title: 'Name' evaluated: #shortcutName);
		addColumn: (SpStringTableColumn title: 'Category' evaluated: #categoryName);
		beResizable;
		menu: [ :m :s | self menu: m shifted: s ].
	filterField := self newTextInput.
	filterField
		removeEntryCompletion;
		placeholder: 'Filter';
		autoAccept: true.
	clearFilterButton := self newButton.
	clearFilterButton
		icon: (self iconNamed: #smallCancelIcon);
		enabled: false.
	self collectAllShortcuts
]

{ #category : #private }
KeymapBrowser >> inspectActionOfSelectedShortcut [
	| selection action |
	selection := self kmTable selection selectedItem ifNil: [ ^ self ].
	action := selection realValue keymap ifNil: [ ^ self ].
	action inspect
]

{ #category : #accessing }
KeymapBrowser >> kmTable [
	^ kmTable
]

{ #category : #accessing }
KeymapBrowser >> kmTable: anObject [
	kmTable := anObject
]

{ #category : #private }
KeymapBrowser >> menu: aMenu shifted: aBoolean [
	(aMenu add: 'Refresh' target: self selector: #collectAllShortcuts)
		icon: (self iconNamed: #smallUpdateIcon).
	self kmTable selection selectedItem ifNil: [ ^ aMenu ].
	(aMenu
		add: 'Browse Definition'
		target: self
		selector: #browseDefinitionOfSelectedShortcut)
		icon: (self iconNamed: #smallSystemBrowserIcon).
	(aMenu
		add: 'Inspect Action'
		target: self
		selector: #inspectActionOfSelectedShortcut)
		icon: (self iconNamed: #smallInspectItIcon).
	^ aMenu
]

{ #category : #private }
KeymapBrowser >> setFilter: aFilterText [
	aFilterText
		ifEmpty: [ self collectAllShortcuts ]
		ifNotEmpty: [ :filter | 
			self kmTable
				items: (self shortcuts select: [ :shortcut | {shortcut realValue shortcut asString . shortcut shortcutName . shortcut categoryName} anySatisfy: [ :s | s includesSubstring: filter caseSensitive: false ] ]) ]
]

{ #category : #private }
KeymapBrowser >> shortcuts [
	| collection |
	collection := OrderedCollection new.
	KMRepository default categories
		do: [ :cat | 
			cat keymaps
				do: [ :keymapping | 
					collection
						add:
							(KMShortcutDeclaration new
								shortcutName: keymapping name;
								categoryName: cat name;
								yourself) ] ].
	^ collection sorted: #categoryName ascending
]

{ #category : #initialization }
KeymapBrowser >> title [
	^ 'Keymap Browser'
]