src/frontends/qt4/GuiProgressView.cpp

   1 // -*- C++ -*-
   2 /**
   3  * \file GuiProgressView.cpp
   4  * This file is part of LyX, the document processor.
   5  * Licence details can be found in the file COPYING.
   6  *
   7  * \author Peter Kümmel
   8  * \author Pavel Sanda
   9  * \author Jürgen Spitzmüller
  10  *
  11  * Full author contact details are available in file CREDITS.
  12  */
  13
  14 #include <config.h>
  15
  16 #include "GuiProgressView.h"
  17
  18 #include "GuiApplication.h"
  19 #include "GuiProgress.h"
  20 #include "qt_helpers.h"
  21
  22 #include "FuncRequest.h"
  23
  24 #include "support/convert.h"
  25 #include "support/debug.h"
  26
  27 #include <QCheckBox>
  28 #include <QDebug>
  29 #include <QSettings>
  30 #include <QTime>
  31
  32 using namespace std;
  33 using namespace lyx::support;
  34
  35 namespace lyx {
  36 namespace frontend {
  37
  38
  39 ProgressViewWidget::ProgressViewWidget()
  40 {
  41         setupUi(this);
  42 }
  43
  44
  45 GuiProgressView::~GuiProgressView()
  46 {
  47         delete widget_;
  48 }
  49
  50
  51 namespace{
  52 typedef pair<int, QString> DebugMap;
  53 typedef vector<DebugMap> DebugVector;
  54
  55 bool DebugSorter(DebugMap const & a, DebugMap const & b)
  56 {
  57         return a.second < b.second;
  58 }
  59 }
  60
  61
  62 GuiProgressView::GuiProgressView(GuiView & parent, Qt::DockWidgetArea area,
  63         Qt::WindowFlags flags)
  64         : DockView(parent, "progress", qt_("Progress/Debug Messages"), area, flags)
  65 {
  66         eol_last_ = true;
  67         widget_ = new ProgressViewWidget;
  68         widget_->setMinimumHeight(150);
  69         widget_->debugMessagesTW->setSizePolicy(QSizePolicy::Ignored,
  70                                                 QSizePolicy::Expanding);
  71         widget_->adjustSize();
  72         setWidget(widget_);
  73
  74         widget_->outTE->setFont(guiApp->typewriterSystemFont());
  75         widget_->tabWidget->widget(0)->setContentsMargins(-5, -7, 0, -7);
  76
  77         connect(widget_->debugNoneRB, SIGNAL(clicked()),
  78                 this, SLOT(debugSelectionChanged()));
  79         connect(widget_->debugSelectedRB, SIGNAL(clicked()),
  80                 this, SLOT(debugSelectionChanged()));
  81         connect(widget_->debugAnyRB, SIGNAL(clicked()),
  82                 this, SLOT(debugSelectionChanged()));
  83         widget_->debugMessagesTW->setEnabled(false);
  84         widget_->debugNoneRB->setChecked(true);
  85
  86         // ignore Debug::NONE and Debug::ANY
  87         int const level_count = Debug::levelCount() - 1;
  88         DebugVector dmap;
  89         for (int i = 1 ; i < level_count; i++) {
  90                 Debug::Type const level = Debug::value(i);
  91                 QString const desc =
  92                         toqstr(from_ascii(Debug::name(level) + " - "))
  93                         + qt_(Debug::description(level));
  94                 dmap.push_back(DebugMap(level, desc));
  95         }
  96         sort(dmap.begin(), dmap.end(), DebugSorter);
  97
  98         widget_->debugMessagesTW->setColumnCount(2);
  99         widget_->debugMessagesTW->headerItem()->setText(0, qt_("Debug Level"));
 100         widget_->debugMessagesTW->headerItem()->setText(1, qt_("Set"));
 101
 102         DebugVector::const_iterator dit = dmap.begin();
 103         DebugVector::const_iterator const den = dmap.end();
 104         for (; dit != den; ++dit) {
 105                 QTreeWidgetItem * item = new QTreeWidgetItem(widget_->debugMessagesTW);
 106                 item->setText(0, dit->second);
 107                 item->setData(0, Qt::UserRole, int(dit->first));
 108                 item->setText(1, qt_("No"));
 109         }
 110         widget_->debugMessagesTW->resizeColumnToContents(0);
 111         widget_->debugMessagesTW->resizeColumnToContents(1);
 112         connect(widget_->debugMessagesTW,
 113                 SIGNAL(itemActivated(QTreeWidgetItem *, int)),
 114                 this, SLOT(debugMessageActivated(QTreeWidgetItem *, int)));
 115
 116         GuiProgress * progress =
 117                 dynamic_cast<GuiProgress *>(ProgressInterface::instance());
 118
 119         if (progress) {
 120                 connect(progress, SIGNAL(processStarted(QString const &)),
 121                         this, SLOT(appendText(QString const &)));
 122                 //connect(progress, SIGNAL(processFinished(QString const &)),
 123                 //      this, SLOT(appendText(QString const &)));
 124                 connect(progress, SIGNAL(appendMessage(QString const &)),
 125                         this, SLOT(appendText(QString const &)));
 126                 connect(progress, SIGNAL(appendLyXErrMessage(QString const &)),
 127                         this, SLOT(appendLyXErrText(QString const &)), Qt::QueuedConnection);
 128                 connect(progress, SIGNAL(appendError(QString const &)),
 129                         this, SLOT(appendText(QString const &)));
 130                 connect(progress, SIGNAL(clearMessages()), this, SLOT(clearText()));
 131                 progress->lyxerrConnect();
 132         }
 133 }
 134
 135
 136 void GuiProgressView::debugMessageActivated(QTreeWidgetItem * item, int)
 137 {
 138         if (item == 0)
 139                 return;
 140
 141         QString const no = qt_("No");
 142         QString const yes = qt_("Yes");
 143
 144         bool selected = (item->text(1) == yes);
 145         item->setText(1, selected ? no : yes);
 146
 147         levelChanged();
 148 }
 149
 150
 151 void GuiProgressView::levelChanged()
 152 {
 153         int level = Debug::NONE;
 154         QTreeWidgetItemIterator it(widget_->debugMessagesTW);
 155         while (*it) {
 156                 if ((*it)->text(1) == qt_("Yes"))
 157                         level |= (*it)->data(0, Qt::UserRole).toInt();
 158                 ++it;
 159         }
 160         dispatch(FuncRequest(LFUN_DEBUG_LEVEL_SET, convert<string>(level)));
 161 }
 162
 163
 164 void GuiProgressView::debugSelectionChanged()
 165 {
 166         int level = Debug::NONE;
 167         if (widget_->debugAnyRB->isChecked())
 168                 level = Debug::ANY;
 169         else if (widget_->debugSelectedRB->isChecked()) {
 170                 widget_->debugMessagesTW->setEnabled(true);
 171                 levelChanged();
 172                 return;
 173         }
 174         QTreeWidgetItemIterator it(widget_->debugMessagesTW);
 175         while (*it) {
 176                 (*it)->setText(1, level == Debug::NONE ?
 177                                 qt_("No") : qt_("Yes"));
 178                 ++it;
 179         }
 180         widget_->debugMessagesTW->setEnabled(false);
 181         dispatch(FuncRequest(LFUN_DEBUG_LEVEL_SET, convert<string>(level)));
 182 }
 183
 184
 185 void GuiProgressView::clearText()
 186 {
 187         if (widget_->autoClearCB->isChecked()){
 188                 widget_->outTE->clear();
 189                 eol_last_ = true;
 190         }
 191 }
 192
 193
 194 void GuiProgressView::appendLyXErrText(QString const & text)
 195 {
 196         widget_->outTE->moveCursor(QTextCursor::End);
 197         widget_->outTE->insertPlainText(text);
 198         widget_->outTE->ensureCursorVisible();
 199         eol_last_ = false;
 200         // Give the user a chance to disable debug messages because
 201         // showing Debug::ANY messages completely blocks the GUI.
 202         // Text is not always send as the whole line, so we must be
 203         // careful about eolns.
 204         // WARNING: processing events could cause crashes!
 205         // TODO: find a better solution
 206         if (text.endsWith("\n")) {
 207                 eol_last_ = true;
 208                 QApplication::processEvents();
 209         }
 210 }
 211
 212
 213 void GuiProgressView::appendText(QString const & text)
 214 {
 215         if (text.isEmpty() || !widget_->sbarCB->isChecked())
 216                 return;
 217         QString str = GuiProgress::currentTime();
 218         str += ": " + text;
 219         if (!eol_last_)
 220                 str = "\n" + str;
 221         eol_last_ = text.endsWith("\n");
 222
 223         widget_->outTE->moveCursor(QTextCursor::End);
 224         widget_->outTE->insertPlainText(str);
 225         widget_->outTE->ensureCursorVisible();
 226 }
 227
 228
 229 void GuiProgressView::saveSession() const
 230 {
 231         Dialog::saveSession();
 232         QSettings settings;
 233         settings.setValue(
 234                 sessionKey() + "/autoclear", widget_->autoClearCB->isChecked());
 235         settings.setValue(
 236                 sessionKey() + "/statusbarmsgs", widget_->sbarCB->isChecked());
 237 }
 238
 239
 240 void GuiProgressView::restoreSession()
 241 {
 242         DockView::restoreSession();
 243         QSettings settings;
 244         widget_->autoClearCB->setChecked(
 245                 settings.value(sessionKey() + "/autoclear", true).toBool());
 246         widget_->sbarCB->setChecked(
 247                 settings.value(sessionKey() + "/statusbarmsgs", true).toBool());
 248 }
 249
 250
 251 void GuiProgressView::showEvent(QShowEvent*)
 252 {
 253         ProgressInterface::instance()->lyxerrConnect();
 254 }
 255
 256
 257 void GuiProgressView::hideEvent(QHideEvent*)
 258 {
 259         ProgressInterface::instance()->lyxerrDisconnect();
 260 }
 261
 262
 263 Dialog * createGuiProgressView(GuiView & guiview)
 264 {
 265         return new GuiProgressView(guiview, Qt::BottomDockWidgetArea);
 266 }
 267
 268
 269
 270 } // namespace frontend
 271 } // namespace lyx
 272
 273 #include "moc_GuiProgressView.cpp"