1 #!/usr/bin/env python 2 3 """ 4 Document translator support. 5 6 Copyright (C) 2017, 2018, 2019, 2021, 2023 Paul Boddie <paul@boddie.org.uk> 7 8 This program is free software; you can redistribute it and/or modify it under 9 the terms of the GNU General Public License as published by the Free Software 10 Foundation; either version 3 of the License, or (at your option) any later 11 version. 12 13 This program is distributed in the hope that it will be useful, but WITHOUT 14 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS 15 FOR A PARTICULAR PURPOSE. See the GNU General Public License for more 16 details. 17 18 You should have received a copy of the GNU General Public License along with 19 this program. If not, see <http://www.gnu.org/licenses/>. 20 """ 21 22 class Translator: 23 24 "General translator support." 25 26 input_formats = None # defined by subclasses 27 formats = None # defined by subclasses 28 29 def __init__(self, metadata): 30 31 """ 32 Initialise the translator with the given 'metadata'. 33 """ 34 35 self.metadata = metadata 36 37 # Initialisation of any other state. 38 39 self.init() 40 41 def init(self): 42 43 "Initialisation method to be overridden by subclasses." 44 45 pass 46 47 def __repr__(self): 48 return "%s(%r)" % (self.__class__.__name__, self.metadata) 49 50 # Translation visitor methods. 51 52 def visit(self, node): 53 54 """ 55 Visit the 'node', invoking the appropriate serialisation handler, and 56 returning the result of the handler. 57 """ 58 59 return node.visit(self) 60 61 def container(self, container): 62 63 "Visit all nodes in 'container', returning a list of translated nodes." 64 65 nodes = [] 66 67 if container.nodes: 68 for node in container.nodes: 69 n = self.visit(node) 70 if n: 71 nodes.append(n) 72 73 return nodes 74 75 # vim: tabstop=4 expandtab shiftwidth=4