fluxbox/src/ClientPattern.hh
Mathias Gumz dc47491533 Adds 'ClientPatternTest' command
ClientPatterns might be tricky to get right. Instead of fiddling around in
either the keys-file or the apps-file and restarting fluxbox to see if the
changes had any effect / matched the right windows, 'ClientPatternTest' and
the fluxbox-remote should make this easier:

    $> fluxbox-remote "clientpatterntest (title=.*vim*)"

This causes fluxbox to store the list of matched windows in the
_FLUXBOX_ACTION_RESULT property onto the rootwindow. This property might
then be read by:

    $> xprop -root _FLUXBOX_ACTION_RESULT

or

    $> fluxbox-remote result

The format of the list is:

    win_id \t title_of_window \n

win_id is '-1' when fluxbox wasn't able to parse the given ClientPattern.
win_id is '0' when there are no windows matching the given ClientPattern.
2013-01-31 09:14:06 +01:00

106 lines
3.8 KiB
C++

// ClientPattern.hh for Fluxbox Window Manager
// Copyright (c) 2003 - 2006 Henrik Kinnunen (fluxgen at fluxbox dot org)
// and Simon Bowden (rathnor at users.sourceforge.net)
// Copyright (c) 2002 Xavier Brouckaert
//
// Permission is hereby granted, free of charge, to any person obtaining a
// copy of this software and associated documentation files (the "Software"),
// to deal in the Software without restriction, including without limitation
// the rights to use, copy, modify, merge, publish, distribute, sublicense,
// and/or sell copies of the Software, and to permit persons to whom the
// Software is furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
// THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
// DEALINGS IN THE SOFTWARE.
#ifndef CLIENTPATTERN_HH
#define CLIENTPATTERN_HH
#include "FbTk/RegExp.hh"
#include "FbTk/NotCopyable.hh"
#include "FbTk/FbString.hh"
#include <list>
class Focusable;
/**
* This class represents a "pattern" that we can match against a
* Window based on various properties.
*/
class ClientPattern:private FbTk::NotCopyable {
public:
ClientPattern();
/**
* Create the pattern from the given string as it would appear in the
* apps file. the bool value returns the character at which
* there was a parse problem, or -1.
*/
explicit ClientPattern(const char * str);
~ClientPattern();
/// @return a string representation of this pattern
FbTk::FbString toString() const;
enum WinProperty {
TITLE = 0, CLASS, NAME, ROLE, TRANSIENT,
MAXIMIZED, MINIMIZED, SHADED, STUCK, FOCUSHIDDEN, ICONHIDDEN,
WORKSPACE, WORKSPACENAME, HEAD, LAYER, URGENT, SCREEN,
XPROP, FULLSCREEN, VERTMAX, HORZMAX
};
/// Does this client match this pattern?
bool match(const Focusable &win) const;
/// Does this pattern depend on the focused window?
bool dependsOnFocusedWindow() const;
/// Does this pattern depend on the current workspace?
bool dependsOnCurrentWorkspace() const;
/**
* Add an expression to match against
* @param str is a regular expression
* @param prop is the member function that we wish to match against
* @param negate is if the term should be negated
* @param xprop is the name of the prop if prop is XPROP
* @return false if the regexp wasn't valid
*/
bool addTerm(const FbTk::FbString &str, WinProperty prop, bool negate = false, const FbTk::FbString& xprop = FbTk::FbString());
void addMatch() { ++m_nummatches; }
void removeMatch() { --m_nummatches; }
void resetMatches() { m_nummatches = 0; }
// whether this pattern has identical matching criteria
bool operator ==(const ClientPattern &pat) const;
/**
* If there are no terms, then there is assumed to be an error
* the column of the error is stored in m_matchlimit
*/
int error() const { return m_terms.empty() ? 1 : 0; }
int error_col() const { return m_matchlimit; }
static FbTk::FbString getProperty(WinProperty prop, const Focusable &client);
private:
struct Term;
friend struct Term;
typedef std::list<Term *> Terms;
Terms m_terms; ///< our pattern is made up of a sequence of terms, currently we "and" them all
int m_matchlimit;
int m_nummatches;
};
#endif // CLIENTPATTERN_HH