Changeset 124 in tspsg-svn for trunk/src

Timestamp:

Jul 4, 2010, 3:03:13 AM (14 years ago)

Author:

laleppa

Message:

+ Added support for Windows 7 Taskbar Extensions (namely, Progress Bars).

• Cleanup is done in a separate thread now, so progress bar runs more smooth.
• "Tabified" About dialog. Added GPL License and Credits.
• Updated translations and tspsg.tag file.

Location:

trunk/src

Files:

• mainwindow.cpp (modified) (13 diffs)
• mainwindow.h (modified) (3 diffs)
• shobjidl.h (added)
• tspsolver.cpp (modified) (4 diffs)
• tspsolver.h (modified) (2 diffs)

trunk/src/mainwindow.cpp

@@ -23 +23 @@
 
 #include "mainwindow.h"
+
+#ifdef Q_OS_WIN32
+        #include "shobjidl.h"
+#endif
 
 #ifdef _T_T_L_
@@ -436 +440 @@
 void MainWindow::actionHelpAboutTriggered()
 {
+        QApplication::setOverrideCursor(QCursor(Qt::WaitCursor));
+
 QString title;
 #ifdef HANDHELD
@@ -462 +468 @@
         about += QString("%1: <b>%2</b><br>").arg(tr("Algorithm"), CTSPSolver::getVersionId());
         about += "<br>";
-        about += tr("TSPSG is free software: you can redistribute it and/or modify it<br>"
-                "under the terms of the GNU General Public License as published<br>"
-                "by the Free Software Foundation, either version 3 of the License,<br>"
-                "or (at your option) any later version.<br>"
-                "<br>"
-                "TSPSG is distributed in the hope that it will be useful, but<br>"
-                "WITHOUT ANY WARRANTY; without even the implied warranty of<br>"
-                "MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the<br>"
-                "GNU General Public License for more details.<br>"
-                "<br>"
-                "You should have received a copy of the GNU General Public License<br>"
-                "along with TSPSG.  If not, see <a href=\"http://www.gnu.org/licenses/\">http://www.gnu.org/licenses/</a>.");
+        about += tr("This program is free software: you can redistribute it and/or modify<br>\n"
+                "it under the terms of the GNU General Public License as published by<br>\n"
+                "the Free Software Foundation, either version 3 of the License, or<br>\n"
+                "(at your option) any later version.<br>\n"
+                "<br>\n"
+                "This program is distributed in the hope that it will be useful,<br>\n"
+                "but WITHOUT ANY WARRANTY; without even the implied warranty of<br>\n"
+                "MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the<br>\n"
+                "GNU General Public License for more details.<br>\n"
+                "<br>\n"
+                "You should have received a copy of the GNU General Public License<br>\n"
+                "along with TSPSG.  If not, see <a href=\"http://www.gnu.org/licenses/\">www.gnu.org/licenses/</a>.");
+
+QString credits;
+        credits += tr("This software was created using LGPL version of <b>Qt framework</b>,<br>\n"
+                "see <a href=\"http://qt.nokia.com/\">qt.nokia.com</a><br>\n"
+                "<br>\n"
+                "Most icons used in this software are part of <b>Oxygen Icons</b> project "
+                "licensed according to the GNU Lesser General Public License,<br>\n"
+                "see <a href=\"http://www.oxygen-icons.org/\">www.oxygen-icons.org</a><br>\n"
+                "<br>\n"
+                "Country flag icons used in this software are part of the free "
+                "<b>Flag Icons</b> collection created by <b>IconDrawer</b>,<br>\n"
+                "see <a href=\"http://www.icondrawer.com/\">www.icondrawer.com</a>");
+
+QFile f(":/files/COPYING");
+        f.open(QIODevice::ReadOnly);
+
+QString translation = QApplication::translate("--------", "AUTHORS %1", "Please, provide translator credits here. %1 will be replaced with VERSION");
+        if ((translation != "AUTHORS %1") && (translation.contains("%1"))) {
+QString about = QApplication::translate("--------", "VERSION", "Please, provide your translation version here.");
+                if (about != "VERSION")
+                        translation = translation.arg(about);
+        }
 
 QDialog *dlg = new QDialog(this);
 QLabel *lblIcon = new QLabel(dlg),
-        *lblTitle = new QLabel(dlg),
-        *lblTranslated = new QLabel(dlg);
+        *lblTitle = new QLabel(dlg);
 #ifdef HANDHELD
 QLabel *lblSubTitle = new QLabel(QString("<b>&copy; 2007-%1 <a href=\"http://%2/\">%3</a></b>").arg(QDate::currentDate().toString("yyyy"), QApplication::organizationDomain(), QApplication::organizationName()), dlg);
 #endif // HANDHELD
+QTabWidget *tabs = new QTabWidget(dlg);
 QTextBrowser *txtAbout = new QTextBrowser(dlg);
+QTextBrowser *txtLicense = new QTextBrowser(dlg);
+QTextBrowser *txtCredits = new QTextBrowser(dlg);
 QVBoxLayout *vb = new QVBoxLayout();
 QHBoxLayout *hb1 = new QHBoxLayout(),
@@ -509 +539 @@
         txtAbout->setHtml(about);
         txtAbout->moveCursor(QTextCursor::Start);
-#ifndef HANDHELD
-        txtAbout->setStyleSheet(QString("QTextBrowser {background-color: %1; border-color: %2; border-width: 1px; border-style: solid; border-radius: 4px; padding: 1px;}").arg(palette().base().color().name(), palette().shadow().color().name()));
-#endif // HANDHELD
+        txtAbout->setFrameShape(QFrame::NoFrame);
+
+//      txtCredits->setWordWrapMode(QTextOption::NoWrap);
+        txtCredits->setOpenExternalLinks(true);
+        txtCredits->setHtml(credits);
+        txtCredits->moveCursor(QTextCursor::Start);
+        txtCredits->setFrameShape(QFrame::NoFrame);
+
+        txtLicense->setWordWrapMode(QTextOption::NoWrap);
+        txtLicense->setOpenExternalLinks(true);
+        txtLicense->setText(f.readAll());
+        txtLicense->moveCursor(QTextCursor::Start);
+        txtLicense->setFrameShape(QFrame::NoFrame);
 
         bb->button(QDialogButtonBox::Ok)->setCursor(QCursor(Qt::PointingHandCursor));
-
-        lblTranslated->setText(QApplication::translate("--------", "AUTHORS", "Please, provide translator credits here."));
-        if (lblTranslated->text() == "AUTHORS")
-                lblTranslated->hide();
-        else {
-                lblTranslated->setOpenExternalLinks(true);
-#ifndef HANDHELD
-                lblTranslated->setStyleSheet(QString("QLabel {background-color: %1; border-color: %2; border-width: 1px; border-style: solid; border-radius: 3px; padding: 1px;}").arg(palette().alternateBase().color().name(), palette().shadow().color().name()));
-#endif // HANDHELD
-                hb2->addWidget(lblTranslated);
-        }
-
-        // This one isn't displayed anywhere, yet. Provided as a placeholder for future use.
-        QApplication::translate("--------", "VERSION", "Please, provide your translation version here.");
 
         hb2->addWidget(bb);
@@ -538 +564 @@
         vb->addWidget(lblSubTitle);
 #endif // HANDHELD
-        vb->addWidget(txtAbout);
+
+        tabs->addTab(txtAbout, tr("About"));
+        tabs->addTab(txtLicense, tr("License"));
+        tabs->addTab(txtCredits, tr("Credits"));
+        if (translation != "AUTHORS %1") {
+QTextBrowser *txtTranslation = new QTextBrowser(dlg);
+//              txtTranslation->setWordWrapMode(QTextOption::NoWrap);
+                txtTranslation->setOpenExternalLinks(true);
+                txtTranslation->setText(translation);
+                txtTranslation->moveCursor(QTextCursor::Start);
+                txtTranslation->setFrameShape(QFrame::NoFrame);
+
+                tabs->addTab(txtTranslation, tr("Translation"));
+        }
+#ifndef HANDHELD
+        tabs->setStyleSheet(QString("QTabWidget::pane {background-color: %1; border-color: %3; border-width: 1px; border-style: solid; border-bottom-left-radius: 4px; border-bottom-right-radius: 4px; padding: 1px;} QTabBar::tab {background-color: %2; border-color: %3; border-width: 1px; border-style: solid; border-bottom: none; border-top-left-radius: 4px; border-top-right-radius: 4px; padding: 2px 6px;} QTabBar::tab:selected {background-color: %4;} QTabBar::tab:!selected {margin-top: 1px;}").arg(palette().base().color().name(), palette().button().color().name(), palette().shadow().color().name(), palette().light().color().name()));
+#endif // HANDHELD
+
+        vb->addWidget(tabs);
         vb->addLayout(hb2);
 
@@ -556 +600 @@
 
         dlg->resize(450, 350);
+        QApplication::restoreOverrideCursor();
 
         dlg->exec();
@@ -597 +642 @@
         pb->setFormat(tr("%v of %1 parts found").arg(n));
         pd.setBar(pb);
+QPushButton *cancel = new QPushButton(&pd);
+        cancel->setIcon(QIcon::fromTheme("dialog-cancel", QIcon(":/images/icons/dialog-cancel.png")));
+        cancel->setText(QApplication::translate("QProgressDialog", "Cancel", "No need to translate this. This translation will be taken from Qt translation files."));
+        pd.setCancelButton(cancel);
         pd.setMaximum(n);
         pd.setAutoReset(false);
@@ -605 +654 @@
         pd.show();
 
+#ifdef Q_OS_WIN32
+HRESULT hr = CoCreateInstance(CLSID_TaskbarList, NULL, CLSCTX_INPROC_SERVER, IID_ITaskbarList3, (LPVOID*)&tl);
+        if (SUCCEEDED(hr)) {
+                hr = tl->HrInit();
+                if (FAILED(hr)) {
+                        tl->Release();
+                        tl = NULL;
+                } else {
+//                      tl->SetProgressState(winId(), TBPF_INDETERMINATE);
+                        tl->SetProgressValue(winId(), 0, n * 2);
+                }
+        }
+#endif
+
 CTSPSolver solver;
+        solver.setCleanupOnCancel(false);
         connect(&solver, SIGNAL(routePartFound(int)), &pd, SLOT(setValue(int)));
         connect(&pd, SIGNAL(canceled()), &solver, SLOT(cancel()));
+#ifdef Q_OS_WIN32
+        if (tl != NULL)
+                connect(&solver, SIGNAL(routePartFound(int)), SLOT(solverRoutePartFound(int)));
+#endif
 SStep *root = solver.solve(n, matrix);
+#ifdef Q_OS_WIN32
+        if (tl != NULL)
+                disconnect(&solver, SIGNAL(routePartFound(int)), this, SLOT(solverRoutePartFound(int)));
+#endif
         disconnect(&solver, SIGNAL(routePartFound(int)), &pd, SLOT(setValue(int)));
         disconnect(&pd, SIGNAL(canceled()), &solver, SLOT(cancel()));
         if (!root) {
                 pd.reset();
-                if (!solver.wasCanceled())
+                if (!solver.wasCanceled()) {
+#ifdef Q_OS_WIN32
+                        if (tl != NULL) {
+//                              tl->SetProgressValue(winId(), n, n * 2);
+                                tl->SetProgressState(winId(), TBPF_ERROR);
+                        }
+#endif
+                        QApplication::alert(this);
                         QMessageBox::warning(this, tr("Solution Result"), tr("Unable to find a solution.\nMaybe, this task has no solution."));
+                }
+                pd.setLabelText(tr("Cleaning up..."));
+                pd.setMaximum(0);
+                pd.setCancelButton(NULL);
+                pd.show();
+#ifdef Q_OS_WIN32
+                if (tl != NULL)
+                        tl->SetProgressState(winId(), TBPF_INDETERMINATE);
+#endif
+                QApplication::processEvents(QEventLoop::ExcludeUserInputEvents);
+
+QFuture<void> f = QtConcurrent::run(&solver, &CTSPSolver::cleanup, false);
+                while (!f.isFinished()) {
+                        QApplication::processEvents(QEventLoop::ExcludeUserInputEvents);
+                }
+                pd.reset();
+#ifdef Q_OS_WIN32
+                if (tl != NULL) {
+                        tl->SetProgressState(winId(), TBPF_NOPROGRESS);
+                        tl->Release();
+                        tl = NULL;
+                }
+#endif
                 return;
         }
@@ -621 +723 @@
         pd.setMaximum(solver.getTotalSteps() + 1);
         pd.setValue(0);
+
+#ifdef Q_OS_WIN32
+        if (tl != NULL)
+                tl->SetProgressValue(winId(), spinCities->value(), spinCities->value() + solver.getTotalSteps() + 1);
+#endif
 
         solutionText->clear();
@@ -665 +772 @@
                         pd.show();
                         QApplication::processEvents(QEventLoop::ExcludeUserInputEvents);
-                        solver.cleanup(true);
+#ifdef Q_OS_WIN32
+                        if (tl != NULL)
+                                tl->SetProgressState(winId(), TBPF_INDETERMINATE);
+#endif
+QFuture<void> f = QtConcurrent::run(&solver, &CTSPSolver::cleanup, false);
+                        while (!f.isFinished()) {
+                                QApplication::processEvents(QEventLoop::ExcludeUserInputEvents);
+                        }
                         solutionText->clear();
                         toggleSolutionActions(false);
+#ifdef Q_OS_WIN32
+                        if (tl != NULL) {
+                                tl->SetProgressState(winId(), TBPF_NOPROGRESS);
+                                tl->Release();
+                                tl = NULL;
+                        }
+#endif
                         return;
                 }
                 pd.setValue(n);
