pytex/PyTeX/format/tex_formatter.py

149 lines
4.2 KiB
Python
Raw Normal View History

2022-02-06 18:12:30 +01:00
from pathlib import Path
2022-02-07 18:36:30 +01:00
from typing import List, TextIO, Optional, Tuple, Dict
2022-02-08 17:04:16 +01:00
from abc import ABC, abstractmethod
2022-02-07 18:36:30 +01:00
from .formatting_config import FormattingConfig
2022-02-06 18:12:30 +01:00
from .macros import Macro
2022-02-07 18:36:30 +01:00
from .pytex_formatter import PyTeXFormatter
2022-02-06 18:12:30 +01:00
class LineStream:
def __init__(self, filename: Path):
self._file = filename
self._handle = open(filename, 'r')
self._cached_lines: List[str] = []
self._file_exhausted: bool = False
2022-02-06 18:12:30 +01:00
def current_line(self):
return self.future_line(0)
def set_line(self, line):
self.set_future_line(0, line)
def pop_line(self) -> str:
self.reserve_lines(1)
line = self._cached_lines[0]
self._cached_lines = self._cached_lines[1:]
return line
def push_line(self, line):
self.push_lines([line])
def push_lines(self, lines: List[str]):
self._cached_lines = lines + self._cached_lines
def future_line(self, pos: int):
self.reserve_lines(pos + 1)
return self._cached_lines[pos]
def set_future_line(self, line, pos):
self.reserve_lines(pos + 1)
self._cached_lines[pos] = line
def reserve_lines(self, num_lines):
2022-02-09 11:26:01 +01:00
for i in range(0, num_lines - len(self._cached_lines)):
2022-02-06 18:12:30 +01:00
self._cached_lines.append(
self._handle.readline()
)
if self._cached_lines[-1] == '':
self._handle.close()
self._file_exhausted = True
2022-02-06 18:12:30 +01:00
@property
def exhausted(self) -> bool:
2022-02-09 11:26:01 +01:00
a = self._file_exhausted
b = len(self._cached_lines) == 0
return a & b
2022-02-06 15:11:23 +01:00
2022-02-08 17:04:16 +01:00
class TexFormatter(PyTeXFormatter, ABC):
2022-02-06 18:12:30 +01:00
def __init__(self, *args, **kwargs):
super().__init__(*args, **kwargs)
self._macros: List[Macro] = []
2022-02-08 16:09:56 +01:00
self._line_stream: Optional[LineStream] = None
self._output_file: Optional[TextIO] = None
2022-02-06 18:12:30 +01:00
2022-02-08 17:04:16 +01:00
@abstractmethod
def open_output_stream(self, build_dir: Path) -> None:
"""
:param build_dir: Where to open output stream
"""
@abstractmethod
def close_output_stream(self) -> None:
"""
:return:
"""
@property
2022-02-08 19:01:18 +01:00
@abstractmethod
def future_config(self) -> List[Tuple[str, FormattingConfig]]:
2022-02-08 17:04:16 +01:00
"""
# TODO
:return:
"""
@property
def line_stream(self) -> LineStream:
if self._line_stream is None:
self._line_stream = LineStream(self.input_file)
return self._line_stream
@property
def macros(self) -> List[Macro]:
return self._macros
2022-02-06 18:12:30 +01:00
def _handle_macro(self, macro: Macro):
res = macro.apply(
self.line_stream.current_line(),
self
)
if isinstance(res, str):
self.line_stream.set_line(res)
else:
self.line_stream.pop_line()
self.line_stream.push_lines(res)
2022-02-06 18:12:30 +01:00
def _shipout_line(self):
line = self.line_stream.pop_line().rstrip()
2022-02-09 11:26:01 +01:00
self.write_line(line + '\n')
2022-02-06 18:12:30 +01:00
def write_line(self, line: str):
2022-02-08 16:39:20 +01:00
if self._output_file is None:
raise NotImplementedError
self._output_file.write(line)
2022-02-06 18:51:49 +01:00
def format_pre_header(self) -> None:
pass
def format_header(self):
2022-02-08 16:39:20 +01:00
if self._output_file is None:
raise NotImplementedError
2022-02-06 18:51:49 +01:00
self._output_file.write(self.make_header())
def format_post_header(self) -> None:
pass
def format_document(self) -> None:
while not self.line_stream.exhausted:
recent_replacement = True
while recent_replacement:
recent_replacement = False
for macro in self.macros:
if macro.matches(self.line_stream.current_line()):
self._handle_macro(macro)
recent_replacement = True
break
self._shipout_line()
2022-02-06 18:51:49 +01:00
def format(self, build_dir: Path, overwrite: bool = False) -> List[Tuple[str, FormattingConfig]]:
2022-02-08 17:04:16 +01:00
self.open_output_stream(build_dir)
2022-02-06 18:51:49 +01:00
self.format_pre_header()
self.format_header()
self.format_post_header()
self.format_document()
2022-02-08 16:39:20 +01:00
self.close_output_stream()
return self.future_config