]> git.lyx.org Git - lyx.git/blobdiff - src/Paragraph.cpp
Add FIXME
[lyx.git] / src / Paragraph.cpp
index 9fe4de821d0daec36bfe91a9c09b1aa878023e29..135ba96b0abec1a1ee170e4338c49dc964919535 100644 (file)
@@ -40,6 +40,7 @@
 #include "ParagraphParameters.h"
 #include "SpellChecker.h"
 #include "sgml.h"
+#include "texstream.h"
 #include "TextClass.h"
 #include "TexRow.h"
 #include "Text.h"
@@ -52,6 +53,8 @@
 #include "insets/InsetLabel.h"
 #include "insets/InsetSpecialChar.h"
 
+#include "mathed/InsetMathHull.h"
+
 #include "support/debug.h"
 #include "support/docstring_list.h"
 #include "support/ExceptionMessage.h"
@@ -60,6 +63,7 @@
 #include "support/lstrings.h"
 #include "support/textutils.h"
 
+#include <atomic>
 #include <sstream>
 #include <vector>
 
@@ -282,10 +286,11 @@ private:
 
 class Paragraph::Private
 {
-       // Enforce our own "copy" constructor by declaring the standard one and
-       // the assignment operator private without implementing them.
-       Private(Private const &);
-       Private & operator=(Private const &);
+       // Enforce our own "copy" constructor
+       Private(Private const &) = delete;
+       Private & operator=(Private const &) = delete;
+       // Unique ID generator
+       static int make_id();
 public:
        ///
        Private(Paragraph * owner, Layout const & layout);
@@ -505,35 +510,37 @@ Paragraph::Private::Private(Paragraph * owner, Layout const & layout)
 }
 
 
-// Initialization of the counter for the paragraph id's,
-//
-// FIXME: There should be a more intelligent way to generate and use the
-// paragraph ids per buffer instead a global static counter for all InsetText
-// in the running program.
-// However, this per-session id is used in LFUN_PARAGRAPH_GOTO to
-// switch to a different buffer, as used in the outliner for instance.
-static int paragraph_id = -1;
+//static
+int Paragraph::Private::make_id()
+{
+       // The id is unique per session across buffers because it is used in
+       // LFUN_PARAGRAPH_GOTO to switch to a different buffer, for instance in the
+       // outliner.
+       // (thread-safe)
+       static atomic_uint next_id(0);
+       return next_id++;
+}
+
 
 Paragraph::Private::Private(Private const & p, Paragraph * owner)
        : owner_(owner), inset_owner_(p.inset_owner_), fontlist_(p.fontlist_),
+         id_(make_id()),
          params_(p.params_), changes_(p.changes_), insetlist_(p.insetlist_),
          begin_of_body_(p.begin_of_body_), text_(p.text_), words_(p.words_),
          layout_(p.layout_)
 {
-       id_ = ++paragraph_id;
        requestSpellCheck(p.text_.size());
 }
 
 
 Paragraph::Private::Private(Private const & p, Paragraph * owner,
        pos_type beg, pos_type end)
