File size: 41,762 Bytes
985c397 | 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 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 | // SPDX-License-Identifier: LGPL-2.1-or-later
/***************************************************************************
* 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 <QDesktopServices>
#include <QInputDialog>
#include <QLabel>
#include <QMessageBox>
#include <QComboBox>
#include <QSignalBlocker>
#include <QTextStream>
#include <QTimer>
#include <App/Document.h>
#include <Base/Interpreter.h>
#include "Dialogs/DlgMacroExecuteImp.h"
#include "ui_DlgMacroExecute.h"
#include "Application.h"
#include "BitmapFactory.h"
#include "Command.h"
#include "Dialogs/DlgCustomizeImp.h"
#include "Dialogs/DlgToolbarsImp.h"
#include "Document.h"
#include "EditorView.h"
#include "Macro.h"
#include "MainWindow.h"
#include "PythonEditor.h"
#include "Workbench.h"
#include "WorkbenchManager.h"
using namespace Gui;
using namespace Gui::Dialog;
namespace Gui
{
namespace Dialog
{
class MacroItem: public QTreeWidgetItem
{
public:
MacroItem(QTreeWidget* widget, bool systemwide, const QString& dirPath)
: QTreeWidgetItem(widget)
, systemWide(systemwide)
, dirPath(dirPath)
{}
/**
* Acts same as setText method but additionally set toolTip with text of
* absolute file path. There may be different macros with same names from
* different system paths. So it could be helpful for user to show where
* exactly macro is placed.
*/
void setFileName(int column, const QString& text)
{
QFileInfo file(dirPath, text);
setToolTip(column, file.absoluteFilePath());
return QTreeWidgetItem::setText(column, text);
}
~MacroItem() override = default;
bool systemWide;
QString dirPath;
};
} // namespace Dialog
} // namespace Gui
/* TRANSLATOR Gui::Dialog::DlgMacroExecuteImp */
/**
* Constructs a DlgMacroExecuteImp which is a child of 'parent', with the
* name 'name' and widget flags set to 'f'
*
* The dialog will by default be modeless, unless you set 'modal' to
* true to construct a modal dialog.
*/
DlgMacroExecuteImp::DlgMacroExecuteImp(QWidget* parent, Qt::WindowFlags fl)
: QDialog(parent, fl)
, WindowParameter("Macro")
, ui(new Ui_DlgMacroExecute)
{
watcher = std::make_unique<PythonTracingWatcher>(this);
ui->setupUi(this);
setupConnections();
// retrieve the macro path from parameter or use the user data as default
{
QSignalBlocker blocker(ui->fileChooser);
std::string path = getWindowParameter()->GetASCII(
"MacroPath",
App::Application::getUserMacroDir().c_str()
);
this->macroPath = QString::fromUtf8(path.c_str());
ui->fileChooser->setFileName(this->macroPath);
}
// Fill the List box
QStringList labels;
labels << tr("Macros");
for (auto* listBox : {ui->userMacroListBox, ui->systemMacroListBox}) {
listBox->setHeaderLabels(labels);
listBox->header()->hide();
}
fillUpList();
ui->LineEditFind->setFocus();
ui->addonsButton->setEnabled(
Application::Instance->commandManager().getCommandByName("Std_AddonMgr") != nullptr
);
}
/**
* Destroys the object and frees any allocated resources
*/
DlgMacroExecuteImp::~DlgMacroExecuteImp() = default;
void DlgMacroExecuteImp::setupConnections()
{
// clang-format off
connect(ui->fileChooser, &FileChooser::fileNameChanged,
this, &DlgMacroExecuteImp::onFileChooserFileNameChanged);
connect(ui->createButton, &QPushButton::clicked,
this, &DlgMacroExecuteImp::onCreateButtonClicked);
connect(ui->deleteButton, &QPushButton::clicked,
this, &DlgMacroExecuteImp::onDeleteButtonClicked);
connect(ui->editButton, &QPushButton::clicked,
this, &DlgMacroExecuteImp::onEditButtonClicked);
connect(ui->renameButton, &QPushButton::clicked,
this, &DlgMacroExecuteImp::onRenameButtonClicked);
connect(ui->duplicateButton, &QPushButton::clicked,
this, &DlgMacroExecuteImp::onDuplicateButtonClicked);
connect(ui->toolbarButton, &QPushButton::clicked,
this, &DlgMacroExecuteImp::onToolbarButtonClicked);
connect(ui->addonsButton, &QPushButton::clicked,
this, &DlgMacroExecuteImp::onAddonsButtonClicked);
connect(ui->folderButton, &QPushButton::clicked,
this, &DlgMacroExecuteImp::onFolderButtonClicked);
connect(ui->userMacroListBox, &QTreeWidget::currentItemChanged,
this, &DlgMacroExecuteImp::onUserMacroListBoxCurrentItemChanged);
connect(ui->systemMacroListBox, &QTreeWidget::currentItemChanged,
this, &DlgMacroExecuteImp::onSystemMacroListBoxCurrentItemChanged);
connect(ui->tabMacroWidget, &QTabWidget::currentChanged,
this, &DlgMacroExecuteImp::onTabMacroWidgetCurrentChanged);
connect(ui->LineEditFind, &QLineEdit::textChanged,
this, &DlgMacroExecuteImp::onLineEditFindTextChanged);
connect(ui->LineEditFindInFiles, &QLineEdit::textChanged,
this, &DlgMacroExecuteImp::onLineEditFindInFilesTextChanged);
// clang-format on
}
/** Take a folder and return a StringList of the filenames in it
* filtered by both filename *and* by content, if the user has
* put text in one or both of the search line edits.
*
* First filtering is done by file name, which reduces the
* number of files to open and read (relatively expensive operation).
*
* Then we filter by file content after reducing the number of files
* to open and read. But both loops are skipped if there is no text
* in either of the line edits.
*
* We do this as another function in order to reuse this code for
* doing both the User and System macro list boxes in the fillUpList() function.
*/
QStringList DlgMacroExecuteImp::filterFiles(const QString& folder)
{
QDir dir(folder, QLatin1String("*.FCMacro *.py"));
QStringList unfiltered = dir.entryList(); // all .fcmacro and .py files
QString fileFilter = ui->LineEditFind->text(); // used to search by filename
QString searchText = ui->LineEditFindInFiles->text(); // used to search in file content
if (fileFilter.isEmpty() && searchText.isEmpty()) { // skip filtering if no filters
return unfiltered;
}
QStringList filteredByFileName;
if (fileFilter.isEmpty()) {
filteredByFileName = unfiltered; // skip the loop if no file filter
}
else {
QRegularExpression regexFileName(fileFilter, QRegularExpression::CaseInsensitiveOption);
bool isValidFileFilter = regexFileName.isValid(); // check here instead of inside the loop
for (auto uf : unfiltered) {
if (isValidFileFilter) {
if (regexFileName.match(uf).hasMatch()) {
filteredByFileName.append(uf);
}
}
else { // not valid, so do a simple text search
if (uf.contains(fileFilter, Qt::CaseInsensitive)) {
filteredByFileName.append(uf);
}
}
}
}
if (searchText.isEmpty()) { // skip reading file contents if no find in file filter
return filteredByFileName;
}
QRegularExpression regexContent(searchText, QRegularExpression::CaseInsensitiveOption);
bool isValidContentFilter = regexContent.isValid();
QStringList filteredByContent;
for (auto fn : filteredByFileName) {
const QString& fileName = fn;
QString filePath = dir.filePath(fileName);
QFile file(filePath);
if (file.open(QIODevice::ReadOnly | QIODevice::Text)) {
QTextStream in(&file);
QString fileContent = in.readAll();
if (isValidContentFilter) {
if (regexContent.match(fileContent).hasMatch()) {
filteredByContent.append(fileName);
}
}
else {
if (fileContent.contains(searchText, Qt::CaseInsensitive)) {
filteredByContent.append(fileName);
}
}
file.close();
}
}
return filteredByContent;
}
/**
* Fills up the list with macro files found in the specified location
* that have been filtered by both filename and by content
*/
void DlgMacroExecuteImp::fillUpListForDir(const QString& dirPath, bool systemWide)
{
QStringList filteredByContent = this->filterFiles(dirPath);
auto* macroListBox = systemWide ? ui->systemMacroListBox : ui->userMacroListBox;
macroListBox->clear();
for (auto& fn : filteredByContent) {
auto item = new MacroItem(macroListBox, systemWide, dirPath);
item->setFileName(0, fn);
}
}
/**
* Fills up the list with macro files found in all system paths and specified by
* user location that have been filtered by both filename and by content
*/
void DlgMacroExecuteImp::fillUpList()
{
fillUpListForDir(this->macroPath, false);
QString dirstr = QString::fromStdString(App::Application::getHomePath())
+ QStringLiteral("Macro");
fillUpListForDir(dirstr, true);
auto& config = App::Application::Config();
auto additionalMacros = config.find("AdditionalMacroPaths");
if (additionalMacros != config.end()) {
QString dirsstrs = QString::fromStdString(additionalMacros->second);
QStringList dirs = dirsstrs.split(QChar::fromLatin1(';'));
for (const auto& dirstr : dirs) {
fillUpListForDir(dirstr, true);
}
}
}
/**
* Selects a macro file in the list view.
*/
void DlgMacroExecuteImp::onUserMacroListBoxCurrentItemChanged(QTreeWidgetItem* item)
{
if (item) {
ui->LineEditMacroName->setText(item->text(0));
ui->executeButton->setEnabled(true);
ui->deleteButton->setEnabled(true);
ui->toolbarButton->setEnabled(true);
ui->createButton->setEnabled(true);
ui->editButton->setEnabled(true);
ui->renameButton->setEnabled(true);
ui->duplicateButton->setEnabled(true);
}
else {
ui->executeButton->setEnabled(false);
ui->deleteButton->setEnabled(false);
ui->toolbarButton->setEnabled(false);
ui->createButton->setEnabled(true);
ui->editButton->setEnabled(false);
ui->renameButton->setEnabled(false);
ui->duplicateButton->setEnabled(false);
}
}
void DlgMacroExecuteImp::onLineEditFindTextChanged(const QString& text)
{
Q_UNUSED(text);
this->fillUpList();
}
void DlgMacroExecuteImp::onLineEditFindInFilesTextChanged(const QString& text)
{
Q_UNUSED(text);
this->fillUpList();
}
void DlgMacroExecuteImp::onSystemMacroListBoxCurrentItemChanged(QTreeWidgetItem* item)
{
if (item) {
ui->LineEditMacroName->setText(item->text(0));
ui->executeButton->setEnabled(true);
ui->deleteButton->setEnabled(false);
ui->toolbarButton->setEnabled(false);
ui->createButton->setEnabled(false);
ui->editButton->setEnabled(true); // look but don't touch
ui->renameButton->setEnabled(false);
ui->duplicateButton->setEnabled(false);
}
else {
ui->executeButton->setEnabled(false);
ui->deleteButton->setEnabled(false);
ui->toolbarButton->setEnabled(false);
ui->createButton->setEnabled(false);
ui->editButton->setEnabled(false);
ui->renameButton->setEnabled(false);
ui->duplicateButton->setEnabled(false);
}
}
void DlgMacroExecuteImp::onTabMacroWidgetCurrentChanged(int index)
{
QTreeWidgetItem* item;
auto* macroListBox = index == 0 ? ui->userMacroListBox : ui->systemMacroListBox;
item = macroListBox->currentItem();
ui->executeButton->setEnabled(item);
ui->deleteButton->setEnabled(item);
ui->toolbarButton->setEnabled(item);
ui->createButton->setEnabled(item);
ui->editButton->setEnabled(item);
ui->renameButton->setEnabled(item);
ui->duplicateButton->setEnabled(item);
ui->LineEditMacroName->setText(item ? item->text(0) : QString());
}
/**
* Executes the selected macro file.
*/
void DlgMacroExecuteImp::accept()
{
QTreeWidgetItem* item;
int index = ui->tabMacroWidget->currentIndex();
auto* macroListBox = index == 0 ? ui->userMacroListBox : ui->systemMacroListBox;
item = macroListBox->currentItem();
if (!item) {
return;
}
QDialog::accept();
auto mitem = static_cast<MacroItem*>(item);
QDir dir(mitem->dirPath);
QFileInfo fi(dir, item->text(0));
try {
getMainWindow()->setCursor(Qt::WaitCursor);
PythonTracingLocker tracelock(watcher->getTrace());
getMainWindow()->appendRecentMacro(fi.filePath());
Application::Instance->macroManager()->run(Gui::MacroManager::File, fi.filePath().toUtf8());
// after macro run recalculate the document
if (Application::Instance->activeDocument()) {
Application::Instance->activeDocument()->getDocument()->recompute();
}
getMainWindow()->unsetCursor();
}
catch (const Base::SystemExitException&) {
// handle SystemExit exceptions
Base::PyGILStateLocker locker;
Base::PyException e;
e.reportException();
getMainWindow()->unsetCursor();
}
}
/**
* Specify the location of your macro files. The default location is FreeCAD's home path.
*/
void DlgMacroExecuteImp::onFileChooserFileNameChanged(const QString& fn)
{
if (!fn.isEmpty()) {
// save the path in the parameters
this->macroPath = fn;
getWindowParameter()->SetASCII("MacroPath", fn.toUtf8());
// fill the list box
fillUpList();
}
}
/**
* Opens the macro file in an editor.
*/
void DlgMacroExecuteImp::onEditButtonClicked()
{
QTreeWidgetItem* item = nullptr;
int index = ui->tabMacroWidget->currentIndex();
auto* macroListBox = index == 0 ? ui->userMacroListBox : ui->systemMacroListBox;
item = macroListBox->currentItem();
if (!item) {
return;
}
auto mitem = static_cast<MacroItem*>(item);
QDir dir(mitem->dirPath);
QString file = QStringLiteral("%1/%2").arg(dir.absolutePath(), item->text(0));
auto editor = new PythonEditor();
editor->setWindowIcon(Gui::BitmapFactory().iconFromTheme("applications-python"));
auto edit = new PythonEditorView(editor, getMainWindow());
edit->setDisplayName(PythonEditorView::FileName);
edit->open(file);
edit->resize(400, 300);
getMainWindow()->addWindow(edit);
getMainWindow()->appendRecentMacro(file);
if (mitem->systemWide) {
editor->setReadOnly(true);
QString shownName;
shownName = QStringLiteral("%1[*] - [%2]").arg(item->text(0), tr("Read-Only"));
edit->setWindowTitle(shownName);
}
close();
}
/** Creates a new macro file. */
void DlgMacroExecuteImp::onCreateButtonClicked()
{
// query file name
bool replaceSpaces = App::GetApplication()
.GetParameterGroupByPath("User parameter:BaseApp/Preferences/Macro")
->GetBool("ReplaceSpaces", true);
App::GetApplication()
.GetParameterGroupByPath("User parameter:BaseApp/Preferences/Macro")
->SetBool("ReplaceSpaces", replaceSpaces); // create parameter
QString fn = QInputDialog::getText(
this,
tr("Macro file"),
tr("Enter a file name:"),
QLineEdit::Normal,
QString(),
nullptr,
Qt::MSWindowsFixedSizeDialogHint
);
if (replaceSpaces) {
fn = fn.replace(QStringLiteral(" "), QStringLiteral("_"));
}
if (!fn.isEmpty()) {
QString suffix = QFileInfo(fn).suffix().toLower();
if (suffix != QLatin1String("fcmacro") && suffix != QLatin1String("py")) {
fn += QLatin1String(".FCMacro");
}
QDir dir(this->macroPath);
// create the macroPath if nonexistent
if (!dir.exists()) {
dir.mkpath(this->macroPath);
}
QFileInfo fi(dir, fn);
if (fi.exists() && fi.isFile()) {
QMessageBox::warning(
this,
tr("Existing file"),
tr("'%1'.\nThis file already exists.").arg(fi.fileName())
);
}
else {
QFile file(fi.absoluteFilePath());
if (!file.open(QFile::WriteOnly)) {
QMessageBox::warning(
this,
tr("Cannot create file"),
tr("Creation of file '%1' failed.").arg(fi.absoluteFilePath())
);
return;
}
file.close();
auto editor = new PythonEditor();
editor->setWindowIcon(Gui::BitmapFactory().iconFromTheme("applications-python"));
auto edit = new PythonEditorView(editor, getMainWindow());
edit->open(fi.absoluteFilePath());
getMainWindow()->appendRecentMacro(fi.absoluteFilePath());
edit->setWindowTitle(QStringLiteral("%1[*]").arg(fn));
edit->resize(400, 300);
getMainWindow()->addWindow(edit);
close();
}
}
}
/** Deletes the selected macro file from your harddisc. */
void DlgMacroExecuteImp::onDeleteButtonClicked()
{
int index = ui->tabMacroWidget->currentIndex();
auto* macroListBox = index == 0 ? ui->userMacroListBox : ui->systemMacroListBox;
auto* item = dynamic_cast<MacroItem*>(macroListBox->currentItem());
if (!item) {
return;
}
if (item->systemWide) {
QMessageBox::critical(
Gui::getMainWindow(),
QObject::tr("Delete macro"),
QObject::tr("Not allowed to delete system-wide macros")
);
return;
}
QString fn = item->text(0);
auto ret = QMessageBox::question(
this,
tr("Delete macro"),
tr("Delete the macro '%1'?").arg(fn),
QMessageBox::Yes | QMessageBox::No,
QMessageBox::No
);
if (ret == QMessageBox::Yes) {
QDir dir(this->macroPath);
dir.remove(fn);
int index = macroListBox->indexOfTopLevelItem(item);
macroListBox->takeTopLevelItem(index);
delete item;
}
}
/**
* Walk user through process of adding macro to global custom toolbar
* We create a custom customize dialog with instructions embedded
* within the dialog itself for the user, and the buttons to push in red text
* There are 2 dialogs we need to create: the macros dialog and the
* toolbar dialog.
*/
void DlgMacroExecuteImp::onToolbarButtonClicked()
{
/**
* advise user of what we are doing, offer chance to cancel
* unless user already said not to show this messagebox again
**/
bool showAgain = App::GetApplication()
.GetParameterGroupByPath("User parameter:BaseApp/Preferences/Macro")
->GetBool("ShowWalkthroughMessage", true);
if (showAgain) {
QMessageBox msgBox(this);
QAbstractButton* doNotShowAgainButton
= msgBox.addButton(tr("Do not show again"), QMessageBox::YesRole);
msgBox.setText(tr("Guided Walkthrough"));
msgBox.setObjectName(QStringLiteral("macroGuideWalkthrough"));
msgBox.setInformativeText(tr("This will guide you in setting up this macro in a custom \
global toolbar. Instructions will be in red text inside the dialog.\n\
\n\
Note: your changes will be applied when you next switch workbenches\n"));
msgBox.setStandardButtons(QMessageBox::Ok | QMessageBox::Cancel);
msgBox.setDefaultButton(QMessageBox::Ok);
int result = msgBox.exec();
if (result == QMessageBox::Cancel) {
return;
}
if (msgBox.clickedButton() == doNotShowAgainButton) {
App::GetApplication()
.GetParameterGroupByPath("User parameter:BaseApp/Preferences/Macro")
->SetBool("ShowWalkthroughMessage", false);
}
}
QTreeWidgetItem* item = ui->userMacroListBox->currentItem();
if (!item) {
return;
}
QString fn = item->text(0);
QString bareFileName = QFileInfo(fn).baseName(); // for use as default menu text (filename
// without extension)
/** check if user already has custom toolbar, so we can tailor instructions accordingly **/
bool hasCustomToolbar = true;
if (App::GetApplication()
.GetParameterGroupByPath("User parameter:BaseApp/Workbench/Global/Toolbar")
->GetGroups()
.empty()) {
hasCustomToolbar = false;
}
/** check if user already has this macro command created, if so skip dialog 1 **/
bool hasMacroCommand = false;
QString macroMenuText;
CommandManager& cCmdMgr = Application::Instance->commandManager();
std::vector<Command*> aCmds = cCmdMgr.getGroupCommands("Macros");
for (const auto& aCmd : aCmds) {
auto mc = dynamic_cast<MacroCommand*>(aCmd);
if (mc && fn.compare(QLatin1String(mc->getScriptName())) == 0) {
hasMacroCommand = true;
macroMenuText = QString::fromLatin1(mc->getMenuText());
}
}
QTabWidget* tabWidget = nullptr;
if (!hasMacroCommand) {
/** first the custom macros page dialog **/
Gui::Dialog::DlgCustomizeImp dlg(this);
/** title is normally "Customize" **/
dlg.setWindowTitle(tr("Walkthrough, Dialog 1 of 2"));
tabWidget = dlg.findChild<QTabWidget*>(QStringLiteral("Gui__Dialog__TabWidget"));
if (!tabWidget) {
std::cerr << "Toolbar walkthrough error: Unable to find tabwidget" << std::endl;
return;
}
auto setupCustomMacrosPage = tabWidget->findChild<QWidget*>(
QStringLiteral("Gui__Dialog__DlgCustomActions")
);
if (!setupCustomMacrosPage) {
std::cerr << "Toolbar walkthrough error: Unable to find setupCustomMacrosPage"
<< std::endl;
return;
}
tabWidget->setCurrentWidget(setupCustomMacrosPage);
auto groupBox7 = setupCustomMacrosPage->findChild<QGroupBox*>(QStringLiteral("GroupBox7"));
if (!groupBox7) {
Base::Console().warning("Toolbar walkthrough: Unable to find groupBox7\n");
// just warn when not a fatal error
}
else {
/** normally the groupbox title is "Setup Custom Macros", but we change it here **/
groupBox7->setTitle(
tr("Walkthrough instructions: Fill in missing fields (optional) "
"then click Add, then Close")
);
groupBox7->setStyleSheet(QStringLiteral("QGroupBox::title {color:red}"));
}
auto buttonAddAction = setupCustomMacrosPage->findChild<QPushButton*>(
QStringLiteral("buttonAddAction")
);
if (!buttonAddAction) {
Base::Console().warning("Toolbar walkthrough: Unable to find buttonAddAction\n");
}
else {
buttonAddAction->setStyleSheet(QStringLiteral("color:red"));
}
auto macroListBox = setupCustomMacrosPage->findChild<QComboBox*>(
QStringLiteral("actionMacros")
);
if (!macroListBox) {
Base::Console().warning("Toolbar walkthrough: Unable to find actionMacros combo box\n");
}
else {
int macroIndex = macroListBox->findText(fn); // fn is the macro filename
macroListBox->setCurrentIndex(macroIndex); // select it for the user so they don't have to
}
auto menuText = setupCustomMacrosPage->findChild<QLineEdit*>(QStringLiteral("actionMenu"));
if (!menuText) {
Base::Console().warning("Toolbar walkthrough: Unable to find actionMenu menuText\n");
}
else {
menuText->setText(bareFileName); // user can fill in other fields, e.g. tooltip
}
dlg.exec();
}
/** now for the toolbar selection dialog **/
Gui::Dialog::DlgCustomizeImp dlg(this);
dlg.setWindowTitle(
hasMacroCommand ? tr("Walkthrough, Dialog 1 of 1") : tr("Walkthrough, Dialog 2 of 2")
);
tabWidget = nullptr;
tabWidget = dlg.findChild<QTabWidget*>(QStringLiteral("Gui__Dialog__TabWidget"));
if (!tabWidget) {
std::cerr << "Toolbar walkthrough: Unable to find tabWidget Gui__Dialog__TabWidget"
<< std::endl;
return;
}
auto setupToolbarPage = tabWidget->findChild<DlgCustomToolbars*>(
QStringLiteral("Gui__Dialog__DlgCustomToolbars")
);
if (!setupToolbarPage) {
std::cerr
<< "Toolbar walkthrough: Unable to find setupToolbarPage Gui__Dialog__DlgCustomToolbars"
<< std::endl;
return;
}
tabWidget->setCurrentWidget(setupToolbarPage);
auto moveActionRightButton = setupToolbarPage->findChild<QPushButton*>(
QStringLiteral("moveActionRightButton")
);
if (!moveActionRightButton) {
Base::Console().warning("Toolbar walkthrough: Unable to find moveActionRightButton\n");
}
else {
moveActionRightButton->setStyleSheet(QStringLiteral("background-color: red"));
}
/** tailor instructions depending on whether user already has custom toolbar created
* if not, they need to click New button to create one first
**/
QString instructions2
= tr("Walkthrough instructions: Select macro from list, then click right arrow button (->), then Close.");
auto workbenchBox = setupToolbarPage->findChild<QComboBox*>(QStringLiteral("workbenchBox"));
if (!workbenchBox) {
Base::Console().warning("Toolbar walkthrough: Unable to find workbenchBox\n");
}
else {
/** find the Global workbench and select it for the user **/
int globalIdx = workbenchBox->findData(QStringLiteral("Global"));
if (globalIdx != -1) {
workbenchBox->setCurrentIndex(globalIdx);
setupToolbarPage->activateWorkbenchBox(globalIdx);
}
else {
Base::Console().warning("Toolbar walkthrough: Unable to find Global workbench\n");
}
if (!hasCustomToolbar) {
auto newButton = setupToolbarPage->findChild<QPushButton*>(QStringLiteral("newButton"));
if (!newButton) {
Base::Console().warning("Toolbar walkthrough: Unable to find newButton\n");
}
else {
newButton->setStyleSheet(QStringLiteral("color:red"));
instructions2 = tr(
"Walkthrough instructions: Click New, select macro, then right arrow (->) "
"button, then Close."
);
}
}
}
/** "label" normally says "Note: the changes become active the next time you load the
* appropriate workbench" **/
auto label = setupToolbarPage->findChild<QLabel*>(QStringLiteral("label"));
if (!label) {
Base::Console().warning("Toolbar walkthrough: Unable to find label\n");
}
else {
label->setText(instructions2);
label->setStyleSheet(QStringLiteral("color:red"));
}
/** find Macros category and select it for the user **/
auto categoryBox = setupToolbarPage->findChild<QComboBox*>(QStringLiteral("categoryBox"));
if (!categoryBox) {
Base::Console().warning("Toolbar walkthrough: Unable to find categoryBox\n");
}
else {
int macrosIdx = categoryBox->findText(tr("Macros"));
if (macrosIdx != -1) {
categoryBox->setCurrentIndex(macrosIdx);
}
else {
Base::Console().warning("Toolbar walkthrough: Unable to find Macros in categoryBox\n");
}
}
/** expand custom toolbar items **/
auto toolbarTreeWidget = setupToolbarPage->findChild<QTreeWidget*>(
QStringLiteral("toolbarTreeWidget")
);
if (!toolbarTreeWidget) {
Base::Console().warning("Toolbar walkthrough: Unable to find toolbarTreeWidget\n");
}
else {
toolbarTreeWidget->expandAll();
}
/** preselect macro command for user after a short delay to allow time for the
tree widget to populate all the actions
**/
QTimer::singleShot(500, [=]() {
auto commandTreeWidget = setupToolbarPage->findChild<QTreeWidget*>(
QStringLiteral("commandTreeWidget")
);
if (!commandTreeWidget) {
Base::Console().warning("Toolbar walkthrough: Unable to find commandTreeWidget\n");
}
else {
if (!hasMacroCommand) { // will be the last in the list, the one just created
commandTreeWidget->setCurrentItem(
commandTreeWidget->topLevelItem(commandTreeWidget->topLevelItemCount() - 1)
);
commandTreeWidget->scrollToItem(commandTreeWidget->currentItem());
}
else { // preselect it for the user (will be the macro menu text)
QList<QTreeWidgetItem*> items = commandTreeWidget->findItems(
macroMenuText,
Qt::MatchFixedString | Qt::MatchWrap,
1
);
if (!items.empty()) {
commandTreeWidget->setCurrentItem(items[0]);
commandTreeWidget->scrollToItem(commandTreeWidget->currentItem());
}
}
}
});
dlg.exec();
// refresh toolbar so new icon shows up immediately
Workbench* active = Gui::WorkbenchManager::instance()->active();
if (active) {
active->activate();
}
}
/**
* renames the selected macro
*/
void DlgMacroExecuteImp::onRenameButtonClicked()
{
QDir dir;
QTreeWidgetItem* item = nullptr;
int index = ui->tabMacroWidget->currentIndex();
if (index == 0) { // user-specific
item = ui->userMacroListBox->currentItem();
dir.setPath(this->macroPath);
}
if (!item) {
return;
}
bool replaceSpaces = App::GetApplication()
.GetParameterGroupByPath("User parameter:BaseApp/Preferences/Macro")
->GetBool("ReplaceSpaces", true);
App::GetApplication()
.GetParameterGroupByPath("User parameter:BaseApp/Preferences/Macro")
->SetBool("ReplaceSpaces", replaceSpaces); // create parameter
QString oldName = item->text(0);
QFileInfo oldfi(dir, oldName);
QFile oldfile(oldfi.absoluteFilePath());
// query new name
QString fn = QInputDialog::getText(
this,
tr("Renaming Macro File"),
tr("Enter new name"),
QLineEdit::Normal,
oldName,
nullptr,
Qt::MSWindowsFixedSizeDialogHint
);
if (replaceSpaces) {
fn = fn.replace(QStringLiteral(" "), QStringLiteral("_"));
}
if (!fn.isEmpty() && fn != oldName) {
QString suffix = QFileInfo(fn).suffix().toLower();
if (suffix != QLatin1String("fcmacro") && suffix != QLatin1String("py")) {
fn += QLatin1String(".FCMacro");
}
QFileInfo fi(dir, fn);
// check if new name exists
if (fi.exists()) {
QMessageBox::warning(
this,
tr("Existing file"),
tr("'%1'\n already exists.").arg(fi.absoluteFilePath())
);
}
else if (!oldfile.rename(fi.absoluteFilePath())) {
QMessageBox::warning(
this,
tr("Rename Failed"),
tr("Failed to rename to '%1'.\nPerhaps a file permission error?")
.arg(fi.absoluteFilePath())
);
}
else {
// keep the item selected although it's not necessarily in alphabetic order
item->setText(0, fn);
ui->LineEditMacroName->setText(fn);
}
}
}
/**Duplicates selected macro
* New file has same name as original but with "@" and 3-digit number appended
* Begins with "@001" and increments until available name is found
* "MyMacro.FCMacro" becomes "MyMacro@001.FCMacro"
* "MyMacro@002.FCMacro.py" becomes "MyMacro@003.FCMacro.py" unless there is
* no already existing "MyMacro@001.FCMacro.py"
*/
void DlgMacroExecuteImp::onDuplicateButtonClicked()
{
QDir dir;
QTreeWidgetItem* item = nullptr;
// When duplicating a macro we can either begin trying to find a unique name with @001 or begin
// with the current @NNN if applicable
bool from001 = App::GetApplication()
.GetParameterGroupByPath("User parameter:BaseApp/Preferences/Macro")
->GetBool("DuplicateFrom001", false);
App::GetApplication()
.GetParameterGroupByPath("User parameter:BaseApp/Preferences/Macro")
->SetBool("DuplicateFrom001", from001); // create parameter
// A user may wish to add a note to end of the filename when duplicating
// example: mymacro@005.fix_bug_in_dialog.FCMacro
// and then when duplicating to have the extra note removed so the suggested new name is:
// mymacro@006.FCMacro instead of mymacro@006.fix_bug_in_dialog.FCMacro since the new duplicate
// will be given a new note
bool ignoreExtra = App::GetApplication()
.GetParameterGroupByPath("User parameter:BaseApp/Preferences/Macro")
->GetBool("DuplicateIgnoreExtraNote", false);
App::GetApplication()
.GetParameterGroupByPath("User parameter:BaseApp/Preferences/Macro")
->SetBool("DuplicateIgnoreExtraNote", ignoreExtra); // create parameter
// when creating a note it will be convenient to convert spaces to underscores if the user
// desires this behavior
bool replaceSpaces = App::GetApplication()
.GetParameterGroupByPath("User parameter:BaseApp/Preferences/Macro")
->GetBool("ReplaceSpaces", true);
App::GetApplication()
.GetParameterGroupByPath("User parameter:BaseApp/Preferences/Macro")
->SetBool("ReplaceSpaces", replaceSpaces); // create parameter
int index = ui->tabMacroWidget->currentIndex();
if (index == 0) { // user-specific
item = ui->userMacroListBox->currentItem();
dir.setPath(this->macroPath);
}
if (!item) {
return;
}
QString oldName = item->text(0);
QFileInfo oldfi(dir, oldName);
QFile oldfile(oldfi.absoluteFilePath());
QString completeSuffix = oldfi.completeSuffix(); // everything after the first "."
QString extraNote = completeSuffix.left(completeSuffix.size() - oldfi.suffix().size());
QString baseName = oldfi.baseName(); // everything before first "."
QString neutralSymbol = QStringLiteral("@");
QString last3 = baseName.right(3);
bool ok = true; // was conversion to int successful?
int nLast3 = last3.toInt(&ok);
last3 = QStringLiteral("001"); // increment beginning with 001 unless from001 = false
if (ok) {
// last3 were all digits, so we strip them from the base name
if (baseName.size() > 3) { // if <= 3 leave be (e.g. 2.py becomes 2@001.py)
if (!from001) {
last3 = baseName.right(3); // use these instead of 001
}
baseName = baseName.left(baseName.size() - 3); // strip digits
if (baseName.endsWith(neutralSymbol)) {
baseName = baseName.left(baseName.size() - 1); // trim the "@", will be added back later
}
}
}
// at this point baseName = the base name without any digits, e.g. "MyMacro"
// neutralSymbol = "@"
// last3 is a string representing 3 digits, always "001"
// unless from001 = false, in which case we begin with previous numbers
// completeSuffix = FCMacro or py or FCMacro.py or else suffix will become FCMacro below
// if ignoreExtra any extra notes added between @NN. and .FCMacro will be ignored
// when suggesting a new filename
if (ignoreExtra && !extraNote.isEmpty()) {
nLast3++;
last3 = QString::number(nLast3);
while (last3.size() < 3) {
last3.prepend(QStringLiteral("0")); // pad 0's if needed
}
}
QString oldNameDigitized = baseName + neutralSymbol + last3 + QStringLiteral(".")
+ completeSuffix;
QFileInfo fi(dir, oldNameDigitized);
// increment until we find available name with smallest digits
// test from "001" through "999", then give up and let user enter name of choice
while (fi.exists()) {
nLast3 = last3.toInt() + 1;
if (nLast3 >= 1000) { // avoid infinite loop, 999 files will have to be enough
break;
}
last3 = QString::number(nLast3);
while (last3.size() < 3) {
last3.prepend(QStringLiteral("0")); // pad 0's if needed
}
oldNameDigitized = baseName + neutralSymbol + last3 + QStringLiteral(".") + completeSuffix;
fi = QFileInfo(dir, oldNameDigitized);
}
if (ignoreExtra && !extraNote.isEmpty()) {
oldNameDigitized = oldNameDigitized.remove(extraNote);
}
// give user a chance to pick a different name from digitized name suggested
QString fn = QInputDialog::getText(
this,
tr("Duplicate Macro"),
tr("Enter new name"),
QLineEdit::Normal,
oldNameDigitized,
nullptr,
Qt::MSWindowsFixedSizeDialogHint
);
if (replaceSpaces) {
fn = fn.replace(QStringLiteral(" "), QStringLiteral("_"));
}
if (!fn.isEmpty() && fn != oldName) {
QString suffix = QFileInfo(fn).suffix().toLower();
if (suffix != QLatin1String("fcmacro") && suffix != QLatin1String("py")) {
fn += QLatin1String(".FCMacro");
}
QFileInfo fi(dir, fn);
// check again if new name exists in case user changed it
if (fi.exists()) {
QMessageBox::warning(
this,
tr("Existing file"),
tr("'%1'\n already exists.").arg(fi.absoluteFilePath())
);
}
else if (!oldfile.copy(fi.absoluteFilePath())) {
QMessageBox::warning(
this,
tr("Duplicate Failed"),
tr("Failed to duplicate to '%1'.\nPerhaps a file permission error?")
.arg(fi.absoluteFilePath())
);
}
this->fillUpList(); // repopulate list to show new file
}
}
/**
* convenience link button to open tools -> addon manager
* from within macro dialog
*/
void DlgMacroExecuteImp::onAddonsButtonClicked()
{
CommandManager& rMgr = Application::Instance->commandManager();
rMgr.runCommandByName("Std_AddonMgr");
this->fillUpList();
}
/**
* convenience link button to open folder with macros
* from within macro dialog
*/
void DlgMacroExecuteImp::onFolderButtonClicked()
{
QString path = QString::fromStdString(App::Application::getUserMacroDir());
QUrl url = QUrl::fromLocalFile(path);
QDesktopServices::openUrl(url);
}
#include "moc_DlgMacroExecuteImp.cpp"
|