/usr/share/gps/plug-ins/gnatcov.py is in gnat-gps-common 6.1.2016-1ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 | """ This plug-in adds support for GNATcoverage.
This plug-in provides the following:
* A new Build Mode "gnatcov"
* Several new project attributes which GPS will
use to drive various tools in the context of
GNATcoverage
* Build targets to launch runs and analyses
* Menus corresponding to these build targets.
The Build Mode "gnatcov" is listed in the Build Mode
combo, in the main toolbar. Objects generated under
this build mode are generated in a subdirectory "gnatcov"
in all object and executable directories specified by
the project hierarchy.
The following Project Properties are added, which are
available in the "GNATcov" section of the Project
Properties editor, and which map to attributes in a
package "IDE_Coverage" in the project files.
* Gnatcov_Mode_Switches: switches that GPS will pass
to the command line used to build while the "gnatcov"
Build Mode is selected
* Level_Run: the coverage level to pass to the
"gnatcov run" command
* Switches_Run: additional switches to pass to
the "gnatcov run" command
* Level_Coverage: the coverage level to pass to
the "gnatcov coverage" command
* Switches_Coverage: additional switches to pass
to the "gnatcov coverage" command
This plugin defines two new build targets, to launch
"gnatcov run" and "gnatcov coverage", automatically
generated for every executable defined in the project
hierarchy, along with menus, under the menu
Tools->GNATcoverage.
In addition, this plugin automatically loads or refreshes
the Coverage Report in GPS after every call to the
"gnatcov coverage" build target.
With this plugin, the steps to follow for a typical
GNATcoverage session would be:
1 - switch to the "gnatcov" Build Mode in the toolbar
2 - build the executable using the standard mechanism
3 - launch a first run using the menu
Tools->GNATcoverage->Run under gnatcov
4 - launch a first analysis using the menu
Tools->GNATcoverage->Coverage with gnatcov
5 - edit the code or the test driver, then rerun
steps 2, 3, 4
Note: this plug-in activates only when the command-line tool
"gnatcov" is found on the PATH.
"""
###########################################################################
# No user customization below this line
###########################################################################
import os.path
import GPS
from extensions.private.xml import X
import os_utils
def list_to_xml(items):
return '\n'.join(str(i) for i in items)
gnatcov_path = os_utils.locate_exec_on_path('gnatcov')
gnatcov_install_dir = (
os.path.join(os.path.dirname(gnatcov_path), '..')
if gnatcov_path else
None
)
class GNATcovPlugin(object):
PLUGIN_MENU = '/Tools/GNATcov/'
# Keep this style name synchronized with Code_Coverage.GNATcov.
INLINED_DETAILS_NAME = 'GNATcov inlined details'
PROJECT_ATTRIBUTES = [
X(
'project_attribute',
package='IDE_Coverage',
name='Gnatcov_Mode_Switches',
label="Switches in 'gnatcov' mode",
description=("Extra build switches to pass to the builder when in"
" 'gnatcov' mode."),
editor_page='GNATcov',
editor_section='Build',
hide_in='wizard library_wizard',
).children(X('string')),
X(
'project_attribute',
name='Level_Run',
label='Coverage Level',
package='IDE_Coverage',
editor_page='GNATcov',
editor_section='Run',
hide_in='wizard library_wizard',
description='The coverage level to pass to gnatcov run.',
).children(
X('choice').children('branch'),
X('choice').children('insn'),
X('choice', default='true').children('stmt'),
X('choice').children('stmt+decision'),
X('choice').children('stmt+mcdc'),
),
X(
'project_attribute',
name='Switches_Run',
label='Extra switches',
package='IDE_Coverage',
editor_page='GNATcov',
editor_section='Run',
hide_in='wizard library_wizard',
description='Extra build switches to pass to gnatcov run',
).children(X('string')),
X(
'project_attribute',
name='Level_Coverage',
label='Coverage Level',
package='IDE_Coverage',
editor_page='GNATcov',
editor_section='Coverage',
hide_in='wizard library_wizard',
description='The coverage level to pass to gnatcov coverage.',
).children(
X('choice').children('branch'),
X('choice').children('insn'),
X('choice', default='true').children('stmt'),
X('choice').children('stmt+decision'),
X('choice').children('stmt+mcdc'),
),
X(
'project_attribute',
name='Switches_Coverage',
label='Extra switches',
package='IDE_Coverage',
editor_page='GNATcov',
editor_section='Coverage',
hide_in='wizard library_wizard',
description='Extra build switches to pass to gnatcov coverage',
).children(X('string')),
]
BUILD_MODES = [
X('builder-mode', name='gnatcov').children(
X('description').children('Build with GNATcoverage information'),
X('subdir').children('gnatcov'),
X('supported-model').children('builder'),
X('supported-model').children('gnatmake'),
X('supported-model').children('gprbuild'),
X('supported-model', filter='--subdirs=').children('gnatcov-run'),
X('supported-model', filter='--subdirs=').children(
'gnatcov-coverage'),
X('supported-model', filter='--subdirs=').children('gprclean'),
X('extra-args').children(
X('arg').children("%attr(ide_coverage'gnatcov_mode_switches)"),
X('arg').children('--subdirs=%subdir'),
X('arg').children('-cargs'),
X('arg').children('-g'),
X('arg').children('-fdump-scos'),
X('arg').children('-fpreserve-control-flow'),
)
)
]
BUILD_TARGETS = [
# Program execution under instrumented execution environment
X('target-model', name='gnatcov-run', category='').children(
X('description').children('Run under GNATcov for code coverage'),
X('command-line').children(
X('arg').children('gnatcov'),
X('arg').children('run'),
),
X('iconname').children('gps-build-all-symbolic'),
X('switches', command='%(tool_name)s', columns='2', lines='2'),
),
X(
'target',
model='gnatcov-run', category='GNATcov run',
name='Run under GNATcov', menu=PLUGIN_MENU
).children(
X('target-type').children('executable'),
X('in-toolbar').children('FALSE'),
X('in-menu').children('TRUE'),
X('read-only').children('TRUE'),
X('iconname').children('gps-build-all-symbolic'),
X('launch-mode').children('MANUALLY'),
X('command-line').children(
X('arg').children('gnatcov'),
X('arg').children('run'),
X('arg').children('-P%PP'),
X('arg').children('--recursive'),
X('arg').children('%target'),
X('arg').children('-c'),
X('arg').children("%attr(ide_coverage'level_coverage,stmt)"),
X('arg').children('-o'),
X('arg').children('%TT.trace'),
X('arg').children('%E'),
X('arg').children("%attr(ide_coverage'switches_run)"),
),
),
# Coverage report generation
X('target-model', name='gnatcov-coverage', category='').children(
X('description').children('Code coverage with GNATcov'),
X('command-line').children(
X('arg').children('gnatcov'),
X('arg').children('coverage'),
X('arg').children('-P%PP'),
X('arg').children('--recursive'),
X('arg').children('%target'),
X('arg').children('--annotate=xcov'),
),
X('iconname').children('gps-build-all-symbolic'),
X('switches', command='%(tool_name)s', columns='1', lines='4'),
),
X('target', model='gnatcov-coverage', category='GNATcov coverage',
name='Generate GNATcov Main Report',
menu=PLUGIN_MENU).children(
X('target-type').children('executable'),
X('in-toolbar').children('FALSE'),
X('in-menu').children('TRUE'),
X('read-only').children('TRUE'),
X('iconname').children('gps-build-all-symbolic'),
X('launch-mode').children('MANUALLY'),
X('command-line').children(
X('arg').children('gnatcov'),
X('arg').children('coverage'),
X('arg').children('-P%PP'),
X('arg').children('--recursive'),
X('arg').children('%target'),
X('arg').children('-c'),
X('arg').children("%attr(ide_coverage'level_coverage,stmt)"),
X('arg').children('--annotate=xcov+'),
X('arg').children('--output-dir=%O'),
X('arg').children('-T'),
X('arg').children('%TT.trace'),
X('arg').children("%attr(ide_coverage'switches_coverage)"),
),
),
]
PREFERENCES = [
X('preference',
name='GNATcov-Inlined-Details-Foreground',
page='Plugins/GNATcov',
default='#000000',
label='Inline details foreground',
tip='Color to use for the foreground of inlined details',
type='color'),
X('preference',
name='GNATcov-Inlined-Details-Background',
page='Plugins/GNATcov',
default='#E9E9E9',
label='Inline details background',
tip='Color to use for the background of inlined details',
type='color'),
]
GNATCOV_DOCUMENTATION = [
X('doc_path').children(
os.path.join(gnatcov_install_dir, 'share',
'doc', 'gnatcoverage', 'html')
if gnatcov_install_dir else
None
),
X('documentation_file').children(
X('name').children('gnatcov.html'),
X('descr').children("GNATcoverage User's Guide"),
X('category').children('GNATcoverage'),
X('menu', before='About').children(
"/Help/GNATcoverage/GNATcoverage User's Guide"
),
),
]
GNATEMU_DOCUMENTATION = [
X('doc_path').children('share/doc/gnatemu/html'),
X('documentation_file').children(
X('name').children('gnatemulator.html'),
X('descr').children('GNATemulator Documentation'),
X('category').children('GNATcoverage'),
X('menu', before='About').children(
'/Help/GNATcoverage/GNATemulator Documentation'
),
),
]
def __init__(self):
# Create all custom things that do not require GPS' GUI to be ready
# (i.e.: all but menus and hooks).
for xml_nodes in (
self.PROJECT_ATTRIBUTES, self.BUILD_MODES, self.PREFERENCES,
self.GNATCOV_DOCUMENTATION, self.GNATEMU_DOCUMENTATION,
):
GPS.parse_xml(list_to_xml(xml_nodes))
# Defer further initialization to when GPS is completely ready.
GPS.Hook('gps_started').add(self.on_gps_started)
def on_gps_started(self, hook):
# Create the GNATcov menu entry before loading targets and so on, so
# that we master where the entry is inserted.
GPS.Menu.create(
self.PLUGIN_MENU + '-',
ref='Coverage',
add_before=False)
# Now the parent menu is present, fill it with custom targets.
GPS.parse_xml(list_to_xml(self.BUILD_TARGETS))
GPS.Hook('compilation_finished').add(self.on_compilation_finished)
GPS.Hook('preferences_changed').add(self.on_preferences_changed)
self.inline_details_style = GPS.Style(self.INLINED_DETAILS_NAME)
self.on_preferences_changed('', reload=False)
def reload_gnatcov_data(self):
"""Clean the coverage report and reload it from the files."""
# If needed, switch to GNATcov build mode.
if GPS.Preference("Coverage-Toolchain").get() != 'Gnatcov':
GPS.Preference("Coverage-Toolchain").set('Gnatcov')
GPS.execute_action("/Tools/Coverage/Clear coverage from memory")
GPS.execute_action("/Tools/Coverage/Load data for all projects")
def on_compilation_finished(self, hook, category,
target_name="", mode_name="", status=""):
"""Called whenever a compilation ends."""
# If compilation failed, do nothing.
if status:
return
if target_name in ["Generate GNATcov Main Report"]:
self.reload_gnatcov_data()
def on_preferences_changed(self, hook, reload=True):
"""Update various plugin elements that rely on preferences."""
self.inline_details_style.set_background(
GPS.Preference('GNATcov-Inlined-Details-Background').get())
self.inline_details_style.set_foreground(
GPS.Preference('GNATcov-Inlined-Details-Foreground').get())
# This plug-in makes sense only if GNATcoverage is available.
if os_utils.locate_exec_on_path('gnatcov'):
plugin = GNATcovPlugin()
|