Repository navigation
Expand file tree
/
Copy pathRemoveTextWithTags.py
More file actions
443 lines (325 loc) · 12.9 KB
/
Copy pathRemoveTextWithTags.py
File metadata and controls
443 lines (325 loc) · 12.9 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
from Npp import editor
import re
# Wim Gielis
# Sep. 2026
#
# RemoveTextWithTags script (Ctrl-...):
# - Delete the complete element containing the caret, or whose opening/closing tag is selected.
# - HTML and XML supported
# - The line is also deleted if only whitespace remains after the initial delete operation.
#
# Examples:
#
# <div>Some text</div>
# ^ caret in either tag -> deletes the whole div
#
# <div>
# <span>Hello</span>
# </div>
# ^ caret in span tag -> deletes only the span
#
# Handles:
# - Nested tags
# - Attributes containing > characters
# - HTML and XML
# - Comments
# - CDATA
# - Processing instructions
# - Self-closing tags
#
# HTML tag names are matched case-insensitively.
# XML tag names are effectively matched case-insensitively too.
# If strict XML case sensitivity is required, see the note below.
# ----------------------------------------------------------------------
# Configuration
# ----------------------------------------------------------------------
# HTML void elements have no closing tag.
# If the caret is inside one of these, the tag itself is deleted.
HTML_VOID_TAGS = set(["area", "base", "br", "col", "embed", "hr", "img", "input", "link", "meta", "param", "source", "track", "wbr"])
# ----------------------------------------------------------------------
# Find all tags in the document
# ----------------------------------------------------------------------
def find_tags(text):
"""
Return a list of tag records.
Each record is:
{
"start": start position,
"end": end position (exclusive),
"name": tag name,
"type": "open", "close", "self"
}
Comments, CDATA, declarations and processing instructions are skipped.
"""
tags = []
length = len(text)
i = 0
while i < length:
# --------------------------------------------------------------
# HTML/XML comment
# --------------------------------------------------------------
if text.startswith("<!--", i):
end = text.find("-->", i + 4)
if end == -1:
break
i = end + 3
continue
# --------------------------------------------------------------
# CDATA
# --------------------------------------------------------------
if text.startswith("<![CDATA[", i):
end = text.find("]]>", i + 9)
if end == -1:
break
i = end + 3
continue
# --------------------------------------------------------------
# Processing instruction
# <?xml ... ?>
# --------------------------------------------------------------
if text.startswith("<?", i):
end = text.find("?>", i + 2)
if end == -1:
break
i = end + 2
continue
# --------------------------------------------------------------
# DOCTYPE / declarations
# <!DOCTYPE ...>
# --------------------------------------------------------------
if text.startswith("<!", i):
end = find_tag_end(text, i)
if end == -1:
break
i = end + 1
continue
# --------------------------------------------------------------
# Normal tag
# --------------------------------------------------------------
if text[i] == "<":
# Closing tag
if i + 1 < length and text[i + 1] == "/":
match = re.match(r'<\s*/\s*([A-Za-z_][\w:.-]*)', text[i:])
if match:
name = match.group(1)
end = find_tag_end(text, i)
if end != -1:
tags.append({
"start": i,
"end": end + 1,
"name": name.lower(),
"type": "close"
})
i = end + 1
continue
# Opening tag
else:
match = re.match(r'<\s*([A-Za-z_][\w:.-]*)', text[i:])
if match:
name = match.group(1)
end = find_tag_end(text, i)
if end != -1:
tag_text = text[i:end + 1]
# Determine whether it is explicitly self-closing.
# Ignore whitespace before >.
self_closing = bool(re.search(r'/\s*>$', tag_text))
# HTML void elements are also effectively
# self-closing.
if name.lower() in HTML_VOID_TAGS:
self_closing = True
tags.append({
"start": i,
"end": end + 1,
"name": name.lower(),
"type": "self" if self_closing else "open"
})
i = end + 1
continue
i += 1
return tags
# ----------------------------------------------------------------------
# Find the end of a tag while respecting quoted attributes
# ----------------------------------------------------------------------
def find_tag_end(text, start):
"""
Find the '>' ending a tag.
A '>' inside a quoted attribute does not terminate the tag.
Example:
<div title="a > b">
The correct ending is the second '>'.
"""
quote = None
i = start + 1
length = len(text)
while i < length:
ch = text[i]
if quote:
if ch == quote:
quote = None
else:
if ch == '"' or ch == "'":
quote = ch
elif ch == ">":
return i
i += 1
return -1
# ----------------------------------------------------------------------
# Match opening and closing tags
# ----------------------------------------------------------------------
def build_pairs(tags):
"""
Match opening and closing tags using a stack.
Returns:
open_to_close
close_to_open
where the values are tag indexes.
"""
open_to_close = {}
close_to_open = {}
stack = []
for index, tag in enumerate(tags):
if tag["type"] == "open":
stack.append(index)
elif tag["type"] == "self":
# No matching closing tag.
pass
elif tag["type"] == "close":
# Search backwards for the most recent matching opening tag.
match_index = -1
for j in range(len(stack) - 1, -1, -1):
candidate = stack[j]
if tags[candidate]["name"] == tag["name"]:
match_index = candidate
break
if match_index != -1:
# Remove the matched opening tag and anything above it.
#
# Normally everything above it should already have
# matched. This also makes the routine reasonably
# tolerant of malformed HTML.
stack = stack[:match_index]
open_to_close[match_index] = index
close_to_open[index] = match_index
return open_to_close, close_to_open
# ----------------------------------------------------------------------
# Determine which tag the caret/selection is inside
# ----------------------------------------------------------------------
def find_selected_or_current_tag(tags, selection_start, selection_end):
"""
Find the tag containing the caret or selection.
A tag is considered selected if:
selection_start >= tag.start
selection_end <= tag.end
We also accept overlap, which makes the script more forgiving.
"""
# First preference: a tag completely containing the selection.
candidates = []
for index, tag in enumerate(tags):
if selection_start >= tag["start"] and \
selection_end <= tag["end"]:
candidates.append(index)
if candidates:
# Normally only one tag can contain another because tags
# themselves cannot be nested.
return candidates[-1]
# If the selection/caret overlaps the tag, use that too.
for index, tag in enumerate(tags):
if selection_start < tag["end"] and \
selection_end > tag["start"]:
return index
return None
# ----------------------------------------------------------------------
# Main operation
# ----------------------------------------------------------------------
def delete_current_element():
text = editor.getText()
if not text:
return
selection_start = editor.getSelectionStart()
selection_end = editor.getSelectionEnd()
tags = find_tags(text)
if not tags:
notepad.messageBox("No HTML/XML tag was found at the cursor.", "Delete Element")
return
# --------------------------------------------------------------
# Identify the tag under the cursor/selection
# --------------------------------------------------------------
tag_index = find_selected_or_current_tag(
tags,
selection_start,
selection_end
)
if tag_index is None:
notepad.messageBox("The cursor or selection is not inside an HTML/XML tag.", "Delete Element")
return
open_to_close, close_to_open = build_pairs(tags)
tag = tags[tag_index]
# --------------------------------------------------------------
# Opening tag
# --------------------------------------------------------------
if tag["type"] == "open":
if tag_index in open_to_close:
close_index = open_to_close[tag_index]
start = tags[tag_index]["start"]
end = tags[close_index]["end"]
else:
# Unmatched opening tag.
#
# Rather than deleting arbitrary document contents, delete
# only the tag itself.
start = tag["start"]
end = tag["end"]
# --------------------------------------------------------------
# Closing tag
# --------------------------------------------------------------
elif tag["type"] == "close":
if tag_index in close_to_open:
open_index = close_to_open[tag_index]
start = tags[open_index]["start"]
end = tag["end"]
else:
# Unmatched closing tag.
start = tag["start"]
end = tag["end"]
# --------------------------------------------------------------
# Self-closing tag / HTML void element
# --------------------------------------------------------------
else:
start = tag["start"]
end = tag["end"]
# --------------------------------------------------------------
# Delete the complete range
# --------------------------------------------------------------
editor.beginUndoAction()
try:
editor.setSelection(start, end)
editor.replaceSel("")
# ----------------------------------------------------------
# If the resulting line contains only spaces/tabs,
# delete the entire line as well.
# ----------------------------------------------------------
# Get the position of the caret after the deletion.
pos = editor.getCurrentPos()
line = editor.lineFromPosition(pos)
line_start = editor.positionFromLine(line)
line_end = editor.getLineEndPosition(line)
# Get the remaining contents of the line.
remaining = editor.getTextRange(line_start, line_end)
# Only spaces and tabs are considered whitespace here.
if remaining.strip(" \t") == "":
# Select the entire line including its line ending.
editor.setSelection(line_start, editor.getLineEndPosition(line))
# Include the line ending if there is one.
if line < editor.getLineCount() - 1:
editor.gotoLine(line)
editor.home()
editor.lineDelete()
else:
# Last line: just remove its remaining whitespace.
editor.replaceSel("")
finally:
editor.endUndoAction()
# ----------------------------------------------------------------------
# Run it
# ----------------------------------------------------------------------
delete_current_element()