Merge lp:~plprgt/zim/lines into lp:~jaap.karssenberg/zim/pyzim

[Pl]

Addition of horizontal lines to separate different sections in Zim.

[lp:~plprgt/zim/lines]

807. By Pavel_M on 2016-01-17

Horizontal Lines: Change from '___' to '---'.

=== modified file 'data/menubar.xml'
--- data/menubar.xml	2015-11-13 20:21:57 +0000
+++ data/menubar.xml	2016-01-18 16:19:18 +0000
@@ -88,6 +88,7 @@
 			<menuitem action='insert_bullet_list'/>
 			<menuitem action='insert_numbered_list'/>
 			<menuitem action='insert_checkbox_list'/>
+			<menuitem action='insert_line'/>
 			<placeholder name='plugin_items'/>
 			<separator/>
 			<menuitem action='insert_text_from_file'/>

=== modified file 'tests/pageview.py'
--- tests/pageview.py	2015-11-13 20:21:57 +0000
+++ tests/pageview.py	2016-01-18 16:19:18 +0000
@@ -47,6 +47,56 @@
 	return PageView(ui)
 
 
+class TestLines(tests.TestCase):
+
+	def testLines(self):
+		'''Test lines formatting.'''
+
+		pageview = setUpPageView()
+		buffer = pageview.view.get_buffer()
+
+		def check_text(input, result):
+			buffer.set_text(input)
+			tree = buffer.get_parsetree()
+			dumper = get_format('wiki').Dumper()
+			text = ''.join(dumper.dump(tree))
+			self.assertEqual(text, result)
+
+		# Check formatting.
+		string = 'text... \n{}\n text... \n'
+		input = string.format('-'*4)
+		check_text(input, input) # doesn't format
+		for i in range(30):
+			if i < 5:
+				output = string.format('-'*i)
+			else:
+				output = string.format(LINE_TEXT)
+			input = string.format('-'*i)
+			check_text(input, output)
+
+		# Check that any additional symbol other than '-' fails.
+		input = 'text... {}\n text... \n'.format('-'*10)
+		check_text(input, input)
+		input = 'text... \n{}text... \n'.format('-'*10)
+		check_text(input, input)
+		input = 'text... \n{} \n text... \n'.format('-'*10)
+		check_text(input, input)
+		input = 'text... \n {}\n text... \n'.format('-'*10)
+		check_text(input, input)
+
+		# Check more complex text.
+		string = 'text... \n\n{0}\n\n{0}\n\n text... \n'
+		input = string.format('-'*7)
+		output = string.format(LINE_TEXT)
+		check_text(input, output)
+
+		string = '... \n{}\n{}\n{}\n ... \n{}\n{}0\n'
+		input = string.format('-'*8, '-'*6, '-'*4, '-'*11, '-'*10)
+		output = string.format(LINE_TEXT, LINE_TEXT, '-'*4, LINE_TEXT, '-'*10)
+		check_text(input, output)
+
+
+
 class TestCaseMixin(object):
 	# Mixin class with extra test methods
 

=== modified file 'zim/formats/__init__.py'
--- zim/formats/__init__.py	2015-10-30 21:34:34 +0000
+++ zim/formats/__init__.py	2016-01-18 16:19:18 +0000
@@ -141,6 +141,9 @@
 TABLEROW = 'trow'
 TABLEDATA = 'td'
 
+LINE = 'line'
+LINE_TEXT = '-'*20
+
 BLOCK_LEVEL = (PARAGRAPH, HEADING, VERBATIM_BLOCK, BLOCK, OBJECT, IMAGE, LISTITEM, TABLE)
 
 

=== modified file 'zim/formats/html.py'
--- zim/formats/html.py	2015-02-15 20:12:11 +0000
+++ zim/formats/html.py	2016-01-18 16:19:18 +0000
@@ -265,3 +265,8 @@
 		strings.insert(0, '  <td>')
 		strings.append('</td>\n')
 		return strings
+
+        def dump_line(self, tag, attrib, strings=None):
+                return '\n<hr>\n'
+
+        

=== modified file 'zim/formats/latex.py'
--- zim/formats/latex.py	2015-06-13 19:48:28 +0000
+++ zim/formats/latex.py	2016-01-18 16:19:18 +0000
@@ -253,3 +253,6 @@
 
 		table.append('\end{tabular}')
 		return map(lambda line: line+"\n", table)
