message_filter.py

Go to the documentation of this file.

# Software License Agreement (BSD License)
#
# Copyright (c) 2012, Willow Garage, Inc.
# All rights reserved.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions
# are met:
#
#  * Redistributions of source code must retain the above copyright
#    notice, this list of conditions and the following disclaimer.
#  * Redistributions in binary form must reproduce the above
#    copyright notice, this list of conditions and the following
#    disclaimer in the documentation and/or other materials provided
#    with the distribution.
#  * Neither the name of Willow Garage, Inc. nor the names of its
#    contributors may be used to stoporse or promote products derived
#    from this software without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
# FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
# COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
# INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
# BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
# LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
# CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
# LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
# ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
# POSSIBILITY OF SUCH DAMAGE.

from python_qt_binding.QtCore import QRegExp
from .base_filter import BaseFilter


class MessageFilter(BaseFilter):

    """
    Contains filter logic for a message filter. If the regex flag is False
    simple 'is this in that' text matching is used on _text. If the regex flag is True
    _text is treated as a regular expression with one exception. If it does not
    start with a ^ a .* is appended, and if it does not end with a $ then a .*
    is added to the end.
    The filter_changed signal should be connected to a slot which notifies the
    overall filtering system that it needs to reevaluate all entries.
    """

    def __init__(self):
        super(MessageFilter, self).__init__()
        self._text = ''
        self._regex = False

    def set_text(self, text):
        """
        Setter for _text
        :param text: text to set ''str''
        :emits filter_changed_signal: If _enabled is true
        """
        self._text = text
        if self.is_enabled():
            self.start_emit_timer(500)

    def set_regex(self, checked):
        """
        Setter for _regex
        :param checked: boolean flag to set ''bool''
        :emits filter_changed_signal: If _enabled is true
        """
        self._regex = checked
        if self.is_enabled():
            self.start_emit_timer(500)

    def has_filter(self):
        return self._text != ''

    def test_message(self, message):
        """
        Tests if the message matches the filter.
        If the regex flag is False simple 'is this in that' text matching is used
        on _text. If the regex flag is True _text is treated as a regular expression
        with one exception. If it does not start with a ^ a .* is appended, and if
        it does not end with a $ then a .* is added to the end.

        :param message: the message to be tested against the filters, ''Message''
        :returns: True if the message matches, ''bool''
        """
        return self._test_message(message.message)

    def _test_message(self, value):
        if not self.is_enabled():
            return False
        if self._text != '':
            if self._regex:
                temp = self._text
                if temp[0] != '^':
                    temp = '.*' + temp
                if temp[-1] != '$':
                    temp += '.*'
                if QRegExp(temp).exactMatch(value):
                    return True
            else:
                if value.find(self._text) != -1:
                    return True
        return False