New Modelines plugin by Steve Frécinaux <nud@apinc.org>

2006-01-02  Paolo Maggi  <paolo@gnome.org>

	New Modelines plugin by Steve Frécinaux  <nud@apinc.org>

	* configure.ac: added plugins/modelines/Makefile to AC_OUTPUT

	* data/gedit.schemas.in: added modelines to the list of default plugins

	* plugins/Makefile.am: added modelines to [DIST_]SUBDIRS

	* plugins/modelines/Makefile.am:
	* plugins/modelines/modelines.gedit-plugin.desktop.in:
	* plugins/modelines/modelines.py: new modelines plugin

ChangeLog

+2006-01-02  Paolo Maggi  <paolo@gnome.org>
+
+	New Modelines plugin by Steve Frécinaux  <nud@apinc.org>
+
+	* configure.ac: added plugins/modelines/Makefile to AC_OUTPUT
+
+	* data/gedit.schemas.in: added modelines to the list of default plugins
+
+	* plugins/Makefile.am: added modelines to [DIST_]SUBDIRS
+
+	* plugins/modelines/Makefile.am:
+	* plugins/modelines/modelines.gedit-plugin.desktop.in:
+	* plugins/modelines/modelines.py: new modelines plugin
+
 2006-01-02  Paolo Borelli  <pborelli@katamail.com>
 
 	* gedit/dialogs/gedit-search-dialog.c: make sure Replace All

configure.ac

@@ -300,6 +300,7 @@ plugins/changecase/Makefile
 plugins/docinfo/Makefile
 plugins/indent/Makefile
 plugins/Makefile
+plugins/modelines/Makefile
 plugins/pythonconsole/Makefile
 plugins/sample/Makefile
 plugins/sort/Makefile

data/gedit.schemas.in

@@ -583,7 +583,7 @@
       <owner>gedit</owner>
       <type>list</type>
       <list_type>string</list_type>
-      <default>[docinfo,savecopy,spell,time]</default>
+      <default>[docinfo,modelines,savecopy,spell,time]</default>
       <locale name="C">
 	<short>Active plugins</short>
 	<long>List of active plugins. It contains the "Location" of the active plugins. See the .gedit-plugin file for obtaining

plugins/Makefile.am

@@ -5,7 +5,7 @@ DIST_SUBDIRS = changecase docinfo indent sample sort spell time taglist
 SUBDIRS = changecase docinfo indent sample sort time taglist $(SPELL_PLUGIN_DIR)
 
 if ENABLE_PYTHON
-DIST_SUBDIRS += pythonconsole
-SUBDIRS      += pythonconsole
+DIST_SUBDIRS += pythonconsole modelines
+SUBDIRS      += pythonconsole modelines
 endif
 

plugins/modelines/Makefile.am

