1package ports
2
3import (
4 "image"
5 "regexp"
6 "strings"
7 "time"
8)
9
10// DefaultSDRBrightness is the BT.2408 SDR reference white in HDR, in nits.
11const DefaultSDRBrightness = 203
12
13// OutputConfig configures one connector. Name is the connector (e.g. "DP-2").
14// Mode is "WxH" (highest refresh) or "WxH@Hz" (closest refresh); empty picks the
15// monitor's preferred mode. Off disables the connector.
16// Every connected output that is not off is used.
17// Placement, by precedence: Pos (set at runtime by wlr-output-management),
18// then Anchor against another connected output, then automatic: right of
19// everything placed so far (never left of 0), at y=0, in config order, then in
20// connection order.
21// Scale is the output scale (0 means 1); layout works in logical pixels,
22// physical = logical × Scale. Placement and offsets use the transformed
23// logical size.
24// Primary gets the focus and the pointer at startup, wherever it is placed.
25// ScaleOnly marks an entry set only by output.<name> subkeys: it
26// does not select the connector.
27type OutputConfig struct {
28 Name string
29 Mode string
30 Off bool
31 Scale float64
32 // Transform is output.<name>.transform; logical size swaps for 90/270.
33 Transform BufferTransform
34 // Pos is an explicit logical placement set at runtime; nil uses Anchor, else automatic layout.
35 Pos *image.Point
36 // Anchor places the output against another connected one.
37 Anchor OutputAnchor // RelationNone: automatic
38 Primary bool
39 HDR bool // opt-in to HDR10 on capable outputs
40 SDRBrightness int // nits; default DefaultSDRBrightness
41 ScaleOnly bool
42}
43
44// OutputRelation is the side of another output where an output is placed.
45type OutputRelation uint8
46
47const (
48 RelationNone OutputRelation = iota
49 RelationRightOf
50 RelationLeftOf
51 RelationAbove
52 RelationBelow
53)
54
55// OutputAnchor places an output against another connected one, named by To.
56// Offset is in logical pixels, along the shared edge: y for right-of and
57// left-of (positive is down), x for above and below (positive is right).
58type OutputAnchor struct {
59 Relation OutputRelation
60 To string
61 Offset int
62}
63
64// LayoutRules are the layout settings shared by the defaults, screens and
65// named workspaces. Zero MaxColumns and an empty Overflow inherit.
66type LayoutRules struct {
67 // MaxColumns is how many columns share the screen at once.
68 MaxColumns int
69 // Overflow is "scroll" (horizontal scrolling), "fixed" (spiral splits),
70 // or "cascade" (vertically scrolling bands of columns).
71 Overflow string
72}
73
74// Over fills the unset rules of r from base.
75func (r LayoutRules) Over(base LayoutRules) LayoutRules {
76 if r.MaxColumns == 0 {
77 r.MaxColumns = base.MaxColumns
78 }
79 if r.Overflow == "" {
80 r.Overflow = base.Overflow
81 }
82 return r
83}
84
85// OutputLayout is the layout of one screen, matched by connector (DP-2) or
86// monitor key.
87type OutputLayout struct {
88 Output string
89 LayoutRules
90}
91
92// Config is the parsed compositor configuration (see the config adapter for keys).
93type Config struct {
94 Keyboard struct {
95 Layout, Variant, Options string
96 RepeatRate int
97 RepeatDelay int
98 CmdKey string
99 }
100 Terminal struct {
101 Command []string
102 AutoOpen string
103 }
104 // Xwayland is the xwayland-satellite binary serving X11 clients; empty
105 // disables X11.
106 Xwayland string
107 // Startup are commands run once when the session starts, in order.
108 // One startup line may hold several, split by SplitCommands.
109 Startup [][]string
110 Background struct{ Color string }
111 Floating struct{ Dim float64 }
112 // Stash is the strip of windows set aside by toggle-window-stash:
113 // Width is the width of its selected window (10 to 90) and Gap the
114 // space between it and its neighbors (0 to 10), in percent of the
115 // usable width; Dim darkens the neighbors, 0 to 1. Capture puts new
116 // windows in the stash while it is shown. SpawnTerminal makes
117 // toggle-stash-visible on an empty stash open the terminal in it.
118 Stash struct {
119 Width, Gap int
120 Dim float64
121 Capture bool
122 SpawnTerminal bool
123 }
124 // Border is drawn inside the window edge; Width 0 disables it.
125 Border struct {
126 Width int
127 Active string
128 Inactive string
129 }
130 Layout struct {
131 Gaps int
132 // LayoutRules are the defaults; Outputs override them per screen and
133 // named workspaces override them again.
134 LayoutRules
135 Outputs []OutputLayout
136 }
137 // InputDevicesConfig holds Touchpad and Mouse, promoted.
138 InputDevicesConfig
139 // Cursor.HideAfter hides the pointer cursor after this long without
140 // motion; the next motion shows it. 0 never hides it.
141 Cursor struct{ HideAfter time.Duration }
142 // Animations: On enables motion (off lands everything instantly);
143 // Slowdown scales every spring's duration, 0.1 to
144 // 10 (the config's animations.speed maps to it).
145 Animations struct {
146 On bool
147 Slowdown float64
148 }
149 Focus struct {
150 // FollowMove shows the target workspace after a column or window
151 // moves to it.
152 FollowMove bool
153 // Flash briefly draws an inner border on the entity an action changed
154 // (window, column, output). FlashWidth is in logical pixels (1 to 8),
155 // FlashOpacity the starting opacity (0.1 to 1), FlashDuration the fade
156 // (50ms to 1s, not scaled by Animations.Slowdown), FlashColor #rrggbb or
157 // empty for Border.Active.
158 Flash bool
159 FlashWidth int
160 FlashOpacity float64
161 FlashDuration time.Duration
162 FlashColor string
163 }
164 // Hint configures keyboard hint mode (action hint).
165 Hint struct {
166 // Enable turns the experimental hint mode on (hint.enable). It is
167 // read at startup: a reload keeps the startup value.
168 Enable bool
169 // LinksOnly limits the targets to links and URLs; false also
170 // includes buttons (hint.targets = clickable).
171 LinksOnly bool
172 // TextClick are the modifiers held for a click on a link found by
173 // OCR (hint.text-click); zero sends a plain click.
174 TextClick Mods
175 Size float64 // logical pixels; zero selects automatic density sizing
176 Background, Foreground string // empty derives from Border.Active
177 }
178 // Workspaces are declared with workspace.<name>.* keys, in first-seen order.
179 Workspaces []WorkspaceConfig
180 // Rules are the window rules (rule.<name>.* keys), in first-seen order.
181 Rules []WindowRule
182 // Outputs selects and configures physical displays (drm backend).
183 Outputs []OutputConfig
184 Binds map[string]string
185 Render struct {
186 DirectScanout bool
187 // Tearing honours wp_tearing_control_v1 in direct scanout; VRR
188 // turns variable refresh on while a buffer is scanned out.
189 Tearing, VRR bool
190 // VRRFlipGap is the minimum time between a game frame's flip and
191 // the next frame commit under VRR (0: off). It works around
192 // flips that land at the panel's slowest refresh.
193 VRRFlipGap time.Duration
194 }
195 Performance struct{ Realtime bool }
196 Log struct {
197 Level string
198 Debug []string
199 }
200}
201
202// PointerConfig holds the settings mice and touchpads share. NaturalScroll
203// moves the content with the fingers or the wheel instead of against them.
204// AccelSpeed (-1 to 1) and AccelProfile (AccelAdaptive or AccelFlat) set the
205// pointer speed. LeftHanded swaps the left and right buttons.
206type PointerConfig struct {
207 NaturalScroll bool
208 AccelSpeed float64
209 AccelProfile string
210 LeftHanded bool
211}
212
213// TouchpadConfig configures touchpads: the shared pointer settings
214// (NaturalScroll also applies to two-finger scroll and swipes), plus Tap,
215// which clicks on a tap (one finger left, two right, three middle), and
216// ScrollFactor, which multiplies two-finger scroll.
217type TouchpadConfig struct {
218 PointerConfig
219 Tap bool
220 ScrollFactor float64
221}
222
223// InputDevicesConfig is the live configuration of the input devices, sent to
224// the input adapter as one value. It is comparable.
225type InputDevicesConfig struct {
226 Touchpad TouchpadConfig
227 Mouse PointerConfig
228}
229
230// Pointer acceleration profiles, for mice and touchpads.
231const (
232 AccelAdaptive = "adaptive"
233 AccelFlat = "flat"
234)
235
236// WorkspaceConfig declares a bind-only named workspace, outside the numbered list.
237// Zero MaxColumns and an empty Overflow use the layout.* defaults.
238type WorkspaceConfig struct {
239 Name string
240 // Monitor is the home monitor: a connector name (DP-2) or a monitor key
241 // ("make model serial"); empty follows the focused output when shown.
242 Monitor string
243 // Size overrides the workspace's logical width and height. Zero inherits
244 // the monitor; its scale is always inherited.
245 Size [2]int
246 // Slots are the declared columns (workspace.<name>.column.N), by N.
247 Slots []SlotConfig
248 LayoutRules
249}
250
251// CommandSeparator separates commands in config values that run programs
252// (startup, spawn binds): "waybar; mako" starts both, without waiting.
253const CommandSeparator = ";"
254
255// SplitCommands splits v on CommandSeparator, then each command on
256// whitespace. Empty commands are skipped; no shell is involved.
257func SplitCommands(v string) [][]string {
258 var commands [][]string
259 for part := range strings.SplitSeq(v, CommandSeparator) {
260 if argv := strings.Fields(part); len(argv) > 0 {
261 commands = append(commands, argv)
262 }
263 }
264 return commands
265}
266
267// SlotConfig reserves column N of a workspace for the window of one command.
268// neferwl spawns the command at startup; the window it opens goes to the
269// slot. Cells is its width in cells, a cell being one max-columns-th of
270// the usable width (1 to 16; 0 shares the width with the other columns).
271type SlotConfig struct {
272 Index int
273 Cells int
274 Argv []string
275}
276
277// WindowRule places the windows whose app ID it matches when they first map.
278// Matching rules merge in config order, a later rule winning per field.
279type WindowRule struct {
280 Name string
281 // AppID matches the whole app ID (the config anchors it).
282 AppID *regexp.Regexp
283 // Floating forces a window to float (true) or to tile (false); nil leaves it.
284 Floating *bool
285 // Workspace is a 1-based number of a numbered workspace or the name of a
286 // declared one; empty leaves it.
287 Workspace string
288 // Monitor is a connector (DP-2) or a monitor key ("make model serial").
289 Monitor string
290 // Cells is the width in cells of the new column of a tiled window
291 // (1 to 16; 0 leaves it automatic).
292 Cells int
293}