1# Copyright (c) 2004 Danilo Segan <danilo@kvota.net>.
2#
3# This file is part of xml2po.
4#
5# xml2po is free software; you can redistribute it and/or modify
6# it under the terms of the GNU General Public License as published by
7# the Free Software Foundation; either version 2 of the License, or
8# (at your option) any later version.
9#
10# xml2po is distributed in the hope that it will be useful,
11# but WITHOUT ANY WARRANTY; without even the implied warranty of
12# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13# GNU General Public License for more details.
14#
15# You should have received a copy of the GNU General Public License
16# along with xml2po; if not, write to the Free Software Foundation, Inc.,
17# 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
18#
19
20# Abstract class; use it only to construct other special-handling classes
21#
22
23class emptyXmlMode:
24    """Abstract class for special handling of document types."""
25    def getIgnoredTags(self):
26        "Returns array of tags to be ignored."
27        return []
28
29    def getFinalTags(self):
30        "Returns array of tags to be considered 'final'."
31        return []
32
33    def getSpacePreserveTags(self):
34        "Returns array of tags in which spaces are to be preserved."
35        return []
36
37    def preProcessXml(self, doc, msg):
38        "Preprocess a document and perhaps adds some messages."
39        pass
40
41    def postProcessXmlTranslation(self, doc, language, translators):
42        """Sets a language and translators in "doc" tree.
43
44        "translators" is a string consisted of translator credits.
45        "language" is a simple string.
46        "doc" is a libxml2.xmlDoc instance."""
47        pass
48
49    def getStringForTranslators(self):
50        """Returns None or a string to be added to PO files.
51
52        Common example is 'translator-credits'."""
53        return None
54
55    def getCommentForTranslators(self):
56        """Returns a comment to be added next to string for crediting translators.
57
58        It should explain the format of the string provided by getStringForTranslators()."""
59        return None
60