summaryrefslogtreecommitdiffstats
path: root/src/kscopeactions.cpp
blob: d5c64fc1bde91378a86850aea496ba71a9ba870b (plain)
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
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
/***************************************************************************
 *
 * Copyright (C) 2007 Elad Lahav (elad_lahav@users.sourceforge.net)
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 
 * 1. Redistributions of source code must retain the above copyright
 *    notice, m_pWindow list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, m_pWindow list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AS IS'' AND ANY EXPRESS OR
 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 ***************************************************************************/

#include <klocale.h>
#include "kscope.h"
#include "kscopeactions.h"
#include "kscopeconfig.h"
#include "filelist.h"
#include "editortabs.h"
#include "querywidget.h"

KScopeActions::KScopeActions(KScope* pWindow) : QObject(),
		m_pWindow(pWindow),
		m_pCollection(pWindow->actionCollection())
{
}

KScopeActions::~KScopeActions()
{
}

/**
 * Connects menu bar and toolbar commands with class members. These members
 * handle the actions associated with each command.
 */
void KScopeActions::init()
{
	// File menu
	KStdAction::openNew(m_pWindow, SLOT(slotNewFile()), m_pCollection);
	KStdAction::open(m_pWindow, SLOT(slotOpenFile()), m_pCollection);
	KStdAction::close(m_pWindow, SLOT(slotCloseEditor()), m_pCollection);
	KStdAction::quit(m_pWindow, SLOT(slotClose()), m_pCollection);

	addAction(i18n("Go to File List"),
		NULL,
		"Ctrl+Shift+O",
		m_pWindow->m_pFileList,
		SLOT(slotSetFocus()),
		"file_open_file_from_list",
		SIGNAL(toggleProject(bool)));
	
	addAction(i18n("Save Al&l"),
		"save_all",
		"Ctrl+L",
		m_pWindow->m_pEditTabs,
		SLOT(slotSaveAll()),
		"file_save_all",
		NULL);
	
	// Edit menu
	m_pExtEditAction = addAction(i18n("Edit in E&xternal Editor"),
		NULL,
		"Ctrl+E",
		m_pWindow,
		SLOT(slotExtEdit()),
		"edit_external_editor",
		SIGNAL(toggleFile(bool)));
		
	addAction(i18n("Go To Tag"),
		NULL,
		"Ctrl+Shift+T",
		m_pWindow,
		SLOT(slotGotoTag()),
		"edit_goto_tag",
		SIGNAL(toggleFile(bool)));
	
	addAction(i18n("Complete Symbol"),
		NULL,
		"Ctrl+Space",
		m_pWindow,
		SLOT(slotCompleteSymbol()),
		"edit_comp_symbol",
		SIGNAL(toggleFile(bool)));
		
	// Project menu
	addAction(i18n("&New Project..."),
		NULL,
		NULL,
		m_pWindow,
		SLOT(slotCreateProject()),
		"project_new",
		NULL);
		
	addAction(i18n("&Open Project..."),
		"project_open",
		NULL,
		m_pWindow,
		SLOT(slotOpenProject()),
		"project_open",
		NULL);
		
	addAction(i18n("Open &Cscope.out..."),
		NULL,
		NULL,
		m_pWindow,
		SLOT(slotProjectCscopeOut()),
		"project_cscope_out",
		NULL);
		
	addAction(i18n("Add/Remove &Files..."),
		NULL,
		NULL,
		m_pWindow,
		SLOT(slotProjectFiles()),
		"project_add_rem_files",
		SIGNAL(toggleProject(bool)));
		
	addAction(i18n("&Properties..."),
		NULL,
		NULL,
		m_pWindow,
		SLOT(slotProjectProps()),
		"project_properties",
		SIGNAL(toggleProject(bool)));
		
	addAction(i18n("&Make Project"),
		"make_kdevelop",
		"Ctrl+M",
		m_pWindow,
		SLOT(slotProjectMake()),
		"project_make",
		SIGNAL(toggleProject(bool)));
		
	addAction(i18n("&Remake Project"),
		"rebuild",
		"Ctrl+Shift+M",
		m_pWindow,
		SLOT(slotProjectRemake()),
		"project_remake",
		SIGNAL(toggleProject(bool)));
	
	addAction(i18n("&Close Project"),
		"fileclose",
		NULL,
		m_pWindow,
		SLOT(slotCloseProject()),
		"project_close",
		SIGNAL(toggleProject(bool)));

	// Cscope menu
	addAction(i18n("&References..."),
		NULL,
		"Ctrl+0",
		m_pWindow,
		SLOT(slotQueryReference()),
		"cscope_references",
		SIGNAL(toggleProject(bool)));
		
	addAction(i18n("&Definition..."),
		NULL,
		"Ctrl+1",
		m_pWindow,
		SLOT(slotQueryDefinition()),
		"cscope_definition",
		SIGNAL(toggleProject(bool)));
	
	addAction(i18n("&Called Functions..."),
		NULL,
		"Ctrl+2",
		m_pWindow,
		SLOT(slotQueryCalled()),
		"cscope_called",
		SIGNAL(toggleProject(bool)));
		
	addAction(i18n("C&alling Functions..."),
		NULL,
		"Ctrl+3",
		m_pWindow,
		SLOT(slotQueryCalling()),
		"cscope_calling",
		SIGNAL(toggleProject(bool)));
		
	addAction(i18n("Find &Text..."),
		NULL,
		"Ctrl+4",
		m_pWindow,
		SLOT(slotQueryText()),
		"cscope_text",
		SIGNAL(toggleProject(bool)));
		
	addAction(i18n("Find &EGrep Pattern..."),
		NULL,
		"Ctrl+5",
		m_pWindow,
		SLOT(slotQueryPattern()),
		"cscope_pattern",
		SIGNAL(toggleProject(bool)));
		
	addAction(i18n("Find &File..."),
		NULL,
		"Ctrl+7",
		m_pWindow,
		SLOT(slotQueryFile()),
		"cscope_file",
		SIGNAL(toggleProject(bool)));
		
	addAction(i18n("&Including Files..."),
		NULL,
		"Ctrl+8",
		m_pWindow,
		SLOT(slotQueryIncluding()),
		"cscope_including",
		SIGNAL(toggleProject(bool)));
		
	addAction(i18n("&Quick Definition"),
		NULL,
		"Ctrl+]",
		m_pWindow,
		SLOT(slotQueryQuickDef()),
		"cscope_quick_def",
		SIGNAL(toggleProject(bool)));
		
	addAction(i18n("Call &Graph..."),
		NULL,
		"Ctrl+\\",
		m_pWindow,
		SLOT(slotCallTree()),
		"cscope_call_tree",
		SIGNAL(toggleProject(bool)));
		
	addAction(i18n("Re&build database"),
		"vcs_update",
		NULL,
		m_pWindow,
		SLOT(slotRebuildDB()),
		"cscope_rebuild",
		SIGNAL(toggleProject(bool)));

	// Go menu
	addAction(i18n("P&revious Result"),
		"up",
		"Alt+Up", 
		m_pWindow->m_pQueryWidget,
		SLOT(slotPrevResult()),
		"go_prev_result",
		SIGNAL(toggleProject(bool)));
	
	addAction(i18n("N&ext Result"),
		"down",
		"Alt+Down",
		m_pWindow->m_pQueryWidget,
		SLOT(slotNextResult()),
		"go_next_result",
		SIGNAL(toggleProject(bool)));
	
	addAction(i18n("&Previous Position"),
		"back", 
		"Alt+Left",
		m_pWindow->m_pQueryWidget,
		SLOT(slotHistoryPrev()),
		"go_prev_pos",
		NULL);
	
	addAction(i18n("&Next Position"),
		"forward", 
		"Alt+Right",
		m_pWindow->m_pQueryWidget,
		SLOT(slotHistoryNext()),
		"go_next_pos",
		NULL);
		
	addAction(i18n("Position &History"),
		"history",
		"Ctrl+h",
		m_pWindow,
		SLOT(slotHistoryShow()),
		"go_history",
		NULL);
		
	addAction(i18n("Global &Bookmarks"),
		"bookmark", 
		"Ctrl+Shift+G",
		m_pWindow,
		SLOT(slotShowBookmarks()),
		"go_bookmarks",
		NULL);

	// View menu
	m_pToggleFileViewAction = addToggle(i18n("Toggle File List"),
		"view_sidetree",
		"Ctrl+/",
		m_pWindow->m_pFileViewDock,
		SLOT(changeHideShowState()),
		"view_toggle_filelist_dock",
		NULL);
	
	m_pToggleQueryWindowAction = addToggle(i18n("Toggle Query Window"),
		"view_top_bottom",
		"Ctrl+.",
		m_pWindow->m_pQueryDock,
		SLOT(changeHideShowState()),
		"view_toggle_query_dock",
		NULL);
	
	m_pToggleTagListAction = addToggle(i18n("Toggle Tag List"),
		"view_detailed",
		"Ctrl+'",
		m_pWindow->m_pEditTabs,
		SLOT(slotToggleTagList()),
		"view_toggle_tag_list",
		NULL);
			
	// Window menu
	addAction(i18n("Close &All"),
		"fileclose",
		NULL,
		m_pWindow,
		SLOT(slotCloseAllWindows()),
		"window_close_all",
		NULL);
		
	addAction(i18n("Go &Left"),
		"back", 
		"Alt+Shift+Left",
		m_pWindow->m_pEditTabs,
		SLOT(slotGoLeft()),
		"window_go_left",
		NULL);
		
	addAction(i18n("Go &Right"),
		"forward",
		"Alt+Shift+Right",
		m_pWindow->m_pEditTabs,
		SLOT(slotGoRight()),
		"window_go_right",
		NULL);
		
	// Settings menu
	KStdAction::preferences(m_pWindow, SLOT(slotConfigure()), m_pCollection);
	KStdAction::keyBindings(m_pWindow, SLOT(slotShortcuts()), m_pCollection);
	
	// Help menu
	addAction(i18n("Show &Welcome Message..."),
		NULL,
		NULL,
		m_pWindow,
		SLOT(slotShowWelcome()),
		"help_welcome",
		NULL);
	
	// Query widget popup menu
	addAction(i18n("&New"),
		"filenew",
		NULL,
		m_pWindow->m_pQueryWidget,
		SLOT(slotNewQueryPage()),
		"query_new",
		SIGNAL(toggleProject(bool)));
	
	addAction(i18n("&Refresh"),
		"reload",
		NULL,
		m_pWindow->m_pQueryWidget,
		SLOT(slotRefreshCurrent()),
		"query_refresh",
		SIGNAL(toggleProject(bool)));
		
	m_pLockAction = addToggle(i18n("&Lock/Unlock"),
		"encrypted",
		NULL,
		m_pWindow->m_pQueryWidget,
		SLOT(slotLockCurrent()),
		"query_toggle_locked",
		SIGNAL(toggleProject(bool)));
		
	addAction(i18n("&Close"),
		"fileclose",
		NULL,
		m_pWindow->m_pQueryWidget,
		SLOT(slotCloseCurrent()),
		"query_close",
		SIGNAL(toggleProject(bool)));
	
	m_pExtEditAction->setEnabled(Config().useExtEditor());
}

