mirror of
https://github.com/olivierkes/manuskript.git
synced 2024-04-28 10:02:31 +12:00
138 lines
5.1 KiB
Python
138 lines
5.1 KiB
Python
# -*- coding: utf-8 -*-
|
|
#
|
|
# Create and extract text from ODF, handling whitespace correctly.
|
|
# Copyright (C) 2008 J. David Eisenberg
|
|
#
|
|
# 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 of the License, 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.,
|
|
# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
|
|
|
|
|
|
"""
|
|
Class for handling whitespace properly in OpenDocument.
|
|
|
|
While it is possible to use getTextContent() and setTextContent()
|
|
to extract or create ODF content, these won't extract or create
|
|
the appropriate <text:s>, <text:tab>, or <text:line-break>
|
|
elements. This module takes care of that problem.
|
|
"""
|
|
|
|
from odf.element import Node
|
|
import odf.opendocument
|
|
from odf.text import S,LineBreak,Tab
|
|
|
|
class WhitespaceText(object):
|
|
|
|
def __init__(self):
|
|
self.textBuffer = []
|
|
self.spaceCount = 0
|
|
|
|
def addTextToElement(self, odfElement, s):
|
|
""" Process an input string, inserting
|
|
<text:tab> elements for '\t',
|
|
<text:line-break> elements for '\n', and
|
|
<text:s> elements for runs of more than one blank.
|
|
These will be added to the given element.
|
|
"""
|
|
i = 0
|
|
ch = ' '
|
|
|
|
# When we encounter a tab or newline, we can immediately
|
|
# dump any accumulated text and then emit the appropriate
|
|
# ODF element.
|
|
#
|
|
# When we encounter a space, we add it to the text buffer,
|
|
# and then collect more spaces. If there are more spaces
|
|
# after the first one, we dump the text buffer and then
|
|
# then emit the appropriate <text:s> element.
|
|
|
|
while i < len(s):
|
|
ch = s[i]
|
|
if ch == '\t':
|
|
self._emitTextBuffer(odfElement)
|
|
odfElement.addElement(Tab())
|
|
i += 1
|
|
elif ch == '\n':
|
|
self._emitTextBuffer(odfElement);
|
|
odfElement.addElement(LineBreak())
|
|
i += 1
|
|
elif ch == ' ':
|
|
self.textBuffer.append(' ')
|
|
i += 1
|
|
self.spaceCount = 0
|
|
while i < len(s) and (s[i] == ' '):
|
|
self.spaceCount += 1
|
|
i += 1
|
|
if self.spaceCount > 0:
|
|
self._emitTextBuffer(odfElement)
|
|
self._emitSpaces(odfElement)
|
|
else:
|
|
self.textBuffer.append(ch)
|
|
i += 1
|
|
|
|
self._emitTextBuffer(odfElement)
|
|
|
|
def _emitTextBuffer(self, odfElement):
|
|
""" Creates a Text Node whose contents are the current textBuffer.
|
|
Side effect: clears the text buffer.
|
|
"""
|
|
if len(self.textBuffer) > 0:
|
|
odfElement.addText(''.join(self.textBuffer))
|
|
self.textBuffer = []
|
|
|
|
|
|
def _emitSpaces(self, odfElement):
|
|
""" Creates a <text:s> element for the current spaceCount.
|
|
Side effect: sets spaceCount back to zero
|
|
"""
|
|
if self.spaceCount > 0:
|
|
spaceElement = S(c=self.spaceCount)
|
|
odfElement.addElement(spaceElement)
|
|
self.spaceCount = 0
|
|
|
|
def addTextToElement(odfElement, s):
|
|
wst = WhitespaceText()
|
|
wst.addTextToElement(odfElement, s)
|
|
|
|
def extractText(odfElement):
|
|
""" Extract text content from an Element, with whitespace represented
|
|
properly. Returns the text, with tabs, spaces, and newlines
|
|
correctly evaluated. This method recursively descends through the
|
|
children of the given element, accumulating text and "unwrapping"
|
|
<text:s>, <text:tab>, and <text:line-break> elements along the way.
|
|
"""
|
|
result = [];
|
|
|
|
if len(odfElement.childNodes) != 0:
|
|
for child in odfElement.childNodes:
|
|
if child.nodeType == Node.TEXT_NODE:
|
|
result.append(child.data)
|
|
elif child.nodeType == Node.ELEMENT_NODE:
|
|
subElement = child
|
|
tagName = subElement.qname;
|
|
if tagName == (u"urn:oasis:names:tc:opendocument:xmlns:text:1.0", u"line-break"):
|
|
result.append("\n")
|
|
elif tagName == (u"urn:oasis:names:tc:opendocument:xmlns:text:1.0", u"tab"):
|
|
result.append("\t")
|
|
elif tagName == (u"urn:oasis:names:tc:opendocument:xmlns:text:1.0", u"s"):
|
|
c = subElement.getAttribute('c')
|
|
if c:
|
|
spaceCount = int(c)
|
|
else:
|
|
spaceCount = 1
|
|
|
|
result.append(" " * spaceCount)
|
|
else:
|
|
result.append(extractText(subElement))
|
|
return ''.join(result)
|