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
|
############################################################################
#
# Copyright (C) 2016 The Qt Company Ltd.
# Contact: https://www.qt.io/licensing/
#
# This file is part of Qt Creator.
#
# Commercial License Usage
# Licensees holding valid commercial Qt licenses may use this file in
# accordance with the commercial license agreement provided with the
# Software or, alternatively, in accordance with the terms contained in
# a written agreement between you and The Qt Company. For licensing terms
# and conditions see https://www.qt.io/terms-conditions. For further
# information use the contact form at https://www.qt.io/contact-us.
#
# GNU General Public License Usage
# Alternatively, this file may be used under the terms of the GNU
# General Public License version 3 as published by the Free Software
# Foundation with exceptions as appearing in the file LICENSE.GPL3-EXCEPT
# included in the packaging of this file. Please review the following
# information to ensure the GNU General Public License requirements will
# be met: https://www.gnu.org/licenses/gpl-3.0.html.
#
############################################################################
source("../../shared/qtcreator.py")
def __highlighterDefinitionsDirectory__():
if platform.system() in ('Microsoft', 'Windows'):
basePath = os.path.expandvars("%LOCALAPPDATA%")
elif platform.system() == 'Linux':
basePath = os.path.expanduser("~/.local/share")
else: # macOS
basePath = os.path.expanduser("~/Library/Application Support")
return os.path.join(basePath, "org.kde.syntax-highlighting", "syntax")
def createFile(folder, filename):
__createProjectOrFileSelectType__(" General", "Empty File", isProject = False)
replaceEditorContent(waitForObject("{name='nameLineEdit' visible='1' "
"type='Utils::FileNameValidatingLineEdit'}"), filename)
replaceEditorContent(waitForObject("{type='Utils::FancyLineEdit' unnamed='1' visible='1' "
"window={type='ProjectExplorer::JsonWizard' unnamed='1' "
"visible='1'}}"), folder)
clickButton(waitForObject(":Next_QPushButton"))
__createProjectHandleLastPage__()
def clickTableGetPatternLineEdit(table, row):
mouseClick(waitForObjectItem(table, row))
return waitForObject("{name='patternsLineEdit' type='QLineEdit' visible='1'}")
def getOrModifyFilePatternsFor(mimeType, filter='', toBePresent=None):
toSuffixArray = lambda x : [pat.replace("*", "") for pat in x.split(";")]
result = []
invokeMenuItem("Tools", "Options...")
waitForObjectItem(":Options_QListView", "Environment")
mouseClick(waitForObjectItem(":Options_QListView", "Environment"))
waitForObject("{container=':Options.qt_tabwidget_tabbar_QTabBar' type='TabItem' "
"text='MIME Types'}")
clickOnTab(":Options.qt_tabwidget_tabbar_QTabBar", "MIME Types")
replaceEditorContent(waitForObject("{name='filterLineEdit' type='QLineEdit' visible='1'}"),
filter)
mimeTypeTable = waitForObject("{name='mimeTypesTreeView' type='QTreeView' visible='1'}")
model = mimeTypeTable.model()
if filter == '':
for row in dumpItems(model):
if row == mimeType:
result = toSuffixArray(str(clickTableGetPatternLineEdit(mimeTypeTable, row).text))
break
clickButton(":Options.Cancel_QPushButton")
if result == ['']:
test.warning("MIME type '%s' seems to have no file patterns." % mimeType)
return result
waitFor('model.rowCount() == 1', 2000)
if model.rowCount() == 1:
patternsLineEd = clickTableGetPatternLineEdit(mimeTypeTable, dumpItems(model)[0])
patterns = str(patternsLineEd.text)
if toBePresent:
actualSuffixes = toSuffixArray(patterns)
toBeAddedSet = set(toBePresent).difference(set(actualSuffixes))
if toBeAddedSet:
patterns += ";*" + ";*".join(toBeAddedSet)
replaceEditorContent(patternsLineEd, patterns)
clickButton(":Options.OK_QPushButton")
try:
mBox = waitForObject("{type='QMessageBox' unnamed='1' visible='1' "
"text?='Conflicting pattern*'}", 2000)
conflictingSet = set(str(mBox.detailedText).replace("*", "").splitlines())
clickButton(waitForObject("{text='OK' type='QPushButton' unnamed='1' visible='1' "
"window={type='QMessageBox' unnamed='1' visible='1'}}"))
if toBeAddedSet.intersection(conflictingSet):
test.fatal("At least one of the patterns to be added is already in use "
"for another MIME type.",
"Conflicting patterns: %s" % str(conflictingSet))
if conflictingSet.difference(toBeAddedSet):
test.fail("MIME type handling failed. (QTCREATORBUG-12149?)",
"Conflicting patterns: %s" % str(conflictingSet))
# re-check the patterns
result = getOrModifyFilePatternsFor(mimeType)
except:
result = toSuffixArray(patterns)
test.passes("Added suffixes")
return result
else:
result = toSuffixArray(patterns)
else:
result = toSuffixArray(patterns)
elif model.rowCount() > 1:
test.warning("MIME type '%s' has ambiguous results." % mimeType)
else:
test.log("MIME type '%s' seems to be unknown to the system." % mimeType)
clickButton(":Options.Cancel_QPushButton")
return result
def addHighlighterDefinition(*languages):
syntaxDirectory = __highlighterDefinitionsDirectory__()
toBeChecked = (os.path.join(syntaxDirectory, x + ".xml") for x in languages)
test.log("Updating highlighter definitions...")
invokeMenuItem("Tools", "Options...")
waitForObjectItem(":Options_QListView", "Text Editor")
mouseClick(waitForObjectItem(":Options_QListView", "Text Editor"))
waitForObject("{container=':Options.qt_tabwidget_tabbar_QTabBar' type='TabItem' "
"text='Generic Highlighter'}")
clickOnTab(":Options.qt_tabwidget_tabbar_QTabBar", "Generic Highlighter")
clickButton("{text='Download Definitions' type='QPushButton' name='downloadDefinitions' visible='1'}")
updateStatus = "{name='updateStatus' type='QLabel' visible='1'}"
waitFor("object.exists(updateStatus)", 5000)
if waitFor('str(findObject(updateStatus).text) == "Download finished"', 5000):
test.verify(os.path.exists(syntaxDirectory),
"Directory for syntax highlighter files exists.")
xmlFiles = glob.glob(os.path.join(syntaxDirectory, "*.xml"))
test.verify(len(xmlFiles) > 0, "Verified presence of syntax highlighter files. "
"(Found %d)" % len(xmlFiles))
# should we check output (General Messages) as well?
test.passes("Updated definitions")
clickButton(":Options.OK_QPushButton")
return map(os.path.exists, toBeChecked)
else:
test.fail("Could not update highlighter definitions")
clickButton(":Options.Cancel_QPushButton")
return map(os.path.exists, toBeChecked)
def hasSuffix(fileName, suffixPatterns):
for suffix in suffixPatterns:
if fileName.endswith(suffix):
return True
return False
def displayHintForHighlighterDefinition(fileName, patterns, lPatterns, added, addedLiterate):
if hasSuffix(fileName, patterns):
return not added
if hasSuffix(fileName, lPatterns):
return not addedLiterate
test.warning("Got an unexpected suffix.", "Filename: %s, Patterns: %s"
% (fileName, str(patterns + lPatterns)))
return False
def main():
miss = ("A highlight definition was not found for this file. Would you like to download "
"additional highlight definition files?")
startQC()
if not startedWithoutPluginError():
return
patterns = getOrModifyFilePatternsFor("text/x-haskell", "x-haskell")
lPatterns = getOrModifyFilePatternsFor("text/x-literate-haskell", "literate-haskell")
folder = tempDir()
filesToTest = ["Main.lhs", "Main.hs"]
code = ['module Main where', '', 'main :: IO ()', '', 'main = putStrLn "Hello World!"']
for current in filesToTest:
createFile(folder, current)
editor = getEditorForFileSuffix(current)
if editor == None:
earlyExit("Something's really wrong! (did the UI change?)")
return
expectHint = hasSuffix(current, patterns) or hasSuffix(current, lPatterns)
mssg = "Verifying whether hint for missing highlight definition is present. (expected: %s)"
try:
waitForObject("{text='%s' type='QLabel' unnamed='1' visible='1' "
"window=':Qt Creator_Core::Internal::MainWindow'}" % miss, 2000)
test.verify(expectHint, mssg % str(expectHint))
except:
test.verify(not expectHint, mssg % str(expectHint))
# literate haskell: first character must be '>' otherwise it's a comment
if current.endswith(".lhs"):
typeLines(editor, [">" + line for line in code])
else:
typeLines(editor, code)
invokeMenuItem("File", "Save All")
invokeMenuItem("File", "Close All")
addedHaskell, addedLiterateHaskell = addHighlighterDefinition("haskell", "literate-haskell")
patterns = getOrModifyFilePatternsFor('text/x-haskell', 'x-haskell', ['.hs'])
lPatterns = getOrModifyFilePatternsFor('text/x-literate-haskell', 'literate-haskell', ['.lhs'])
home = os.path.expanduser("~")
for current in filesToTest:
recentFile = os.path.join(folder, current)
if recentFile.startswith(home) and platform.system() in ('Linux', 'Darwin'):
recentFile = recentFile.replace(home, "~", 1)
invokeMenuItem("File", "Recent Files", "(&\\d \| )?%s" % recentFile)
editor = getEditorForFileSuffix(current)
display = displayHintForHighlighterDefinition(current, patterns, lPatterns,
addedHaskell, addedLiterateHaskell)
try:
waitForObject("{text='%s' type='QLabel' unnamed='1' visible='1' "
"window=':Qt Creator_Core::Internal::MainWindow'}" % miss, 2000)
test.verify(display, "Hint for missing highlight definition was present "
"- current file: %s" % current)
except:
test.verify(not display, "Hint for missing highlight definition is not shown "
"- current file: %s" % current)
placeCursorToLine(editor, '.*%s' % code[-1], True)
for _ in range(23):
type(editor, "<Left>")
type(editor, "<Return>")
if current.endswith(".lhs"):
type(editor, ">")
type(editor, "<Tab>")
invokeMenuItem("File", "Save All")
invokeMenuItem("File", "Exit")
def init():
syntaxDirectory = __highlighterDefinitionsDirectory__()
if not os.path.exists(syntaxDirectory):
return
test.log("Removing existing highlighter definitions folder")
deleteDirIfExists(syntaxDirectory)
|