+#ifdef Q_OS_WIN32
+                if (tl != NULL)
+                        tl->SetProgressValue(winId(), spinCities->value() + n, spinCities->value() + solver.getTotalSteps() + 1);
+#endif
 
                 cur.beginEditBlock();
@@ -713 +838 @@
         pb->setFormat(tr("Generating footer"));
         pd.setValue(n);
+#ifdef Q_OS_WIN32
+        if (tl != NULL)
+                tl->SetProgressValue(winId(), spinCities->value() + n, spinCities->value() + solver.getTotalSteps() + 1);
+#endif
 
         cur.beginEditBlock();
@@ -764 +893 @@
         pd.setCancelButton(NULL);
         QApplication::processEvents(QEventLoop::ExcludeUserInputEvents);
-        solver.cleanup(true);
+#ifdef Q_OS_WIN32
+        if (tl != NULL)
+                tl->SetProgressState(winId(), TBPF_INDETERMINATE);
+#endif
+QFuture<void> f = QtConcurrent::run(&solver, &CTSPSolver::cleanup, false);
+        while (!f.isFinished()) {
+                QApplication::processEvents(QEventLoop::ExcludeUserInputEvents);
+        }
         toggleSolutionActions();
         tabWidget->setCurrentIndex(1);
+#ifdef Q_OS_WIN32
+        if (tl != NULL) {
+                tl->SetProgressState(winId(), TBPF_NOPROGRESS);
+                tl->Release();
+                tl = NULL;
+        }
+#endif
+
+        pd.reset();
+        QApplication::alert(this, 3000);
 }
 
