1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/moinformat/translators/common.py Thu Aug 17 23:34:10 2023 +0200
1.3 @@ -0,0 +1,75 @@
1.4 +#!/usr/bin/env python
1.5 +
1.6 +"""
1.7 +Document translator support.
1.8 +
1.9 +Copyright (C) 2017, 2018, 2019, 2021, 2023 Paul Boddie <paul@boddie.org.uk>
1.10 +
1.11 +This program is free software; you can redistribute it and/or modify it under
1.12 +the terms of the GNU General Public License as published by the Free Software
1.13 +Foundation; either version 3 of the License, or (at your option) any later
1.14 +version.
1.15 +
1.16 +This program is distributed in the hope that it will be useful, but WITHOUT
1.17 +ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
1.18 +FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
1.19 +details.
1.20 +
1.21 +You should have received a copy of the GNU General Public License along with
1.22 +this program. If not, see <http://www.gnu.org/licenses/>.
1.23 +"""
1.24 +
1.25 +class Translator:
1.26 +
1.27 + "General translator support."
1.28 +
1.29 + input_formats = None # defined by subclasses
1.30 + formats = None # defined by subclasses
1.31 +
1.32 + def __init__(self, metadata):
1.33 +
1.34 + """
1.35 + Initialise the translator with the given 'metadata'.
1.36 + """
1.37 +
1.38 + self.metadata = metadata
1.39 +
1.40 + # Initialisation of any other state.
1.41 +
1.42 + self.init()
1.43 +
1.44 + def init(self):
1.45 +
1.46 + "Initialisation method to be overridden by subclasses."
1.47 +
1.48 + pass
1.49 +
1.50 + def __repr__(self):
1.51 + return "%s(%r)" % (self.__class__.__name__, self.metadata)
1.52 +
1.53 + # Translation visitor methods.
1.54 +
1.55 + def visit(self, node):
1.56 +
1.57 + """
1.58 + Visit the 'node', invoking the appropriate serialisation handler, and
1.59 + returning the result of the handler.
1.60 + """
1.61 +
1.62 + return node.visit(self)
1.63 +
1.64 + def container(self, container):
1.65 +
1.66 + "Visit all nodes in 'container', returning a list of translated nodes."
1.67 +
1.68 + nodes = []
1.69 +
1.70 + if container.nodes:
1.71 + for node in container.nodes:
1.72 + n = self.visit(node)
1.73 + if n:
1.74 + nodes.append(n)
1.75 +
1.76 + return nodes
1.77 +
1.78 +# vim: tabstop=4 expandtab shiftwidth=4