+# Modelines Plugin
+plugindir = $(libdir)/gedit-2/plugins
+plugin_PYTHON = \
+	modelines.py
+
+plugin_in_files = modelines.gedit-plugin.desktop.in
+%.gedit-plugin: %.gedit-plugin.desktop.in $(INTLTOOL_MERGE) $(wildcard $(top_srcdir)/po/*po) ; $(INTLTOOL_MERGE) $(top_srcdir)/po $< $@ -d -u -c $(top_builddir)/po/.intltool-merge-cache
+
+plugin_DATA = $(plugin_in_files:.gedit-plugin.desktop.in=.gedit-plugin)
+
+EXTRA_DIST = $(plugin_in_files)
+
+CLEANFILES = $(plugin_DATA)
+DISTCLEANFILES = $(plugin_DATA)

plugins/modelines/modelines.gedit-plugin.desktop.in

+[Gedit Plugin]
+Loader=python
+Module=modelines
+IAge=2
+_Name=Modelines
+_Description=Emacs, Kate and Vim-style modelines support for gedit
+Authors=Steve Frécinaux <nud@apinc.org>
+Copyright=Copyright © 2005 Steve Frécinaux
+Website=http://www.gedit.org

plugins/modelines/modelines.py

+# -*- coding: utf-8 -*-
+# modelines.py
+#
+# Copyright (C) 2005 - Steve Frécinaux
+#
+# 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, 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., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+
+import gedit
+import re
+import gtk
+
+class ModelinePlugin(gedit.Plugin):
+	def __init__(self):
+		gedit.Plugin.__init__(self)
+
+	def activate(self, window):
+		for view in window.get_views():
+			doc = view.get_buffer()
+			loaded_id = doc.connect("loaded", apply_modeline, view)
+			saved_id  = doc.connect("saved", apply_modeline, view)
+			doc.set_data("ModelinePluginHandlerIds", (loaded_id, saved_id))
+			apply_modeline(doc, None, view)
+			
+		tab_added_id = window.connect("tab_added", self.connect_handlers);
+		window.set_data("ModelinePluginHandlerId", tab_added_id);
+
+	def connect_handlers(self, window, tab):
+		doc = tab.get_document()
+		view = tab.get_view()
+		loaded_id = doc.connect("loaded", apply_modeline, view)
+		saved_id  = doc.connect("saved", apply_modeline, view)
+		doc.set_data("ModelinePluginHandlerIds", (loaded_id, saved_id))
+	
+	def deactivate(self, window):
+		tab_added_id = window.get_data("ModelinePluginHandlerId");
+		window.disconnect(tab_added_id);
+		window.set_data("ModelinePluginHandlerId", None);
+		
+		for doc in window.get_documents():
+			loaded_id, saved_id = doc.get_data("ModelinePluginHandlerIds")
+			doc.set_data("ModelinePluginHandlerIds", None)
+			doc.disconnect(loaded_id)
+			doc.disconnect(saved_id)
+
+def apply_modeline(doc, error, view):
+	if error is None:
+		options = get_modeline_options(doc)
+		apply_options(options, view)
+		doc.set_data("ModelineOptions", options)
+
+def get_modeline_options(doc):
+	# Search the two first lines for emacs- or vim-style modelines
+	start = doc.get_start_iter()
+	for i in (1, 2):
+		end = start.copy()
+		if not end.forward_to_line_end(): return False
+		modeline = doc.get_text(start, end, False)
+		options = parse_modeline_vim(modeline)
+		if options: return options
+		options = parse_modeline_emacs(modeline)
+		if options: return options
+		options = parse_modeline_kate(modeline)
+		if options: return options
+		start = end
+
+	# Vim can read modeline on the 3rd line
+	end = start.copy()
+	if not end.forward_to_line_end(): return False
+	modeline = doc.get_text(start, end, False)
+	options = parse_modeline_vim(modeline)
+	if options: return options
+	options = parse_modeline_kate(modeline)
+	if options: return options
+	start = end
+
+	# Kate reads modelines on the 10 first lines
+	for i in (4, 5, 6, 7, 8, 9, 10):
+		end = start.copy()
+		if not end.forward_to_line_end(): break
+		modeline = doc.get_text(start, end, False)
+		options = parse_modeline_kate(modeline)
+		if options: return options
+		start = end
+
+	# Search the three last lines for vim- and kate-style modelines
+	start = doc.get_end_iter()
+	start.backward_lines(2)	
+	for i in (1, 2, 3):
+		end = start.copy()
+		if not end.forward_to_line_end(): return False
+		modeline = doc.get_text(start, end, False)
+		options = parse_modeline_vim(modeline)
+		if options: return options
+		options = parse_modeline_kate(modeline)
+		if options: return options
+		start = end
+
+	# Kate reads modelines on the 10 last lines
+	start.backward_lines(9)	
+	for i in (4, 5, 6, 7, 8, 9, 10):
+		end = start.copy()
+		if not end.forward_to_line_end(): return False
+		modeline = doc.get_text(start, end, False)
+		options = parse_modeline_kate(modeline)
+		if options: return options
+		start = end
+	
+	# No modeline found
+	return False
+
+def parse_modeline_vim(line):
+	# First form modeline
+	# [text]{white}{vi:|vim:|ex:}[white]{options}
+	#
+	# Second form
+	# [text]{white}{vi:|vim:|ex:}[white]se[t] {options}:[text]
+
+	# Find the modeline
+	for i in ('ex:', 'vi:', 'vim:'):
+		start = line.find(i)
+		if start != -1:	
+			break
+	else:
+		return False
+	
+	if line[start : start + 2] == "se":
+		end = line.find(":", start + 3)
+		if end == -1:
+			return False
+		elif line[start : start + 3] == "set":
+			line = line[start + 4 : end - 1]
+		else:
+			line = line[start + 3 : end - 1]
+	else:
+		line = line[start :]
+	
+	# Get every individual directives
+	directives = filter((lambda x: x != ''), re.split(r'[: ]', line))
+	options = dict();
+	
+	for directive in directives:
+		# Reformat the directive
+		if (directive.find("=") != -1):
+			name, value = directive.split("=")
+		elif directive[0:2] == "no":
+			value = False
+			name = directive[2:]
+		else:
+			value = True
+			name = directive
+		
+		# Set the options according to the directive
+		if name == "et" or name == "expandtab":
+			options["use-tabs"] = not value
+		elif name == "ts" or name == "tabstop":
+			options["tabs-width"] = int(value)
+		elif name == "wrap":
+			options["wrapping"] = value
+		elif name == "textwidth":
+			options["margin"] = int(value)
+	return options
+
+def parse_modeline_emacs(line):
+	# cf. http://www.delorie.com/gnu/docs/emacs/emacs_486.html
+	# Extract the modeline from the given line
+	start = line.find("-*-")
+	if start == -1:
+		return False
+	else:
+		start = start + 3
+	end = line.find("-*-", start)
+	if end == -1:
+		return False
+	
+	# Get every individual directives
+	directives = filter((lambda x: x != ''), map(str.strip, line[start : end - 1].split(";")))
+	options = dict()
+	
+	for directive in directives:
+		name, value = (map(str.strip, directive.split(":", 1)) + [None])[0:2]
+		if name == "tab-width":
+			options["tabs-width"] = int(value)
+		elif name == "indent-tabs-mode":
+			options["use-tabs"] = value != "nil"
+		elif name == "autowrap":
+			options["wrapping"] = value != "nil"
+	return options
+
+def parse_modeline_kate(line):
+	# cf. http://wiki.kate-editor.org/index.php/Modelines
+
+	# Extract the modeline from the given line
+	start = line.find("kate:")
+	if start == -1:
+		return False
+	else:
+		start = start + 5
+	end = line.rfind(";")
+	if end == -1:
+		return False
+	
+	# Get every individual directives
+	directives = filter((lambda x: x != ''), map(str.strip, line[start : end - 1].split(";")))
+	options = dict()
+	
+	for directive in directives:
+		name, value = (map(str.strip, directive.split(None, 1)) + [None])[0:2]
+		if name == "tab-width":
+			options["tabs-width"] = int(value)
+		elif name == "space-indent":
+			options["use-tabs"] = value not in ("on", "true", "1")
+		elif name == "word-wrap":
+			options["wrapping"] = value not in ("on", "true", "1")
+		elif name == "word-wrap-column":
+			options["margin"] = int(value)
+	return options
+
+def apply_options(options, view):
+	if not options:
+		return
+
+	if options.has_key("tabs-width"):
+		view.set_tabs_width(options["tabs-width"])
+	
+	if options.has_key("use-tabs"):
+		view.set_insert_spaces_instead_of_tabs(not options["use-tabs"])
+
+	if options.has_key("wrapping"):
+		if options["wrapping"]:
+			view.set_wrap_mode(gtk.WRAP_WORD)
+		else:
+			view.set_wrap_mode(gtk.WRAP_NONE)
+
+	if options.has_key("margin"):
+		if options["margin"] > 0:
+			view.set_margin(long(options["margin"]))
+			view.set_show_margin(True)
+		else:
+			view.set_show_margin(False)
+
+# ex:ts=8:noet: