i3/include/i3.h

/*
 * vim:ts=4:sw=4:expandtab
 *
 * i3 - an improved dynamic tiling window manager
 * © 2009-2012 Michael Stapelberg and contributors (see also: LICENSE)
 *
 * i3.h: global variables that are used all over i3.
 *
 */
#pragma once

#include <sys/time.h>
#include <sys/resource.h>

#include <xcb/xcb_keysyms.h>

#include <X11/XKBlib.h>

#define SN_API_NOT_YET_FROZEN 1
#include <libsn/sn-launcher.h>

#include "queue.h"
#include "data.h"
#include "xcb.h"

/** The original value of RLIMIT_CORE when i3 was started. We need to restore
 * this before starting any other process, since we set RLIMIT_CORE to
 * RLIM_INFINITY for i3 debugging versions. */
extern struct rlimit original_rlimit_core;
/** Whether this version of i3 is a debug build or a release build. */
extern bool debug_build;
/** The number of file descriptors passed via socket activation. */
extern int listen_fds;
extern xcb_connection_t *conn;
extern int conn_screen;
/** The last timestamp we got from X11 (timestamps are included in some events
 * and are used for some things, like determining a unique ID in startup
 * notification). */
extern xcb_timestamp_t last_timestamp;
extern SnDisplay *sndisplay;
extern xcb_key_symbols_t *keysyms;
extern char **start_argv;
extern Display *xlibdpy, *xkbdpy;
extern int xkb_current_group;
extern TAILQ_HEAD(bindings_head, Binding) * bindings;
extern TAILQ_HEAD(autostarts_head, Autostart) autostarts;
extern TAILQ_HEAD(autostarts_always_head, Autostart) autostarts_always;
extern TAILQ_HEAD(ws_assignments_head, Workspace_Assignment) ws_assignments;
extern TAILQ_HEAD(assignments_head, Assignment) assignments;
extern SLIST_HEAD(stack_wins_head, Stack_Window) stack_wins;
extern xcb_screen_t *root_screen;

/* Color depth, visual id and colormap to use when creating windows and
 * pixmaps. Will use 32 bit depth and an appropriate visual, if available,
 * otherwise the root window’s default (usually 24 bit TrueColor). */
extern uint8_t root_depth;
extern xcb_visualid_t visual_id;
extern xcb_colormap_t colormap;

extern bool xcursor_supported, xkb_supported;
extern xcb_window_t root;
extern struct ev_loop *main_loop;
extern bool only_check_config;
-												Add vim hints, copyright notice to each file, add LICENSE, retab! everything

											
										
										
											2009-02-13 20:33:31 -05:00
+								/*
-												Make it easier to use other atoms.

											
										
										
											2011-03-13 19:44:16 -04:00
+								 * vim:ts=4:sw=4:expandtab
-												Add vim hints, copyright notice to each file, add LICENSE, retab! everything

											
										
										
											2009-02-13 20:33:31 -05:00
+								 *
 								 * i3 - an improved dynamic tiling window manager
-												make in-place restarts use socket activation, too (for faster/less flaky tests)

											
										
										
											2012-01-21 18:03:09 -05:00
+								 * © 2009-2012 Michael Stapelberg and contributors (see also: LICENSE)
-												Add vim hints, copyright notice to each file, add LICENSE, retab! everything

											
										
										
											2009-02-13 20:33:31 -05:00
+								 *
-												normalize file headers across **/*.{h,c}

											
										
										
											2011-10-25 16:19:38 -04:00
+								 * i3.h: global variables that are used all over i3.
-												Add vim hints, copyright notice to each file, add LICENSE, retab! everything

											
										
										
											2009-02-13 20:33:31 -05:00
+								 *
 								 */
-												Use #pragma once

 #pragma once is safer and simpler. According to Wikipedia it's supported by all major compilers.

											
										
										
											2013-12-28 21:11:50 -05:00
