import re
from types import MappingProxyType
from typing import List, Callable
from .types import Outcome, Node, FormattedLines
from .context import Context
from .constants import (
INDENT_SIZE,
DEFAULT_SURROUNDING_EMPTY_LINES_TABLE as DEFAULT_SURROUNDINGS_TABLE,
)
def format_block(
statements: List[Node],
statement_formatter: Callable,
context: Context,
surrounding_empty_lines_table: MappingProxyType = DEFAULT_SURROUNDINGS_TABLE,
) -> Outcome:
previous_statement_name = None
formatted_lines = [] # type: FormattedLines
previously_processed_line_number = context.previously_processed_line_number
for statement in statements:
blank_lines = reconstruct_blank_lines_in_range(
previously_processed_line_number, statement.line, context,
)
if previous_statement_name is None:
blank_lines = _remove_empty_strings_from_begin(blank_lines)
else:
blank_lines = _add_extra_blanks_due_to_previous_statement(
blank_lines,
previous_statement_name, # type: ignore
surrounding_empty_lines_table,
)
blank_lines = _add_extra_blanks_due_to_next_statement(
blank_lines, statement.data, surrounding_empty_lines_table
)
formatted_lines += blank_lines
lines, previously_processed_line_number = statement_formatter(
statement, context
)
formatted_lines += lines
previous_statement_name = statement.data
dedent_line_number = _find_dedent_line_number(
previously_processed_line_number, context
)
lines_at_the_end = reconstruct_blank_lines_in_range(
previously_processed_line_number, dedent_line_number, context,
)
lines_at_the_end = _remove_empty_strings_from_end(lines_at_the_end)
formatted_lines += lines_at_the_end
previously_processed_line_number = dedent_line_number - 1
return (formatted_lines, previously_processed_line_number)
def reconstruct_blank_lines_in_range(
begin: int, end: int, context: Context
) -> FormattedLines:
comments_in_range = context.standalone_comments[begin + 1 : end]
reconstructed_lines = []
for line_no, comment in zip(range(begin + 1, end), comments_in_range):
if comment is not None:
prefix = (
context.indent_string
if not context.gdscript_code_lines[line_no].startswith("#")
else ""
)
reconstructed_lines.append(prefix + comment)
else:
reconstructed_lines.append("")
reconstructed_lines = _squeeze_lines(reconstructed_lines)
return list(zip([None for _ in range(begin + 1, end)], reconstructed_lines))
# TODO: indent detection & refactoring
def _find_dedent_line_number(
previously_processed_line_number: int, context: Context
) -> int:
if (
previously_processed_line_number == len(context.gdscript_code_lines) - 1
or context.indent == 0
):
return len(context.gdscript_code_lines)
line_no = previously_processed_line_number + 1
for line in context.gdscript_code_lines[previously_processed_line_number + 1 :]:
if (
line.startswith(" ")
and re.search(r"^ {0,%d}[^ ]+" % (context.indent - 1), line) is not None
):
break
if (
line.startswith("\t")
and re.search(
r"^\t{0,%d}[^\t]+" % ((context.indent / INDENT_SIZE) - 1), line
)
is not None
):
break
if (
context.indent > 0
and len(line) > 0
and not line.startswith(" ")
and not line.startswith("\t")
):
break
line_no += 1
for line in context.gdscript_code_lines[line_no - 1 :: -1]:
if line.strip() == "":
line_no -= 1
else:
break
return line_no
def _add_extra_blanks_due_to_previous_statement(
blank_lines: FormattedLines,
previous_statement_name: str,
surrounding_empty_lines_table: MappingProxyType,
) -> FormattedLines:
# assumption: there is no sequence of empty lines longer than 1 (in blank lines)
forced_blanks_num = surrounding_empty_lines_table.get(previous_statement_name)
if forced_blanks_num is None:
return blank_lines
lines_to_prepend = forced_blanks_num
lines_to_prepend -= 1 if len(blank_lines) > 0 and blank_lines[0][1] == "" else 0
empty_line = [(None, "")] # type: FormattedLines
return lines_to_prepend * empty_line + blank_lines
def _add_extra_blanks_due_to_next_statement(
blank_lines: FormattedLines,
next_statement_name: str,
surrounding_empty_lines_table: MappingProxyType,
) -> FormattedLines:
# assumption: there is no sequence of empty lines longer than 2 (in blank lines)
forced_blanks_num = surrounding_empty_lines_table.get(next_statement_name)
if forced_blanks_num is None:
return blank_lines
first_empty_line_ix_from_end = _find_first_empty_line_ix_from_end(blank_lines)
empty_lines_already_in_place = 1 if first_empty_line_ix_from_end > -1 else 0
empty_lines_already_in_place += (
1
if first_empty_line_ix_from_end > 0
and blank_lines[first_empty_line_ix_from_end - 1][1] == ""
else 0
)
lines_to_inject = forced_blanks_num
lines_to_inject -= empty_lines_already_in_place
empty_line = [(None, "")] # type: FormattedLines
if first_empty_line_ix_from_end == -1:
return lines_to_inject * empty_line + blank_lines
return (
blank_lines[:first_empty_line_ix_from_end]
+ lines_to_inject * empty_line
+ blank_lines[first_empty_line_ix_from_end:]
)
def _find_first_empty_line_ix_from_end(blank_lines: FormattedLines) -> int:
for line_no, (_, line) in reversed(list(enumerate(blank_lines))):
if line == "":
return line_no
return -1
def _squeeze_lines(lines: List[str]) -> List[str]:
squeezed_lines = []
previous_line = None
for line in lines:
if line != "" or previous_line != "":
squeezed_lines.append(line)
previous_line = line
return squeezed_lines
def _remove_empty_strings_from_begin(lst: FormattedLines) -> FormattedLines:
for i, (_, line) in enumerate(lst):
if line != "":
return lst[i:]
return []
def _remove_empty_strings_from_end(lst: FormattedLines) -> FormattedLines:
return list(reversed(_remove_empty_strings_from_begin(list(reversed(lst)))))
