#include "ctwm.h"
#include <stdio.h>
#include <stdlib.h>
#include <assert.h>
#include <X11/Xatom.h>
#include "otp.h"
#include "ctwm_atoms.h"
#include "screen.h"
#include "util.h"
#include "icons.h"
#include "list.h"
#include "events.h"
#include "event_handlers.h"
#include "vscreen.h"
#include "win_utils.h"

Include dependency graph for otp.c:

Data Structures
struct	OtpWinList
struct	OtpPreferences
struct	Box

Macros
#define	DEBUG_OTP 0
#define	DPRINTF(x)
#define	CHECK_OTP 1
#define	OTP_ZERO 8
#define	OTP_MAX (OTP_ZERO * 2)
#define	PRI(owl)
#define	PRI_CP(from, to)

Typedefs
typedef struct Box	Box

Functions
static bool	OtpCheckConsistencyVS (VirtualScreen *currentvs, Window vroot)
static void	OwlPrettyPrint (const OtpWinList *start)
	Pretty-print a whole OWL stack.
static void	OwlSetAflagMask (OtpWinList *owl, unsigned mask, unsigned setto)
static void	OwlSetAflag (OtpWinList *owl, unsigned flag)
static void	OwlClearAflag (OtpWinList *owl, unsigned flag)
static void	OwlStashAflags (OtpWinList *owl)
static unsigned	OwlGetStashedAflags (OtpWinList owl, bool gotit)
static int	OwlEffectivePriority (OtpWinList *owl)
static Box	BoxOfOwl (OtpWinList *owl)
static bool	BoxesIntersect (Box b1, Box b2)
static bool	isIntersectingWith (OtpWinList owl1, OtpWinList owl2)
static bool	isOnScreen (OtpWinList *owl)
bool	isTransientOf (TwmWindow trans, TwmWindow main)
bool	isGroupLeader (TwmWindow *twm_win)
bool	isGroupLeaderOf (TwmWindow leader, TwmWindow twm_win)
bool	isSmallTransientOf (TwmWindow trans, TwmWindow main)
static Window	WindowOfOwl (OtpWinList *owl)
bool	OtpCheckConsistency (void)
static void	RemoveOwl (OtpWinList *owl)
static OtpWinList *	GetOwlAtOrBelowInVS (OtpWinList owl, VirtualScreen vs)
	For the purpose of putting a window above another, they need to have the same parent, i.e.
