Cppcheck report - cafe-panel (cppcheck 2.14.0-1+b1): cafe-panel/panel-multimonitor.c

/*
 * panel-multimonitor.c: Multi-monitor and Xinerama support for the panel.
 *
 * Copyright (C) 2001 George Lebl <jirka@5z.com>
 *               2002 Sun Microsystems Inc.
 *
 * 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 St, Fifth Floor, Boston, MA 02110-1301
 * USA
 *
 * Authors: George Lebl <jirka@5z.com>,
 *          Mark McLoughlin <mark@skynet.ie>
 */

#include <config.h>

#ifdef HAVE_X11
#include <X11/Xatom.h>
#include <X11/Xlib.h>
#include <X11/extensions/Xrandr.h>
#include <cdk/cdkx.h>
#endif // HAVE_X11

#include "panel-multimonitor.h"

#include <string.h>

// The number of logical monitors we are keeping track of
// May be different than cdk_display_get_n_monitors()
// (see comment in panel_multimonitor_compress_overlapping_monitors for details)
static int            monitor_count = 0;

// A dynamically allocated array of monitor geometries
// monitor_count is the length
static CdkRectangle  *geometries = NULL;<--- Shadowed declaration<--- Shadowed declaration<--- Shadowed declaration

static gboolean       initialized = FALSE;
static gboolean       have_randr  = FALSE;
static guint          reinit_id   = 0;

#ifdef HAVE_X11
#ifdef HAVE_RANDR
static gboolean
_panel_multimonitor_output_should_be_first (Display       *xdisplay,
					    RROutput       output,
					    XRROutputInfo *info,
					    RROutput       primary)
{
	if (primary)
		return output == primary;

	Atom           connector_type_atom;
	Atom           actual_type;
	int            actual_format;
	unsigned long  nitems;
	unsigned long  bytes_after;
	unsigned char *prop;
	char          *connector_type;
<--- The scope of the variable 'connector_type' can be reduced. [+]
The scope of the variable 'connector_type' can be reduced. Warning: Be careful when fixing this message, especially when there are inner loops. Here is an example where cppcheck will write that the scope for 'i' can be reduced:
void f(int x)
{
    int i = 0;
    if (x) {
        // it's safe to move 'int i = 0;' here
        for (int n = 0; n < 10; ++n) {
            // it is possible but not safe to move 'int i = 0;' here
            do_something(&i);
        }
    }
}
When you see this message it is always safe to reduce the variable scope 1 level.
	gboolean       retval;

	connector_type_atom = XInternAtom (xdisplay, "ConnectorType", False);

	if (XRRGetOutputProperty (xdisplay, output, connector_type_atom,
				  0, 100, False, False, None,
				  &actual_type, &actual_format,
				  &nitems, &bytes_after, &prop) == Success) {
		if (actual_type == XA_ATOM && nitems == 1 && actual_format == 32) {
			connector_type = XGetAtomName (xdisplay, prop[0]);
			retval = g_strcmp0 (connector_type, "Panel") == 0;
			XFree (connector_type);
			return retval;
		}
	}

	/* Fallback (see https://bugs.freedesktop.org/show_bug.cgi?id=26736)
	 * "LVDS" is the oh-so-intuitive name that X gives to laptop LCDs.
	 * It can actually be LVDS0, LVDS-0, Lvds, etc.
	 */
	return (g_ascii_strncasecmp (info->name, "LVDS", strlen ("LVDS")) == 0);
}

