Merge pull request #18 from nwg-piotr/searchres

focus first search result #17

README.md

@@ -5,7 +5,8 @@ This application is a part of the [nwg-shell](https://github.com/nwg-piotr/nwg-s
 Nwg-drawer is a golang replacement to the `nwggrid` command
 (a part of [nwg-launchers](https://github.com/nwg-piotr/nwg-launchers)). It's being developed with
 [sway](https://github.com/swaywm/sway) in mind, but should also work with other wlroots-based Wayland compositors.
-X Window System is not supported.
+X Window System is not officially supported, but you should be able to use the drawer on some floating
+window managers (tested on Openbox).
 
 The `nwg-drawer` command displays the application grid. The search entry allows to look for installed applications,
 and for files in XDG user directories. The grid view may also be filtered by categories.
@@ -24,17 +25,18 @@ and `nwggrid`.
 
 ### Dependencies
 
-- go 1.16 (just to build)
+- go >=1.16 (just to build)
 - gtk3
 - gtk-layer-shell
+- xdg-utils
 
 Optional (recommended):
 
 - thunar
 - alacritty
 
-You may use another file manager and terminal emulator (see command line arguments), but for now the program has
- only been tested with the two mentioned above.
+You may use another file manager and terminal emulator (see command line arguments), but mentioned above have been
+confirmed to work well with the program. Also see **Files** below.
 
 ### Steps
 
@@ -63,8 +65,12 @@ Usage of nwg-drawer:
     	Icon Size (default 64)
   -lang string
     	force lang, e.g. "en", "pl"
+  -nocats
+    	Disable filtering by category
+  -nofs
+    	Disable file search
   -o string
-    	name of the Output to display the menu on (sway only)
+    	name of the Output to display the drawer on (sway only)
   -ovl
     	use OVerLay layer
   -s string
@@ -80,6 +86,37 @@ Usage of nwg-drawer:
 
 Edit `~/.config/nwg-panel/drawer.css` to your taste.
 
+## Files
+
+When the search phrase is at least 3 characters long, your XDG user directories are being searched.
+
+![screenshot-03.png](https://scrot.cloud/images/2021/05/30/screenshot-03.png)
+
+Use the **left mouse button** to open a file with the `xdg-open` command. As configuring file associations for it is
+PITA, you may override them, by creating the `~/.config/nwg-panel/preferred-apps.json` file with your own definitions.
+
+### Sample file content
+
+```json
+{
+  "\\.pdf$": "atril",
+  "\\.svg$": "inkscape",
+  "\\.(jpg|png|tiff|gif)$": "feh",
+  "\\.(mp3|ogg|flac|wav|wma)$": "audacious",
+  "\\.(avi|mp4|mkv|mov|wav)$": "mpv",
+  "\\.(doc|docx|xls|xlsx)$": "libreoffice"
+}
+```
+
+Use the **right mouse button** to open the file with your file manager (see `-fm` argument). The result depends on the
+file manager you use.
+
+- thunar will open the file location
+- pcmanfm will open the file with its associated program
+- caja won't open anything, except for directories
+
+I've noy yet tried other file managers.
+
 ## Credits
 
 This program uses some great libraries:

drawer.css

@@ -3,11 +3,12 @@ window {
     color: #eeeeee
 }
 
+/* search entry */
 entry {
     background-color: rgba (0, 0, 0, 0.2)
 }
 
-button {
+button, image {
     background: none;
     border: none
 }
@@ -16,6 +17,11 @@ button:hover {
     background-color: rgba (255, 255, 255, 0.1)
 }
 
+/* in case you wanted to give category buttons a different look */
+#category-button {
+    margin: 0 10px 0 10px
+}
+
 #pinned-box {
     padding-bottom: 5px;
     border-bottom: 1px dotted gray

go.mod

@@ -1,4 +1,4 @@
-module github.com/nwg-piotr/nwg-menu
+module github.com/nwg-piotr/nwg-drawer
 
 go 1.16
 

main.go

@@ -19,7 +19,7 @@ import (
 	"github.com/gotk3/gotk3/gtk"
 )
 
-const version = "0.1.1"
+const version = "0.1.9"
 
 var (
 	appDirs         []string
@@ -28,6 +28,7 @@ var (
 	pinned          []string
 	src             glib.SourceHandle
 	id2entry        map[string]desktopEntry
+	preferredApps   map[string]interface{}
 )
 
 var categoryNames = [...]string{
@@ -90,6 +91,7 @@ var (
 	fileSearchResultWrapper *gtk.Box
 	pinnedFlowBox           *gtk.FlowBox
 	pinnedFlowBoxWrapper    *gtk.Box
+	categoriesWrapper       *gtk.Box
 	catButtons              []*gtk.Button
 	statusLabel             *gtk.Label
 	status                  string
@@ -98,7 +100,7 @@ var (
 
 // Flags
 var cssFileName = flag.String("s", "drawer.css", "Styling: css file name")
-var targetOutput = flag.String("o", "", "name of the Output to display the menu on (sway only)")
+var targetOutput = flag.String("o", "", "name of the Output to display the drawer on (sway only)")
 var displayVersion = flag.Bool("v", false, "display Version information")
 var overlay = flag.Bool("ovl", false, "use OVerLay layer")
 var iconSize = flag.Int("is", 64, "Icon Size")
@@ -109,6 +111,8 @@ var lang = flag.String("lang", "", "force lang, e.g. \"en\", \"pl\"")
 var fileManager = flag.String("fm", "thunar", "File Manager")
 var term = flag.String("term", "alacritty", "Terminal emulator")
 var nameLimit = flag.Int("fslen", 80, "File Search name length Limit")
+var noCats = flag.Bool("nocats", false, "Disable filtering by category")
+var noFS = flag.Bool("nofs", false, "Disable file search")
 
 func main() {
 	timeStart := time.Now()
@@ -172,6 +176,7 @@ func main() {
 	if err != nil {
 		pinned = nil
 	}
+	println(fmt.Sprintf("Found %v pinned items", len(pinned)))
 
 	cssFile := filepath.Join(configDirectory, *cssFileName)
 
@@ -184,6 +189,16 @@ func main() {
 
 	status = parseDesktopFiles(desktopFiles)
 
+	// For opening files we use xdg-open. As its configuration is PITA, we may override some associations
+	// in the ~/.config/nwg-panel/preferred-apps.json file.
+	paFile := filepath.Join(configDirectory, "preferred-apps.json")
+	preferredApps, err = loadPreferredApps(paFile)
+	if err != nil {
+		println(fmt.Sprintf("Custom associations file %s not found or invalid", paFile))
+	} else {
+		println(fmt.Sprintf("Found %v associations in %s", len(preferredApps), paFile))
+	}
+
 	// USER INTERFACE
 	gtk.Init(nil)
 
@@ -253,12 +268,11 @@ func main() {
 			return false
 		case gdk.KEY_downarrow, gdk.KEY_Up, gdk.KEY_Down, gdk.KEY_Left, gdk.KEY_Right, gdk.KEY_Tab,
 			gdk.KEY_Return, gdk.KEY_Page_Up, gdk.KEY_Page_Down, gdk.KEY_Home, gdk.KEY_End:
-			//searchEntry.SetText("")
 			return false
 
 		default:
 			if !searchEntry.IsFocus() {
-				searchEntry.GrabFocus()
+				searchEntry.GrabFocusWithoutSelecting()
 			}
 			return false
 		}
@@ -298,10 +312,12 @@ func main() {
 	searchEntry.SetMaxWidthChars(30)
 	searchBoxWrapper.PackStart(searchEntry, true, false, 0)
 
-	categoriesWrapper, _ := gtk.BoxNew(gtk.ORIENTATION_HORIZONTAL, 0)
+	if !*noCats {
+		categoriesWrapper, _ = gtk.BoxNew(gtk.ORIENTATION_HORIZONTAL, 0)
 		categoriesButtonBox := setUpCategoriesButtonBox()
 		categoriesWrapper.PackStart(categoriesButtonBox, true, false, 0)
 		outerVBox.PackStart(categoriesWrapper, false, false, 0)
+	}
 
 	pinnedWrapper, _ := gtk.BoxNew(gtk.ORIENTATION_HORIZONTAL, 0)
 	outerVBox.PackStart(pinnedWrapper, false, false, 0)
@@ -311,10 +327,19 @@ func main() {
 	pinnedFlowBox = setUpPinnedFlowBox()
 
 	resultWindow, _ = gtk.ScrolledWindowNew(nil, nil)
+	resultWindow.SetEvents(int(gdk.ALL_EVENTS_MASK))
 	resultWindow.SetPolicy(gtk.POLICY_AUTOMATIC, gtk.POLICY_AUTOMATIC)
 	resultWindow.Connect("enter-notify-event", func() {
 		cancelClose()
 	})
+	resultWindow.Connect("button-release-event", func(sw *gtk.ScrolledWindow, e *gdk.Event) bool {
+		btnEvent := gdk.EventButtonNewFromEvent(e)
+		if btnEvent.Button() == 1 || btnEvent.Button() == 3 {
+			gtk.MainQuit()
+			return true
+		}
+		return false
+	})
 	outerVBox.PackStart(resultWindow, true, true, 10)
 
 	resultsWrapper, _ := gtk.BoxNew(gtk.ORIENTATION_VERTICAL, 0)
@@ -341,11 +366,13 @@ func main() {
 	resultsWrapper.PackStart(placeholder, true, true, 0)
 	placeholder.SetSizeRequest(20, 20)
 
+	if !*noFS {
 		wrapper, _ := gtk.BoxNew(gtk.ORIENTATION_HORIZONTAL, 0)
 		fileSearchResultWrapper, _ = gtk.BoxNew(gtk.ORIENTATION_HORIZONTAL, 0)
 		fileSearchResultWrapper.SetProperty("name", "files-box")
 		wrapper.PackStart(fileSearchResultWrapper, true, false, 0)
 		resultsWrapper.PackEnd(wrapper, false, false, 10)
+	}
 
 	statusLineWrapper, _ := gtk.BoxNew(gtk.ORIENTATION_HORIZONTAL, 0)
 	outerVBox.PackStart(statusLineWrapper, false, false, 10)
@@ -353,9 +380,13 @@ func main() {
 	statusLineWrapper.PackStart(statusLabel, true, false, 0)
 
 	win.ShowAll()
+	if !*noFS {
 		fileSearchResultWrapper.SetSizeRequest(appFlowBox.GetAllocatedWidth(), 1)
-	categoriesWrapper.SetSizeRequest(1, categoriesWrapper.GetAllocatedHeight()*2)
 		fileSearchResultWrapper.Hide()
+	}
+	if !*noCats {
+		categoriesWrapper.SetSizeRequest(1, categoriesWrapper.GetAllocatedHeight()*2)
+	}
 
 	t := time.Now()
 	println(fmt.Sprintf("UI created in %v ms. Thank you for your patience.", t.Sub(timeStart).Milliseconds()))

tools.go

@@ -2,6 +2,8 @@ package main
 
 import (
 	"context"
+	"encoding/json"
+	"errors"
 	"fmt"
 	"io"
 	"io/fs"
@@ -10,6 +12,7 @@ import (
 	"os"
 	"os/exec"
 	"path/filepath"
+	"regexp"
 	"sort"
 	"strings"
 	"time"
@@ -243,6 +246,25 @@ func getAppDirs() []string {
 	return dirs
 }
 
+func loadPreferredApps(path string) (map[string]interface{}, error) {
+	jsonFile, err := os.Open(path)
+	if err != nil {
+		return nil, err
+	}
+	defer jsonFile.Close()
+
+	byteValue, _ := ioutil.ReadAll(jsonFile)
+
+	var result map[string]interface{}
+	json.Unmarshal([]byte(byteValue), &result)
+
+	if len(result) == 0 {
+		return nil, errors.New("json invalid or empty")
+	}
+
+	return result, nil
+}
+
 func listFiles(dir string) ([]fs.FileInfo, error) {
 	files, err := ioutil.ReadDir(dir)
 	if err == nil {
@@ -268,7 +290,7 @@ func listDesktopFiles() []string {
 }
 
 func setUpCategories() {
-	path := filepath.Join(getDataHome(), "nwg-menu/desktop-directories")
+	path := filepath.Join(getDataHome(), "nwg-drawer/desktop-directories")
 	var other category
 
 	for _, cName := range categoryNames {
@@ -583,17 +605,19 @@ func launch(command string, terminal bool) {
 	envVarsNum := strings.Count(command, "=")
 	var envVars []string
 
-	cmdIdx := 0
-	lastEnvVarIdx := 0
+	cmdIdx := -1
 
 	if envVarsNum > 0 {
 		for idx, item := range elements {
 			if strings.Contains(item, "=") {
-				lastEnvVarIdx = idx
 				envVars = append(envVars, item)
+			} else if !strings.HasPrefix(item, "-") && cmdIdx == -1 {
+				cmdIdx = idx
 			}
 		}
-		cmdIdx = lastEnvVarIdx + 1
+	}
+	if cmdIdx == -1 {
+		cmdIdx = 0
 	}
 
 	cmd := exec.Command(elements[cmdIdx], elements[1+cmdIdx:]...)
@@ -620,14 +644,25 @@ func launch(command string, terminal bool) {
 	})
 }
 
-func open(filePath string) {
-	cmd := exec.Command(*fileManager, filePath)
-	go cmd.Run()
+func open(filePath string, xdgOpen bool) {
+	var cmd *exec.Cmd
+	if xdgOpen {
+		cmd = exec.Command("xdg-open", filePath)
+		// Look for possible custom file association
+		for key, element := range preferredApps {
+			r, err := regexp.Compile(key)
+			if err == nil && r.MatchString(filePath) {
+				cmd = exec.Command(fmt.Sprintf("%v", element), filePath)
+				break
+			}
+		}
+	} else {
+		cmd = exec.Command(*fileManager, filePath)
+	}
+	fmt.Printf("Executing: %s", cmd)
+	cmd.Start()
 
-	glib.TimeoutAdd(uint(150), func() bool {
 	gtk.MainQuit()
-		return false
-	})
 }
 
 // Returns map output name -> gdk.Monitor

uicomponents.go

@@ -17,7 +17,7 @@ func setUpPinnedFlowBox() *gtk.FlowBox {
 	flowBox, _ := gtk.FlowBoxNew()
 	if uint(len(pinned)) >= *columnsNumber {
 		flowBox.SetMaxChildrenPerLine(*columnsNumber)
-	} else {
+	} else if len(pinned) > 0 {
 		flowBox.SetMaxChildrenPerLine(uint(len(pinned)))
 	}
 
@@ -78,16 +78,17 @@ func setUpPinnedFlowBox() *gtk.FlowBox {
 			})
 			flowBox.Add(btn)
 		}
+		pinnedFlowBoxWrapper.PackStart(flowBox, true, false, 0)
+
+		//While moving focus with arrow keys we want buttons to get focus directly
+		flowBox.GetChildren().Foreach(func(item interface{}) {
+			item.(*gtk.Widget).SetCanFocus(false)
+		})
 	}
 	flowBox.Connect("enter-notify-event", func() {
 		cancelClose()
 	})
 
-	pinnedFlowBoxWrapper.PackStart(flowBox, true, false, 0)
-	//While moving focus with arrow keys we want buttons to get focus directly
-	flowBox.GetChildren().Foreach(func(item interface{}) {
-		item.(*gtk.Widget).SetCanFocus(false)
-	})
 	flowBox.ShowAll()
 
 	return flowBox
@@ -113,6 +114,7 @@ func setUpCategoriesButtonBox() *gtk.EventBox {
 	hBox, _ := gtk.BoxNew(gtk.ORIENTATION_HORIZONTAL, 0)
 	eventBox.Add(hBox)
 	button, _ := gtk.ButtonNewWithLabel("All")
+	button.SetProperty("name", "category-button")
 	button.Connect("clicked", func(item *gtk.Button) {
 		searchEntry.SetText("")
 		appFlowBox = setUpAppsFlowBox(nil, "")
@@ -126,8 +128,11 @@ func setUpCategoriesButtonBox() *gtk.EventBox {
 	for _, cat := range categories {
 		if isSupposedToShowUp(cat.Name) {
 			button, _ = gtk.ButtonNewFromIconName(cat.Icon, gtk.ICON_SIZE_MENU)
+			button.SetProperty("name", "category-button")
 			catButtons = append(catButtons, button)
 			button.SetLabel(cat.DisplayName)
+			// fix #8
+			button.SetAlwaysShowImage(true)
 			hBox.PackStart(button, false, false, 0)
 			name := cat.Name
 			b := *button
@@ -141,7 +146,9 @@ func setUpCategoriesButtonBox() *gtk.EventBox {
 				w := b.GetAllocatedWidth()
 				b.SetImagePosition(gtk.POS_TOP)
 				b.SetSizeRequest(w, 0)
+				if fileSearchResultWrapper != nil {
 					fileSearchResultWrapper.Hide()
+				}
 			})
 		}
 	}
@@ -314,13 +321,17 @@ func setUpSearchEntry() *gtk.SearchEntry {
 		phrase, _ = searchEntry.GetText()
 		if len(phrase) > 0 {
 
+			// search apps
 			appFlowBox = setUpAppsFlowBox(nil, phrase)
 
-			if len(phrase) > 2 {
+			// search files
+			if !*noFS && len(phrase) > 2 {
 				if fileSearchResultFlowBox != nil {
 					fileSearchResultFlowBox.Destroy()
 				}
+
 				fileSearchResultFlowBox = setUpFileSearchResultContainer()
+
 				for key := range userDirsMap {
 					if key != "home" {
 						fileSearchResults = nil
@@ -332,22 +343,53 @@ func setUpSearchEntry() *gtk.SearchEntry {
 					statusLabel.SetText("0 results")
 				}
 			} else {
+				// search phrase too short
 				if fileSearchResultFlowBox != nil {
 					fileSearchResultFlowBox.Destroy()
 				}
+				if fileSearchResultWrapper != nil {
 					fileSearchResultWrapper.Hide()
 				}
+			}
+			// focus 1st search result #17
+			var w *gtk.Widget
+			if appFlowBox != nil {
+				b := appFlowBox.GetChildAtIndex(0)
+				if b != nil {
+					button, err := b.GetChild()
+					if err == nil {
+						button.ToWidget().GrabFocus()
+						w = button.ToWidget()
+					}
+				}
+			}
+			if w == nil && fileSearchResultFlowBox != nil {
+				f := fileSearchResultFlowBox.GetChildAtIndex(0)
+				if f != nil {
+					//f.SetCanFocus(false)
+					button, err := f.GetChild()
+					if err == nil {
+						button.ToWidget().SetCanFocus(true)
+						button.ToWidget().GrabFocus()
+					}
+				}
+			}
 		} else {
+			// clear search results
+			appFlowBox = setUpAppsFlowBox(nil, "")
+
 			if fileSearchResultFlowBox != nil {
 				fileSearchResultFlowBox.Destroy()
 			}
-			appFlowBox = setUpAppsFlowBox(nil, "")
+
+			if fileSearchResultWrapper != nil {
 				fileSearchResultWrapper.Hide()
 			}
+		}
 	})
-	searchEntry.Connect("focus-in-event", func() {
+	/*searchEntry.Connect("focus-in-event", func() {
 		searchEntry.SetText("")
-	})
+	})*/
 
 	return searchEntry
 }
@@ -370,7 +412,8 @@ func searchUserDir(dir string) {
 		}
 		fileSearchResultFlowBox.Hide()
 
-		statusLabel.SetText(fmt.Sprintf("%v results", fileSearchResultFlowBox.GetChildren().Length()))
+		statusLabel.SetText(fmt.Sprintf("%v results | LMB: xdg-open | RMB: file manager",
+			fileSearchResultFlowBox.GetChildren().Length()))
 		num := uint(fileSearchResultFlowBox.GetChildren().Length() / *fsColumns)
 		fileSearchResultFlowBox.SetMinChildrenPerLine(num + 1)
 		fileSearchResultFlowBox.SetMaxChildrenPerLine(num + 1)
@@ -389,6 +432,7 @@ func setUpUserDirButton(iconName, displayName, entryName string, userDirsMap map
 	}
 	box, _ := gtk.BoxNew(gtk.ORIENTATION_HORIZONTAL, 0)
 	button, _ := gtk.ButtonNew()
+	button.SetAlwaysShowImage(true)
 	img, _ := gtk.ImageNewFromIconName(iconName, gtk.ICON_SIZE_MENU)
 	button.SetImage(img)
 
@@ -397,8 +441,16 @@ func setUpUserDirButton(iconName, displayName, entryName string, userDirsMap map
 	}
 	button.SetLabel(displayName)
 
-	button.Connect("clicked", func() {
-		launch(fmt.Sprintf("%s %s", *fileManager, userDirsMap[entryName]), false)
+	button.Connect("button-release-event", func(btn *gtk.Button, e *gdk.Event) bool {
+		btnEvent := gdk.EventButtonNewFromEvent(e)
+		if btnEvent.Button() == 1 {
+			open(userDirsMap[entryName], true)
+			return true
+		} else if btnEvent.Button() == 3 {
+			open(userDirsMap[entryName], false)
+			return true
+		}
+		return false
 	})
 
 	box.PackStart(button, false, true, 0)
@@ -413,6 +465,7 @@ func setUpUserFileSearchResultButton(fileName, filePath string) *gtk.Box {
 	if strings.HasPrefix(filePath, "#is_dir#") {
 		filePath = filePath[8:]
 		img, _ := gtk.ImageNewFromIconName("folder", gtk.ICON_SIZE_MENU)
+		button.SetAlwaysShowImage(true)
 		button.SetImage(img)
 	}
 
@@ -426,8 +479,20 @@ func setUpUserFileSearchResultButton(fileName, filePath string) *gtk.Box {
 		button.SetTooltipText(tooltipText)
 	}
 
-	button.Connect("clicked", func() {
-		open(filePath)
+	button.Connect("button-release-event", func(btn *gtk.Button, e *gdk.Event) bool {
+		btnEvent := gdk.EventButtonNewFromEvent(e)
+		if btnEvent.Button() == 1 {
+			open(filePath, true)
+			return true
+		} else if btnEvent.Button() == 3 {
+			open(filePath, false)
+			return true
+		}
+		return false
+	})
+
+	button.Connect("activate", func() {
+		open(filePath, true)
 	})
 
 	box.PackStart(button, false, true, 0)