# -*- coding: utf-8 -*-
# Copyright © 2007 Lateef Alabi-Oki
#
# This file is part of Scribes.
#
# Scribes 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.
#
# Scribes 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 Scribes; if not, write to the Free Software
# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301
# USA

"""
This module documents a class that highlights template triggers when
they are found.

@author: Lateef Alabi-Oki
@organization: The Scribes Project
@copyright: Copyright © 2007 Lateef Alabi-Oki
@license: GNU GPLv2 or Later
@contact: mystilleef@gmail.com
"""

class Highlighter(object):
	"""
	This class creates an object that highlights found template
	triggers.
	"""

	def __init__(self, manager, editor):
		"""
		Initialize object.

		@param self: Reference to the Highlighter instance.
		@type self: A Highlighter object.

		@param manager: Reference to the TemplateManager instance.
		@type manager: A TemplateManager object.

		@param editor: Reference to the text editor.
		@type editor: An Editor object.
		"""
		self.__init_attributes(manager, editor)
		from thread import start_new_thread
		start_new_thread(self.__precompile_methods, ())
		self.__signal_id_1 = manager.connect("destroy", self.__destroy_cb)
		self.__signal_id_2 = manager.connect("trigger-found", self.__trigger_found_cb)
		self.__signal_id_3 = manager.connect("no-trigger-found", self.__no_trigger_found_cb)

	def __init_attributes(self, manager, editor):
		"""
		Initialize data attributes.

		@param self: Reference to the Highlighter instance.
		@type self: A Highlighter object.

		@param manager: Reference to the TemplateManager instance.
		@type manager: A TemplateManager object.

		@param editor: Reference to the text editor.
		@type editor: An Editor object.
		"""
		self.__manager = manager
		self.__editor = editor
		self.__is_highlighted = False
		self.__highlight_tag = self.__create_highlight_tag()
		self.__signal_id_1 = self.__signal_id_2 = None
		self.__status_id = None
		return

	def __destroy_cb(self, manager):
		self.__editor.textbuffer.get_tag_table().remove(self.__highlight_tag)
		from SCRIBES.utils import delete_attributes, disconnect_signal
		disconnect_signal(self.__signal_id_1, manager)
		disconnect_signal(self.__signal_id_2, manager)
		delete_attributes(self)
		self = None
		del self
		return

	def __trigger_found_cb(self, manager, position):
		if self.__is_highlighted: return
		textbuffer = self.__editor.textbuffer
		start = textbuffer.get_iter_at_mark(position[0])
		end = textbuffer.get_iter_at_mark(position[1])
		textbuffer.apply_tag(self.__highlight_tag, start, end)
		self.__is_highlighted = True
		self.__status_id = self.__editor.feedback.set_modal_message("Template trigger highlighted", "info")
		return

	def __no_trigger_found_cb(self, manager, position):
		if self.__is_highlighted is False: return
		textbuffer = self.__editor.textbuffer
		start = textbuffer.get_iter_at_mark(position[0])
		end = textbuffer.get_iter_at_mark(position[1])
		textbuffer.remove_tag(self.__highlight_tag, start, end)
		self.__is_highlighted = False
		from gobject import idle_add
		idle_add(self.__editor.feedback.unset_modal_message, self.__status_id)
		return

	def __precompile_methods(self):
		try:
			from psyco import bind
			bind(self.__trigger_found_cb)
			bind(self.__no_trigger_found_cb)
		except ImportError:
			pass
		return False

	def __create_highlight_tag(self):
		"""
		Create the a highlight tag.

		@param self: Reference to the LexicalScopeHighlight instance.
		@type self: A LexicalScopeHighlight object.

		@return: A region highlight tag.
		@rtype: A gtk.TextTag object.
		"""
		from gtk import TextTag
		tag = TextTag("template-trigger")
		self.__editor.textbuffer.get_tag_table().add(tag)
		tag.set_property("background", "gray")
#		tag.set_property("foreground", "yellow")
		from pango import WEIGHT_HEAVY, STYLE_ITALIC
#		tag.set_property("weight", WEIGHT_HEAVY)
#		tag.set_property("style", STYLE_ITALIC)
		return tag