Files
create/src/Gui/Command.cpp
2015-09-02 22:52:04 +02:00

1396 lines
46 KiB
C++

/***************************************************************************
* 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 <QDir>
# include <QKeySequence>
# include <QMessageBox>
# include <Inventor/actions/SoGetBoundingBoxAction.h>
# include <Inventor/nodes/SoOrthographicCamera.h>
# include <Inventor/nodes/SoPerspectiveCamera.h>
#endif
#include "Command.h"
#include "Action.h"
#include "Application.h"
#include "Document.h"
#include "Selection.h"
#include "HelpView.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 <App/Document.h>
#include <App/DocumentObject.h>
using Base::Interpreter;
using namespace Gui;
using namespace Gui::Dialog;
using namespace Gui::DockWnd;
/** \defgroup commands Command Framework
\ingroup GUI
* \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::null, 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;
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(0)
{
}
CommandBase::~CommandBase()
{
//Note: The Action object becomes a children of MainWindow which gets destoyed _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)
{
#if defined (_MSC_VER)
this->sMenuText = _strdup(s);
#else
this->sMenuText = strdup(s);
#endif
}
void CommandBase::setToolTipText(const char* s)
{
#if defined (_MSC_VER)
this->sToolTipText = _strdup(s);
#else
this->sToolTipText = strdup(s);
#endif
}
void CommandBase::setStatusTip(const char* s)
{
#if defined (_MSC_VER)
this->sStatusTip = _strdup(s);
#else
this->sStatusTip = strdup(s);
#endif
}
void CommandBase::setWhatsThis(const char* s)
{
#if defined (_MSC_VER)
this->sWhatsThis = _strdup(s);
#else
this->sWhatsThis = strdup(s);
#endif
}
void CommandBase::setPixmap(const char* s)
{
#if defined (_MSC_VER)
this->sPixmap = _strdup(s);
#else
this->sPixmap = strdup(s);
#endif
}
void CommandBase::setAccel(const char* s)
{
#if defined (_MSC_VER)
this->sAccel = _strdup(s);
#else
this->sAccel = strdup(s);
#endif
}
//===========================================================================
// Command
//===========================================================================
/* TRANSLATOR Gui::Command */
Command::Command(const char* name)
: CommandBase(0), sName(name), sHelpUrl(0)
{
sAppModule = "FreeCAD";
sGroup = QT_TR_NOOP("Standard");
eType = AlterDoc | Alter3DView | AlterSelection;
}
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();
_pcAction->addTo(pcWidget);
}
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;
}
void Command::invoke(int i)
{
// Do not query _pcAction since it isn't created necessarily
#ifdef FC_LOGUSERACTION
Base::Console().Log("CmdG: %s\n",sName);
#endif
// set the application module type for the macro
getGuiApplication()->macroManager()->setModule(sAppModule);
try {
// check if it really works NOW (could be a delay between click deactivation of the button)
if (isActive())
activated( i );
}
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", i);
}
#endif
}
void Command::testActive(void)
{
if (!_pcAction) return;
if (_blockCmd) {
_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;
}
bool bActive = isActive();
_pcAction->setEnabled(bActive);
}
//--------------------------------------------------------------------------
// 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
{
assert(hasActiveDocument());
return getActiveGuiDocument()->getDocument()->getUniqueObjectName(BaseName);
}
//--------------------------------------------------------------------------
// 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 apear 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 alternetive name for the
* operation default is the Command name.
* @see CommitCommand(),AbortCommand()
*/
void Command::openCommand(const char* sCmdName)
{
// Using OpenCommand with no active document !
assert(Gui::Application::Instance->activeDocument());
if (sCmdName)
Gui::Application::Instance->activeDocument()->openCommand(sCmdName);
else
Gui::Application::Instance->activeDocument()->openCommand("Command");
}
void Command::commitCommand(void)
{
Gui::Application::Instance->activeDocument()->commitCommand();
}
void Command::abortCommand(void)
{
Gui::Application::Instance->activeDocument()->abortCommand();
}
bool Command::hasPendingCommand(void)
{
return Gui::Application::Instance->activeDocument()->hasPendingCommand();
}
bool Command::_blockCmd = false;
void Command::blockCommand(bool block)
{
Command::_blockCmd = block;
}
/// Run a App level Action
void Command::doCommand(DoCmd_Type eType,const char* sCmd,...)
{
// temp buffer
size_t format_len = std::strlen(sCmd)+4024;
char* format = (char*) malloc(format_len);
va_list namelessVars;
va_start(namelessVars, sCmd); // Get the "..." vars
vsnprintf(format, format_len, sCmd, namelessVars);
va_end(namelessVars);
if (eType == Gui)
Gui::Application::Instance->macroManager()->addLine(MacroManager::Gui,format);
else
Gui::Application::Instance->macroManager()->addLine(MacroManager::App,format);
try {
Base::Interpreter().runString(format);
}
catch (...) {
// free memory to avoid a leak if an exception occurred
free (format);
throw;
}
#ifdef FC_LOGUSERACTION
Base::Console().Log("CmdC: %s\n",format);
#endif
free (format);
}
/// Run a App level Action
void Command::runCommand(DoCmd_Type eType,const char* sCmd)
{
if (eType == Gui)
Gui::Application::Instance->macroManager()->addLine(MacroManager::Gui,sCmd);
else
Gui::Application::Instance->macroManager()->addLine(MacroManager::App,sCmd);
Base::Interpreter().runString(sCmd);
}
void Command::addModule(DoCmd_Type eType,const char* sModuleName)
{
if(alreadyLoadedModule.find(sModuleName) == alreadyLoadedModule.end()) {
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 * 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(Gui,"Gui.activateWorkbench('%s')",sName);
return actName;
}
void Command::copyVisual(const char* to, const char* attr, const char* from)
{
doCommand(Gui,"Gui.ActiveDocument.%s.%s=Gui.ActiveDocument.%s.%s", to, attr, from, attr);
}
void Command::copyVisual(const char* to, const char* attr_to, const char* from, const char* attr_from)
{
doCommand(Gui,"Gui.ActiveDocument.%s.%s=Gui.ActiveDocument.%s.%s", to, attr_to, from, attr_from);
}
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::applyCommandData(const char* context, Action* action)
{
action->setText(QCoreApplication::translate(
context, getMenuText(), 0,
QCoreApplication::UnicodeUTF8));
action->setToolTip(QCoreApplication::translate(
context, getToolTipText(), 0,
QCoreApplication::UnicodeUTF8));
if (sStatusTip)
action->setStatusTip(QCoreApplication::translate(
context, getStatusTip(), 0,
QCoreApplication::UnicodeUTF8));
else
action->setStatusTip(QCoreApplication::translate(
context, getToolTipText(), 0,
QCoreApplication::UnicodeUTF8));
if (sWhatsThis)
action->setWhatsThis(QCoreApplication::translate(
context, getWhatsThis(), 0,
QCoreApplication::UnicodeUTF8));
else
action->setWhatsThis(QCoreApplication::translate(
context, getToolTipText(), 0,
QCoreApplication::UnicodeUTF8));
QString accel = action->shortcut().toString(QKeySequence::NativeText);
if (!accel.isEmpty()) {
// show shortcut inside tooltip
QString ttip = QString::fromLatin1("%1 (%2)")
.arg(action->toolTip()).arg(accel);
action->setToolTip(ttip);
// show shortcut inside status tip
QString stip = QString::fromLatin1("(%1)\t%2")
.arg(accel).arg(action->statusTip());
action->setStatusTip(stip);
}
}
const char* Command::keySequenceToAccel(int sk) const
{
QKeySequence::StandardKey type = (QKeySequence::StandardKey)sk;
QKeySequence ks(type);
QString qs = ks.toString();
QByteArray data = qs.toAscii();
#if defined (_MSC_VER)
return _strdup((const char*)data);
#else
return strdup((const char*)data);
#endif
}
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;
}
}
}
Action * Command::createAction(void)
{
Action *pcAction;
pcAction = new Action(this,getMainWindow());
pcAction->setShortcut(QString::fromAscii(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)
{
}
//===========================================================================
// MacroCommand
//===========================================================================
/* TRANSLATOR Gui::MacroCommand */
MacroCommand::MacroCommand(const char* name)
#if defined (_MSC_VER)
: Command( _strdup(name) )
#else
: Command( strdup(name) )
#endif
{
sGroup = QT_TR_NOOP("Macros");
eType = 0;
}
void MacroCommand::activated(int iMsg)
{
std::string cMacroPath = App::GetApplication().GetParameterGroupByPath
("User parameter:BaseApp/Preferences/Macro")->GetASCII("MacroPath",
App::Application::getUserAppDataDir().c_str());
QDir d(QString::fromUtf8(cMacroPath.c_str()));
QFileInfo fi(d, QString::fromUtf8(sScriptName));
Application::Instance->macroManager()->run(MacroManager::File, fi.filePath().toUtf8());
// after macro run recalculate the document
if (Application::Instance->activeDocument())
Application::Instance->activeDocument()->getDocument()->recompute();
}
Action * MacroCommand::createAction(void)
{
Action *pcAction;
pcAction = new Action(this,getMainWindow());
pcAction->setText(QString::fromUtf8(sMenuText));
pcAction->setToolTip(QString::fromUtf8(sToolTipText));
pcAction->setStatusTip(QString::fromUtf8(sStatusTip));
if (pcAction->statusTip().isEmpty())
pcAction->setStatusTip(pcAction->toolTip());
pcAction->setWhatsThis(QString::fromUtf8(sWhatsThis));
if (sPixmap)
pcAction->setIcon(Gui::BitmapFactory().pixmap(sPixmap));
pcAction->setShortcut(QString::fromAscii(sAccel));
QString accel = pcAction->shortcut().toString(QKeySequence::NativeText);
if (!accel.isEmpty()) {
// show shortcut inside tooltip
QString ttip = QString::fromLatin1("%1 (%2)")
.arg(pcAction->toolTip()).arg(accel);
pcAction->setToolTip(ttip);
// show shortcut inside status tip
QString stip = QString::fromLatin1("(%1)\t%2")
.arg(accel).arg(pcAction->statusTip());
pcAction->setStatusTip(stip);
}
return pcAction;
}
void MacroCommand::setScriptName( const char* s )
{
#if defined (_MSC_VER)
this->sScriptName = _strdup( s );
#else
this->sScriptName = strdup( s );
#endif
}
void MacroCommand::load()
{
ParameterGrp::handle hGrp = App::GetApplication().GetParameterGroupByPath("User parameter:BaseApp/Macro");
if (hGrp->HasGroup("Macros")) {
hGrp = hGrp->GetGroup("Macros");
std::vector<Base::Reference<ParameterGrp> > macros = hGrp->GetGroups();
for (std::vector<Base::Reference<ParameterGrp> >::iterator it = macros.begin(); it!=macros.end(); ++it ) {
MacroCommand* macro = new MacroCommand((*it)->GetGroupName());
macro->setScriptName ( (*it)->GetASCII( "Script" ).c_str() );
macro->setMenuText ( (*it)->GetASCII( "Menu" ).c_str() );
macro->setToolTipText ( (*it)->GetASCII( "Tooltip" ).c_str() );
macro->setWhatsThis ( (*it)->GetASCII( "WhatsThis" ).c_str() );
macro->setStatusTip ( (*it)->GetASCII( "Statustip" ).c_str() );
if ((*it)->GetASCII("Pixmap", "nix") != "nix")
macro->setPixmap ( (*it)->GetASCII( "Pixmap" ).c_str() );
macro->setAccel ( (*it)->GetASCII( "Accel",0 ).c_str() );
Application::Instance->commandManager().addCommand( macro );
}
}
}
void MacroCommand::save()
{
ParameterGrp::handle hGrp = App::GetApplication().GetParameterGroupByPath("User parameter:BaseApp/Macro")->GetGroup("Macros");
hGrp->Clear();
std::vector<Command*> macros = Application::Instance->commandManager().getGroupCommands("Macros");
if ( macros.size() > 0 ) {
for (std::vector<Command*>::iterator it = macros.begin(); it!=macros.end(); ++it ) {
MacroCommand* macro = (MacroCommand*)(*it);
ParameterGrp::handle hMacro = hGrp->GetGroup(macro->getName());
hMacro->SetASCII( "Script", macro->getScriptName () );
hMacro->SetASCII( "Menu", macro->getMenuText () );
hMacro->SetASCII( "Tooltip", macro->getToolTipText() );
hMacro->SetASCII( "WhatsThis", macro->getWhatsThis () );
hMacro->SetASCII( "Statustip", macro->getStatusTip () );
hMacro->SetASCII( "Pixmap", macro->getPixmap () );
hMacro->SetASCII( "Accel", macro->getAccel () );
}
}
}
//===========================================================================
// PythonCommand
//===========================================================================
PythonCommand::PythonCommand(const char* name, PyObject * pcPyCommand, const char* pActivationString)
: Command(name),_pcPyCommand(pcPyCommand)
{
if (pActivationString)
Activation = pActivationString;
sGroup = "Python";
Py_INCREF(_pcPyCommand);
// call the method "GetResources()" of the command object
_pcPyResourceDict = Interpreter().runMethodObject(_pcPyCommand, "GetResources");
// check if the "GetResources()" method returns a Dict object
if (!PyDict_Check(_pcPyResourceDict)) {
throw Base::Exception("PythonCommand::PythonCommand(): Method GetResources() of the Python "
"command object returns the wrong type (has to be dict)");
}
// check for command type
std::string cmdType = getResource("CmdType");
if (!cmdType.empty()) {
int type = 0;
if (cmdType.find("AlterDoc") != std::string::npos)
type += int(AlterDoc);
if (cmdType.find("Alter3DView") != std::string::npos)
type += int(Alter3DView);
if (cmdType.find("AlterSelection") != std::string::npos)
type += int(AlterSelection);
if (cmdType.find("ForEdit") != std::string::npos)
type += int(ForEdit);
eType = type;
}
}
const char* PythonCommand::getResource(const char* sName) const
{
PyObject* pcTemp;
// get the "MenuText" resource string
pcTemp = PyDict_GetItemString(_pcPyResourceDict,sName);
if (!pcTemp)
return "";
if (!PyString_Check(pcTemp)) {
throw Base::Exception("PythonCommand::getResource(): Method GetResources() of the Python "
"command object returns a dictionary which holds not only strings");
}
return PyString_AsString(pcTemp);
}
void PythonCommand::activated(int iMsg)
{
if (Activation.empty()) {
try {
if (isCheckable()) {
Interpreter().runMethod(_pcPyCommand, "Activated", "", 0, "(i)", iMsg);
}
else {
Interpreter().runMethodVoid(_pcPyCommand, "Activated");
}
}
catch (const Base::PyException& e) {
Base::Console().Error("Running the Python command '%s' failed:\n%s\n%s",
sName, e.getStackTrace().c_str(), e.what());
}
catch (const Base::Exception&) {
Base::Console().Error("Running the Python command '%s' failed, try to resume",sName);
}
}
else {
doCommand(Doc,Activation.c_str());
}
}
bool PythonCommand::isActive(void)
{
try {
Base::PyGILStateLocker lock;
Py::Object cmd(_pcPyCommand);
if (cmd.hasAttr("IsActive")) {
Py::Callable call(cmd.getAttr("IsActive"));
Py::Tuple args;
Py::Object ret = call.apply(args);
// if return type is not boolean or not true
if (!PyBool_Check(ret.ptr()) || ret.ptr() != Py_True)
return false;
}
}
catch(Py::Exception& e) {
Base::PyGILStateLocker lock;
e.clear();
return false;
}
return true;
}
void PythonCommand::languageChange()
{
if (_pcAction) {
applyCommandData(getName(), _pcAction);
}
}
const char* PythonCommand::getHelpUrl(void) const
{
PyObject* pcTemp;
pcTemp = Interpreter().runMethodObject(_pcPyCommand, "CmdHelpURL");
if (! pcTemp )
return "";
if (! PyString_Check(pcTemp) )
throw Base::Exception("PythonCommand::CmdHelpURL(): Method CmdHelpURL() of the Python command object returns no string");
return PyString_AsString(pcTemp);
}
Action * PythonCommand::createAction(void)
{
QAction* qtAction = new QAction(0);
Action *pcAction;
pcAction = new Action(this, qtAction, getMainWindow());
pcAction->setShortcut(QString::fromAscii(getAccel()));
applyCommandData(this->getName(), pcAction);
if (strcmp(getResource("Pixmap"),"") != 0)
pcAction->setIcon(Gui::BitmapFactory().iconFromTheme(getResource("Pixmap")));
try {
if (isCheckable()) {
pcAction->setCheckable(true);
// Here the QAction must be tmp. blocked to avoid to call the 'activated' method
qtAction->blockSignals(true);
pcAction->setChecked(isChecked());
qtAction->blockSignals(false);
}
}
catch (const Base::Exception& e) {
Base::Console().Error("%s\n", e.what());
}
return pcAction;
}
const char* PythonCommand::getWhatsThis() const
{
const char* whatsthis = getResource("WhatsThis");
if (!whatsthis || whatsthis[0] == '\0')
whatsthis = this->getName();
return whatsthis;
}
const char* PythonCommand::getMenuText() const
{
return getResource("MenuText");
}
const char* PythonCommand::getToolTipText() const
{
return getResource("ToolTip");
}
const char* PythonCommand::getStatusTip() const
{
return getResource("StatusTip");
}
const char* PythonCommand::getPixmap() const
{
const char* ret = getResource("Pixmap");
return (ret && ret[0] != '\0') ? ret : 0;
}
const char* PythonCommand::getAccel() const
{
return getResource("Accel");
}
bool PythonCommand::isCheckable() const
{
PyObject* item = PyDict_GetItemString(_pcPyResourceDict,"Checkable");
return item ? true : false;
}
bool PythonCommand::isChecked() const
{
PyObject* item = PyDict_GetItemString(_pcPyResourceDict,"Checkable");
if (!item) {
throw Base::Exception("PythonCommand::isChecked(): Method GetResources() of the Python "
"command object doesn't contain the key 'Checkable'");
}
if (PyBool_Check(item)) {
return PyObject_IsTrue(item) ? true : false;
}
else {
throw Base::Exception("PythonCommand::isChecked(): Method GetResources() of the Python "
"command object contains the key 'Checkable' which is not a boolean");
}
}
//===========================================================================
// PythonGroupCommand
//===========================================================================
PythonGroupCommand::PythonGroupCommand(const char* name, PyObject * pcPyCommand)
: Command(name),_pcPyCommand(pcPyCommand)
{
sGroup = "Python";
Py_INCREF(_pcPyCommand);
// call the method "GetResources()" of the command object
_pcPyResource = Interpreter().runMethodObject(_pcPyCommand, "GetResources");
// check if the "GetResources()" method returns a Dict object
if (!PyDict_Check(_pcPyResource)) {
throw Base::TypeError("PythonGroupCommand::PythonGroupCommand(): Method GetResources() of the Python "
"command object returns the wrong type (has to be dict)");
}
// check for command type
std::string cmdType = getResource("CmdType");
if (!cmdType.empty()) {
int type = 0;
if (cmdType.find("AlterDoc") != std::string::npos)
type += int(AlterDoc);
if (cmdType.find("Alter3DView") != std::string::npos)
type += int(Alter3DView);
if (cmdType.find("AlterSelection") != std::string::npos)
type += int(AlterSelection);
if (cmdType.find("ForEdit") != std::string::npos)
type += int(ForEdit);
eType = type;
}
}
PythonGroupCommand::~PythonGroupCommand()
{
Base::PyGILStateLocker lock;
Py_DECREF(_pcPyCommand);
}
void PythonGroupCommand::activated(int iMsg)
{
try {
Gui::ActionGroup* pcAction = qobject_cast<Gui::ActionGroup*>(_pcAction);
QList<QAction*> a = pcAction->actions();
assert(iMsg < a.size());
QAction* act = a[iMsg];
Base::PyGILStateLocker lock;
Py::Object cmd(_pcPyCommand);
if (cmd.hasAttr("Activated")) {
Py::Callable call(cmd.getAttr("Activated"));
Py::Tuple args(1);
args.setItem(0, Py::Int(iMsg));
Py::Object ret = call.apply(args);
}
// If the command group doesn't implement the 'Activated' method then invoke the command directly
else {
Gui::CommandManager &rcCmdMgr = Gui::Application::Instance->commandManager();
rcCmdMgr.runCommandByName(act->property("CommandName").toByteArray());
}
// Since the default icon is reset when enabing/disabling the command we have
// to explicitly set the icon of the used command.
pcAction->setIcon(a[iMsg]->icon());
}
catch(Py::Exception&) {
Base::PyGILStateLocker lock;
Base::PyException e;
Base::Console().Error("Running the Python command '%s' failed:\n%s\n%s",
sName, e.getStackTrace().c_str(), e.what());
}
}
bool PythonGroupCommand::isActive(void)
{
try {
Base::PyGILStateLocker lock;
Py::Object cmd(_pcPyCommand);
if (cmd.hasAttr("IsActive")) {
Py::Callable call(cmd.getAttr("IsActive"));
Py::Tuple args;
Py::Object ret = call.apply(args);
// if return type is not boolean or not true
if (!PyBool_Check(ret.ptr()) || ret.ptr() != Py_True)
return false;
}
}
catch(Py::Exception& e) {
Base::PyGILStateLocker lock;
e.clear();
return false;
}
return true;
}
Action * PythonGroupCommand::createAction(void)
{
Gui::ActionGroup* pcAction = new Gui::ActionGroup(this, Gui::getMainWindow());
pcAction->setDropDownMenu(hasDropDownMenu());
pcAction->setExclusive(isExclusive());
applyCommandData(this->getName(), pcAction);
int defaultId = 0;
try {
Base::PyGILStateLocker lock;
Py::Object cmd(_pcPyCommand);
Gui::CommandManager &rcCmdMgr = Gui::Application::Instance->commandManager();
Py::Callable call(cmd.getAttr("GetCommands"));
Py::Tuple args;
Py::Tuple ret(call.apply(args));
for (Py::Tuple::iterator it = ret.begin(); it != ret.end(); ++it) {
Py::String str(*it);
QAction* cmd = pcAction->addAction(QString());
cmd->setProperty("CommandName", QByteArray(static_cast<std::string>(str).c_str()));
PythonCommand* pycmd = dynamic_cast<PythonCommand*>(rcCmdMgr.getCommandByName(cmd->property("CommandName").toByteArray()));
if (pycmd) {
cmd->setCheckable(pycmd->isCheckable());
}
}
if (cmd.hasAttr("GetDefaultCommand")) {
Py::Callable call2(cmd.getAttr("GetDefaultCommand"));
Py::Int def(call2.apply(args));
defaultId = static_cast<int>(def);
}
}
catch(Py::Exception&) {
Base::PyGILStateLocker lock;
Base::PyException e;
Base::Console().Error("createAction() of the Python command '%s' failed:\n%s\n%s",
sName, e.getStackTrace().c_str(), e.what());
}
_pcAction = pcAction;
languageChange();
if (strcmp(getResource("Pixmap"),"") != 0) {
pcAction->setIcon(Gui::BitmapFactory().iconFromTheme(getResource("Pixmap")));
}
else {
QList<QAction*> a = pcAction->actions();
// if out of range then set to 0
if (defaultId < 0 || defaultId >= a.size())
defaultId = 0;
if (a.size() > defaultId)
pcAction->setIcon(a[defaultId]->icon());
}
pcAction->setProperty("defaultAction", QVariant(defaultId));
return pcAction;
}
void PythonGroupCommand::languageChange()
{
if (!_pcAction)
return;
applyCommandData(this->getName(), _pcAction);
Gui::CommandManager &rcCmdMgr = Gui::Application::Instance->commandManager();
Gui::ActionGroup* pcAction = qobject_cast<Gui::ActionGroup*>(_pcAction);
QList<QAction*> a = pcAction->actions();
for (QList<QAction*>::iterator it = a.begin(); it != a.end(); ++it) {
Gui::Command* cmd = rcCmdMgr.getCommandByName((*it)->property("CommandName").toByteArray());
// Python command use getName as context
if (dynamic_cast<PythonCommand*>(cmd)) {
(*it)->setIcon(Gui::BitmapFactory().iconFromTheme(cmd->getPixmap()));
(*it)->setText(QApplication::translate(cmd->getName(), cmd->getMenuText()));
(*it)->setToolTip(QApplication::translate(cmd->getName(), cmd->getToolTipText()));
(*it)->setStatusTip(QApplication::translate(cmd->getName(), cmd->getStatusTip()));
}
else if (cmd) {
(*it)->setIcon(Gui::BitmapFactory().iconFromTheme(cmd->getPixmap()));
(*it)->setText(QApplication::translate(cmd->className(), cmd->getMenuText()));
(*it)->setToolTip(QApplication::translate(cmd->className(), cmd->getToolTipText()));
(*it)->setStatusTip(QApplication::translate(cmd->className(), cmd->getStatusTip()));
}
}
}
const char* PythonGroupCommand::getHelpUrl(void) const
{
return "";
}
const char* PythonGroupCommand::getResource(const char* sName) const
{
PyObject* pcTemp;
// get the "MenuText" resource string
pcTemp = PyDict_GetItemString(_pcPyResource, sName);
if (!pcTemp)
return "";
if (!PyString_Check(pcTemp)) {
throw Base::ValueError("PythonGroupCommand::getResource(): Method GetResources() of the Python "
"group command object returns a dictionary which holds not only strings");
}
return PyString_AsString(pcTemp);
}
const char* PythonGroupCommand::getWhatsThis() const
{
const char* whatsthis = getResource("WhatsThis");
if (!whatsthis || whatsthis[0] == '\0')
whatsthis = this->getName();
return whatsthis;
}
const char* PythonGroupCommand::getMenuText() const
{
return getResource("MenuText");
}
const char* PythonGroupCommand::getToolTipText() const
{
return getResource("ToolTip");
}
const char* PythonGroupCommand::getStatusTip() const
{
return getResource("StatusTip");
}
const char* PythonGroupCommand::getPixmap() const
{
const char* ret = getResource("Pixmap");
return (ret && ret[0] != '\0') ? ret : 0;
}
const char* PythonGroupCommand::getAccel() const
{
return getResource("Accel");
}
bool PythonGroupCommand::isExclusive() const
{
PyObject* item = PyDict_GetItemString(_pcPyResource,"Exclusive");
if (!item) {
return false;
}
if (PyBool_Check(item)) {
return PyObject_IsTrue(item) ? true : false;
}
else {
throw Base::Exception("PythonGroupCommand::isExclusive(): Method GetResources() of the Python "
"command object contains the key 'Exclusive' which is not a boolean");
}
}
bool PythonGroupCommand::hasDropDownMenu() const
{
PyObject* item = PyDict_GetItemString(_pcPyResource,"DropDownMenu");
if (!item) {
return true;
}
if (PyBool_Check(item)) {
return PyObject_IsTrue(item) ? true : false;
}
else {
throw Base::Exception("PythonGroupCommand::hasDropDownMenu(): Method GetResources() of the Python "
"command object contains the key 'DropDownMenu' which is not a boolean");
}
}
//===========================================================================
// CommandManager
//===========================================================================
CommandManager::CommandManager()
{
}
CommandManager::~CommandManager()
{
clearCommands();
}
void CommandManager::addCommand(Command* pCom)
{
_sCommands[pCom->getName()] = pCom;// pCom->Init();
}
void CommandManager::removeCommand(Command* pCom)
{
std::map <std::string,Command*>::iterator It = _sCommands.find(pCom->getName());
if (It != _sCommands.end()) {
delete It->second;
_sCommands.erase(It);
}
}
void CommandManager::clearCommands()
{
for ( std::map<std::string,Command*>::iterator it = _sCommands.begin(); it != _sCommands.end(); ++it )
delete it->second;
_sCommands.clear();
}
bool CommandManager::addTo(const char* Name, QWidget *pcWidget)
{
if (_sCommands.find(Name) == _sCommands.end()) {
// Print in release mode only a log message instead of an error message to avoid to annoy the user
#ifdef FC_DEBUG
Base::Console().Error("CommandManager::addTo() try to add an unknown command (%s) to a widget!\n",Name);
#else
Base::Console().Warning("Unknown command '%s'\n",Name);
#endif
return false;
}
else {
Command* pCom = _sCommands[Name];
pCom->addTo(pcWidget);
return true;
}
}
std::vector <Command*> CommandManager::getModuleCommands(const char *sModName) const
{
std::vector <Command*> vCmds;
for ( std::map<std::string, Command*>::const_iterator It= _sCommands.begin();It!=_sCommands.end();It++) {
if ( strcmp(It->second->getAppModuleName(),sModName) == 0)
vCmds.push_back(It->second);
}
return vCmds;
}
std::vector <Command*> CommandManager::getAllCommands(void) const
{
std::vector <Command*> vCmds;
for ( std::map<std::string, Command*>::const_iterator It= _sCommands.begin();It!=_sCommands.end();It++) {
vCmds.push_back(It->second);
}
return vCmds;
}
std::vector <Command*> CommandManager::getGroupCommands(const char *sGrpName) const
{
std::vector <Command*> vCmds;
for ( std::map<std::string, Command*>::const_iterator It= _sCommands.begin();It!=_sCommands.end();It++) {
if ( strcmp(It->second->getGroupName(),sGrpName) == 0)
vCmds.push_back(It->second);
}
return vCmds;
}
Command* CommandManager::getCommandByName(const char* sName) const
{
std::map<std::string,Command*>::const_iterator it = _sCommands.find( sName );
return ( it != _sCommands.end() ) ? it->second : 0;
}
void CommandManager::runCommandByName (const char* sName) const
{
Command* pCmd = getCommandByName(sName);
if (pCmd)
pCmd->invoke(0);
}
void CommandManager::testActive(void)
{
for ( std::map<std::string, Command*>::iterator It= _sCommands.begin();It!=_sCommands.end();It++) {
It->second->testActive();
}
}
void CommandManager::addCommandMode(const char* sContext, const char* sName)
{
_sCommandModes[sContext].push_back(sName);
}
void CommandManager::updateCommands(const char* sContext, int mode)
{
std::map<std::string, std::list<std::string> >::iterator it = _sCommandModes.find(sContext);
if (it != _sCommandModes.end()) {
for (std::list<std::string>::iterator jt = it->second.begin(); jt != it->second.end(); ++jt) {
Command* cmd = getCommandByName(jt->c_str());
if (cmd) {
cmd->updateAction(mode);
}
}
}
}