Merge lp:~mc-return/compiz/compiz.merge-plugin-workspacenames into lp:compiz/0.9.8

[MC Return]

Added the unsupported, but fully working plug-in "workspacenames" converted from git to bzr (including history) to Compiz 0.9.8.

Adds the unsupported, but fully working plug-in "workspacenames" converted from git to bzr (including history) to Compiz 0.9.8.

[MC Return (mc-return)]

This one should work now :)

[Sam Spilsbury (smspillaz)]

review: Approve

=== added directory 'plugins/workspacenames'
=== added file 'plugins/workspacenames/CMakeLists.txt'
--- plugins/workspacenames/CMakeLists.txt	1970-01-01 00:00:00 +0000
+++ plugins/workspacenames/CMakeLists.txt	2012-06-15 08:14:21 +0000
@@ -0,0 +1,5 @@
+find_package (Compiz REQUIRED)
+
+include (CompizPlugin)
+
+compiz_plugin (workspacenames PLUGINDEPS composite opengl text)

=== added directory 'plugins/workspacenames/src'
=== added file 'plugins/workspacenames/src/workspacenames.cpp'
--- plugins/workspacenames/src/workspacenames.cpp	1970-01-01 00:00:00 +0000
+++ plugins/workspacenames/src/workspacenames.cpp	2012-06-15 08:14:21 +0000
@@ -0,0 +1,250 @@
+/*
+ *
+ * Compiz workspace name display plugin
+ *
+ * workspacenames.cpp
+ *
+ * Copyright : (C) 2008 by Danny Baumann
+ * E-mail    : [e-mail]
+ * 
+ * Ported to Compiz 0.9.x
+ * Copyright : (c) 2010 Scott Moreau <[e-mail]>
+ *
+ * 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.
+ *
+ */
+
+#include "workspacenames.h"
+
+CompString
+WSNamesScreen::getCurrentWSName ()
+{
+    int		currentVp;
+    int		listSize, i;
+    CompString	ret;
+    CompOption::Value::Vector names;
+    CompOption::Value::Vector vpNumbers;
+
+    vpNumbers = optionGetViewports ();
+    names     = optionGetNames ();
+
+    currentVp = screen->vp ().y () * screen->vpSize ().width () +
+		screen->vp ().x () + 1;
+    listSize  = MIN (vpNumbers.size (), names.size ());
+
+    for (i = 0; i < listSize; i++)
+	if (vpNumbers[i].i () == currentVp)
+	    return names[i].s ();
+
+    return ret;
+}
+
+void
+WSNamesScreen::renderNameText ()
+{
+    CompText::Attrib attrib;
+    CompString	     name;
+
+    textData.clear ();
+
+    name = getCurrentWSName ();
+
+    if (name.empty ())
+	return;
+
+    /* 75% of the output device as maximum width */
+    attrib.maxWidth  = screen->getCurrentOutputExtents ().width () * 3 / 4;
+    attrib.maxHeight = 100;
+
+    attrib.family = "Sans";
+    attrib.size = optionGetTextFontSize ();
+
+    attrib.color[0] = optionGetFontColorRed ();
+    attrib.color[1] = optionGetFontColorGreen ();
+    attrib.color[2] = optionGetFontColorBlue ();
+    attrib.color[3] = optionGetFontColorAlpha ();
+
+    attrib.flags = CompText::WithBackground | CompText::Ellipsized;
+    if (optionGetBoldText ())
+	attrib.flags |= CompText::StyleBold;
+
+    attrib.bgHMargin = 15;
+    attrib.bgVMargin = 15;
+    attrib.bgColor[0] = optionGetBackColorRed ();
+    attrib.bgColor[1] = optionGetBackColorGreen ();
+    attrib.bgColor[2] = optionGetBackColorBlue ();
+    attrib.bgColor[3] = optionGetBackColorAlpha ();
+
+    textData.renderText (name, attrib);
+}
+
+void
+WSNamesScreen::drawText ()
+{
+    GLfloat  alpha;
+    float    x, y, border = 10.0f;
+    CompRect oe = screen->getCurrentOutputExtents ();
+
+    x = oe.centerX () - textData.getWidth () / 2;
+
+    /* assign y (for the lower corner!) according to the setting */
+    switch (optionGetTextPlacement ())
+    {
+	case WorkspacenamesOptions::TextPlacementCenteredOnScreen:
+	    y = oe.centerY () + textData.getHeight () / 2;
+	    break;
+	case WorkspacenamesOptions::TextPlacementTopOfScreen:
+	case WorkspacenamesOptions::TextPlacementBottomOfScreen:
+	    {
+		CompRect workArea = screen->currentOutputDev ().workArea ();
+
+		if (optionGetTextPlacement () ==
+		    WorkspacenamesOptions::TextPlacementTopOfScreen)
+    		    y = oe.y1 () + workArea.y () +
+			(2 * border) + textData.getHeight ();
+		else
+		    y = oe.y1 () + workArea.y () +
+			workArea.height () - (2 * border);
+	    }
+	    break;
+	default:
+	    return;
+	    break;
+    }
+
+    if (timer)
+	alpha = timer / (optionGetFadeTime () * 1000.0f);
+    else
+	alpha = 1.0f;
+
+    textData.draw (floor (x), floor (y), alpha);
+}
+
+bool
+WSNamesScreen::glPaintOutput (const GLScreenPaintAttrib	&attrib,
+			      const GLMatrix		&transform,
+			      const CompRegion		&region,
+			      CompOutput		*output,
+			      unsigned int		mask)
+{
+    bool status;
+
+    status = gScreen->glPaintOutput (attrib, transform, region, output, mask);
+
+    if (textData.getWidth () && textData.getHeight ())
+    {
+	GLMatrix sTransform (transform);
+
+	sTransform.toScreenSpace (output, -DEFAULT_Z_CAMERA);
+	glPushMatrix ();
+	glLoadMatrixf (sTransform.getMatrix ());
+
+	drawText ();
+
+	glPopMatrix ();
+    }
+
+    return status;
+}
+
+void
+WSNamesScreen::preparePaint (int msSinceLastPaint)
+{
+    if (timer)
+    {
+	timer -= msSinceLastPaint;
+	timer = MAX (timer, 0);
+
+	if (!timer)
+	    textData.clear ();
+    }
+
+    cScreen->preparePaint (msSinceLastPaint);
+}
+
+void
+WSNamesScreen::donePaint ()
+{
+    /* FIXME: better only damage paint region */
+    if (timer)
+	cScreen->damageScreen ();
+
+    cScreen->donePaint ();
+}
+
+bool
+WSNamesScreen::hideTimeout ()
+{
+    timer = optionGetFadeTime () * 1000;
+    if (!timer)
+	textData.clear ();
+
+    cScreen->damageScreen ();
+
+    timeoutHandle.stop ();
+
+    return false;
+}
+
+void
+WSNamesScreen::handleEvent (XEvent *event)
+{
+    screen->handleEvent (event);
+
+   if (event->type != PropertyNotify)
+    return;
+
+    if (event->xproperty.atom == Atoms::desktopViewport)
+    {
+	int timeout = optionGetDisplayTime () * 1000;
+
+	timer = 0;
+	if (timeoutHandle.active ())
+	    timeoutHandle.stop ();
+
+	renderNameText ();
+	timeoutHandle.start (timeout, timeout + 200);
+
+	cScreen->damageScreen ();
+    }
+}
+
+WSNamesScreen::WSNamesScreen (CompScreen *screen) :
+    PluginClassHandler <WSNamesScreen, CompScreen> (screen),
+    cScreen (CompositeScreen::get (screen)),
+    gScreen (GLScreen::get (screen)),
+    timer (0)
+{
+    ScreenInterface::setHandler (screen, true);
+    CompositeScreenInterface::setHandler (cScreen, true);
+    GLScreenInterface::setHandler (gScreen, true);
+
+    timeoutHandle.start (boost::bind (&WSNamesScreen::hideTimeout, this),
+			 0, 0);
+}
+
+WSNamesScreen::~WSNamesScreen ()
+{
+}
+
+bool
+WorkspacenamesPluginVTable::init ()
+{
+    if (!CompPlugin::checkPluginABI ("core", CORE_ABIVERSION) ||
+        !CompPlugin::checkPluginABI ("composite", COMPIZ_COMPOSITE_ABI) ||
+        !CompPlugin::checkPluginABI ("opengl", COMPIZ_OPENGL_ABI))
+    	return false;
+
+    if (!CompPlugin::checkPluginABI ("text", COMPIZ_TEXT_ABI))
+	compLogMessage ("workspacenames", CompLogLevelWarn,
+			"No compatible text plugin loaded");
+    return true;
+}