static void	InsertOwlAbove (OtpWinList owl, OtpWinList other_owl)
static bool	shouldStayAbove (OtpWinList owl, OtpWinList other_owl)
static void	RaiseSmallTransientsOfAbove (OtpWinList owl, OtpWinList other_owl)
static OtpWinList *	OwlRightBelow (int priority)
static void	InsertOwl (OtpWinList *owl, int where)
static void	SetOwlPriority (OtpWinList *owl, int new_pri, int where)
static void	TryToMoveTransientsOfTo (OtpWinList *owl, int priority, int where)
static void	TryToSwitch (OtpWinList *owl, int where)
static void	RaiseOwl (OtpWinList *owl)
static void	LowerOwl (OtpWinList *owl)
static bool	isHiddenBy (OtpWinList owl, OtpWinList other_owl)
static void	TinyRaiseOwl (OtpWinList *owl)
static void	TinyLowerOwl (OtpWinList *owl)
static void	RaiseLowerOwl (OtpWinList *owl)
void	OtpRaise (TwmWindow *twm_win, WinType wintype)
void	OtpLower (TwmWindow *twm_win, WinType wintype)
void	OtpRaiseLower (TwmWindow *twm_win, WinType wintype)
void	OtpTinyRaise (TwmWindow *twm_win, WinType wintype)
void	OtpTinyLower (TwmWindow *twm_win, WinType wintype)
void	OtpCirculateSubwindows (VirtualScreen *vs, int direction)
void	OtpHandleCirculateNotify (VirtualScreen vs, TwmWindow twm_win, WinType wintype, int place)
void	OtpSetPriority (TwmWindow *twm_win, WinType wintype, int new_pri, int where)
void	OtpChangePriority (TwmWindow *twm_win, WinType wintype, int relpriority)
void	OtpSwitchPriority (TwmWindow *twm_win, WinType wintype)
void	OtpToggleSwitching (TwmWindow *twm_win, WinType wintype)
void	OtpForcePlacement (TwmWindow twm_win, int where, TwmWindow other_win)
static void	ApplyPreferences (OtpPreferences prefs, OtpWinList owl)
static void	RecomputeOwlPrefs (OtpPreferences prefs, OtpWinList owl)
void	OtpRecomputePrefs (TwmWindow *twm_win)
static void	free_OtpWinList (OtpWinList *owl)
void	OtpRemove (TwmWindow *twm_win, WinType wintype)
static OtpWinList *	new_OtpWinList (TwmWindow *twm_win, WinType wintype, bool switching, int priority)
static OtpWinList *	AddNewOwl (TwmWindow twm_win, WinType wintype, OtpWinList parent)
void	OtpAdd (TwmWindow *twm_win, WinType wintype)
void	OtpReassignIcon (TwmWindow twm_win, Icon old_icon)
void	OtpFreeIcon (TwmWindow *twm_win)
name_list **	OtpScrSwitchingL (ScreenInfo *scr, WinType wintype)
void	OtpScrSetSwitching (ScreenInfo *scr, WinType wintype, bool switching)
void	OtpScrSetZero (ScreenInfo *scr, WinType wintype, int priority)
name_list **	OtpScrPriorityL (ScreenInfo *scr, WinType wintype, int priority)
static OtpPreferences *	new_OtpPreferences (void)
static void	free_OtpPreferences (OtpPreferences *pref)
void	OtpScrInitData (ScreenInfo *scr)
int	ReparentWindow (Display display, TwmWindow twm_win, WinType wintype, Window parent, int x, int y)
void	ReparentWindowAndIcon (Display display, TwmWindow twm_win, Window parent, int win_x, int win_y, int icon_x, int icon_y)
TwmWindow *	OtpBottomWin (void)
TwmWindow *	OtpTopWin (void)
TwmWindow *	OtpNextWinUp (TwmWindow *twm_win)
TwmWindow *	OtpNextWinDown (TwmWindow *twm_win)
void	OtpSetAflagMask (TwmWindow *twm_win, unsigned mask, unsigned setto)
void	OtpSetAflag (TwmWindow *twm_win, unsigned flag)
void	OtpClearAflag (TwmWindow *twm_win, unsigned flag)
void	OtpStashAflagsFirstTime (TwmWindow *twm_win)
void	OtpRestackWindow (TwmWindow *twm_win)
static void	OtpFocusWindowBE (TwmWindow *twm_win, int oldprio)
	Focus/unfocus backend.
void	OtpUnfocusWindow (TwmWindow *twm_win)
	Unfocus a window.
void	OtpFocusWindow (TwmWindow *twm_win)
	Focus a window.
int	OtpEffectiveDisplayPriority (TwmWindow *twm_win)
int	OtpEffectivePriority (TwmWindow *twm_win)
bool	OtpIsFocusDependent (TwmWindow *twm_win)

Macro Definition Documentation

◆ CHECK_OTP

#define CHECK_OTP 1

Definition at line 42 of file otp.c.

◆ DEBUG_OTP

#define DEBUG_OTP 0

Definition at line 32 of file otp.c.

◆ DPRINTF

#define DPRINTF ( x )

Definition at line 36 of file otp.c.

Referenced by InsertOwl(), InsertOwlAbove(), OtpCheckConsistencyVS(), OtpCirculateSubwindows(), OtpHandleCirculateNotify(), OtpSetPriority(), ReparentWindow(), ReparentWindowAndIcon(), and SetOwlPriority().

◆ OTP_MAX

#define OTP_MAX (OTP_ZERO * 2)

Definition at line 47 of file otp.c.

Referenced by ApplyPreferences(), free_OtpPreferences(), new_OtpPreferences(), OtpCheckConsistencyVS(), OtpSwitchPriority(), OwlEffectivePriority(), RaiseLowerOwl(), SetOwlPriority(), and TryToSwitch().

◆ OTP_ZERO

#define OTP_ZERO 8

Definition at line 46 of file otp.c.

Referenced by AddNewOwl(), new_OtpPreferences(), OtpEffectiveDisplayPriority(), OtpScrPriorityL(), OtpScrSetZero(), OtpSetPriority(), OtpSwitchPriority(), and OwlEffectivePriority().

◆ PRI

#define PRI ( owl )

Value:

OwlEffectivePriority(owl)

OwlEffectivePriority

static int OwlEffectivePriority(OtpWinList *owl)

Definition otp.c:1812

Definition at line 50 of file otp.c.

Referenced by AddNewOwl(), InsertOwl(), InsertOwlAbove(), OtpCheckConsistencyVS(), OtpFocusWindow(), OtpUnfocusWindow(), OwlRightBelow(), RaiseLowerOwl(), TinyLowerOwl(), TinyRaiseOwl(), and TryToMoveTransientsOfTo().

