From 23766e8dcdd3fa915aa8a96623a09cd37e5ea321 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Maximilian=20Ke=C3=9Fler?= Date: Tue, 11 Jan 2022 18:39:56 +0100 Subject: [PATCH] start adding support for formatting latex3 files --- base/enums.py | 1 + default_formatters/class_formatter.py | 10 ++- default_formatters/package_formatter.py | 11 ++- formatter/tex_formatter.py | 17 +++-- macros/default_macros.py | 97 ++++++++++++++----------- 5 files changed, 85 insertions(+), 51 deletions(-) diff --git a/base/enums.py b/base/enums.py index eeea582..a0399fa 100644 --- a/base/enums.py +++ b/base/enums.py @@ -11,6 +11,7 @@ class Attributes(Enum): date = 'date' year = 'year' source_file_name = 'source_file_name' + version = 'package_version' class Args(Enum): diff --git a/default_formatters/class_formatter.py b/default_formatters/class_formatter.py index c93a8a4..217c882 100644 --- a/default_formatters/class_formatter.py +++ b/default_formatters/class_formatter.py @@ -4,8 +4,14 @@ import PyTeX.macros class ClassFormatter(PyTeX.formatter.TexFormatter): - def __init__(self, class_name: str, author: str, extra_header: [str] = []): - PyTeX.formatter.TexFormatter.__init__(self, class_name, author, extra_header, '.cls') + def __init__(self, class_name: str, author: str, extra_header: [str] = [], tex_version: str = 'LaTeX2e'): + PyTeX.formatter.TexFormatter.__init__( + self, + name=class_name, + author=author, + header=extra_header, + file_extension='.cls', + tex_version=tex_version) def make_default_macros(self): PyTeX.macros.make_default_macros(self, 'class') diff --git a/default_formatters/package_formatter.py b/default_formatters/package_formatter.py index 774e4ab..5e8e94d 100644 --- a/default_formatters/package_formatter.py +++ b/default_formatters/package_formatter.py @@ -4,8 +4,15 @@ import PyTeX.macros class PackageFormatter(PyTeX.formatter.TexFormatter): - def __init__(self, package_name: str, author: str, extra_header: [str] = []): - PyTeX.formatter.TexFormatter.__init__(self, package_name, author, extra_header, '.sty') + def __init__(self, package_name: str, author: str, extra_header: [str] = [], tex_version: str = 'LaTeX2e'): + PyTeX.formatter.TexFormatter.__init__( + self, + name=package_name, + author=author, + header=extra_header, + file_extension='.sty', + tex_version=tex_version + ) def make_default_macros(self): PyTeX.macros.make_default_macros(self, 'package') diff --git a/formatter/tex_formatter.py b/formatter/tex_formatter.py index 60ca700..9b17d99 100644 --- a/formatter/tex_formatter.py +++ b/formatter/tex_formatter.py @@ -8,21 +8,28 @@ from PyTeX.base import Attributes, Args class TexFormatter: - def __init__(self, name: str, author: str, header: Optional[List[str]], file_extension: str): + def __init__(self, name: str, author: str, header: Optional[List[str]], file_extension: str, + tex_version: str, version: str): + self.version = version self.header = header self.name_raw = name self.author = author author_parts = self.author.lower().replace('ß', 'ss').split(' ') self.author_acronym = author_parts[0][0] + author_parts[-1] - self.name_lowercase = r'{prefix}-{name}'.format(prefix=self.author_acronym, - name=self.name_raw.lower().strip().replace(' ', '-')) - self.prefix = self.name_lowercase.replace('-', '@') + '@' - self.file_name = self.name_lowercase + file_extension self.date = datetime.now().strftime('%Y/%m/%d') self.year = int(datetime.now().strftime('%Y')) self.replace_dict: Dict = {} self.arg_replace_dict: Dict = {} self.source_file_name = "not specified" + self.name_lowercase = r'{prefix}-{name}'.format(prefix=self.author_acronym, + name=self.name_raw.lower().strip().replace(' ', '-')) + self.file_name = self.name_lowercase + file_extension + if tex_version == 'LaTeX2e': + self.prefix = self.name_lowercase.replace('-', '@') + '@' + elif tex_version == 'LaTeX3': + self.prefix = '__' + self.name_lowercase.replace('-', '_') + '_' + else: + raise Exception('Unknown TeX version') @staticmethod def __command_name2keyword(keyword: str): diff --git a/macros/default_macros.py b/macros/default_macros.py index 2653383..72bd2bc 100644 --- a/macros/default_macros.py +++ b/macros/default_macros.py @@ -3,44 +3,11 @@ import PyTeX.base import PyTeX.config -def make_default_macros(formatter: PyTeX.formatter.TexFormatter, latex_file_type: str): - header = '\\NeedsTeXFormat{{LaTeX2e}}\n' \ - '\\Provides{Type}{{{name_lowercase}}}[{date} - {description}]\n\n' - formatter.add_arg_replacement( - 1, 'header', - header, - name_lowercase=PyTeX.base.Attributes.name_lowercase, - date=PyTeX.base.Attributes.date, - description=PyTeX.base.Args.one, - Type=latex_file_type.capitalize(), - ) +def make_default_macros(formatter: PyTeX.formatter.TexFormatter, latex_file_type: str, tex_version: str = 'LaTeX2e'): formatter.add_replacement('{Type} name'.format(Type=latex_file_type), '{}', PyTeX.base.Attributes.name_lowercase) formatter.add_replacement('{Type} prefix'.format(Type=latex_file_type), '{}', PyTeX.base.Attributes.prefix) - formatter.add_arg_replacement(1, '{Type} macro'.format(Type=latex_file_type), r'\{}{}', - PyTeX.base.Attributes.prefix, PyTeX.base.Args.one) - formatter.add_replacement('file name', '{name}', name=PyTeX.base.Attributes.file_name) formatter.add_replacement('date', '{}', PyTeX.base.Attributes.date) formatter.add_replacement('author', '{}', PyTeX.base.Attributes.author) - formatter.add_arg_replacement(2, 'new if', r'\newif\if{prefix}{condition}\{prefix}{condition}{value}', - prefix=PyTeX.base.Attributes.prefix, condition=PyTeX.base.Args.one, - value=PyTeX.base.Args.two) - formatter.add_arg_replacement(2, 'set if', r'\{prefix}{condition}{value}', - prefix=PyTeX.base.Attributes.prefix, condition=PyTeX.base.Args.one, - value=PyTeX.base.Args.two) - formatter.add_arg_replacement(1, 'if', r'\if{prefix}{condition}', prefix=PyTeX.base.Attributes.prefix, - condition=PyTeX.base.Args.one) - formatter.add_replacement('language options x', - r'\newif\if{prefix}english\{prefix}englishtrue' + '\n' + - r'\DeclareOptionX{{german}}{{\{prefix}englishfalse}}' + '\n' + - r'\DeclareOptionX{{ngerman}}{{\{prefix}englishfalse}}' + '\n' + - r'\DeclareOptionX{{english}}{{\{prefix}englishtrue}}', - prefix=PyTeX.base.Attributes.prefix) - formatter.add_replacement('language options', - r'\newif\if{prefix}english\{prefix}englishtrue' + '\n' + - r'\DeclareOption{{german}}{{\{prefix}englishfalse}}' + '\n' + - r'\DeclareOption{{ngerman}}{{\{prefix}englishfalse}}' + '\n' + - r'\DeclareOption{{english}}{{\{prefix}englishtrue}}', - prefix=PyTeX.base.Attributes.prefix) formatter.add_arg_replacement(1, 'info', r'\{Type}Info{{{name}}}{{{info}}}', name=PyTeX.base.Attributes.name_lowercase, info=PyTeX.base.Args.one, Type=latex_file_type.capitalize()) @@ -50,11 +17,57 @@ def make_default_macros(formatter: PyTeX.formatter.TexFormatter, latex_file_type formatter.add_arg_replacement(1, 'error', r'\{Type}Error{{{name}}}{{{error}}}', name=PyTeX.base.Attributes.name_lowercase, error=PyTeX.base.Args.one, Type=latex_file_type.capitalize()) - formatter.add_replacement('end options x', - r"\DeclareOptionX*{{\{Type}Warning{{{name_lowercase}}}" - r"{{Unknown '\CurrentOption'}}}}" + '\n' + r'\ProcessOptionsX*\relax' + '\n', - name_lowercase=PyTeX.base.Attributes.name_lowercase, Type=latex_file_type.capitalize()) - formatter.add_replacement('end options', - r"\DeclareOption*{{\{Type}Warning{{{name_lowercase}}}" - r"{{Unknown '\CurrentOption'}}}}" + '\n' + r'\ProcessOptions\relax' + '\n', - name_lowercase=PyTeX.base.Attributes.name_lowercase, Type=latex_file_type.capitalize()) + formatter.add_replacement('file name', '{name}', name=PyTeX.base.Attributes.file_name) + formatter.add_arg_replacement(1, '{Type} macro'.format(Type=latex_file_type), r'\{}{}', + PyTeX.base.Attributes.prefix, PyTeX.base.Args.one) + + if tex_version == 'LaTeX3': + header = r'\ProvidesExpl{Type}{{{name_lowercase}}}{{{date}}}{{{version}}}{{{description}}}' + '\n\n' + formatter.add_arg_replacement( + 1, 'header', + header, + name_lowercase=PyTeX.base.Attributes.name_lowercase, + date=PyTeX.base.Attributes.date, + description=PyTeX.base.Args.one, + Type=latex_file_type.capitalize(), + version=PyTeX.base.Attributes.version + ) + elif tex_version == 'LaTeX2e': + header = '\\NeedsTeXFormat{{LaTeX2e}}\n' \ + '\\Provides{Type}{{{name_lowercase}}}[{date} - {description}]\n\n' + formatter.add_arg_replacement( + 1, 'header', + header, + name_lowercase=PyTeX.base.Attributes.name_lowercase, + date=PyTeX.base.Attributes.date, + description=PyTeX.base.Args.one, + Type=latex_file_type.capitalize(), + ) + formatter.add_arg_replacement(2, 'new if', r'\newif\if{prefix}{condition}\{prefix}{condition}{value}', + prefix=PyTeX.base.Attributes.prefix, condition=PyTeX.base.Args.one, + value=PyTeX.base.Args.two) + formatter.add_arg_replacement(2, 'set if', r'\{prefix}{condition}{value}', + prefix=PyTeX.base.Attributes.prefix, condition=PyTeX.base.Args.one, + value=PyTeX.base.Args.two) + formatter.add_arg_replacement(1, 'if', r'\if{prefix}{condition}', prefix=PyTeX.base.Attributes.prefix, + condition=PyTeX.base.Args.one) + formatter.add_replacement('language options x', + r'\newif\if{prefix}english\{prefix}englishtrue' + '\n' + + r'\DeclareOptionX{{german}}{{\{prefix}englishfalse}}' + '\n' + + r'\DeclareOptionX{{ngerman}}{{\{prefix}englishfalse}}' + '\n' + + r'\DeclareOptionX{{english}}{{\{prefix}englishtrue}}', + prefix=PyTeX.base.Attributes.prefix) + formatter.add_replacement('language options', + r'\newif\if{prefix}english\{prefix}englishtrue' + '\n' + + r'\DeclareOption{{german}}{{\{prefix}englishfalse}}' + '\n' + + r'\DeclareOption{{ngerman}}{{\{prefix}englishfalse}}' + '\n' + + r'\DeclareOption{{english}}{{\{prefix}englishtrue}}', + prefix=PyTeX.base.Attributes.prefix) + formatter.add_replacement('end options x', + r"\DeclareOptionX*{{\{Type}Warning{{{name_lowercase}}}" + r"{{Unknown '\CurrentOption'}}}}" + '\n' + r'\ProcessOptionsX*\relax' + '\n', + name_lowercase=PyTeX.base.Attributes.name_lowercase, Type=latex_file_type.capitalize()) + formatter.add_replacement('end options', + r"\DeclareOption*{{\{Type}Warning{{{name_lowercase}}}" + r"{{Unknown '\CurrentOption'}}}}" + '\n' + r'\ProcessOptions\relax' + '\n', + name_lowercase=PyTeX.base.Attributes.name_lowercase, Type=latex_file_type.capitalize())