static gboolean
panel_multimonitor_get_randr_monitors (int           *monitors_ret,
				       CdkRectangle **geometries_ret)
{
	CdkDisplay         *display;
	CdkScreen          *screen;
	CdkMonitor         *monitor;
	Display            *xdisplay;
	Window              xroot;
	XRRScreenResources *resources;
	RROutput            primary;
	GArray             *geometries;<--- Shadow variable
	int                 scale;
	int                 i;

	display = cdk_display_get_default ();

	g_return_val_if_fail (have_randr, FALSE);
	g_return_val_if_fail (CDK_IS_X11_DISPLAY (display), FALSE);

	/* CTK+ 2.14.x uses the Xinerama API, instead of RANDR, to get the
	 * monitor geometries. It does this to avoid calling
	 * XRRGetScreenResources(), which is slow as it re-detects all the
	 * monitors --- note that XRRGetScreenResourcesCurrent() had not been
	 * introduced yet.  Using Xinerama in CTK+ has the bad side effect that
	 * cdk_screen_get_monitor_plug_name() will return NULL, as Xinerama
	 * does not provide that information, unlike RANDR.
	 *
	 * Here we need to identify the output names, so that we can put the
	 * built-in LCD in a laptop *before* all other outputs.  This is so
	 * that cafe-panel will normally prefer to appear on the "native"
	 * display rather than on an external monitor.
	 *
	 * To get the output names and geometries, we will not use
	 * cdk_screen_get_n_monitors() and friends, but rather we will call
	 * XRR*() directly.
	 *
	 * See https://bugzilla.novell.com/show_bug.cgi?id=479684 for this
	 * particular bug, and and
	 * http://bugzilla.gnome.org/show_bug.cgi?id=562944 for a more
	 * long-term solution.
	 */
	screen = cdk_display_get_default_screen (display);
	xdisplay = CDK_SCREEN_XDISPLAY (screen);
	xroot = CDK_WINDOW_XID (cdk_screen_get_root_window (screen));

	resources = XRRGetScreenResourcesCurrent (xdisplay, xroot);
	if (resources->noutput == 0) {
		/* This might happen if nothing tried to get randr
		 * resources from the server before, so we need an
		 * active probe. See comment #27 in
		 * https://bugzilla.gnome.org/show_bug.cgi?id=597101 */
		XRRFreeScreenResources (resources);
		resources = XRRGetScreenResources (xdisplay, xroot);
	}

	if (!resources)
		return FALSE;

	primary = XRRGetOutputPrimary (xdisplay, xroot);
	monitor = cdk_display_get_primary_monitor (display);

	/* Use scale factor to bring geometries down to device pixels to support HiDPI displays */
	scale = cdk_monitor_get_scale_factor (monitor);

	geometries = g_array_sized_new (FALSE, FALSE,
					sizeof (CdkRectangle),
					resources->noutput);

	for (i = 0; i < resources->noutput; i++) {
		XRROutputInfo *output;

		output = XRRGetOutputInfo (xdisplay, resources,
					   resources->outputs[i]);

		if (output->connection != RR_Disconnected &&
		    output->crtc != 0) {
			XRRCrtcInfo  *crtc;
			CdkRectangle  rect;

			crtc = XRRGetCrtcInfo (xdisplay, resources,
					       output->crtc);

			rect.x      = crtc->x / scale;
			rect.y      = crtc->y / scale;
			rect.width  = crtc->width / scale;
			rect.height = crtc->height / scale;

			XRRFreeCrtcInfo (crtc);

			if (_panel_multimonitor_output_should_be_first (xdisplay,
									resources->outputs[i],
									output, primary))
				g_array_prepend_vals (geometries, &rect, 1);
			else
				g_array_append_vals (geometries, &rect, 1);
		}

		XRRFreeOutputInfo (output);
	}

	XRRFreeScreenResources (resources);

	if (geometries->len == 0) {
		/* This can happen in at least one case:
		 * https://bugzilla.novell.com/show_bug.cgi?id=543876 where all
		 * monitors appear disconnected (possibly because the  screen
		 * is behing a KVM switch) -- see comment #8.
		 * There might be other cases too, so we stay on the safe side.
		 */
		g_array_free (geometries, TRUE);
		return FALSE;
	}

	*monitors_ret = geometries->len;
	*geometries_ret = (CdkRectangle *) g_array_free (geometries, FALSE);

	return TRUE;
}
#endif // HAVE_RANDR
#endif // HAVE_X11

static void
panel_multimonitor_get_cdk_monitors (int           *monitors_ret,
				     CdkRectangle **geometries_ret)
{
	CdkDisplay   *display;
	int           num_monitors;
	CdkRectangle *geometries;<--- Shadow variable
	int           i;

	display = cdk_display_get_default ();
	num_monitors = cdk_display_get_n_monitors (display);
	geometries = g_new (CdkRectangle, num_monitors);

	for (i = 0; i < num_monitors; i++)
		cdk_monitor_get_geometry (cdk_display_get_monitor (display, i), &(geometries[i]));

	*monitors_ret = num_monitors;
	*geometries_ret = geometries;
}

