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
|
# This file is part of the Frescobaldi project, http://www.frescobaldi.org/
#
# Copyright (c) 2013 - 2014 by Wilbert Berendsen
#
# This program is free software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License
# as published by the Free Software Foundation; either version 2
# of the License, or (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
# See http://www.gnu.org/licenses/ for more information.
"""
Maintains an overview of the structure of a Document.
"""
import re
from PyQt5.QtCore import QSettings
import app
import plugin
import lydocument
import ly.document
# default outline patterns that are ignored in comments
default_outline_patterns = [
r"(?P<title>\\(score|book|bookpart))\b",
r"^\\(paper|layout|header)\b",
r"\\(new|context)\s+[A-Z]\w+",
r"^[a-zA-Z]+\s*=",
r"^<<",
r"^\{",
r"^\\relative([ \t]+\w+[',]*)?",
]
# default outline patterns that are matched also in comments
default_outline_patterns_comments = [
r"(?P<title>BEGIN[^\n]*)[ \t]*$",
r"\b(?P<alert>(FIXME|HACK|XXX+)\b\W*\w+)",
]
# cache the outline regexp
_outline_re = None
_outline_re_comments = None
def outline_re(comments):
"""Return the expression to look for document outline items.
If comments is True it is used to search in the whole document,
if it is False comments are excluded."""
v = '_outline_re'+('_comments' if comments else '')
if globals()[v] is None:
globals()[v] = create_outline_re(comments)
return globals()[v]
def _reset_outline_re():
global _outline_re
global _outline_re_comments
_outline_re = None
_outline_re_comments = None
app.settingsChanged.connect(_reset_outline_re, -999)
def create_outline_re(comments):
"""Create and return the expression to look for document outline items.
If comments is True it is used to search in the whole document,
if it is False comments are excluded."""
try:
if comments:
rx = QSettings().value("documentstructure/outline_patterns_comments",
default_outline_patterns_comments, str)
else:
rx = QSettings().value("documentstructure/outline_patterns",
default_outline_patterns, str)
except TypeError:
rx = []
# suffix duplicate named groups with a number
groups = {}
new_rx = []
for e in rx:
try:
c = re.compile(e)
except re.error:
continue
if c.groupindex:
for name in c.groupindex:
if name in groups:
groups[name] += 1
new_name = name + format(groups[name])
e = e.replace("(?P<{0}>".format(name), "(?P<{0}>".format(new_name))
else:
groups[name] = 0
new_rx.append(e)
rx = '|'.join(new_rx)
return re.compile(rx, re.MULTILINE | re.UNICODE)
class DocumentStructure(plugin.DocumentPlugin):
def __init__(self, document):
self._outline = None
def invalidate(self):
"""Called when the document changes or the settings are changed."""
self._outline = None
app.settingsChanged.disconnect(self.invalidate)
self.document().contentsChanged.disconnect(self.invalidate)
def outline(self):
"""Return the document outline as a series of match objects."""
if self._outline is None:
# match patterns excluding comments
active_code = self.remove_comments()
outline_list = list(outline_re(False).finditer(active_code))
# match patterns including comments
outline_list_comments = list(outline_re(True).finditer(self.document().toPlainText()))
# merge lists and sort by start position
self._outline = outline_list + outline_list_comments
self._outline.sort(key=lambda match: match.start())
self.document().contentsChanged.connect(self.invalidate)
app.settingsChanged.connect(self.invalidate, -999)
return self._outline
def remove_comments(self):
"""Remove Lilypond comments from text"""
def whiteout_section(cursor, start, end):
spaces = ''.join(' ' for x in range(start, end))
with cursor.document as doc:
doc[start:end] = spaces
doc = ly.document.Document(self.document().toPlainText())
cursor = lydocument.Cursor(doc)
source = ly.document.Source(cursor, True, tokens_with_position=True)
start = 0
for token in source:
if isinstance(token, ly.lex.BlockCommentStart):
start = token.pos
elif isinstance(token, ly.lex.BlockCommentEnd):
if start:
whiteout_section(cursor, start, token.end)
start = 0
elif isinstance(token, ly.lex.Comment):
whiteout_section(cursor, token.pos, token.end)
return cursor.document.plaintext()
|