+
+        def dump_line(self, tag, attrib, strings=None):
+                return '\n\\hrule\n'

=== modified file 'zim/formats/markdown.py'
--- zim/formats/markdown.py	2015-10-30 21:34:34 +0000
+++ zim/formats/markdown.py	2016-01-18 16:19:18 +0000
@@ -130,3 +130,6 @@
 	def dump_td(self, tag, attrib, strings):
 		strings = [s.replace('\n', '<br>').replace('|', '∣') for s in strings]
 		return [self._concat(strings)]
+
+	def dump_line(self, tag, attrib, strings=None):
+		return '\n{}\n'.format('*'*5)

=== modified file 'zim/formats/plain.py'
--- zim/formats/plain.py	2015-10-30 21:34:34 +0000
+++ zim/formats/plain.py	2016-01-18 16:19:18 +0000
@@ -226,3 +226,5 @@
 		strings = [s.replace('|', '∣') for s in strings]
 		return [self._concat(strings)]
 
+	def dump_line(self, tag, attrib, strings=None):
+		return '\n{}\n'.format(LINE_TEXT)

=== modified file 'zim/formats/rst.py'
--- zim/formats/rst.py	2015-10-30 21:34:34 +0000
+++ zim/formats/rst.py	2016-01-18 16:19:18 +0000
@@ -120,3 +120,6 @@
 	def dump_td(self, tag, attrib, strings):
 		strings = [s.replace('|', '∣') for s in strings]
 		return [self._concat(strings)]
+
+	def dump_line(self, tag, attrib, strings=None):
+		return '\n{}\n'.format('*'*5)