static void
panel_multimonitor_get_raw_monitors (int           *monitors_ret,
				     CdkRectangle **geometries_ret)
{
	gboolean res = FALSE;

	*monitors_ret = 0;<--- Assignment '*monitors_ret=0', assigned value is 0
	*geometries_ret = NULL;

#ifdef HAVE_X11
#ifdef HAVE_RANDR
	if (CDK_IS_X11_DISPLAY (cdk_display_get_default ()) && have_randr)
		res = panel_multimonitor_get_randr_monitors (monitors_ret, geometries_ret);
#endif // HAVE_RANDR
#endif // HAVE_X11

	if (res && *monitors_ret > 0)<--- Condition '*monitors_ret>0' is always false
		return;

	panel_multimonitor_get_cdk_monitors (monitors_ret, geometries_ret);
}

static inline gboolean
rectangle_overlaps (CdkRectangle *a,
		    CdkRectangle *b)
{
	return cdk_rectangle_intersect (a, b, NULL);
}

static long
pixels_in_rectangle (CdkRectangle *r)<--- Parameter 'r' can be declared as pointer to const
{
	return (long) (r->width * r->height);
}

static void
panel_multimonitor_compress_overlapping_monitors (int           *num_monitors_inout,
						  CdkRectangle **geometries_inout)
{
	int           num_monitors;
	CdkRectangle *geometries;<--- Shadow variable
	int           i;

	num_monitors = *num_monitors_inout;
	geometries = *geometries_inout;

	/* http://bugzilla.gnome.org/show_bug.cgi?id=530969
	 * https://bugzilla.novell.com/show_bug.cgi?id=310208
	 * and many other such bugs...
	 *
	 * RANDR sometimes gives us monitors that overlap (i.e. outputs whose
	 * bounding rectangles overlap). This is sometimes right and sometimes
	 * wrong:
	 *
	 *   * Right - two 1024x768 outputs at the same offset (0, 0) that show
	 *     the same thing.  Think "laptop plus projector with the same
	 *     resolution".
	 *
	 *   * Wrong - one 1280x1024 output ("laptop internal LCD") and another
	 *     1024x768 output ("external monitor"), both at offset (0, 0).
	 *     There is no way for the monitor with the small resolution to
	 *     show the complete image from the laptop's LCD, unless one uses
	 *     panning (but nobody wants panning, right!?).
	 *
	 * With overlapping monitors, we may end up placing the panel with
	 * respect to the "wrong" one.  This is always wrong, as the panel
	 * appears "in the middle of the screen" of the monitor with the
	 * smaller resolution, instead of at the edge.
	 *
	 * Our strategy is to find the subsets of overlapping monitors, and
	 * "compress" each such set to being like if there were a single
	 * monitor with the biggest resolution of each of that set's monitors.
	 * Say we have four monitors
	 *
	 *      A, B, C, D
	 *
	 * where B and D overlap.  In that case, we'll generate a new list that
	 * looks like
	 *
	 *      A, MAX(B, D), C
	 *
	 * with three monitors.
	 *
	 * NOTE FOR THE FUTURE: We could avoid most of this mess if we had a
	 * concept of a "primary monitor". Also, we could look at each
	 * output's name or properties to see if it is the built-in LCD in a
	 * laptop. However, with CTK+ 2.14.x we don't get output names, since
	 * it gets the list outputs from Xinerama, not RANDR (and Xinerama
	 * doesn't provide output names).
	 */

	for (i = 0; i < num_monitors; i++) {
		long max_pixels;
		int  j;

		max_pixels = pixels_in_rectangle (&geometries[i]);

		j = i + 1;

		while (j < num_monitors) {
			if (rectangle_overlaps (&geometries[i],
						&geometries[j])) {
				long pixels;

				pixels = pixels_in_rectangle (&geometries[j]);
				if (pixels > max_pixels) {
					max_pixels = pixels;
					/* keep the maximum */
					geometries[i] = geometries[j];
				}

				/* Shift the remaining monitors to the left */
				if (num_monitors - j - 1 > 0)
					memmove (&geometries[j],
						 &geometries[j + 1],
						 sizeof (geometries[0]) * (num_monitors - j - 1));

				num_monitors--;
				g_assert (num_monitors > 0);
			} else
				j++;
		}
	}

	*num_monitors_inout = num_monitors;
	*geometries_inout = geometries;
}

static gboolean
panel_multimonitor_reinit_idle (gpointer data)
{
	panel_multimonitor_reinit ();
	reinit_id = 0;

	return FALSE;
}

static void
panel_multimonitor_handle_screen_changed (CdkScreen *screen,
					  gpointer    user_data)
{
	if (reinit_id)
		return;

	reinit_id = g_idle_add (panel_multimonitor_reinit_idle, NULL);
}