=== added file 'plugins/workspacenames/src/workspacenames.h'
--- plugins/workspacenames/src/workspacenames.h	1970-01-01 00:00:00 +0000
+++ plugins/workspacenames/src/workspacenames.h	2012-06-15 08:14:21 +0000
@@ -0,0 +1,91 @@
+/*
+ *
+ * Compiz workspace name display plugin
+ *
+ * workspacenames.h
+ *
+ * Copyright : (C) 2008 by Danny Baumann
+ * E-mail    : [e-mail]
+ * 
+ * Ported to Compiz 0.9.x
+ * Copyright : (c) 2010 Scott Moreau <[e-mail]>
+ *
+ * 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.
+ *
+ */
+
+#include <stdio.h>
+#include <stdlib.h>
+#include <math.h>
+
+#include <core/core.h>
+#include <core/atoms.h>
+#include <composite/composite.h>
+#include <opengl/opengl.h>
+#include <text/text.h>
+
+#include "workspacenames_options.h"
+
+class WSNamesScreen :
+    public PluginClassHandler <WSNamesScreen, CompScreen>,
+    public ScreenInterface,
+    public CompositeScreenInterface,
+    public GLScreenInterface,
+    public WorkspacenamesOptions
+{
+    public:
+	WSNamesScreen (CompScreen *screen);
+	~WSNamesScreen ();
+
+	CompositeScreen *cScreen;
+	GLScreen	*gScreen;
+
+	CompText	textData;
+	CompTimer	timeoutHandle;
+	int		timer;
+
+	CompString
+	getCurrentWSName ();
+
+	void
+	renderNameText ();
+
+	void
+	drawText ();
+
+	bool
+	glPaintOutput (const GLScreenPaintAttrib &attrib,
+		       const GLMatrix	         &transform,
+		       const CompRegion	         &region,
+		       CompOutput	         *output,
+		       unsigned int              mask);
+
+	void
+	preparePaint (int ms);
+
+	void
+	donePaint ();
+
+	bool
+	hideTimeout ();
+
+	void
+	handleEvent (XEvent *);
+};
+
+class WorkspacenamesPluginVTable :
+    public CompPlugin::VTableForScreen <WSNamesScreen>
+{
+    public:
+	bool init ();
+};
+
+COMPIZ_PLUGIN_20090315 (workspacenames, WorkspacenamesPluginVTable);

