1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
|
#!/usr/bin/env python
# -*- coding: utf-8 -*-
#
# Copyright 2004-2007 Zuza Software Foundation
#
# This file is part of translate.
#
# translate 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.
#
# translate 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 translate; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
#
"""Module for parsing Qt .ts files for translation.
Currently this module supports the old format of .ts files. Some applictaions
use the newer .ts format which are documented here:
U{TS file format 4.3<http://doc.trolltech.com/4.3/linguist-ts-file-format.html>},
U{Example<http://svn.ez.no/svn/ezcomponents/trunk/Translation/docs/linguist-format.txt>}
U{Specification of the valid variable entries <http://doc.trolltech.com/4.3/qstring.html#arg>},
U{2 <http://doc.trolltech.com/4.3/qstring.html#arg-2>}
"""
from translate.misc import ourdom
class QtTsParser:
contextancestors = dict.fromkeys(["TS"])
messageancestors = dict.fromkeys(["TS", "context"])
def __init__(self, inputfile=None):
"""make a new QtTsParser, reading from the given inputfile if required"""
self.filename = getattr(inputfile, "filename", None)
self.knowncontextnodes = {}
self.indexcontextnodes = {}
if inputfile is None:
self.document = ourdom.parseString("<!DOCTYPE TS><TS></TS>")
else:
self.document = ourdom.parse(inputfile)
assert self.document.documentElement.tagName == "TS"
def addtranslation(self, contextname, source, translation, comment=None, transtype=None, createifmissing=False):
"""adds the given translation (will create the nodes required if asked). Returns success"""
contextnode = self.getcontextnode(contextname)
if contextnode is None:
if not createifmissing:
return False
# construct a context node with the given name
contextnode = self.document.createElement("context")
namenode = self.document.createElement("name")
nametext = self.document.createTextNode(contextname)
namenode.appendChild(nametext)
contextnode.appendChild(namenode)
self.document.documentElement.appendChild(contextnode)
if not createifmissing:
return False
messagenode = self.document.createElement("message")
sourcenode = self.document.createElement("source")
sourcetext = self.document.createTextNode(source)
sourcenode.appendChild(sourcetext)
messagenode.appendChild(sourcenode)
if comment:
commentnode = self.document.createElement("comment")
commenttext = self.document.createTextNode(comment)
commentnode.appendChild(commenttext)
messagenode.appendChild(commentnode)
translationnode = self.document.createElement("translation")
translationtext = self.document.createTextNode(translation)
translationnode.appendChild(translationtext)
if transtype:
translationnode.setAttribute("type", transtype)
messagenode.appendChild(translationnode)
contextnode.appendChild(messagenode)
return True
def getxml(self):
"""return the ts file as xml"""
xml = self.document.toprettyxml(indent=" ", encoding="utf-8")
#This line causes empty lines in the translation text to be removed (when there are two newlines)
xml = "\n".join([line for line in xml.split("\n") if line.strip()])
return xml
def getcontextname(self, contextnode):
"""returns the name of the given context"""
namenode = ourdom.getFirstElementByTagName(contextnode, "name")
return ourdom.getnodetext(namenode)
def getcontextnode(self, contextname):
"""finds the contextnode with the given name"""
contextnode = self.knowncontextnodes.get(contextname, None)
if contextnode is not None:
return contextnode
contextnodes = self.document.searchElementsByTagName("context", self.contextancestors)
for contextnode in contextnodes:
if self.getcontextname(contextnode) == contextname:
self.knowncontextnodes[contextname] = contextnode
return contextnode
return None
def getmessagenodes(self, context=None):
"""returns all the messagenodes, limiting to the given context (name or node) if given"""
if context is None:
return self.document.searchElementsByTagName("message", self.messageancestors)
else:
if isinstance(context, (str, unicode)):
# look up the context node by name
context = self.getcontextnode(context)
if context is None:
return []
return context.searchElementsByTagName("message", self.messageancestors)
def getmessagesource(self, message):
"""returns the message source for a given node"""
sourcenode = ourdom.getFirstElementByTagName(message, "source")
return ourdom.getnodetext(sourcenode)
def getmessagetranslation(self, message):
"""returns the message translation for a given node"""
translationnode = ourdom.getFirstElementByTagName(message, "translation")
return ourdom.getnodetext(translationnode)
def getmessagetype(self, message):
"""returns the message translation attributes for a given node"""
translationnode = ourdom.getFirstElementByTagName(message, "translation")
return translationnode.getAttribute("type")
def getmessagecomment(self, message):
"""returns the message comment for a given node"""
commentnode = ourdom.getFirstElementByTagName(message, "comment")
# NOTE: handles only one comment per msgid (OK)
# and only one-line comments (can be VERY wrong) TODO!!!
return ourdom.getnodetext(commentnode)
def iteritems(self):
"""iterates through (contextname, messages)"""
for contextnode in self.document.searchElementsByTagName("context", self.contextancestors):
yield self.getcontextname(contextnode), self.getmessagenodes(contextnode)
def __del__(self):
"""clean up the document if required"""
if hasattr(self, "document"):
self.document.unlink()
|