static void
panel_multimonitor_handle_monitor_changed (CdkDisplay *display,
					   CdkMonitor *monitor,
					   gpointer    user_data)
{
	if (reinit_id)
		return;

	reinit_id = g_idle_add (panel_multimonitor_reinit_idle, NULL);
}

static void
panel_multimonitor_handle_monitor_invalidate (CdkMonitor *monitor,
					      gpointer    user_data)
{
	if (reinit_id)
		return;

	reinit_id = g_idle_add (panel_multimonitor_reinit_idle, NULL);
}

#ifdef HAVE_X11
#ifdef HAVE_RANDR
static void
panel_multimonitor_init_randr (CdkDisplay *display)
{
	Display *xdisplay;
	int      event_base, error_base;

	g_return_if_fail (CDK_IS_X11_DISPLAY (display));

	have_randr = FALSE;

	if (!CDK_IS_X11_DISPLAY (display))
		return;

	xdisplay = CDK_DISPLAY_XDISPLAY (display);

	/* We don't remember the event/error bases, as we expect to get monitor
	 * added/removed events from the display instead.
	 */

	if (XRRQueryExtension (xdisplay, &event_base, &error_base)) {
		int major, minor;

		XRRQueryVersion (xdisplay, &major, &minor);
		if ((major == 1 && minor >= 3) || major > 1)
			have_randr = TRUE;
	}
}
#endif // HAVE_RANDR
#endif // HAVE_X11

void
panel_multimonitor_init (void)
{
	CdkDisplay *display;
	CdkScreen  *screen;
	int i;

	if (initialized)
		return;

	display = cdk_display_get_default ();
	screen = cdk_display_get_default_screen (display);

	have_randr = FALSE;

#ifdef HAVE_X11
#ifdef HAVE_RANDR
	if (CDK_IS_X11_DISPLAY (display))
		panel_multimonitor_init_randr (display);
#endif // HAVE_RANDR
#endif // HAVE_X11

	/*
	 * The screen signals probably shouldn't be needed, but sometimes on X11 they are
	 * the only ones that get fired
	 */

	g_signal_handlers_disconnect_by_func (screen, panel_multimonitor_handle_screen_changed, NULL);
	g_signal_connect (screen, "size-changed",
			  G_CALLBACK (panel_multimonitor_handle_screen_changed), NULL);
	g_signal_connect (screen, "monitors-changed",
			  G_CALLBACK (panel_multimonitor_handle_screen_changed), NULL);

	g_signal_handlers_disconnect_by_func (display, panel_multimonitor_handle_monitor_changed, NULL);
	g_signal_connect (display, "monitor-added",
			  G_CALLBACK (panel_multimonitor_handle_monitor_changed), NULL);
	g_signal_connect (display, "monitor-removed",
			  G_CALLBACK (panel_multimonitor_handle_monitor_changed), NULL);

	for (i = 0; i < cdk_display_get_n_monitors (display); i++) {
		CdkMonitor *monitor;

		monitor = cdk_display_get_monitor (display, i);
		g_signal_handlers_disconnect_by_func (display, panel_multimonitor_handle_monitor_invalidate, NULL);
		g_signal_connect (monitor, "invalidate",
			  G_CALLBACK (panel_multimonitor_handle_monitor_invalidate), NULL);
	}

	panel_multimonitor_get_raw_monitors (&monitor_count, &geometries);
	panel_multimonitor_compress_overlapping_monitors (&monitor_count, &geometries);

	initialized = TRUE;
}

void
panel_multimonitor_reinit (void)
{
	GList      *toplevels, *l;

	if (geometries)
		g_free (geometries);

	initialized = FALSE;
	panel_multimonitor_init ();

	toplevels = ctk_window_list_toplevels ();

	for (l = toplevels; l; l = l->next)
		ctk_widget_queue_resize (l->data);

	g_list_free (toplevels);
}

int
panel_multimonitor_monitors ()
{
	return monitor_count;
}

int
panel_multimonitor_x (int monitor)
{
	g_return_val_if_fail (monitor >= 0 && monitor < monitor_count, 0);
	return geometries [monitor].x;
}

int
panel_multimonitor_y (int monitor)
{
	g_return_val_if_fail (monitor >= 0 && monitor < monitor_count, 0);
	return geometries [monitor].y;
}

int
panel_multimonitor_width (int monitor)
{
	g_return_val_if_fail (monitor >= 0 && monitor < monitor_count, 0);
	return geometries [monitor].width;
}