=== added file 'plugins/workspacenames/workspacenames.xml.in'
--- plugins/workspacenames/workspacenames.xml.in	1970-01-01 00:00:00 +0000
+++ plugins/workspacenames/workspacenames.xml.in	2012-06-15 08:14:21 +0000
@@ -0,0 +1,114 @@
+<?xml version="1.0"?>
+<compiz>
+	<plugin name="workspacenames" useBcop="true">
+		<_short>Workspace Naming</_short>
+		<_long>Allows assigning descriptions to workspaces</_long>
+		<category>Window Management</category>
+		<deps>
+			<relation type="after">
+				<plugin>opengl</plugin>
+				<plugin>composite</plugin>
+				<plugin>text</plugin>
+			</relation>
+			<requirement>
+				<plugin>opengl</plugin>
+			</requirement>
+		</deps>
+		<options>
+			<group>
+				<_short>Names</_short>
+				<subgroup>
+					<_short>Workspace Names</_short>
+					<option name="viewports" type="list">
+						<_short>Viewport</_short>
+						<_long>Number of viewport to be named</_long>
+						<type>int</type>
+						<min>1</min>
+						<max>50</max>
+					</option>
+					<option name="names" type="list">
+						<_short>Name</_short>
+						<_long>Viewport name</_long>
+						<type>string</type>
+					</option>
+				</subgroup>
+			</group>
+			<group>
+				<_short>Appearance</_short>
+				<option name="display_time" type="float">
+					<_short>Display Time</_short>
+					<_long>Timeout (in s) of the name display</_long>
+					<min>0.1</min>
+					<max>5.0</max>
+					<precision>0.05</precision>
+					<default>0.5</default>
+				</option>
+				<option name="fade_time" type="float">
+					<_short>Fade Time</_short>
+					<_long>Time (in s) the name display fades out after being shown.</_long>
+					<min>0.0</min>
+					<max>5.0</max>
+					<precision>0.05</precision>
+					<default>0.25</default>
+				</option>
+				<subgroup>
+					<_short>Text Display</_short>
+					<option name="bold_text" type="bool">
+						<_short>Bold Font</_short>
+						<_long>Selects if the text should be displayed in bold font or not.</_long>
+						<default>false</default>
+					</option>
+					<option name="text_font_size" type="int">
+						<_short>Font Size</_short>
+						<_long>Font size for the text display.</_long>
+						<default>16</default>
+						<min>6</min>
+						<max>96</max>
+					</option>
+					<option name="text_placement" type="int">
+						<_short>Text Placement</_short>
+						<_long>Selects where to place the text.</_long>
+						<default>0</default>
+						<min>0</min>
+						<max>2</max>
+						<desc>
+							<value>0</value>
+							<_name>Centered on screen</_name>
+						</desc>
+						<desc>
+							<value>1</value>
+							<_name>Top of screen</_name>
+						</desc>
+						<desc>
+							<value>2</value>
+							<_name>Bottom of screen</_name>
+						</desc>
+					</option>
+				</subgroup>
+				<subgroup>
+					<_short>Colors</_short>
+					<option name="back_color" type="color">
+						<_short>Background Color</_short>
+						<_long>Background color for the text display.</_long>
+						<default>
+							<red>0x0000</red>
+							<green>0x0000</green>
+							<blue>0x0000</blue>
+							<alpha>0x9999</alpha>
+						</default>
+					</option>
+					<option name="font_color" type="color">
+						<_short>Font Color</_short>
+						<_long>Font color for the text display.</_long>
+						<default>
+							<red>0xffff</red>
+							<green>0xffff</green>
+							<blue>0xffff</blue>
+							<alpha>0xffff</alpha>
+						</default>
+					</option>
+				</subgroup>
+			</group>
+		</options>	
+	</plugin>
+</compiz>