shinglify

package module
v0.4.7 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Dec 5, 2021 License: MIT Imports: 33 Imported by: 0

README

Shinglify

TLDR;

Shinglify aims to emulate a tiling window manager within your regular desktop environment to give you:

  • Automatic window tiling
  • Efficient keyboard navigation
  • Virtual Workspaces that work

These three major features are fully orthogonal. You can use just one, two or all three to your liking.

Installation

Download the executable from https://gitlab.com/corthbandt/shinglify-bin/-/tree/latest or go build it. Make it auto-start after login.

Default Configuration

  • Meta-Shift-Left/Right/Up/Down - Spatial Window Navigation
  • Meta-Prior - Activate the previous window across all screens
  • Meta-Next - Activate the next window across all screens
  • Meta-Shift-Prior - Activate the previous window on the same screen
  • Meta-Shift-Next - Activate the next window on the same screens
  • Meta-Control-Prior - Activate the previous window on the same tag
  • Meta-Control-Next - Activate the next window on the same tag
  • Meta-Space - Maximize/Minimize the active window
  • Meta-1/2/3/4/5 - Switch to tags 1-5
  • Meta-Shift-1/2/3/4/5 - Send active window to tag 1-5
  • Meta-Shift-a - Set current screen to grid tiling
  • Meta-Shift-s - Set current screen to master/stack tiling
  • Meta-Shift-d - Set current screen to tabbed tiling
  • Meta-Shift-f - Set current screen to tabbed/stagger tiling

What Shinglify Does

Shinglify adds WM-like workspaces, tiling and window navigation to traditional desktop environments.

Currently, it mainly targets XFCE. There are provisions for multiple backends, for now the only one is X11/EWMH. This means it technically works in other environments too. It is also tested against Gnome, Cinnamon, KDE Plasma, Mate and various other environments. Support heavily depends on the respective window manager implementing X11/EWMH in a reasonable way.

