|
| 1 | +from enum import Enum |
| 2 | +from typing import Iterator, Match, Callable |
| 3 | + |
| 4 | +import re |
| 5 | + |
| 6 | + |
| 7 | +class TextPosInfo: |
| 8 | + line: int |
| 9 | + start: int |
| 10 | + end: int |
| 11 | + |
| 12 | + def __init__(self, line, start, end): |
| 13 | + self.line = line |
| 14 | + self.start = start |
| 15 | + self.end = end |
| 16 | + |
| 17 | + |
| 18 | +shortcode_re_pattern_start = r"(\n)|\{\{[<%]\s*" |
| 19 | +shortcode_re_body = r"(/)?([\w\-]+)\s*(.+?)?" |
| 20 | +shortcode_re_pattern_end = r"\s*[>%]\}\}" |
| 21 | + |
| 22 | +shortcode_re_pattern = ( |
| 23 | + shortcode_re_pattern_start + |
| 24 | + shortcode_re_body + |
| 25 | + shortcode_re_pattern_end |
| 26 | +) |
| 27 | + |
| 28 | + |
| 29 | +class ShortcodeTagType(Enum): |
| 30 | + """Specifies open or close shortcode tag.""" |
| 31 | + OPEN = 1 |
| 32 | + CLOSE = 2 |
| 33 | + |
| 34 | + |
| 35 | +class ShortcodeInfo: |
| 36 | + """Represents the information in a shortcode. |
| 37 | + """ |
| 38 | + tag_type: ShortcodeTagType |
| 39 | + tag: str |
| 40 | + pos_params: list[str] |
| 41 | + named_params: dict[str, str] |
| 42 | + |
| 43 | + def parse_params(self, param_str: str): |
| 44 | + param_re = "|".join([ |
| 45 | + r'"(([^"]|(?<=\\)")*)"', |
| 46 | + r'((\w+)=([^"\s]+))', |
| 47 | + r'((\w+)="(([^"]|(?<=\\)")*)")', |
| 48 | + r'([^"=\s]+)' |
| 49 | + ]) |
| 50 | + |
| 51 | + for match in re.finditer(param_re, param_str): |
| 52 | + if match is None: |
| 53 | + self.pos_params = [] |
| 54 | + self.named_params = {} |
| 55 | + return |
| 56 | + |
| 57 | + if match[1]: |
| 58 | + self.pos_params.append(re.sub(r'\\"', '"', match[1])) |
| 59 | + elif match[3]: |
| 60 | + self.named_params[match[4]] = match[5] |
| 61 | + elif match[6]: |
| 62 | + self.named_params[match[7]] = re.sub(r'\\"', '"', match[8]) |
| 63 | + elif match[10]: |
| 64 | + self.pos_params.append(match[10]) |
| 65 | + |
| 66 | + def __init__( |
| 67 | + self, tag: str, |
| 68 | + tag_type: ShortcodeTagType, |
| 69 | + param_text: str = "" |
| 70 | + ): |
| 71 | + self.tag = tag |
| 72 | + self.tag_type = tag_type |
| 73 | + self.pos_params = [] |
| 74 | + self.named_params = {} |
| 75 | + self.parse_params(param_text or "") |
| 76 | + |
| 77 | + def __str__(self) -> str: |
| 78 | + type_text: str |
| 79 | + |
| 80 | + if self.tag_type == ShortcodeTagType.OPEN: |
| 81 | + type_text = "OPEN" |
| 82 | + else: |
| 83 | + type_text = "CLOSE" |
| 84 | + |
| 85 | + result = f"{type_text} {self.tag}" |
| 86 | + |
| 87 | + if self.pos_params or self.named_params: |
| 88 | + result += ":" |
| 89 | + |
| 90 | + for pos_param in self.pos_params: |
| 91 | + result += f"\n '{pos_param}'" |
| 92 | + |
| 93 | + for named_param, named_value in self.named_params.items(): |
| 94 | + result += f"\n {named_param} = {named_value}" |
| 95 | + |
| 96 | + return result |
| 97 | + |
| 98 | + |
| 99 | +class ShortcodeIterator: |
| 100 | + """Iterates through all shortcodes in a string. |
| 101 | + """ |
| 102 | + re_iterator: Iterator[Match[str]] |
| 103 | + linenum: int |
| 104 | + sc_filter: Callable[[ShortcodeInfo], bool] |
| 105 | + |
| 106 | + def __init__( |
| 107 | + self, |
| 108 | + text: str, |
| 109 | + sc_filter: Callable[[ShortcodeInfo], bool] = lambda x: True |
| 110 | + ): |
| 111 | + self.re_iterator = re.finditer(shortcode_re_pattern, text) |
| 112 | + self.sc_filter = lambda self, x: sc_filter(x) |
| 113 | + self.linenum = 1 |
| 114 | + |
| 115 | + def __iter__(self): |
| 116 | + return self |
| 117 | + |
| 118 | + def __next__(self) -> tuple[ShortcodeInfo, TextPosInfo]: |
| 119 | + next_match = self.re_iterator.__next__() |
| 120 | + |
| 121 | + while True: |
| 122 | + if next_match[1]: |
| 123 | + self.linenum += 1 |
| 124 | + elif next_match[2]: |
| 125 | + result = ShortcodeInfo( |
| 126 | + next_match[3], ShortcodeTagType.CLOSE |
| 127 | + ) |
| 128 | + |
| 129 | + if self.sc_filter(self, result): |
| 130 | + return ( |
| 131 | + result, |
| 132 | + TextPosInfo( |
| 133 | + self.linenum, |
| 134 | + next_match.start(), |
| 135 | + next_match.end() |
| 136 | + ) |
| 137 | + ) |
| 138 | + else: |
| 139 | + result = ShortcodeInfo( |
| 140 | + next_match[3], |
| 141 | + ShortcodeTagType.OPEN, |
| 142 | + next_match[4] |
| 143 | + ) |
| 144 | + |
| 145 | + if self.sc_filter(self, result): |
| 146 | + return ( |
| 147 | + result, |
| 148 | + TextPosInfo( |
| 149 | + self.linenum, |
| 150 | + next_match.start(), |
| 151 | + next_match.end() |
| 152 | + ) |
| 153 | + ) |
| 154 | + |
| 155 | + next_match = self.re_iterator.__next__() |
0 commit comments