Merge lp:~gdwarner/zim/sequence-diagram-plugin into lp:~jaap.karssenberg/zim/pyzim

[gdw2]

Added sequence diagram plugin (_heavily_ based off diagram plugin -- thanks!)

[Jaap Karssenberg (jaap.karssenberg)]

Thanks for the plugin code it looks good and usable to me but I will keep it
on hold for a bit. Reason is that we get too many similar plugins, so I'll
go and try wrapping them into bigger ones.

Essentially that will mean a patch to the diagram plugin that allows you to
switch what command is used for a specific diagram. Thus there will be a
single "insert diagram" item that supports different styles.

(Something similar can be done to merge the two insert plot plugins)

[gdw2 (gdwarner)]

Sounds good.
On Apr 27, 2011 12:25 PM, "Jaap Karssenberg" <email address hidden>
wrote:
> Thanks for the plugin code it looks good and usable to me but I will keep
it
> on hold for a bit. Reason is that we get too many similar plugins, so I'll
> go and try wrapping them into bigger ones.
>
> Essentially that will mean a patch to the diagram plugin that allows you
to
> switch what command is used for a specific diagram. Thus there will be a
> single "insert diagram" item that supports different styles.
>
> (Something similar can be done to merge the two insert plot plugins)
>
> --
>
https://code.launchpad.net/~gdwarner/zim/sequence-diagram-plugin/+merge/58749
> You are the owner of lp:~gdwarner/zim/sequence-diagram-plugin.

[Jaap Karssenberg (jaap.karssenberg)]

OK, optional dependencies are in. I will be back in ~ 2 weeks and merge this code with the existing plugin.

review: Approve

[Jaap Karssenberg (jaap.karssenberg)]

... first of all my apologies for the 2.5 y timeout - somehow this request got burried in my inbox - sorry.

Merged in pyzim-refactor using new plugin framework, will be merged in trunk for next release.

review: Approve

=== added directory 'data/manual/Plugins/Sequence_Diagram_Editor'
=== added file 'data/manual/Plugins/Sequence_Diagram_Editor.txt'
--- data/manual/Plugins/Sequence_Diagram_Editor.txt	1970-01-01 00:00:00 +0000
+++ data/manual/Plugins/Sequence_Diagram_Editor.txt	2011-04-21 20:37:52 +0000
@@ -0,0 +1,30 @@
+Content-Type: text/x-zim-wiki
+Wiki-Format: zim 0.4
+
+====== Diagram Editor ======
+
+The sequence diagram editor allows you to insert and edit diagrams based on seqdiag. Seqdiag uses a basic script language to define diagrams. This plugin adds a dialog where one can define a diagram in this script. The dialog shows a preview of the rendered diagram and when the diagram is finished it can be inserted in a zim page as an image. You can always edit it later again by selecting "Edit Diagram" from the context menu (right-mouse-click on the diagram will show the context menu).
+
+**Dependencies:** This plugin requires seqdiag to be installed and available in the system path.
+
+===== Example =====
+
+For example a diagram like:
+
+{{./diagram.png}}
+
+Can be created by entering the following definition in the dialog:
+
+'''
+diagram {
+  browser  -> webserver [label = "GET /index.html"];
+  browser <-- webserver;
+  browser  -> webserver [label = "POST /blog/comment"];
+              webserver  -> database [label = "INSERT comment"];
+              webserver <-- database;
+  browser <-- webserver;
+}
+'''
+
+For full documentation of the script language see: http://tk0miya.bitbucket.org/seqdiag/build/html/index.html
+

