Repository navigation
Expand file tree
/
Copy pathclient.lua
More file actions
1241 lines (1104 loc) · 36.9 KB
/
Copy pathclient.lua
File metadata and controls
1241 lines (1104 loc) · 36.9 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
---------------------------------------------------------------------------
--- Useful client manipulation functions.
--
-- @author Julien Danjou <julien@danjou.info>
-- @copyright 2008 Julien Danjou
-- @release @AWESOME_VERSION@
-- @module client
---------------------------------------------------------------------------
-- Grab environment we need
local util = require("awful.util")
local spawn = require("awful.spawn")
local object = require("gears.object")
local grect = require("gears.geometry").rectangle
local pairs = pairs
local type = type
local ipairs = ipairs
local table = table
local math = math
local setmetatable = setmetatable
local capi =
{
client = client,
mouse = mouse,
screen = screen,
awesome = awesome,
}
local function get_screen(s)
return s and capi.screen[s]
end
-- We use a metatable to prevent circular dependency loops.
local screen
do
screen = setmetatable({}, {
__index = function(_, k)
screen = require("awful.screen")
return screen[k]
end,
__newindex = error -- Just to be sure in case anything ever does this
})
end
local client = {object={}}
-- Private data
client.data = {}
client.data.marked = {}
client.data.properties = setmetatable({}, { __mode = 'k' })
client.data.persistent_properties_registered = {} -- keys are names of persistent properties, value always true
client.data.persistent_properties_loaded = setmetatable({}, { __mode = 'k' }) -- keys are clients, value always true
-- Functions
client.urgent = require("awful.client.urgent")
client.swap = {}
client.floating = {}
client.dockable = {}
client.property = {}
client.shape = require("awful.client.shape")
client.focus = require("awful.client.focus")
--- Jump to the given client.
-- Takes care of focussing the screen, the right tag, etc.
--
-- @deprecated awful.client.jumpto
-- @see client.jump_to
-- @client c the client to jump to
-- @tparam bool|function merge If true then merge tags (select the client's
-- first tag additionally) when the client is not visible.
-- If it is a function, it will be called with the client and its first
-- tag as arguments.
function client.jumpto(c, merge)
util.deprecate("Use c:jump_to(merge) instead of awful.client.jumpto")
client.object.jump_to(c, merge)
end
--- Jump to the given client.
-- Takes care of focussing the screen, the right tag, etc.
--
-- @function client.jump_to
-- @tparam bool|function merge If true then merge tags (select the client's
-- first tag additionally) when the client is not visible.
-- If it is a function, it will be called with the client and its first
-- tag as arguments.
function client.object.jump_to(self, merge)
local s = get_screen(screen.focused())
-- focus the screen
if s ~= get_screen(self.screen) then
screen.focus(self.screen)
end
self.minimized = false
-- Try to make client visible, this also covers e.g. sticky.
if not self:isvisible() then
local t = self.first_tag
if merge then
if type(merge) == "function" then
merge(self, t)
elseif t then
t.selected = true
end
elseif t then
t:view_only()
end
end
self:emit_signal("request::activate", "client.jumpto", {raise=true})
end
--- Get visible clients from a screen.
--
-- @deprecated awful.client.visible
-- @see screen.clients
-- @tparam[opt] integer|screen s The screen, or nil for all screens.
-- @tparam[opt=false] boolean stacked Use stacking order? (top to bottom)
-- @treturn table A table with all visible clients.
function client.visible(s, stacked)
local cls = capi.client.get(s, stacked)
local vcls = {}
for _, c in pairs(cls) do
if c:isvisible() then
table.insert(vcls, c)
end
end
return vcls
end
--- Get visible and tiled clients
--
-- @deprecated awful.client.tiled
-- @see screen.tiled_clients
-- @tparam integer|screen s The screen, or nil for all screens.
-- @tparam[opt=false] boolean stacked Use stacking order? (top to bottom)
-- @treturn table A table with all visible and tiled clients.
function client.tiled(s, stacked)
local clients = client.visible(s, stacked)
local tclients = {}
-- Remove floating clients
for _, c in pairs(clients) do
if not client.object.get_floating(c)
and not c.fullscreen
and not c.maximized_vertical
and not c.maximized_horizontal then
table.insert(tclients, c)
end
end
return tclients
end
--- Get a client by its relative index to another client.
-- If no client is passed, the focused client will be used.
--
-- @function awful.client.next
-- @tparam int i The index. Use 1 to get the next, -1 to get the previous.
-- @client[opt] sel The client.
-- @tparam[opt=false] boolean stacked Use stacking order? (top to bottom)
-- @return A client, or nil if no client is available.
--
-- @usage -- focus the next window in the index
-- awful.client.next(1)
-- -- focus the previous
-- awful.client.next(-1)
function client.next(i, sel, stacked)
-- Get currently focused client
sel = sel or capi.client.focus
if sel then
-- Get all visible clients
local cls = client.visible(sel.screen, stacked)
local fcls = {}
-- Remove all non-normal clients
for _, c in ipairs(cls) do
if client.focus.filter(c) or c == sel then
table.insert(fcls, c)
end
end
cls = fcls
-- Loop upon each client
for idx, c in ipairs(cls) do
if c == sel then
-- Cycle
return cls[util.cycle(#cls, idx + i)]
end
end
end
end
--- Swap a client with another client in the given direction.
-- @function awful.client.swap.bydirection
-- @tparam string dir The direction, can be either "up", "down", "left" or "right".
-- @client[opt=focused] c The client.
-- @tparam[opt=false] boolean stacked Use stacking order? (top to bottom)
function client.swap.bydirection(dir, c, stacked)
local sel = c or capi.client.focus
if sel then
local cltbl = client.visible(sel.screen, stacked)
local geomtbl = {}
for i,cl in ipairs(cltbl) do
geomtbl[i] = cl:geometry()
end
local target = grect.get_in_direction(dir, geomtbl, sel:geometry())
-- If we found a client to swap with, then go for it
if target then
cltbl[target]:swap(sel)
end
end
end
--- Swap a client with another client in the given direction. Swaps across screens.
-- @function awful.client.swap.global_bydirection
-- @param dir The direction, can be either "up", "down", "left" or "right".
-- @client[opt] sel The client.
function client.swap.global_bydirection(dir, sel)
sel = sel or capi.client.focus
local scr = get_screen(sel and sel.screen or screen.focused())
if sel then
-- move focus
client.focus.global_bydirection(dir, sel)
local c = capi.client.focus
-- swapping inside a screen
if get_screen(sel.screen) == get_screen(c.screen) and sel ~= c then
c:swap(sel)
-- swapping to an empty screen
elseif get_screen(sel.screen) ~= get_screen(c.screen) and sel == c then
sel:move_to_screen(screen.focused())
-- swapping to a nonempty screen
elseif get_screen(sel.screen) ~= get_screen(c.screen) and sel ~= c then
sel:move_to_screen(c.screen)
c:move_to_screen(scr)
end
screen.focus(sel.screen)
sel:emit_signal("request::activate", "client.swap.global_bydirection",
{raise=false})
end
end
--- Swap a client by its relative index.
-- @function awful.client.swap.byidx
-- @param i The index.
-- @client[opt] c The client, otherwise focused one is used.
function client.swap.byidx(i, c)
local sel = c or capi.client.focus
local target = client.next(i, sel)
if target then
target:swap(sel)
end
end
--- Cycle clients.
--
-- @function awful.client.cycle
-- @param clockwise True to cycle clients clockwise.
-- @param[opt] s The screen where to cycle clients.
-- @tparam[opt=false] boolean stacked Use stacking order? (top to bottom)
function client.cycle(clockwise, s, stacked)
s = s or screen.focused()
local cls = client.visible(s, stacked)
-- We can't rotate without at least 2 clients, buddy.
if #cls >= 2 then
local c = table.remove(cls, 1)
if clockwise then
for i = #cls, 1, -1 do
c:swap(cls[i])
end
else
for _, rc in pairs(cls) do
c:swap(rc)
end
end
end
end
--- Get the master window.
--
-- @legacylayout awful.client.getmaster
-- @param[opt] s The screen number, defaults to focused screen.
-- @return The master window.
function client.getmaster(s)
s = s or screen.focused()
return client.visible(s)[1]
end
--- Set the client as master: put it at the beginning of other windows.
--
-- @legacylayout awful.client.setmaster
-- @client c The window to set as master.
function client.setmaster(c)
local cls = util.table.reverse(capi.client.get(c.screen))
for _, v in pairs(cls) do
c:swap(v)
end
end
--- Set the client as slave: put it at the end of other windows.
-- @legacylayout awful.client.setslave
-- @client c The window to set as slave.
function client.setslave(c)
local cls = capi.client.get(c.screen)
for _, v in pairs(cls) do
c:swap(v)
end
end
--- Move/resize a client relative to current coordinates.
-- @deprecated awful.client.moveresize
-- @param x The relative x coordinate.
-- @param y The relative y coordinate.
-- @param w The relative width.
-- @param h The relative height.
-- @client[opt] c The client, otherwise focused one is used.
-- @see client.relative_move
function client.moveresize(x, y, w, h, c)
util.deprecate("Use c:relative_move(x, y, w, h) instead of awful.client.moveresize")
client.object.relative_move(c or capi.client.focus, x, y, w, h)
end
--- Move/resize a client relative to current coordinates.
-- @function client.relative_move
-- @see geometry
-- @tparam[opt=c.x] number x The relative x coordinate.
-- @tparam[opt=c.y] number y The relative y coordinate.
-- @tparam[opt=c.width] number w The relative width.
-- @tparam[opt=c.height] number h The relative height.
function client.object.relative_move(self, x, y, w, h)
local geometry = self:geometry()
geometry['x'] = geometry['x'] + x
geometry['y'] = geometry['y'] + y
geometry['width'] = geometry['width'] + w
geometry['height'] = geometry['height'] + h
self:geometry(geometry)
end
--- Move a client to a tag.
-- @deprecated awful.client.movetotag
-- @param target The tag to move the client to.
-- @client[opt] c The client to move, otherwise the focused one is used.
-- @see client.move_to_tag
function client.movetotag(target, c)
util.deprecate("Use c:move_to_tag(target) instead of awful.client.movetotag")
client.object.move_to_tag(c or capi.client.focus, target)
end
--- Move a client to a tag.
-- @function client.move_to_tag
-- @tparam tag target The tag to move the client to.
function client.object.move_to_tag(self, target)
local s = target.screen
if self and s then
if self == capi.client.focus then
self:emit_signal("request::activate", "client.movetotag", {raise=true})
end
-- Set client on the same screen as the tag.
self.screen = s
self:tags({ target })
end
end
--- Toggle a tag on a client.
-- @deprecated awful.client.toggletag
-- @param target The tag to toggle.
-- @client[opt] c The client to toggle, otherwise the focused one is used.
-- @see client.toggle_tag
function client.toggletag(target, c)
util.deprecate("Use c:toggle_tag(target) instead of awful.client.toggletag")
client.object.toggle_tag(c or capi.client.focus, target)
end
--- Toggle a tag on a client.
-- @function client.toggle_tag
-- @tparam tag target The tag to move the client to.
function client.object.toggle_tag(self, target)
-- Check that tag and client screen are identical
if self and get_screen(self.screen) == get_screen(target.screen) then
local tags = self:tags()
local index = nil;
for i, v in ipairs(tags) do
if v == target then
index = i
break
end
end
if index then
-- If it's the only tag for the window, stop.
if #tags == 1 then return end
tags[index] = nil
else
tags[#tags + 1] = target
end
self:tags(tags)
end
end
--- Move a client to a screen. Default is next screen, cycling.
-- @deprecated awful.client.movetoscreen
-- @client c The client to move.
-- @param s The screen, default to current + 1.
-- @see screen
-- @see client.move_to_screen
function client.movetoscreen(c, s)
util.deprecate("Use c:move_to_screen(s) instead of awful.client.movetoscreen")
client.object.move_to_screen(c or capi.client.focus, s)
end
--- Move a client to a screen. Default is next screen, cycling.
-- @function client.move_to_screen
-- @tparam[opt=c.screen.index+1] screen s The screen, default to current + 1.
-- @see screen
-- @see request::activate
function client.object.move_to_screen(self, s)
if self then
local sc = capi.screen.count()
if not s then
s = self.screen.index + 1
end
if type(s) == "number" then
if s > sc then s = 1 elseif s < 1 then s = sc end
end
s = get_screen(s)
if get_screen(self.screen) ~= s then
local sel_is_focused = self == capi.client.focus
self.screen = s
screen.focus(s)
if sel_is_focused then
self:emit_signal("request::activate", "client.movetoscreen",
{raise=true})
end
end
end
end
--- Tag a client with the set of current tags.
-- @function client.to_selected_tags
-- @see screen.selected_tags
function client.object.to_selected_tags(self)
local tags = {}
for _, t in ipairs(self:tags()) do
if get_screen(t.screen) == get_screen(self.screen) then
table.insert(tags, t)
end
end
if self.screen then
if #tags == 0 then
tags = self.screen.selected_tags
end
if #tags == 0 then
tags = self.screen.tags
end
end
if #tags ~= 0 then
self:tags(tags)
end
end
--- If a client is marked or not.
--
-- **Signal:**
--
-- * *marked* (for legacy reasons, use `property::marked`)
-- * *unmarked* (for legacy reasons, use `property::marked`)
-- * *property::marked*
--
-- @property marked
-- @param boolean
--- The border color when the client is focused.
--
-- @beautiful beautiful.border_marked
-- @param string
--
function client.object.set_marked(self, value)
local is_marked = self.marked
if value == false and is_marked then
for k, v in pairs(client.data.marked) do
if self == v then
table.remove(client.data.marked, k)
end
end
self:emit_signal("unmarked")
elseif not is_marked and value then
self:emit_signal("marked")
table.insert(client.data.marked, self)
end
client.property.set(self, "marked", value)
end
function client.object.get_marked(self)
return client.property.get(self, "marked")
end
--- Mark a client, and then call 'marked' hook.
-- @deprecated awful.client.mark
-- @client c The client to mark, the focused one if not specified.
function client.mark(c)
util.deprecate("Use c.marked = true instead of awful.client.mark")
client.object.set_marked(c or capi.client.focus, true)
end
--- Unmark a client and then call 'unmarked' hook.
-- @deprecated awful.client.unmark
-- @client c The client to unmark, or the focused one if not specified.
function client.unmark(c)
util.deprecate("Use c.marked = false instead of awful.client.unmark")
client.object.set_marked(c or capi.client.focus, false)
end
--- Check if a client is marked.
-- @deprecated awful.client.ismarked
-- @client c The client to check, or the focused one otherwise.
function client.ismarked(c)
util.deprecate("Use c.marked instead of awful.client.ismarked")
return client.object.get_marked(c or capi.client.focus)
end
--- Toggle a client as marked.
-- @deprecated awful.client.togglemarked
-- @client c The client to toggle mark.
function client.togglemarked(c)
util.deprecate("Use c.marked = not c.marked instead of awful.client.togglemarked")
c = c or capi.client.focus
if c then
c.marked = not c.marked
end
end
--- Return the marked clients and empty the marked table.
-- @function awful.client.getmarked
-- @return A table with all marked clients.
function client.getmarked()
local copy = util.table.clone(client.data.marked, false)
for _, v in pairs(copy) do
client.property.set(v, "marked", false)
v:emit_signal("unmarked")
end
client.data.marked = {}
return copy
end
--- Set a client floating state, overriding auto-detection.
-- Floating client are not handled by tiling layouts.
-- @deprecated awful.client.floating.set
-- @client c A client.
-- @param s True or false.
function client.floating.set(c, s)
util.deprecate("Use c.floating = true instead of awful.client.floating.set")
client.object.set_floating(c, s)
end
-- Set a client floating state, overriding auto-detection.
-- Floating client are not handled by tiling layouts.
-- @client c A client.
-- @param s True or false.
function client.object.set_floating(c, s)
c = c or capi.client.focus
if c and client.property.get(c, "floating") ~= s then
client.property.set(c, "floating", s)
local scr = c.screen
if s == true then
c:geometry(client.property.get(c, "floating_geometry"))
end
c.screen = scr
end
end
local function store_floating_geometry(c)
if client.object.get_floating(c) then
client.property.set(c, "floating_geometry", c:geometry())
end
end
-- Store the initial client geometry.
capi.client.connect_signal("new", function(cl)
local function store_init_geometry(c)
client.property.set(c, "floating_geometry", c:geometry())
c:disconnect_signal("property::border_width", store_init_geometry)
end
cl:connect_signal("property::border_width", store_init_geometry)
end)
capi.client.connect_signal("property::geometry", store_floating_geometry)
--- Return if a client has a fixed size or not.
-- This function is deprecated, use `c.is_fixed`
-- @client c The client.
-- @deprecated awful.client.isfixed
-- @see is_fixed
-- @see size_hints_honor
function client.isfixed(c)
util.deprecate("Use c.is_fixed instead of awful.client.isfixed")
c = c or capi.client.focus
return client.object.is_fixed(c)
end
--- Return if a client has a fixed size or not.
--
-- **Signal:**
--
-- * *property::is_fixed*
--
-- This property is read only.
-- @property is_fixed
-- @param boolean The floating state
-- @see size_hints
-- @see size_hints_honor
function client.object.is_fixed(c)
if not c then return end
local h = c.size_hints
if h.min_width and h.max_width
and h.max_height and h.min_height
and h.min_width > 0 and h.max_width > 0
and h.max_height > 0 and h.min_height > 0
and h.min_width == h.max_width
and h.min_height == h.max_height then
return true
end
return false
end
--- Get a client floating state.
-- @client c A client.
-- @see floating
-- @deprecated awful.client.floating.get
-- @return True or false. Note that some windows might be floating even if you
-- did not set them manually. For example, windows with a type different than
-- normal.
function client.floating.get(c)
util.deprecate("Use c.floating instead of awful.client.floating.get")
return client.object.get_floating(c)
end
--- The client floating state.
-- If the client is part of the tiled layout or free floating.
--
-- Note that some windows might be floating even if you
-- did not set them manually. For example, windows with a type different than
-- normal.
--
-- **Signal:**
--
-- * *property::floating*
--
-- @property floating
-- @param boolean The floating state
function client.object.get_floating(c)
c = c or capi.client.focus
if c then
local value = client.property.get(c, "floating")
if value ~= nil then
return value
end
if c.type ~= "normal"
or c.fullscreen
or c.maximized_vertical
or c.maximized_horizontal
or client.object.is_fixed(c) then
return true
end
return false
end
end
--- Toggle the floating state of a client between 'auto' and 'true'.
-- Use `c.floating = not c.floating`
-- @deprecated awful.client.floating.toggle
-- @client c A client.
-- @see floating
function client.floating.toggle(c)
c = c or capi.client.focus
-- If it has been set to floating
client.object.set_floating(c, not client.object.get_floating(c))
end
-- Remove the floating information on a client.
-- @client c The client.
function client.floating.delete(c)
client.object.set_floating(c, nil)
end
--- The x coordinates.
--
-- **Signal:**
--
-- * *property::x*
--
-- @property x
-- @param integer
--- The y coordinates.
--
-- **Signal:**
--
-- * *property::y*
--
-- @property y
-- @param integer
--- The width of the wibox.
--
-- **Signal:**
--
-- * *property::width*
--
-- @property width
-- @param width
--- The height of the wibox.
--
-- **Signal:**
--
-- * *property::height*
--
-- @property height
-- @param height
-- Add the geometry helpers to match the wibox API
for _, v in ipairs {"x", "y", "width", "height"} do
client.object["get_"..v] = function(c)
return c:geometry()[v]
end
client.object["set_"..v] = function(c, value)
return c:geometry({[v] = value})
end
end
--- Restore (=unminimize) a random client.
-- @function awful.client.restore
-- @param s The screen to use.
-- @return The restored client if some client was restored, otherwise nil.
function client.restore(s)
s = s or screen.focused()
local cls = capi.client.get(s)
local tags = s.selected_tags
for _, c in pairs(cls) do
local ctags = c:tags()
if c.minimized then
for _, t in ipairs(tags) do
if util.table.hasitem(ctags, t) then
c.minimized = false
return c
end
end
end
end
return nil
end
--- Normalize a set of numbers to 1
-- @param set the set of numbers to normalize
-- @param num the number of numbers to normalize
local function normalize(set, num)
num = num or #set
local total = 0
if num then
for i = 1,num do
total = total + set[i]
end
for i = 1,num do
set[i] = set[i] / total
end
else
for _,v in ipairs(set) do
total = total + v
end
for i,v in ipairs(set) do
set[i] = v / total
end
end
end
--- Calculate a client's column number, index in that column, and
-- number of visible clients in this column.
--
-- @legacylayout awful.client.idx
-- @client c the client
-- @return col the column number
-- @return idx index of the client in the column
-- @return num the number of visible clients in the column
function client.idx(c)
c = c or capi.client.focus
if not c then return end
-- Only check the tiled clients, the others un irrelevant
local clients = client.tiled(c.screen)
local idx = nil
for k, cl in ipairs(clients) do
if cl == c then
idx = k
break
end
end
local t = c.screen.selected_tag
local nmaster = t.master_count
-- This will happen for floating or maximized clients
if not idx then return nil end
if idx <= nmaster then
return {idx = idx, col=0, num=nmaster}
end
local nother = #clients - nmaster
idx = idx - nmaster
-- rather than regenerate the column number we can calculate it
-- based on the how the tiling algorithm places clients we calculate
-- the column, we could easily use the for loop in the program but we can
-- calculate it.
local ncol = t.column_count
-- minimum number of clients per column
local percol = math.floor(nother / ncol)
-- number of columns with an extra client
local overcol = math.fmod(nother, ncol)
-- number of columns filled with [percol] clients
local regcol = ncol - overcol
local col = math.floor( (idx - 1) / percol) + 1
if col > regcol then
-- col = math.floor( (idx - (percol*regcol) - 1) / (percol + 1) ) + regcol + 1
-- simplified
col = math.floor( (idx + regcol + percol) / (percol+1) )
-- calculate the index in the column
idx = idx - percol*regcol - (col - regcol - 1) * (percol+1)
percol = percol+1
else
idx = idx - percol*(col-1)
end
return {idx = idx, col=col, num=percol}
end
--- Set the window factor of a client
--
-- @legacylayout awful.client.setwfact
-- @param wfact the window factor value
-- @client c the client
function client.setwfact(wfact, c)
-- get the currently selected window
c = c or capi.client.focus
if not c or not c:isvisible() then return end
local w = client.idx(c)
if not w then return end
local t = c.screen.selected_tag
-- n is the number of windows currently visible for which we have to be concerned with the properties
local data = t.windowfact or {}
local colfact = data[w.col]
local need_normalize = colfact ~= nil
if not need_normalize then
colfact = {}
end
colfact[w.idx] = wfact
if not need_normalize then
t:emit_signal("property::windowfact")
return
end
local rest = 1-wfact
-- calculate the current denominator
local total = 0
for i = 1,w.num do
if i ~= w.idx then
total = total + colfact[i]
end
end
-- normalize the windows
for i = 1,w.num do
if i ~= w.idx then
colfact[i] = (colfact[i] * rest) / total
end
end
t:emit_signal("property::windowfact")
end
--- Increment a client's window factor
--
-- @legacylayout awful.client.incwfact
-- @param add amount to increase the client's window
-- @client c the client
function client.incwfact(add, c)
c = c or capi.client.focus
if not c then return end
local t = c.screen.selected_tag
local w = client.idx(c)
local data = t.windowfact or {}
local colfact = data[w.col] or {}
local curr = colfact[w.idx] or 1
colfact[w.idx] = curr + add
-- keep our ratios normalized
normalize(colfact, w.num)
t:emit_signal("property::windowfact")
end
--- Get a client dockable state.
--
-- @client c A client.
-- @return True or false. Note that some windows might be dockable even if you
-- did not set them manually. For example, windows with a type "utility",
-- "toolbar" or "dock"
-- @deprecated awful.client.dockable.get
function client.dockable.get(c)
util.deprecate("Use c.dockable instead of awful.client.dockable.get")
return client.object.get_dockable(c)
end
--- If the client is dockable.
-- A dockable client is an application confined to the edge of the screen. The
-- space it occupy is substracted from the `screen.workarea`.
--
-- **Signal:**
--
-- * *property::dockable*
--
-- @property dockable
-- @param boolean The dockable state
function client.object.get_dockable(c)
local value = client.property.get(c, "dockable")
-- Some sane defaults
if value == nil then
if (c.type == "utility" or c.type == "toolbar" or c.type == "dock") then
value = true
else
value = false
end
end
return value
end
--- Set a client dockable state, overriding auto-detection.
-- With this enabled you can dock windows by moving them from the center
-- to the edge of the workarea.
--
-- @client c A client.
-- @param value True or false.
-- @deprecated awful.client.dockable.set
function client.dockable.set(c, value)
util.deprecate("Use c.dockable = value instead of awful.client.dockable.set")
client.property.set(c, "dockable", value)
end
--- Get a client property.
--
-- This method is deprecated. It is now possible to use `c.value` directly.
--
-- @client c The client.
-- @param prop The property name.
-- @return The property.
-- @deprecated awful.client.property.get
function client.property.get(c, prop)
if not client.data.persistent_properties_loaded[c] then
client.data.persistent_properties_loaded[c] = true
for p in pairs(client.data.persistent_properties_registered) do
local value = c:get_xproperty("awful.client.property." .. p)
if value ~= nil then
client.property.set(c, p, value)
end
end
end
if client.data.properties[c] then
return client.data.properties[c][prop]
end