void KScopeActions::initLayoutActions()
{
	m_pToggleFileViewAction->setChecked(m_pWindow->m_pFileViewDock->isShown());
	m_pToggleQueryWindowAction->setChecked(m_pWindow->m_pQueryDock->isShown());
	m_pToggleTagListAction->setChecked(Config().getShowTagList());
}

/**
 * Enables/disables the "Edit in External Editor" command.
 * @param	bEnable	true to enable the command, false to disable it
 */
void KScopeActions::enableExtEditor(bool bEnable)
{
	m_pExtEditAction->setEnabled(bEnable);
}
 
void KScopeActions::slotQueryDockToggled(bool bVisible)
{
	m_pToggleQueryWindowAction->setChecked(bVisible);
}

/**
 * Ensures the "Show/Hide Query Window" action is unchecked when the dock
 * is closed through its close button.
 * This slot is conncted to the headerCloseButtonClicked() signal of the
 * query window dock widget.
 */
void KScopeActions::slotQueryDockClosed()
{
	m_pToggleQueryWindowAction->setChecked(false);
}

/**
 * Ensures the "Show/Hide File View" action is unchecked when the dock
 * is closed through its close button.
 * This slot is conncted to the headerCloseButtonClicked() signal of the
 * file view dock widget.
 */
void KScopeActions::slotFileViewDockClosed()
{
	m_pToggleFileViewAction->setChecked(false);
}
 