int
panel_multimonitor_height (int monitor)
{
	g_return_val_if_fail (monitor >= 0 && monitor < monitor_count, 0);
	return geometries [monitor].height;
}

int
panel_multimonitor_locate_widget_monitor (CtkWidget *widget)
{
	CtkWidget *toplevel;
	int        retval = -1;

	toplevel = ctk_widget_get_toplevel (widget);
	if (!toplevel)
		return -1;

	g_object_get (toplevel, "monitor", &retval, NULL);

	return retval;
}

static int
axis_distance (int p, int axis_start, int axis_size)
{
	if (p >= axis_start && p < axis_start + axis_size)
		return 0;
	else if (p < axis_start)
		return (axis_start - p);
	else
		return (p - (axis_start + axis_size - 1));
}

/* The panel can't use cdk_screen_get_monitor_at_point() since it has its own
 * view of which monitors are present. Look at get_monitors_for_screen() above
 * to see why. */
int
panel_multimonitor_get_monitor_at_point (int x, int y)
{
	int i;
	int min_dist_squared;
	int closest_monitor;

	min_dist_squared = G_MAXINT32;
	closest_monitor = 0;

	for (i = 0; i < monitor_count; i++) {
		int dist_x, dist_y;
		int dist_squared;

		dist_x = axis_distance (x, geometries[i].x, geometries[i].width);
		dist_y = axis_distance (y, geometries[i].y, geometries[i].height);

		if (dist_x == 0 && dist_y == 0)
			return i;

		dist_squared = dist_x * dist_x + dist_y * dist_y;

		if (dist_squared < min_dist_squared) {
			min_dist_squared = dist_squared;
			closest_monitor = i;
		}
	}

	return closest_monitor;
}

typedef struct {
	int x0;
	int y0;
	int x1;
	int y1;
} MonitorBounds;

static inline void
get_monitor_bounds (int            n_monitor,
		    MonitorBounds *bounds)
{
	g_return_if_fail (n_monitor >= 0 || n_monitor < monitor_count);
	g_return_if_fail (bounds != NULL);

	bounds->x0 = geometries [n_monitor].x;
	bounds->y0 = geometries [n_monitor].y;
	bounds->x1 = bounds->x0 + geometries [n_monitor].width;
	bounds->y1 = bounds->y0 + geometries [n_monitor].height;
}

/* determines whether a given monitor is along the visible
 * edge of the logical screen.
 */
void
panel_multimonitor_is_at_visible_extreme (int        n_monitor,
					  gboolean  *leftmost,
					  gboolean  *rightmost,
					  gboolean  *topmost,
					  gboolean  *bottommost)
{
	MonitorBounds monitor;
	int           i;

	*leftmost   = TRUE;
	*rightmost  = TRUE;
	*topmost    = TRUE;
	*bottommost = TRUE;

	g_return_if_fail (n_monitor >= 0 && n_monitor < monitor_count);

	get_monitor_bounds (n_monitor, &monitor);

	/* go through each monitor and try to find one either right,
	 * below, above, or left of the specified monitor
	 */

	for (i = 0; i < monitor_count; i++) {
		MonitorBounds iter;

		if (i == n_monitor) continue;

		get_monitor_bounds (i, &iter);

		if ((iter.y0 >= monitor.y0 && iter.y0 <  monitor.y1) ||
		    (iter.y1 >  monitor.y0 && iter.y1 <= monitor.y1)) {
			if (iter.x0 < monitor.x0)
				*leftmost = FALSE;
			if (iter.x1 > monitor.x1)
				*rightmost = FALSE;
		}

		if ((iter.x0 >= monitor.x0 && iter.x0 <  monitor.x1) ||
		    (iter.x1 >  monitor.x0 && iter.x1 <= monitor.x1)) {
			if (iter.y0 < monitor.y0)
				*topmost = FALSE;
			if (iter.y1 > monitor.y1)
				*bottommost = FALSE;
		}
	}
}

void
panel_multimonitor_get_bounds (CdkPoint *min,
			       CdkPoint *max)
{
	int i;

	g_return_if_fail (monitor_count > 0);

	min->x = min->y = INT_MAX;
	max->x = max->y = INT_MIN;

	for (i = 0; i < monitor_count; i++) {
		min->x = MIN (min->x, geometries[i].x);
		min->y = MIN (min->y, geometries[i].y);
		max->x = MAX (max->x, geometries[i].x + geometries[i].width);
		max->y = MAX (max->y, geometries[i].y + geometries[i].height);
	}
}