=== modified file 'zim/formats/wiki.py'
--- zim/formats/wiki.py	2015-10-30 21:34:34 +0000
+++ zim/formats/wiki.py	2016-01-18 16:19:18 +0000
@@ -171,7 +171,10 @@
 				^(?= \s*? \n)							# empty line / only spaces
 				''',
 				process=self.parse_table
-			)
+			),
+			# line format
+			Rule(LINE, r'(?<=\n)-{4}-+(?=\n)', process=self.parse_line) # \n-----\n
+
 		)
 		p.process_unmatched = self.parse_para
 		return p
@@ -428,6 +431,9 @@
 	def parse_tag(builder, text):
 		builder.append(TAG, {'name': text[1:]}, text)
 
+	@staticmethod
+	def parse_line(builder, text):
+		builder.append(LINE)
 
 
 
@@ -576,3 +582,11 @@
 			strings = map(lambda s: s.replace('\n', '\\n').replace('|', '\\|'), strings)
 			strings = map(lambda s: s.replace('<br>', '\\n'), strings)
 			return [self._concat(strings)]
+
+	def dump_line(self, tag, attrib, strings = None):
+		#logger.debug("Dumping line tag:%s, attrib:%s, strings:%s", tag, attrib, strings)
+		if not strings:
+			strings = [LINE_TEXT]
+		elif isinstance(strings, basestring):
+			strings = [strings]
+		return strings

=== modified file 'zim/gui/pageview.py'
--- zim/gui/pageview.py	2016-01-07 11:10:24 +0000
+++ zim/gui/pageview.py	2016-01-18 16:19:18 +0000
@@ -34,8 +34,13 @@
 from zim.parsing import link_type, Re, url_re
 from zim.formats import get_format, increase_list_iter, \
 	ParseTree, ElementTreeModule, OldParseTreeBuilder, \
+<<<<<<< TREE
 	BULLET, CHECKED_BOX, UNCHECKED_BOX, XCHECKED_BOX
 from zim.actions import get_gtk_actiongroup, gtk_accelerator_preparse_list, action, toggle_action
+=======
+	BULLET, CHECKED_BOX, UNCHECKED_BOX, XCHECKED_BOX, LINE_TEXT
+from zim.actions import gtk_accelerator_preparse_list
+>>>>>>> MERGE-SOURCE
 from zim.gui.widgets import ui_environment, \
 	Dialog, FileDialog, QuestionDialog, ErrorDialog, \
 	Button, CloseButton, MenuButton, BrowserTreeView, InputEntry, \
@@ -55,6 +60,37 @@
 logger = logging.getLogger('zim.gui.pageview')
 
 
+class LineSeparator(CustomObjectWidget):
+	'''Class to create a separation line.'''
+	__gsignals__ = {
+		'size-request': 'override',
+	}
+       
+	def __init__(self):
+		CustomObjectWidget.__init__(self)
+		# Set color of the line.
+		self.modify_bg(gtk.STATE_NORMAL, gtk.gdk.color_parse('darkgrey'))
+		# Set size of the line.
+		self.vbox.set_size_request(self._textview_width, height = 3)
+
+class LineObject(CustomObjectClass):
+	'''Class to work with 'LineSeparator' objects.'''
+	OBJECT_ATTR = {
+		'type': String('line'),
+	}
+
+	def get_widget(self):
+		'''Creates a new line which can be displayed on the wiki-page.'''
+		return LineSeparator()
+
+ObjectManager.register_object('line', LineObject)
+ 
+def IS_LINE(line):
+	'''Function used for line autoformatting.'''
+	length = len(line)
+	return (line == '-'*length) and (length > 4)
+
+
 STOCK_CHECKED_BOX = 'zim-checked-box'
 STOCK_UNCHECKED_BOX = 'zim-unchecked-box'
 STOCK_XCHECKED_BOX = 'zim-xchecked-box'
@@ -113,9 +149,52 @@
 # States that influence keybindings - we use this to explicitly
 # exclude other states. E.g. MOD2_MASK seems to be set when either
 # numlock or fn keys are active, resulting in keybindings failing
+<<<<<<< TREE
 KEYSTATES = gtk.gdk.CONTROL_MASK |gtk.gdk.META_MASK| gtk.gdk.SHIFT_MASK | gtk.gdk.MOD1_MASK
 
 MENU_ACTIONS = (
+=======
+KEYSTATES = gtk.gdk.META_MASK | gtk.gdk.SHIFT_MASK | gtk.gdk.MOD1_MASK
+
+ui_actions = (
+	# name, stock id, label, accelerator, tooltip, readonly
+	('undo', 'gtk-undo', _('_Undo'), '<Primary>Z', '', False), # T: Menu item
+	('redo', 'gtk-redo', _('_Redo'), '<Primary><shift>Z', '', False), # T: Menu item
+	('redo_alt1', None, '', '<Primary>Y', '', False),
+	('cut', 'gtk-cut', _('Cu_t'), '<Primary>X', '', False), # T: Menu item
+	('copy', 'gtk-copy', _('_Copy'), '<Primary>C', '', False), # T: Menu item
+	('paste', 'gtk-paste', _('_Paste'), '<Primary>V', '', False), # T: Menu item
+	('delete', 'gtk-delete', _('_Delete'), '', '', False), # T: Menu item
+	('toggle_checkbox', STOCK_CHECKED_BOX, _('Toggle Checkbox \'V\''), 'F12', '', False), # T: Menu item
+	('xtoggle_checkbox', STOCK_XCHECKED_BOX, _('Toggle Checkbox \'X\''), '<shift>F12', '', False), # T: Menu item
+	('edit_object', 'gtk-properties', _('_Edit Link or Object...'), '<Primary>E', '', False), # T: Menu item
+	('remove_link', None, _('_Remove Link'), '', '', False), # T: Menu item
+	('insert_date', None, _('_Date and Time...'), '<Primary>D', '', False), # T: Menu item
+	('insert_image', None, _('_Image...'), '', '', False), # T: Menu item
+	('insert_bullet_list', None, _('Bulle_t List'), '', '', False), # T: Menu item
+	('insert_numbered_list', None, _('_Numbered List'), '', '', False), # T: Menu item
+	('insert_checkbox_list', None, _('Checkbo_x List'), '', '', False), # T: Menu item,
+	('apply_format_bullet_list', None, _('Bulle_t List'), '', '', False), # T: Menu item,
+	('apply_format_numbered_list', None, _('_Numbered List'), '', '', False), # T: Menu item,
+	('apply_format_checkbox_list', None, _('Checkbo_x List'), '', '', False), # T: Menu item,
+	('insert_text_from_file', None, _('Text From _File...'), '', '', False), # T: Menu item
+	('insert_link', 'zim-link', _('_Link...'), '<Primary>L', _('Insert Link'), False), # T: Menu item
+	('insert_line', None, _('Line'), '', '', False), # T: Menu item        
+	('clear_formatting', None, _('_Clear Formatting'), '<Primary>9', '', False), # T: Menu item
+	('show_find', 'gtk-find', _('_Find...'), '<Primary>F', '', True), # T: Menu item
+	('show_find_alt1', None, '', '<Primary>F3', '', True),
+	('find_next', None, _('Find Ne_xt'), '<Primary>G', '', True), # T: Menu item
+	('find_next_alt1', None, '', 'F3', '', True), # T: Menu item
+	('find_previous', None, _('Find Pre_vious'), '<Primary><shift>G', '', True), # T: Menu item
+	('find_previous_alt1', None, '', '<shift>F3', '', True),
+	('show_find_and_replace', 'gtk-find-and-replace', _('_Replace...'), '<Primary>H', '', False), # T: Menu item
+	('show_word_count', None, _('Word Count...'), '', '', True), # T: Menu item
+	('zoom_in', 'gtk-zoom-in', _('_Zoom In'), '<Primary>plus', '', True), # T: Menu item
+	('zoom_in_alt1', None, '', '<Primary>equal', '', True),
+	('zoom_out', 'gtk-zoom-out', _('Zoom _Out'), '<Primary>minus', '', True), # T: Menu item
+	('zoom_reset', 'gtk-zoom-100', _('_Normal Size'), '<Primary>0', '', True), # T: Menu item to reset zoom
+
+>>>>>>> MERGE-SOURCE
 	# name, stock id, label
 	('insert_new_file_menu', None, _('New _Attachment')), # T: Menu title
 )
@@ -891,6 +970,10 @@
 				self.insert_object_at_cursor(obj)
 
 				set_indent(None)
+			elif element.tag == 'line':
+				obj = ObjectManager.get_object('line', None, None)
+				self.insert_object_at_cursor(obj)
+
 			elif element.tag == 'object':
 				if 'indent' in element.attrib:
 					set_indent(int(element.attrib['indent']))
@@ -2332,6 +2415,18 @@
 					and hasattr(anchor.manager, 'build_parsetree_of_table'): # fallback should not go here...
 						obj = anchor.manager
 						obj.build_parsetree_of_table(builder, iter)
+					elif attrib and attrib['type'] == 'line':
+						# Add (if necessary) additional newline symbols
+						# to prevent formatting back from line object to text.
+						_new_iter = iter.copy()
+						_start = '' if _new_iter.starts_line() else '\n'
+						_new_iter.forward_char()
+						_end = '' if _new_iter.ends_line() else '\n'
+						data = '{}{}{}'.format(_start, LINE_TEXT, _end)
+						logger.debug("Anchor with Line, obj:%s", anchor.manager)
+						builder.start('line', attrib)
+						builder.data(data)
+						builder.end('line')
 					else:
 						# general object related parsing
 						data = anchor.manager.get_data()
@@ -4203,6 +4298,12 @@
 			buffer.insert_with_tags_by_name(
 				buffer.get_iter_at_mark(mark), heading, 'style-h'+str(level))
 			buffer.delete_mark(mark)
+		elif IS_LINE(line):
+			with buffer.user_action:
+				buffer.delete(start, end)
+				obj = ObjectManager.get_object('line', None, None)
+				buffer.insert_object_at_cursor(obj)
+				buffer.insert_at_cursor('\n')
 		elif not buffer.get_bullet_at_iter(start) is None:
 			# we are part of bullet list
 			# FIXME should logic be handled by TextBufferList ?
@@ -4364,6 +4465,7 @@
 			('insert-text', self.do_insert_text),
 			#~ ('inserted-tree', self.do_insert_tree), # TODO
 			('insert-pixbuf', self.do_insert_pixbuf),
+			('insert-child-anchor', self.do_insert_pixbuf),
 			('delete-range', self.do_delete_range),
 			('begin-user-action', self.do_begin_user_action),
 			('end-user-action', self.do_end_user_action),
@@ -5585,7 +5687,23 @@
 		with buffer.user_action:
 			buffer.insert_object_at_cursor(obj)
 
+<<<<<<< TREE
 	@action(_('_Image...'), readonly=False) # T: Menu item
+=======
+	def insert_line(self):
+		'''
+                This function is called from menu action.
+                Insert a line at the cursor position.
+		'''
+		obj = ObjectManager.get_object('line', None, None)
+
+		buffer = self.view.get_buffer()
+		with buffer.user_action:
+			buffer.insert_object_at_cursor(obj)
+			# Add newline after line separator widget.
+			buffer.insert_at_cursor('\n')
+
+>>>>>>> MERGE-SOURCE
 	def insert_image(self, file=None, type=None, interactive=True, force=False):
 		'''Menu action to insert an image, shows the L{InsertImageDialog}