+								#pragma once
-												normalize file headers across **/*.{h,c}

											
										
										
											2011-10-25 16:19:38 -04:00
-												Enable (unlimited) core dumps when running i3 development versions

Also prints out useful stuff:

    CORE DUMPS: You are running a development version of i3, so coredumps were
    automatically enabled (ulimit -c unlimited).
    CORE DUMPS: Your current working directory is "/home/michael/i3".
    CORE DUMPS: Your core_pattern is: /tmp/%e.core.%p
    i3 (tree) version 4.0.2-479-g26ab2ac (2011-11-08, branch "next") starting

This does not affect child processes of i3.

The intention of this change is to make debugging easier – it’s one less thing
users of the development version have to worry about when trying to help with
debugging.

											
										
										
											2011-11-08 17:49:25 -05:00
+								#include <sys/time.h>
 								#include <sys/resource.h>
-												Implement support for using key symbols in configuration file

Use "bindsym" instead of "bind". You have to use the names of keys
as in xmodmap. To get a list of currently bounud symbols, use
xmodmap -pke

Technical quirk: Xlib generated MappingNotify events upon
XkbMapNotify events (from XKB, as the name says). XCB does not yet
have support for XKB, thus we need to select and handle the event
by ourself. Hopefully, this will change in the future.

											
										
										
											2009-08-07 09:35:12 -04:00
+								#include <xcb/xcb_keysyms.h>
-												Cleanups, first strike. Move stuff to separate files, eliminate warnings

											
										
										
											2009-02-13 13:04:45 -05:00
 								#include <X11/XKBlib.h>
-												Implement support for startup notifications

This only sets up startup notifications for the 'exec' commands and directives.

Monitoring startups follows later.

											
										
										
											2011-10-09 13:21:59 -04:00
+								#define SN_API_NOT_YET_FROZEN 1
 								#include <libsn/sn-launcher.h>
-												Cleanups, first strike. Move stuff to separate files, eliminate warnings

											
										
										
											2009-02-13 13:04:45 -05:00
+								#include "queue.h"
-												Don’t rely on libxcb-wm any longer, as it got removed in libxcb 0.3.4

See http://cgit.freedesktop.org/xcb/util/commit/?id=4c9a707f472e49bc3005354db265a0214071d46b

											
										
										
											2009-04-19 14:44:34 -04:00
+								#include "data.h"
-												Make it easier to use other atoms.

											
										
										
											2011-03-13 19:44:16 -04:00
+								#include "xcb.h"
-												Cleanups, first strike. Move stuff to separate files, eliminate warnings

											
										
										
											2009-02-13 13:04:45 -05:00
-												Enable (unlimited) core dumps when running i3 development versions

Also prints out useful stuff:

    CORE DUMPS: You are running a development version of i3, so coredumps were
    automatically enabled (ulimit -c unlimited).
    CORE DUMPS: Your current working directory is "/home/michael/i3".
    CORE DUMPS: Your core_pattern is: /tmp/%e.core.%p
    i3 (tree) version 4.0.2-479-g26ab2ac (2011-11-08, branch "next") starting

This does not affect child processes of i3.

The intention of this change is to make debugging easier – it’s one less thing
users of the development version have to worry about when trying to help with
debugging.

											
										
										
											2011-11-08 17:49:25 -05:00
+								/** The original value of RLIMIT_CORE when i3 was started. We need to restore
 								 * this before starting any other process, since we set RLIMIT_CORE to
 								 * RLIM_INFINITY for i3 debugging versions. */
 								extern struct rlimit original_rlimit_core;
-												Introduce --shmlog-size flag, unlink SHM log when exiting

											
										
										
											2011-12-10 05:51:55 -05:00
+								/** Whether this version of i3 is a debug build or a release build. */
 								extern bool debug_build;
-												make in-place restarts use socket activation, too (for faster/less flaky tests)

											
										
										
											2012-01-21 18:03:09 -05:00
+								/** The number of file descriptors passed via socket activation. */
 								extern int listen_fds;
-												first step of the big refactoring ("tree" branch).

From here on, we can track changes. It made no sense to put the
development up to this point into git.

											
										
										
											2010-03-27 10:25:51 -04:00
+								extern xcb_connection_t *conn;
-												Make conn_screen available outside of main()

Will be used in other parts of the code for startup notification

											
										
										
											2011-10-09 13:19:31 -04:00
+								extern int conn_screen;
-												Implement support for startup notifications

This only sets up startup notifications for the 'exec' commands and directives.

Monitoring startups follows later.

											
										
										
											2011-10-09 13:21:59 -04:00
+								/** The last timestamp we got from X11 (timestamps are included in some events
 								 * and are used for some things, like determining a unique ID in startup
 								 * notification). */
 								extern xcb_timestamp_t last_timestamp;
 								extern SnDisplay *sndisplay;
-												Implement support for using key symbols in configuration file

Use "bindsym" instead of "bind". You have to use the names of keys
as in xmodmap. To get a list of currently bounud symbols, use
xmodmap -pke

Technical quirk: Xlib generated MappingNotify events upon
XkbMapNotify events (from XKB, as the name says). XCB does not yet
have support for XKB, thus we need to select and handle the event
by ourself. Hopefully, this will change in the future.

											
										
										
											2009-08-07 09:35:12 -04:00
+								extern xcb_key_symbols_t *keysyms;
-												Bugfix: Correctly restart i3 when not using its absolute path

											
										
										
											2009-05-01 10:10:02 -04:00
