From c3c0b95c6420a71ae399b36b363bf4ff7d30f9b9 Mon Sep 17 00:00:00 2001
From: Richard Grenville <pyxlcy@gmail.com>
Date: Wed, 28 Nov 2012 11:44:00 +0800
Subject: Feature #65: --focus-exclude

- Add --focus-exclude, which should be used with a list of conditions to
  set certain windows to always be considered focused.

- Change focus determination process, with a newly added w->focused_real
  that reflects whether the window is actually focused, while w->focused
  represents whether compton considers it focused. The primary
  difference is now when a window considered focused because of
  --mark-wmwin-focused or --mark-ovredir-focused receives a FocusOut
  event, it's still considered focused by compton.

- Change opacity target and dim state calculation so that it's done at
  most once every paint.

- Split window opacity property fetching from calc_opacity() to a new
  function win_update_opacity_prop().

- Silence a warning in wid_get_prop_wintype().

- Rename a few functions. Code clean-up.

- My time is very limited currently, few tests are done, so this commit
  may very well introduce bugs.

- Known issue: Dim picture opacity does not change based on window
  opacity, causing somehow annoying effects when a window fades off.
---
 compton.h | 62 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++------
 1 file changed, 56 insertions(+), 6 deletions(-)

(limited to 'compton.h')

diff --git a/compton.h b/compton.h
index de4d84e5e..00f6349e1 100644
--- a/compton.h
+++ b/compton.h
@@ -116,6 +116,8 @@
 #define WFLAG_SIZE_CHANGE   0x0001
 // Window size/position is changed
 #define WFLAG_POS_CHANGE    0x0002
+// Window opacity / dim state changed
+#define WFLAG_OPCT_CHANGE   0x0004
 
 /**
  * Types
@@ -290,8 +292,12 @@ typedef struct {
   double inactive_dim;
   /// Step for pregenerating alpha pictures. 0.01 - 1.0.
   double alpha_step;
+
+  // === Focus related ===
   /// Whether to use EWMH _NET_ACTIVE_WINDOW to find active window.
   bool use_ewmh_active_win;
+  /// A list of windows always to be considered focused.
+  wincond_t *focus_blacklist;
 
   // === Calculated ===
   /// Whether compton needs to track focus changes.
@@ -512,8 +518,10 @@ typedef struct _win {
   XserverRegion extents;
   // Type of the window.
   wintype_t window_type;
-  /// Whether the window is focused.
+  /// Whether the window is to be considered focused.
   bool focused;
+  /// Whether the window is actually focused.
+  bool focused_real;
   /// Whether the window has been destroyed.
   bool destroyed;
   /// Cached width/height of the window including border.
@@ -531,6 +539,7 @@ typedef struct _win {
   char *class_general;
   wincond_t *cache_sblst;
   wincond_t *cache_fblst;
+  wincond_t *cache_fcblst;
 
   // Opacity-related members
   /// Current window opacity.
@@ -1354,6 +1363,20 @@ unmap_win(session_t *ps, Window id);
 static opacity_t
 wid_get_opacity_prop(session_t *ps, Window wid, opacity_t def);
 
+/**
+ * Reread opacity property of a window.
+ */
+static inline void
+win_update_opacity_prop(session_t *ps, win *w) {
+  w->opacity_prop = wid_get_opacity_prop(ps, w->id, OPAQUE);
+  if (!ps->o.detect_client_opacity || !w->client_win
+      || w->id == w->client_win)
+    w->opacity_prop_client = OPAQUE;
+  else
+    w->opacity_prop_client = wid_get_opacity_prop(ps, w->client_win,
+          OPAQUE);
+}
+
 static double
 get_opacity_percent(win *w);
 
@@ -1361,16 +1384,39 @@ static void
 determine_mode(session_t *ps, win *w);
 
 static void
-calc_opacity(session_t *ps, win *w, bool refetch_prop);
+calc_opacity(session_t *ps, win *w);
 
 static void
 calc_dim(session_t *ps, win *w);
 
+/**
+ * Update focused state of a window.
+ */
+static inline void
+win_update_focused(session_t *ps, win *w) {
+  bool focused_old = w->focused;
+
+  w->focused = w->focused_real;
+
+  // Consider a window without client window a WM window and mark it
+  // focused if mark_wmwin_focused is on, or it's over-redirected and
+  // mark_ovredir_focused is on
+  if ((ps->o.mark_wmwin_focused && !w->client_win)
+      || (ps->o.mark_ovredir_focused && w->id == w->client_win)
+      || win_match(w, ps->o.focus_blacklist, &w->cache_fcblst))
+    w->focused = true;
+
+  if (w->focused != focused_old)
+    w->flags |= WFLAG_OPCT_CHANGE;
+}
+
+/**
+ * Set real focused state of a window.
+ */
 static inline void
-set_focused(session_t *ps, win *w, bool focused) {
-  w->focused = focused;
-  calc_opacity(ps, w, false);
-  calc_dim(ps, w);
+win_set_focused(session_t *ps, win *w, bool focused) {
+  w->focused_real = focused;
+  win_update_focused(ps, w);
 }
 
 static void
@@ -1628,6 +1674,10 @@ lcfg_lookup_int(const config_t *config, const char *path, int *value) {
 static FILE *
 open_config_file(char *cpath, char **path);
 
+static void
+parse_cfg_condlst(const config_t *pcfg, wincond_t **pcondlst,
+    const char *name);
+
 static void
 parse_config(session_t *ps, char *cpath, struct options_tmp *pcfgtmp);
 #endif
-- 
cgit v1.2.1