2 * \file GuiViewSource.cpp
3 * This file is part of LyX, the document processor.
4 * Licence details can be found in the file COPYING.
8 * \author Abdelrazak Younes
10 * Full author contact details are available in file CREDITS.
15 #include "GuiApplication.h"
16 #include "GuiViewSource.h"
17 #include "LaTeXHighlighter.h"
18 #include "qt_helpers.h"
20 #include "BufferParams.h"
21 #include "BufferView.h"
24 #include "Paragraph.h"
26 #include "support/debug.h"
27 #include "support/lassert.h"
28 #include "support/docstream.h"
29 #include "support/docstring_list.h"
30 #include "support/gettext.h"
32 #include <boost/crc.hpp>
38 #include <QTextCursor>
39 #include <QTextDocument>
47 ViewSourceWidget::ViewSourceWidget()
48 : bv_(0), document_(new QTextDocument(this)),
49 highlighter_(new LaTeXHighlighter(document_)),
50 update_timer_(new QTimer(this))
54 connect(contentsCO, SIGNAL(activated(int)),
55 this, SLOT(contentsChanged()));
56 connect(autoUpdateCB, SIGNAL(toggled(bool)),
57 updatePB, SLOT(setDisabled(bool)));
58 connect(autoUpdateCB, SIGNAL(toggled(bool)),
59 this, SLOT(contentsChanged()));
60 connect(masterPerspectiveCB, SIGNAL(toggled(bool)),
61 this, SLOT(contentsChanged()));
62 connect(updatePB, SIGNAL(clicked()),
63 this, SLOT(updateViewNow()));
64 connect(outputFormatCO, SIGNAL(activated(int)),
65 this, SLOT(setViewFormat(int)));
66 connect(outputFormatCO, SIGNAL(activated(int)),
67 this, SLOT(contentsChanged()));
69 if (lyx::lyxerr.debugging(Debug::LATEX))
70 connect(viewSourceTV, SIGNAL(cursorPositionChanged()),
71 this, SLOT(gotoCursor()));
74 // setting the update timer
75 update_timer_->setSingleShot(true);
76 connect(update_timer_, SIGNAL(timeout()),
77 this, SLOT(realUpdateView()));
79 // setting a document at this point trigger an assertion in Qt
80 // so we disable the signals here:
81 document_->blockSignals(true);
82 viewSourceTV->setDocument(document_);
85 document_->blockSignals(false);
86 viewSourceTV->setReadOnly(true);
87 ///dialog_->viewSourceTV->setAcceptRichText(false);
88 // this is personal. I think source code should be in fixed-size font
89 QFont font(guiApp->typewriterFontName());
90 font.setFixedPitch(true);
91 font.setStyleHint(QFont::TypeWriter);
92 viewSourceTV->setFont(font);
93 // again, personal taste
94 viewSourceTV->setWordWrapMode(QTextOption::NoWrap);
98 void ViewSourceWidget::getContent(BufferView const * view,
99 Buffer::OutputWhat output, docstring & str, string const & format,
102 // get the *top* level paragraphs that contain the cursor,
103 // or the selected text
107 if (!view->cursor().selection()) {
108 par_begin = view->cursor().bottom().pit();
111 par_begin = view->cursor().selectionBegin().bottom().pit();
112 par_end = view->cursor().selectionEnd().bottom().pit();
114 if (par_begin > par_end)
115 swap(par_begin, par_end);
116 odocstringstream ostr;
117 texrow_ = view->buffer().getSourceCode(ostr, format,
118 par_begin, par_end + 1, output, master);
119 //ensure that the last line can always be selected in its full width
120 str = ostr.str() + "\n";
124 void ViewSourceWidget::setBufferView(BufferView const * bv)
130 setEnabled(bv ? true : false);
134 bool ViewSourceWidget::setText(QString const & qstr)
136 bool const changed = document_->toPlainText() != qstr;
137 viewSourceTV->setExtraSelections(QList<QTextEdit::ExtraSelection>());
139 document_->setPlainText(qstr);
144 void ViewSourceWidget::contentsChanged()
146 if (autoUpdateCB->isChecked())
151 void ViewSourceWidget::setViewFormat(int const index)
153 outputFormatCO->setCurrentIndex(index);
154 view_format_ = outputFormatCO->itemData(index).toString();
158 void ViewSourceWidget::updateView()
160 const int long_delay = 400;
161 const int short_delay = 60;
162 // a shorter delay if just the current paragraph is shown
163 update_timer_->start((contentsCO->currentIndex() == 0) ?
164 short_delay : long_delay);
168 void ViewSourceWidget::updateViewNow()
170 update_timer_->start(0);
174 void ViewSourceWidget::realUpdateView()
184 // we will try to get that much space around the cursor
185 int const v_margin = 3;
186 int const h_margin = 10;
187 // we will try to preserve this
188 int const h_scroll = viewSourceTV->horizontalScrollBar()->value();
190 string const format = fromqstr(view_format_);
192 Buffer::OutputWhat output = Buffer::CurrentParagraph;
193 if (contentsCO->currentIndex() == 1)
194 output = Buffer::FullSource;
195 else if (contentsCO->currentIndex() == 2)
196 output = Buffer::OnlyPreamble;
197 else if (contentsCO->currentIndex() == 3)
198 output = Buffer::OnlyBody;
201 getContent(bv_, output, content, format, masterPerspectiveCB->isChecked());
202 QString old = document_->toPlainText();
203 QString qcontent = toqstr(content);
205 // output tex<->row correspondences in the source panel if the "-dbg latex"
207 if (texrow_.get() && lyx::lyxerr.debugging(Debug::LATEX)) {
208 QStringList list = qcontent.split(QChar('\n'));
209 docstring_list dlist;
210 for (QStringList::const_iterator it = list.begin(); it != list.end(); ++it)
211 dlist.push_back(from_utf8(fromqstr(*it)));
212 texrow_->prepend(dlist);
214 for (docstring_list::iterator it = dlist.begin(); it != dlist.end(); ++it)
215 qcontent += toqstr(*it) + '\n';
218 // prevent gotoCursor()
219 viewSourceTV->blockSignals(true);
220 bool const changed = setText(qcontent);
222 if (changed && !texrow_.get()) {
223 // position-to-row is unavailable
224 // we jump to the first modification
225 const QChar * oc = old.constData();
226 const QChar * nc = qcontent.constData();
228 while (*oc != '\0' && *nc != '\0' && *oc == *nc) {
233 QTextCursor c = QTextCursor(viewSourceTV->document());
234 //get some space below the cursor
236 c.movePosition(QTextCursor::Down, QTextCursor::MoveAnchor,v_margin);
237 viewSourceTV->setTextCursor(c);
238 //get some space on the right of the cursor
239 viewSourceTV->horizontalScrollBar()->setValue(h_scroll);
241 const int block = c.blockNumber();
242 for (int i = h_margin; i && block == c.blockNumber(); --i) {
243 c.movePosition(QTextCursor::Right, QTextCursor::MoveAnchor);
245 c.movePosition(QTextCursor::Left, QTextCursor::MoveAnchor);
246 viewSourceTV->setTextCursor(c);
247 //back to the position
249 //c.movePosition(QTextCursor::Right, QTextCursor::KeepAnchor,1);
250 viewSourceTV->setTextCursor(c);
252 } else if (texrow_.get()) {
253 // Use the available position-to-row conversion to highlight
254 // the current selection in the source
255 std::pair<int,int> rows = texrow_->rowFromCursor(bv_->cursor());
256 int const beg_row = rows.first;
257 int const end_row = rows.second;
259 QTextCursor c = QTextCursor(viewSourceTV->document());
261 c.movePosition(QTextCursor::NextBlock, QTextCursor::MoveAnchor,
263 const int beg_sel = c.position();
264 //get some space above the cursor
265 c.movePosition(QTextCursor::PreviousBlock, QTextCursor::MoveAnchor,
267 viewSourceTV->setTextCursor(c);
268 c.setPosition(beg_sel, QTextCursor::MoveAnchor);
270 c.movePosition(QTextCursor::NextBlock, QTextCursor::KeepAnchor,
271 end_row - beg_row +1);
272 const int end_sel = c.position();
273 //get some space below the cursor
274 c.movePosition(QTextCursor::NextBlock, QTextCursor::KeepAnchor,
276 viewSourceTV->setTextCursor(c);
277 c.setPosition(end_sel, QTextCursor::KeepAnchor);
279 viewSourceTV->setTextCursor(c);
281 //the real highlighting is done with an ExtraSelection
282 QTextCharFormat format;
283 QPalette palette = viewSourceTV->palette();
285 // QColor bg = palette.color(QPalette::Active,QPalette::Highlight);
287 // format.setBackground(QBrush(bg));
288 //Other alternatives:
289 //format.setBackground(palette.light());
290 //format.setBackground(palette.alternateBase());
291 format.setBackground(palette.toolTipBase());
292 format.setProperty(QTextFormat::FullWidthSelection, true);
293 QTextEdit::ExtraSelection sel;
296 viewSourceTV->setExtraSelections(
297 QList<QTextEdit::ExtraSelection>() << sel);
301 viewSourceTV->setTextCursor(c);
302 viewSourceTV->horizontalScrollBar()->setValue(h_scroll);
303 } // else if (texrow)
304 viewSourceTV->blockSignals(false);
308 // only used in DEVEL_MODE for debugging
309 // need a proper LFUN if we want to implement it in release mode
310 void ViewSourceWidget::gotoCursor()
312 if (!bv_ || !texrow_.get())
314 int row = viewSourceTV->textCursor().blockNumber() + 1;
315 const_cast<BufferView *>(bv_)->setCursorFromRow(row, *texrow_);
320 void ViewSourceWidget::updateDefaultFormat()
325 outputFormatCO->blockSignals(true);
326 outputFormatCO->clear();
327 outputFormatCO->addItem(qt_("Default"),
328 QVariant(QString("default")));
331 vector<string> tmp = bv_->buffer().params().backends();
332 vector<string>::const_iterator it = tmp.begin();
333 vector<string>::const_iterator en = tmp.end();
334 for (; it != en; ++it) {
335 string const format = *it;
336 Format const * fmt = formats.getFormat(format);
338 LYXERR0("Can't find format for backend " << format << "!");
342 QString const pretty = qt_(fmt->prettyname());
343 QString const qformat = toqstr(format);
344 outputFormatCO->addItem(pretty, QVariant(qformat));
345 if (qformat == view_format_)
346 index = outputFormatCO->count() -1;
348 setViewFormat(index);
350 outputFormatCO->blockSignals(false);
354 void ViewSourceWidget::resizeEvent (QResizeEvent * event)
356 QSize const & formSize = formLayout->sizeHint();
357 // minimize the size of the part that contains the buttons
358 if (width() * formSize.height() < height() * formSize.width()) {
359 layout_->setDirection(QBoxLayout::TopToBottom);
361 layout_->setDirection(QBoxLayout::LeftToRight);
363 QWidget::resizeEvent(event);
366 void ViewSourceWidget::saveSession(QString const & session_key) const
369 settings.setValue(session_key + "/output", view_format_);
370 settings.setValue(session_key + "/contents", contentsCO->currentIndex());
371 settings.setValue(session_key + "/autoupdate", autoUpdateCB->isChecked());
372 settings.setValue(session_key + "/masterview",
373 masterPerspectiveCB->isChecked());
377 void ViewSourceWidget::restoreSession(QString const & session_key)
380 view_format_ = settings.value(session_key + "/output", 0).toString();
381 contentsCO->setCurrentIndex(settings
382 .value(session_key + "/contents", 0)
384 masterPerspectiveCB->setChecked(settings
385 .value(session_key + "/masterview", false)
387 bool const checked = settings
388 .value(session_key + "/autoupdate", true)
390 autoUpdateCB->setChecked(checked);
396 GuiViewSource::GuiViewSource(GuiView & parent,
397 Qt::DockWidgetArea area, Qt::WindowFlags flags)
398 : DockView(parent, "view-source", qt_("LaTeX Source"), area, flags)
400 widget_ = new ViewSourceWidget;
405 GuiViewSource::~GuiViewSource()
411 void GuiViewSource::updateView()
413 if (widget_->autoUpdateCB->isChecked()) {
414 widget_->setBufferView(bufferview());
415 widget_->updateView();
417 widget_->masterPerspectiveCB->setEnabled(buffer().parent());
421 void GuiViewSource::enableView(bool enable)
423 widget_->setBufferView(bufferview());
424 widget_->updateDefaultFormat();
426 // In the opposite case, updateView() will be called anyway.
427 widget_->contentsChanged();
431 bool GuiViewSource::initialiseParams(string const & /*source*/)
433 setWindowTitle(title());
438 QString GuiViewSource::title() const
442 //FIXME: this is shown for LyXHTML source, LyX source, etc.
443 return qt_("LaTeX Source");
445 return qt_("DocBook Source");
447 return qt_("Literate Source");
454 void GuiViewSource::saveSession() const
456 Dialog::saveSession();
457 widget_->saveSession(sessionKey());
461 void GuiViewSource::restoreSession()
463 DockView::restoreSession();
464 widget_->restoreSession(sessionKey());
468 Dialog * createGuiViewSource(GuiView & lv)
470 return new GuiViewSource(lv);
474 } // namespace frontend
477 #include "moc_GuiViewSource.cpp"