+								extern char **start_argv;
-												libXcursor support (themed cursors).

											
										
										
											2010-11-26 18:26:51 -05:00
+								extern Display *xlibdpy, *xkbdpy;
-												Don’t use SYNC key bindings for Mode_switch but re-grab keys

Before this commit, i3 used key bindings in SYNC mode for bindings
like Mode_switch + <a> and replayed the key if the current state
did not include Mode_switch. This had some problems:

1) The WM needed to acknowledge much more key presses than you
   actually had bindings for, thus making the system a bit laggy
   sometimes.
2) Users of layouts who constantly type in the third level (like
   russian layouts) did not get their cyrillic symbols correctly
   (they were not replayed right), neither did the keybindings
   work in both modes.

So, the current implementation uses the following approach: XKB
provides an event which contains the current state (including
the current level). i3 signs up for this event and upon receival,
it re-maps the bindings using Mode_switch (enables them when the
level goes to the third level and disables them as soon as the
level goes back to normal). This fixes both problems.

											
										
										
											2010-03-14 17:35:51 -04:00
+								extern int xkb_current_group;
-												clang-format-3.5 **/*.h **/*.c

This should be the last commit that formats a big bunch of files. From
here on, whenever I merge patches, I’ll run clang-format like described
in the title.

											
										
										
											2014-06-19 05:20:32 -04:00
+								extern TAILQ_HEAD(bindings_head, Binding) * bindings;
-												Implement autostart using "exec" in config

Syntax is "exec <application>", like when creating a binding.
Multiple entries are possible, applications are started in
the specified order.

											
										
										
											2009-03-29 08:53:48 -04:00
+								extern TAILQ_HEAD(autostarts_head, Autostart) autostarts;
-												patch to allow exec_always in configure file

fixed indentation, updated docs

											
										
										
											2011-07-12 06:24:01 -04:00
+								extern TAILQ_HEAD(autostarts_always_head, Autostart) autostarts_always;
-												re-implement assignments of workspace to specific outputs

											
										
										
											2011-05-14 16:13:29 -04:00
+								extern TAILQ_HEAD(ws_assignments_head, Workspace_Assignment) ws_assignments;
-												Implement assignments for (named) workspaces, with '~' compatibility (floating)

											
										
										
											2011-05-23 12:41:17 -04:00
+								extern TAILQ_HEAD(assignments_head, Assignment) assignments;
-												Implement stacking

											
										
										
											2009-02-23 18:30:04 -05:00
+								extern SLIST_HEAD(stack_wins_head, Stack_Window) stack_wins;
-												Bugfix: use the global root variable, don’t get the first one (Thanks quaec)

											
										
										
											2011-07-23 16:29:01 -04:00
+								extern xcb_screen_t *root_screen;
-												Implement support for chosing a 32 bit visual (necessary for pseudo-transparency) (Thanks darkraven)

You need to specify the --enable-32bit-visual flag when starting i3. This is
done because everything feels sluggish on my system when using a 32 bit visual
instead of a 24 bit visual. Fast > fancy.

											
										
										
											2012-01-28 11:09:02 -05:00
 								/* Color depth, visual id and colormap to use when creating windows and
 								 * pixmaps. Will use 32 bit depth and an appropriate visual, if available,
 								 * otherwise the root window’s default (usually 24 bit TrueColor). */
-												optimization: Render on pixmaps and copy the result on Stack_Wins

This should speed up the rendering of Stack_Wins with many window
decorations and it should considerably reduce flicker.

											
										
										
											2009-07-17 12:32:40 -04:00
+								extern uint8_t root_depth;
-												Implement support for chosing a 32 bit visual (necessary for pseudo-transparency) (Thanks darkraven)

You need to specify the --enable-32bit-visual flag when starting i3. This is
done because everything feels sluggish on my system when using a 32 bit visual
instead of a 24 bit visual. Fast > fancy.

											
										
										
											2012-01-28 11:09:02 -05:00
+								extern xcb_visualid_t visual_id;
 								extern xcb_colormap_t colormap;
-												libXcursor support (themed cursors).

											
										
										
											2010-11-26 18:26:51 -05:00
+								extern bool xcursor_supported, xkb_supported;
-												Implements a reload command

											
										
										
											2009-07-23 12:14:24 -04:00
+								extern xcb_window_t root;
-												add i3-nagbar. tells you about config file errors (for example)

											
										
										
											2011-07-10 08:33:19 -04:00
+								extern struct ev_loop *main_loop;
-												Don’t start i3-nagbar when using -C to validate the config

											
										
										
											2011-10-20 17:25:59 -04:00
+								extern bool only_check_config;