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
|
""" Provides the tools for loading the cross-reference information in GPS.
"""
import GPS
import os.path
import tool_output
import gps_utils
cross_ref_runtime = GPS.Preference('Project:Cross-References/runtime')
def runtime_switch():
"""
A function called from the target model, which returns the --runtime
switch if the user wants cross-references inside predefined files.
"""
return "--runtime" if cross_ref_runtime.get() else ""
class Sqlite_Cross_References(object):
"""
A python class to support the xref engine in GPS.
This class takes care of running gnatinspect as needed to refresh the
xref info.
"""
disable_gnatinspect = False
# If true, gnatinspect is never run. This should only be used for the
# testsuite in some cases, since this also breaks all cross-referenes.
xml = """<?xml version="1.0" ?><GPS>
<!-- This is an XML model for launching gnatinspect -->
<target-model name="gnatinspect" category="">
<description>Launch cross-reference recompilation</description>
<iconname>gps-custom-build-symbolic</iconname>
<server>GPS_Server</server>
<output-parsers>
console_writer
gnatinspect_onexit_hook
</output-parsers>
<is-run>True</is-run>
<switches command=""/>
</target-model>
<!-- Targets to launch cross-reference recompilation -->
<target model="gnatinspect" name="Load Xref Info" category="_File_">
<in-toolbar>FALSE</in-toolbar>
<in-menu>FALSE</in-menu>
<in-contextual-menus-for-projects>False</in-contextual-menus-for-projects>
<iconname>gps-compute-xref-symbolic</iconname>
<launch-mode>MANUALLY_WITH_NO_DIALOG</launch-mode>
<read-only>TRUE</read-only>
<server>GPS_Server</server>
<output-parsers>
output_chopper
utf_converter
progress_parser
console_writer
gnatinspect_onexit_hook
end_of_build
</output-parsers>
<command-line>
<arg>%system_bin_dir/gnatinspect</arg>
<arg>-d</arg>
<arg>--exit</arg>
<arg>--tracefile=%GPS/gnatinspect_traces.cfg</arg>
<arg>--config=%{O}gpsauto.cgpr</arg>
<!-- Runtime_switch support -->
<arg>--encoding=iso-8859-1</arg>
<arg>--check_db_version</arg>
<arg>-P%PP</arg>
<arg>%X</arg>
<arg>%subdirsarg</arg>
</command-line>
</target>
</GPS>
"""
def __init__(self):
# Whether we trust that there are no links in the project hierarchy
self.trusted_mode = True
cross_ref_runtime.create(
"Cross references in runtime files",
'boolean',
"Index files in the runtime for cross references queries",
False)
# When we support python, we add support for the --runtime attribute.
# This is not supported in GNAT Bench though
xml = self.xml
xml = xml.replace(
"<!-- Runtime_switch support -->",
"<arg>%python(cross_references.runtime_switch())</arg>")
GPS.parse_xml(xml)
GPS.Hook("project_view_changed").add(self.on_project_view_changed)
GPS.Hook("compilation_finished").add(self.on_compilation_finished)
GPS.Hook("preferences_changed").add(self.on_preferences_changed)
GPS.Hook("rsync_finished").add(self.on_rsync_finished)
self.gnatinspect_launch_registered = False
self.gnatinspect_already_running = False
# Initialize self.trusted_mode and other preferences
self.on_preferences_changed(None)
# An action for the menu item /Build/Recompute Xref Info
gps_utils.make_interactive(
lambda *args: self.recompute_xref(quiet=False),
name="recompute xref info")
def gnatinspect_completed(self):
""" Call this when gnatinspect completed working.
"""
self.gnatinspect_already_running = False
if self.gnatinspect_launch_registered:
# Aha, someone had requested a launch of gnatinspect while
# this one was running. Launch this now.
self.gnatinspect_launch_registered = False
self.recompute_xref()
def recompute_xref(self, force=False, quiet=True):
""" Launch recompilation of the cross references.
if Force is True, run regardless of a running gnatinspect
(this flag is used to protect against reentry)"""
if self.gnatinspect_already_running:
# We are already running gnatinspect. If someone registers
# another gnatinspect launch, set up the corresponding flag,
# and wait for gnatinspect to complete before launching the
# next one.
self.gnatinspect_launch_registered = True
return
# The testsuite can disable gnatinspect in some cases.
# Similarly if the DB xref is frozen, do nothing.
if self.disable_gnatinspect:
return
# The project might not exist, for instance when GPS is loading the
# default project in a directory
if not os.path.exists(GPS.Project.root().file().path):
return
# We are about to launch gnatinspect
self.gnatinspect_launch_registered = False
self.gnatinspect_already_running = True
target = GPS.BuildTarget("Load Xref Info")
# This might fail if we have spaces in the name of the directory, but
# any quoting we do here is passed directly to gnatinspect, and the
# switch will not be handled correctly.
extra_args = ['--db=%s' % (GPS.xref_db(), )]
if not self.trusted_mode:
extra_args.append("--symlinks")
target.execute(synchronous=GPS.Logger(
"TESTSUITE").active, quiet=quiet, extra_args=extra_args)
def on_compilation_finished(self, hook, category,
target_name="", mode_name="", status=""):
if (target_name in ["Compile File", "Build Main",
"Build All", "Make", "Compile All Sources",
"Build <current file>", "Custom Build...",
"Check Semantic", "Update file XRef",
"Update file XRef in background"] or
category in ["Makefile", "CodePeer"]):
self.recompute_xref()
def on_project_view_changed(self, hook):
self.recompute_xref()
def on_preferences_changed(self, hook_name):
self.trusted_mode = GPS.Preference("Prj-Editor-Trusted-Mode").get()
def on_rsync_finished(self, hook):
self.recompute_xref()
r = Sqlite_Cross_References()
class GnatInspect_OnExit_Hook(tool_output.OutputParser):
name = "gnatinspect_onexit_hook"
def on_exit(self, status, command):
if status != 0:
GPS.Logger("XREF").log(
"gnatinspect returned with status %s" % status)
r.gnatinspect_completed()
if not r.gnatinspect_already_running:
GPS.Hook("xref_updated").run()
|