◆ PRI_CP

#define PRI_CP	(		from,
			to )

Value:

            do {                  \
            to->pri_base = from->pri_base;     \
            to->pri_aflags = from->pri_aflags; \
        } while(0)

Definition at line 51 of file otp.c.

Referenced by AddNewOwl(), InsertOwl(), and RaiseSmallTransientsOfAbove().

Typedef Documentation

◆ Box

typedef struct Box Box

Function Documentation

◆ AddNewOwl()

OtpWinList * AddNewOwl	(	TwmWindow *	twm_win,
		WinType	wintype,
		OtpWinList *	parent )

static

Definition at line 1134 of file otp.c.

References ApplyPreferences(), EWMH_STATE_ABOVE, EWMH_STATE_BELOW, EWMH_STATE_FULLSCREEN, EwmhGetInitPriority(), IconWin, InsertOwl(), TwmWindow::istransient, new_OtpWinList(), OTP_ZERO, OwlGetStashedAflags(), OwlStashAflags(), PRI, OtpWinList::pri_aflags, OtpWinList::pri_base, PRI_CP, OtpPreferences::priority, Scr, OtpWinList::stashed_aflags, OtpPreferences::switching, and OtpWinList::switching.

Referenced by OtpAdd().

◆ ApplyPreferences()

void ApplyPreferences	(	OtpPreferences *	prefs,
		OtpWinList *	owl )

static

Definition at line 1024 of file otp.c.

References TwmWindow::class, LookInList(), TwmWindow::name, OTP_MAX, OtpWinList::pri_base, OtpPreferences::priorityL, OtpPreferences::switching, OtpWinList::switching, OtpPreferences::switchingL, and OtpWinList::twm_win.

Referenced by AddNewOwl(), and RecomputeOwlPrefs().

◆ BoxesIntersect()

bool BoxesIntersect	(	Box *	b1,
		Box *	b2 )

static

Definition at line 121 of file otp.c.

References Box::height, Box::width, Box::x, and Box::y.

Referenced by isIntersectingWith().

◆ BoxOfOwl()

Box BoxOfOwl ( OtpWinList * owl )

static

Definition at line 91 of file otp.c.

References TwmWindow::frame_height, TwmWindow::frame_width, TwmWindow::frame_x, TwmWindow::frame_y, Box::height, TwmWindow::icon, IconWin, OtpWinList::twm_win, OtpWinList::type, Icon::w_height, Icon::w_width, Icon::w_x, Icon::w_y, Box::width, WinWin, Box::x, and Box::y.

Referenced by isIntersectingWith().

◆ free_OtpPreferences()

void free_OtpPreferences ( OtpPreferences * pref )

static

Definition at line 1354 of file otp.c.

References FreeList(), OTP_MAX, OtpPreferences::priorityL, and OtpPreferences::switchingL.

Referenced by OtpScrInitData().

◆ free_OtpWinList()

void free_OtpWinList ( OtpWinList * owl )

static

Definition at line 1086 of file otp.c.

References OtpWinList::above, and OtpWinList::below.

Referenced by OtpRemove().

◆ GetOwlAtOrBelowInVS()

OtpWinList * GetOwlAtOrBelowInVS	(	OtpWinList *	owl,
		VirtualScreen *	vs )

static

For the purpose of putting a window above another, they need to have the same parent, i.e.

be in the same VirtualScreen.

Definition at line 378 of file otp.c.

References OtpWinList::below, TwmWindow::parent_vs, and OtpWinList::twm_win.

Referenced by InsertOwlAbove().

◆ InsertOwl()

void InsertOwl	(	OtpWinList *	owl,
		int	where )

static

Definition at line 561 of file otp.c.

References OtpWinList::above, OtpWinList::below, DPRINTF, InsertOwlAbove(), OwlRightBelow(), PRI, PRI_CP, RaiseSmallTransientsOfAbove(), Scr, and shouldStayAbove().

Referenced by AddNewOwl(), LowerOwl(), OtpFocusWindowBE(), OtpRestackWindow(), RaiseOwl(), RecomputeOwlPrefs(), and SetOwlPriority().

◆ InsertOwlAbove()

void InsertOwlAbove	(	OtpWinList *	owl,
		OtpWinList *	other_owl )

static

Definition at line 415 of file otp.c.

References OtpWinList::above, OtpWinList::below, DPRINTF, dpy, GetOwlAtOrBelowInVS(), TwmWindow::parent_vs, PRI, Scr, OtpWinList::twm_win, WindowOfOwl(), VirtualScreen::x, and VirtualScreen::y.