@@ -833 +979 @@
 }
 #endif // QT_NO_PRINTER
+
+#ifdef Q_OS_WIN32
+void MainWindow::solverRoutePartFound(int n)
+{
+#ifdef Q_OS_WIN32
+        tl->SetProgressValue(winId(), n, spinCities->value() * 2);
+#else
+        Q_UNUSED(n);
+#endif // Q_OS_WIN32
+}
+#endif // Q_OS_WIN32
 
 void MainWindow::spinCitiesValueChanged(int n)

trunk/src/mainwindow.h

@@ -35 +35 @@
 
 #include "tspmodel.h"
+
+#ifdef Q_OS_WIN32
+        // Forward declaration. A real one is in shobjidl.h
+        struct ITaskbarList3;
+#endif
 
 using namespace TSPSolver;
@@ -88 +93 @@
         void printPreview(QPrinter *printer);
 #endif // QT_NO_PRINTER
+#ifdef Q_OS_WIN32
+        void solverRoutePartFound(int n);
+#endif // Q_OS_WIN32
         void spinCitiesValueChanged(int nCities);
 
@@ -111 +119 @@
         QRect currentGeometry;
 #endif // Q_OS_WINCE_WM
+
+#ifdef Q_OS_WIN32
+        ITaskbarList3 *tl;
+#endif // Q_OS_WIN32
 
         // The solution graph SVG

