|
|
|
|
@ -6,9 +6,22 @@ displayed, along with associated meta-data such as its type or a link's URL.
|
|
|
|
|
|
|
|
|
|
Note that metalines can be generated by custom functions without relying on the
|
|
|
|
|
elements classes as they are quite coupled to Gemtext parsing/rendering.
|
|
|
|
|
|
|
|
|
|
The metalines are tuples (ltype, line, lextra):
|
|
|
|
|
- ltype is the LineType.
|
|
|
|
|
- line is the text content itself.
|
|
|
|
|
- lextra is either a dict of additional data, or None.
|
|
|
|
|
|
|
|
|
|
The lextra part is currently only used for links, and can contain the following
|
|
|
|
|
keys:
|
|
|
|
|
- url: the URL the link on this line refers to. Note that this key is present
|
|
|
|
|
only for the first line of the link, i.e. long link descriptions wrapped on
|
|
|
|
|
multiple lines will not have a this key except for the first line.
|
|
|
|
|
- link_id: only alongside "url" key, ID generated for this link.
|
|
|
|
|
"""
|
|
|
|
|
|
|
|
|
|
import string
|
|
|
|
|
from dataclasses import dataclass
|
|
|
|
|
from enum import IntEnum
|
|
|
|
|
from typing import List
|
|
|
|
|
|
|
|
|
|
@ -18,7 +31,6 @@ from bebop.gemtext import (
|
|
|
|
|
|
|
|
|
|
SPLIT_CHARS = " \t-"
|
|
|
|
|
JOIN_CHAR = "-"
|
|
|
|
|
LIST_ITEM_MARK = "• "
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
class LineType(IntEnum):
|
|
|
|
|
@ -39,27 +51,26 @@ class LineType(IntEnum):
|
|
|
|
|
ERROR = 9 # Not part of Gemtext but useful internally.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
def generate_metalines(elements, width, dumb=False):
|
|
|
|
|
"""Format elements into a list of lines with metadata.
|
|
|
|
|
RENDER_MODES = ("fancy", "dumb")
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
The returned list ("metalines") are tuples (meta, line), meta being a
|
|
|
|
|
dict of metadata and a text line to display. Currently the only metadata
|
|
|
|
|
keys used are:
|
|
|
|
|
- type: one of the Renderer.TYPE constants.
|
|
|
|
|
- url: only for links, the URL the link on this line refers to. Note
|
|
|
|
|
that this key is present only for the first line of the link, i.e.
|
|
|
|
|
long link descriptions wrapped on multiple lines will not have a this
|
|
|
|
|
key except for the first line.
|
|
|
|
|
- link_id: only alongside "url" key, ID generated for this link.
|
|
|
|
|
@dataclass
|
|
|
|
|
class RenderOptions:
|
|
|
|
|
"""Rendering options."""
|
|
|
|
|
width: int
|
|
|
|
|
mode: str
|
|
|
|
|
bullet: str
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
def generate_metalines(elements: list, options: RenderOptions) -> list:
|
|
|
|
|
"""Format elements into a list of lines with metadata.
|
|
|
|
|
|
|
|
|
|
Arguments:
|
|
|
|
|
- elements: list of elements to use.
|
|
|
|
|
- width: max text width to use.
|
|
|
|
|
- dumb: if True, standard presentation margins are ignored.
|
|
|
|
|
- options: RenderOptions to respect when generating metalines.
|
|
|
|
|
"""
|
|
|
|
|
metalines = []
|
|
|
|
|
context = {"width": width}
|
|
|
|
|
separator = ({"type": LineType.NONE}, "")
|
|
|
|
|
separator = (LineType.NONE, "", None)
|
|
|
|
|
has_margins = False
|
|
|
|
|
thin_type = None
|
|
|
|
|
for index, element in enumerate(elements):
|
|
|
|
|
@ -68,30 +79,30 @@ def generate_metalines(elements, width, dumb=False):
|
|
|
|
|
has_margins = False
|
|
|
|
|
thin_type = None
|
|
|
|
|
if isinstance(element, Title):
|
|
|
|
|
element_metalines = format_title(element, context)
|
|
|
|
|
element_metalines = format_title(element, options)
|
|
|
|
|
has_margins = True
|
|
|
|
|
elif isinstance(element, Paragraph):
|
|
|
|
|
element_metalines = format_paragraph(element, context)
|
|
|
|
|
element_metalines = format_paragraph(element, options)
|
|
|
|
|
has_margins = True
|
|
|
|
|
elif isinstance(element, Link):
|
|
|
|
|
element_metalines = format_link(element, context)
|
|
|
|
|
element_metalines = format_link(element, options)
|
|
|
|
|
thin_type = LineType.LINK
|
|
|
|
|
elif isinstance(element, Preformatted):
|
|
|
|
|
element_metalines = format_preformatted(element, context)
|
|
|
|
|
element_metalines = format_preformatted(element, options)
|
|
|
|
|
has_margins = True
|
|
|
|
|
elif isinstance(element, Blockquote):
|
|
|
|
|
element_metalines = format_blockquote(element, context)
|
|
|
|
|
element_metalines = format_blockquote(element, options)
|
|
|
|
|
has_margins = True
|
|
|
|
|
elif isinstance(element, ListItem):
|
|
|
|
|
element_metalines = format_list_item(element, context)
|
|
|
|
|
element_metalines = format_list_item(element, options)
|
|
|
|
|
thin_type = LineType.LIST_ITEM
|
|
|
|
|
else:
|
|
|
|
|
continue
|
|
|
|
|
# In dumb mode, elements producing no metalines still need to be
|
|
|
|
|
# rendered as empty lines.
|
|
|
|
|
if dumb:
|
|
|
|
|
if options.mode == "dumb":
|
|
|
|
|
if not element_metalines:
|
|
|
|
|
element_metalines = [({"type": LineType.PARAGRAPH}, "")]
|
|
|
|
|
element_metalines = [(LineType.PARAGRAPH, "", None)]
|
|
|
|
|
# If current element requires margins and is not the first elements,
|
|
|
|
|
# separate from previous element. Also do it if the current element does
|
|
|
|
|
# not require margins but follows an element that required it (e.g. link
|
|
|
|
|
@ -110,12 +121,12 @@ def generate_metalines(elements, width, dumb=False):
|
|
|
|
|
|
|
|
|
|
def generate_dumb_metalines(lines):
|
|
|
|
|
"""Generate dumb metalines: all lines are given the PARAGRAPH line type."""
|
|
|
|
|
return [({"type": LineType.PARAGRAPH}, line) for line in lines]
|
|
|
|
|
return [(LineType.PARAGRAPH, line, None) for line in lines]
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
def format_title(title: Title, context: dict):
|
|
|
|
|
def format_title(title: Title, options: RenderOptions):
|
|
|
|
|
"""Return metalines for this title."""
|
|
|
|
|
width = context["width"]
|
|
|
|
|
width = options.width
|
|
|
|
|
if title.level == 1:
|
|
|
|
|
wrapped = wrap_words(title.text, width)
|
|
|
|
|
line_template = f"{{:^{width}}}"
|
|
|
|
|
@ -126,55 +137,51 @@ def format_title(title: Title, context: dict):
|
|
|
|
|
else:
|
|
|
|
|
lines = wrap_words(title.text, width)
|
|
|
|
|
# Title levels match the type constants of titles.
|
|
|
|
|
return [({"type": LineType(title.level)}, line) for line in lines]
|
|
|
|
|
return [(LineType(title.level), line, None) for line in lines]
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
def format_paragraph(paragraph: Paragraph, context: dict):
|
|
|
|
|
def format_paragraph(paragraph: Paragraph, options: RenderOptions):
|
|
|
|
|
"""Return metalines for this paragraph."""
|
|
|
|
|
lines = wrap_words(paragraph.text, context["width"])
|
|
|
|
|
return [({"type": LineType.PARAGRAPH}, line) for line in lines]
|
|
|
|
|
lines = wrap_words(paragraph.text, options.width)
|
|
|
|
|
return [(LineType.PARAGRAPH, line, None) for line in lines]
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
def format_link(link: Link, context: dict):
|
|
|
|
|
def format_link(link: Link, options: RenderOptions):
|
|
|
|
|
"""Return metalines for this link."""
|
|
|
|
|
# Get a new link and build the "[id]" anchor.
|
|
|
|
|
link_anchor = f"[{link.ident}] "
|
|
|
|
|
link_text = link.text or link.url
|
|
|
|
|
# Wrap lines, indented by the link anchor length.
|
|
|
|
|
lines = wrap_words(link_text, context["width"], indent=len(link_anchor))
|
|
|
|
|
first_line_meta = {
|
|
|
|
|
"type": LineType.LINK,
|
|
|
|
|
lines = wrap_words(link_text, options.width, indent=len(link_anchor))
|
|
|
|
|
first_line_extra = {
|
|
|
|
|
"url": link.url,
|
|
|
|
|
"link_id": link.ident
|
|
|
|
|
}
|
|
|
|
|
# Replace first line indentation with the anchor.
|
|
|
|
|
first_line_text = link_anchor + lines[0][len(link_anchor):]
|
|
|
|
|
first_line = [(first_line_meta, first_line_text)]
|
|
|
|
|
other_lines = [({"type": LineType.LINK}, line) for line in lines[1:]]
|
|
|
|
|
return first_line + other_lines
|
|
|
|
|
first_line = [(LineType.LINK, first_line_text, first_line_extra)]
|
|
|
|
|
other_lines = [(LineType.LINK, line, None) for line in lines[1:]]
|
|
|
|
|
return first_line + other_lines # type: ignore
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
def format_preformatted(preformatted: Preformatted, context: dict):
|
|
|
|
|
def format_preformatted(preformatted: Preformatted, options: RenderOptions):
|
|
|
|
|
"""Return metalines for this preformatted block."""
|
|
|
|
|
return [
|
|
|
|
|
({"type": LineType.PREFORMATTED}, line)
|
|
|
|
|
for line in preformatted.lines
|
|
|
|
|
]
|
|
|
|
|
return [(LineType.PREFORMATTED, line, None) for line in preformatted.lines]
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
def format_blockquote(blockquote: Blockquote, context: dict):
|
|
|
|
|
def format_blockquote(blockquote: Blockquote, options: RenderOptions):
|
|
|
|
|
"""Return metalines for this blockquote."""
|
|
|
|
|
lines = wrap_words(blockquote.text, context["width"], indent=2)
|
|
|
|
|
return [({"type": LineType.BLOCKQUOTE}, line) for line in lines]
|
|
|
|
|
lines = wrap_words(blockquote.text, options.width, indent=2)
|
|
|
|
|
return [(LineType.BLOCKQUOTE, line, None) for line in lines]
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
def format_list_item(item: ListItem, context: dict):
|
|
|
|
|
def format_list_item(item: ListItem, options: RenderOptions):
|
|
|
|
|
"""Return metalines for this list item."""
|
|
|
|
|
indent = len(LIST_ITEM_MARK)
|
|
|
|
|
lines = wrap_words(item.text, context["width"], indent=indent)
|
|
|
|
|
first_line = LIST_ITEM_MARK + lines[0][indent:]
|
|
|
|
|
indent = len(options.bullet)
|
|
|
|
|
lines = wrap_words(item.text, options.width, indent=indent)
|
|
|
|
|
first_line = options.bullet + lines[0][indent:]
|
|
|
|
|
lines[0] = first_line
|
|
|
|
|
return [({"type": LineType.LIST_ITEM}, line) for line in lines]
|
|
|
|
|
return [(LineType.LIST_ITEM, line, None) for line in lines]
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
def wrap_words(text: str, width: int, indent: int =0) -> List[str]:
|
|
|
|
|
|
dece