/
Command.cpp
1915 lines (1661 loc) · 62.4 KB
/
Command.cpp
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
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/***************************************************************************
* Copyright (c) 2002 Jürgen Riegel <juergen.riegel@web.de> *
* *
* This file is part of the FreeCAD CAx development system. *
* *
* This library is free software; you can redistribute it and/or *
* modify it under the terms of the GNU Library General Public *
* License as published by the Free Software Foundation; either *
* version 2 of the License, or (at your option) any later version. *
* *
* This library 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 Library General Public License for more details. *
* *
* You should have received a copy of the GNU Library General Public *
* License along with this library; see the file COPYING.LIB. If not, *
* write to the Free Software Foundation, Inc., 59 Temple Place, *
* Suite 330, Boston, MA 02111-1307, USA *
* *
***************************************************************************/
#include "PreCompiled.h"
#ifndef _PreComp_
# include <sstream>
# include <QApplication>
# include <QByteArray>
# include <QDir>
# include <QKeySequence>
# include <QMessageBox>
# include <Inventor/actions/SoGetBoundingBoxAction.h>
# include <Inventor/nodes/SoOrthographicCamera.h>
# include <Inventor/nodes/SoPerspectiveCamera.h>
#endif
#include <boost/algorithm/string/replace.hpp>
#include <Python.h>
#include <frameobject.h>
#include "Command.h"
#include "Action.h"
#include "Application.h"
#include "Document.h"
#include "Selection.h"
#include "Macro.h"
#include "MainWindow.h"
#include "DlgUndoRedo.h"
#include "BitmapFactory.h"
#include "WhatsThis.h"
#include "WaitCursor.h"
#include "Control.h"
#include "View3DInventor.h"
#include "View3DInventorViewer.h"
#include "WorkbenchManager.h"
#include "Workbench.h"
#include <Base/Console.h>
#include <Base/Exception.h>
#include <Base/Interpreter.h>
#include <Base/Sequencer.h>
#include <Base/Tools.h>
#include <App/Document.h>
#include <App/DocumentObject.h>
#include <App/AutoTransaction.h>
#include <Gui/ViewProviderLink.h>
FC_LOG_LEVEL_INIT("Command", true, true)
using Base::Interpreter;
using namespace Gui;
using namespace Gui::Dialog;
using namespace Gui::DockWnd;
/** \defgroup commands Command Framework
\ingroup GUI
\brief Structure for registering commands to the FreeCAD system
* \section Overview
* In GUI applications many commands can be invoked via a menu item, a toolbar button or an accelerator key. The answer of Qt to master this
* challenge is the class \a QAction. A QAction object can be added to a popup menu or a toolbar and keep the state of the menu item and
* the toolbar button synchronized.
*
* For example, if the user clicks the menu item of a toggle action then the toolbar button gets also pressed
* and vice versa. For more details refer to your Qt documentation.
*
* \section Drawbacks
* Since QAction inherits QObject and emits the \a triggered() signal or \a toggled() signal for toggle actions it is very convenient to connect
* these signals e.g. with slots of your MainWindow class. But this means that for every action an appropriate slot of MainWindow is necessary
* and leads to an inflated MainWindow class. Furthermore, it's simply impossible to provide plugins that may also need special slots -- without
* changing the MainWindow class.
*
* \section wayout Way out
* To solve these problems we have introduced the command framework to decouple QAction and MainWindow. The base classes of the framework are
* \a Gui::CommandBase and \a Gui::Action that represent the link between Qt's QAction world and the FreeCAD's command world.
*
* The Action class holds a pointer to QAction and CommandBase and acts as a mediator and -- to save memory -- that gets created
* (@ref Gui::CommandBase::createAction()) not before it is added (@ref Gui::Command::addTo()) to a menu or toolbar.
*
* Now, the implementation of the slots of MainWindow can be done in the method \a activated() of subclasses of Command instead.
*
* For example, the implementation of the "Open file" command can be done as follows.
* \code
* class OpenCommand : public Command
* {
* public:
* OpenCommand() : Command("Std_Open")
* {
* // set up menu text, status tip, ...
* sMenuText = "&Open";
* sToolTipText = "Open a file";
* sWhatsThis = "Open a file";
* sStatusTip = "Open a file";
* sPixmap = "Open"; // name of a registered pixmap
* sAccel = "Shift+P"; // or "P" or "P, L" or "Ctrl+X, Ctrl+C" for a sequence
* }
* protected:
* void activated(int)
* {
* QString filter ... // make a filter of all supported file formats
* QStringList FileList = QFileDialog::getOpenFileNames( filter,QString(), getMainWindow() );
* for ( QStringList::Iterator it = FileList.begin(); it != FileList.end(); ++it ) {
* getGuiApplication()->open((*it).latin1());
* }
* }
* };
* \endcode
* An instance of \a OpenCommand must be created and added to the \ref Gui::CommandManager to make the class known to FreeCAD.
* To see how menus and toolbars can be built go to the @ref workbench.
*
* @see Gui::Command, Gui::CommandManager
*/
// list of modules already loaded by a command (not issue again for macro cleanness)
std::set<std::string> alreadyLoadedModule;
class StringCache {
public:
static const char* New(const char* str) {
using StringList = std::list<std::string>;
static StringList strings;
strings.emplace_back(str);
return strings.back().c_str();
}
};
CommandBase::CommandBase(const char* sMenu, const char* sToolTip, const char* sWhat,
const char* sStatus, const char* sPixmap, const char* sAcc)
: sMenuText(sMenu)
, sToolTipText(sToolTip)
, sWhatsThis(sWhat ? sWhat : sToolTip)
, sStatusTip(sStatus ? sStatus : sToolTip)
, sPixmap(sPixmap)
, sAccel(sAcc)
, _pcAction(nullptr)
{
}
CommandBase::~CommandBase()
{
//Note: The Action object becomes a children of MainWindow which gets destroyed _before_ the
//command manager hence before any command object. So the action pointer is a dangling pointer
//at this state.
}
Action* CommandBase::getAction() const
{
return _pcAction;
}
Action * CommandBase::createAction()
{
// does nothing
return 0;
}
void CommandBase::setMenuText(const char* s)
{
this->sMenuText = StringCache::New(s);
}
void CommandBase::setToolTipText(const char* s)
{
this->sToolTipText = StringCache::New(s);
}
void CommandBase::setStatusTip(const char* s)
{
this->sStatusTip = StringCache::New(s);
}
void CommandBase::setWhatsThis(const char* s)
{
this->sWhatsThis = StringCache::New(s);
}
void CommandBase::setPixmap(const char* s)
{
this->sPixmap = StringCache::New(s);
}
void CommandBase::setAccel(const char* s)
{
this->sAccel = StringCache::New(s);
}
//===========================================================================
// Command
//===========================================================================
/* TRANSLATOR Gui::Command */
Command::Command(const char* name)
: CommandBase(nullptr)
, sName(name)
, sHelpUrl(0)
{
sAppModule = "FreeCAD";
sGroup = QT_TR_NOOP("Standard");
eType = AlterDoc | Alter3DView | AlterSelection;
bEnabled = true;
bCanLog = true;
}
Command::~Command()
{
}
bool Command::isViewOfType(Base::Type t) const
{
Gui::Document *d = getGuiApplication()->activeDocument();
if (!d) return false;
Gui::BaseView *v = d->getActiveView();
if (!v) return false;
if (v->getTypeId().isDerivedFrom(t))
return true;
else
return false;
}
void Command::addTo(QWidget *pcWidget)
{
if (!_pcAction) {
_pcAction = createAction();
testActive();
}
_pcAction->addTo(pcWidget);
}
void Command::addToGroup(ActionGroup* group, bool checkable)
{
addToGroup(group);
_pcAction->setCheckable(checkable);
}
void Command::addToGroup(ActionGroup* group)
{
if (!_pcAction) {
_pcAction = createAction();
testActive();
}
group->addAction(_pcAction->findChild<QAction*>());
}
Application *Command::getGuiApplication(void)
{
return Application::Instance;
}
Gui::Document* Command::getActiveGuiDocument(void) const
{
return getGuiApplication()->activeDocument();
}
App::Document* Command::getDocument(const char* Name) const
{
if (Name) {
return App::GetApplication().getDocument(Name);
}
else {
Gui::Document * pcDoc = getGuiApplication()->activeDocument();
if (pcDoc)
return pcDoc->getDocument();
else
return 0l;
}
}
App::DocumentObject* Command::getObject(const char* Name) const
{
App::Document*pDoc = getDocument();
if (pDoc)
return pDoc->getObject(Name);
else
return 0;
}
int Command::_busy;
class PendingLine {
public:
PendingLine(MacroManager::LineType type, const char *line) {
Application::Instance->macroManager()->addLine(type,line,true);
}
~PendingLine() {
cancel();
}
void cancel() {
Application::Instance->macroManager()->addLine(MacroManager::Cmt,0,true);
}
};
class CommandTrigger {
public:
CommandTrigger(Command::TriggerSource &trigger, Command::TriggerSource source)
:trigger(trigger),saved(trigger)
{
trigger = source;
}
~CommandTrigger() {
trigger = saved;
}
private:
Command::TriggerSource &trigger;
Command::TriggerSource saved;
};
void Command::setupCheckable(int iMsg) {
QAction *action = 0;
Gui::ActionGroup* pcActionGroup = qobject_cast<Gui::ActionGroup*>(_pcAction);
if(pcActionGroup) {
QList<QAction*> a = pcActionGroup->actions();
assert(iMsg < a.size());
action = a[iMsg];
}else
action = _pcAction->action();
if(!action)
return;
bool checkable = action->isCheckable();
_pcAction->setCheckable(checkable);
if(checkable) {
bool checked = false;
switch(triggerSource()) {
case TriggerNone:
checked = !action->isChecked();
break;
case TriggerAction:
checked = _pcAction->isChecked();
break;
case TriggerChildAction:
checked = action->isChecked();
break;
}
bool blocked = action->blockSignals(true);
action->setChecked(checked);
action->blockSignals(blocked);
if(action!=_pcAction->action())
_pcAction->setChecked(checked,true);
}
}
void Command::invoke(int i, TriggerSource trigger)
{
CommandTrigger cmdTrigger(_trigger,trigger);
if (displayText.empty()) {
displayText = getMenuText();
boost::replace_all(displayText,"&","");
if (displayText.empty())
displayText = getName();
}
// Do not query _pcAction since it isn't created necessarily
#ifdef FC_LOGUSERACTION
Base::Console().Log("CmdG: %s\n",sName);
#endif
_invoke(i, bCanLog && !_busy);
}
void Command::_invoke(int id, bool disablelog)
{
try {
// Because Transaction now captures ViewObject changes, auto named
// transaction is disabled here to avoid too many unnecessary transactions.
//
App::AutoTransaction committer(nullptr, true);
// set the application module type for the macro
getGuiApplication()->macroManager()->setModule(sAppModule);
std::unique_ptr<LogDisabler> logdisabler;
if (disablelog)
logdisabler.reset(new LogDisabler);
// check if it really works NOW (could be a delay between click deactivation of the button)
if (isActive()) {
auto manager = getGuiApplication()->macroManager();
auto editDoc = getGuiApplication()->editDocument();
if (!logdisabler) {
activated(id);
}
else {
Gui::SelectionLogDisabler seldisabler;
auto lines = manager->getLines();
std::ostringstream ss;
ss << "### Begin command " << sName;
// Add a pending line to mark the start of a command
PendingLine pending(MacroManager::Cmt, ss.str().c_str());
ss.str("");
activated(id);
if (manager->getLines() == lines) {
// This command does not record any lines, lets do it for
// it. The above LogDisabler is to prevent nested command
// logging, i.e. we only auto log the first invoking
// command.
// Cancel the above pending line first
pending.cancel();
ss << "Gui.runCommand('" << sName << "'," << id << ')';
manager->addLine(MacroManager::Gui, ss.str().c_str());
}
else {
// In case the command has any output to the console, lets
// mark the end of the command here
ss << "### End command " << sName;
manager->addLine(MacroManager::Cmt, ss.str().c_str());
}
}
getMainWindow()->updateActions();
// If this command starts an editing, let the transaction persist
if (!editDoc && getGuiApplication()->editDocument())
committer.setEnable(false);
}
}
catch (const Base::SystemExitException&) {
throw;
}
catch (Base::PyException &e) {
e.ReportException();
}
catch (Py::Exception&) {
Base::PyGILStateLocker lock;
Base::PyException e;
e.ReportException();
}
catch (Base::AbortException&) {
}
catch (Base::Exception &e) {
e.ReportException();
// Pop-up a dialog for FreeCAD-specific exceptions
QMessageBox::critical(Gui::getMainWindow(), QObject::tr("Exception"), QLatin1String(e.what()));
}
catch (std::exception &e) {
Base::Console().Error("C++ exception thrown (%s)\n", e.what());
}
catch (const char* e) {
Base::Console().Error("%s\n", e);
}
#ifndef FC_DEBUG
catch (...) {
Base::Console().Error("Gui::Command::activated(%d): Unknown C++ exception thrown\n", id);
}
#endif
}
void Command::testActive(void)
{
if (!_pcAction)
return;
if (_blockCmd || !bEnabled) {
_pcAction->setEnabled(false);
return;
}
if (!(eType & ForEdit)) { // special case for commands which are only in some edit modes active
if ((!Gui::Control().isAllowedAlterDocument() && eType & AlterDoc) ||
(!Gui::Control().isAllowedAlterView() && eType & Alter3DView) ||
(!Gui::Control().isAllowedAlterSelection() && eType & AlterSelection)) {
_pcAction->setEnabled(false);
return;
}
}
Gui::ActionGroup* pcAction = qobject_cast<Gui::ActionGroup*>(_pcAction);
if(pcAction) {
Gui::CommandManager &rcCmdMgr = Gui::Application::Instance->commandManager();
for(auto action : pcAction->actions()) {
auto name = action->property("CommandName").toByteArray();
if(!name.size())
continue;
Command* cmd = rcCmdMgr.getCommandByName(name);
if(cmd)
action->setEnabled(cmd->isActive());
}
}
bool bActive = isActive();
_pcAction->setEnabled(bActive);
}
void Command::setEnabled(bool on)
{
if (_pcAction) {
bEnabled = on;
_pcAction->setEnabled(on);
}
}
//--------------------------------------------------------------------------
// Helper methods
//--------------------------------------------------------------------------
bool Command::hasActiveDocument(void) const
{
return getActiveGuiDocument() != 0;
}
/// true when there is a document and a Feature with Name
bool Command::hasObject(const char* Name)
{
return getDocument() != 0 && getDocument()->getObject(Name) != 0;
}
Gui::SelectionSingleton& Command::getSelection(void)
{
return Gui::Selection();
}
std::string Command::getUniqueObjectName(const char *BaseName, const App::DocumentObject *obj) const
{
auto doc = obj?obj->getDocument():App::GetApplication().getActiveDocument();
assert(doc);
return doc->getUniqueObjectName(BaseName);
}
std::string Command::getObjectCmd(const char *Name, const App::Document *doc,
const char *prefix, const char *postfix, bool gui)
{
if(!doc) doc = App::GetApplication().getActiveDocument();
if(!doc || !Name)
return std::string("None");
std::ostringstream str;
if(prefix)
str << prefix;
str << (gui?"Gui":"App") << ".getDocument('" << doc->getName()
<< "').getObject('" << Name << "')";
if(postfix)
str << postfix;
return str.str();
}
std::string Command::getObjectCmd(const App::DocumentObject *obj,
const char *prefix, const char *postfix, bool gui)
{
if(!obj || !obj->getNameInDocument())
return std::string("None");
return getObjectCmd(obj->getNameInDocument(), obj->getDocument(), prefix, postfix,gui);
}
void Command::setAppModuleName(const char* s)
{
this->sAppModule = StringCache::New(s);
}
void Command::setGroupName(const char* s)
{
this->sGroup = StringCache::New(s);
}
//--------------------------------------------------------------------------
// UNDO REDO transaction handling
//--------------------------------------------------------------------------
/** Open a new Undo transaction on the active document
* This method opens a new UNDO transaction on the active document. This transaction
* will later appear in the UNDO REDO dialog with the name of the command. If the user
* recall the transaction everything changed on the document between OpenCommand() and
* CommitCommand will be undone (or redone). You can use an alternative name for the
* operation default is the Command name.
* @see CommitCommand(),AbortCommand()
*/
void Command::openCommand(const char* sCmdName)
{
if (!sCmdName)
sCmdName = "Command";
App::GetApplication().setActiveTransaction(sCmdName);
}
void Command::commitCommand(void)
{
App::GetApplication().closeActiveTransaction();
}
void Command::abortCommand(void)
{
App::GetApplication().closeActiveTransaction(true);
}
bool Command::hasPendingCommand(void)
{
return !!App::GetApplication().getActiveTransaction();
}
bool Command::_blockCmd = false;
void Command::blockCommand(bool block)
{
Command::_blockCmd = block;
}
/// Run a App level Action
void Command::_doCommand(const char *file, int line, DoCmd_Type eType, const char* sCmd, ...)
{
va_list ap;
va_start(ap, sCmd);
QString s;
#if QT_VERSION < QT_VERSION_CHECK(5, 14, 0)
const QString cmd = s.vsprintf(sCmd, ap);
#else
const QString cmd = s.vasprintf(sCmd, ap);
#endif
va_end(ap);
// 'vsprintf' expects a utf-8 string for '%s'
QByteArray format = cmd.toUtf8();
#ifdef FC_LOGUSERACTION
Base::Console().Log("CmdC: %s\n", format.constData());
#endif
_runCommand(file,line,eType,format.constData());
}
void Command::printPyCaller() {
if(!FC_LOG_INSTANCE.isEnabled(FC_LOGLEVEL_LOG))
return;
PyFrameObject* frame = PyEval_GetFrame();
if(!frame)
return;
int line = PyFrame_GetLineNumber(frame);
const char *file = PyUnicode_AsUTF8(frame->f_code->co_filename);
printCaller(file?file:"<no file>",line);
}
void Command::printCaller(const char *file, int line) {
if(!FC_LOG_INSTANCE.isEnabled(FC_LOGLEVEL_LOG))
return;
std::ostringstream str;
#ifdef FC_OS_WIN32
const char *_f = std::strstr(file, "\\src\\");
#else
const char *_f = std::strstr(file, "/src/");
#endif
str << "## " << (_f?_f+5:file)<<'('<<line<<')';
Gui::Application::Instance->macroManager()->addLine(MacroManager::Cmt,str.str().c_str());
}
/// Run a App level Action
void Command::_runCommand(const char *file, int line, DoCmd_Type eType, const char* sCmd)
{
LogDisabler d1;
SelectionLogDisabler d2;
Base::PyGILStateLocker lock;
printCaller(file,line);
if (eType == Gui)
Gui::Application::Instance->macroManager()->addLine(MacroManager::Gui,sCmd);
else
Gui::Application::Instance->macroManager()->addLine(MacroManager::App,sCmd);
try {
Base::Interpreter().runString(sCmd);
}
catch(Py::Exception &) {
Base::PyException::ThrowException();
}
}
/// Run a App level Action
void Command::_runCommand(const char *file, int line, DoCmd_Type eType, const QByteArray& sCmd)
{
_runCommand(file,line,eType,sCmd.constData());
}
void Command::addModule(DoCmd_Type eType,const char* sModuleName)
{
if(alreadyLoadedModule.find(sModuleName) == alreadyLoadedModule.end()) {
LogDisabler d1;
SelectionLogDisabler d2;
std::string sCmd("import ");
sCmd += sModuleName;
if (eType == Gui)
Gui::Application::Instance->macroManager()->addLine(MacroManager::Gui,sCmd.c_str());
else
Gui::Application::Instance->macroManager()->addLine(MacroManager::App,sCmd.c_str());
Base::Interpreter().runString(sCmd.c_str());
alreadyLoadedModule.insert(sModuleName);
}
}
std::string Command::_assureWorkbench(const char *file, int line, const char * sName)
{
// check if the WB is already open?
std::string actName = WorkbenchManager::instance()->active()->name();
// if yes, do nothing
if(actName == sName)
return actName;
// else - switch to new WB
_doCommand(file,line,Gui,"Gui.activateWorkbench('%s')",sName);
return actName;
}
void Command::_copyVisual(const char *file, int line, const char* to, const char* attr, const char* from)
{
_copyVisual(file,line,to,attr,from,attr);
}
void Command::_copyVisual(const char *file, int line, const char* to, const char* attr_to, const char* from, const char* attr_from)
{
auto doc = App::GetApplication().getActiveDocument();
if(!doc)
return;
return _copyVisual(file,line,doc->getObject(to),attr_to,
doc->getObject(from),attr_from);
}
void Command::_copyVisual(const char *file, int line, const App::DocumentObject *to, const char* attr_to, const App::DocumentObject *from, const char *attr_from)
{
if(!from || !from->getNameInDocument() || !to || !to->getNameInDocument())
return;
static std::map<std::string,std::string> attrMap = {
{"ShapeColor","ShapeMaterial.DiffuseColor"},
// {"LineColor","ShapeMaterial.DiffuseColor"},
// {"PointColor","ShapeMaterial.DiffuseColor"},
{"Transparency","Transparency"},
};
auto it = attrMap.find(attr_to);
auto objCmd = getObjectCmd(to);
if(it!=attrMap.end()) {
auto obj = from;
for(int depth=0;;++depth) {
auto vp = dynamic_cast<Gui::ViewProviderLink*>(
Gui::Application::Instance->getViewProvider(obj));
if(vp && vp->OverrideMaterial.getValue()) {
_doCommand(file,line,Gui,"%s.ViewObject.%s=%s.ViewObject.%s",
objCmd.c_str(),attr_to,getObjectCmd(obj).c_str(),it->second.c_str());
return;
}
auto linked = obj->getLinkedObject(false,0,false,depth);
if(!linked || linked==obj)
break;
obj = linked;
}
}
try {
_doCommand(file,line,Gui,
"%s.ViewObject.%s=getattr(%s.getLinkedObject(True).ViewObject,'%s',%s.ViewObject.%s)",
objCmd.c_str(),attr_to,getObjectCmd(from).c_str(),attr_from,objCmd.c_str(),attr_to);
}
catch(Base::Exception& /*e*/) {
// e.ReportException();
}
}
void Command::_copyVisual(const char *file, int line, const App::DocumentObject *to, const char* attr, const App::DocumentObject *from)
{
_copyVisual(file,line,to,attr,from,attr);
}
std::string Command::getPythonTuple(const std::string& name, const std::vector<std::string>& subnames)
{
std::stringstream str;
std::vector<std::string>::const_iterator last = --subnames.end();
str << "(App.ActiveDocument." << name << ",[";
for (std::vector<std::string>::const_iterator it = subnames.begin();it!=subnames.end();++it){
str << "\"" << *it << "\"";
if (it != last)
str << ",";
}
str << "])";
return str.str();
}
const std::string Command::strToPython(const char* Str)
{
return Base::InterpreterSingleton::strToPython(Str);
}
/// Updates the (active) document (propagate changes)
void Command::updateActive(void)
{
WaitCursor wc;
doCommand(App,"App.ActiveDocument.recompute()");
}
bool Command::isActiveObjectValid(void)
{
Gui::Document* active = Gui::Application::Instance->activeDocument();
assert(active);
App::Document* document = active->getDocument();
App::DocumentObject* object = document->getActiveObject();
assert(object);
return object->isValid();
}
/// Updates the (all or listed) documents (propagate changes)
void Command::updateAll(std::list<Gui::Document*> cList)
{
if (cList.size()>0) {
for (std::list<Gui::Document*>::iterator It= cList.begin();It!=cList.end();++It)
(*It)->onUpdate();
}
else {
Gui::Application::Instance->onUpdate();
}
}
//--------------------------------------------------------------------------
// Online help handling
//--------------------------------------------------------------------------
/// returns the begin of a online help page
const char * Command::beginCmdHelp(void)
{
return "<!DOCTYPE HTML PUBLIC \"-//W3C//DTD HTML 4.0 Transitional//EN\">\n"
"<html>\n"
"<head>\n"
"<meta http-equiv=\"Content-Type\" content=\"text/html; charset=ISO-8859-1\">\n"
"<title>FreeCAD Main Index</title>\n"
"</head>\n"
"<body bgcolor=\"#ffffff\">\n\n";
}
/// returns the end of a online help page
const char * Command::endCmdHelp(void)
{
return "</body></html>\n\n";
}
void Command::recreateTooltip(const char* context, Action* action)
{
QString tooltip;
tooltip.append(QString::fromLatin1("<h3>"));
tooltip.append(QCoreApplication::translate(
context, getMenuText()));
tooltip.append(QString::fromLatin1("</h3>"));
QRegularExpression re(QString::fromLatin1("([^&])&([^&])"));
tooltip.replace(re, QString::fromLatin1("\\1\\2"));
tooltip.replace(QString::fromLatin1("&&"), QString::fromLatin1("&"));
tooltip.append(QCoreApplication::translate(
context, getToolTipText()));
tooltip.append(QString::fromLatin1("<br><i>("));
tooltip.append(QCoreApplication::translate(
context, getWhatsThis()));
tooltip.append(QString::fromLatin1(")</i> "));
action->setToolTip(tooltip);
QString accel = action->shortcut().toString(QKeySequence::NativeText);
if (!accel.isEmpty()) {
// show shortcut inside tooltip
QString ttip = QString::fromLatin1("%1 (%2)")
.arg(action->toolTip(), accel);
action->setToolTip(ttip);
// show shortcut inside status tip
QString stip = QString::fromLatin1("(%1)\t%2")
.arg(accel, action->statusTip());
action->setStatusTip(stip);
}
if (sStatusTip)
action->setStatusTip(QCoreApplication::translate(
context, getStatusTip()));
else
action->setStatusTip(QCoreApplication::translate(
context, getToolTipText()));
}
void Command::applyCommandData(const char* context, Action* action)
{
action->setText(QCoreApplication::translate(
context, getMenuText()));
recreateTooltip(context, action);
action->setWhatsThis(QCoreApplication::translate(
context, getWhatsThis()));
}
const char* Command::keySequenceToAccel(int sk) const
{
/* Local class to ensure free()'ing the strings allocated below */
typedef std::map<int, std::string> StringMap;
static StringMap strings;
StringMap::iterator i = strings.find(sk);
if (i != strings.end())
return i->second.c_str();
QKeySequence::StandardKey type = (QKeySequence::StandardKey)sk;
QKeySequence ks(type);
QString qs = ks.toString();
QByteArray data = qs.toLatin1();
return (strings[sk] = static_cast<const char*>(data)).c_str();
}
void Command::adjustCameraPosition()
{
Gui::Document* doc = Gui::Application::Instance->activeDocument();
if (doc) {
Gui::View3DInventor* view = static_cast<Gui::View3DInventor*>(doc->getActiveView());
Gui::View3DInventorViewer* viewer = view->getViewer();
SoCamera* camera = viewer->getSoRenderManager()->getCamera();
if (!camera || !camera->isOfType(SoOrthographicCamera::getClassTypeId()))
return;
// get scene bounding box
SoGetBoundingBoxAction action(viewer->getSoRenderManager()->getViewportRegion());
action.apply(viewer->getSceneGraph());
SbBox3f box = action.getBoundingBox();
if (box.isEmpty()) return;
// get cirumscribing sphere and check if camera is inside
SbVec3f cam_pos = camera->position.getValue();
SbVec3f box_cnt = box.getCenter();
SbSphere bs;
bs.circumscribe(box);
float radius = bs.getRadius();
float distance_to_midpoint = (box_cnt-cam_pos).length();
if (radius >= distance_to_midpoint) {
// Move the camera to the edge of the bounding sphere, while still
// pointing at the scene.
SbVec3f direction = cam_pos - box_cnt;
(void) direction.normalize(); // we know this is not a null vector
camera->position.setValue(box_cnt + direction * radius);
// New distance to mid point
distance_to_midpoint =
(camera->position.getValue() - box.getCenter()).length();
camera->nearDistance = distance_to_midpoint - radius;
camera->farDistance = distance_to_midpoint + radius;
camera->focalDistance = distance_to_midpoint;
}
}
}
void Command::printConflictingAccelerators() const
{
auto cmd = Application::Instance->commandManager().checkAcceleratorForConflicts(sAccel, this);
if (cmd)
Base::Console().Warning("Accelerator conflict between %s (%s) and %s (%s)\n", sName, sAccel, cmd->sName, cmd->sAccel);
}
Action * Command::createAction(void)
{
Action *pcAction;
pcAction = new Action(this,getMainWindow());
#ifdef FC_DEBUG
printConflictingAccelerators();
#endif
pcAction->setShortcut(QString::fromLatin1(sAccel));
applyCommandData(this->className(), pcAction);
if (sPixmap)
pcAction->setIcon(Gui::BitmapFactory().iconFromTheme(sPixmap));
return pcAction;
}
void Command::languageChange()
{
if (_pcAction) {
applyCommandData(this->className(), _pcAction);
}
}
void Command::updateAction(int)
{
}
//===========================================================================
// GroupCommand
//===========================================================================
GroupCommand::GroupCommand(const char *name)
:Command(name)
{}