Reproog/novelWriter
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Refactor Odt paragraph style class

Browse Source
This commit is contained in:
Veronica Berglyd Olsen
2024-04-05 17:23:07 +02:00
parent 53e5756745
commit dd539be64e
2 changed files with 69 additions and 51 deletions
Download Patch File Download Diff File Expand all files Collapse all files
novelwriter/core/toodt.py
+62 -44
View File
@@ -126,8 +126,8 @@ class ToOdt(Tokenizer):
self._xBody = ET.Element("") # Office body root self._xBody = ET.Element("") # Office body root
self._xText = ET.Element("") # Office text root self._xText = ET.Element("") # Office text root
self._mainPara = {} # User-accessible paragraph styles self._mainPara: dict[str, ODTParagraphStyle] = {} # User-accessible paragraph styles
self._autoPara = {} # Auto-generated paragraph styles self._autoPara: dict[str, ODTParagraphStyle] = {} # Auto-generated paragraph styles
self._autoText = {} # Auto-generated text styles self._autoText = {} # Auto-generated text styles
self._errData = [] # List of errors encountered self._errData = [] # List of errors encountered
@@ -515,10 +515,10 @@ class ToOdt(Tokenizer):
def closeDocument(self) -> None: def closeDocument(self) -> None:
"""Pack the styles of the XML document.""" """Pack the styles of the XML document."""
# Build the auto-generated styles # Build the auto-generated styles
for styleName, styleObj in self._autoPara.values(): for style in self._autoPara.values():
styleObj.packXML(self._xAuto, styleName) style.packXML(self._xAuto)
for styleName, styleObj in self._autoText.values(): for styleName, style in self._autoText.values():
styleObj.packXML(self._xAuto, styleName) style.packXML(self._xAuto, styleName)
return return
def saveFlatXML(self, path: str | Path) -> None: def saveFlatXML(self, path: str | Path) -> None:
@@ -700,12 +700,13 @@ class ToOdt(Tokenizer):
oStyle.setParentStyleName(parName) oStyle.setParentStyleName(parName)
pID = oStyle.getID() pID = oStyle.getID()
if pID in self._autoPara: if pID in self._autoPara:
return self._autoPara[pID][0] return self._autoPara[pID].name
newName = "P%d" % (len(self._autoPara) + 1) name = f"P{len(self._autoPara)+1:d}"
self._autoPara[pID] = (newName, oStyle) oStyle.setName(name)
self._autoPara[pID] = oStyle
return newName return name
def _textStyle(self, hFmt: int) -> str: def _textStyle(self, hFmt: int) -> str:
"""Return a text style for a given style code.""" """Return a text style for a given style code."""
@@ -835,7 +836,7 @@ class ToOdt(Tokenizer):
def _useableStyles(self) -> None: def _useableStyles(self) -> None:
"""Set the usable styles.""" """Set the usable styles."""
# Add Text Body Style # Add Text Body Style
style = ODTParagraphStyle() style = ODTParagraphStyle("Text_20_body")
style.setClass("text") style.setClass("text")
style.setDisplayName("Text body") style.setDisplayName("Text body")
style.setFontFamily(self._fontFamily) style.setFontFamily(self._fontFamily)
@@ -846,20 +847,20 @@ class ToOdt(Tokenizer):
style.setMarginTop(self._mTopText) style.setMarginTop(self._mTopText)
style.setParentStyleName("Standard") style.setParentStyleName("Standard")
style.setTextAlign(self._textAlign) style.setTextAlign(self._textAlign)
style.packXML(self._xStyl, "Text_20_body") style.packXML(self._xStyl)
self._mainPara["Text_20_body"] = style self._mainPara[style.name] = style
# Add First Line Indent Style # Add First Line Indent Style
style = ODTParagraphStyle() style = ODTParagraphStyle("First_20_line_20_indent")
style.setClass("text") style.setClass("text")
style.setDisplayName("First line indent") style.setDisplayName("First line indent")
style.setParentStyleName("Text_20_body") style.setParentStyleName("Text_20_body")
style.setTextIndent(self._fTextIndent) style.setTextIndent(self._fTextIndent)
style.packXML(self._xStyl, "First_20_line_20_indent") style.packXML(self._xStyl)
self._mainPara["First_20_line_20_indent"] = style self._mainPara[style.name] = style
# Add Text Meta Style # Add Text Meta Style
style = ODTParagraphStyle() style = ODTParagraphStyle("Text_20_Meta")
style.setClass("text") style.setClass("text")
style.setColor(self._colMetaTx) style.setColor(self._colMetaTx)
style.setDisplayName("Text Meta") style.setDisplayName("Text Meta")
@@ -871,11 +872,11 @@ class ToOdt(Tokenizer):
style.setMarginTop(self._mTopMeta) style.setMarginTop(self._mTopMeta)
style.setOpacity(self._opaMetaTx) style.setOpacity(self._opaMetaTx)
style.setParentStyleName("Standard") style.setParentStyleName("Standard")
style.packXML(self._xStyl, "Text_20_Meta") style.packXML(self._xStyl)
self._mainPara["Text_20_Meta"] = style self._mainPara[style.name] = style
# Add Title Style # Add Title Style
style = ODTParagraphStyle() style = ODTParagraphStyle("Title")
style.setClass("chapter") style.setClass("chapter")
style.setDisplayName("Title") style.setDisplayName("Title")
style.setFontFamily(self._fontFamily) style.setFontFamily(self._fontFamily)
@@ -887,11 +888,11 @@ class ToOdt(Tokenizer):
style.setNextStyleName("Text_20_body") style.setNextStyleName("Text_20_body")
style.setParentStyleName("Heading") style.setParentStyleName("Heading")
style.setTextAlign("center") style.setTextAlign("center")
style.packXML(self._xStyl, "Title") style.packXML(self._xStyl)
self._mainPara["Title"] = style self._mainPara[style.name] = style
# Add Separator Style # Add Separator Style
style = ODTParagraphStyle() style = ODTParagraphStyle("Separator")
style.setClass("text") style.setClass("text")
style.setDisplayName("Separator") style.setDisplayName("Separator")
style.setFontFamily(self._fontFamily) style.setFontFamily(self._fontFamily)
@@ -903,11 +904,11 @@ class ToOdt(Tokenizer):
style.setNextStyleName("Text_20_body") style.setNextStyleName("Text_20_body")
style.setParentStyleName("Standard") style.setParentStyleName("Standard")
style.setTextAlign("center") style.setTextAlign("center")
style.packXML(self._xStyl, "Separator") style.packXML(self._xStyl)
self._mainPara["Separator"] = style self._mainPara[style.name] = style
# Add Heading 1 Style # Add Heading 1 Style
style = ODTParagraphStyle() style = ODTParagraphStyle("Heading_20_1")
style.setClass("text") style.setClass("text")
style.setColor(self._colHead12) style.setColor(self._colHead12)
style.setDisplayName("Heading 1") style.setDisplayName("Heading 1")
@@ -921,11 +922,11 @@ class ToOdt(Tokenizer):
style.setOpacity(self._opaHead12) style.setOpacity(self._opaHead12)
style.setOutlineLevel("1") style.setOutlineLevel("1")
style.setParentStyleName("Heading") style.setParentStyleName("Heading")
style.packXML(self._xStyl, "Heading_20_1") style.packXML(self._xStyl)
self._mainPara["Heading_20_1"] = style self._mainPara[style.name] = style
# Add Heading 2 Style # Add Heading 2 Style
style = ODTParagraphStyle() style = ODTParagraphStyle("Heading_20_2")
style.setClass("text") style.setClass("text")
style.setColor(self._colHead12) style.setColor(self._colHead12)
style.setDisplayName("Heading 2") style.setDisplayName("Heading 2")
@@ -939,11 +940,11 @@ class ToOdt(Tokenizer):
style.setOpacity(self._opaHead12) style.setOpacity(self._opaHead12)
style.setOutlineLevel("2") style.setOutlineLevel("2")
style.setParentStyleName("Heading") style.setParentStyleName("Heading")
style.packXML(self._xStyl, "Heading_20_2") style.packXML(self._xStyl)
self._mainPara["Heading_20_2"] = style self._mainPara[style.name] = style
# Add Heading 3 Style # Add Heading 3 Style
style = ODTParagraphStyle() style = ODTParagraphStyle("Heading_20_3")
style.setClass("text") style.setClass("text")
style.setColor(self._colHead34) style.setColor(self._colHead34)
style.setDisplayName("Heading 3") style.setDisplayName("Heading 3")
@@ -957,11 +958,11 @@ class ToOdt(Tokenizer):
style.setOpacity(self._opaHead34) style.setOpacity(self._opaHead34)
style.setOutlineLevel("3") style.setOutlineLevel("3")
style.setParentStyleName("Heading") style.setParentStyleName("Heading")
style.packXML(self._xStyl, "Heading_20_3") style.packXML(self._xStyl)
self._mainPara["Heading_20_3"] = style self._mainPara[style.name] = style
# Add Heading 4 Style # Add Heading 4 Style
style = ODTParagraphStyle() style = ODTParagraphStyle("Heading_20_4")
style.setClass("text") style.setClass("text")
style.setColor(self._colHead34) style.setColor(self._colHead34)
style.setDisplayName("Heading 4") style.setDisplayName("Heading 4")
@@ -975,16 +976,16 @@ class ToOdt(Tokenizer):
style.setOpacity(self._opaHead34) style.setOpacity(self._opaHead34)
style.setOutlineLevel("4") style.setOutlineLevel("4")
style.setParentStyleName("Heading") style.setParentStyleName("Heading")
style.packXML(self._xStyl, "Heading_20_4") style.packXML(self._xStyl)
self._mainPara["Heading_20_4"] = style self._mainPara[style.name] = style
# Add Header Style # Add Header Style
style = ODTParagraphStyle() style = ODTParagraphStyle("Header")
style.setDisplayName("Header") style.setDisplayName("Header")
style.setParentStyleName("Header_20_and_20_Footer") style.setParentStyleName("Header_20_and_20_Footer")
style.setTextAlign("right") style.setTextAlign("right")
style.packXML(self._xStyl, "Header") style.packXML(self._xStyl)
self._mainPara["Header"] = style self._mainPara[style.name] = style
return return
@@ -1045,7 +1046,9 @@ class ODTParagraphStyle:
VALID_CLASS = ["text", "chapter"] VALID_CLASS = ["text", "chapter"]
VALID_WEIGHT = ["normal", "inherit", "bold"] VALID_WEIGHT = ["normal", "inherit", "bold"]
def __init__(self) -> None: def __init__(self, name: str = "None") -> None:
self._name = name
# Attributes # Attributes
self._mAttr = { self._mAttr = {
@@ -1081,6 +1084,10 @@ class ODTParagraphStyle:
return return
@property
def name(self) -> str:
return self._name
## ##
# Checkers # Checkers
## ##
@@ -1091,6 +1098,15 @@ class ODTParagraphStyle:
self._pAttr[n][1] is None for n in ["text-align", "margin-left", "margin-right"] self._pAttr[n][1] is None for n in ["text-align", "margin-left", "margin-right"]
) )
##
# Setters
##
def setName(self, name: str) -> None:
"""Set the paragraph style name."""
self._name = name
return
## ##
# Attribute Setters # Attribute Setters
## ##
@@ -1228,13 +1244,15 @@ class ODTParagraphStyle:
f"Paragraph:Text:{str(self._tAttr)}:" f"Paragraph:Text:{str(self._tAttr)}:"
).encode()).hexdigest() ).encode()).hexdigest()
def packXML(self, xParent: ET.Element, name: str) -> None: def packXML(self, xParent: ET.Element) -> None:
"""Pack the content into an xml element.""" """Pack the content into an xml element."""
attr = { attr = {
_mkTag("style", "name"): name, _mkTag("style", "name"): self._name,
_mkTag("style", "family"): "paragraph", _mkTag("style", "family"): "paragraph",
} }
attr.update({_mkTag(n, m): v for m, (n, v) in self._mAttr.items() if v is not None}) attr.update(
{_mkTag(n, m): v for m, (n, v) in self._mAttr.items() if v is not None}
)
xEntry = ET.SubElement(xParent, _mkTag("style", "style"), attrib=attr) xEntry = ET.SubElement(xParent, _mkTag("style", "style"), attrib=attr)
if attr := {_mkTag(n, m): v for m, (n, v) in self._pAttr.items() if v is not None}: if attr := {_mkTag(n, m): v for m, (n, v) in self._pAttr.items() if v is not None}:
tests/test_core/test_core_toodt.py
+7 -7
View File
@@ -137,8 +137,8 @@ def testCoreToOdt_TextFormatting(mockGUI):
key = "55db6c1d22ff5aba93f0f67c8d4a857a26e2d3813dfbcba1ef7c0d424f501be5" key = "55db6c1d22ff5aba93f0f67c8d4a857a26e2d3813dfbcba1ef7c0d424f501be5"
assert key in odt._autoPara assert key in odt._autoPara
assert odt._autoPara[key][0] == "P1" assert isinstance(odt._autoPara[key], ODTParagraphStyle)
assert isinstance(odt._autoPara[key][1], ODTParagraphStyle) assert odt._autoPara[key].name == "P1"
# Paragraph Formatting # Paragraph Formatting
# ==================== # ====================
@@ -334,9 +334,9 @@ def testCoreToOdt_ConvertParagraphs(mockGUI):
odt._isNovel = True odt._isNovel = True
def getStyle(styleName): def getStyle(styleName):
for aSet in odt._autoPara.values(): for style in odt._autoPara.values():
if aSet[0] == styleName: if style.name == styleName:
return aSet[1] return style
return None return None
# Nested Markdown Text # Nested Markdown Text
@@ -857,7 +857,7 @@ def testCoreToOdt_Format(mockGUI):
@pytest.mark.core @pytest.mark.core
def testCoreToOdt_ODTParagraphStyle(): def testCoreToOdt_ODTParagraphStyle():
"""Test the ODTParagraphStyle class.""" """Test the ODTParagraphStyle class."""
parStyle = ODTParagraphStyle() parStyle = ODTParagraphStyle("test")
# Set Attributes # Set Attributes
# ============== # ==============
@@ -1033,7 +1033,7 @@ def testCoreToOdt_ODTParagraphStyle():
# Pack XML # Pack XML
# ======== # ========
xStyle = ET.Element("test") xStyle = ET.Element("test")
parStyle.packXML(xStyle, "test") parStyle.packXML(xStyle)
assert xmlToText(xStyle) == ( assert xmlToText(xStyle) == (
'<test>' '<test>'
'<style:style style:name="test" style:family="paragraph" style:display-name="Name" ' '<style:style style:name="test" style:family="paragraph" style:display-name="Name" '