Referenced by InsertOwl(), OtpForcePlacement(), RaiseSmallTransientsOfAbove(), ReparentWindow(), ReparentWindowAndIcon(), TinyLowerOwl(), and TinyRaiseOwl().

◆ isGroupLeader()

bool isGroupLeader ( TwmWindow * twm_win )

Definition at line 153 of file otp.c.

References TwmWindow::group, and TwmWindow::w.

Referenced by isGroupLeaderOf(), and OtpAdd().

◆ isGroupLeaderOf()

bool isGroupLeaderOf	(	TwmWindow *	leader,
		TwmWindow *	twm_win )

Definition at line 159 of file otp.c.

References TwmWindow::group, and isGroupLeader().

Referenced by OtpAdd().

◆ isHiddenBy()

bool isHiddenBy	(	OtpWinList *	owl,
		OtpWinList *	other_owl )

static

Definition at line 693 of file otp.c.

References isIntersectingWith(), and isOnScreen().

Referenced by RaiseLowerOwl(), TinyLowerOwl(), and TinyRaiseOwl().

◆ isIntersectingWith()

bool isIntersectingWith	(	OtpWinList *	owl1,
		OtpWinList *	owl2 )

static

Definition at line 130 of file otp.c.

References BoxesIntersect(), and BoxOfOwl().

Referenced by isHiddenBy().

◆ isOnScreen()

bool isOnScreen ( OtpWinList * owl )

static

Definition at line 139 of file otp.c.

References TwmWindow::iconified, IconWin, TwmWindow::mapped, OCCUPY, Scr, OtpWinList::twm_win, and OtpWinList::type.

Referenced by isHiddenBy().

◆ isSmallTransientOf()

bool isSmallTransientOf	(	TwmWindow *	trans,
		TwmWindow *	main )

Definition at line 166 of file otp.c.

References TwmWindow::frame, TwmWindow::frame_height, TwmWindow::frame_width, isTransientOf(), main(), and Scr.

Referenced by shouldStayAbove().

◆ isTransientOf()

bool isTransientOf	(	TwmWindow *	trans,
		TwmWindow *	main )

Definition at line 148 of file otp.c.

References TwmWindow::istransient, main(), and TwmWindow::transientfor.

Referenced by isSmallTransientOf(), OtpAdd(), OtpFocusWindowBE(), and TryToMoveTransientsOfTo().

◆ LowerOwl()

void LowerOwl ( OtpWinList * owl )

static

Definition at line 686 of file otp.c.

References InsertOwl(), RemoveOwl(), and TryToSwitch().

Referenced by OtpLower(), and RaiseLowerOwl().

◆ new_OtpPreferences()

OtpPreferences * new_OtpPreferences ( void )

static

Definition at line 1338 of file otp.c.

References OTP_MAX, OTP_ZERO, OtpPreferences::priority, OtpPreferences::priorityL, OtpPreferences::switching, and OtpPreferences::switchingL.

Referenced by OtpScrInitData().

◆ new_OtpWinList()

OtpWinList * new_OtpWinList	(	TwmWindow *	twm_win,
		WinType	wintype,
		bool	switching,
		int	priority )

static

Definition at line 1109 of file otp.c.

References OtpWinList::above, OtpWinList::below, OtpWinList::pri_aflags, OtpWinList::pri_base, OtpWinList::stashed_aflags, OtpWinList::switching, OtpWinList::twm_win, OtpWinList::type, and WinWin.

Referenced by AddNewOwl().

◆ OtpAdd()

void OtpAdd	(	TwmWindow *	twm_win,
		WinType	wintype )

Definition at line 1222 of file otp.c.

References AddNewOwl(), TwmWindow::icon, IconWin, isGroupLeader(), isGroupLeaderOf(), TwmWindow::istransient, isTransientOf(), TwmWindow::next, Icon::otp, TwmWindow::otp, OtpCheckConsistency(), Scr, OtpWinList::switching, and WinWin.

Referenced by AddWindow(), CreateIconWindow(), and OtpReassignIcon().

◆ OtpBottomWin()

TwmWindow * OtpBottomWin ( void )

Definition at line 1437 of file otp.c.

References OtpWinList::above, Scr, OtpWinList::twm_win, OtpWinList::type, and WinWin.

Referenced by EwmhSet_NET_CLIENT_LIST_STACKING(), GotoWorkSpace(), and RestoreForShutdown().

◆ OtpChangePriority()

void OtpChangePriority	(	TwmWindow *	twm_win,
		WinType	wintype,
		int	relpriority )

