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