Merge pull request #112 from matze-dd/Issue-110

Closes #110

HISTORY.md

@@ -1,5 +1,10 @@
 Work in progress
 ----------------
+- **Changed interface** to extension modules for packages and document classes
+  (issue [#110](../../issues/110)).
+  Entry point is now function init\_module() with two arguments: parser and
+  list of packet options.
+  See for instance file yalafi/packages/amsmath.py.
 - yalafi.shell
   - added support for multi-language documents (issue [#98](../../issues/98))
   - new options --multi-language, --ml-continue-threshold, --ml-rule-threshold,

README.md

@@ -929,11 +929,10 @@ submodules that are activated by the LaTeX filter when executing
   This is similar to the previous case.
 
 Each extension module has to provide a list 'require\_packages' of strings
-that causes loading of other modules, and a function 'modify\_parameters()'.
-It is called by the parser and can modify the passed object of
-class 'Parameters'.
+that causes loading of other modules, and a function 'init\_module()'.
+It is called by the parser and can modify the object of class 'Parameters'.
 In order to add macros and environments, it has to construct strings or
-object lists that are included in the returned object of class 'ModParm'.
+object lists that are included in the returned object of class 'InitModule'.
 Classes for definition of macros and environments are described in the
 sections starting at [Definition of macros](#definition-of-macros).
 For an example, see file

tests/defs.py

@@ -1,9 +1,10 @@
 
-from yalafi.defs import ModParm, Environ, EquEnv
+from yalafi.defs import InitModule, Environ, EquEnv
 
 require_packages = ['amsmath']  # for test_modules.py
 
-def modify_parameters(parms):
+def init_module(parser, options):
+    parms = parser.parms
 
     environments = [
 
@@ -12,5 +13,5 @@ def modify_parameters(parms):
 
     ]
 
-    return ModParm(environments=environments)
+    return InitModule(environments=environments)
 

yalafi/defs.py

@@ -18,7 +18,7 @@
 
 from . import utils
 
-class ModParm:
+class InitModule:
     def __init__(self, macros_latex='', macros_python=[], environments=[]):
         self.macros_latex = macros_latex
         self.macros_python = macros_python

yalafi/documentclasses/article.py

@@ -3,11 +3,12 @@
 #   YaLafi: \documentclass{article}
 #
 
-from yalafi.defs import ModParm
+from yalafi.defs import InitModule
 
 require_packages = []
 
-def modify_parameters(parms):
+def init_module(parser, options):
+    parms = parser.parms
 
-    return ModParm()
+    return InitModule()
 

yalafi/documentclasses/book.py

@@ -3,11 +3,12 @@
 #   YaLafi: \documentclass{book}
 #
 
-from yalafi.defs import ModParm
+from yalafi.defs import InitModule
 
 require_packages = []
 
-def modify_parameters(parms):
+def init_module(parser, options):
+    parms = parser.parms
 
-    return ModParm()
+    return InitModule()
 

yalafi/documentclasses/report.py

@@ -3,11 +3,12 @@
 #   YaLafi: \documentclass{report}
 #
 
-from yalafi.defs import ModParm
+from yalafi.defs import InitModule
 
 require_packages = []
 
-def modify_parameters(parms):
+def init_module(parser, options):
+    parms = parser.parms
 
-    return ModParm()
+    return InitModule()
 

yalafi/documentclasses/scrartcl.py

@@ -3,11 +3,12 @@
 #   YaLafi: \documentclass{scrartcl}
 #
 
-from yalafi.defs import ModParm
+from yalafi.defs import InitModule
 
 require_packages = []
 
-def modify_parameters(parms):
+def init_module(parser, options):
+    parms = parser.parms
 
     macros_latex = r"""
 
@@ -16,5 +17,5 @@ def modify_parameters(parms):
 
     """
 
-    return ModParm(macros_latex=macros_latex)
+    return InitModule(macros_latex=macros_latex)
 

yalafi/documentclasses/scrbook.py

@@ -3,11 +3,12 @@
 #   YaLafi: \documentclass{scrbook}
 #
 
-from yalafi.defs import ModParm
+from yalafi.defs import InitModule
 
 require_packages = []
 
-def modify_parameters(parms):
+def init_module(parser, options):
+    parms = parser.parms
 
     macros_latex = r"""
 
@@ -16,5 +17,5 @@ def modify_parameters(parms):
 
     """
 
-    return ModParm(macros_latex=macros_latex)
+    return InitModule(macros_latex=macros_latex)
 

yalafi/documentclasses/scrreprt.py

@@ -3,11 +3,12 @@
 #   YaLafi: \documentclass{scrreprt}
 #
 
-from yalafi.defs import ModParm
+from yalafi.defs import InitModule
 
 require_packages = []
 
-def modify_parameters(parms):
+def init_module(parser, options):
+    parms = parser.parms
 
     macros_latex = r"""
 
@@ -16,5 +17,5 @@ def modify_parameters(parms):
 
     """
 
-    return ModParm(macros_latex=macros_latex)
+    return InitModule(macros_latex=macros_latex)
 

yalafi/handlers.py

@@ -76,10 +76,11 @@ def handler (parser, buf, mac, args, pos):
 def h_newtheorem(parser, buf, mac, args, pos):
     name = parser.get_text_expanded(args[0])
     title = parser.get_text_expanded(args[2])
-    def f(parms):
+    def f(parser, options):
+        parms = parser.parms
         envs = [defs.Environ(parms, name, args='O', repl=h_theorem(title))]
-        return defs.ModParm(environments=envs)
-    parser.modify_parameters(f)
+        return defs.InitModule(environments=envs)
+    parser.modify_parameters(f, [])
     return []
 
 #   heading macros: append '.', unless last char in parms.heading_punct
@@ -131,9 +132,10 @@ def h_load_defs(parser, buf, mac, args, pos):
 #
 def h_load_module(prefix):
     def f(parser, buf, mac, args, pos):
+        options = []
         pack = parser.get_text_expanded(args[1])
         f = utils.get_module_handler(pack, prefix)
-        parser.init_package(pack, f)
+        parser.init_package(pack, f, options)
         return []
     return f
 

yalafi/packages/amsmath.py

@@ -3,7 +3,7 @@
 #   YaLafi module for LaTeX package amsmath
 #
 
-from yalafi.defs import Macro, ModParm, EquEnv
+from yalafi.defs import Macro, InitModule, EquEnv
 
 require_packages = []
 
@@ -15,7 +15,8 @@
 #   - The spacing macros and \notag are imporant for correct parsing
 #     of maths material.
 #
-def modify_parameters(parms):
+def init_module(parser, options):
+    parms = parser.parms
 
     parms.math_text_macros.append('\\text')
 
@@ -56,6 +57,6 @@ def modify_parameters(parms):
 
     ]
 
-    return ModParm(macros_latex=macros_latex, macros_python=macros_python,
+    return InitModule(macros_latex=macros_latex, macros_python=macros_python,
                         environments=environments)
 

yalafi/packages/amsthm.py

@@ -3,11 +3,12 @@
 #   YaLafi module for LaTeX package amsthm
 #
 
-from yalafi.defs import ModParm, Environ, SpaceToken, TextToken
+from yalafi.defs import InitModule, Environ, SpaceToken, TextToken
 
 require_packages = []
 
-def modify_parameters(parms):
+def init_module(parser, options):
+    parms = parser.parms
 
     macros_latex = r"""
 
@@ -24,7 +25,7 @@ def modify_parameters(parms):
 
     ]
 
-    return ModParm(macros_latex=macros_latex, macros_python=macros_python,
+    return InitModule(macros_latex=macros_latex, macros_python=macros_python,
                         environments=environments)
 
 def h_proof(parser, buf, mac, args, pos):

yalafi/packages/babel.py

@@ -21,8 +21,10 @@
     'english': 'en-GB',
     'english-au': 'en-AU',
     'english-ca': 'en-CA',
+    'british': 'en-GB',
     'english-gb': 'en-GB',
     'english-nz': 'en-NZ',
+    'american': 'en-US',
     'english-us': 'en-US',
 #   'en-ZA',
     'esperanto': 'eo',
@@ -52,11 +54,12 @@
     'chinese': 'zh-CN',
 }
 
-from yalafi.defs import ModParm, Macro, LanguageToken
+from yalafi.defs import InitModule, Macro, LanguageToken
 
 require_packages = []
 
-def modify_parameters(parms):
+def init_module(parser, options):
+    parms = parser.parms
 
     macros_latex = ''
 
@@ -69,7 +72,7 @@ def modify_parameters(parms):
 
     environments = []
 
-    return ModParm(macros_latex=macros_latex, macros_python=macros_python,
+    return InitModule(macros_latex=macros_latex, macros_python=macros_python,
                         environments=environments)
 
 def modify_language_map(babel, lt):

yalafi/packages/biblatex.py

@@ -8,13 +8,14 @@
 #
 
 from yalafi import defs
-from yalafi.defs import Macro, ModParm
+from yalafi.defs import Macro, InitModule
 
 require_packages = []
 
 cite_text = '0'
 
-def modify_parameters(parms):
+def init_module(parser, options):
+    parms = parser.parms
 
     macros_latex = ''
 
@@ -33,7 +34,7 @@ def modify_parameters(parms):
 
     environments = []
 
-    return ModParm(macros_latex=macros_latex, macros_python=macros_python,
+    return InitModule(macros_latex=macros_latex, macros_python=macros_python,
                         environments=environments)
 
 

yalafi/packages/glossaries.py

@@ -46,11 +46,12 @@
 
 import copy
 from yalafi import defs, utils
-from yalafi.defs import Macro, ModParm
+from yalafi.defs import Macro, InitModule
 
 require_packages = []
 
-def modify_parameters(parms):
+def init_module(parser, options):
+    parms = parser.parms
 
     macros_latex = ''
 
@@ -89,7 +90,7 @@ def modify_parameters(parms):
 
     environments = []
 
-    return ModParm(macros_latex=macros_latex, macros_python=macros_python,
+    return InitModule(macros_latex=macros_latex, macros_python=macros_python,
                         environments=environments)
 
 #   return a handler function:

yalafi/packages/glossaries_extra.py

@@ -10,11 +10,12 @@
 #       \usepackage[docdef=atom]{glossaries-extra}
 #
 
-from yalafi.defs import Macro, ModParm
+from yalafi.defs import Macro, InitModule
 
 require_packages = ['glossaries']
 
-def modify_parameters(parms):
+def init_module(parser, options):
+    parms = parser.parms
 
     macros_latex = ''
 
@@ -27,6 +28,6 @@ def modify_parameters(parms):
 
     environments = []
 
-    return ModParm(macros_latex=macros_latex, macros_python=macros_python,
+    return InitModule(macros_latex=macros_latex, macros_python=macros_python,
                         environments=environments)
 

yalafi/packages/graphicx.py

@@ -3,11 +3,12 @@
 #   YaLafi module for LaTeX package graphicx
 #
 
-from yalafi.defs import ModParm
+from yalafi.defs import InitModule
 
 require_packages = []
 
-def modify_parameters(parms):
+def init_module(parser, options):
+    parms = parser.parms
 
     macros_latex = r"""
 
@@ -19,6 +20,6 @@ def modify_parameters(parms):
 
     environments = []
 
-    return ModParm(macros_latex=macros_latex, macros_python=macros_python,
+    return InitModule(macros_latex=macros_latex, macros_python=macros_python,
                         environments=environments)