Definition at line 920 of file otp.c.

References TwmWindow::icon, IconWin, Icon::otp, TwmWindow::otp, OtpCheckConsistency(), OtpWinList::pri_base, SetOwlPriority(), and TryToMoveTransientsOfTo().

Referenced by otp_priority_handler().

◆ OtpCheckConsistency()

bool OtpCheckConsistency ( void )

Definition at line 188 of file otp.c.

References VirtualScreen::next, OtpCheckConsistencyVS(), Scr, VirtualScreen::window, VirtualScreen::x, and VirtualScreen::y.

Referenced by DisplayWin(), GotoWorkSpace(), OtpAdd(), OtpChangePriority(), OtpFocusWindowBE(), OtpForcePlacement(), OtpLower(), OtpRaise(), OtpRaiseLower(), OtpRecomputePrefs(), OtpRemove(), OtpRestackWindow(), OtpSetPriority(), OtpSwitchPriority(), OtpTinyLower(), OtpTinyRaise(), OtpToggleSwitching(), ReparentWindow(), and ReparentWindowAndIcon().

◆ OtpCheckConsistencyVS()

bool OtpCheckConsistencyVS	(	VirtualScreen *	currentvs,
		Window	vroot )

static

Definition at line 205 of file otp.c.

References OtpWinList::above, OtpWinList::below, DPRINTF, dpy, TwmWindow::icon, IconWin, TwmWindow::name, TwmWindow::next, TwmWindow::occupation, Icon::otp, TwmWindow::otp, OTP_MAX, OwlPrettyPrint(), TwmWindow::parent_vs, PRI, OtpWinList::pri_base, root, Scr, OtpWinList::twm_win, OtpWinList::type, TwmWindow::vs, WindowOfOwl(), WinWin, VirtualScreen::x, and VirtualScreen::y.

Referenced by OtpCheckConsistency().

◆ OtpCirculateSubwindows()

void OtpCirculateSubwindows	(	VirtualScreen *	vs,
		int	direction )

Definition at line 849 of file otp.c.

References DPRINTF, dpy, Event, HandleCirculateNotify(), and VirtualScreen::window.

Referenced by f_circledown_impl(), and f_circleup_impl().

◆ OtpClearAflag()

void OtpClearAflag	(	TwmWindow *	twm_win,
		unsigned	flag )

Definition at line 1559 of file otp.c.

References TwmWindow::otp, and OwlClearAflag().

Referenced by unzoom().

◆ OtpEffectiveDisplayPriority()

int OtpEffectiveDisplayPriority ( TwmWindow * twm_win )

Definition at line 1794 of file otp.c.

References TwmWindow::otp, OTP_ZERO, and OwlEffectivePriority().

Referenced by EwmhSet_NET_WM_STATE(), Identify(), and OwlPrettyPrint().

◆ OtpEffectivePriority()

int OtpEffectivePriority ( TwmWindow * twm_win )

Definition at line 1803 of file otp.c.

References TwmWindow::otp, and OwlEffectivePriority().

Referenced by EwmhClientMessage_NET_WM_STATEchange(), and OwlPrettyPrint().

◆ OtpFocusWindow()

void OtpFocusWindow ( TwmWindow * twm_win )

Focus a window.

This needs to know internals of OTP because of focus-dependent stacking of it and its transients.

Definition at line 1774 of file otp.c.

References TwmWindow::otp, OtpFocusWindowBE(), PRI, and Scr.

Referenced by HandleFocusIn(), and SetFocus().

◆ OtpFocusWindowBE()

void OtpFocusWindowBE	(	TwmWindow *	twm_win,
		int	oldprio )

static

Focus/unfocus backend.

This is used on windows whose stacking is focus-dependent (e.g., EWMH fullscreen), to move them and their transients around. For these windows, getting/losing focus is practically the same as a f.setpriority, except it's on the calculated rather than the base parts. And it's hard to re-use our existing functions to do it because we have to move Scr->Focus before the main window changes, but then it's too late to see where all the transients were.

There are a number of unpleasant assumptions in here relating to where the transients are, and IWBNI we could be smarter and quicker about dealing with them. But this gets us past the simple to cause assertion failures, anyway...

Definition at line 1675 of file otp.c.

References OtpWinList::above, InsertOwl(), isTransientOf(), TwmWindow::otp, OtpCheckConsistency(), RemoveOwl(), Scr, OtpWinList::twm_win, OtpWinList::type, and WinWin.

Referenced by OtpFocusWindow(), and OtpUnfocusWindow().