]> git.lyx.org Git - lyx.git/blob - src/BufferView2.C
another 100+ lines bite the dust...
[lyx.git] / src / BufferView2.C
1 /* This file is part of
2  * ======================================================
3  *
4  *           LyX, The Document Processor
5  *
6  *           Copyright 1995 Matthias Ettrich
7  *           Copyright 1995-2001 The LyX Team.
8  *
9  * ====================================================== */
10
11 #include <config.h>
12
13 #include "BufferView.h"
14 #include "buffer.h"
15 #include "lyxcursor.h"
16 #include "lyxtext.h"
17 #include "frontends/LyXView.h"
18 #include "bufferlist.h"
19 #include "frontends/screen.h"
20 #include "LaTeX.h"
21 #include "BufferView_pimpl.h"
22 #include "language.h"
23 #include "gettext.h"
24 #include "undo_funcs.h"
25 #include "debug.h"
26 #include "iterators.h"
27 #include "lyxlex.h"
28 #include "WordLangTuple.h"
29
30 #include "frontends/Alert.h"
31 #include "frontends/Dialogs.h"
32
33 #include "insets/insetcommand.h" //ChangeRefs
34 #include "insets/inseterror.h"
35
36 #include "support/FileInfo.h"
37 #include "support/filetools.h"
38 #include "support/lyxfunctional.h" //equal_1st_in_pair
39 #include "support/types.h"
40 #include "support/lyxalgo.h" // lyx_count
41
42 #include <fstream>
43
44 extern BufferList bufferlist;
45
46 using lyx::pos_type;
47
48 using std::pair;
49 using std::endl;
50 using std::ifstream;
51 using std::vector;
52 using std::find;
53 using std::count_if;
54
55
56 // Inserts a file into current document
57 bool BufferView::insertLyXFile(string const & filen)
58         //
59         // Copyright CHT Software Service GmbH
60         // Uwe C. Schroeder
61         //
62         // Insert a LyXformat - file into current buffer
63         //
64         // Moved from lyx_cb.C (Lgb)
65 {
66         if (filen.empty())
67                 return false;
68
69         string const fname = MakeAbsPath(filen);
70
71         // check if file exist
72         FileInfo const fi(fname);
73
74         if (!fi.readable()) {
75                 Alert::alert(_("Error!"),
76                            _("Specified file is unreadable: "),
77                            MakeDisplayPath(fname, 50));
78                 return false;
79         }
80
81         beforeChange(text);
82
83         ifstream ifs(fname.c_str());
84         if (!ifs) {
85                 Alert::alert(_("Error!"),
86                            _("Cannot open specified file: "),
87                            MakeDisplayPath(fname, 50));
88                 return false;
89         }
90
91         int const c = ifs.peek();
92
93         LyXLex lex(0, 0);
94         lex.setStream(ifs);
95
96         bool res = true;
97
98         if (c == '#') {
99                 lyxerr[Debug::INFO] << "Will insert file with header" << endl;
100                 res = buffer()->readFile(lex, text->cursor.par());
101         } else {
102                 lyxerr[Debug::INFO] << "Will insert file without header"
103                                     << endl;
104                 res = buffer()->readLyXformat2(lex, text->cursor.par());
105         }
106
107         resize();
108         return res;
109 }
110
111
112 bool BufferView::removeAutoInsets()
113 {
114         // keep track of which pos and par the cursor was on
115         Paragraph * cursor_par = text->cursor.par();
116         Paragraph * cursor_par_prev = cursor_par ? cursor_par->previous() : 0;
117         Paragraph * cursor_par_next = cursor_par ? cursor_par->next() : 0;
118         pos_type cursor_pos = text->cursor.pos();
119
120         bool found = false;
121
122         // Trap the deletion of the paragraph the cursor is in.
123         // Iterate until we find a paragraph that won't be immediately deleted.
124         // In reality this should mean we only execute the body of the while
125         // loop once at most.  However for safety we iterate rather than just
126         // make this an if () conditional.
127         while ((cursor_par_prev || cursor_par_next)
128                && text->setCursor(this,
129                                   cursor_par_prev ? cursor_par_prev : cursor_par_next,
130                                   0)) {
131                 // We just removed cursor_par so have to fix the "cursor"
132                 if (cursor_par_prev) {
133                         // '.' = cursor_par
134                         //  a -> a.
135                         // .
136                         cursor_par = cursor_par_prev;
137                         cursor_pos = cursor_par->size();
138                 } else {
139                         // .  -> .a
140                         //  a
141                         cursor_par = cursor_par_next;
142                         cursor_pos = 0;
143                 }
144                 cursor_par_prev = cursor_par->previous();
145                 cursor_par_next = cursor_par->next();
146         }
147
148         // Iterate through the paragraphs removing autoDelete insets as we go.
149         // If the paragraph ends up empty after all the autoDelete insets are
150         // removed that paragraph will be removed by the next setCursor() call.
151         ParIterator it = buffer()->par_iterator_begin();
152         ParIterator end = buffer()->par_iterator_end();
153         for (; it != end; ++it) {
154                 Paragraph * par = *it;
155                 Paragraph * par_prev = par ? par->previous() : 0;
156                 bool removed = false;
157
158                 if (text->setCursor(this, par, 0)
159                     && cursor_par == par_prev) {
160                         // The previous setCursor line was deleted and that
161                         // was the cursor_par line.  This can only happen if an
162                         // error box was the sole item on cursor_par.
163                         // It is possible for cursor_par_prev to be stray if
164                         // the line it pointed to only had a error box on it
165                         // so we have to set it to a known correct value.
166                         // This is often the same value it already had.
167                         cursor_par_prev = par->previous();
168                         if (cursor_par_prev) {
169                                 // '|' = par, '.' = cursor_par, 'E' = error box
170                                 // First step below may occur before while{}
171                                 //  a    |a      a     a     a.
172                                 //  E -> .E -> |.E -> .  -> |b
173                                 // .      b      b    |b
174                                 //  b
175                                 cursor_par = cursor_par_prev;
176                                 cursor_pos = cursor_par_prev->size();
177                                 cursor_par_prev = cursor_par->previous();
178                                 // cursor_par_next remains the same
179                         } else if (cursor_par_next) {
180                                 // First step below may occur before while{}
181                                 // .
182                                 //  E -> |.E -> |.  -> . -> .|a
183                                 //  a      a      a    |a
184                                 cursor_par = cursor_par_next;
185                                 cursor_pos = 0;
186                                 // cursor_par_prev remains unset
187                                 cursor_par_next = cursor_par->next();
188                         } else {
189                                 // I can't find a way to trigger this
190                                 // so it should be unreachable code
191                                 // unless the buffer is corrupted.
192                                 lyxerr << "BufferView::removeAutoInsets() is bad\n";
193                         }
194                 }
195
196                 InsetList::iterator pit = par->insetlist.begin();
197                 InsetList::iterator pend = par->insetlist.end();
198
199                 while (pit != pend) {
200                         if (pit.getInset()->autoDelete()) {
201                                 removed = true;
202                                 pos_type const pos = pit.getPos();
203
204                                 par->erase(pos);
205                                 // We just invalidated par's inset iterators so
206                                 // we get the next valid iterator position
207                                 pit = par->insetlist.insetIterator(pos);
208                                 // and ensure we have a valid end iterator.
209                                 pend = par->insetlist.end();
210
211                                 if (cursor_par == par) {
212                                         // update the saved cursor position
213                                         if (cursor_pos > pos)
214                                                 --cursor_pos;
215                                 }
216                         } else {
217                                 ++pit;
218                         }
219                 }
220                 if (removed) {
221                         found = true;
222                         text->redoParagraph(this);
223                 }
224         }
225
226         // It is possible that the last line is empty if it was cursor_par
227         // and/or only had an error inset on it.  So we set the cursor to the
228         // start of the doc to force its removal and ensure a valid saved cursor
229         if (text->setCursor(this, text->ownerParagraph(), 0)
230             && 0 == cursor_par_next) {
231                 cursor_par = cursor_par_prev;
232                 cursor_pos = cursor_par->size();
233         } else if (cursor_pos > cursor_par->size()) {
234                 // Some C-Enter lines were removed by the setCursor call which
235                 // then invalidated cursor_pos. It could still be "wrong" because
236                 // the cursor may appear to have jumped but since we collapsed
237                 // some C-Enter lines this should be a reasonable compromise.
238                 cursor_pos = cursor_par->size();
239         }
240
241         // restore the original cursor in its corrected location.
242         text->setCursorIntern(this, cursor_par, cursor_pos);
243
244         return found;
245 }
246
247
248 void BufferView::insertErrors(TeXErrors & terr)
249 {
250         // Save the cursor position
251         LyXCursor cursor = text->cursor;
252
253         TeXErrors::Errors::const_iterator cit = terr.begin();
254         TeXErrors::Errors::const_iterator end = terr.end();
255         for (; cit != end; ++cit) {
256                 string const desctext(cit->error_desc);
257                 string const errortext(cit->error_text);
258                 string const msgtxt = desctext + '\n' + errortext;
259                 int const errorrow = cit->error_in_line;
260
261                 // Insert error string for row number
262                 int tmpid = -1;
263                 int tmppos = -1;
264
265                 if (buffer()->texrow.getIdFromRow(errorrow, tmpid, tmppos)) {
266                         buffer()->texrow.increasePos(tmpid, tmppos);
267                 }
268
269                 Paragraph * texrowpar = 0;
270
271                 if (tmpid == -1) {
272                         texrowpar = text->ownerParagraph();
273                         tmppos = 0;
274                 } else {
275                         texrowpar = buffer()->getParFromID(tmpid);
276                 }
277
278                 if (texrowpar == 0)
279                         continue;
280
281                 freezeUndo();
282                 InsetError * new_inset = new InsetError(msgtxt);
283                 text->setCursorIntern(this, texrowpar, tmppos);
284                 text->insertInset(this, new_inset);
285                 text->fullRebreak(this);
286                 unFreezeUndo();
287         }
288         // Restore the cursor position
289         text->setCursorIntern(this, cursor.par(), cursor.pos());
290 }
291
292
293 void BufferView::setCursorFromRow(int row)
294 {
295         int tmpid = -1;
296         int tmppos = -1;
297
298         buffer()->texrow.getIdFromRow(row, tmpid, tmppos);
299
300         Paragraph * texrowpar;
301
302         if (tmpid == -1) {
303                 texrowpar = text->ownerParagraph();
304                 tmppos = 0;
305         } else {
306                 texrowpar = buffer()->getParFromID(tmpid);
307         }
308         text->setCursor(this, texrowpar, tmppos);
309 }
310
311
312 bool BufferView::insertInset(Inset * inset, string const & lout)
313 {
314         return pimpl_->insertInset(inset, lout);
315 }
316
317
318 /* This is also a buffer property (ale) */
319 // Not so sure about that. a goto Label function can not be buffer local, just
320 // think how this will work in a multiwindo/buffer environment, all the
321 // cursors in all the views showing this buffer will move. (Lgb)
322 // OK, then no cursor action should be allowed in buffer. (ale)
323 bool BufferView::gotoLabel(string const & label)
324
325 {
326         for (Buffer::inset_iterator it = buffer()->inset_iterator_begin();
327              it != buffer()->inset_iterator_end(); ++it) {
328                 vector<string> labels = (*it)->getLabelList();
329                 if (find(labels.begin(),labels.end(),label)
330                      != labels.end()) {
331                         beforeChange(text);
332                         text->setCursor(this, it.getPar(), it.getPos());
333                         text->selection.cursor = text->cursor;
334                         update(text, BufferView::SELECT|BufferView::FITCUR);
335                         return true;
336                 }
337         }
338         return false;
339 }
340
341
342 void BufferView::menuUndo()
343 {
344         if (!available())
345                 return;
346
347         owner()->message(_("Undo"));
348         hideCursor();
349         beforeChange(text);
350         update(text, BufferView::SELECT|BufferView::FITCUR);
351         if (!textUndo(this))
352                 owner()->message(_("No further undo information"));
353         else
354                 update(text, BufferView::SELECT|BufferView::FITCUR|BufferView::CHANGE);
355         switchKeyMap();
356 }
357
358
359 void BufferView::menuRedo()
360 {
361         if (!available())
362                 return;
363
364         owner()->message(_("Redo"));
365         hideCursor();
366         beforeChange(text);
367         update(text, BufferView::SELECT|BufferView::FITCUR);
368         if (!textRedo(this))
369                 owner()->message(_("No further redo information"));
370         else
371                 update(text, BufferView::SELECT|BufferView::FITCUR|BufferView::CHANGE);
372         switchKeyMap();
373 }
374
375
376 void BufferView::copyEnvironment()
377 {
378         if (available()) {
379                 text->copyEnvironmentType();
380                 owner()->message(_("Paragraph environment type copied"));
381         }
382 }
383
384
385 void BufferView::pasteEnvironment()
386 {
387         if (available()) {
388                 text->pasteEnvironmentType(this);
389                 owner()->message(_("Paragraph environment type set"));
390                 update(text, BufferView::SELECT|BufferView::FITCUR|BufferView::CHANGE);
391         }
392 }
393
394
395 void BufferView::copy()
396 {
397         if (available()) {
398                 getLyXText()->copySelection(this);
399                 owner()->message(_("Copy"));
400         }
401 }
402
403
404 void BufferView::cut(bool realcut)
405 {
406         if (available()) {
407                 hideCursor();
408                 update(text, BufferView::SELECT|BufferView::FITCUR);
409                 text->cutSelection(this, true, realcut);
410                 update(text, BufferView::SELECT|BufferView::FITCUR|BufferView::CHANGE);
411                 owner()->message(_("Cut"));
412         }
413 }
414
415
416 void BufferView::paste()
417 {
418         if (!available())
419                 return;
420
421         owner()->message(_("Paste"));
422
423         hideCursor();
424         // clear the selection
425         toggleSelection();
426         text->clearSelection();
427         update(text, BufferView::SELECT|BufferView::FITCUR);
428
429         // paste
430         text->pasteSelection(this);
431         // bug 393
432         text->clearSelection();
433         update(text, BufferView::SELECT|BufferView::FITCUR|BufferView::CHANGE);
434 // why fake a selection only I think it should be a real one and not only
435 // a painted one (Jug 20020318).
436 #if 0
437         // clear the selection
438         toggleSelection();
439         text->clearSelection();
440         update(text, BufferView::SELECT|BufferView::FITCUR);
441 #endif
442 }
443
444
445 /* these functions are for the spellchecker */
446 WordLangTuple const BufferView::nextWord(float & value)
447 {
448         if (!available()) {
449                 value = 1;
450                 return WordLangTuple();
451         }
452
453         return text->selectNextWordToSpellcheck(this, value);
454 }
455
456
457 void BufferView::selectLastWord()
458 {
459         if (!available())
460                 return;
461
462         LyXCursor cur = text->selection.cursor;
463         hideCursor();
464         beforeChange(text);
465         text->selection.cursor = cur;
466         text->selectSelectedWord(this);
467         toggleSelection(false);
468         update(text, BufferView::SELECT|BufferView::FITCUR);
469 }
470
471
472 void BufferView::endOfSpellCheck()
473 {
474         if (!available()) return;
475
476         hideCursor();
477         beforeChange(text);
478         text->selectSelectedWord(this);
479         text->clearSelection();
480         update(text, BufferView::SELECT|BufferView::FITCUR);
481 }
482
483
484 void BufferView::replaceWord(string const & replacestring)
485 {
486         if (!available())
487                 return;
488
489         LyXText * tt = getLyXText();
490         hideCursor();
491         update(tt, BufferView::SELECT|BufferView::FITCUR);
492
493         // clear the selection (if there is any)
494         toggleSelection(false);
495         update(tt, BufferView::SELECT|BufferView::FITCUR);
496
497         // clear the selection (if there is any)
498         toggleSelection(false);
499         tt->replaceSelectionWithString(this, replacestring);
500
501         tt->setSelectionOverString(this, replacestring);
502
503         // Go back so that replacement string is also spellchecked
504         for (string::size_type i = 0; i < replacestring.length() + 1; ++i) {
505                 tt->cursorLeft(this);
506         }
507         update(tt, BufferView::SELECT|BufferView::FITCUR|BufferView::CHANGE);
508 }
509 // End of spellchecker stuff
510
511
512 bool BufferView::lockInset(UpdatableInset * inset)
513 {
514         if (!inset)
515                 return false;
516         // don't relock if we're already locked
517         if (theLockingInset() == inset)
518                 return true;
519         if (!theLockingInset()) {
520                 // first check if it's the inset under the cursor we want lock
521                 // should be most of the time
522                 char const c = text->cursor.par()->getChar(text->cursor.pos());
523                 if (c == Paragraph::META_INSET) {
524                         Inset * in = text->cursor.par()->getInset(text->cursor.pos());
525                         if (inset == in) {
526                                 theLockingInset(inset);
527                                 return true;
528                         }
529                 }
530                 // Then do a deep look of the inset and lock the right one
531                 int const id = inset->id();
532                 ParagraphList::iterator pit = buffer()->paragraphs.begin();
533                 ParagraphList::iterator pend = buffer()->paragraphs.end();
534                 for (; pit != pend; ++pit) {
535                         InsetList::iterator it = pit->insetlist.begin();
536                         InsetList::iterator end = pit->insetlist.end();
537                         for (; it != end; ++it) {
538                                 if (it.getInset() == inset) {
539                                         text->setCursorIntern(this, &*pit, it.getPos());
540                                         theLockingInset(inset);
541                                         return true;
542                                 }
543                                 if (it.getInset()->getInsetFromID(id)) {
544                                         text->setCursorIntern(this, &*pit, it.getPos());
545                                         it.getInset()->edit(this);
546                                         return theLockingInset()->lockInsetInInset(this, inset);
547                                 }
548                         }
549                 }
550                 return false;
551         }
552         return theLockingInset()->lockInsetInInset(this, inset);
553 }
554
555
556 void BufferView::showLockedInsetCursor(int x, int y, int asc, int desc)
557 {
558         if (available() && theLockingInset() && !theLockingInset()->nodraw()) {
559                 LyXCursor cursor = text->cursor;
560                 Inset * locking_inset = theLockingInset()->getLockingInset();
561
562                 if ((cursor.pos() - 1 >= 0) &&
563                     cursor.par()->isInset(cursor.pos() - 1) &&
564                     (cursor.par()->getInset(cursor.pos() - 1) ==
565                      locking_inset))
566                         text->setCursor(this, cursor,
567                                         cursor.par(), cursor.pos() - 1);
568                 LyXScreen::Cursor_Shape shape = LyXScreen::BAR_SHAPE;
569                 LyXText * txt = getLyXText();
570                 if (locking_inset->isTextInset() &&
571                     locking_inset->lyxCode() != Inset::ERT_CODE &&
572                     (txt->real_current_font.language() !=
573                      buffer()->params.language
574                      || txt->real_current_font.isVisibleRightToLeft()
575                      != buffer()->params.language->RightToLeft()))
576                         shape = (txt->real_current_font.isVisibleRightToLeft())
577                                 ? LyXScreen::REVERSED_L_SHAPE
578                                 : LyXScreen::L_SHAPE;
579                 y += cursor.iy() + theLockingInset()->insetInInsetY();
580                 screen().showManualCursor(text, x, y, asc, desc,
581                                                   shape);
582         }
583 }
584
585
586 void BufferView::hideLockedInsetCursor()
587 {
588         if (theLockingInset() && available()) {
589                 screen().hideCursor();
590         }
591 }
592
593
594 bool BufferView::fitLockedInsetCursor(int x, int y, int asc, int desc)
595 {
596         if (theLockingInset() && available()) {
597                 y += text->cursor.iy() + theLockingInset()->insetInInsetY();
598                 if (screen().fitManualCursor(this, text, x, y, asc, desc)) {
599                         updateScrollbar();
600                         return true;
601                 }
602         }
603         return false;
604 }
605
606
607 int BufferView::unlockInset(UpdatableInset * inset)
608 {
609         if (!inset)
610                 return 0;
611         if (inset && theLockingInset() == inset) {
612                 inset->insetUnlock(this);
613                 theLockingInset(0);
614                 // make sure we update the combo !
615                 owner()->setLayout(getLyXText()->cursor.par()->layout()->name());
616                 // Tell the paragraph dialog that we changed paragraph
617                 owner()->getDialogs().updateParagraph();
618                 finishUndo();
619                 return 0;
620         } else if (inset && theLockingInset() &&
621                    theLockingInset()->unlockInsetInInset(this, inset)) {
622                 // Tell the paragraph dialog that we changed paragraph
623                 owner()->getDialogs().updateParagraph();
624                 // owner inset has updated the layout combo
625                 finishUndo();
626                 return 0;
627         }
628         return bufferlist.unlockInset(inset);
629 }
630
631
632 void BufferView::lockedInsetStoreUndo(Undo::undo_kind kind)
633 {
634         if (!theLockingInset())
635                 return; // shouldn't happen
636         if (kind == Undo::EDIT) // in this case insets would not be stored!
637                 kind = Undo::FINISH;
638         setUndo(this, kind,
639                 text->cursor.par(),
640                 text->cursor.par()->next());
641 }
642
643
644 void BufferView::updateInset(Inset * inset, bool mark_dirty)
645 {
646         pimpl_->updateInset(inset, mark_dirty);
647 }
648
649
650 bool BufferView::ChangeInsets(Inset::Code code,
651                               string const & from, string const & to)
652 {
653         bool need_update = false;
654         LyXCursor cursor = text->cursor;
655         LyXCursor tmpcursor = cursor;
656         cursor.par(tmpcursor.par());
657         cursor.pos(tmpcursor.pos());
658
659         ParIterator end = buffer()->par_iterator_end();
660         for (ParIterator it = buffer()->par_iterator_begin();
661              it != end; ++it) {
662                 Paragraph * par = *it;
663                 bool changed_inset = false;
664                 for (InsetList::iterator it2 = par->insetlist.begin();
665                      it2 != par->insetlist.end(); ++it2) {
666                         if (it2.getInset()->lyxCode() == code) {
667                                 InsetCommand * inset = static_cast<InsetCommand *>(it2.getInset());
668                                 if (inset->getContents() == from) {
669                                         inset->setContents(to);
670                                         changed_inset = true;
671                                 }
672                         }
673                 }
674                 if (changed_inset) {
675                         need_update = true;
676
677                         // FIXME
678
679                         // The test it.size()==1 was needed to prevent crashes.
680                         // How to set the cursor corretly when it.size()>1 ??
681                         if (it.size() == 1) {
682                                 text->setCursorIntern(this, par, 0);
683                                 text->redoParagraphs(this, text->cursor,
684                                                      text->cursor.par()->next());
685                                 text->fullRebreak(this);
686                         }
687                 }
688         }
689         text->setCursorIntern(this, cursor.par(), cursor.pos());
690         return need_update;
691 }
692
693
694 bool BufferView::ChangeRefsIfUnique(string const & from, string const & to)
695 {
696         // Check if the label 'from' appears more than once
697         vector<string> labels = buffer()->getLabelList();
698
699         if (lyx::count(labels.begin(), labels.end(), from) > 1)
700                 return false;
701
702         return ChangeInsets(Inset::REF_CODE, from, to);
703 }
704
705
706 bool BufferView::ChangeCitationsIfUnique(string const & from,
707                                          string const & to)
708 {
709         typedef pair<string, string> StringPair;
710
711         vector<StringPair> keys = buffer()->getBibkeyList();
712         if (count_if(keys.begin(), keys.end(),
713                      lyx::equal_1st_in_pair<StringPair>(from))
714             > 1)
715                 return false;
716
717         return ChangeInsets(Inset::CITE_CODE, from, to);
718 }
719
720
721 UpdatableInset * BufferView::theLockingInset() const
722 {
723         // If NULL is not allowed we should put an Assert here. (Lgb)
724         if (text)
725                 return text->the_locking_inset;
726         return 0;
727 }
728
729
730 void BufferView::theLockingInset(UpdatableInset * inset)
731 {
732         text->the_locking_inset = inset;
733 }
734
735
736 LyXText * BufferView::getLyXText() const
737 {
738         if (theLockingInset()) {
739                 LyXText * txt = theLockingInset()->getLyXText(this, true);
740                 if (txt)
741                         return txt;
742         }
743         return text;
744 }
745
746
747 LyXText * BufferView::getParentText(Inset * inset) const
748 {
749         if (inset->owner()) {
750                 LyXText * txt = inset->getLyXText(this);
751                 inset = inset->owner();
752                 while (inset && inset->getLyXText(this) == txt)
753                         inset = inset->owner();
754                 if (inset)
755                         return inset->getLyXText(this);
756         }
757         return text;
758 }
759
760
761 Language const * BufferView::getParentLanguage(Inset * inset) const
762 {
763         LyXText * text = getParentText(inset);
764         return text->cursor.par()->getFontSettings(buffer()->params,
765                                                    text->cursor.pos()).language();
766 }