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// Focus indicator: the animation (Config.Focus.Animation) shapes in time
93// the visual effect (Config.Focus.Effect) drawn on a newly focused window.
94const (
95 FocusAnimationOff = "off"
96 FocusAnimationPulse = "pulse"
97 FocusEffectScreen = "screen"
98)
99
100// Config is the parsed compositor configuration (see the config adapter for keys).
101type Config struct {
102 Keyboard struct {
103 Layout, Variant, Options string
104 RepeatRate int
105 RepeatDelay int
106 CmdKey string
107 }
108 Terminal struct {
109 Command []string
110 AutoOpen string
111 }
112 // Xwayland is the xwayland-satellite binary serving X11 clients; empty
113 // disables X11.
114 Xwayland string
115 // Startup are commands run once when the session starts, in order.
116 // One startup line may hold several, split by SplitCommands.
117 Startup [][]string
118 Background struct{ Color string }
119 Floating struct{ Dim float64 }
120 // Stash is the strip of windows set aside by toggle-window-stash:
121 // Width is the width of its selected window (10 to 90) and Gap the
122 // space between it and its neighbors (0 to 10), in percent of the
123 // usable width; Dim darkens the neighbors, 0 to 1. Capture puts new
124 // windows in the stash while it is shown.
125 Stash struct {
126 Width, Gap int
127 Dim float64
128 Capture bool
129 }
130 // Border is drawn inside the window edge; Width 0 disables it.
131 Border struct {
132 Width int
133 Active string
134 Inactive string
135 }
136 Layout struct {
137 Gaps int
138 Presets []string
139 // LayoutRules are the defaults; Outputs override them per screen and
140 // named workspaces override them again.
141 LayoutRules
142 Outputs []OutputLayout
143 }
144 // InputDevicesConfig holds Touchpad and Mouse, promoted.
145 InputDevicesConfig
146 // Cursor.HideAfter hides the pointer cursor after this long without
147 // motion; the next motion shows it. 0 never hides it.
148 Cursor struct{ HideAfter time.Duration }
149 // Animations: On enables motion (off lands everything instantly);
150 // Slowdown scales every spring's duration (not the focus pulse), 0.1 to
151 // 10 (the config's animations.speed maps to it).
152 Animations struct {
153 On bool
154 Slowdown float64
155 }
156 Focus struct {
157 // FollowMove shows the target workspace after a column or window
158 // moves to it.
159 FollowMove bool
160 // Animation and Effect mark a window that just got the focus:
161 // FocusAnimation* (off disables it) and FocusEffect*. Strength is
162 // the effect's peak, 0.01 to 0.2.
163 Animation, Effect string
164 Strength float64
165 }
166 // Workspaces are declared with workspace.<name>.* keys, in first-seen order.
167 Workspaces []WorkspaceConfig
168 // Rules are the window rules (rule.<name>.* keys), in first-seen order.
169 Rules []WindowRule
170 // Outputs selects and configures physical displays (drm backend).
171 Outputs []OutputConfig
172 Binds map[string]string
173 Render struct {
174 DirectScanout bool
175 // Tearing honours wp_tearing_control_v1 in direct scanout; VRR
176 // turns variable refresh on while a buffer is scanned out.
177 Tearing, VRR bool
178 // VRRFlipGap is the minimum time between a game frame's flip and
179 // the next frame commit under VRR (0: off). It works around
180 // flips that land at the panel's slowest refresh.
181 VRRFlipGap time.Duration
182 }
183 Performance struct{ Realtime bool }
184 Log struct {
185 Level string
186 Debug []string
187 }
188}
189
190// PointerConfig holds the settings mice and touchpads share. NaturalScroll
191// moves the content with the fingers or the wheel instead of against them.
192// AccelSpeed (-1 to 1) and AccelProfile (AccelAdaptive or AccelFlat) set the
193// pointer speed. LeftHanded swaps the left and right buttons.
194type PointerConfig struct {
195 NaturalScroll bool
196 AccelSpeed float64
197 AccelProfile string
198 LeftHanded bool
199}
200
201// TouchpadConfig configures touchpads: the shared pointer settings
202// (NaturalScroll also applies to two-finger scroll and swipes), plus Tap,
203// which clicks on a tap (one finger left, two right, three middle), and
204// ScrollFactor, which multiplies two-finger scroll.
205type TouchpadConfig struct {
206 PointerConfig
207 Tap bool
208 ScrollFactor float64
209}
210
211// InputDevicesConfig is the live configuration of the input devices, sent to
212// the input adapter as one value. It is comparable.
213type InputDevicesConfig struct {
214 Touchpad TouchpadConfig
215 Mouse PointerConfig
216}
217
218// Pointer acceleration profiles, for mice and touchpads.
219const (
220 AccelAdaptive = "adaptive"
221 AccelFlat = "flat"
222)
223
224// WorkspaceConfig declares a bind-only named workspace, outside the numbered list.
225// Zero MaxColumns and an empty Overflow use the layout.* defaults.
226type WorkspaceConfig struct {
227 Name string
228 // Monitor is the home monitor: a connector name (DP-2) or a monitor key
229 // ("make model serial"); empty follows the focused output when shown.
230 Monitor string
231 // Size overrides the workspace's logical width and height. Zero inherits
232 // the monitor; its scale is always inherited.
233 Size [2]int
234 // Slots are the declared columns (workspace.<name>.column.N), by N.
235 Slots []SlotConfig
236 LayoutRules
237}
238
239// CommandSeparator separates commands in config values that run programs
240// (startup, spawn binds): "waybar; mako" starts both, without waiting.
241const CommandSeparator = ";"
242
243// SplitCommands splits v on CommandSeparator, then each command on
244// whitespace. Empty commands are skipped; no shell is involved.
245func SplitCommands(v string) [][]string {
246 var commands [][]string
247 for part := range strings.SplitSeq(v, CommandSeparator) {
248 if argv := strings.Fields(part); len(argv) > 0 {
249 commands = append(commands, argv)
250 }
251 }
252 return commands
253}
254
255// SlotConfig reserves column N of a workspace for the window of one command.
256// neferwl spawns the command at startup; the window it opens goes to the
257// slot. Width is a layout width (fraction, percentage or pixels).
258type SlotConfig struct {
259 Index int
260 Width string
261 Argv []string
262}
263
264// WindowRule places the windows whose app ID it matches when they first map.
265// Matching rules merge in config order, a later rule winning per field.
266type WindowRule struct {
267 Name string
268 // AppID matches the whole app ID (the config anchors it).
269 AppID *regexp.Regexp
270 // Floating forces a window to float (true) or to tile (false); nil leaves it.
271 Floating *bool
272 // Workspace is a 1-based number of a numbered workspace or the name of a
273 // declared one; empty leaves it.
274 Workspace string
275 // Monitor is a connector (DP-2) or a monitor key ("make model serial").
276 Monitor string
277 // Width is the layout width of the new column of a tiled window.
278 Width string
279}