Wayland unfortunately currently does not work. At this time, the Wayland ecosystem lacks the means for window manipulation (I'm aware of wlr-foreign-toplevel-management). The wayland developers consider this largely a not-my-problem and I guess they will want to figure out copy'n'paste first anyway.

Limitations

Wayland

Wayland currently is not supported. Later, if they get their act together.

Gnome

Gnome technically supports EWMH, but it is doing weird things with window geometry. There is a Gnome-specific tweak in place but it is not perfect. Proper support would require using DBus. With Gnome habitually breaking APIs whenever they feel like, this seems wasteful unless there is actual demand.

Minimum Window Size

Shinglify currently does not respect any kind of minimum size for windows. This may break the tiling.

Static Key Bindings

Key bindings are only applied on the initial run of the config script.

No Dynamic Config

To change the configuration, you have to stop and restart.

XFCE GenMon
  • The GenMon integration does not have any configuration yet.
  • To avoid the GenMon display getting too long, the text is culled in a very simple way.
  • Clicking does not do anything yet.
  • Screen layout changes are detected, but panel config usually does not follow.

Configuration

Shinglify is configured through a single Lua script. This script is running when Shinglify starts and whenever something relevant happens to your windows. This allows custom behaviours if you need them.

The possible config script locations are currently hard-coded. This list is tried in order:

  • $HOME/.config/shinglify/shinglify.lua
  • $HOME/.config/shinglify.lua
  • $HOME/.shinglify.lua
  • /etc/shinglify.lua
  • builtin

A default config is built into the executable and can be retrieved by running shinglify --print-default-config.

Keyboard Focus

All functionality is triggered via keyboard bindings.

Example:

key_bind("Mod4-shift-left",navigate_left)

This causes Mod4-Shift-Left to change the active window to the one left of the currently active window.

The second argument navigate_left is a Lua function that gets executed when the keyboard combination is pressed.

Example:

key_bind("Mod4-1",function() show_tag("1") end)

Here the key combination triggers an inline lua function.

Window Navigation

Shinglify provides ten built-in navigation functions:

Function Behaviour
navigate_left Switch to the closest window left of the currently active one
navigate_right Switch to the closest window right of the currently active one
navigate_up Switch to the closest window above the currently active one
navigate_down Switch to the closest window below the currently active one
navigate_next Switch to the next window across all screens
navigate_prev Switch to the previous window across all screens
navigate_next_on_screen Switch to the next window on the same screen
navigate_prev_on_screen Switch to the previous window on the same screen
navigate_next_on_tag Switch to the next window on the same tag
navigate_prev_on_tag Switch to the previous window on the same tag

The left/right/up/down navigation functions employ a number of heuristics to determine what is "closest", considering window overlapping, previous activations and relative layout.

Workspaces/Tags

Workspaces in Shinglify are called "Tags", primarily to avoid confusion with DE-native workspaces. Shinglify Tags are largely incompatible with regular workspaces provided by the desktop environment. Use one or the other, but not both.

The tag names do not have to be numbers and the names have no relation to the keyboard bindings.

Window Tiling

Shinglify provides for per-screen automatic tiling with optional gaps. Tiling is performed by tiler functions exposed to lua or written in lua.

XFCE Status Display

Shinglify has special support for XFCE. It provides for tiling status display through one or more panels that have a "Generic Monitor" item.

The assumed setup is to have one panel per screen, with one Shinglify-assigned GenMon item.

The GenMon item has to be set up in a specific way to be detected:

Command: "cat FILENAME" Label: "shinglify" or "shinglify-SCREENID"

The filename for the command should be temporary and unique. /tmp/shinglify_SCREENID would work nicely.

If the label specifies a SCREENID then this item will show the Shinglify status for that screen.

If the label does not specify a SCREENID, it is auto-detected from the panels' position.

Lua Function Reference

The configuration script is running completely on every single event.

evt_type():string

Returns the type of the event currently being handled.

This is one of:

  • ScreenChange - when the screen layout changes
  • WindowChange - when windows activate, open or close
  • Quit - when shinglify quits
  • KeyPress - when a registered keycombo is pressed
  • KeyRelease - when a registered keycombo is released
  • Error - when an error occurs
  • Raw - a raw backend event, mainly for debugging
evt_data():string

Returns additional event data, notable an error message for "Error" events and the keycombo for "KeyPress"/"KeyRelease" events.

evt_param():any

Returns optional, variant event parameters.

key_bind(keycombo,keypressfun[,keyreleasefun])

Register a key combination.

get_wm_state():window_manager_state

Get a structure describing the full state of the window manager.

get_active_windowid():string

Shortcut to get the active window ID out of the current window manager state.

get_active_screenid():string

Shortcut to get the active screen ID out of the current window manager state.

get_window_screenid(windowid):string

Shortcut to get the screen ID out for a window.

navigate_left()

Activate the next visible window left of the currently active one.

navigate_right()

Activate the next visible window right of the currently active one.

navigate_up()

Activate the next visible window above the currently active one.

navigate_down()

Activate the next visible window below the currently active one.

navigate_next()

Activate the next window in the global window list.

navigate_prev()

Activate the previous window in the global window list.

navigate_next_on_screen()

Activate the next window on the same screen.

navigate_prev_on_screen()

Activate the previous window on the same screen.

navigate_next_on_tag()

Activate the next window with the same tag.

navigate_prev_on_tag()

Activate the previous window with the same tag.

move_window_left()

Move the active window to the next screen left.

move_window_right()

Move the active window to the next screen right.

move_window_up()

Move the active window to the next screen up.

move_window_down()

Move the active window to the next screen down.

apply_tags()

Update visiblity according to tag assignments.

register_tags(tag[,tag...])

Register tag names.

set_active_window_tag(tag)

Set the tag on the active window.

set_window_tag(windowid,tag)

Set the tag on any window.

add_screen_tag(screenid,tag)

Set a tag to show on a specific screen.

show_tag(tag)

Make windows with given tag visible.

tag_visible(tag):bool

Check whether a given tag is currently visible.

show_window(windowid,show_or_hide)

Show (true) or hide (false) a window.

maximize_window(windowid,switch)

Minimize or maximize a window.

Switch:

  • 0 - restore/unmaximize
  • 1 - maximize
  • 2 - toggle
run_tiler(screenid,windowid,tilerfun)

Apply the current tiling rules. All three parameters may be nil, causing the active window/screen and/or preset tiler being used.

tiler_helper_get_screen_layout_params(screenid,single):usable_rect,innergap,dx,dy

Helper function for building scripted tilers. Returns the usable rectangle and the inter-window gap for a given screen. The return values dx and dy will allow tiling size adjustments in later versions

set_tiler([screenid][,tilerfun][,automatic])

Set the tiler for the screen identified by screenid or the default tiler if screenid is ommitted. If automatic is true, the set tiler is re-run automatically when windows open or close.

get_tiler([screenid]):tilerfun

Get the tiler for screenid or the default one if screenid is ommitted.

enable_tiler(screenid,enable)

Enable or disable the tiler on a screen without changing its settings.

set_gaps(screenid,innergap,outergap,singlegap)

When screenid is "", the global default gaps are set. If screenid is not empty, only the gaps for that screen are set.

tiler_none:tilerfun

tiler_none is a no-op tiling function.

tiler_grid:tilerfun

tiler_grid arranges all windows in a grid.

tiler_masterstack:tilerfun

tiler_masterstack applies a master-stack tiling configuration.

tiler_vtabbed:tilerfun

tiler_vtabbed arranges windows as vertical tabs.

tiler_vtabbed_stagger:tilerfun

tiler_vtabbed_stagger arranges windows as vertical tabs with a slight horizontal stagger.

enableui_xfcegenmon(with_icon:bool,active_pango,inactive_pango)

enableui_xfcegenmon activates the special integration with xfce and the genmon panel module.

Annotated Default Configuration

-- enable the XFCE GenMon integration. See the README for details.
enableui_xfcegenmon(true,"fgcolor='#80ff40'","fgcolor='#a0a0a0'")

-- Set the default tiler. This does not actually do much, but these are the options for tilers.

--set_tiler(tiler_grid)
set_tiler(tiler_masterstack)
--set_tiler(tiler_vtabbed)
--set_tiler(tiler_vtabbed_stagger)


-- Set the gaps globally. Inner, outer, single
-- Inner is the gap between windows when tiled
-- Outer is the gap between windows and the border of the usable screen space (considering panels)
-- Single is the gap around a single window on a tiled screen 
set_gaps("",5,5,5)

-- Set up navigation keys

key_bind("Mod4-shift-left",navigate_left)
key_bind("Mod4-shift-right",navigate_right)
key_bind("Mod4-shift-up",navigate_up)
key_bind("Mod4-shift-down",navigate_down)
key_bind("Mod4-prior",navigate_prev)
key_bind("Mod4-next",navigate_next)
key_bind("Mod4-shift-prior",navigate_prev_on_screen)
key_bind("Mod4-shift-next",navigate_next_on_screen)
key_bind("Mod4-control-prior",navigate_prev_on_tag)
key_bind("Mod4-control-next",navigate_next_on_tag)

-- Set a key combo to toggle maximized/normal window size

key_bind("Mod4-space",function() maximize_window(get_active_windowid(),2) end)

-- Set key combos for tags. Tags can be any text and there can be any number.

key_bind("Mod4-shift-1",function() set_active_window_tag("1") end)
key_bind("Mod4-shift-2",function() set_active_window_tag("2") end)
key_bind("Mod4-shift-3",function() set_active_window_tag("3") end)
key_bind("Mod4-shift-4",function() set_active_window_tag("4") end)
key_bind("Mod4-shift-5",function() set_active_window_tag("5") end)
key_bind("Mod4-1",function() show_tag("1") end)
key_bind("Mod4-2",function() show_tag("2") end)
key_bind("Mod4-3",function() show_tag("3") end)
key_bind("Mod4-4",function() show_tag("4") end)
key_bind("Mod4-5",function() show_tag("5") end)

-- Set key combos for tiling

key_bind("Mod4-shift-a",function()set_tiler(get_active_screenid(),tiler_grid,true)end)
key_bind("Mod4-shift-s",function()set_tiler(get_active_screenid(),tiler_masterstack,true)end)
key_bind("Mod4-shift-d",function()set_tiler(get_active_screenid(),tiler_vtabbed,true)end)
key_bind("Mod4-shift-f",function()set_tiler(get_active_screenid(),tiler_vtabbed_stagger,true)end)

Why???

The Why of Shinglify is obviously highly subjective. Take it with a grain of salt. Or two.

Tiling Window Managers

Tiling window managers are arguably more efficient for keyboard-centric workflows, with quicker arrangement of windows, keyboard-driven window navigation and semantic grouping of windows.

What tiling window managers generally lack is user friendliness. I consider this a problem. Having nice a GUI to configure your audio, networking or bluetooth is important to me. Because I cannot be bothered to learn and remember the terminal invocations to connect to a WiFi. Why should I if I do this maybe ten times a year? My brain capacity is better wasted elsewhere.

Tiling window managers also often lack in usability (example: notifications) and discoverability.

Yes, things like notifications can be added, but this requires considerable effort on the part of the user. There's a reason people show off their "ricing" on reddit. Because it is soooo much work to get right.

Desktop Environments

Full-blown desktop environments on the other hand provide all the bells and whistles for tasks you'd rather not spend half a day googling. Yay for that!

What DEs (Gnome, KDE, XFCE, MATE, Cinnamon, ...) lack is consistent and efficient keyboard-driven workflows.

Workspaces are just a mess across the board. If they work at all, they fail at multi-monitor setups.

Keyboard-driven navigation requires digging through configuration dialogs and often third-party extensions. And then they go and change whether your workspaces go up/down or left/right for no good reason, breaking everything.

Conclusion

Tiling WMs fall short in user friendliness. DEs lack in efficiency. Choose your poison.

Or... don't!

Documentation

Index

Constants

View Source 
const EvtTypeError = "Error"
View Source 
const EvtTypeInit = "Init"
View Source 
const EvtTypeKeyPress = "KeyPress"
View Source 
const EvtTypeKeyRelease = "KeyRelease"
View Source 
const EvtTypeQuit = "Quit"
View Source 
const EvtTypeRaw = "Raw"
View Source 
const EvtTypeScreenChange = "ScreenChange"
View Source 
const EvtTypeWindowActivate = "WindowActivate"
View Source 
const EvtTypeWindowChange = "WindowChange"
View Source 
const EvtTypeWindowClose = "WindowClose"
View Source 
const EvtTypeWindowGeometry = "WindowGeometry"
View Source 
const EvtTypeWindowOpen = "WindowOpen"
View Source 
const EvtTypeWindowTitle = "WindowTitle"

Variables

View Source 
var BuildDate string
View Source 
var DefaultConfig string
View Source 
var VersionString string

Functions

func Main 

func Main()

func Max 

func Max(a, b int) int

Max returns the larger of a and b

func Min 

func Min(a, b int) int

Min returns the smaller of a and b 

func NavRangesOverlap(a1, a2, b1, b2 int) bool

func Overlap 

func Overlap(a0, a1, b0, b1 int) int

Overlap returns the absolute overlap of the two ranges (a0,a1) and (b0,b1) or <=0 if no overlap. For no overlap, the value gives the distance

Types

type Direction 

type Direction int
const (
	DirNone  Direction = 0
	DirLeft  Direction = 1
	DirRight Direction = 2
	DirUp    Direction = 3
	DirDown  Direction = 4

	DirNext         Direction = 10
	DirPrev         Direction = 11
	DirNextOnScreen Direction = 20
	DirPrevOnScreen Direction = 21
	DirNextOnTag    Direction = 30
	DirPrevOnTag    Direction = 31
)

type EWMHBackend 

type EWMHBackend struct {
	// contains filtered or unexported fields
}

func (*EWMHBackend) Activate 

func (e *EWMHBackend) Activate(wid WindowID) error

func (*EWMHBackend) AddScreenTag 

func (e *EWMHBackend) AddScreenTag(sid ScreenID, tag Tag) error

func (*EWMHBackend) ArrangeWindows 

func (e *EWMHBackend) ArrangeWindows(stack []WindowID) error

func (*EWMHBackend) BeginChange 

func (e *EWMHBackend) BeginChange() error

func (*EWMHBackend) Compatible 

func (e *EWMHBackend) Compatible() bool

func (*EWMHBackend) EndChange 

func (e *EWMHBackend) EndChange() error

func (*EWMHBackend) EvtChan 

func (e *EWMHBackend) EvtChan() chan Evt

func (*EWMHBackend) Icon 

func (e *EWMHBackend) Icon(wid WindowID) image.Image

func (*EWMHBackend) Init 

func (e *EWMHBackend) Init(inst *Inst) error

func (*EWMHBackend) Maximize 

func (e *EWMHBackend) Maximize(wid WindowID, dir int) error

func (*EWMHBackend) Move 

func (e *EWMHBackend) Move(wid WindowID, r Rct) error

func (*EWMHBackend) RegisterKeyBind 

func (e *EWMHBackend) RegisterKeyBind(keys KeyBindDef, evtDataPress interface{}, evtDataRelease interface{}) error

func (*EWMHBackend) RemScreenTag 

func (e *EWMHBackend) RemScreenTag(sid ScreenID, tag Tag) error

func (*EWMHBackend) SetScreenTag 

func (e *EWMHBackend) SetScreenTag(sid ScreenID, tag Tag) error

func (*EWMHBackend) SetWindowTag 

func (e *EWMHBackend) SetWindowTag(wid WindowID, tag Tag) error

func (*EWMHBackend) Show 

func (e *EWMHBackend) Show(wid WindowID, show bool) error

func (*EWMHBackend) Shut 

func (e *EWMHBackend) Shut()

func (*EWMHBackend) State 

func (e *EWMHBackend) State(refresh bool) WMState

type Evt 

type Evt struct {
	Timestamp time.Time
	Type      string
	Data      string
	Params    interface{}
}

type Inst 

type Inst struct {
	L             *lua.LState
	Log           logfunk.F
	WMBE          WMBackend
	ScriptSource  string
	Script        *lua.LFunction
	EvtType       string
	EvtData       string
	EvtParam      lua.LValue
	RetileLockout time.Time

	ScreenParamsMap     map[ScreenID]*ScreenParams // keeps track of current tag assignments
	WinFloat            map[WindowID]struct{}
	DefaultScreenParams *ScreenParams
	GnomeShellHack      bool

	TilerNames map[*lua.LFunction]string

	UIBackends []UIBackend
}

func (*Inst) ApplyTagVisiblity 

func (inst *Inst) ApplyTagVisiblity(refresh bool, screenID ScreenID)

func (*Inst) CallTiler 

func (inst *Inst) CallTiler(scr *WMScreenState, wnd *WMWindowState, tilerfunc *lua.LFunction, resizeDir string) error

func (*Inst) GetScreenParams added in v0.4.7 

func (inst *Inst) GetScreenParams(scrid string, isolate bool) *ScreenParams

func (*Inst) GetTilerWindowIDList 

func (inst *Inst) GetTilerWindowIDList(scr *WMScreenState, wnd *WMWindowState) WMWindowIDList

func (*Inst) LuaAddScreenTag 

func (inst *Inst) LuaAddScreenTag(L *lua.LState) int

func (*Inst) LuaApplyTags 

func (inst *Inst) LuaApplyTags(L *lua.LState) int

func (*Inst) LuaEnableTiler added in v0.4.7 

func (inst *Inst) LuaEnableTiler(L *lua.LState) int

func (*Inst) LuaEnableUIXFCEGenMon added in v0.2.0 

func (inst *Inst) LuaEnableUIXFCEGenMon(L *lua.LState) int

func (*Inst) LuaEvtData 

func (inst *Inst) LuaEvtData(L *lua.LState) int

func (*Inst) LuaEvtParam 

func (inst *Inst) LuaEvtParam(L *lua.LState) int

func (*Inst) LuaEvtType 

func (inst *Inst) LuaEvtType(L *lua.LState) int

func (*Inst) LuaGetActiveScreenID 

func (inst *Inst) LuaGetActiveScreenID(L *lua.LState) int

func (*Inst) LuaGetActiveWindowID 

func (inst *Inst) LuaGetActiveWindowID(L *lua.LState) int

func (*Inst) LuaGetScreenLayout added in v0.4.3 

func (inst *Inst) LuaGetScreenLayout(L *lua.LState) int

func (*Inst) LuaGetTiler 

func (inst *Inst) LuaGetTiler(L *lua.LState) int

func (*Inst) LuaGetWMState 

func (inst *Inst) LuaGetWMState(L *lua.LState) int

func (*Inst) LuaGetWindowScreenID 

func (inst *Inst) LuaGetWindowScreenID(L *lua.LState) int

func (*Inst) LuaHelperParseWindowIDList 

func (inst *Inst) LuaHelperParseWindowIDList(L *lua.LState, paramIdx int) WMWindowIDList

func (*Inst) LuaHelperTileResultList 

func (inst *Inst) LuaHelperTileResultList(L *lua.LState, trl []TileResult) *lua.LTable

func (*Inst) LuaKeyBind 

func (inst *Inst) LuaKeyBind(L *lua.LState) int

func (*Inst) LuaMaximizeWindow 

func (inst *Inst) LuaMaximizeWindow(L *lua.LState) int

func (*Inst) LuaMoveXFCEPanelToScreen added in v0.4.3 

func (inst *Inst) LuaMoveXFCEPanelToScreen(L *lua.LState) int

func (*Inst) LuaNavigateDown 

func (inst *Inst) LuaNavigateDown(L *lua.LState) int

func (*Inst) LuaNavigateLeft 

func (inst *Inst) LuaNavigateLeft(L *lua.LState) int

func (*Inst) LuaNavigateNext 

func (inst *Inst) LuaNavigateNext(L *lua.LState) int

func (*Inst) LuaNavigateNextOnScreen 

func (inst *Inst) LuaNavigateNextOnScreen(L *lua.LState) int

func (*Inst) LuaNavigateNextOnTag 

func (inst *Inst) LuaNavigateNextOnTag(L *lua.LState) int

func (*Inst) LuaNavigatePrev 

func (inst *Inst) LuaNavigatePrev(L *lua.LState) int

func (*Inst) LuaNavigatePrevOnScreen 

func (inst *Inst) LuaNavigatePrevOnScreen(L *lua.LState) int

func (*Inst) LuaNavigatePrevOnTag 

func (inst *Inst) LuaNavigatePrevOnTag(L *lua.LState) int

func (*Inst) LuaNavigateRight 

func (inst *Inst) LuaNavigateRight(L *lua.LState) int

func (*Inst) LuaNavigateUp 

func (inst *Inst) LuaNavigateUp(L *lua.LState) int

func (*Inst) LuaRepositionWindow added in v0.2.0 

func (inst *Inst) LuaRepositionWindow(L *lua.LState) int

func (*Inst) LuaResizeTiler added in v0.3.0 

func (inst *Inst) LuaResizeTiler(L *lua.LState) int

func (*Inst) LuaRunTiler 

func (inst *Inst) LuaRunTiler(L *lua.LState) int

LuaRunTiler run_tiler(screenid,actwndid,tiler)

func (*Inst) LuaSetActiveWindowTag 

func (inst *Inst) LuaSetActiveWindowTag(L *lua.LState) int

func (*Inst) LuaSetGaps 

func (inst *Inst) LuaSetGaps(L *lua.LState) int

func (*Inst) LuaSetTiler 

func (inst *Inst) LuaSetTiler(L *lua.LState) int

func (*Inst) LuaSetWindowTag 

func (inst *Inst) LuaSetWindowTag(L *lua.LState) int

func (*Inst) LuaShowTag 

func (inst *Inst) LuaShowTag(L *lua.LState) int

func (*Inst) LuaShowWindow 

func (inst *Inst) LuaShowWindow(L *lua.LState) int

func (*Inst) LuaTagVisible 

func (inst *Inst) LuaTagVisible(L *lua.LState) int

func (*Inst) LuaTilerGrid 

func (inst *Inst) LuaTilerGrid(L *lua.LState) int

func (*Inst) LuaTilerHelperGetScreenLayoutParams 

func (inst *Inst) LuaTilerHelperGetScreenLayoutParams(L *lua.LState) int

func (*Inst) LuaTilerMasterStack 

func (inst *Inst) LuaTilerMasterStack(L *lua.LState) int

func (*Inst) LuaTilerNone 

func (inst *Inst) LuaTilerNone(L *lua.LState) int

func (*Inst) LuaTilerVTabbed 

func (inst *Inst) LuaTilerVTabbed(L *lua.LState) int

func (*Inst) LuaTilerVTabbedStagger 

func (inst *Inst) LuaTilerVTabbedStagger(L *lua.LState) int

func (*Inst) LuaWindowMoveDown added in v0.4.1 

func (inst *Inst) LuaWindowMoveDown(L *lua.LState) int

func (*Inst) LuaWindowMoveLeft added in v0.4.1 

func (inst *Inst) LuaWindowMoveLeft(L *lua.LState) int

func (*Inst) LuaWindowMoveRight added in v0.4.1 

func (inst *Inst) LuaWindowMoveRight(L *lua.LState) int

func (*Inst) LuaWindowMoveUp added in v0.4.1 

func (inst *Inst) LuaWindowMoveUp(L *lua.LState) int

func (*Inst) MoveWindowToScreen added in v0.4.1 

func (inst *Inst) MoveWindowToScreen(wndid WindowID, scrid ScreenID)

func (*Inst) NavMoveWindow added in v0.4.1 

func (inst *Inst) NavMoveWindow(wndid WindowID, dir Direction) bool

func (*Inst) PostProc 

func (inst *Inst) PostProc(wms *WMState)

func (*Inst) PrintOutputInfo added in v0.4.7 

func (inst *Inst) PrintOutputInfo()

func (*Inst) RegisterTilers 

func (inst *Inst) RegisterTilers()

func (*Inst) SetWindowTag added in v0.4.7 

func (inst *Inst) SetWindowTag(wndid WindowID, tag string)

func (*Inst) TilerHelperGetScreenLayoutParams 

func (inst *Inst) TilerHelperGetScreenLayoutParams(scrid ScreenID, single bool) (usable Rct, gap int, dx, dy int)

func (*Inst) TilerHelperProximityAdjust 

func (inst *Inst) TilerHelperProximityAdjust(trl []TileResult)

TilerHelperProximityAdjust rearranges a tiling result so that windows stay closest to their original position, unless their size changed

type KeyBindDef 

type KeyBindDef = string

type Pnt 

type Pnt struct {
	X, Y int
}

Pnt encodes a 2D integer position

type Rct 

type Rct struct {
	X, Y, W, H int
}

Rct encodes a 2D integer rectangle as top-left coordinates X/Y, width and height W/H. The right and bottom columns/rows (X+W, Y+H) are not considered part of the area.

func MkRct added in v0.2.0 

func MkRct(x, y, w, h int) Rct

func (Rct) Area 

func (r Rct) Area() int

func (Rct) B 

func (r Rct) B() int

func (Rct) BottomLeft 

func (r Rct) BottomLeft() Pnt

func (Rct) BottomRight 

func (r Rct) BottomRight() Pnt

func (Rct) Hit 

func (r Rct) Hit(p Pnt) bool

func (Rct) Intersect 

func (r Rct) Intersect(r2 Rct) bool

func (Rct) Intersection 

func (r Rct) Intersection(r2 Rct) Rct

func (Rct) IsZero added in v0.2.0 

func (r Rct) IsZero() bool

func (Rct) R 

func (r Rct) R() int

func (Rct) String added in v0.2.0 

func (r Rct) String() string

func (Rct) TopLeft 

func (r Rct) TopLeft() Pnt

func (Rct) TopRight 

func (r Rct) TopRight() Pnt

func (Rct) Valid 

func (r Rct) Valid() bool

type RctList 

type RctList struct {
	Rcts []Rct
}

RctList is a list of disjunct (i.e. non-overlapping) rectangles (Rct)

func (*RctList) Add 

func (rl *RctList) Add(r Rct)

Add r to the combined area of the list. This may change large parts of the list to ensure the non-overlapping property.

func (*RctList) Area 

func (rl *RctList) Area() int

func (*RctList) Bounds 

func (rl *RctList) Bounds() Rct

func (*RctList) Clear 

func (rl *RctList) Clear()

func (*RctList) Compact 

func (rl *RctList) Compact()

func (*RctList) Hit 

func (rl *RctList) Hit(p Pnt) bool

Hit returns true if p is within any of the rectangles

func (*RctList) Len 

func (rl *RctList) Len() int

func (*RctList) Sub 

func (rl *RctList) Sub(r Rct)

Remove r from the combined area of the list. This may change large parts of the list to ensure the non-overlapping property.

type ScreenID 

type ScreenID = string

type ScreenParams 

type ScreenParams struct {
	ScreenID       ScreenID
	TagList        TagList
	ActiveTag      Tag
	Tiler          *lua.LFunction
	TilerEnable    bool
	TilerAutomatic bool
	GapOuter       int
	GapInner       int
	GapSingle      int
	TilerDX        int
	TilerDY        int
}

type Tag 

type Tag = string

type TagList 

type TagList = []Tag

type TileResult 

type TileResult struct {
	ID  WindowID
	Geo Rct
}

type TilingMode 

type TilingMode string

type UIBackend 

type UIBackend interface {
	Compatible() bool
	Init(inst *Inst) error
	ScreenUpdate(wms WMState, events []Evt)
}

type WMBackend 

type WMBackend interface {
	Compatible() bool
	Init(inst *Inst) error
	Shut()
	RegisterKeyBind(keys KeyBindDef, evtDataPress interface{}, evtDataRelease interface{}) error
	EvtChan() chan Evt

	State(refresh bool) WMState
	Icon(wid WindowID) image.Image

	BeginChange() error
	ArrangeWindows([]WindowID) error
	Show(wid WindowID, show bool) error
	Move(wid WindowID, r Rct) error
	Maximize(wid WindowID, dir int) error // 0:unmaximize, 1=maximize, 2=toggle
	Activate(wid WindowID) error
	SetWindowTag(wid WindowID, tag Tag) error
	SetScreenTag(sid ScreenID, tag Tag) error
	AddScreenTag(sid ScreenID, tag Tag) error
	RemScreenTag(sid ScreenID, tag Tag) error
	EndChange() error
}

type WMDesktopState 

type WMDesktopState struct {
	ID       string
	Name     string
	Geometry Rct
	Active   bool
}

type WMDesktopStateList 

type WMDesktopStateList []WMDesktopState

type WMScreenIDList 

type WMScreenIDList []ScreenID

type WMScreenState 

type WMScreenState struct {
	ID           ScreenID
	Name         string
	Geometry     Rct
	Manufacturer string
	Product      string
	Serial       string
	Tags         TagList
	ActiveTag    Tag
}

type WMScreenStateList 

type WMScreenStateList []WMScreenState

type WMState 

type WMState struct {
	WMName              string
	Windows             WMWindowStateList
	Screens             WMScreenStateList // all outputs that are currently enabled and mapped
	Desktops            WMDesktopStateList
	Outputs             WMScreenStateList // all outputs, including disabled ones
	ScreensConnected    string
	ScreenLayouts       string
	ActiveWindowHistory []WindowID
}

func (*WMState) FindWindowIndex 

func (wsl *WMState) FindWindowIndex(wndid WindowID) int

func (*WMState) GetActiveWindowID 

func (wsl *WMState) GetActiveWindowID() WindowID

func (*WMState) GetScreen 

func (wsl *WMState) GetScreen(scrid ScreenID) *WMScreenState

func (*WMState) GetScreenForTag 

func (wsl *WMState) GetScreenForTag(tag Tag) ScreenID

func (*WMState) GetWindow 

func (wsl *WMState) GetWindow(wndid WindowID) *WMWindowState

func (*WMState) WindowInfo 

func (wsl *WMState) WindowInfo(wndid WindowID) string

type WMWindowIDList 

type WMWindowIDList []WindowID

type WMWindowState 

type WMWindowState struct {
	ID       WindowID
	Title    string
	Types    []string
	States   []string
	Class    string
	Instance string
	Desktop  string
	Geometry Rct
	//	InnerGeometry   Rct
	PosOfs          Pnt
	SizeOfs         Pnt
	VisibleGeometry RctList
	Visible         bool
	Active          bool
	Maximized       bool
	Special         bool
	Panel           bool
	IsDesktop       bool
	IconID          string

	PrimaryScreen string
	SingleScreen  bool
	Tag           Tag
}

func (*WMWindowState) WindowInfo 

func (w *WMWindowState) WindowInfo() string

type WMWindowStateList 

type WMWindowStateList []WMWindowState

func FilterReachable 

func FilterReachable(wsl *WMState, from WindowID, includeOccluded bool) WMWindowStateList

type WindowID 

type WindowID = string
func NavNextWindow(wsl *WMState, from WindowID, dir Direction) (nxtid WindowID)

type XFCEGenMonInstance 

type XFCEGenMonInstance struct {
	Screen         string
	Filename       string
	PluginID       int
	PanelID        string
	PanelSize      int
	PanelPluginCnt int
	LastText       string
}

type XFCEGenMonUI 

type XFCEGenMonUI struct {
	GenMons          []*XFCEGenMonInstance
	GenmonConfigDone bool
	// contains filtered or unexported fields
}

func (*XFCEGenMonUI) Compatible 

func (ui *XFCEGenMonUI) Compatible() bool

func (*XFCEGenMonUI) DetectGenmonConfig 

func (ui *XFCEGenMonUI) DetectGenmonConfig(wms WMState)

func (*XFCEGenMonUI) Init 

func (ui *XFCEGenMonUI) Init(inst *Inst) error

func (*XFCEGenMonUI) ScreenUpdate 

func (ui *XFCEGenMonUI) ScreenUpdate(wms WMState, events []Evt)

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.