trunk/src/tspsolver.cpp

@@ -43 +43 @@
  */
 CTSPSolver::CTSPSolver(QObject *parent)
-        : QObject(parent), nCities(0), total(0), root(NULL) {}
+        : QObject(parent), cc(true), nCities(0), total(0), root(NULL) {}
 
 /*!
@@ -51 +51 @@
  * \note It is not required to call this function manually. This function is always called by solve() at the beginning of the solution process.
  *
- * \sa solve()
+ * \sa solve(), setCleanupOnCancel()
  */
 void CTSPSolver::cleanup(bool processEvents)
 {
-#ifdef QAPPLICATION_H
-        if (!processEvents)
-                QApplication::setOverrideCursor(QCursor(Qt::WaitCursor));
-#endif
         route.clear();
         mayNotBeOptimal = false;
         if (root != NULL)
                 deleteTree(root, processEvents);
-#ifdef QAPPLICATION_H
-        if (!processEvents)
-                QApplication::restoreOverrideCursor();
-#endif
 }
 
@@ -115 +107 @@
 {
         return !mayNotBeOptimal;
+}
+
+/*!
+ * \brief Sets whether or not to call cleanup() on solution cancel.
+ * \param enable Set to \c true to enable clenup (default).
+ *
+ *  This may be useful if you want to make cleanup yourself or provide indication of clenup to user.
+ *
+ * \note Please, note that cleanup() is explicitly called at the start of each solution.
+ *       Disabling cleanup and forgetting to do it manually may considerably increase the solution time for large tasks (with more than 15 cities).
+ * \sa cleanup()
+ */
+void CTSPSolver::setCleanupOnCancel(bool enable)
+{
+        cc = enable;
 }
 
@@ -174 +181 @@
                 locker.relock();
                 if ((nRow == -1) || (nCol == -1) || canceled) {
-                        cleanup();
+                        if (canceled && cc)
+                                cleanup();
                         return NULL;
                 }

trunk/src/tspsolver.h

@@ -113 +113 @@
         CTSPSolver(QObject *parent = NULL);
         void cleanup(bool processEvents = false);
-        QString getSortedPath(const QString &city, const QString &separator = " -> ") const;
+        QString getSortedPath(const QString &city, const QString &separator = QString(" -> ")) const;
         int getTotalSteps() const;
         bool isOptimal() const;
+        void setCleanupOnCancel(bool enable = true);
         SStep *solve(int numCities, const TMatrix &task);
         bool wasCanceled() const;
@@ -131 +132 @@
 
 private:
-        bool mayNotBeOptimal, canceled;
+        bool mayNotBeOptimal, canceled, cc;
         int nCities, total;
         SStep *root;