]> git.lyx.org Git - lyx.git/blob - src/paragraph_pimpl.C
some integer type changes for inset unification
[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 "LColor.h"
24 #include "lyxlength.h"
25 #include "lyxrc.h"
26 #include "outputparams.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                                 owner_->getInset(pos)->markErased();
366                         }
367                         return false;
368                 }
369         }
370
371         eraseIntern(pos);
372         return true;
373 }
374
375
376 int Paragraph::Pimpl::erase(pos_type start, pos_type end)
377 {
378         pos_type i = start;
379         for (pos_type count = end - start; count; --count) {
380                 if (!erase(i))
381                         ++i;
382         }
383         return end - i;
384 }
385
386
387 void Paragraph::Pimpl::simpleTeXBlanks(ostream & os, TexRow & texrow,
388                                        pos_type const i,
389                                        unsigned int & column,
390                                        LyXFont const & font,
391                                        LyXLayout const & style)
392 {
393         if (style.pass_thru)
394                 return;
395
396         if (column > lyxrc.ascii_linelen
397             && i
398             && getChar(i - 1) != ' '
399             && (i < size() - 1)
400             // same in FreeSpacing mode
401             && !owner_->isFreeSpacing()
402             // In typewriter mode, we want to avoid
403             // ! . ? : at the end of a line
404             && !(font.family() == LyXFont::TYPEWRITER_FAMILY
405                  && (getChar(i - 1) == '.'
406                      || getChar(i - 1) == '?'
407                      || getChar(i - 1) == ':'
408                      || getChar(i - 1) == '!'))) {
409                 os << '\n';
410                 texrow.newline();
411                 texrow.start(owner_->id(), i + 1);
412                 column = 0;
413         } else if (style.free_spacing) {
414                 os << '~';
415         } else {
416                 os << ' ';
417         }
418 }
419
420
421 bool Paragraph::Pimpl::isTextAt(string const & str, pos_type pos) const
422 {
423         pos_type const len = str.length();
424
425         // is the paragraph large enough?
426         if (pos + len > size())
427                 return false;
428
429         // does the wanted text start at point?
430         for (string::size_type i = 0; i < str.length(); ++i) {
431                 if (str[i] != owner_->text_[pos + i])
432                         return false;
433         }
434
435         // is there a font change in middle of the word?
436         FontList::const_iterator cit = fontlist.begin();
437         FontList::const_iterator end = fontlist.end();
438         for (; cit != end; ++cit) {
439                 if (cit->pos() >= pos)
440                         break;
441         }
442         if (cit != end && pos + len - 1 > cit->pos())
443                 return false;
444
445         return true;
446 }
447
448
449 void Paragraph::Pimpl::simpleTeXSpecialChars(Buffer const & buf,
450                                              BufferParams const & bparams,
451                                              ostream & os,
452                                              TexRow & texrow,
453                                              OutputParams const & runparams,
454                                              LyXFont & font,
455                                              LyXFont & running_font,
456                                              LyXFont & basefont,
457                                              LyXFont const & outerfont,
458                                              bool & open_font,
459                                              Change::Type & running_change,
460                                              LyXLayout const & style,
461                                              pos_type & i,
462                                              unsigned int & column,
463                                              value_type const c)
464 {
465         if (style.pass_thru) {
466                 if (c != Paragraph::META_INSET) {
467                         if (c != '\0')
468                                 os << c;
469                 } else {
470                         InsetOld const * inset = owner_->getInset(i);
471                         inset->plaintext(buf, os, runparams);
472                 }
473                 return;
474         }
475
476         // Two major modes:  LaTeX or plain
477         // Handle here those cases common to both modes
478         // and then split to handle the two modes separately.
479         switch (c) {
480         case Paragraph::META_INSET: {
481                 InsetOld * inset = owner_->getInset(i);
482
483                 // FIXME: remove this check
484                 if (!inset)
485                         break;
486
487                 // FIXME: move this to InsetNewline::latex
488                 if (inset->lyxCode() == InsetOld::NEWLINE_CODE) {
489                         // newlines are handled differently here than
490                         // the default in simpleTeXSpecialChars().
491                         if (!style.newline_allowed) {
492                                 os << '\n';
493                         } else {
494                                 if (open_font) {
495                                         column += running_font.latexWriteEndChanges(os, basefont, basefont);
496                                         open_font = false;
497                                 }
498                                 basefont = owner_->getLayoutFont(bparams, outerfont);
499                                 running_font = basefont;
500
501                                 if (font.family() == LyXFont::TYPEWRITER_FAMILY)
502                                         os << '~';
503
504                                 if (runparams.moving_arg)
505                                         os << "\\protect ";
506
507                                 os << "\\\\\n";
508                         }
509                         texrow.newline();
510                         texrow.start(owner_->id(), i + 1);
511                         column = 0;
512                         break;
513                 }
514
515                 if (inset->isTextInset()) {
516                         column += Changes::latexMarkChange(os, running_change,
517                                 Change::UNCHANGED);
518                         running_change = Change::UNCHANGED;
519                 }
520
521                 bool close = false;
522                 ostream::pos_type const len = os.tellp();
523
524                 if ((inset->lyxCode() == InsetOld::GRAPHICS_CODE
525                      || inset->lyxCode() == InsetOld::MATH_CODE
526                      || inset->lyxCode() == InsetOld::URL_CODE)
527                     && running_font.isRightToLeft()) {
528                         os << "\\L{";
529                         close = true;
530                 }
531
532 #ifdef WITH_WARNINGS
533 #warning Bug: we can have an empty font change here!
534 // if there has just been a font change, we are going to close it
535 // right now, which means stupid latex code like \textsf{}. AFAIK,
536 // this does not harm dvi output. A minor bug, thus (JMarc)
537 #endif
538                 // some insets cannot be inside a font change command
539                 if (open_font && inset->noFontChange()) {
540                         column +=running_font.
541                                 latexWriteEndChanges(os,
542                                                      basefont,
543                                                      basefont);
544                         open_font = false;
545                         basefont = owner_->getLayoutFont(bparams, outerfont);
546                         running_font = basefont;
547                 }
548
549                 int tmp = inset->latex(buf, os, runparams);
550
551                 if (close)
552                         os << '}';
553
554                 if (tmp) {
555                         for (int j = 0; j < tmp; ++j) {
556                                 texrow.newline();
557                         }
558                         texrow.start(owner_->id(), i + 1);
559                         column = 0;
560                 } else {
561                         column += os.tellp() - len;
562                 }
563         }
564         break;
565
566         default:
567                 // And now for the special cases within each mode
568
569                 switch (c) {
570                 case '\\':
571                         os << "\\textbackslash{}";
572                         column += 15;
573                         break;
574
575                 case '±': case '²': case '³':
576                 case '×': case '÷': case '¹':
577                 case '¬': case 'µ':
578                         if ((bparams.inputenc == "latin1" ||
579                              bparams.inputenc == "latin9") ||
580                             (bparams.inputenc == "auto" &&
581                              (font.language()->encoding()->LatexName()
582                               == "latin1" ||
583                               font.language()->encoding()->LatexName()
584                               == "latin9"))) {
585                                 os << "\\ensuremath{"
586                                    << c
587                                    << '}';
588                                 column += 13;
589                         } else {
590                                 os << c;
591                         }
592                         break;
593
594                 case '|': case '<': case '>':
595                         // In T1 encoding, these characters exist
596                         if (lyxrc.fontenc == "T1") {
597                                 os << c;
598                                 //... but we should avoid ligatures
599                                 if ((c == '>' || c == '<')
600                                     && i <= size() - 2
601                                     && getChar(i + 1) == c) {
602                                         //os << "\\textcompwordmark{}";
603                                         // Jean-Marc, have a look at
604                                         // this. I think this works
605                                         // equally well:
606                                         os << "\\,{}";
607                                         // Lgb
608                                         column += 19;
609                                 }
610                                 break;
611                         }
612                         // Typewriter font also has them
613                         if (font.family() == LyXFont::TYPEWRITER_FAMILY) {
614                                 os << c;
615                                 break;
616                         }
617                         // Otherwise, we use what LaTeX
618                         // provides us.
619                         switch (c) {
620                         case '<':
621                                 os << "\\textless{}";
622                                 column += 10;
623                                 break;
624                         case '>':
625                                 os << "\\textgreater{}";
626                                 column += 13;
627                                 break;
628                         case '|':
629                                 os << "\\textbar{}";
630                                 column += 9;
631                                 break;
632                         }
633                         break;
634
635                 case '-': // "--" in Typewriter mode -> "-{}-"
636                         if (i <= size() - 2
637                             && getChar(i + 1) == '-'
638                             && font.family() == LyXFont::TYPEWRITER_FAMILY) {
639                                 os << "-{}";
640                                 column += 2;
641                         } else {
642                                 os << '-';
643                         }
644                         break;
645
646                 case '\"':
647                         os << "\\char`\\\"{}";
648                         column += 9;
649                         break;
650
651                 case '£':
652                         if (bparams.inputenc == "default") {
653                                 os << "\\pounds{}";
654                                 column += 8;
655                         } else {
656                                 os << c;
657                         }
658                         break;
659
660                 case '$': case '&':
661                 case '%': case '#': case '{':
662                 case '}': case '_':
663                         os << '\\' << c;
664                         column += 1;
665                         break;
666
667                 case '~':
668                         os << "\\textasciitilde{}";
669                         column += 16;
670                         break;
671
672                 case '^':
673                         os << "\\textasciicircum{}";
674                         column += 17;
675                         break;
676
677                 case '*': case '[': case ']':
678                         // avoid being mistaken for optional arguments
679                         os << '{' << c << '}';
680                         column += 2;
681                         break;
682
683                 case ' ':
684                         // Blanks are printed before font switching.
685                         // Sure? I am not! (try nice-latex)
686                         // I am sure it's correct. LyX might be smarter
687                         // in the future, but for now, nothing wrong is
688                         // written. (Asger)
689                         break;
690
691                 default:
692
693                         // I assume this is hack treating typewriter as verbatim
694                         if (font.family() == LyXFont::TYPEWRITER_FAMILY) {
695                                 if (c != '\0') {
696                                         os << c;
697                                 }
698                                 break;
699                         }
700
701                         // LyX, LaTeX etc.
702
703                         // FIXME: if we have "LaTeX" with a font
704                         // change in the middle (before the 'T', then
705                         // the "TeX" part is still special cased.
706                         // Really we should only operate this on
707                         // "words" for some definition of word
708
709                         size_t pnr = 0;
710
711                         for (; pnr < phrases_nr; ++pnr) {
712                                 if (isTextAt(special_phrases[pnr].phrase, i)) {
713                                         os << special_phrases[pnr].macro;
714                                         i += special_phrases[pnr].phrase.length() - 1;
715                                         column += special_phrases[pnr].macro.length() - 1;
716                                         break;
717                                 }
718                         }
719
720                         if (pnr == phrases_nr && c != '\0') {
721                                 os << c;
722                         }
723                         break;
724                 }
725         }
726 }
727
728
729 void Paragraph::Pimpl::validate(LaTeXFeatures & features,
730                                 LyXLayout const & layout) const
731 {
732         BufferParams const & bparams = features.bufferParams();
733
734         // check the params.
735         if (!params.spacing().isDefault())
736                 features.require("setspace");
737
738         // then the layouts
739         features.useLayout(layout.name());
740
741         // then the fonts
742         Language const * doc_language = bparams.language;
743
744         FontList::const_iterator fcit = fontlist.begin();
745         FontList::const_iterator fend = fontlist.end();
746         for (; fcit != fend; ++fcit) {
747                 if (fcit->font().noun() == LyXFont::ON) {
748                         lyxerr[Debug::LATEX] << "font.noun: "
749                                              << fcit->font().noun()
750                                              << endl;
751                         features.require("noun");
752                         lyxerr[Debug::LATEX] << "Noun enabled. Font: "
753                                              << fcit->font().stateText(0)
754                                              << endl;
755                 }
756                 switch (fcit->font().color()) {
757                 case LColor::none:
758                 case LColor::inherit:
759                 case LColor::ignore:
760                         // probably we should put here all interface colors used for
761                         // font displaying! For now I just add this ones I know of (Jug)
762                 case LColor::latex:
763                 case LColor::note:
764                         break;
765                 default:
766                         features.require("color");
767                         lyxerr[Debug::LATEX] << "Color enabled. Font: "
768                                              << fcit->font().stateText(0)
769                                              << endl;
770                 }
771
772                 Language const * language = fcit->font().language();
773                 if (language->babel() != doc_language->babel() &&
774                     language != ignore_language &&
775                     language != latex_language)
776                 {
777                         features.useLanguage(language);
778                         lyxerr[Debug::LATEX] << "Found language "
779                                              << language->babel() << endl;
780                 }
781         }
782
783         if (!params.leftIndent().zero())
784                 features.require("ParagraphLeftIndent");
785
786         // then the insets
787         InsetList::iterator icit = owner_->insetlist.begin();
788         InsetList::iterator iend = owner_->insetlist.end();
789         for (; icit != iend; ++icit) {
790                 if (icit->inset) {
791                         icit->inset->validate(features);
792                         if (layout.needprotect &&
793                             icit->inset->lyxCode() == InsetOld::FOOT_CODE)
794                                 features.require("NeedLyXFootnoteCode");
795                 }
796         }
797
798         // then the contents
799         for (pos_type i = 0; i < size() ; ++i) {
800                 for (size_t pnr = 0; pnr < phrases_nr; ++pnr) {
801                         if (!special_phrases[pnr].builtin
802                             && isTextAt(special_phrases[pnr].phrase, i)) {
803                                 features.require(special_phrases[pnr].phrase);
804                                 break;
805                         }
806                 }
807         }
808 }