/**
 * Enables/disables all actions related to open projects.
 * This slot should be called whenever a project is opened or closed.
 * @param	bEnable	true to enable actions, false to disable
 */
void KScopeActions::slotEnableProjectActions(bool bEnable)
{
	emit toggleProject(bEnable);
}
 
/**
 * Enables/disables all actions related to open files.
 * This slot should be called the first file is opened, or when the last one
 * is closed.
 * @param	bEnable	true to enable actions, false to disable
 */
void KScopeActions::slotEnableFileActions(bool bEnable)
{
	emit toggleFile(bEnable);
}

/**
 * Creates a new action.
 * @param	sCaption	The text to display in the menu item
 * @param	szIcon		Optional icon associated with the action
 * @param	szShortcut	Optional key-combination string
 * @param	pReceiver	The widget to receive the action's signal
 * @param	szSlot		The widget's slot that connect to the signal
 * @param	szName		The XML entry corresponding to the action
 * @param	szSignal	Optional signal to connect to the setEnabled() slot of
 *						the action
 * @return	The newly created action object
 */
KAction* KScopeActions::addAction(const QString& sCaption, const char* szIcon,
	const char* szShortcut, QWidget* pReceiver, const char* szSlot,
	const char* szName, const char* szSignal)
{
	KAction* pAction;
	
	// Create the action
	pAction = new KAction(sCaption,
			szIcon,
			szShortcut == NULL ? KShortcut() : KShortcut(szShortcut),
			pReceiver,
			szSlot,
			m_pCollection,
			szName);
			
	// Add to the given action list, if any
	if (szSignal)
		connect(this, szSignal, pAction, SLOT(setEnabled(bool)));
		
	return pAction;
}

/**
 * Creates a new toggle action.
 * @param	sCaption	The text to display in the menu item
 * @param	szIcon		Optional icon associated with the action
 * @param	szShortcut	Optional key-combination string
 * @param	pReceiver	The widget to receive the action's signal
 * @param	szSlot		The widget's slot that connect to the signal
 * @param	szName		The XML entry corresponding to the action
 * @param	szSignal	Optional signal to connect to the setEnabled() slot of
 *						the action
 * @return	The newly created action object
 */
KToggleAction* KScopeActions::addToggle(const QString& sCaption,
	const char* szIcon, const char* szShortcut, QWidget* pReceiver,
	const char* szSlot, const char* szName, const char* szSignal)
{
	KToggleAction* pAction;
	
	// Create the action
	pAction = new KToggleAction(sCaption,
			szIcon,
			szShortcut == NULL ? KShortcut() : KShortcut(szShortcut),
			pReceiver,
			szSlot,
			m_pCollection,
			szName);
			
	// Add to the given action list, if any
	if (szSignal)
		connect(this, szSignal, pAction, SLOT(setEnabled(bool)));
		
	return pAction;
}

#include "kscopeactions.moc"