/* * client.c - client management * * Copyright © 2007-2009 Julien Danjou * * This program is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation; either version 2 of the License, or * (at your option) any later version. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License along * with this program; if not, write to the Free Software Foundation, Inc., * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. * */ /** A process window. * * Clients are the name used by Awesome (and X11) to refer to a window. * * A program can have multiple clients (e.g. for dialogs) or none at all (e.g. * command line applications). * Clients are usually grouped by classes. * A class is the name used by X11 to help the window manager distinguish * between windows and write rules for them. A client's behavior is also * defined by its `type` and `size_hints` properties. * See the `xprop` command line application to query properties for a client. * * ![Client geometry](../images/client_geo.svg) * * The client's `:geometry()` function returns a table with *x*, *y*, *width* * and *height*. The area returned **excludes the border width**. * All clients also have a `shape_bounding` and `shape_clip` used to "crop" the * client's content. * Finally, each clients can have titlebars (see `awful.titlebar`). * * Additionally to the classes described here, one can also use signals as * described in @{signals} and X properties as described in @{xproperties}. * * Some signal names are starting with a dot. These dots are artefacts from * the documentation generation, you get the real signal name by * removing the starting dot. * * Accessing client objects can be done in multiple ways depending on the * context. * To get the currently focused client: * * local c = client.focus * if c then * -- do something * end * * To get a list of all clients, use `client:get`: * * for _, c in ipairs(client.get()) do * -- do something * end * * To execute a callback when a new client is added, use the `manage` signal: * * client.connect_signal("request::manage", function(c) * -- do something * end) * * To be notified when a property of a client changed: * * client.connect_signal("property::name", function(c) * -- do something * end) * * To be notified when a property of a specific client `c` changed: * * c:connect_signal("property::name", function() * -- do something * end) * * To get all the clients for a screen use either `screen.clients` or * `screen.tiled_clients`. * * @DOC_uml_nav_tables_client_EXAMPLE@ * * @author Julien Danjou <julien@danjou.info> * @copyright 2008-2009 Julien Danjou * @coreclassmod client */ #include "objects/client.h" #include "common/atoms.h" #include "common/xutil.h" #include "event.h" #include "ewmh.h" #include "objects/drawable.h" #include "objects/screen.h" #include "objects/tag.h" #include "property.h" #include "spawn.h" #include "systray.h" #include "xwindow.h" #include "math.h" #include #include #include lua_class_t client_class; /** Client class. * * This table allow to add more dynamic properties to the clients. For example, * doing: * * function awful.client.object.set_my_cool_property(c, value) * -- Some logic code * c._my_secret_my_cool_property = value * c:emit_signal("property::my_cool_property) * end * * function awful.client.object.get_my_cool_property() * return c._my_secret_my_cool_property * end * * Will add a new "my_cool_property" dyanmic property to all client. These * methods will be called when an user does `c.my_cool_property = "something"` * or set them in `awdul.rules`. * * Note that doing this isn't required to set random properties to the client, * it is only useful when setting or getting these properties require code to * executed. * * @table awful.client.object */ /** Emitted when AwesomeWM is about to scan for existing clients. * * Connect to this signal when code needs to be executed after screens are * initialized, but before clients are added. * * @signal scanning * @classsignal */ /** Emitted when AwesomeWM is done scanning for clients. * * This is emitted before the `startup` signal and after the `scanning` signal. * * @signal scanned * @classsignal */ /** Emitted when a client gains focus. * @signal focus * @classsignal */ /** Emitted before `request::manage`, after `request::unmanage`, * and when clients swap. * @signal list * @classsignal */ /** Emitted when 2 clients are swapped * @tparam client client The other client * @tparam boolean is_source If self is the source or the destination of the swap * @signal swapped */ /** Emitted when a new client appears and gets managed by Awesome. * * This request should be implemented by code which track the client. It isn't * recommended to use this to initialize the client content. This use case is * a better fit for `ruled.client`, which has built-in dependency management. * Using this request to mutate the client state will likely conflict with * `ruled.client`. * * @signal request::manage * @tparam client c The client. * @tparam string context What created the client. It is currently either "new" * or "startup". * @tparam table hints More metadata (currently empty, it exists for compliance * with the other `request::` signals). * @request client border added granted When a new client needs a its initial * border settings. * @classsignal */ /** Emitted when a client is going away. * * Each places which store `client` objects in non-weak table or whose state * depend on the current client should answer this request. * * The contexts are: * * * **user**: `c:unmanage()` was called. * * **reparented**: The window was reparented to another window. It is no * longer a stand alone client. * * **destroyed**: The window was closed. * * @signal request::unmanage * @tparam client c The client. * @tparam string context Why was the client unmanaged. * @tparam table hints More metadata (currently empty, it exists for compliance * with the other `request::` signals). * @classsignal */ /** Use `request::manage`. * @deprecatedsignal manage */ /** Use `request::unmanage`. * @deprecatedsignal unmanage */ /** Emitted when a mouse button is pressed in a client. * @signal button::press */ /** Emitted when a mouse button is released in a client. * * @signal button::release */ /** Emitted when the mouse enters a client. * * @signal mouse::enter */ /** Emitted when the mouse leaves a client. * * @signal mouse::leave */ /** * Emitted when the mouse moves within a client. * * @signal mouse::move */ /** Emitted when a client should get activated (focused and/or raised). * * **Contexts are:** * * * *ewmh*: When a client asks for focus (from `X11` events). * * *autofocus.check_focus*: When autofocus is enabled (from * `awful.autofocus`). * * *autofocus.check_focus_tag*: When autofocus is enabled * (from `awful.autofocus`). * * *client.jumpto*: When a custom lua extension asks a client to be focused * (from `client.jump_to`). * * *client.swap.global_bydirection*: When client swapping requires a focus * change (from `awful.client.swap.bydirection`). * * *client.movetotag*: When a client is moved to a new tag * (from `client.move_to_tag`). * * *client.movetoscreen*: When the client is moved to a new screen * (from `client.move_to_screen`). * * *client.focus.byidx*: When selecting a client using its index * (from `awful.client.focus.byidx`). * * *client.focus.history.previous*: When cycling through history * (from `awful.client.focus.history.previous`). * * *menu.clients*: When using the builtin client menu * (from `awful.menu.clients`). * * *rules*: When a new client is focused from a rule (from `ruled.client`). * * *screen.focus*: When a screen is focused (from `awful.screen.focus`). * * Default implementation: `awful.ewmh.activate`. * * To implement focus stealing filters see `awful.ewmh.add_activate_filter`. * * @signal request::activate * @tparam string context The context where this signal was used. * @tparam[opt] table hints A table with additional hints: * @tparam[opt=false] boolean hints.raise should the client be raised? * @request client activate ewmh granted When the client asks to be activated. * @classsignal */ /** Emitted when an event could lead to the client being activated. * * This is an layer "on top" of `request::activate` for event which are not * actual request for activation/focus, but where "it would be nice" if the * client got the focus. This includes the focus-follow-mouse model and focusing * previous clients when the selected tag changes. * * This idea is that `request::autoactivate` will emit `request::activate`. * However it is much easier to replace the handler for `request::autoactivate` * than it is to replace the handler for `request::activate`. Thus it provides * a nice abstraction to simplify handling the focus when switching tags or * moving the mouse. * * @signal request::autoactivate * @tparam string context The context where this signal was used. * @tparam[opt] table hints A table with additional hints: * @tparam[opt=false] boolean hints.raise should the client be raised? * @classsignal * */ /** Emitted when something request a client's geometry to be modified. * * @signal request::geometry * @tparam client c The client * @tparam string context Why and what to resize. This is used for the * handlers to know if they are capable of applying the new geometry. * @tparam[opt={}] table Additional arguments. Each context handler may * interpret this differently. * @request client geometry client_maximize_horizontal granted When a client * (programmatically) asks for the maximization to be changed. * @request client geometry client_maximize_vertical granted When a client * (programmatically) asks for the maximization to be changed. * @classsignal */ /** Emitted when a client requests to be moved to a tag or needs a new tag. * * @signal request::tag * @tparam client c The client requesting a new tag. * @classsignal */ /** Emitted when any client's `urgent` property changes. * * Emitted both when `urgent = true` and `urgent = false`, so you will likely * want to check `c.urgent` within the signal callback. * * client.connect_signal("property::urgent", function(c) * if c.urgent then * naughty.notify { * title = "Urgent client", * message = c.name, * } * end * end) * * @signal request::urgent * @tparam client c The client whose property changed. * @classsignal */ /** Emitted once to request default client mousebindings during the initial * startup sequence. * * This signal gives all modules a chance to register their default client * mousebindings. * They will then be added to all new clients, unless rules overwrite them via * the `buttons` property. * * @signal request::default_mousebindings * @tparam string context The reason why the signal was sent (currently always * `startup`). * @classsignal */ /** Emitted once to request default client keybindings during the initial * startup sequence. * * This signal gives all modules a chance to register their default client * keybindings. * They will then be added to all new clients, unless rules overwrite them via * the `keys` property. * * @signal request::default_keybindings * @tparam string context The reason why the signal was sent (currently always * @classsignal * @request client default_keybindings startup granted Sent when AwesomeWM starts. */ /** Emitted when a client gets tagged. * @signal tagged * @tparam tag t The tag object. */ /** Emitted when a client gets unfocused. * @signal unfocus */ /** Emitted when a client gets untagged. * @signal untagged * @tparam tag t The tag object. */ /** * Emitted when the client is raised within its layer. * * @signal raised * @see below * @see above * @see ontop * @see raise * @see lower * @see lowered */ /** Emitted when the client is lowered within its layer. * * @signal lowered * @see below * @see above * @see ontop * @see raise * @see lower * @see raised */ /** * The focused `client` or nil (in case there is none). * * It is not recommended to set the focused client using * this property. Please use @{client.activate} instead of * `client.focus = c`. Setting the focus directly bypasses * all the filters and emits fewer signals, which tend to * cause unwanted side effects and make it harder to alter * the code behavior in the future. It usually takes *more* * code to use this rather than @{client.activate} because all * the boilerplate code (such as `c:raise()`) needs to be * added everywhere. * * The main use case for this field is to check *when* there * is an active client. * * if client.focus ~= nil then * -- do something * end * * If you want to check if a client is active, use: * * if c.active then * -- do something * end * * @tfield client focus * @see active * @see activate * @see request::activate */ /** * The X window id. * * This is rarely useful, but some DBus protocols will * have this ID in their API, so it can be useful when * writing AwesomeWM bindings for them. * * @property window * @tparam integer window * @propemits false false * @readonly */ /** * The client title. * * This is the text which will be shown in `awful.widget.tasklist` * and `awful.titlebar.widget.titlewidget`. * * @property name * @tparam string name * @propemits false false * @see awful.titlebar * @see awful.widget.tasklist */ /** * True if the client does not want to be in taskbar. * * Some clients, like docked bars or some `sticky` clients * such as wallpaper sensors like Conky have no value in * the `awful.widget.tasklist` and should not be shown there. * * The default value of this property reflects the value of the * `_NET_WM_STATE_SKIP_TASKBAR` X11 protocol xproperty. Clients can modify this * state through this property. * * @DOC_awful_client_skip_tasklist1_EXAMPLE@ * * @property skip_taskbar * @tparam[opt=false] boolean skip_taskbar * @propemits false false * @see sticky * @see hidden * @see unmanage */ /** * The window type. * * This is useful in, among other places, the `ruled.client` rules to apply * different properties depending on the client types. It is also used * throughout the API to alter the client (and `wibox`) behavior depending on * the `type`. For example, clients with the `dock` type are placed on the side * of the screen while other like `combo` are totally ignored and never * considered `client`s in the first place. * * Valid types are: * * * * * * * * * * * * * * * * * * * *
NameDescription
desktopThe root client, it cannot be moved or resized.
dockA client attached to the side of the screen.
splashA client, usually without titlebar shown when an application starts.
dialogA dialog, see `transient_for`.
menuA context menu.
toolbarA floating toolbar.
utility
dropdown_menuA context menu attached to a parent position.
popup_menuA context menu.
notificationA notification popup.
comboA combobox list menu.
dndA drag and drop indicator.
normalA normal application main window.
* * More information can be found [here](https://specifications.freedesktop.org/wm-spec/wm-spec-latest.html#idm140200472629520) * * @property type * @tparam string type * @propemits false false * @readonly * @see ruled.client */ /** * The client class. * * A class usually maps to the application name. It is useful in, among other * places, the rules to apply different properties to different clients. It * is also useful, along with `instance`, to implement "windows counter" * used in many popular docks and Alt-Tab like popups. * * To get a client class from the command line, use the command: * * xprop WM_CLASS * * The class will be the second string. * * This *should* never change after the client is created, but some * buggy application like the Spotify desktop client are known to * violate the specification and do it anyway. There *is* a signal for * this property, but it should hopefully never be useful. If your * applications change their classes, please report a bug to them * and point to ICCCM §4.1.2.5. * It tends to break `ruled.client` and other AwesomeWM APIs. * * @property class * @tparam string class * @propemits false false * @readonly * @see instance * @see ruled.client */ /** * The client instance. * * The `instance` is a subtype of the `class`. Each `class` can have * multiple instances. This is useful in the `ruled.client` rules to * filter clients and apply different properties to them. * * To get a client instance from the command line, use the command: * * xprop WM_CLASS * * The instance will be the first string. * * This *should* never change after the client is created. There * *is* a signal for * this property, but it should hopefully never * be useful. If your applications change their classes, please * report a bug to them and point to ICCCM §4.1.2.5. * It tends to break `ruled.client` and other AwesomeWM APIs. * * @property instance * @tparam string instance * @propemits false false * @readonly * @see class * @see ruled.client */ /** * The client PID, if available. * * This will never change. * * @property pid * @tparam integer pid * @propemits false false * @readonly */ /** * The window role, if available. * * @property role * @tparam string role * @propemits false false * @readonly * @see instance * @see class */ /** * The machine the client is running on. * * X11 windows can "live" in one computer but be shown * in another one. This is called "network transparency" * and is either used directly by allowing remote windows * using the `xhosts` command or using proxies such as * `ssh -X` or `ssh -Y`. * * According to EWMH, this property contains the value * returned by `gethostname()` on the computer that the * client is running on. * * @property machine * @tparam string machine * @propemits false false * @readonly */ /** * The client name when iconified. * * @property icon_name * @tparam string icon_name * @propemits false false * @readonly */ /** * The client icon as a surface. * * This property holds the client icon closest to the size configured via * @{awesome.set_preferred_icon_size}. * * It is not a path or a "real" file. Rather, it is already a bitmap surface. * * Typically you would want to use @{awful.widget.clienticon} to get this as a * widget. * * Working with icons is tricky because their surfaces do not use reference * counting correctly. If `gears.surface(c.icon)` is called multiple time on * the same icon, it will cause a double-free error and Awesome will crash. To * get a copy of the icon, you can use: * * local s = gears.surface(c.icon) * local img = cairo.ImageSurface.create(cairo.Format.ARGB32, s:get_width(), s:get_height()) * local cr = cairo.Context(img) * cr:set_source_surface(s, 0, 0) * cr:paint() * * (Note that `awesome.set_preferred_icon_size` defaults to `0` if it wasn't * set. It means that, by default, the preferred icon provided will be the * smallest available) * * @property icon * @tparam surface icon * @propemits false false * @usage local ib = wibox.widget.imagebox(c.icon) * @see awful.widget.clienticon */ /** * The available sizes of client icons. This is a table where each entry * contains the width and height of an icon. * * Example: * * { * { 24, 24 }, * { 32, 32 }, * { 64, 64 }, * } * * @property icon_sizes * @tparam table sizes * @propemits false false * @readonly * @see awful.widget.clienticon * @see get_icon */ /** * Client screen. * * The `screen` corresponds to the top-left corner of the window. * * Please note that clients can only be on one screen at once. X11 * does not natively allow clients to be in multiple locations at * once. Changing the screen directly will affect the tags and may * cause several other changes to the state in order to ensure that * a client's position and its screen are consistent. * * @DOC_sequences_client_screen_EXAMPLE@ * * @property screen * @tparam screen screen * @propemits false false * @see move_to_screen */ /** * Define if the client must be hidden, i.e. never mapped, * invisible in taskbar. * * @property hidden * @tparam boolean hidden * @propemits false false * @see minimized * @see skip_taskbar * @see unmanage */ /** * Define it the client must be iconify, i.e. only visible in * taskbar. * * Minimized clients are still part of tags and screens, but * they are not displayed. You can unminimize using `c.minimized = false`, * but if you also want to set the focus, it is better to use: * * c:activate { context = "unminimized", raise = true } * * @DOC_sequences_client_minimize1_EXAMPLE@ * * @property minimized * @tparam boolean minimized * @propemits false false * @see hidden * @see isvisible * @see activate */ /** * Honor size hints, e.g. respect size ratio. * * For example, a terminal such as `xterm` require the client size to be a * multiple of the character size. Honoring size hints will cause the terminal * window to have a small gap at the bottom. * * This is enabled by default. To disable it by default, see `ruled.client`. * * @property size_hints_honor * @tparam boolean size_hints_honor * @propemits false false * @see size_hints */ /** * The client border width. * * When manually set (for example, in `ruled.client` rules), this value * will be static. Otherwise, it is controlled by many `beautiful` variables. * * Be careful, the borders are **around** the geometry, not part of it. If * you want more fancy border, use the `awful.titlebar` API to create * titlebars on each side of the client. * * @DOC_awful_client_border_width_EXAMPLE@ * * @property border_width * @tparam integer border_width * @propemits false false * @usebeautiful beautiful.border_width_active * @usebeautiful beautiful.border_width_normal * @usebeautiful beautiful.border_width_new * @usebeautiful beautiful.border_width_urgent * @usebeautiful beautiful.border_width_floating * @usebeautiful beautiful.border_width_floating_active * @usebeautiful beautiful.border_width_floating_normal * @usebeautiful beautiful.border_width_floating_new * @usebeautiful beautiful.border_width_floating_urgent * @usebeautiful beautiful.border_width_maximized * @usebeautiful beautiful.border_width_maximized_active * @usebeautiful beautiful.border_width_maximized_normal * @usebeautiful beautiful.border_width_maximized_new * @usebeautiful beautiful.border_width_maximized_urgent * @usebeautiful beautiful.border_width_fullscreen * @usebeautiful beautiful.border_width_fullscreen_active * @usebeautiful beautiful.border_width_fullscreen_normal * @usebeautiful beautiful.border_width_fullscreen_new * @usebeautiful beautiful.border_width_fullscreen_urgent * @usebeautiful beautiful.fullscreen_hide_border Hide the border on fullscreen clients. * @usebeautiful beautiful.maximized_hide_border Hide the border on maximized clients. * @see request::border * @see awful.permissions.update_border * @see border_color */ /** * The client border color. * * @DOC_awful_client_border_color_EXAMPLE@ * * Note that setting this directly will override and disable all related theme * variables. * * Setting a transparent color (e.g. to implement dynamic borders without size * changes) is supported, but requires the color to be set to `#00000000` * specifically. Other RGB colors with an alpha of `0` won't work. * * @property border_color * @tparam color border_color Any string, gradient or pattern definition that * can be converted to a cairo pattern. * @propemits false false * @usebeautiful beautiful.border_color_marked The fallback color when the * client is marked. * @usebeautiful beautiful.border_color_active The fallback color when the * client is active (focused). * @usebeautiful beautiful.border_color_normal The fallback color when the * client isn't active/floating/new/urgent/maximized/floating/fullscreen. * @usebeautiful beautiful.border_color_new The fallback color when the * client is new. * @usebeautiful beautiful.border_color_urgent The fallback color when the * client is urgent. * @usebeautiful beautiful.border_color_floating The fallback color when the * client is floating and the other colors are not set. * @usebeautiful beautiful.border_color_floating_active The color when the * client is floating and is active (focused). * @usebeautiful beautiful.border_color_floating_normal The color when the * client is floating and not new/urgent/active. * @usebeautiful beautiful.border_color_floating_new * @usebeautiful beautiful.border_color_floating_urgent The color when the * client is floating and urgent. * @usebeautiful beautiful.border_color_maximized * @usebeautiful beautiful.border_color_maximized_active * @usebeautiful beautiful.border_color_maximized_normal * @usebeautiful beautiful.border_color_maximized_new * @usebeautiful beautiful.border_color_maximized_urgent The color when the * client is urbent and maximized. * @usebeautiful beautiful.border_color_fullscreen * @usebeautiful beautiful.border_color_fullscreen_active * @usebeautiful beautiful.border_color_fullscreen_normal * @usebeautiful beautiful.border_color_fullscreen_new * @usebeautiful beautiful.border_color_fullscreen_urgent The color when the * client is fullscreen and urgent. * @see request::border * @see awful.permissions.update_border * @see gears.color * @see border_width */ /** * Set to `true` when the client ask for attention. * * The urgent state is the visual equivalent of the "bell" noise from * old computer. It is set by the client when their state changed and * they need attention. For example, a chat client will set it when * a new message arrive. Some terminals, like `rxvt-unicode`, will also * set it when calling the `bell` command. * * There is many ways an urgent client can become for visible: * * * Highlight in the `awful.widget.taglist` and `awful.widget.tasklist` * * Highlight in the `awful.titlebar` * * Highlight of the client border color (or width). * * Accessible using `Mod4+u` in the default config. * * Emit the `property::urgent` signal. * * @DOC_awful_client_urgent1_EXAMPLE@ * * @property urgent * @tparam boolean urgent * @propemits false false * @request client border active granted When a client becomes active and is no * longer urgent. * @request client border inactive granted When a client stop being active and * is no longer urgent. * @request client border urgent granted When a client stop becomes urgent. * @see request::border * @see awful.client.urgent.jumpto * @usebeautiful beautiful.border_color_urgent The fallback color when the * client is urgent. * @usebeautiful beautiful.border_color_floating_urgent The color when the * client is floating and urgent. * @usebeautiful beautiful.border_color_maximized_urgent The color when the * client is urbent and maximized. * @usebeautiful beautiful.border_color_fullscreen_urgent The color when the * client is fullscreen and urgent. * @usebeautiful beautiful.border_width_urgent The fallback border width when * the client is urgent. * @usebeautiful beautiful.border_width_floating_urgent The border width when * the client is floating and urgent. * @usebeautiful beautiful.border_width_maximized_urgent The border width when * the client is maximized and urgent. * @usebeautiful beautiful.border_width_fullscreen_urgent The border width when * the client is fullscreen and urgent. * @usebeautiful beautiful.titlebar_fg_urgent * @usebeautiful beautiful.titlebar_bg_urgent * @usebeautiful beautiful.titlebar_bgimage_urgent * @usebeautiful beautiful.fg_urgent * @usebeautiful beautiful.bg_urgent */ /** * A cairo surface for the client window content. * * To get the screenshot, use: * * gears.surface(c.content) * * To save it, use: * * gears.surface(c.content):write_to_png(path) * * Please note that this only creates a new cairo surface * referring to the client's content. This means that * changes to the client's content may or may not become * visible in the returned surface. If you want to take a * screenshot, a copy of the surface's content needs to * be taken. Note that the content of parts of a window * that are currently not visible are undefined. * * The only way to get an animated client screenshot widget is to poll this * property multiple time per seconds. This is obviously a bad idea. * * This property has no signals when the content changes. * * @property content * @tparam surface content * @readonly * @see gears.surface */ /** * The client opacity. * * The opacity only works when a compositing manager, such as * [picom](https://github.com/yshui/picom/), is used. Otherwise, * the clients will remain opaque. * * @DOC_awful_client_opacity1_EXAMPLE@ * * @property opacity * @tparam number opacity Between 0 (transparent) to 1 (opaque). * @propemits false false * @see request::border * @see awesome.composite_manager_running */ /** * The client is on top of every other windows. * * @property ontop * @tparam boolean ontop * @propemits false false * @see below * @see above */ /** * The client is above normal windows. * * @property above * @tparam boolean above * @propemits false false * @see below * @see ontop */ /** * The client is below normal windows. * * @property below * @tparam boolean below * @propemits false false * @see above * @see ontop */ /** * The client is fullscreen or not. * * @DOC_sequences_client_fullscreen_EXAMPLE@ * * @property fullscreen * @tparam boolean fullscreen * @propemits false false * @request client geometry fullscreen granted When the client must be resized * because it became (or stop being) fullscreen. * @see maximized_horizontal * @see maximized_vertical * @see immobilized_horizontal * @see immobilized_vertical * @see maximized */ /** * The client is maximized (horizontally and vertically) or not. * * @DOC_sequences_client_maximized_EXAMPLE@ * * @property maximized * @tparam boolean maximized * @propemits false false * @request client geometry maximized granted When the client must be resized * because it became (or stop being) maximized. * @see request::border * @see maximized_horizontal * @see maximized_vertical * @see fullscreen * @see immobilized_horizontal * @see immobilized_vertical */ /** * The client is maximized horizontally or not. * * @DOC_sequences_client_maximized_horizontal_EXAMPLE@ * * @property maximized_horizontal * @tparam boolean maximized_horizontal * @propemits false false * @request client geometry maximized_horizontal granted When the client must be resized * because it became (or stop being) maximized horizontally. * @see maximized_vertical * @see fullscreen * @see immobilized_horizontal * @see immobilized_vertical * @see maximized */ /** * The client is maximized vertically or not. * * @DOC_sequences_client_maximized_vertical_EXAMPLE@ * * @property maximized_vertical * @tparam boolean maximized_vertical * @propemits false false * @request client geometry maximized_vertical granted When the client must be resized * because it became (or stop being) maximized vertically. * @see maximized_horizontal * @see fullscreen * @see immobilized_horizontal * @see immobilized_vertical * @see maximized */ /** * The client the window is transient for. * * A transient window is a client that "belongs" to another * client. If the client is also `modal`, then the parent client * cannot be focused while the child client exists. * This is common for "Save as" dialogs or other dialogs where it * is not possible to modify the content of the "parent" client * while the dialog is open. * * However, `modal` is not a requirement for using the `transient_for` * concept. "Tools" such as popup palette in canvas-and-palettes * applications can belong to each other without being modal. * * @property transient_for * @tparam client transient_for * @propemits false false * @readonly * @see modal * @see type * @see is_transient_for * @see get_transient_for_matching */ /** * Window identification unique to a group of windows. * * This is the ID of the group window, not a client object. * The group window is most likely not a visible client, but * only an invisible and internal window. * * @property group_window * @tparam integer group_window * @propemits false false * @readonly * @see leader_window */ /** * Identification unique to windows spawned by the same command. * * This is the ID of the group window, not a client object. * * @property leader_window * @tparam number leader_window * @propemits false false * @readonly * @see transient_for * @see modal * @see group_window */ /** * A table with size hints of the client. * * For details on the meaning of the fields, refer to ICCCM § 4.1.2.3 * `WM_NORMAL_HINTS`. * * Please note that most fields are optional and may or may not be set. * * When the client is tiled, the `size_hints` usually get in the way and * cause the layouts to behave incorrectly. To mitigate this, it is often * advised to set `size_hints_honor` to `false` in the `ruled.client` rules. * * @property size_hints * @tparam[opt] table|nil hints The hints. * @tparam[opt] table|nil hints.user_position A table with `x` and `y` keys. It * contains the preferred position of the client. This is set when the * position has been modified by the user. See `program_position`. * @tparam[opt] table|nil hints.program_position A table with `x` and `y` keys. It * contains the preferred position of the client. This is set when the * application itself requests a specific position. See `user_position`. * @tparam[opt] table|nil hints.user_size A table with `width` and `height`. This * contains the client preferred size when it has previously been set by * the user. See `program_size` for the equivalent when the applications * itself wants to specify its preferred size. * @tparam[opt] table|nil hints.program_size A table with `width` and `height`. This * contains the client preferred size as specified by the application. * @tparam[opt] integer|nil hints.max_width The maximum width (in pixels). * @tparam[opt] integer|nil hints.max_height The maximum height (in pixels). * @tparam[opt] integer|nil hints.min_width The minimum width (in pixels). * @tparam[opt] integer|nil hints.min_height The minimum height (in pixels). * @tparam[opt] integer|nil hints.width_inc The number of pixels by which the * client width may be increased or decreased. For example, for terminals, * the size has to be proportional with the monospace font size. * @tparam[opt] integer|nil hints.height_inc The number of pixels by which the * client height may be increased or decreased. For example, for terminals, * the size has to be proportional with the monospace font size. * @tparam[opt] string|nil hints.win_gravity The client `gravity` defines the corder * from which the size is computed. For most clients, it is `north_west`, which * corresponds to the top-left of the window. This will affect how the client * is resized and other size related operations. * @tparam[opt] integer|nil hints.min_aspect_num * @tparam[opt] integer|nil hints.min_aspect_den * @tparam[opt] integer|nil hints.max_aspect_num * @tparam[opt] integer|nil hints.max_aspect_den * @tparam[opt] integer|nil hints.base_width * @tparam[opt] integer|nil hints.base_height * @propemits false false * @readonly * @see size_hints_honor * @see geometry */ /** * The motif WM hints of the client. * * This is nil if the client has no motif hints. Otherwise, this is a table that * contains the present properties. Note that awesome provides these properties * as-is and does not interpret them for you. For example, if the function table * only has "resize" set to true, this means that the window requests to be only * resizable, but asks for the other functions not to be able. If however both * "resize" and "all" are set, this means that all but the resize function * should be enabled. * * @property motif_wm_hints * @tparam table hints The hints. * @tparam[opt] boolean hints.functions.all * @tparam[opt] boolean hints.functions.resize * @tparam[opt] boolean hints.functions.move * @tparam[opt] boolean hints.functions.minimize * @tparam[opt] boolean hints.functions.maximize * @tparam[opt] boolean hints.functions.close * @tparam[opt] boolean hints.decorations.all * @tparam[opt] boolean hints.decorations.border * @tparam[opt] boolean hints.decorations.resizeh * @tparam[opt] boolean hints.decorations.title * @tparam[opt] boolean hints.decorations.menu * @tparam[opt] boolean hints.decorations.minimize * @tparam[opt] boolean hints.decorations.maximize * @tparam[opt] string hints.input_mode This is either `modeless`, * `primary_application_modal`, `system_modal`, * `full_application_modal` or `unknown`. * @tparam[opt] boolean hints.status.tearoff_window * @propemits false false * @readonly */ /** * Set the client sticky, i.e. available on all tags. * * Please note that AwesomeWM implements `sticky` clients * per screens rather than globally like some other * implementations. * * @DOC_sequences_client_sticky_EXAMPLE@ * * @property sticky * @tparam boolean sticky * @propemits false false * @see skip_taskbar */ /** * Indicate if the client is modal. * * A transient window is a client that "belongs" to another * client. If the client is also `modal`, then it always has * to be on top of the other window *and* the parent client * cannot be focused while the child client exists. * This is common for "Save as" dialogs or other dialogs where * is not possible to modify the content of the "parent" client * while the dialog is open. * * However, `modal` is not a requirement for using the `transient_for` * concept. "Tools" such as popup palette in canvas-and-palettes * applications can belong to each other without being modal. * * @property modal * @tparam boolean modal * @propemits false false * @see transient_for */ /** * True if the client can receive the input focus. * * The client will not get focused even when the user * click on it. * * @property focusable * @tparam boolean focusable * @propemits false false * @see shape_input * @see client.focus * @see active * @see activate */ /** * The client's bounding shape as set by awesome as a (native) cairo surface. * * The bounding shape is the outer shape of the client. It is outside of the * border. * * Do not use this directly unless you want total control over the shape (such * as shape with holes). Even then, it is usually recommended to use transparency * in the titlebars and a compositing manager. For the vast majority of use * cases, use the `shape` property. * * @property shape_bounding * @tparam surface shape_bounding * @propemits false false * @see shape * @see gears.surface.apply_shape_bounding * @see gears.shape * @see shape_clip * @see shape_input * @see client_shape_bounding * @see client_shape_clip * @see gears.surface */ /** * The client's clip shape as set by awesome as a (native) cairo surface. * * The shape_clip is the shape of the client *content*. It is *inside* the * border. * * @property shape_clip * @tparam surface shape_clip * @propemits false false * @see shape_bounding * @see shape_input * @see shape * @see gears.surface.apply_shape_bounding * @see gears.shape * @see client_shape_bounding * @see client_shape_clip * @see gears.surface */ /** * The client's input shape as set by awesome as a (native) cairo surface. * * The input shape is the shape where mouse input will be passed to the * client rather than propagated below it. * * @property shape_input * @tparam surface shape_input * @propemits false false * @see shape_bounding * @see shape_clip * @see shape * @see gears.surface.apply_shape_bounding * @see gears.shape * @see client_shape_bounding * @see client_shape_clip * @see gears.surface */ /** * The client's bounding shape as set by the program as a (native) cairo surface. * * @property client_shape_bounding * @tparam surface client_shape_bounding * @propemits false false * @readonly * @see shape_bounding * @see shape_clip * @see shape_input * @see shape * @see gears.surface.apply_shape_bounding * @see gears.shape * @see client_shape_clip * @see gears.surface */ /** * The client's clip shape as set by the program as a (native) cairo surface. * * @property client_shape_clip * @tparam surface client_shape_clip * @propemits false false * @readonly * @see shape_bounding * @see shape_clip * @see shape_input * @see shape * @see gears.surface.apply_shape_bounding * @see gears.shape * @see client_shape_bounding * @see gears.surface */ /** * The FreeDesktop StartId. * * When a client is spawned (like using a terminal or `awful.spawn`, a startup * notification identifier is created. When the client is created, this * identifier remain the same. This allow to match a spawn event to an actual * client. * * This is used to display a different mouse cursor when the application is * loading and also to attach some properties to the newly created client (like * a `tag` or `floating` state). * * Some applications, like `xterm`, don't support startup notification. While * not perfect, the addition the following code to `rc.lua` will mitigate the * issue. Please note that this code is Linux specific. * * local blacklisted_snid = setmetatable({}, {__mode = "v" }) * * --- Make startup notification work for some clients like XTerm. This is ugly * -- but works often enough to be useful. * local function fix_startup_id(c) * -- Prevent "broken" sub processes created by `c` to inherit its SNID * if c.startup_id then * blacklisted_snid[c.startup_id] = blacklisted_snid[c.startup_id] or c * return * end * * if not c.pid then return end * * -- Read the process environment variables * local f = io.open("/proc/"..c.pid.."/environ", "rb") * * -- It will only work on Linux, that's already 99% of the userbase. * if not f then return end * * local value = _VERSION <= "Lua 5.1" and "([^\z]*)\0" or "([^\0]*)\0" * local snid = f:read("*all"):match("STARTUP_ID=" .. value) * f:close() * * -- If there is already a client using this SNID, it means it's either a * -- subprocess or another window for the same process. While it makes sense * -- in some case to apply the same rules, it is not always the case, so * -- better doing nothing rather than something stupid. * if blacklisted_snid[snid] then return end * * c.startup_id = snid * * blacklisted_snid[snid] = c * end * * ruled.client.add_rule_source( * "snid", fix_startup_id, {}, {"awful.spawn", "ruled.client"} * ) * * @property startup_id * @tparam string startup_id * @propemits false false * @see awful.spawn */ /** * If the client that this object refers to is still managed by awesome. * * To avoid errors, use: * * local is_valid = pcall(function() return c.valid end) and c.valid * * @property valid * @tparam boolean valid * @propemits false false * @readonly * @see kill */ /** * The first tag of the client. * * Optimized form of `c:tags()[1]`. Not every workflow uses the * ability to set multiple tags to a client. It is often enough * to only get the first tag and ignore everything else. * * @property first_tag * @tparam tag first_tag * @propemits false false * @readonly * @see tags */ /** Return client struts (reserved space at the edge of the screen). * * The struts area is a table with a `left`, `right`, `top` and `bottom` * keys to define how much space of the screen `workarea` this client * should reserve for itself. * * This corresponds to EWMH's `_NET_WM_STRUT` and `_NET_WM_STRUT_PARTIAL`. * * In the example below, 2 object affect the workarea (using their struts): * * * The top wibar add a `top=24` * * The bottom-left client add `bottom=100, left=100` * * @DOC_screen_struts_EXAMPLE@ * * @tparam table struts A table with new strut values, or none. * @treturn table A table with strut values. * @method struts * @see geometry * @see screen.workarea * @see dockable */ /** Get or set mouse buttons bindings for a client. * * @property buttons * @tparam table buttons * @propemits false false * @see awful.button * @see append_mousebinding * @see remove_mousebinding * @see request::default_mousebindings */ /** Get the number of instances. * * @treturn integer The number of client objects alive. * @staticfct instances */ /* Set a __index metamethod for all client instances. * @tparam function cb The meta-method * @staticfct set_index_miss_handler */ /* Set a __newindex metamethod for all client instances. * @tparam function cb The meta-method * @staticfct set_newindex_miss_handler */ typedef enum { CLIENT_MAXIMIZED_NONE = 0 << 0, CLIENT_MAXIMIZED_V = 1 << 0, CLIENT_MAXIMIZED_H = 1 << 1, CLIENT_MAXIMIZED_BOTH = 1 << 2, /* V|H == BOTH, but ~(V|H) != ~(BOTH)... */ } client_maximized_t; static area_t titlebar_get_area(client_t *c, client_titlebar_t bar); static drawable_t *titlebar_get_drawable(lua_State *L, client_t *c, int cl_idx, client_titlebar_t bar); static void client_resize_do(client_t *c, area_t geometry); static void client_set_maximized_common(lua_State *L, int cidx, bool s, const char* type, const int val); /** Collect a client. * \param L The Lua VM state. * \return The number of element pushed on stack. */ static void client_wipe(client_t *c) { key_array_wipe(&c->keys); xcb_icccm_get_wm_protocols_reply_wipe(&c->protocols); cairo_surface_array_wipe(&c->icons); p_delete(&c->machine); p_delete(&c->class); p_delete(&c->instance); p_delete(&c->icon_name); p_delete(&c->alt_icon_name); p_delete(&c->name); p_delete(&c->alt_name); p_delete(&c->startup_id); } /** Change the clients urgency flag. * \param L The Lua VM state. * \param cidx The client index on the stack. * \param urgent The new flag state. */ void client_set_urgent(lua_State *L, int cidx, bool urgent) { client_t *c = luaA_checkudata(L, cidx, &client_class); if(c->urgent != urgent) { c->urgent = urgent; luaA_object_emit_signal(L, cidx, "property::urgent", 0); } } #define DO_CLIENT_SET_PROPERTY(prop) \ void \ client_set_##prop(lua_State *L, int cidx, fieldtypeof(client_t, prop) value) \ { \ client_t *c = luaA_checkudata(L, cidx, &client_class); \ if(c->prop != value) \ { \ c->prop = value; \ luaA_object_emit_signal(L, cidx, "property::" #prop, 0); \ } \ } DO_CLIENT_SET_PROPERTY(group_window) DO_CLIENT_SET_PROPERTY(type) DO_CLIENT_SET_PROPERTY(transient_for) DO_CLIENT_SET_PROPERTY(pid) DO_CLIENT_SET_PROPERTY(skip_taskbar) #undef DO_CLIENT_SET_PROPERTY #define DO_CLIENT_SET_STRING_PROPERTY2(prop, signal) \ void \ client_set_##prop(lua_State *L, int cidx, char *value) \ { \ client_t *c = luaA_checkudata(L, cidx, &client_class); \ if (A_STREQ(c->prop, value)) \ { \ p_delete(&value); \ return; \ } \ p_delete(&c->prop); \ c->prop = value; \ luaA_object_emit_signal(L, cidx, "property::" #signal, 0); \ } #define DO_CLIENT_SET_STRING_PROPERTY(prop) \ DO_CLIENT_SET_STRING_PROPERTY2(prop, prop) DO_CLIENT_SET_STRING_PROPERTY(name) DO_CLIENT_SET_STRING_PROPERTY2(alt_name, name) DO_CLIENT_SET_STRING_PROPERTY(icon_name) DO_CLIENT_SET_STRING_PROPERTY2(alt_icon_name, icon_name) DO_CLIENT_SET_STRING_PROPERTY(startup_id) DO_CLIENT_SET_STRING_PROPERTY(role) DO_CLIENT_SET_STRING_PROPERTY(machine) #undef DO_CLIENT_SET_STRING_PROPERTY void client_emit_scanned(void) { lua_State *L = globalconf_get_lua_State(); luaA_class_emit_signal(L, &client_class, "scanned", 0); } void client_emit_scanning(void) { lua_State *L = globalconf_get_lua_State(); luaA_class_emit_signal(L, &client_class, "scanning", 0); } void client_set_motif_wm_hints(lua_State *L, int cidx, motif_wm_hints_t hints) { client_t *c = luaA_checkudata(L, cidx, &client_class); if (memcmp(&c->motif_wm_hints, &hints, sizeof(c->motif_wm_hints)) == 0) return; memcpy(&c->motif_wm_hints, &hints, sizeof(c->motif_wm_hints)); luaA_object_emit_signal(L, cidx, "property::motif_wm_hints", 0); } void client_find_transient_for(client_t *c) { int counter; client_t *tc, *tmp; lua_State *L = globalconf_get_lua_State(); /* This might return NULL, in which case we unset transient_for */ tmp = tc = client_getbywin(c->transient_for_window); /* Verify that there are no loops in the transient_for relation after we are done */ for(counter = 0; tmp != NULL && counter <= globalconf.stack.len; counter++) { if (tmp == c) /* We arrived back at the client we started from, so there is a loop */ counter = globalconf.stack.len+1; tmp = tmp->transient_for; } if (counter > globalconf.stack.len) { /* There was a loop, so unset .transient_for */ tc = NULL; } luaA_object_push(L, c); client_set_transient_for(L, -1, tc); lua_pop(L, 1); } void client_set_class_instance(lua_State *L, int cidx, const char *class, const char *instance) { client_t *c = luaA_checkudata(L, cidx, &client_class); p_delete(&c->class); p_delete(&c->instance); c->class = a_strdup(class); luaA_object_emit_signal(L, cidx, "property::class", 0); c->instance = a_strdup(instance); luaA_object_emit_signal(L, cidx, "property::instance", 0); } /** Returns true if a client is tagged with one of the active tags. * \param c The client to check. * \return true if the client is visible, false otherwise. */ bool client_on_selected_tags(client_t *c) { if(c->sticky) return true; foreach(tag, globalconf.tags) if(tag_get_selected(*tag) && is_client_tagged(c, *tag)) return true; return false; } /** Get a client by its window. * \param w The client window to find. * \return A client pointer if found, NULL otherwise. */ client_t * client_getbywin(xcb_window_t w) { foreach(c, globalconf.clients) if((*c)->window == w) return *c; return NULL; } client_t * client_getbynofocuswin(xcb_window_t w) { foreach(c, globalconf.clients) if((*c)->nofocus_window == w) return *c; return NULL; } /** Get a client by its frame window. * \param w The client window to find. * \return A client pointer if found, NULL otherwise. */ client_t * client_getbyframewin(xcb_window_t w) { foreach(c, globalconf.clients) if((*c)->frame_window == w) return *c; return NULL; } /** Unfocus a client (internal). * \param c The client. */ static void client_unfocus_internal(client_t *c) { lua_State *L = globalconf_get_lua_State(); globalconf.focus.client = NULL; luaA_object_push(L, c); lua_pushboolean(L, false); luaA_object_emit_signal(L, -2, "property::active", 1); luaA_object_emit_signal(L, -1, "unfocus", 0); lua_pop(L, 1); } /** Unfocus a client. * \param c The client. */ static void client_unfocus(client_t *c) { client_unfocus_internal(c); globalconf.focus.need_update = true; } /** Check if client supports atom a protocol in WM_PROTOCOL. * \param c The client. * \param atom The protocol atom to check for. * \return True if client has the atom in protocol, false otherwise. */ bool client_hasproto(client_t *c, xcb_atom_t atom) { for(uint32_t i = 0; i < c->protocols.atoms_len; i++) if(c->protocols.atoms[i] == atom) return true; return false; } /** Prepare banning a client by running all needed lua events. * \param c The client. */ void client_ban_unfocus(client_t *c) { /* Wait until the last moment to take away the focus from the window. */ if(globalconf.focus.client == c) client_unfocus(c); } /** Ban client and move it out of the viewport. * \param c The client. */ void client_ban(client_t *c) { if(!c->isbanned) { client_ignore_enterleave_events(); xcb_unmap_window(globalconf.connection, c->frame_window); client_restore_enterleave_events(); c->isbanned = true; client_ban_unfocus(c); } } /** This is part of The Bob Marley Algorithm: we ignore enter and leave window * in certain cases, like map/unmap or move, so we don't get spurious events. * The implementation works by noting the range of sequence numbers for which we * should ignore events. We grab the server to make sure that only we could * generate events in this range. */ void client_ignore_enterleave_events(void) { check(globalconf.pending_enter_leave_begin.sequence == 0); globalconf.pending_enter_leave_begin = xcb_grab_server(globalconf.connection); /* If the connection is broken, we get a request with sequence number 0 * which would then trigger an assertion in * client_restore_enterleave_events(). Handle this nicely. */ if(xcb_connection_has_error(globalconf.connection)) fatal("X server connection broke (error %d)", xcb_connection_has_error(globalconf.connection)); check(globalconf.pending_enter_leave_begin.sequence != 0); } void client_restore_enterleave_events(void) { sequence_pair_t pair; check(globalconf.pending_enter_leave_begin.sequence != 0); pair.begin = globalconf.pending_enter_leave_begin; pair.end = xcb_no_operation(globalconf.connection); xutil_ungrab_server(globalconf.connection); globalconf.pending_enter_leave_begin.sequence = 0; sequence_pair_array_append(&globalconf.ignore_enter_leave_events, pair); } /** Record that a client got focus. * \param c The client. * \return true if the client focus changed, false otherwise. */ bool client_focus_update(client_t *c) { lua_State *L = globalconf_get_lua_State(); if(globalconf.focus.client && globalconf.focus.client != c) { /* When we are called due to a FocusIn event (=old focused client * already unfocused), we don't want to cause a SetInputFocus, * because the client which has focus now could be using globally * active input model (or 'no input'). */ client_unfocus_internal(globalconf.focus.client); } bool focused_new = globalconf.focus.client != c; globalconf.focus.client = c; /* According to EWMH, we have to remove the urgent state from a client. * This should be done also for the current/focused client (FS#1310). */ luaA_object_push(L, c); client_set_urgent(L, -1, false); if(focused_new) { lua_pushboolean(L, true); luaA_object_emit_signal(L, -2, "property::active", 1); luaA_object_emit_signal(L, -1, "focus", 0); } lua_pop(L, 1); return focused_new; } /** Give focus to client, or to first client if client is NULL. * \param c The client. */ void client_focus(client_t *c) { /* We have to set focus on first client */ if(!c && globalconf.clients.len && !(c = globalconf.clients.tab[0])) return; if(client_focus_update(c)) globalconf.focus.need_update = true; } static xcb_window_t client_get_nofocus_window(client_t *c) { if (c->nofocus_window == XCB_NONE) { c->nofocus_window = xcb_generate_id(globalconf.connection); xcb_create_window(globalconf.connection, globalconf.default_depth, c->nofocus_window, c->frame_window, -2, -2, 1, 1, 0, XCB_COPY_FROM_PARENT, globalconf.visual->visual_id, 0, NULL); xcb_map_window(globalconf.connection, c->nofocus_window); xwindow_grabkeys(c->nofocus_window, &c->keys); } return c->nofocus_window; } void client_focus_refresh(void) { client_t *c = globalconf.focus.client; xcb_window_t win = globalconf.focus.window_no_focus; if(!globalconf.focus.need_update) return; if(c && client_on_selected_tags(c)) { /* Make sure this window is unbanned and e.g. not minimized */ client_unban(c); /* Sets focus on window - using xcb_set_input_focus or WM_TAKE_FOCUS */ if(!c->nofocus) win = c->window; else win = client_get_nofocus_window(c); if(client_hasproto(c, WM_TAKE_FOCUS)) xwindow_takefocus(c->window); } /* If nothing has the focus or the currently focused client does not want * us to focus it, this sets the focus to the root window. This makes sure * the previously focused client actually gets unfocused. Alternatively, the * new client gets the input focus. */ xcb_set_input_focus(globalconf.connection, XCB_INPUT_FOCUS_PARENT, win, globalconf.timestamp); /* Do this last, because client_unban() might set it to true */ globalconf.focus.need_update = false; } static void client_border_refresh(void) { foreach(c, globalconf.clients) window_border_refresh((window_t *) *c); } static void client_geometry_refresh(void) { bool ignored_enterleave = false; foreach(_c, globalconf.clients) { client_t *c = *_c; /* Compute the client window's and frame window's geometry */ area_t geometry = c->geometry; area_t real_geometry = c->geometry; if (!c->fullscreen) { if ((real_geometry.width < c->titlebar[CLIENT_TITLEBAR_LEFT].size + c->titlebar[CLIENT_TITLEBAR_RIGHT].size) || (real_geometry.height < c->titlebar[CLIENT_TITLEBAR_TOP].size + c->titlebar[CLIENT_TITLEBAR_BOTTOM].size)) warn("Resizing a window to a negative size!? Have width %d-%d-%d=%d" " and height %d-%d-%d=%d", real_geometry.width, c->titlebar[CLIENT_TITLEBAR_LEFT].size, c->titlebar[CLIENT_TITLEBAR_RIGHT].size, real_geometry.width - c->titlebar[CLIENT_TITLEBAR_LEFT].size - c->titlebar[CLIENT_TITLEBAR_RIGHT].size, real_geometry.height, c->titlebar[CLIENT_TITLEBAR_TOP].size, c->titlebar[CLIENT_TITLEBAR_BOTTOM].size, real_geometry.height - c->titlebar[CLIENT_TITLEBAR_TOP].size - c->titlebar[CLIENT_TITLEBAR_BOTTOM].size); real_geometry.x = c->titlebar[CLIENT_TITLEBAR_LEFT].size; real_geometry.y = c->titlebar[CLIENT_TITLEBAR_TOP].size; real_geometry.width -= c->titlebar[CLIENT_TITLEBAR_LEFT].size; real_geometry.width -= c->titlebar[CLIENT_TITLEBAR_RIGHT].size; real_geometry.height -= c->titlebar[CLIENT_TITLEBAR_TOP].size; real_geometry.height -= c->titlebar[CLIENT_TITLEBAR_BOTTOM].size; if (real_geometry.width == 0 || real_geometry.height == 0) warn("Resizing a window to size zero!?"); } else { real_geometry.x = 0; real_geometry.y = 0; } /* Is there anything to do? */ if (AREA_EQUAL(geometry, c->x11_frame_geometry) && AREA_EQUAL(real_geometry, c->x11_client_geometry)) { if (c->got_configure_request) { /* ICCCM 4.1.5 / 4.2.3, if nothing was changed, send an event saying so */ client_send_configure(c); c->got_configure_request = false; } continue; } if (!ignored_enterleave) { client_ignore_enterleave_events(); ignored_enterleave = true; } xcb_configure_window(globalconf.connection, c->frame_window, XCB_CONFIG_WINDOW_X | XCB_CONFIG_WINDOW_Y | XCB_CONFIG_WINDOW_WIDTH | XCB_CONFIG_WINDOW_HEIGHT, (uint32_t[]) { geometry.x, geometry.y, geometry.width, geometry.height }); xcb_configure_window(globalconf.connection, c->window, XCB_CONFIG_WINDOW_X | XCB_CONFIG_WINDOW_Y | XCB_CONFIG_WINDOW_WIDTH | XCB_CONFIG_WINDOW_HEIGHT, (uint32_t[]) { real_geometry.x, real_geometry.y, real_geometry.width, real_geometry.height }); c->x11_frame_geometry = geometry; c->x11_client_geometry = real_geometry; /* ICCCM 4.2.3 says something else, but Java always needs this... */ client_send_configure(c); c->got_configure_request = false; } if (ignored_enterleave) client_restore_enterleave_events(); } void client_refresh(void) { client_geometry_refresh(); client_border_refresh(); client_focus_refresh(); } void client_destroy_later(void) { bool ignored_enterleave = false; foreach(window, globalconf.destroy_later_windows) { if (!ignored_enterleave) { client_ignore_enterleave_events(); ignored_enterleave = true; } xcb_destroy_window(globalconf.connection, *window); } if (ignored_enterleave) client_restore_enterleave_events(); /* Everything's done, clear the list */ globalconf.destroy_later_windows.len = 0; } static void border_width_callback(client_t *c, uint16_t old_width, uint16_t new_width) { if(c->size_hints.flags & XCB_ICCCM_SIZE_HINT_P_WIN_GRAVITY) { area_t geometry = c->geometry; int16_t diff = new_width - old_width; xwindow_translate_for_gravity(c->size_hints.win_gravity, diff, diff, diff, diff, &geometry.x, &geometry.y); /* inform client about changes */ client_resize_do(c, geometry); } } static void client_update_properties(lua_State *L, int cidx, client_t *c) { /* get all hints */ xcb_get_property_cookie_t wm_normal_hints = property_get_wm_normal_hints(c); xcb_get_property_cookie_t wm_hints = property_get_wm_hints(c); xcb_get_property_cookie_t wm_transient_for = property_get_wm_transient_for(c); xcb_get_property_cookie_t wm_client_leader = property_get_wm_client_leader(c); xcb_get_property_cookie_t wm_client_machine = property_get_wm_client_machine(c); xcb_get_property_cookie_t wm_window_role = property_get_wm_window_role(c); xcb_get_property_cookie_t net_wm_pid = property_get_net_wm_pid(c); xcb_get_property_cookie_t net_wm_icon = property_get_net_wm_icon(c); xcb_get_property_cookie_t wm_name = property_get_wm_name(c); xcb_get_property_cookie_t net_wm_name = property_get_net_wm_name(c); xcb_get_property_cookie_t wm_icon_name = property_get_wm_icon_name(c); xcb_get_property_cookie_t net_wm_icon_name = property_get_net_wm_icon_name(c); xcb_get_property_cookie_t wm_class = property_get_wm_class(c); xcb_get_property_cookie_t wm_protocols = property_get_wm_protocols(c); xcb_get_property_cookie_t motif_wm_hints = property_get_motif_wm_hints(c); xcb_get_property_cookie_t opacity = xwindow_get_opacity_unchecked(c->window); /* update strut */ ewmh_process_client_strut(c); /* Now process all replies */ property_update_wm_normal_hints(c, wm_normal_hints); property_update_wm_hints(c, wm_hints); property_update_wm_transient_for(c, wm_transient_for); property_update_wm_client_leader(c, wm_client_leader); property_update_wm_client_machine(c, wm_client_machine); property_update_wm_window_role(c, wm_window_role); property_update_net_wm_pid(c, net_wm_pid); property_update_net_wm_icon(c, net_wm_icon); property_update_wm_name(c, wm_name); property_update_net_wm_name(c, net_wm_name); property_update_wm_icon_name(c, wm_icon_name); property_update_net_wm_icon_name(c, net_wm_icon_name); property_update_wm_class(c, wm_class); property_update_wm_protocols(c, wm_protocols); property_update_motif_wm_hints(c, motif_wm_hints); window_set_opacity(L, cidx, xwindow_get_opacity_from_cookie(opacity)); } /** Manage a new client. * \param w The window. * \param wgeom Window geometry. * \param startup True if we are managing at startup time. */ void client_manage(xcb_window_t w, xcb_get_geometry_reply_t *wgeom, xcb_get_window_attributes_reply_t *wattr) { xcb_void_cookie_t reparent_cookie; lua_State *L = globalconf_get_lua_State(); const uint32_t select_input_val[] = { CLIENT_SELECT_INPUT_EVENT_MASK }; if(systray_iskdedockapp(w)) { systray_request_handle(w); return; } /* If this is a new client that just has been launched, then request its * startup id. */ xcb_get_property_cookie_t startup_id_q = xcb_get_property(globalconf.connection, false, w, _NET_STARTUP_ID, XCB_GET_PROPERTY_TYPE_ANY, 0, UINT_MAX); /* Make sure the window is automatically mapped if awesome exits or dies. */ xcb_change_save_set(globalconf.connection, XCB_SET_MODE_INSERT, w); if (globalconf.have_shape) xcb_shape_select_input(globalconf.connection, w, 1); client_t *c = client_new(L); xcb_screen_t *s = globalconf.screen; c->border_width_callback = (void (*) (void *, uint16_t, uint16_t)) border_width_callback; /* consider the window banned */ c->isbanned = true; /* Store window and visual */ c->window = w; c->visualtype = draw_find_visual(globalconf.screen, wattr->visual); c->frame_window = xcb_generate_id(globalconf.connection); xcb_create_window(globalconf.connection, globalconf.default_depth, c->frame_window, s->root, wgeom->x, wgeom->y, wgeom->width, wgeom->height, wgeom->border_width, XCB_COPY_FROM_PARENT, globalconf.visual->visual_id, XCB_CW_BORDER_PIXEL | XCB_CW_BIT_GRAVITY | XCB_CW_WIN_GRAVITY | XCB_CW_OVERRIDE_REDIRECT | XCB_CW_EVENT_MASK | XCB_CW_COLORMAP, (const uint32_t []) { globalconf.screen->black_pixel, XCB_GRAVITY_NORTH_WEST, XCB_GRAVITY_NORTH_WEST, 1, FRAME_SELECT_INPUT_EVENT_MASK, globalconf.default_cmap }); /* The client may already be mapped, thus we must be sure that we don't send * ourselves an UnmapNotify due to the xcb_reparent_window(). * * Grab the server to make sure we don't lose any events. */ uint32_t no_event[] = { 0 }; xcb_grab_server(globalconf.connection); xcb_change_window_attributes(globalconf.connection, globalconf.screen->root, XCB_CW_EVENT_MASK, no_event); reparent_cookie = xcb_reparent_window_checked(globalconf.connection, w, c->frame_window, 0, 0); xcb_map_window(globalconf.connection, w); xcb_change_window_attributes(globalconf.connection, globalconf.screen->root, XCB_CW_EVENT_MASK, ROOT_WINDOW_EVENT_MASK); xutil_ungrab_server(globalconf.connection); /* Do this now so that we don't get any events for the above * (Else, reparent could cause an UnmapNotify) */ xcb_change_window_attributes(globalconf.connection, w, XCB_CW_EVENT_MASK, select_input_val); /* The frame window gets the border, not the real client window */ xcb_configure_window(globalconf.connection, w, XCB_CONFIG_WINDOW_BORDER_WIDTH, (uint32_t[]) { 0 }); /* Move this window to the bottom of the stack. Without this we would force * other windows which will be above this one to redraw themselves because * this window occludes them for a tiny moment. The next stack_refresh() * will fix this up and move the window to its correct place. */ xcb_configure_window(globalconf.connection, c->frame_window, XCB_CONFIG_WINDOW_STACK_MODE, (uint32_t[]) { XCB_STACK_MODE_BELOW}); /* Duplicate client and push it in client list */ lua_pushvalue(L, -1); client_array_push(&globalconf.clients, luaA_object_ref(L, -1)); /* Set the right screen */ screen_client_moveto(c, screen_getbycoord(wgeom->x, wgeom->y), false); /* Store initial geometry and emits signals so we inform that geometry have * been set. */ c->geometry.x = wgeom->x; c->geometry.y = wgeom->y; c->geometry.width = wgeom->width; c->geometry.height = wgeom->height; luaA_object_emit_signal(L, -1, "property::x", 0); luaA_object_emit_signal(L, -1, "property::y", 0); luaA_object_emit_signal(L, -1, "property::width", 0); luaA_object_emit_signal(L, -1, "property::height", 0); luaA_object_emit_signal(L, -1, "property::window", 0); luaA_object_emit_signal(L, -1, "property::geometry", 0); /* Set border width */ window_set_border_width(L, -1, wgeom->border_width); /* we honor size hints by default */ c->size_hints_honor = true; luaA_object_emit_signal(L, -1, "property::size_hints_honor", 0); /* update all properties */ client_update_properties(L, -1, c); /* check if this is a TRANSIENT_FOR of another client */ foreach(oc, globalconf.clients) if ((*oc)->transient_for_window == w) client_find_transient_for(*oc); /* Put the window in normal state. */ xwindow_set_state(c->window, XCB_ICCCM_WM_STATE_NORMAL); /* Then check clients hints */ ewmh_client_check_hints(c); /* Push client in stack */ stack_client_push(c); /* Request our response */ xcb_get_property_reply_t *reply = xcb_get_property_reply(globalconf.connection, startup_id_q, NULL); /* Say spawn that a client has been started, with startup id as argument */ char *startup_id = xutil_get_text_property_from_reply(reply); p_delete(&reply); if (startup_id == NULL && c->leader_window != XCB_NONE) { /* GTK hides this property elsewhere. No idea why. */ startup_id_q = xcb_get_property(globalconf.connection, false, c->leader_window, _NET_STARTUP_ID, XCB_GET_PROPERTY_TYPE_ANY, 0, UINT_MAX); reply = xcb_get_property_reply(globalconf.connection, startup_id_q, NULL); startup_id = xutil_get_text_property_from_reply(reply); p_delete(&reply); } c->startup_id = startup_id; spawn_start_notify(c, startup_id); luaA_class_emit_signal(L, &client_class, "list", 0); /* Add the context */ if (globalconf.loop == NULL) lua_pushstring(L, "startup"); else lua_pushstring(L, "new"); /* Hints */ lua_newtable(L); /* client is still on top of the stack; emit signal */ luaA_object_emit_signal(L, -3, "request::manage", 2); /*TODO v6: remove this*/ luaA_object_emit_signal(L, -1, "manage", 0); xcb_generic_error_t *error = xcb_request_check(globalconf.connection, reparent_cookie); if (error != NULL) { warn("Failed to manage window with name '%s', class '%s', instance '%s', because reparenting failed.", NONULL(c->name), NONULL(c->class), NONULL(c->instance)); event_handle((xcb_generic_event_t *) error); p_delete(&error); client_unmanage(c, CLIENT_UNMANAGE_FAILED); } /* pop client */ lua_pop(L, 1); } static void client_remove_titlebar_geometry(client_t *c, area_t *geometry) { geometry->x += c->titlebar[CLIENT_TITLEBAR_LEFT].size; geometry->y += c->titlebar[CLIENT_TITLEBAR_TOP].size; geometry->width -= c->titlebar[CLIENT_TITLEBAR_LEFT].size; geometry->width -= c->titlebar[CLIENT_TITLEBAR_RIGHT].size; geometry->height -= c->titlebar[CLIENT_TITLEBAR_TOP].size; geometry->height -= c->titlebar[CLIENT_TITLEBAR_BOTTOM].size; } static void client_add_titlebar_geometry(client_t *c, area_t *geometry) { geometry->x -= c->titlebar[CLIENT_TITLEBAR_LEFT].size; geometry->y -= c->titlebar[CLIENT_TITLEBAR_TOP].size; geometry->width += c->titlebar[CLIENT_TITLEBAR_LEFT].size; geometry->width += c->titlebar[CLIENT_TITLEBAR_RIGHT].size; geometry->height += c->titlebar[CLIENT_TITLEBAR_TOP].size; geometry->height += c->titlebar[CLIENT_TITLEBAR_BOTTOM].size; } area_t client_get_undecorated_geometry(client_t *c) { area_t geometry = c->geometry; if (!c->fullscreen) { int diff_left = c->titlebar[CLIENT_TITLEBAR_LEFT].size; int diff_right = c->titlebar[CLIENT_TITLEBAR_RIGHT].size; int diff_top = c->titlebar[CLIENT_TITLEBAR_TOP].size; int diff_bottom = c->titlebar[CLIENT_TITLEBAR_BOTTOM].size; geometry.width -= diff_left + diff_right; geometry.height -= diff_top + diff_bottom; if (c->size_hints.flags & XCB_ICCCM_SIZE_HINT_P_WIN_GRAVITY) { xwindow_translate_for_gravity(c->size_hints.win_gravity, -diff_left - c->border_width, -diff_top - c->border_width, -diff_right - c->border_width, -diff_bottom - c->border_width, &geometry.x, &geometry.y); } } return geometry; } /** Send a synthetic configure event to a window. */ void client_send_configure(client_t *c) { area_t geometry = c->geometry; if (!c->fullscreen) client_remove_titlebar_geometry(c, &geometry); xwindow_configure(c->window, geometry, c->border_width); } /** Apply size hints to the client's new geometry. */ static area_t client_apply_size_hints(client_t *c, area_t geometry) { int32_t minw = 0, minh = 0; int32_t basew = 0, baseh = 0, real_basew = 0, real_baseh = 0; if (c->fullscreen) return geometry; /* Size hints are applied to the window without any decoration */ client_remove_titlebar_geometry(c, &geometry); if(c->size_hints.flags & XCB_ICCCM_SIZE_HINT_BASE_SIZE) { basew = c->size_hints.base_width; baseh = c->size_hints.base_height; real_basew = basew; real_baseh = baseh; } else if(c->size_hints.flags & XCB_ICCCM_SIZE_HINT_P_MIN_SIZE) { /* base size is substituted with min size if not specified */ basew = c->size_hints.min_width; baseh = c->size_hints.min_height; } if(c->size_hints.flags & XCB_ICCCM_SIZE_HINT_P_MIN_SIZE) { minw = c->size_hints.min_width; minh = c->size_hints.min_height; } else if(c->size_hints.flags & XCB_ICCCM_SIZE_HINT_BASE_SIZE) { /* min size is substituted with base size if not specified */ minw = c->size_hints.base_width; minh = c->size_hints.base_height; } /* Handle the size aspect ratio */ if(c->size_hints.flags & XCB_ICCCM_SIZE_HINT_P_ASPECT && c->size_hints.min_aspect_den > 0 && c->size_hints.max_aspect_den > 0 && geometry.height > real_baseh && geometry.width > real_basew) { /* ICCCM mandates: * If a base size is provided along with the aspect ratio fields, the base size should be subtracted from the * window size prior to checking that the aspect ratio falls in range. If a base size is not provided, nothing * should be subtracted from the window size. (The minimum size is not to be used in place of the base size for * this purpose.) */ double dx = geometry.width - real_basew; double dy = geometry.height - real_baseh; double ratio = dx / dy; double min = c->size_hints.min_aspect_num / (double) c->size_hints.min_aspect_den; double max = c->size_hints.max_aspect_num / (double) c->size_hints.max_aspect_den; if(max > 0 && min > 0 && ratio > 0) { if(ratio < min) { /* dx is lower than allowed, make dy lower to compensate this (+ 0.5 to force proper rounding). */ dy = dx / min + 0.5; geometry.width = dx + real_basew; geometry.height = dy + real_baseh; } else if(ratio > max) { /* dx is too high, lower it (+0.5 for proper rounding) */ dx = dy * max + 0.5; geometry.width = dx + real_basew; geometry.height = dy + real_baseh; } } } /* Handle the minimum size */ geometry.width = MAX(geometry.width, minw); geometry.height = MAX(geometry.height, minh); /* Handle the maximum size */ if(c->size_hints.flags & XCB_ICCCM_SIZE_HINT_P_MAX_SIZE) { if(c->size_hints.max_width) geometry.width = MIN(geometry.width, c->size_hints.max_width); if(c->size_hints.max_height) geometry.height = MIN(geometry.height, c->size_hints.max_height); } /* Handle the size increment */ if(c->size_hints.flags & (XCB_ICCCM_SIZE_HINT_P_RESIZE_INC | XCB_ICCCM_SIZE_HINT_BASE_SIZE) && c->size_hints.width_inc && c->size_hints.height_inc) { uint16_t t1 = geometry.width, t2 = geometry.height; unsigned_subtract(t1, basew); unsigned_subtract(t2, baseh); geometry.width -= t1 % c->size_hints.width_inc; geometry.height -= t2 % c->size_hints.height_inc; } client_add_titlebar_geometry(c, &geometry); return geometry; } static void client_resize_do(client_t *c, area_t geometry) { lua_State *L = globalconf_get_lua_State(); screen_t *new_screen = c->screen; if(!screen_area_in_screen(new_screen, geometry)) new_screen = screen_getbycoord(geometry.x, geometry.y); /* Also store geometry including border */ area_t old_geometry = c->geometry; c->geometry = geometry; luaA_object_push(L, c); if (!AREA_EQUAL(old_geometry, geometry)) luaA_object_emit_signal(L, -1, "property::geometry", 0); if (old_geometry.x != geometry.x || old_geometry.y != geometry.y) { luaA_object_emit_signal(L, -1, "property::position", 0); if (old_geometry.x != geometry.x) luaA_object_emit_signal(L, -1, "property::x", 0); if (old_geometry.y != geometry.y) luaA_object_emit_signal(L, -1, "property::y", 0); } if (old_geometry.width != geometry.width || old_geometry.height != geometry.height) { luaA_object_emit_signal(L, -1, "property::size", 0); if (old_geometry.width != geometry.width) luaA_object_emit_signal(L, -1, "property::width", 0); if (old_geometry.height != geometry.height) luaA_object_emit_signal(L, -1, "property::height", 0); } lua_pop(L, 1); screen_client_moveto(c, new_screen, false); /* Update all titlebars */ for (client_titlebar_t bar = CLIENT_TITLEBAR_TOP; bar < CLIENT_TITLEBAR_COUNT; bar++) { if (c->titlebar[bar].drawable == NULL && c->titlebar[bar].size == 0) continue; luaA_object_push(L, c); drawable_t *drawable = titlebar_get_drawable(L, c, -1, bar); luaA_object_push_item(L, -1, drawable); area_t area = titlebar_get_area(c, bar); /* Convert to global coordinates */ area.x += geometry.x; area.y += geometry.y; if (c->fullscreen) area.width = area.height = 0; drawable_set_geometry(L, -1, area); /* Pop the client and the drawable */ lua_pop(L, 2); } } /** Resize client window. * The sizes given as parameters are with borders! * \param c Client to resize. * \param geometry New window geometry. * \param honor_hints Use size hints. * \return true if an actual resize occurred. */ bool client_resize(client_t *c, area_t geometry, bool honor_hints) { if (honor_hints) { /* We could get integer underflows in client_remove_titlebar_geometry() * without these checks here. */ if(geometry.width < c->titlebar[CLIENT_TITLEBAR_LEFT].size + c->titlebar[CLIENT_TITLEBAR_RIGHT].size) return false; if(geometry.height < c->titlebar[CLIENT_TITLEBAR_TOP].size + c->titlebar[CLIENT_TITLEBAR_BOTTOM].size) return false; geometry = client_apply_size_hints(c, geometry); } if(geometry.width < c->titlebar[CLIENT_TITLEBAR_LEFT].size + c->titlebar[CLIENT_TITLEBAR_RIGHT].size) return false; if(geometry.height < c->titlebar[CLIENT_TITLEBAR_TOP].size + c->titlebar[CLIENT_TITLEBAR_BOTTOM].size) return false; if(geometry.width == 0 || geometry.height == 0) return false; if(!AREA_EQUAL(c->geometry, geometry)) { client_resize_do(c, geometry); return true; } return false; } /** Set a client minimized, or not. * \param L The Lua VM state. * \param cidx The client index. * \param s Set or not the client minimized. */ void client_set_minimized(lua_State *L, int cidx, bool s) { client_t *c = luaA_checkudata(L, cidx, &client_class); if(c->minimized != s) { c->minimized = s; banning_need_update(); if(s) { /* ICCCM: To transition from ICONIC to NORMAL state, the client * should just map the window. Thus, iconic clients need to be * unmapped, else the MapWindow request doesn't have any effect. */ xwindow_set_state(c->window, XCB_ICCCM_WM_STATE_ICONIC); uint32_t no_event[] = { 0 }; const uint32_t client_select_input_val[] = { CLIENT_SELECT_INPUT_EVENT_MASK }; const uint32_t frame_select_input_val[] = { FRAME_SELECT_INPUT_EVENT_MASK }; xcb_grab_server(globalconf.connection); xcb_change_window_attributes(globalconf.connection, globalconf.screen->root, XCB_CW_EVENT_MASK, no_event); xcb_change_window_attributes(globalconf.connection, c->frame_window, XCB_CW_EVENT_MASK, no_event); xcb_change_window_attributes(globalconf.connection, c->window, XCB_CW_EVENT_MASK, no_event); xcb_unmap_window(globalconf.connection, c->window); xcb_change_window_attributes(globalconf.connection, globalconf.screen->root, XCB_CW_EVENT_MASK, ROOT_WINDOW_EVENT_MASK); xcb_change_window_attributes(globalconf.connection, c->frame_window, XCB_CW_EVENT_MASK, frame_select_input_val); xcb_change_window_attributes(globalconf.connection, c->window, XCB_CW_EVENT_MASK, client_select_input_val); xutil_ungrab_server(globalconf.connection); } else { xwindow_set_state(c->window, XCB_ICCCM_WM_STATE_NORMAL); xcb_map_window(globalconf.connection, c->window); } if(strut_has_value(&c->strut)) screen_update_workarea(c->screen); luaA_object_emit_signal(L, cidx, "property::minimized", 0); } } /** Set a client hidden, or not. * \param L The Lua VM state. * \param cidx The client index. * \param s Set or not the client hidden. */ static void client_set_hidden(lua_State *L, int cidx, bool s) { client_t *c = luaA_checkudata(L, cidx, &client_class); if(c->hidden != s) { c->hidden = s; banning_need_update(); if(strut_has_value(&c->strut)) screen_update_workarea(c->screen); luaA_object_emit_signal(L, cidx, "property::hidden", 0); } } /** Set a client sticky, or not. * \param L The Lua VM state. * \param cidx The client index. * \param s Set or not the client sticky. */ void client_set_sticky(lua_State *L, int cidx, bool s) { client_t *c = luaA_checkudata(L, cidx, &client_class); if(c->sticky != s) { c->sticky = s; banning_need_update(); ewmh_client_update_desktop(c); if(strut_has_value(&c->strut)) screen_update_workarea(c->screen); luaA_object_emit_signal(L, cidx, "property::sticky", 0); } } /** Set a client focusable, or not. * \param L The Lua VM state. * \param cidx The client index. * \param s Set or not the client's focusable property. */ static void client_set_focusable(lua_State *L, int cidx, bool s) { client_t *c = luaA_checkudata(L, cidx, &client_class); if(c->focusable != s || !c->focusable_set) { c->focusable = s; c->focusable_set = true; luaA_object_emit_signal(L, cidx, "property::focusable", 0); } } /** Unset a client's focusable property and make it use the default again. * \param L The Lua VM state. * \param cidx The client index. */ static void client_unset_focusable(lua_State *L, int cidx) { client_t *c = luaA_checkudata(L, cidx, &client_class); if(c->focusable_set) { c->focusable_set = false; luaA_object_emit_signal(L, cidx, "property::focusable", 0); } } /** Set a client fullscreen, or not. * \param L The Lua VM state. * \param cidx The client index. * \param s Set or not the client fullscreen. */ void client_set_fullscreen(lua_State *L, int cidx, bool s) { client_t *c = luaA_checkudata(L, cidx, &client_class); if(c->fullscreen != s) { /* become fullscreen! */ if(s) { /* You can only be part of one of the special layers. */ client_set_below(L, cidx, false); client_set_above(L, cidx, false); client_set_ontop(L, cidx, false); } int abs_cidx = luaA_absindex(L, cidx); \ lua_pushstring(L, "fullscreen"); c->fullscreen = s; luaA_object_emit_signal(L, abs_cidx, "request::geometry", 1); luaA_object_emit_signal(L, abs_cidx, "property::fullscreen", 0); /* Force a client resize, so that titlebars get shown/hidden */ client_resize_do(c, c->geometry); stack_windows(); } } /** Set a client horizontally|vertically maximized. * \param L The Lua VM state. * \param cidx The client index. * \param s The maximized status. */ void client_set_maximized_common(lua_State *L, int cidx, bool s, const char* type, const int val) { client_t *c = luaA_checkudata(L, cidx, &client_class); /* Store the current and next state on 2 bit */ const client_maximized_t current = ( (c->maximized_vertical ? CLIENT_MAXIMIZED_V : CLIENT_MAXIMIZED_NONE)| (c->maximized_horizontal ? CLIENT_MAXIMIZED_H : CLIENT_MAXIMIZED_NONE)| (c->maximized ? CLIENT_MAXIMIZED_BOTH : CLIENT_MAXIMIZED_NONE) ); client_maximized_t next = s ? (val | current) : (current & (~val)); /* When both are already set during startup, assume `maximized` is true*/ if (next == (CLIENT_MAXIMIZED_H|CLIENT_MAXIMIZED_V) && !globalconf.loop) next = CLIENT_MAXIMIZED_BOTH; if(current != next) { int abs_cidx = luaA_absindex(L, cidx); int max_before = c->maximized; int h_before = c->maximized_horizontal; int v_before = c->maximized_vertical; /*Update the client properties */ c->maximized_horizontal = !!(next & CLIENT_MAXIMIZED_H ); c->maximized_vertical = !!(next & CLIENT_MAXIMIZED_V ); c->maximized = !!(next & CLIENT_MAXIMIZED_BOTH); /* Request the changes to be applied */ lua_pushstring(L, type); luaA_object_emit_signal(L, abs_cidx, "request::geometry", 1); /* Notify changes in the relevant properties */ if (h_before != c->maximized_horizontal) luaA_object_emit_signal(L, abs_cidx, "property::maximized_horizontal", 0); if (v_before != c->maximized_vertical) luaA_object_emit_signal(L, abs_cidx, "property::maximized_vertical", 0); if(max_before != c->maximized) luaA_object_emit_signal(L, abs_cidx, "property::maximized", 0); stack_windows(); } } void client_set_maximized(lua_State *L, int cidx, bool s) { return client_set_maximized_common( L, cidx, s, "maximized", CLIENT_MAXIMIZED_BOTH ); } void client_set_maximized_horizontal(lua_State *L, int cidx, bool s) { return client_set_maximized_common( L, cidx, s, "maximized_horizontal", CLIENT_MAXIMIZED_H ); } void client_set_maximized_vertical(lua_State *L, int cidx, bool s) { return client_set_maximized_common( L, cidx, s, "maximized_vertical", CLIENT_MAXIMIZED_V ); } /** Set a client above, or not. * \param L The Lua VM state. * \param cidx The client index. * \param s Set or not the client above. */ void client_set_above(lua_State *L, int cidx, bool s) { client_t *c = luaA_checkudata(L, cidx, &client_class); if(c->above != s) { /* You can only be part of one of the special layers. */ if(s) { client_set_below(L, cidx, false); client_set_ontop(L, cidx, false); client_set_fullscreen(L, cidx, false); } c->above = s; stack_windows(); luaA_object_emit_signal(L, cidx, "property::above", 0); } } /** Set a client below, or not. * \param L The Lua VM state. * \param cidx The client index. * \param s Set or not the client below. */ void client_set_below(lua_State *L, int cidx, bool s) { client_t *c = luaA_checkudata(L, cidx, &client_class); if(c->below != s) { /* You can only be part of one of the special layers. */ if(s) { client_set_above(L, cidx, false); client_set_ontop(L, cidx, false); client_set_fullscreen(L, cidx, false); } c->below = s; stack_windows(); luaA_object_emit_signal(L, cidx, "property::below", 0); } } /** Set a client modal, or not. * \param L The Lua VM state. * \param cidx The client index. * \param s Set or not the client modal attribute. */ void client_set_modal(lua_State *L, int cidx, bool s) { client_t *c = luaA_checkudata(L, cidx, &client_class); if(c->modal != s) { c->modal = s; stack_windows(); luaA_object_emit_signal(L, cidx, "property::modal", 0); } } /** Set a client ontop, or not. * \param L The Lua VM state. * \param cidx The client index. * \param s Set or not the client ontop attribute. */ void client_set_ontop(lua_State *L, int cidx, bool s) { client_t *c = luaA_checkudata(L, cidx, &client_class); if(c->ontop != s) { /* You can only be part of one of the special layers. */ if(s) { client_set_above(L, cidx, false); client_set_below(L, cidx, false); client_set_fullscreen(L, cidx, false); } c->ontop = s; stack_windows(); luaA_object_emit_signal(L, cidx, "property::ontop", 0); } } /** Unban a client and move it back into the viewport. * \param c The client. */ void client_unban(client_t *c) { lua_State *L = globalconf_get_lua_State(); if(c->isbanned) { client_ignore_enterleave_events(); xcb_map_window(globalconf.connection, c->frame_window); client_restore_enterleave_events(); c->isbanned = false; /* An unbanned client shouldn't be minimized or hidden */ luaA_object_push(L, c); client_set_minimized(L, -1, false); client_set_hidden(L, -1, false); lua_pop(L, 1); if (globalconf.focus.client == c) globalconf.focus.need_update = true; } } /** Unmanage a client. * \param c The client. * \param reason Why was the unmanage done. */ void client_unmanage(client_t *c, client_unmanage_t reason) { lua_State *L = globalconf_get_lua_State(); /* Reset transient_for attributes of windows that might be referring to us */ foreach(_tc, globalconf.clients) { client_t *tc = *_tc; if(tc->transient_for == c) tc->transient_for = NULL; } if(globalconf.focus.client == c) client_unfocus(c); /* remove client from global list and everywhere else */ foreach(elem, globalconf.clients) if(*elem == c) { client_array_remove(&globalconf.clients, elem); break; } stack_client_remove(c); for(int i = 0; i < globalconf.tags.len; i++) untag_client(c, globalconf.tags.tab[i]); luaA_object_push(L, c); /* Give the context to Lua */ switch (reason) { break; case CLIENT_UNMANAGE_USER: lua_pushstring(L, "user"); break; case CLIENT_UNMANAGE_REPARENT: lua_pushstring(L, "reparented"); break; case CLIENT_UNMANAGE_UNMAP: case CLIENT_UNMANAGE_FAILED: case CLIENT_UNMANAGE_DESTROYED: lua_pushstring(L, "destroyed"); break; } /* Hints */ lua_newtable(L); luaA_object_emit_signal(L, -3, "request::unmanage", 2); luaA_object_emit_signal(L, -1, "unmanage", 0); lua_pop(L, 1); luaA_class_emit_signal(L, &client_class, "list", 0); if(strut_has_value(&c->strut)) screen_update_workarea(c->screen); /* Get rid of all titlebars */ for (client_titlebar_t bar = CLIENT_TITLEBAR_TOP; bar < CLIENT_TITLEBAR_COUNT; bar++) { if (c->titlebar[bar].drawable == NULL) continue; if (globalconf.drawable_under_mouse == c->titlebar[bar].drawable) { /* Leave drawable before we invalidate the client */ lua_pushnil(L); event_drawable_under_mouse(L, -1); lua_pop(L, 1); } /* Forget about the drawable */ luaA_object_push(L, c); luaA_object_unref_item(L, -1, c->titlebar[bar].drawable); c->titlebar[bar].drawable = NULL; lua_pop(L, 1); } /* Clear our event mask so that we don't receive any events from now on, * especially not for the following requests. */ if(reason != CLIENT_UNMANAGE_DESTROYED) xcb_change_window_attributes(globalconf.connection, c->window, XCB_CW_EVENT_MASK, (const uint32_t []) { 0 }); xcb_change_window_attributes(globalconf.connection, c->frame_window, XCB_CW_EVENT_MASK, (const uint32_t []) { 0 }); if(reason != CLIENT_UNMANAGE_DESTROYED) { area_t geometry = client_get_undecorated_geometry(c); xcb_unmap_window(globalconf.connection, c->window); xcb_reparent_window(globalconf.connection, c->window, globalconf.screen->root, geometry.x, geometry.y); } if (c->nofocus_window != XCB_NONE) window_array_append(&globalconf.destroy_later_windows, c->nofocus_window); window_array_append(&globalconf.destroy_later_windows, c->frame_window); if(reason != CLIENT_UNMANAGE_DESTROYED) { /* Remove this window from the save set since this shouldn't be made visible * after a restart anymore. */ xcb_change_save_set(globalconf.connection, XCB_SET_MODE_DELETE, c->window); if (globalconf.have_shape) xcb_shape_select_input(globalconf.connection, c->window, 0); /* Do this last to avoid races with clients. According to ICCCM, clients * arent allowed to re-use the window until after this. */ xwindow_set_state(c->window, XCB_ICCCM_WM_STATE_WITHDRAWN); } /* set client as invalid */ c->window = XCB_NONE; luaA_object_unref(L, c); } /** Kill a client via a WM_DELETE_WINDOW request or KillClient if not * supported. * \param c The client to kill. */ void client_kill(client_t *c) { if(client_hasproto(c, WM_DELETE_WINDOW)) { xcb_client_message_event_t ev; /* Initialize all of event's fields first */ p_clear(&ev, 1); ev.response_type = XCB_CLIENT_MESSAGE; ev.window = c->window; ev.format = 32; ev.data.data32[1] = globalconf.timestamp; ev.type = WM_PROTOCOLS; ev.data.data32[0] = WM_DELETE_WINDOW; xcb_send_event(globalconf.connection, false, c->window, XCB_EVENT_MASK_NO_EVENT, (char *) &ev); } else xcb_kill_client(globalconf.connection, c->window); } /** Get all clients into a table. * * @tparam[opt] integer|screen screen A screen number to filter clients on. * @tparam[opt] boolean stacked Return clients in stacking order? (ordered from * top to bottom). * @treturn table A table with clients. * @staticfct get * @usage for _, c in ipairs(client.get()) do * -- do something * end */ static int luaA_client_get(lua_State *L) { int i = 1; screen_t *screen = NULL; bool stacked = false; if(!lua_isnoneornil(L, 1)) screen = luaA_checkscreen(L, 1); if(!lua_isnoneornil(L, 2)) stacked = luaA_checkboolean(L, 2); lua_newtable(L); if(stacked) { foreach_reverse(c, globalconf.stack) if(screen == NULL || (*c)->screen == screen) { luaA_object_push(L, *c); lua_rawseti(L, -2, i++); } } else { foreach(c, globalconf.clients) if(screen == NULL || (*c)->screen == screen) { luaA_object_push(L, *c); lua_rawseti(L, -2, i++); } } return 1; } /** Check if a client is visible on its screen. * * @treturn boolean A boolean value, true if the client is visible, false otherwise. * @method isvisible */ static int luaA_client_isvisible(lua_State *L) { client_t *c = luaA_checkudata(L, 1, &client_class); lua_pushboolean(L, client_isvisible(c)); return 1; } /** Set client icons. * \param L The Lua VM state. * \param array Array of icons to set. */ void client_set_icons(client_t *c, cairo_surface_array_t array) { cairo_surface_array_wipe(&c->icons); c->icons = array; lua_State *L = globalconf_get_lua_State(); luaA_object_push(L, c); luaA_object_emit_signal(L, -1, "property::icon", 0); luaA_object_emit_signal(L, -1, "property::icon_sizes", 0); lua_pop(L, 1); } /** Set a client icon. * \param L The Lua VM state. * \param cidx The client index on the stack. * \param iidx The image index on the stack. */ static void client_set_icon(client_t *c, cairo_surface_t *s) { cairo_surface_array_t array; cairo_surface_array_init(&array); if (s && cairo_surface_status(s) == CAIRO_STATUS_SUCCESS) cairo_surface_array_push(&array, draw_dup_image_surface(s)); client_set_icons(c, array); } /** Set a client icon. * \param c The client to change. * \param icon A bitmap containing the icon. * \param mask A mask for the bitmap (optional) */ void client_set_icon_from_pixmaps(client_t *c, xcb_pixmap_t icon, xcb_pixmap_t mask) { xcb_get_geometry_cookie_t geom_icon_c, geom_mask_c; xcb_get_geometry_reply_t *geom_icon_r, *geom_mask_r = NULL; cairo_surface_t *s_icon, *result; geom_icon_c = xcb_get_geometry_unchecked(globalconf.connection, icon); if (mask) geom_mask_c = xcb_get_geometry_unchecked(globalconf.connection, mask); geom_icon_r = xcb_get_geometry_reply(globalconf.connection, geom_icon_c, NULL); if (mask) geom_mask_r = xcb_get_geometry_reply(globalconf.connection, geom_mask_c, NULL); if (!geom_icon_r || (mask && !geom_mask_r)) goto out; if ((geom_icon_r->depth != 1 && geom_icon_r->depth != globalconf.screen->root_depth) || (geom_mask_r && geom_mask_r->depth != 1)) { warn("Got pixmaps with depth (%d, %d) while processing icon, but only depth 1 and %d are allowed", geom_icon_r->depth, geom_mask_r ? geom_mask_r->depth : 0, globalconf.screen->root_depth); goto out; } if (geom_icon_r->depth == 1) s_icon = cairo_xcb_surface_create_for_bitmap(globalconf.connection, globalconf.screen, icon, geom_icon_r->width, geom_icon_r->height); else s_icon = cairo_xcb_surface_create(globalconf.connection, icon, globalconf.default_visual, geom_icon_r->width, geom_icon_r->height); result = s_icon; if (mask) { cairo_surface_t *s_mask; cairo_t *cr; result = cairo_surface_create_similar(s_icon, CAIRO_CONTENT_COLOR_ALPHA, geom_icon_r->width, geom_icon_r->height); s_mask = cairo_xcb_surface_create_for_bitmap(globalconf.connection, globalconf.screen, mask, geom_icon_r->width, geom_icon_r->height); cr = cairo_create(result); cairo_set_source_surface(cr, s_icon, 0, 0); cairo_mask_surface(cr, s_mask, 0, 0); cairo_surface_destroy(s_mask); cairo_destroy(cr); } client_set_icon(c, result); cairo_surface_destroy(result); if (result != s_icon) cairo_surface_destroy(s_icon); out: p_delete(&geom_icon_r); p_delete(&geom_mask_r); } /** Kill a client. * * This method can be used to close (kill) a **client** using the * X11 protocol. To use the POSIX way to kill a **process**, use * `awesome.kill` (using the client `pid` property). * * @DOC_sequences_client_kill1_EXAMPLE@ * * @method kill * @see awesome.kill */ static int luaA_client_kill(lua_State *L) { client_t *c = luaA_checkudata(L, 1, &client_class); client_kill(c); return 0; } /** Swap a client with another one in global client list. * * @DOC_sequences_client_swap1_EXAMPLE@ * * @tparam client c A client to swap with. * @method swap * @emits swapped * @emitstparam swapped client other The other client. * @emitstparam swapped boolean is_origin `true` when `:swap()` was called * on *self* rather than the other client. `false` when * `:swap()` was called on the other client. * @emits list * @see swapped * @see awful.client.swap.bydirection * @see awful.client.swap.global_bydirection * @see awful.client.swap.byidx * @see awful.client.cycle */ static int luaA_client_swap(lua_State *L) { client_t *c = luaA_checkudata(L, 1, &client_class); client_t *swap = luaA_checkudata(L, 2, &client_class); if(c != swap) { client_t **ref_c = NULL, **ref_swap = NULL; foreach(item, globalconf.clients) { if(*item == c) ref_c = item; else if(*item == swap) ref_swap = item; if(ref_c && ref_swap) break; } /* swap ! */ *ref_c = swap; *ref_swap = c; luaA_class_emit_signal(L, &client_class, "list", 0); luaA_object_push(L, swap); lua_pushboolean(L, true); luaA_object_emit_signal(L, -4, "swapped", 2); luaA_object_push(L, swap); luaA_object_push(L, c); lua_pushboolean(L, false); luaA_object_emit_signal(L, -3, "swapped", 2); } return 0; } /** Access or set the client tags. * * Use the `first_tag` field to access the first tag of a client directly. * * @DOC_sequences_client_tags1_EXAMPLE@ * * @tparam table tags_table A table with tags to set, or `nil` to get the * current tags. * @treturn table A table with all tags. * @method tags * @emits property::tags * @see first_tag * @see toggle_tag */ static int luaA_client_tags(lua_State *L) { client_t *c = luaA_checkudata(L, 1, &client_class); int j = 0; if(lua_gettop(L) == 2) { luaA_checktable(L, 2); for(int i = 0; i < globalconf.tags.len; i++) { /* Only untag if we aren't going to add this tag again */ bool found = false; lua_pushnil(L); while(lua_next(L, 2)) { tag_t *t = lua_touserdata(L, -1); /* Pop the value from lua_next */ lua_pop(L, 1); if (t != globalconf.tags.tab[i]) continue; /* Pop the key from lua_next */ lua_pop(L, 1); found = true; break; } if(!found) untag_client(c, globalconf.tags.tab[i]); } lua_pushnil(L); while(lua_next(L, 2)) tag_client(L, c); lua_pop(L, 1); luaA_object_emit_signal(L, -1, "property::tags", 0); } lua_newtable(L); foreach(tag, globalconf.tags) if(is_client_tagged(c, *tag)) { luaA_object_push(L, *tag); lua_rawseti(L, -2, ++j); } return 1; } /** Get the first tag of a client. */ static int luaA_client_get_first_tag(lua_State *L, client_t *c) { foreach(tag, globalconf.tags) if(is_client_tagged(c, *tag)) { luaA_object_push(L, *tag); return 1; } return 0; } /** Raise a client on top of others which are on the same layer. * * @method raise * @emits raised * @see above * @see below * @see ontop * @see lower */ static int luaA_client_raise(lua_State *L) { client_t *c = luaA_checkudata(L, 1, &client_class); /* Avoid sending the signal if nothing was done */ if (c->transient_for == NULL && globalconf.stack.len && globalconf.stack.tab[globalconf.stack.len-1] == c ) return 0; client_raise(c); return 0; } /** Lower a client on bottom of others which are on the same layer. * * @method lower * @emits lowered * @see above * @see below * @see ontop * @see raise */ static int luaA_client_lower(lua_State *L) { client_t *c = luaA_checkudata(L, 1, &client_class); /* Avoid sending the signal if nothing was done */ if (globalconf.stack.len && globalconf.stack.tab[0] == c) return 0; stack_client_push(c); /* Traverse all transient layers. */ for(client_t *tc = c->transient_for; tc; tc = tc->transient_for) stack_client_push(tc); /* Notify the listeners */ luaA_object_push(L, c); luaA_object_emit_signal(L, -1, "lowered", 0); lua_pop(L, 1); return 0; } /** Stop managing a client. * * @method unmanage */ static int luaA_client_unmanage(lua_State *L) { client_t *c = luaA_checkudata(L, 1, &client_class); client_unmanage(c, CLIENT_UNMANAGE_USER); return 0; } static area_t titlebar_get_area(client_t *c, client_titlebar_t bar) { area_t result = c->geometry; result.x = result.y = 0; // Let's try some ascii art: // --------------------------- // | Top | // |-------------------------| // |L| |R| // |e| |i| // |f| |g| // |t| |h| // | | |t| // |-------------------------| // | Bottom | // --------------------------- switch (bar) { case CLIENT_TITLEBAR_BOTTOM: result.y = c->geometry.height - c->titlebar[bar].size; /* Fall through */ case CLIENT_TITLEBAR_TOP: result.height = c->titlebar[bar].size; break; case CLIENT_TITLEBAR_RIGHT: result.x = c->geometry.width - c->titlebar[bar].size; /* Fall through */ case CLIENT_TITLEBAR_LEFT: result.y = c->titlebar[CLIENT_TITLEBAR_TOP].size; result.width = c->titlebar[bar].size; result.height -= c->titlebar[CLIENT_TITLEBAR_TOP].size; result.height -= c->titlebar[CLIENT_TITLEBAR_BOTTOM].size; break; default: fatal("Unknown titlebar kind %d\n", (int) bar); } return result; } drawable_t * client_get_drawable_offset(client_t *c, int *x, int *y) { for (client_titlebar_t bar = CLIENT_TITLEBAR_TOP; bar < CLIENT_TITLEBAR_COUNT; bar++) { area_t area = titlebar_get_area(c, bar); if (AREA_LEFT(area) > *x || AREA_RIGHT(area) <= *x) continue; if (AREA_TOP(area) > *y || AREA_BOTTOM(area) <= *y) continue; *x -= area.x; *y -= area.y; return c->titlebar[bar].drawable; } return NULL; } drawable_t * client_get_drawable(client_t *c, int x, int y) { return client_get_drawable_offset(c, &x, &y); } static void client_refresh_titlebar_partial(client_t *c, client_titlebar_t bar, int16_t x, int16_t y, uint16_t width, uint16_t height) { if(c->titlebar[bar].drawable == NULL || c->titlebar[bar].drawable->pixmap == XCB_NONE || !c->titlebar[bar].drawable->refreshed) return; /* Is the titlebar part of the area that should get redrawn? */ area_t area = titlebar_get_area(c, bar); if (AREA_LEFT(area) >= x + width || AREA_RIGHT(area) <= x) return; if (AREA_TOP(area) >= y + height || AREA_BOTTOM(area) <= y) return; /* Redraw the affected parts */ cairo_surface_flush(c->titlebar[bar].drawable->surface); xcb_copy_area(globalconf.connection, c->titlebar[bar].drawable->pixmap, c->frame_window, globalconf.gc, x - area.x, y - area.y, x, y, width, height); } #define HANDLE_TITLEBAR_REFRESH(name, index) \ static void \ client_refresh_titlebar_ ## name(client_t *c) \ { \ area_t area = titlebar_get_area(c, index); \ client_refresh_titlebar_partial(c, index, area.x, area.y, area.width, area.height); \ } HANDLE_TITLEBAR_REFRESH(top, CLIENT_TITLEBAR_TOP) HANDLE_TITLEBAR_REFRESH(right, CLIENT_TITLEBAR_RIGHT) HANDLE_TITLEBAR_REFRESH(bottom, CLIENT_TITLEBAR_BOTTOM) HANDLE_TITLEBAR_REFRESH(left, CLIENT_TITLEBAR_LEFT) /** * Refresh all titlebars that are in the specified rectangle */ void client_refresh_partial(client_t *c, int16_t x, int16_t y, uint16_t width, uint16_t height) { for (client_titlebar_t bar = CLIENT_TITLEBAR_TOP; bar < CLIENT_TITLEBAR_COUNT; bar++) { client_refresh_titlebar_partial(c, bar, x, y, width, height); } } static drawable_t * titlebar_get_drawable(lua_State *L, client_t *c, int cl_idx, client_titlebar_t bar) { if (c->titlebar[bar].drawable == NULL) { cl_idx = luaA_absindex(L, cl_idx); switch (bar) { case CLIENT_TITLEBAR_TOP: drawable_allocator(L, (drawable_refresh_callback *) client_refresh_titlebar_top, c); break; case CLIENT_TITLEBAR_BOTTOM: drawable_allocator(L, (drawable_refresh_callback *) client_refresh_titlebar_bottom, c); break; case CLIENT_TITLEBAR_RIGHT: drawable_allocator(L, (drawable_refresh_callback *) client_refresh_titlebar_right, c); break; case CLIENT_TITLEBAR_LEFT: drawable_allocator(L, (drawable_refresh_callback *) client_refresh_titlebar_left, c); break; default: fatal("Unknown titlebar kind %d\n", (int) bar); } c->titlebar[bar].drawable = luaA_object_ref_item(L, cl_idx, -1); } return c->titlebar[bar].drawable; } static void titlebar_resize(lua_State *L, int cidx, client_t *c, client_titlebar_t bar, int size) { const char *property_name; if (size < 0) return; if (size == c->titlebar[bar].size) return; /* Now resize the client (and titlebars!) suitably (the client without * titlebars should keep its current size!) */ area_t geometry = c->geometry; int change = size - c->titlebar[bar].size; int16_t diff_top = 0, diff_bottom = 0, diff_right = 0, diff_left = 0; switch (bar) { case CLIENT_TITLEBAR_TOP: geometry.height += change; diff_top = change; property_name = "property::titlebar_top"; break; case CLIENT_TITLEBAR_BOTTOM: geometry.height += change; diff_bottom = change; property_name = "property::titlebar_bottom"; break; case CLIENT_TITLEBAR_RIGHT: geometry.width += change; diff_right = change; property_name = "property::titlebar_right"; break; case CLIENT_TITLEBAR_LEFT: geometry.width += change; diff_left = change; property_name = "property::titlebar_left"; break; default: fatal("Unknown titlebar kind %d\n", (int) bar); } if(c->size_hints.flags & XCB_ICCCM_SIZE_HINT_P_WIN_GRAVITY) { xwindow_translate_for_gravity(c->size_hints.win_gravity, diff_left, diff_top, diff_right, diff_bottom, &geometry.x, &geometry.y); } c->titlebar[bar].size = size; client_resize_do(c, geometry); luaA_object_emit_signal(L, cidx, property_name, 0); } #define HANDLE_TITLEBAR(name, index) \ static int \ luaA_client_titlebar_ ## name(lua_State *L) \ { \ client_t *c = luaA_checkudata(L, 1, &client_class); \ \ if (lua_gettop(L) == 2) \ { \ if (lua_isnil(L, 2)) \ titlebar_resize(L, 1, c, index, 0); \ else \ titlebar_resize(L, 1, c, index, ceil(luaA_checknumber_range(L, 2, 0, MAX_X11_SIZE))); \ } \ \ luaA_object_push_item(L, 1, titlebar_get_drawable(L, c, 1, index)); \ lua_pushinteger(L, c->titlebar[index].size); \ return 2; \ } HANDLE_TITLEBAR(top, CLIENT_TITLEBAR_TOP) HANDLE_TITLEBAR(right, CLIENT_TITLEBAR_RIGHT) HANDLE_TITLEBAR(bottom, CLIENT_TITLEBAR_BOTTOM) HANDLE_TITLEBAR(left, CLIENT_TITLEBAR_LEFT) /** Return or set client geometry. * * @DOC_sequences_client_geometry1_EXAMPLE@ * * @tparam table|nil geo A table with new coordinates, or nil. * @tparam integer geo.x The horizontal position. * @tparam integer geo.y The vertical position. * @tparam integer geo.width The width. * @tparam integer geo.height The height. * @treturn table A table with client geometry and coordinates. * @method geometry * @see struts * @see x * @see y * @see width * @see height */ static int luaA_client_geometry(lua_State *L) { client_t *c = luaA_checkudata(L, 1, &client_class); if(lua_gettop(L) == 2 && !lua_isnil(L, 2)) { area_t geometry; luaA_checktable(L, 2); geometry.x = round(luaA_getopt_number_range(L, 2, "x", c->geometry.x, MIN_X11_COORDINATE, MAX_X11_COORDINATE)); geometry.y = round(luaA_getopt_number_range(L, 2, "y", c->geometry.y, MIN_X11_COORDINATE, MAX_X11_COORDINATE)); if(client_isfixed(c)) { geometry.width = c->geometry.width; geometry.height = c->geometry.height; } else { geometry.width = ceil(luaA_getopt_number_range(L, 2, "width", c->geometry.width, MIN_X11_SIZE, MAX_X11_SIZE)); geometry.height = ceil(luaA_getopt_number_range(L, 2, "height", c->geometry.height, MIN_X11_SIZE, MAX_X11_SIZE)); } client_resize(c, geometry, c->size_hints_honor); } return luaA_pusharea(L, c->geometry); } /** Apply size hints to a size. * * This method applies the client size hints. The client * will be resized according to the size hints as long * as `size_hints_honor` is true. Regardless of the * status of `size_hints_honor`, this method will * return the size with the size hints applied. * * @tparam integer width Desired width of client * @tparam integer height Desired height of client * @treturn integer Actual width of client * @treturn integer Actual height of client * @method apply_size_hints * @see size_hints * @see size_hints_honor */ static int luaA_client_apply_size_hints(lua_State *L) { client_t *c = luaA_checkudata(L, 1, &client_class); area_t geometry = c->geometry; if(!client_isfixed(c)) { geometry.width = ceil(luaA_checknumber_range(L, 2, MIN_X11_SIZE, MAX_X11_SIZE)); geometry.height = ceil(luaA_checknumber_range(L, 3, MIN_X11_SIZE, MAX_X11_SIZE)); } if (c->size_hints_honor) geometry = client_apply_size_hints(c, geometry); lua_pushinteger(L, geometry.width); lua_pushinteger(L, geometry.height); return 2; } static int luaA_client_set_screen(lua_State *L, client_t *c) { screen_client_moveto(c, luaA_checkscreen(L, -1), true); return 0; } static int luaA_client_set_hidden(lua_State *L, client_t *c) { client_set_hidden(L, -3, luaA_checkboolean(L, -1)); return 0; } static int luaA_client_set_minimized(lua_State *L, client_t *c) { client_set_minimized(L, -3, luaA_checkboolean(L, -1)); return 0; } static int luaA_client_set_fullscreen(lua_State *L, client_t *c) { client_set_fullscreen(L, -3, luaA_checkboolean(L, -1)); return 0; } static int luaA_client_set_modal(lua_State *L, client_t *c) { client_set_modal(L, -3, luaA_checkboolean(L, -1)); return 0; } static int luaA_client_set_maximized(lua_State *L, client_t *c) { client_set_maximized(L, -3, luaA_checkboolean(L, -1)); return 0; } static int luaA_client_set_maximized_horizontal(lua_State *L, client_t *c) { client_set_maximized_horizontal(L, -3, luaA_checkboolean(L, -1)); return 0; } static int luaA_client_set_maximized_vertical(lua_State *L, client_t *c) { client_set_maximized_vertical(L, -3, luaA_checkboolean(L, -1)); return 0; } static int luaA_client_set_icon(lua_State *L, client_t *c) { cairo_surface_t *surf = NULL; if(!lua_isnil(L, -1)) surf = (cairo_surface_t *)lua_touserdata(L, -1); client_set_icon(c, surf); return 0; } static int luaA_client_set_focusable(lua_State *L, client_t *c) { if(lua_isnil(L, -1)) client_unset_focusable(L, -3); else client_set_focusable(L, -3, luaA_checkboolean(L, -1)); return 0; } static int luaA_client_set_sticky(lua_State *L, client_t *c) { client_set_sticky(L, -3, luaA_checkboolean(L, -1)); return 0; } static int luaA_client_set_size_hints_honor(lua_State *L, client_t *c) { c->size_hints_honor = luaA_checkboolean(L, -1); luaA_object_emit_signal(L, -3, "property::size_hints_honor", 0); return 0; } static int luaA_client_set_ontop(lua_State *L, client_t *c) { client_set_ontop(L, -3, luaA_checkboolean(L, -1)); return 0; } static int luaA_client_set_below(lua_State *L, client_t *c) { client_set_below(L, -3, luaA_checkboolean(L, -1)); return 0; } static int luaA_client_set_above(lua_State *L, client_t *c) { client_set_above(L, -3, luaA_checkboolean(L, -1)); return 0; } static int luaA_client_set_urgent(lua_State *L, client_t *c) { client_set_urgent(L, -3, luaA_checkboolean(L, -1)); return 0; } static int luaA_client_set_skip_taskbar(lua_State *L, client_t *c) { client_set_skip_taskbar(L, -3, luaA_checkboolean(L, -1)); return 0; } static int luaA_client_get_name(lua_State *L, client_t *c) { lua_pushstring(L, NONULL(c->name ? c->name : c->alt_name)); return 1; } /** Set the client name. * \param L The Lua VM state. * \param client The client to name. * \return The number of elements pushed on stack. */ static int luaA_client_set_name(lua_State *L, client_t *c) { const char *name = luaL_checkstring(L, -1); client_set_name(L, 1, a_strdup(name)); return 0; } static int luaA_client_get_icon_name(lua_State *L, client_t *c) { lua_pushstring(L, c->icon_name ? c->icon_name : c->alt_icon_name); return 1; } static int luaA_client_set_startup_id(lua_State *L, client_t *c) { const char *startup_id = luaL_checkstring(L, -1); client_set_startup_id(L, 1, a_strdup(startup_id)); return 0; } LUA_OBJECT_EXPORT_OPTIONAL_PROPERTY(client, client_t, screen, luaA_object_push, NULL) LUA_OBJECT_EXPORT_PROPERTY(client, client_t, class, lua_pushstring) LUA_OBJECT_EXPORT_PROPERTY(client, client_t, instance, lua_pushstring) LUA_OBJECT_EXPORT_OPTIONAL_PROPERTY(client, client_t, machine, lua_pushstring, NULL) LUA_OBJECT_EXPORT_PROPERTY(client, client_t, role, lua_pushstring) LUA_OBJECT_EXPORT_PROPERTY(client, client_t, transient_for, luaA_object_push) LUA_OBJECT_EXPORT_PROPERTY(client, client_t, skip_taskbar, lua_pushboolean) LUA_OBJECT_EXPORT_PROPERTY(client, client_t, leader_window, lua_pushinteger) LUA_OBJECT_EXPORT_PROPERTY(client, client_t, group_window, lua_pushinteger) LUA_OBJECT_EXPORT_OPTIONAL_PROPERTY(client, client_t, pid, lua_pushinteger, 0) LUA_OBJECT_EXPORT_PROPERTY(client, client_t, hidden, lua_pushboolean) LUA_OBJECT_EXPORT_PROPERTY(client, client_t, minimized, lua_pushboolean) LUA_OBJECT_EXPORT_PROPERTY(client, client_t, fullscreen, lua_pushboolean) LUA_OBJECT_EXPORT_PROPERTY(client, client_t, modal, lua_pushboolean) LUA_OBJECT_EXPORT_PROPERTY(client, client_t, ontop, lua_pushboolean) LUA_OBJECT_EXPORT_PROPERTY(client, client_t, urgent, lua_pushboolean) LUA_OBJECT_EXPORT_PROPERTY(client, client_t, above, lua_pushboolean) LUA_OBJECT_EXPORT_PROPERTY(client, client_t, below, lua_pushboolean) LUA_OBJECT_EXPORT_PROPERTY(client, client_t, sticky, lua_pushboolean) LUA_OBJECT_EXPORT_PROPERTY(client, client_t, size_hints_honor, lua_pushboolean) LUA_OBJECT_EXPORT_PROPERTY(client, client_t, maximized_horizontal, lua_pushboolean) LUA_OBJECT_EXPORT_PROPERTY(client, client_t, maximized_vertical, lua_pushboolean) LUA_OBJECT_EXPORT_PROPERTY(client, client_t, maximized, lua_pushboolean) LUA_OBJECT_EXPORT_PROPERTY(client, client_t, startup_id, lua_pushstring) static int luaA_client_get_motif_wm_hints(lua_State *L, client_t *c) { if (!(c->motif_wm_hints.hints & MWM_HINTS_AWESOME_SET)) return 0; lua_newtable(L); #define HANDLE_BIT(field, flag, name) do { \ lua_pushboolean(L, c->motif_wm_hints.field & flag); \ lua_setfield(L, -2, name); \ } while (0) if (c->motif_wm_hints.hints & MWM_HINTS_FUNCTIONS) { lua_newtable(L); HANDLE_BIT(functions, MWM_FUNC_ALL, "all"); HANDLE_BIT(functions, MWM_FUNC_RESIZE, "resize"); HANDLE_BIT(functions, MWM_FUNC_MOVE, "move"); HANDLE_BIT(functions, MWM_FUNC_MINIMIZE, "minimize"); HANDLE_BIT(functions, MWM_FUNC_MAXIMIZE, "maximize"); HANDLE_BIT(functions, MWM_FUNC_CLOSE, "close"); lua_setfield(L, -2, "functions"); } if (c->motif_wm_hints.hints & MWM_HINTS_DECORATIONS) { lua_newtable(L); HANDLE_BIT(decorations, MWM_DECOR_ALL, "all"); HANDLE_BIT(decorations, MWM_DECOR_BORDER, "border"); HANDLE_BIT(decorations, MWM_DECOR_RESIZEH, "resizeh"); HANDLE_BIT(decorations, MWM_DECOR_TITLE, "title"); HANDLE_BIT(decorations, MWM_DECOR_MENU, "menu"); HANDLE_BIT(decorations, MWM_DECOR_MINIMIZE, "minimize"); HANDLE_BIT(decorations, MWM_DECOR_MAXIMIZE, "maximize"); lua_setfield(L, -2, "decorations"); } if (c->motif_wm_hints.hints & MWM_HINTS_INPUT_MODE) { switch (c->motif_wm_hints.input_mode) { case MWM_INPUT_MODELESS: lua_pushliteral(L, "modeless"); break; case MWM_INPUT_PRIMARY_APPLICATION_MODAL: lua_pushliteral(L, "primary_application_modal"); break; case MWM_INPUT_SYSTEM_MODAL: lua_pushliteral(L, "system_modal"); break; case MWM_INPUT_FULL_APPLICATION_MODAL: lua_pushliteral(L, "full_application_modal"); break; default: lua_pushfstring(L, "unknown (%d)", (int) c->motif_wm_hints.input_mode); break; } lua_setfield(L, -2, "input_mode"); } if (c->motif_wm_hints.hints & MWM_HINTS_STATUS) { lua_newtable(L); HANDLE_BIT(status, MWM_TEAROFF_WINDOW, "tearoff_window"); lua_setfield(L, -2, "status"); } #undef HANDLE_BIT return 1; } static int luaA_client_get_content(lua_State *L, client_t *c) { cairo_surface_t *surface; int width = c->geometry.width; int height = c->geometry.height; /* Just the client size without decorations */ width -= c->titlebar[CLIENT_TITLEBAR_LEFT].size + c->titlebar[CLIENT_TITLEBAR_RIGHT].size; height -= c->titlebar[CLIENT_TITLEBAR_TOP].size + c->titlebar[CLIENT_TITLEBAR_BOTTOM].size; surface = cairo_xcb_surface_create(globalconf.connection, c->window, c->visualtype, width, height); /* lua has to make sure to free the ref or we have a leak */ lua_pushlightuserdata(L, surface); return 1; } static int luaA_client_get_icon(lua_State *L, client_t *c) { if(c->icons.len == 0) return 0; /* Pick the closest available size, only picking a smaller icon if no bigger * one is available. */ cairo_surface_t *found = NULL; int found_size = 0; int preferred_size = globalconf.preferred_icon_size; foreach(surf, c->icons) { int width = cairo_image_surface_get_width(*surf); int height = cairo_image_surface_get_height(*surf); int size = MAX(width, height); /* pick the icon if it's a better match than the one we already have */ bool found_icon_too_small = found_size < preferred_size; bool found_icon_too_large = found_size > preferred_size; bool icon_empty = width == 0 || height == 0; bool better_because_bigger = found_icon_too_small && size > found_size; bool better_because_smaller = found_icon_too_large && size >= preferred_size && size < found_size; if (!icon_empty && (better_because_bigger || better_because_smaller || found_size == 0)) { found = *surf; found_size = size; } } /* lua gets its own reference which it will have to destroy */ lua_pushlightuserdata(L, cairo_surface_reference(found)); return 1; } static int luaA_client_get_focusable(lua_State *L, client_t *c) { bool ret; if (c->focusable_set) ret = c->focusable; /* A client can be focused if it doesnt have the "nofocus" hint...*/ else if (!c->nofocus) ret = true; else /* ...or if it knows the WM_TAKE_FOCUS protocol */ ret = client_hasproto(c, WM_TAKE_FOCUS); lua_pushboolean(L, ret); return 1; } static int luaA_client_get_size_hints(lua_State *L, client_t *c) { const char *u_or_p = NULL; lua_createtable(L, 0, 1); if(c->size_hints.flags & XCB_ICCCM_SIZE_HINT_US_POSITION) u_or_p = "user_position"; else if(c->size_hints.flags & XCB_ICCCM_SIZE_HINT_P_POSITION) u_or_p = "program_position"; if(u_or_p) { lua_createtable(L, 0, 2); lua_pushinteger(L, c->size_hints.x); lua_setfield(L, -2, "x"); lua_pushinteger(L, c->size_hints.y); lua_setfield(L, -2, "y"); lua_setfield(L, -2, u_or_p); u_or_p = NULL; } if(c->size_hints.flags & XCB_ICCCM_SIZE_HINT_US_SIZE) u_or_p = "user_size"; else if(c->size_hints.flags & XCB_ICCCM_SIZE_HINT_P_SIZE) u_or_p = "program_size"; if(u_or_p) { lua_createtable(L, 0, 2); lua_pushinteger(L, c->size_hints.width); lua_setfield(L, -2, "width"); lua_pushinteger(L, c->size_hints.height); lua_setfield(L, -2, "height"); lua_setfield(L, -2, u_or_p); } if(c->size_hints.flags & XCB_ICCCM_SIZE_HINT_P_MIN_SIZE) { lua_pushinteger(L, c->size_hints.min_width); lua_setfield(L, -2, "min_width"); lua_pushinteger(L, c->size_hints.min_height); lua_setfield(L, -2, "min_height"); } if(c->size_hints.flags & XCB_ICCCM_SIZE_HINT_P_MAX_SIZE) { lua_pushinteger(L, c->size_hints.max_width); lua_setfield(L, -2, "max_width"); lua_pushinteger(L, c->size_hints.max_height); lua_setfield(L, -2, "max_height"); } if(c->size_hints.flags & XCB_ICCCM_SIZE_HINT_P_RESIZE_INC) { lua_pushinteger(L, c->size_hints.width_inc); lua_setfield(L, -2, "width_inc"); lua_pushinteger(L, c->size_hints.height_inc); lua_setfield(L, -2, "height_inc"); } if(c->size_hints.flags & XCB_ICCCM_SIZE_HINT_P_ASPECT) { lua_pushinteger(L, c->size_hints.min_aspect_num); lua_setfield(L, -2, "min_aspect_num"); lua_pushinteger(L, c->size_hints.min_aspect_den); lua_setfield(L, -2, "min_aspect_den"); lua_pushinteger(L, c->size_hints.max_aspect_num); lua_setfield(L, -2, "max_aspect_num"); lua_pushinteger(L, c->size_hints.max_aspect_den); lua_setfield(L, -2, "max_aspect_den"); } if(c->size_hints.flags & XCB_ICCCM_SIZE_HINT_BASE_SIZE) { lua_pushinteger(L, c->size_hints.base_width); lua_setfield(L, -2, "base_width"); lua_pushinteger(L, c->size_hints.base_height); lua_setfield(L, -2, "base_height"); } if(c->size_hints.flags & XCB_ICCCM_SIZE_HINT_P_WIN_GRAVITY) { switch(c->size_hints.win_gravity) { default: lua_pushliteral(L, "north_west"); break; case XCB_GRAVITY_NORTH: lua_pushliteral(L, "north"); break; case XCB_GRAVITY_NORTH_EAST: lua_pushliteral(L, "north_east"); break; case XCB_GRAVITY_WEST: lua_pushliteral(L, "west"); break; case XCB_GRAVITY_CENTER: lua_pushliteral(L, "center"); break; case XCB_GRAVITY_EAST: lua_pushliteral(L, "east"); break; case XCB_GRAVITY_SOUTH_WEST: lua_pushliteral(L, "south_west"); break; case XCB_GRAVITY_SOUTH: lua_pushliteral(L, "south"); break; case XCB_GRAVITY_SOUTH_EAST: lua_pushliteral(L, "south_east"); break; case XCB_GRAVITY_STATIC: lua_pushliteral(L, "static"); break; } lua_setfield(L, -2, "win_gravity"); } return 1; } /** Get the client's child window bounding shape. * \param L The Lua VM state. * \param client The client object. * \return The number of elements pushed on stack. */ static int luaA_client_get_client_shape_bounding(lua_State *L, client_t *c) { cairo_surface_t *surf = xwindow_get_shape(c->window, XCB_SHAPE_SK_BOUNDING); if (!surf) return 0; /* lua has to make sure to free the ref or we have a leak */ lua_pushlightuserdata(L, surf); return 1; } /** Get the client's frame window bounding shape. * \param L The Lua VM state. * \param client The client object. * \return The number of elements pushed on stack. */ static int luaA_client_get_shape_bounding(lua_State *L, client_t *c) { cairo_surface_t *surf = xwindow_get_shape(c->frame_window, XCB_SHAPE_SK_BOUNDING); if (!surf) return 0; /* lua has to make sure to free the ref or we have a leak */ lua_pushlightuserdata(L, surf); return 1; } /** Set the client's frame window bounding shape. * \param L The Lua VM state. * \param client The client object. * \return The number of elements pushed on stack. */ static int luaA_client_set_shape_bounding(lua_State *L, client_t *c) { cairo_surface_t *surf = NULL; if(!lua_isnil(L, -1)) surf = (cairo_surface_t *)lua_touserdata(L, -1); xwindow_set_shape(c->frame_window, c->geometry.width + (c->border_width * 2), c->geometry.height + (c->border_width * 2), XCB_SHAPE_SK_BOUNDING, surf, -c->border_width); luaA_object_emit_signal(L, -3, "property::shape_bounding", 0); return 0; } /** Get the client's child window clip shape. * \param L The Lua VM state. * \param client The client object. * \return The number of elements pushed on stack. */ static int luaA_client_get_client_shape_clip(lua_State *L, client_t *c) { cairo_surface_t *surf = xwindow_get_shape(c->window, XCB_SHAPE_SK_CLIP); if (!surf) return 0; /* lua has to make sure to free the ref or we have a leak */ lua_pushlightuserdata(L, surf); return 1; } /** Get the client's frame window clip shape. * \param L The Lua VM state. * \param client The client object. * \return The number of elements pushed on stack. */ static int luaA_client_get_shape_clip(lua_State *L, client_t *c) { cairo_surface_t *surf = xwindow_get_shape(c->frame_window, XCB_SHAPE_SK_CLIP); if (!surf) return 0; /* lua has to make sure to free the ref or we have a leak */ lua_pushlightuserdata(L, surf); return 1; } /** Set the client's frame window clip shape. * \param L The Lua VM state. * \param client The client object. * \return The number of elements pushed on stack. */ static int luaA_client_set_shape_clip(lua_State *L, client_t *c) { cairo_surface_t *surf = NULL; if(!lua_isnil(L, -1)) surf = (cairo_surface_t *)lua_touserdata(L, -1); xwindow_set_shape(c->frame_window, c->geometry.width, c->geometry.height, XCB_SHAPE_SK_CLIP, surf, 0); luaA_object_emit_signal(L, -3, "property::shape_clip", 0); return 0; } /** Get the client's frame window input shape. * \param L The Lua VM state. * \param client The client object. * \return The number of elements pushed on stack. */ static int luaA_client_get_shape_input(lua_State *L, client_t *c) { cairo_surface_t *surf = xwindow_get_shape(c->frame_window, XCB_SHAPE_SK_INPUT); if (!surf) return 0; /* lua has to make sure to free the ref or we have a leak */ lua_pushlightuserdata(L, surf); return 1; } /** Set the client's frame window input shape. * \param L The Lua VM state. * \param client The client object. * \return The number of elements pushed on stack. */ static int luaA_client_set_shape_input(lua_State *L, client_t *c) { cairo_surface_t *surf = NULL; if(!lua_isnil(L, -1)) surf = (cairo_surface_t *)lua_touserdata(L, -1); xwindow_set_shape(c->frame_window, c->geometry.width + (c->border_width * 2), c->geometry.height + (c->border_width * 2), XCB_SHAPE_SK_INPUT, surf, -c->border_width); luaA_object_emit_signal(L, -3, "property::shape_input", 0); return 0; } /** Get or set keys bindings for a client. * * @property keys * @tparam table keys * @propemits false false * @see awful.key * @see append_keybinding * @see remove_keybinding * @see request::default_keybindings */ static int luaA_client_keys(lua_State *L) { client_t *c = luaA_checkudata(L, 1, &client_class); key_array_t *keys = &c->keys; if(lua_gettop(L) == 2) { luaA_key_array_set(L, 1, 2, keys); luaA_object_emit_signal(L, 1, "property::keys", 0); xwindow_grabkeys(c->window, keys); if (c->nofocus_window) xwindow_grabkeys(c->nofocus_window, &c->keys); } return luaA_key_array_get(L, 1, keys); } static int luaA_client_get_icon_sizes(lua_State *L, client_t *c) { int index = 1; lua_newtable(L); foreach (s, c->icons) { /* Create a table { width, height } and append it to the table */ lua_createtable(L, 2, 0); lua_pushinteger(L, cairo_image_surface_get_width(*s)); lua_rawseti(L, -2, 1); lua_pushinteger(L, cairo_image_surface_get_height(*s)); lua_rawseti(L, -2, 2); lua_rawseti(L, -2, index++); } return 1; } /** Get the client's n-th icon. * * The icon index can be deternined by inspecting the `icon_sizes` property first. * * The user has the responsibility to test the value returned by this function * to ensure an icon have been returned. * * It is recommended to use the `awful.widget.clienticon` widget when the * client icon is used in a widget structure. * * Note that this function tests the provided index and raise an "invalid icon * index" error if the provided index doesn't exist in the client's icons list * (by raising an error, the function will be stopped and nothing will be * returned to the caller). * * @tparam interger index The index in the list of icons to get. * @treturn surface A lightuserdata for a cairo surface. This reference must be * destroyed! * @method get_icon * @see icon_sizes * @see awful.widget.clienticon */ static int luaA_client_get_some_icon(lua_State *L) { client_t *c = luaA_checkudata(L, 1, &client_class); int index = luaL_checkinteger(L, 2); luaL_argcheck(L, (index >= 1 && index <= c->icons.len), 2, "invalid icon index"); lua_pushlightuserdata(L, cairo_surface_reference(c->icons.tab[index-1])); return 1; } static int client_tostring(lua_State *L, client_t *c) { char *name = c->name ? c->name : c->alt_name; ssize_t len = a_strlen(name); ssize_t limit = 20; lua_pushlstring(L, name, MIN(len, limit)); if (len > limit) lua_pushstring(L, "..."); return len > limit ? 2 : 1; } /* Client module. * \param L The Lua VM state. * \return The number of pushed elements. */ static int luaA_client_module_index(lua_State *L) { const char *buf = luaL_checkstring(L, 2); if (A_STREQ(buf, "focus")) return luaA_object_push(L, globalconf.focus.client); return 0; } /* Client module new index. * \param L The Lua VM state. * \return The number of pushed elements. */ static int luaA_client_module_newindex(lua_State *L) { const char *buf = luaL_checkstring(L, 2); client_t *c; if (A_STREQ(buf, "focus")) { c = luaA_checkudataornil(L, 3, &client_class); if (c) client_focus(c); else if (globalconf.focus.client) client_unfocus(globalconf.focus.client); } return 0; } static bool client_checker(client_t *c) { return c->window != XCB_NONE; } void client_class_setup(lua_State *L) { static const struct luaL_Reg client_methods[] = { LUA_CLASS_METHODS(client) { "get", luaA_client_get }, { "__index", luaA_client_module_index }, { "__newindex", luaA_client_module_newindex }, { NULL, NULL } }; static const struct luaL_Reg client_meta[] = { LUA_OBJECT_META(client) LUA_CLASS_META { "_keys", luaA_client_keys }, { "isvisible", luaA_client_isvisible }, { "geometry", luaA_client_geometry }, { "apply_size_hints", luaA_client_apply_size_hints }, { "tags", luaA_client_tags }, { "kill", luaA_client_kill }, { "swap", luaA_client_swap }, { "raise", luaA_client_raise }, { "lower", luaA_client_lower }, { "unmanage", luaA_client_unmanage }, { "titlebar_top", luaA_client_titlebar_top }, { "titlebar_right", luaA_client_titlebar_right }, { "titlebar_bottom", luaA_client_titlebar_bottom }, { "titlebar_left", luaA_client_titlebar_left }, { "get_icon", luaA_client_get_some_icon }, { NULL, NULL } }; luaA_class_setup(L, &client_class, "client", &window_class, (lua_class_allocator_t) client_new, (lua_class_collector_t) client_wipe, (lua_class_checker_t) client_checker, luaA_class_index_miss_property, luaA_class_newindex_miss_property, client_methods, client_meta); luaA_class_set_tostring(&client_class, (lua_class_propfunc_t) client_tostring); luaA_class_add_property(&client_class, "name", (lua_class_propfunc_t) luaA_client_set_name, (lua_class_propfunc_t) luaA_client_get_name, (lua_class_propfunc_t) luaA_client_set_name); luaA_class_add_property(&client_class, "transient_for", NULL, (lua_class_propfunc_t) luaA_client_get_transient_for, NULL); luaA_class_add_property(&client_class, "skip_taskbar", (lua_class_propfunc_t) luaA_client_set_skip_taskbar, (lua_class_propfunc_t) luaA_client_get_skip_taskbar, (lua_class_propfunc_t) luaA_client_set_skip_taskbar); luaA_class_add_property(&client_class, "content", NULL, (lua_class_propfunc_t) luaA_client_get_content, NULL); luaA_class_add_property(&client_class, "type", NULL, (lua_class_propfunc_t) luaA_window_get_type, NULL); luaA_class_add_property(&client_class, "class", NULL, (lua_class_propfunc_t) luaA_client_get_class, NULL); luaA_class_add_property(&client_class, "instance", NULL, (lua_class_propfunc_t) luaA_client_get_instance, NULL); luaA_class_add_property(&client_class, "role", NULL, (lua_class_propfunc_t) luaA_client_get_role, NULL); luaA_class_add_property(&client_class, "pid", NULL, (lua_class_propfunc_t) luaA_client_get_pid, NULL); luaA_class_add_property(&client_class, "leader_window", NULL, (lua_class_propfunc_t) luaA_client_get_leader_window, NULL); luaA_class_add_property(&client_class, "machine", NULL, (lua_class_propfunc_t) luaA_client_get_machine, NULL); luaA_class_add_property(&client_class, "icon_name", NULL, (lua_class_propfunc_t) luaA_client_get_icon_name, NULL); luaA_class_add_property(&client_class, "screen", NULL, (lua_class_propfunc_t) luaA_client_get_screen, (lua_class_propfunc_t) luaA_client_set_screen); luaA_class_add_property(&client_class, "hidden", (lua_class_propfunc_t) luaA_client_set_hidden, (lua_class_propfunc_t) luaA_client_get_hidden, (lua_class_propfunc_t) luaA_client_set_hidden); luaA_class_add_property(&client_class, "minimized", (lua_class_propfunc_t) luaA_client_set_minimized, (lua_class_propfunc_t) luaA_client_get_minimized, (lua_class_propfunc_t) luaA_client_set_minimized); luaA_class_add_property(&client_class, "fullscreen", (lua_class_propfunc_t) luaA_client_set_fullscreen, (lua_class_propfunc_t) luaA_client_get_fullscreen, (lua_class_propfunc_t) luaA_client_set_fullscreen); luaA_class_add_property(&client_class, "modal", (lua_class_propfunc_t) luaA_client_set_modal, (lua_class_propfunc_t) luaA_client_get_modal, (lua_class_propfunc_t) luaA_client_set_modal); luaA_class_add_property(&client_class, "motif_wm_hints", NULL, (lua_class_propfunc_t) luaA_client_get_motif_wm_hints, NULL); luaA_class_add_property(&client_class, "group_window", NULL, (lua_class_propfunc_t) luaA_client_get_group_window, NULL); luaA_class_add_property(&client_class, "maximized", (lua_class_propfunc_t) luaA_client_set_maximized, (lua_class_propfunc_t) luaA_client_get_maximized, (lua_class_propfunc_t) luaA_client_set_maximized); luaA_class_add_property(&client_class, "maximized_horizontal", (lua_class_propfunc_t) luaA_client_set_maximized_horizontal, (lua_class_propfunc_t) luaA_client_get_maximized_horizontal, (lua_class_propfunc_t) luaA_client_set_maximized_horizontal); luaA_class_add_property(&client_class, "maximized_vertical", (lua_class_propfunc_t) luaA_client_set_maximized_vertical, (lua_class_propfunc_t) luaA_client_get_maximized_vertical, (lua_class_propfunc_t) luaA_client_set_maximized_vertical); luaA_class_add_property(&client_class, "icon", (lua_class_propfunc_t) luaA_client_set_icon, (lua_class_propfunc_t) luaA_client_get_icon, (lua_class_propfunc_t) luaA_client_set_icon); luaA_class_add_property(&client_class, "icon_sizes", NULL, (lua_class_propfunc_t) luaA_client_get_icon_sizes, NULL); luaA_class_add_property(&client_class, "ontop", (lua_class_propfunc_t) luaA_client_set_ontop, (lua_class_propfunc_t) luaA_client_get_ontop, (lua_class_propfunc_t) luaA_client_set_ontop); luaA_class_add_property(&client_class, "above", (lua_class_propfunc_t) luaA_client_set_above, (lua_class_propfunc_t) luaA_client_get_above, (lua_class_propfunc_t) luaA_client_set_above); luaA_class_add_property(&client_class, "below", (lua_class_propfunc_t) luaA_client_set_below, (lua_class_propfunc_t) luaA_client_get_below, (lua_class_propfunc_t) luaA_client_set_below); luaA_class_add_property(&client_class, "sticky", (lua_class_propfunc_t) luaA_client_set_sticky, (lua_class_propfunc_t) luaA_client_get_sticky, (lua_class_propfunc_t) luaA_client_set_sticky); luaA_class_add_property(&client_class, "size_hints_honor", (lua_class_propfunc_t) luaA_client_set_size_hints_honor, (lua_class_propfunc_t) luaA_client_get_size_hints_honor, (lua_class_propfunc_t) luaA_client_set_size_hints_honor); luaA_class_add_property(&client_class, "urgent", (lua_class_propfunc_t) luaA_client_set_urgent, (lua_class_propfunc_t) luaA_client_get_urgent, (lua_class_propfunc_t) luaA_client_set_urgent); luaA_class_add_property(&client_class, "size_hints", NULL, (lua_class_propfunc_t) luaA_client_get_size_hints, NULL); luaA_class_add_property(&client_class, "focusable", (lua_class_propfunc_t) luaA_client_set_focusable, (lua_class_propfunc_t) luaA_client_get_focusable, (lua_class_propfunc_t) luaA_client_set_focusable); luaA_class_add_property(&client_class, "shape_bounding", (lua_class_propfunc_t) luaA_client_set_shape_bounding, (lua_class_propfunc_t) luaA_client_get_shape_bounding, (lua_class_propfunc_t) luaA_client_set_shape_bounding); luaA_class_add_property(&client_class, "shape_clip", (lua_class_propfunc_t) luaA_client_set_shape_clip, (lua_class_propfunc_t) luaA_client_get_shape_clip, (lua_class_propfunc_t) luaA_client_set_shape_clip); luaA_class_add_property(&client_class, "shape_input", (lua_class_propfunc_t) luaA_client_set_shape_input, (lua_class_propfunc_t) luaA_client_get_shape_input, (lua_class_propfunc_t) luaA_client_set_shape_input); luaA_class_add_property(&client_class, "startup_id", (lua_class_propfunc_t) luaA_client_set_startup_id, (lua_class_propfunc_t) luaA_client_get_startup_id, (lua_class_propfunc_t) luaA_client_set_startup_id); luaA_class_add_property(&client_class, "client_shape_bounding", NULL, (lua_class_propfunc_t) luaA_client_get_client_shape_bounding, NULL); luaA_class_add_property(&client_class, "client_shape_clip", NULL, (lua_class_propfunc_t) luaA_client_get_client_shape_clip, NULL); luaA_class_add_property(&client_class, "first_tag", NULL, (lua_class_propfunc_t) luaA_client_get_first_tag, NULL); } /* @DOC_cobject_COMMON@ */ /* @DOC_client_theme_COMMON@ */ // vim: filetype=c:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:textwidth=80