=== added file 'data/manual/Plugins/Sequence_Diagram_Editor/diagram.png'
Binary files data/manual/Plugins/Sequence_Diagram_Editor/diagram.png	1970-01-01 00:00:00 +0000 and data/manual/Plugins/Sequence_Diagram_Editor/diagram.png	2011-04-21 20:37:52 +0000 differ
=== added file 'zim/plugins/sequencediagrameditor.py'
--- zim/plugins/sequencediagrameditor.py	1970-01-01 00:00:00 +0000
+++ zim/plugins/sequencediagrameditor.py	2011-04-21 20:37:52 +0000
@@ -0,0 +1,113 @@
+# -*- coding: utf-8 -*-
+
+# Copyright 2011 Greg Warner <[e-mail]>
+# (Pretty much copied from diagrameditor.py)
+
+import gtk
+
+from zim.fs import File, TmpFile
+from zim.plugins import PluginClass
+from zim.config import data_file
+from zim.applications import Application
+from zim.gui.imagegeneratordialog import ImageGeneratorDialog
+
+# TODO put these commands in preferences
+diagcmd = ('seqdiag', '-o')
+
+ui_xml = '''
+<ui>
+	<menubar name='menubar'>
+		<menu action='insert_menu'>
+			<placeholder name='plugin_items'>
+				<menuitem action='insert_seqdiagram'/>
+			</placeholder>
+		</menu>
+	</menubar>
+</ui>
+'''
+
+ui_actions = (
+	# name, stock id, label, accelerator, tooltip, read only
+	('insert_seqdiagram', None, _('Se_quence Diagram...'), '', _('Insert sequence diagram'), False),
+		# T: menu item for insert diagram plugin
+)
+
+
+class InsertSequenceDiagramPlugin(PluginClass):
+
+	plugin_info = {
+		'name': _('Insert Sequence Diagram'), # T: plugin name
+		'description': _('''\
+This plugin provides a sequence diagram editor for zim based on seqdiag.
+
+This is not a core plugin shipping with zim.
+'''), # T: plugin description
+		'help': ':Plugins:Sequence Diagram Editor',
+		'author': 'Greg Warner',
+	}
+
+	@classmethod
+	def check_dependencies(klass):
+		return [("seqdiag",Application(diagcmd).tryexec())]
+
+	def __init__(self, ui):
+		PluginClass.__init__(self, ui)
+		if self.ui.ui_type == 'gtk':
+			self.ui.add_actions(ui_actions, self)
+			self.ui.add_ui(ui_xml, self)
+			self.register_image_generator_plugin('seqdiagram')
+
+	def insert_seqdiagram(self):
+		dialog = InsertSequenceDiagramDialog.unique(self, self.ui)
+		dialog.show_all()
+
+	def edit_object(self, buffer, iter, image):
+		dialog = InsertSequenceDiagramDialog(self.ui, image=image)
+		dialog.show_all()
+
+	def do_populate_popup(self, menu, buffer, iter, image):
+		menu.prepend(gtk.SeparatorMenuItem())
+
+		item = gtk.MenuItem(_('_Edit Sequence Diagram')) # T: menu item in context menu
+		item.connect('activate',
+			lambda o: self.edit_object(buffer, iter, image))
+		menu.prepend(item)
+
+
+
+class InsertSequenceDiagramDialog(ImageGeneratorDialog):
+
+	def __init__(self, ui, image=None):
+		generator = SequenceDiagramGenerator()
+		ImageGeneratorDialog.__init__(self, ui, _('Insert Sequence Diagram'), # T: dialog title
+			generator, image, help=':Plugins:Sequence Diagram Editor')
+
+
+class SequenceDiagramGenerator(object):
+
+	# TODO: generic base class for image generators
+
+	type = 'seqdiagram'
+	basename = 'seqdiagram.diag'
+
+	def __init__(self):
+		self.diagfile = TmpFile('diagram-editor.diag')
+		self.diagfile.touch()
+		self.pngfile = File(self.diagfile.path[:-5] + '.png') # len('.diag') == 5
+
+	def generate_image(self, text):
+		if isinstance(text, basestring):
+			text = text.splitlines(True)
+
+		# Write to tmp file
+		self.diagfile.writelines(text)
+
+		# Call seqdiag
+		diag = Application(diagcmd)
+		diag.run((self.pngfile, self.diagfile))
+
+		return self.pngfile, None
+
+	def cleanup(self):
+		self.diagfile.remove()
+		self.pngfile.remove()