feat: 'source_once' for modules to avoid re-calling src when not needed

Ciflire · Jul 16, 2024 · f9b7db3 · f9b7db3
1 parent 2cd3e8c
commit f9b7db3
Show file tree

Hide file tree

Showing 15 changed files with 70 additions and 16 deletions.
diff --git a/README.md b/README.md
@@ -123,6 +123,8 @@ Definition for modules:
 type Module struct {
 	Prefix            string `json:"prefix,omitempty"`
 	Name              string `json:"name,omitempty"`
+    SrcOnce           string `json:"src_once,omitempty"`
+    SrcOnceRefresh    bool   `json:"src_once_refresh,omitempty"`
 	Src               string `json:"src,omitempty"`
 	Cmd               string `json:"cmd,omitempty"`
 	SpecialLabel      string `json:"special_label,omitempty"`

diff --git a/config/config.go b/config/config.go
@@ -75,6 +75,8 @@ type Runner struct {
 type Module struct {
 	Prefix            string `json:"prefix,omitempty"`
 	Name              string `json:"name,omitempty"`
+	SrcOnce           string `json:"src_once,omitempty"`
+	SrcOnceRefresh    bool   `json:"src_once_refresh,omitempty"`
 	Src               string `json:"src,omitempty"`
 	Cmd               string `json:"cmd,omitempty"`
 	SpecialLabel      string `json:"special_label,omitempty"`

diff --git a/modules/applications.go b/modules/applications.go
@@ -46,6 +46,8 @@ func (a Applications) Setup(cfg *config.Config) Workable {
 	return a
 }
 
+func (a Applications) Refresh() {}
+
 func (a Applications) Name() string {
 	return ApplicationsName
 }

diff --git a/modules/clipboard/clipboard.go b/modules/clipboard/clipboard.go
@@ -33,6 +33,8 @@ func (c Clipboard) SwitcherExclusive() bool {
 	return c.switcherExclusive
 }
 
+func (c Clipboard) Refresh() {}
+
 type ClipboardItem struct {
 	Content string    `json:"content,omitempty"`
 	Time    time.Time `json:"time,omitempty"`

diff --git a/modules/commands.go b/modules/commands.go
@@ -77,3 +77,5 @@ func (cc Commands) Setup(cfg *config.Config) Workable {
 
 	return c
 }
+
+func (c Commands) Refresh() {}
diff --git a/modules/external.go b/modules/external.go
@@ -19,6 +19,8 @@ type External struct {
 	ModuleName        string
 	src               string
 	cmd               string
+	cachedOutput      []byte
+	refresh           bool
 	switcherExclusive bool
 	recalculateScore  bool
 	terminal          bool
@@ -28,21 +30,34 @@ func (e External) SwitcherExclusive() bool {
 	return e.switcherExclusive
 }
 
-func (e External) Setup(cfg *config.Config) Workable {
+func (e *External) Setup(cfg *config.Config) Workable {
 	module := Find(cfg.External, e.Name())
 	if module == nil {
 		return nil
 	}
 
 	e.prefix = module.Prefix
 	e.switcherExclusive = module.SwitcherExclusive
-	e.src = module.Src
-	e.cmd = module.Cmd
+	e.src = os.ExpandEnv(module.Src)
+	e.cmd = os.ExpandEnv(module.Cmd)
 	e.terminal = module.Terminal
 
+	if module.SrcOnce != "" {
+		e.src = os.ExpandEnv(module.SrcOnce)
+		e.cachedOutput = e.getSrcOutput(false, "")
+	}
+
+	e.refresh = module.SrcOnceRefresh
+
 	return e
 }
 
+func (e *External) Refresh() {
+	if e.refresh {
+		e.cachedOutput = e.getSrcOutput(false, "")
+	}
+}
+
 func (e External) Name() string {
 	return e.ModuleName
 }
@@ -78,20 +93,13 @@ func (e External) Entries(ctx context.Context, term string) []Entry {
 		hasExplicitResult = true
 	}
 
-	e.src = os.ExpandEnv(e.src)
-
 	if e.cmd != "" {
-		name, args := util.ParseShellCommand(e.src)
-		cmd := exec.Command(name, args...)
-
-		if !hasExplicitTerm {
-			cmd.Stdin = strings.NewReader(term)
-		}
+		var out []byte
 
-		out, err := cmd.CombinedOutput()
-		if err != nil {
-			log.Println(err)
-			return entries
+		if e.cachedOutput != nil {
+			out = e.cachedOutput
+		} else {
+			out = e.getSrcOutput(hasExplicitTerm, term)
 		}
 
 		scanner := bufio.NewScanner(strings.NewReader(string(out)))
@@ -150,3 +158,20 @@ func (e External) Entries(ctx context.Context, term string) []Entry {
 
 	return entries
 }
+
+func (e External) getSrcOutput(hasExplicitTerm bool, term string) []byte {
+	name, args := util.ParseShellCommand(e.src)
+	cmd := exec.Command(name, args...)
+
+	if !hasExplicitTerm && term != "" {
+		cmd.Stdin = strings.NewReader(term)
+	}
+
+	out, err := cmd.CombinedOutput()
+	if err != nil {
+		log.Println(err)
+		return nil
+	}
+
+	return out
+}
diff --git a/modules/finder.go b/modules/finder.go
@@ -16,6 +16,8 @@ type Finder struct {
 	switcherExclusive bool
 }
 
+func (f Finder) Refresh() {}
+
 func (f Finder) Entries(ctx context.Context, term string) []Entry {
 	e := []Entry{}
 

diff --git a/modules/hyprland.go b/modules/hyprland.go
@@ -48,6 +48,8 @@ func (h Hyprland) Setup(cfg *config.Config) Workable {
 	return b
 }
 
+func (h Hyprland) Refresh() {}
+
 func (h *Hyprland) monitorWindows() {
 	for {
 		clear(h.windows)

diff --git a/modules/runner.go b/modules/runner.go
@@ -60,6 +60,8 @@ func (r Runner) Setup(cfg *config.Config) Workable {
 	return r
 }
 
+func (r Runner) Refresh() {}
+
 func (r Runner) Prefix() string {
 	return r.prefix
 }

diff --git a/modules/ssh.go b/modules/ssh.go
@@ -18,6 +18,8 @@ type SSH struct {
 	entries           []Entry
 }
 
+func (s SSH) Refresh() {}
+
 func (s SSH) Entries(ctx context.Context, term string) []Entry {
 	fields := strings.Fields(term)
 

diff --git a/modules/switcher.go b/modules/switcher.go
@@ -58,3 +58,5 @@ func (s Switcher) Setup(cfg *config.Config) Workable {
 
 	return s
 }
+
+func (s Switcher) Refresh() {}
diff --git a/modules/util.go b/modules/util.go
@@ -22,6 +22,7 @@ type Workable interface {
 	Name() string
 	SwitcherExclusive() bool
 	Setup(cfg *config.Config) Workable
+	Refresh()
 }
 
 type MatchingType int

diff --git a/modules/websearch.go b/modules/websearch.go
@@ -80,6 +80,8 @@ func (w Websearch) Setup(cfg *config.Config) Workable {
 	return w
 }
 
+func (w Websearch) Refresh() {}
+
 func (w Websearch) Prefix() string {
 	return w.prefix
 }

diff --git a/ui/interactions.go b/ui/interactions.go
@@ -69,7 +69,7 @@ func setupModules() {
 	}
 
 	for _, v := range cfg.External {
-		e := modules.External{
+		e := &modules.External{
 			ModuleName: v.Name,
 		}
 

diff --git a/ui/ui.go b/ui/ui.go
@@ -81,6 +81,12 @@ func Activate(state *state.AppState) func(app *gtk.Application) {
 		if appstate.HasUI {
 			ui.appwin.SetVisible(true)
 
+			for _, v := range procs {
+				for _, proc := range v {
+					proc.Refresh()
+				}
+			}
+
 			if !appstate.IsMeasured {
 				fmt.Printf("startup time: %s\n", time.Since(appstate.Started))
 				appstate.IsMeasured = true
Original file line number	Diff line number	Diff line change
Expand Up		@@ -77,3 +77,5 @@ func (cc Commands) Setup(cfg *config.Config) Workable {

		return c
		}

		func (c Commands) Refresh() {}
Original file line number	Diff line number	Diff line change
Expand Up		@@ -58,3 +58,5 @@ func (s Switcher) Setup(cfg *config.Config) Workable {

		return s
		}

		func (s Switcher) Refresh() {}