]> git.lyx.org Git - lyx.git/blob - src/paragraph_pimpl.C
* lfuns.h: new LFUN_REPEAT, LFUN_INSERT_LINE, LFUN_INSERT_PAGEBREAK
[lyx.git] / src / paragraph_pimpl.C
1 /**
2  * \file paragraph_pimpl.C
3  * This file is part of LyX, the document processor.
4  * Licence details can be found in the file COPYING.
5  *
6  * \author Lars Gullik Bjønnes
7  * \author Jean-Marc Lasgouttes
8  * \author John Levon
9  * \author André Pönitz
10  *
11  * Full author contact details are available in file CREDITS.
12  */
13
14 #include <config.h>
15
16 #include "paragraph_pimpl.h"
17
18 #include "bufferparams.h"
19 #include "debug.h"
20 #include "encoding.h"
21 #include "language.h"
22 #include "LaTeXFeatures.h"
23 #include "latexrunparams.h"
24 #include "LColor.h"
25 #include "lyxlength.h"
26 #include "lyxrc.h"
27 #include "texrow.h"
28
29
30 using lyx::pos_type;
31
32 using std::endl;
33 using std::upper_bound;
34 using std::lower_bound;
35 using std::string;
36 using std::ostream;
37
38
39 // Initialize static member.
40 ShareContainer<LyXFont> Paragraph::Pimpl::FontTable::container;
41 // Initialization of the counter for the paragraph id's,
42 unsigned int Paragraph::Pimpl::paragraph_id = 0;
43
44 namespace {
45
46 struct special_phrase {
47         string phrase;
48         string macro;
49         bool builtin;
50 };
51
52 special_phrase special_phrases[] = {
53         { "LyX", "\\LyX{}", false },
54         { "TeX", "\\TeX{}", true },
55         { "LaTeX2e", "\\LaTeXe{}", true },
56         { "LaTeX", "\\LaTeX{}", true },
57 };
58
59 size_t const phrases_nr = sizeof(special_phrases)/sizeof(special_phrase);
60
61 } // namespace anon
62
63
64 Paragraph::Pimpl::Pimpl(Paragraph * owner)
65         : owner_(owner)
66 {
67         inset_owner = 0;
68         id_ = paragraph_id++;
69 }
70
71
72 Paragraph::Pimpl::Pimpl(Pimpl const & p, Paragraph * owner)
73         : params(p.params), owner_(owner)
74 {
75         inset_owner = p.inset_owner;
76         fontlist = p.fontlist;
77         id_ = paragraph_id++;
78
79         if (p.tracking())
80                 changes_.reset(new Changes(*p.changes_.get()));
81 }
82
83
84 void Paragraph::Pimpl::setContentsFromPar(Paragraph const & par)
85 {
86         owner_->text_ = par.text_;
87         if (par.pimpl_->tracking()) {
88                 changes_.reset(new Changes(*(par.pimpl_->changes_.get())));
89         }
90 }
91
92
93 void Paragraph::Pimpl::trackChanges(Change::Type type)
94 {
95         if (tracking()) {
96                 lyxerr[Debug::CHANGES] << "already tracking for par " << id_ << endl;
97                 return;
98         }
99
100         lyxerr[Debug::CHANGES] << "track changes for par "
101                 << id_ << " type " << type << endl;
102         changes_.reset(new Changes(type));
103         changes_->set(type, 0, size());
104 }
105
106
107 void Paragraph::Pimpl::untrackChanges()
108 {
109         changes_.reset(0);
110 }
111
112
113 void Paragraph::Pimpl::cleanChanges()
114 {
115         // if we're not tracking, we don't want to reset...
116         if (!tracking())
117                 return;
118
119         changes_.reset(new Changes(Change::INSERTED));
120         changes_->set(Change::INSERTED, 0, size());
121 }
122
123
124 bool Paragraph::Pimpl::isChanged(pos_type start, pos_type end) const
125 {
126         if (!tracking())
127                 return false;
128
129         return changes_->isChange(start, end);
130 }
131
132
133 bool Paragraph::Pimpl::isChangeEdited(pos_type start, pos_type end) const
134 {
135         if (!tracking())
136                 return false;
137
138         return changes_->isChangeEdited(start, end);
139 }
140
141
142 void Paragraph::Pimpl::setChange(pos_type pos, Change::Type type)
143 {
144         if (!tracking())
145                 return;
146
147         changes_->set(type, pos);
148 }
149
150
151 Change::Type Paragraph::Pimpl::lookupChange(pos_type pos) const
152 {
153         if (!tracking())
154                 return Change::UNCHANGED;
155
156         return changes_->lookup(pos);
157 }
158
159
160 Change const Paragraph::Pimpl::lookupChangeFull(pos_type pos) const
161 {
162         if (!tracking())
163                 return Change(Change::UNCHANGED);
164
165         return changes_->lookupFull(pos);
166 }
167
168
169 void Paragraph::Pimpl::markErased()
170 {
171         BOOST_ASSERT(tracking());
172
173         // FIXME: we should actually remove INSERTED chars.
174         // difficult because owning insettexts/tabulars need
175         // to update themselves when rows etc. change
176         changes_->set(Change::DELETED, 0, size());
177         changes_->reset(Change::DELETED);
178 }
179
180
181 void Paragraph::Pimpl::acceptChange(pos_type start, pos_type end)
182 {
183         if (!tracking())
184                 return;
185
186         if (!size()) {
187                 changes_.reset(new Changes(Change::UNCHANGED));
188                 return;
189         }
190
191         lyxerr << "acceptchange" << endl;
192         pos_type i = start;
193
194         for (; i < end; ++i) {
195                 switch (lookupChange(i)) {
196                         case Change::UNCHANGED:
197                                 break;
198
199                         case Change::INSERTED:
200                                 changes_->set(Change::UNCHANGED, i);
201                                 break;
202
203                         case Change::DELETED:
204                                 eraseIntern(i);
205                                 changes_->erase(i);
206                                 --end;
207                                 --i;
208                                 break;
209                 }
210         }
211
212         lyxerr << "endacceptchange" << endl;
213         changes_->reset(Change::UNCHANGED);
214 }
215
216
217 void Paragraph::Pimpl::rejectChange(pos_type start, pos_type end)
218 {
219         if (!tracking())
220                 return;
221
222         if (!size()) {
223                 changes_.reset(new Changes(Change::UNCHANGED));
224                 return;
225         }
226
227         pos_type i = start;
228
229         for (; i < end; ++i) {
230                 switch (lookupChange(i)) {
231                         case Change::UNCHANGED:
232                                 break;
233
234                         case Change::INSERTED:
235                                 eraseIntern(i);
236                                 changes_->erase(i);
237                                 --end;
238                                 --i;
239                                 break;
240
241                         case Change::DELETED:
242                                 changes_->set(Change::UNCHANGED, i);
243                                 break;
244                 }
245         }
246         changes_->reset(Change::UNCHANGED);
247 }
248
249
250 Paragraph::value_type Paragraph::Pimpl::getChar(pos_type pos) const
251 {
252         return owner_->getChar(pos);
253 }
254
255
256 void Paragraph::Pimpl::insertChar(pos_type pos, value_type c,
257                                   LyXFont const & font, Change change)
258 {
259         BOOST_ASSERT(pos <= size());
260
261         if (tracking()) {
262                 changes_->record(change, pos);
263         }
264
265         // This is actually very common when parsing buffers (and
266         // maybe inserting ascii text)
267         if (pos == size()) {
268                 // when appending characters, no need to update tables
269                 owner_->text_.push_back(c);
270                 owner_->setFont(pos, font);
271                 return;
272         }
273
274         owner_->text_.insert(owner_->text_.begin() + pos, c);
275
276         // Update the font table.
277         FontTable search_font(pos, LyXFont());
278         for (FontList::iterator it = lower_bound(fontlist.begin(),
279                                                       fontlist.end(),
280                                                       search_font, matchFT());
281              it != fontlist.end(); ++it)
282         {
283                 it->pos(it->pos() + 1);
284         }
285
286         // Update the insets
287         owner_->insetlist.increasePosAfterPos(pos);
288
289         owner_->setFont(pos, font);
290 }
291
292
293 void Paragraph::Pimpl::insertInset(pos_type pos,
294                                    InsetOld * inset, LyXFont const & font, Change change)
295 {
296         BOOST_ASSERT(inset);
297         BOOST_ASSERT(pos <= size());
298
299         insertChar(pos, META_INSET, font, change);
300         BOOST_ASSERT(owner_->text_[pos] == META_INSET);
301
302         // Add a new entry in the insetlist.
303         owner_->insetlist.insert(inset, pos);
304
305         if (inset_owner)
306                 inset->setOwner(inset_owner);
307 }
308
309
310 void Paragraph::Pimpl::eraseIntern(pos_type pos)
311 {
312         // if it is an inset, delete the inset entry
313         if (owner_->text_[pos] == Paragraph::META_INSET) {
314                 owner_->insetlist.erase(pos);
315         }
316
317         owner_->text_.erase(owner_->text_.begin() + pos);
318
319         // Erase entries in the tables.
320         FontTable search_font(pos, LyXFont());
321
322         FontList::iterator it =
323                 lower_bound(fontlist.begin(),
324                             fontlist.end(),
325                             search_font, matchFT());
326         if (it != fontlist.end() && it->pos() == pos &&
327             (pos == 0 ||
328              (it != fontlist.begin()
329               && boost::prior(it)->pos() == pos - 1))) {
330                 // If it is a multi-character font
331                 // entry, we just make it smaller
332                 // (see update below), otherwise we
333                 // should delete it.
334                 unsigned int const i = it - fontlist.begin();
335                 fontlist.erase(fontlist.begin() + i);
336                 it = fontlist.begin() + i;
337                 if (i > 0 && i < fontlist.size() &&
338                     fontlist[i - 1].font() == fontlist[i].font()) {
339                         fontlist.erase(fontlist.begin() + i - 1);
340                         it = fontlist.begin() + i - 1;
341                 }
342         }
343
344         // Update all other entries.
345         FontList::iterator fend = fontlist.end();
346         for (; it != fend; ++it)
347                 it->pos(it->pos() - 1);
348
349         // Update the insetlist.
350         owner_->insetlist.decreasePosAfterPos(pos);
351 }
352
353
354 bool Paragraph::Pimpl::erase(pos_type pos)
355 {
356         BOOST_ASSERT(pos < size());
357
358         if (tracking()) {
359                 Change::Type changetype(changes_->lookup(pos));
360                 changes_->record(Change(Change::DELETED), pos);
361
362                 // only allow the actual removal if it was /new/ text
363                 if (changetype != Change::INSERTED) {
364                         if (owner_->text_[pos] == Paragraph::META_INSET) {
365                                 InsetOld * i(owner_->getInset(pos));
366                                 i->markErased();
367                         }
368                         return false;
369                 }
370         }
371
372         eraseIntern(pos);
373         return true;
374 }
375
376
377 int Paragraph::Pimpl::erase(pos_type start, pos_type end)
378 {
379         pos_type i = start;
380         pos_type count = end - start;
381         while (count) {
382                 if (!erase(i)) {
383                         ++i;
384                 }
385                 --count;
386         }
387         return end - i;
388 }
389
390
391 void Paragraph::Pimpl::simpleTeXBlanks(ostream & os, TexRow & texrow,
392                                        pos_type const i,
393                                        unsigned int & column,
394                                        LyXFont const & font,
395                                        LyXLayout const & style)
396 {
397         if (style.pass_thru)
398                 return;
399
400         if (column > lyxrc.ascii_linelen
401             && i
402             && getChar(i - 1) != ' '
403             && (i < size() - 1)
404             // same in FreeSpacing mode
405             && !owner_->isFreeSpacing()
406             // In typewriter mode, we want to avoid
407             // ! . ? : at the end of a line
408             && !(font.family() == LyXFont::TYPEWRITER_FAMILY
409                  && (getChar(i - 1) == '.'
410                      || getChar(i - 1) == '?'
411                      || getChar(i - 1) == ':'
412                      || getChar(i - 1) == '!'))) {
413                 os << '\n';
414                 texrow.newline();
415                 texrow.start(owner_->id(), i + 1);
416                 column = 0;
417         } else if (style.free_spacing) {
418                 os << '~';
419         } else {
420                 os << ' ';
421         }
422 }
423
424
425 bool Paragraph::Pimpl::isTextAt(string const & str, pos_type pos) const
426 {
427         pos_type const len = str.length();
428
429         // is the paragraph large enough?
430         if (pos + len > size())
431                 return false;
432
433         // does the wanted text start at point?
434         for (string::size_type i = 0; i < str.length(); ++i) {
435                 if (str[i] != owner_->text_[pos + i])
436                         return false;
437         }
438
439         // is there a font change in middle of the word?
440         FontList::const_iterator cit = fontlist.begin();
441         FontList::const_iterator end = fontlist.end();
442         for (; cit != end; ++cit) {
443                 if (cit->pos() >= pos)
444                         break;
445         }
446         if (cit != end && pos + len - 1 > cit->pos())
447                 return false;
448
449         return true;
450 }
451
452
453 void Paragraph::Pimpl::simpleTeXSpecialChars(Buffer const & buf,
454                                              BufferParams const & bparams,
455                                              ostream & os,
456                                              TexRow & texrow,
457                                              LatexRunParams const & runparams,
458                                              LyXFont & font,
459                                              LyXFont & running_font,
460                                              LyXFont & basefont,
461                                              LyXFont const & outerfont,
462                                              bool & open_font,
463                                              Change::Type & running_change,
464                                              LyXLayout const & style,
465                                              pos_type & i,
466                                              unsigned int & column,
467                                              value_type const c)
468 {
469         if (style.pass_thru) {
470                 if (c != Paragraph::META_INSET) {
471                         if (c != '\0')
472                                 os << c;
473                 } else {
474                         InsetOld const * inset = owner_->getInset(i);
475                         inset->ascii(buf, os, 0);
476                 }
477                 return;
478         }
479
480         // Two major modes:  LaTeX or plain
481         // Handle here those cases common to both modes
482         // and then split to handle the two modes separately.
483         switch (c) {
484         case Paragraph::META_INSET: {
485                 InsetOld * inset = owner_->getInset(i);
486
487                 // FIXME: remove this check
488                 if (!inset)
489                         break;
490
491                 // FIXME: move this to InsetNewline::latex
492                 if (inset->lyxCode() == InsetOld::NEWLINE_CODE) {
493                         // newlines are handled differently here than
494                         // the default in simpleTeXSpecialChars().
495                         if (!style.newline_allowed) {
496                                 os << '\n';
497                         } else {
498                                 if (open_font) {
499                                         column += running_font.latexWriteEndChanges(os, basefont, basefont);
500                                         open_font = false;
501                                 }
502                                 basefont = owner_->getLayoutFont(bparams, outerfont);
503                                 running_font = basefont;
504
505                                 if (font.family() == LyXFont::TYPEWRITER_FAMILY)
506                                         os << '~';
507
508                                 if (runparams.moving_arg)
509                                         os << "\\protect ";
510
511                                 os << "\\\\\n";
512                         }
513                         texrow.newline();
514                         texrow.start(owner_->id(), i + 1);
515                         column = 0;
516                         break;
517                 }
518
519                 if (inset->isTextInset()) {
520                         column += Changes::latexMarkChange(os, running_change,
521                                 Change::UNCHANGED);
522                         running_change = Change::UNCHANGED;
523                 }
524
525                 bool close = false;
526                 ostream::pos_type const len = os.tellp();
527
528                 if ((inset->lyxCode() == InsetOld::GRAPHICS_CODE
529                      || inset->lyxCode() == InsetOld::MATH_CODE
530                      || inset->lyxCode() == InsetOld::URL_CODE)
531                     && running_font.isRightToLeft()) {
532                         os << "\\L{";
533                         close = true;
534                 }
535
536 #ifdef WITH_WARNINGS
537 #warning Bug: we can have an empty font change here!
538 // if there has just been a font change, we are going to close it
539 // right now, which means stupid latex code like \textsf{}. AFAIK,
540 // this does not harm dvi output. A minor bug, thus (JMarc)
541 #endif
542                 // some insets cannot be inside a font change command
543                 if (open_font && inset->noFontChange()) {
544                         column +=running_font.
545                                 latexWriteEndChanges(os,
546                                                      basefont,
547                                                      basefont);
548                         open_font = false;
549                         basefont = owner_->getLayoutFont(bparams, outerfont);
550                         running_font = basefont;
551                 }
552
553                 int tmp = inset->latex(buf, os, runparams);
554
555                 if (close)
556                         os << '}';
557
558                 if (tmp) {
559                         for (int j = 0; j < tmp; ++j) {
560                                 texrow.newline();
561                         }
562                         texrow.start(owner_->id(), i + 1);
563                         column = 0;
564                 } else {
565                         column += os.tellp() - len;
566                 }
567         }
568         break;
569
570         default:
571                 // And now for the special cases within each mode
572
573                 switch (c) {
574                 case '\\':
575                         os << "\\textbackslash{}";
576                         column += 15;
577                         break;
578
579                 case '±': case '²': case '³':
580                 case '×': case '÷': case '¹':
581                 case '¬': case 'µ':
582                         if ((bparams.inputenc == "latin1" ||
583                              bparams.inputenc == "latin9") ||
584                             (bparams.inputenc == "auto" &&
585                              (font.language()->encoding()->LatexName()
586                               == "latin1" ||
587                               font.language()->encoding()->LatexName()
588                               == "latin9"))) {
589                                 os << "\\ensuremath{"
590                                    << c
591                                    << '}';
592                                 column += 13;
593                         } else {
594                                 os << c;
595                         }
596                         break;
597
598                 case '|': case '<': case '>':
599                         // In T1 encoding, these characters exist
600                         if (lyxrc.fontenc == "T1") {
601                                 os << c;
602                                 //... but we should avoid ligatures
603                                 if ((c == '>' || c == '<')
604                                     && i <= size() - 2
605                                     && getChar(i + 1) == c) {
606                                         //os << "\\textcompwordmark{}";
607                                         // Jean-Marc, have a look at
608                                         // this. I think this works
609                                         // equally well:
610                                         os << "\\,{}";
611                                         // Lgb
612                                         column += 19;
613                                 }
614                                 break;
615                         }
616                         // Typewriter font also has them
617                         if (font.family() == LyXFont::TYPEWRITER_FAMILY) {
618                                 os << c;
619                                 break;
620                         }
621                         // Otherwise, we use what LaTeX
622                         // provides us.
623                         switch (c) {
624                         case '<':
625                                 os << "\\textless{}";
626                                 column += 10;
627                                 break;
628                         case '>':
629                                 os << "\\textgreater{}";
630                                 column += 13;
631                                 break;
632                         case '|':
633                                 os << "\\textbar{}";
634                                 column += 9;
635                                 break;
636                         }
637                         break;
638
639                 case '-': // "--" in Typewriter mode -> "-{}-"
640                         if (i <= size() - 2
641                             && getChar(i + 1) == '-'
642                             && font.family() == LyXFont::TYPEWRITER_FAMILY) {
643                                 os << "-{}";
644                                 column += 2;
645                         } else {
646                                 os << '-';
647                         }
648                         break;
649
650                 case '\"':
651                         os << "\\char`\\\"{}";
652                         column += 9;
653                         break;
654
655                 case '£':
656                         if (bparams.inputenc == "default") {
657                                 os << "\\pounds{}";
658                                 column += 8;
659                         } else {
660                                 os << c;
661                         }
662                         break;
663
664                 case '$': case '&':
665                 case '%': case '#': case '{':
666                 case '}': case '_':
667                         os << '\\' << c;
668                         column += 1;
669                         break;
670
671                 case '~':
672                         os << "\\textasciitilde{}";
673                         column += 16;
674                         break;
675
676                 case '^':
677                         os << "\\textasciicircum{}";
678                         column += 17;
679                         break;
680
681                 case '*': case '[': case ']':
682                         // avoid being mistaken for optional arguments
683                         os << '{' << c << '}';
684                         column += 2;
685                         break;
686
687                 case ' ':
688                         // Blanks are printed before font switching.
689                         // Sure? I am not! (try nice-latex)
690                         // I am sure it's correct. LyX might be smarter
691                         // in the future, but for now, nothing wrong is
692                         // written. (Asger)
693                         break;
694
695                 default:
696
697                         // I assume this is hack treating typewriter as verbatim
698                         if (font.family() == LyXFont::TYPEWRITER_FAMILY) {
699                                 if (c != '\0') {
700                                         os << c;
701                                 }
702                                 break;
703                         }
704
705                         // LyX, LaTeX etc.
706
707                         // FIXME: if we have "LaTeX" with a font
708                         // change in the middle (before the 'T', then
709                         // the "TeX" part is still special cased.
710                         // Really we should only operate this on
711                         // "words" for some definition of word
712
713                         size_t pnr = 0;
714
715                         for (; pnr < phrases_nr; ++pnr) {
716                                 if (isTextAt(special_phrases[pnr].phrase, i)) {
717                                         os << special_phrases[pnr].macro;
718                                         i += special_phrases[pnr].phrase.length() - 1;
719                                         column += special_phrases[pnr].macro.length() - 1;
720                                         break;
721                                 }
722                         }
723
724                         if (pnr == phrases_nr && c != '\0') {
725                                 os << c;
726                         }
727                         break;
728                 }
729         }
730 }
731
732
733 void Paragraph::Pimpl::validate(LaTeXFeatures & features,
734                                 LyXLayout const & layout) const
735 {
736         BufferParams const & bparams = features.bufferParams();
737
738         // check the params.
739         if (!params.spacing().isDefault())
740                 features.require("setspace");
741
742         // then the layouts
743         features.useLayout(layout.name());
744
745         // then the fonts
746         Language const * doc_language = bparams.language;
747
748         FontList::const_iterator fcit = fontlist.begin();
749         FontList::const_iterator fend = fontlist.end();
750         for (; fcit != fend; ++fcit) {
751                 if (fcit->font().noun() == LyXFont::ON) {
752                         lyxerr[Debug::LATEX] << "font.noun: "
753                                              << fcit->font().noun()
754                                              << endl;
755                         features.require("noun");
756                         lyxerr[Debug::LATEX] << "Noun enabled. Font: "
757                                              << fcit->font().stateText(0)
758                                              << endl;
759                 }
760                 switch (fcit->font().color()) {
761                 case LColor::none:
762                 case LColor::inherit:
763                 case LColor::ignore:
764                         // probably we should put here all interface colors used for
765                         // font displaying! For now I just add this ones I know of (Jug)
766                 case LColor::latex:
767                 case LColor::note:
768                         break;
769                 default:
770                         features.require("color");
771                         lyxerr[Debug::LATEX] << "Color enabled. Font: "
772                                              << fcit->font().stateText(0)
773                                              << endl;
774                 }
775
776                 Language const * language = fcit->font().language();
777                 if (language->babel() != doc_language->babel() &&
778                     language != ignore_language &&
779                     language != latex_language)
780                 {
781                         features.useLanguage(language);
782                         lyxerr[Debug::LATEX] << "Found language "
783                                              << language->babel() << endl;
784                 }
785         }
786
787         if (!params.leftIndent().zero())
788                 features.require("ParagraphLeftIndent");
789
790         // then the insets
791         InsetList::iterator icit = owner_->insetlist.begin();
792         InsetList::iterator iend = owner_->insetlist.end();
793         for (; icit != iend; ++icit) {
794                 if (icit->inset) {
795                         icit->inset->validate(features);
796                         if (layout.needprotect &&
797                             icit->inset->lyxCode() == InsetOld::FOOT_CODE)
798                                 features.require("NeedLyXFootnoteCode");
799                 }
800         }
801
802         // then the contents
803         for (pos_type i = 0; i < size() ; ++i) {
804                 for (size_t pnr = 0; pnr < phrases_nr; ++pnr) {
805                         if (!special_phrases[pnr].builtin
806                             && isTextAt(special_phrases[pnr].phrase, i)) {
807                                 features.require(special_phrases[pnr].phrase);
808                                 break;
809                         }
810                 }
811         }
812 }