-       : owner_(owner), inset_owner_(p.inset_owner_),
+       : owner_(owner), inset_owner_(p.inset_owner_), id_(make_id()),
          params_(p.params_), changes_(p.changes_),
          insetlist_(p.insetlist_, beg, end),
          begin_of_body_(p.begin_of_body_), words_(p.words_),
          layout_(p.layout_)
 {
-       id_ = ++paragraph_id;
        if (beg >= pos_type(p.text_.size()))
                return;
        text_ = p.text_.substr(beg, end - beg);
@@ -562,6 +569,18 @@ void Paragraph::addChangesToToc(DocIterator const & cdit,
 }
 
 
+void Paragraph::addChangesToBuffer(Buffer const & buf) const
+{
+       d->changes_.updateBuffer(buf);
+}
+
+
+bool Paragraph::isChangeUpdateRequired() const
+{
+       return d->changes_.isUpdateRequired();
+}
+
+
 bool Paragraph::isDeleted(pos_type start, pos_type end) const
 {
        LASSERT(start >= 0 && start <= size(), return false);
@@ -1101,7 +1120,7 @@ void Paragraph::Private::latexInset(BufferParams const & bparams,
                }
        }
 
-       int prev_rows = os.texrow().rows();
+       size_t const previous_row_count = os.texrow().rows();
 
        try {
                runparams.lastid = id_;
@@ -1121,7 +1140,7 @@ void Paragraph::Private::latexInset(BufferParams const & bparams,
                                os << '}';
        }
 
-       if (os.texrow().rows() > prev_rows) {
+       if (os.texrow().rows() > previous_row_count) {
                os.texrow().start(owner_->id(), i + 1);
                column = 0;
        } else {
@@ -1192,7 +1211,9 @@ void Paragraph::Private::latexSpecialChar(otexstream & os,
                break;
        case '-':
                os << '-';
-               if (i + 1 < end_pos && text_[i+1] == '-') {
+               if (i + 1 < static_cast<pos_type>(text_.size()) &&
+                   (end_pos == -1 || i + 1 < end_pos) &&
+                   text_[i+1] == '-') {
                        // Prevent "--" becoming an endash and "---" becoming
                        // an emdash.
                        // Within \ttfamily, "--" is merged to "-" (no endash)
@@ -1363,13 +1384,11 @@ void Paragraph::Private::validate(LaTeXFeatures & features) const
                BufferParams const & bp = features.runparams().is_child
                        ? buf.masterParams() : buf.params();
                Font f;
-               TexRow texrow;
                // Using a string stream here circumvents the encoding
                // switching machinery of odocstream. Therefore the
                // output is wrong if this paragraph contains content
                // that needs to switch encoding.
-               odocstringstream ods;
-               otexstream os(ods, texrow);
+               otexstringstream os;
                if (is_command) {
                        os << '\\' << from_ascii(layout_->latexname());
                        // we have to provide all the optional arguments here, even though
@@ -1382,20 +1401,19 @@ void Paragraph::Private::validate(LaTeXFeatures & features) const
                        }
                        os << from_ascii(layout_->latexparam());
                }
-               docstring::size_type const length = ods.str().length();
+               size_t const length = os.length();
                // this will output "{" at the beginning, but not at the end
                owner_->latex(bp, f, os, features.runparams(), 0, -1, true);
-               if (ods.str().length() > length) {
+               if (os.length() > length) {
                        if (is_command) {
-                               ods << '}';
+                               os << '}';
                                if (!layout_->postcommandargs().empty()) {
                                        OutputParams rp = features.runparams();
                                        rp.local_font = &owner_->getFirstFontSettings(bp);
                                        latexArgInsets(*owner_, os, rp, layout_->postcommandargs(), "post:");
                                }
                        }
-                       string const snippet = to_utf8(ods.str());
-                       features.addPreambleSnippet(snippet);
+                       features.addPreambleSnippet(os.release(), true);
                }
        }
 
@@ -1423,7 +1441,9 @@ void Paragraph::Private::validate(LaTeXFeatures & features) const
        InsetList::const_iterator iend = insetlist_.end();
        for (; icit != iend; ++icit) {
                if (icit->inset) {
+                       features.inDeletedInset(owner_->isDeleted(icit->pos));
                        icit->inset->validate(features);
+                       features.inDeletedInset(false);
                        if (layout_->needprotect &&
                            icit->inset->lyxCode() == FOOT_CODE)
                                features.require("NeedLyXFootnoteCode");
@@ -1823,14 +1843,6 @@ Font const Paragraph::getLayoutFont
 }
 
 
-/// Returns the height of the highest font in range
-FontSize Paragraph::highestFontInRange
-       (pos_type startpos, pos_type endpos, FontSize def_size) const
-{
-       return d->fontlist_.highestInRange(startpos, endpos, def_size);
-}
-
-
 char_type Paragraph::getUChar(BufferParams const & bparams, pos_type pos) const
 {
        char_type c = d->text_[pos];
@@ -2377,6 +2389,25 @@ void Paragraph::latex(BufferParams const & bparams,
                                                            runparams);
                }
 
+               runparams.wasDisplayMath = runparams.inDisplayMath;
+               runparams.inDisplayMath = false;
+               bool deleted_display_math = false;
+
+               // Check whether a display math inset follows
+               if (d->text_[i] == META_INSET
+                   && i >= start_pos && (end_pos == -1 || i < end_pos)) {
+                       InsetMath const * im = getInset(i)->asInsetMath();
+                       if (im && im->asHullInset()
+                           && im->asHullInset()->outerDisplay()) {
+                               runparams.inDisplayMath = true;
+                               // runparams.inDeletedInset will be set by
+                               // latexInset later, but we need this info
+                               // before it is called. On the other hand, we
+                               // cannot set it here because it is a counter.
+                               deleted_display_math = isDeleted(i);
+                       }
+               }
+
                Change const & change = runparams.inDeletedInset
                        ? runparams.changeOfDeletedInset : lookupChange(i);
 
@@ -2388,7 +2419,6 @@ void Paragraph::latex(BufferParams const & bparams,
                        }
                        basefont = getLayoutFont(bparams, outerfont);
                        running_font = basefont;
-
                        column += Changes::latexMarkChange(os, bparams, runningChange,
                                                           change, runparams);
                        runningChange = change;
@@ -2403,18 +2433,18 @@ void Paragraph::latex(BufferParams const & bparams,
                ++column;
 
                // Fully instantiated font
-               Font const font = getFont(bparams, i, outerfont);
+               Font const current_font = getFont(bparams, i, outerfont);
 
                Font const last_font = running_font;
 
                // Do we need to close the previous font?
                if (open_font &&
-                   (font != running_font ||
-                    font.language() != running_font.language()))
+                   (current_font != running_font ||
+                    current_font.language() != running_font.language()))
                {
                        column += running_font.latexWriteEndChanges(
                                        os, bparams, runparams, basefont,
-                                       (i == body_pos-1) ? basefont : font);
+                                       (i == body_pos-1) ? basefont : current_font);
                        running_font = basefont;
                        open_font = false;
                }
@@ -2425,39 +2455,63 @@ void Paragraph::latex(BufferParams const & bparams,
                string const lang_end_command = runparams.use_polyglossia ?
                        "\\end{$$lang}" : lyxrc.language_command_end;
                if (!running_lang.empty() &&
-                   font.language()->encoding()->package() == Encoding::CJK) {
+                   current_font.language()->encoding()->package() == Encoding::CJK) {
                                string end_tag = subst(lang_end_command,
                                                        "$$lang",
                                                        running_lang);
                                os << from_ascii(end_tag);
                                column += end_tag.length();
+                               if (runparams.use_polyglossia)
+                                       popPolyglossiaLang();
                }
 
                // Switch file encoding if necessary (and allowed)
                if (!runparams.pass_thru && !style.pass_thru &&
                    runparams.encoding->package() != Encoding::none &&
-                   font.language()->encoding()->package() != Encoding::none) {
+                   current_font.language()->encoding()->package() != Encoding::none) {
                        pair<bool, int> const enc_switch =
                                switchEncoding(os.os(), bparams, runparams,
-                                       *(font.language()->encoding()));
+                                       *(current_font.language()->encoding()));
                        if (enc_switch.first) {
                                column += enc_switch.second;
-                               runparams.encoding = font.language()->encoding();
+                               runparams.encoding = current_font.language()->encoding();
                        }
                }
 
                char_type const c = d->text_[i];
 
+               // A display math inset inside an ulem command will be output
+               // as a box of width \columnwidth, so we have to either disable
+               // indentation if the inset starts a paragraph, or start a new
+               // line to accommodate such box. This has to be done before
+               // writing any font changing commands.
+               if (runparams.inDisplayMath && !deleted_display_math
+                   && runparams.inulemcmd) {
+                       if (os.afterParbreak())
+                               os << "\\noindent";
+                       else
+                               os << "\\\\\n";
+               }
+
                // Do we need to change font?
-               if ((font != running_font ||
-                    font.language() != running_font.language()) &&
+               if ((current_font != running_font ||
+                    current_font.language() != running_font.language()) &&
                        i != body_pos - 1)
                {
                        odocstringstream ods;
-                       column += font.latexWriteStartChanges(ods, bparams,
+                       column += current_font.latexWriteStartChanges(ods, bparams,
                                                              runparams, basefont,
                                                              last_font);
-                       running_font = font;
+                       // Check again for display math in ulem commands as a
+                       // font change may also occur just before a math inset.
+                       if (runparams.inDisplayMath && !deleted_display_math
+                           && runparams.inulemcmd) {
+                               if (os.afterParbreak())
+                                       os << "\\noindent";
+                               else
+                                       os << "\\\\\n";
+                       }
+                       running_font = current_font;
                        open_font = true;
                        docstring fontchange = ods.str();
                        // check whether the fontchange ends with a \\textcolor
@@ -2483,7 +2537,7 @@ void Paragraph::latex(BufferParams const & bparams,
                        // style.pass_thru is false.
                        if (i != body_pos - 1) {
                                if (d->simpleTeXBlanks(runparams, os,
-                                               i, column, font, style)) {
+                                               i, column, current_font, style)) {
                                        // A surrogate pair was output. We
                                        // must not call latexSpecialChar
                                        // in this iteration, since it would output
@@ -2496,7 +2550,7 @@ void Paragraph::latex(BufferParams const & bparams,
 
                OutputParams rp = runparams;
                rp.free_spacing = style.free_spacing;
-               rp.local_font = &font;
+               rp.local_font = &current_font;
                rp.intitle = style.intitle;
 
                // Two major modes:  LaTeX or plain
@@ -2508,12 +2562,12 @@ void Paragraph::latex(BufferParams const & bparams,
                                                basefont, outerfont, open_font,
                                                runningChange, style, i, column);
                        }
-               } else {
-                       if (i >= start_pos && (end_pos == -1 || i < end_pos)) {
-                               try {
-                                       d->latexSpecialChar(os, bparams, rp, running_font, runningChange,
-                                                           style, i, end_pos, column);
-                               } catch (EncodingException & e) {
+               } else if (i >= start_pos && (end_pos == -1 || i < end_pos)) {
+                       try {
+                               d->latexSpecialChar(os, bparams, rp,
+                                                   running_font, runningChange,
+                                                   style, i, end_pos, column);
+                       } catch (EncodingException & e) {
                                if (runparams.dryrun) {
                                        os << "<" << _("LyX Warning: ")
                                           << _("uncodable character") << " '";
@@ -2527,11 +2581,15 @@ void Paragraph::latex(BufferParams const & bparams,
                                }
                        }
                }
-               }
 
                // Set the encoding to that returned from latexSpecialChar (see
                // comment for encoding member in OutputParams.h)
                runparams.encoding = rp.encoding;
+
+               // Also carry on the info on a closed ulem command for insets
+               // such as Note that do not produce any output, so that no
+               // command is ever executed but its opening was recorded.
+               runparams.inulemcmd = rp.inulemcmd;
        }
 
        // If we have an open font definition, we have to close it
@@ -2747,6 +2805,7 @@ docstring Paragraph::simpleLyXHTMLOnePar(Buffer const & buf,
                                    XHTMLStream & xs,
                                    OutputParams const & runparams,
                                    Font const & outerfont,
+                                   bool start_paragraph, bool close_paragraph,
                                    pos_type initial) const
 {
        docstring retval;
@@ -2768,7 +2827,8 @@ docstring Paragraph::simpleLyXHTMLOnePar(Buffer const & buf,
 
        Layout const & style = *d->layout_;
 
-       xs.startParagraph(allowEmpty());
+       if (start_paragraph)
+               xs.startDivision(allowEmpty());
 
        FontInfo font_old =
                style.labeltype == LABEL_MANUAL ? style.labelfont : style.font;
@@ -3054,7 +3114,9 @@ docstring Paragraph::simpleLyXHTMLOnePar(Buffer const & buf,
                        if (!runparams.for_toc || inset->isInToc()) {
                                OutputParams np = runparams;
                                np.local_font = &font;
-                               if (!inset->getLayout().htmlisblock())
+                               // If the paragraph has size 1, then we are in the "special
+                               // case" where we do not output the containing paragraph info
+                               if (!inset->getLayout().htmlisblock() && size() != 1)
                                        np.html_in_par = true;
                                retval += inset->xhtml(xs, np);
                        }
@@ -3065,8 +3127,13 @@ docstring Paragraph::simpleLyXHTMLOnePar(Buffer const & buf,
                font_old = font.fontInfo();
        }
 
+       // FIXME XHTML
+       // I'm worried about what happens if a branch, say, is itself
+       // wrapped in some font stuff. I think that will not work.
        xs.closeFontTags();
-       xs.endParagraph();
+       if (close_paragraph)
+               xs.endDivision();
+
        return retval;
 }
 
@@ -3080,6 +3147,11 @@ bool Paragraph::isHfill(pos_type pos) const
 
 bool Paragraph::isNewline(pos_type pos) const
 {
+       // U+2028 LINE SEPARATOR
+       // U+2029 PARAGRAPH SEPARATOR
+       char_type const c = d->text_[pos];
+       if (c == 0x2028 || c == 0x2029)
+               return true;
        Inset const * inset = getInset(pos);
        return inset && inset->lyxCode() == NEWLINE_CODE;
 }
@@ -3462,6 +3534,12 @@ void Paragraph::setBuffer(Buffer & b)
 }
 
 
+void Paragraph::resetBuffer()
+{
+       d->insetlist_.resetBuffer();
+}
+
+
 Inset * Paragraph::releaseInset(pos_type pos)
 {
        Inset * inset = d->insetlist_.release(pos);