]> git.lyx.org Git - lyx.git/blobdiff - src/tex2lyx/text.cpp
Fix bug #4213: Change tracking support for tex2lyx.
[lyx.git] / src / tex2lyx / text.cpp
index 61a26202dc3528d95a945119b8db8abbf608f03a..6d41e1be715b029271a3bd76601ca2205764d85b 100644 (file)
@@ -19,6 +19,7 @@
 #include "Context.h"
 #include "Encoding.h"
 #include "FloatList.h"
+#include "LaTeXPackages.h"
 #include "Layout.h"
 #include "Length.h"
 #include "Preamble.h"
@@ -28,6 +29,7 @@
 #include "support/FileName.h"
 #include "support/filetools.h"
 #include "support/lstrings.h"
+#include "support/lyxtime.h"
 
 #include <algorithm>
 #include <iostream>
@@ -785,6 +787,23 @@ void parse_box(Parser & p, ostream & os, unsigned outer_flags,
        } else
                latex_width = p.verbatim_item();
        translate_len(latex_width, width_value, width_unit);
+       bool shadedparbox = false;
+       if (inner_type == "shaded") {
+               eat_whitespace(p, os, parent_context, false);
+               if (outer_type == "parbox") {
+                       // Eat '{'
+                       if (p.next_token().cat() == catBegin)
+                               p.get_token();
+                       eat_whitespace(p, os, parent_context, false);
+                       shadedparbox = true;
+               }
+               p.get_token();
+               p.getArg('{', '}');
+       }
+       // If we already read the inner box we have to push the inner env
+       if (!outer_type.empty() && !inner_type.empty() &&
+           (inner_flags & FLAG_END))
+               active_environments.push_back(inner_type);
        // LyX can't handle length variables
        bool use_ert = contains(width_unit, '\\') || contains(height_unit, '\\');
        if (!use_ert && !outer_type.empty() && !inner_type.empty()) {
@@ -797,8 +816,9 @@ void parse_box(Parser & p, ostream & os, unsigned outer_flags,
                else
                        p.verbatim_item();
                p.skip_spaces(true);
-               if ((outer_type == "framed" && p.next_token().asInput() != "\\end") ||
-                   (outer_type != "framed" && p.next_token().cat() != catEnd)) {
+               bool const outer_env(outer_type == "framed" || outer_type == "minipage");
+               if ((outer_env && p.next_token().asInput() != "\\end") ||
+                   (!outer_env && p.next_token().cat() != catEnd)) {
                        // something is between the end of the inner box and
                        // the end of the outer box, so we need to use ERT.
                        use_ert = true;
@@ -817,10 +837,12 @@ void parse_box(Parser & p, ostream & os, unsigned outer_flags,
                        }
                }
                if (!inner_type.empty()) {
-                       if (inner_flags & FLAG_END)
-                               ss << "\\begin{" << inner_type << '}';
-                       else
-                               ss << '\\' << inner_type;
+                       if (inner_type != "shaded") {
+                               if (inner_flags & FLAG_END)
+                                       ss << "\\begin{" << inner_type << '}';
+                               else
+                                       ss << '\\' << inner_type;
+                       }
                        if (!position.empty())
                                ss << '[' << position << ']';
                        if (!latex_height.empty())
@@ -831,6 +853,8 @@ void parse_box(Parser & p, ostream & os, unsigned outer_flags,
                        if (!(inner_flags & FLAG_END))
                                ss << '{';
                }
+               if (inner_type == "shaded")
+                       ss << "\\begin{shaded}";
                handle_ert(os, ss.str(), parent_context);
                if (!inner_type.empty()) {
                        parse_text(p, os, inner_flags, outer, parent_context);
@@ -841,6 +865,10 @@ void parse_box(Parser & p, ostream & os, unsigned outer_flags,
                                handle_ert(os, "}", parent_context);
                }
                if (!outer_type.empty()) {
+                       // If we already read the inner box we have to pop
+                       // the inner env
+                       if (!inner_type.empty() && (inner_flags & FLAG_END))
+                               active_environments.pop_back();
                        parse_text(p, os, outer_flags, outer, parent_context);
                        if (outer_flags & FLAG_END)
                                handle_ert(os, "\\end{" + outer_type + '}',
@@ -855,6 +883,8 @@ void parse_box(Parser & p, ostream & os, unsigned outer_flags,
                        position = "c";
                if (inner_pos.empty())
                        inner_pos = position;
+               // FIXME: Support makebox
+               bool const use_makebox = false;
                parent_context.check_layout(os);
                begin_inset(os, "Box ");
                if (outer_type == "framed")
@@ -863,9 +893,12 @@ void parse_box(Parser & p, ostream & os, unsigned outer_flags,
                        os << "Boxed\n";
                else if (outer_type == "shadowbox")
                        os << "Shadowbox\n";
-               else if (outer_type == "shaded")
+               else if ((outer_type == "shaded" && inner_type.empty()) ||
+                            (outer_type == "minipage" && inner_type == "shaded") ||
+                            (outer_type == "parbox" && inner_type == "shaded")) {
                        os << "Shaded\n";
-               else if (outer_type == "doublebox")
+                       preamble.registerAutomaticallyLoadedPackage("color");
+               } else if (outer_type == "doublebox")
                        os << "Doublebox\n";
                else if (outer_type.empty())
                        os << "Frameless\n";
@@ -875,19 +908,30 @@ void parse_box(Parser & p, ostream & os, unsigned outer_flags,
                os << "hor_pos \"" << hor_pos << "\"\n";
                os << "has_inner_box " << !inner_type.empty() << "\n";
                os << "inner_pos \"" << inner_pos << "\"\n";
-               os << "use_parbox " << (inner_type == "parbox") << '\n';
-               os << "use_makebox 0\n";
+               os << "use_parbox " << (inner_type == "parbox" || shadedparbox)
+                       << '\n';
+               os << "use_makebox " << use_makebox << '\n';
                os << "width \"" << width_value << width_unit << "\"\n";
                os << "special \"none\"\n";
                os << "height \"" << height_value << height_unit << "\"\n";
                os << "height_special \"" << height_special << "\"\n";
                os << "status open\n\n";
-               Context context(true, parent_context.textclass);
-               context.font = parent_context.font;
 
-               // FIXME, the inset layout should be plain, not standard, see bug #7846
+               // Unfortunately we can't use parse_text_in_inset:
+               // InsetBox::forcePlainLayout() is hard coded and does not
+               // use the inset layout. Apart from that do we call parse_text
+               // up to two times, but need only one check_end_layout.
 
-               // If we have no inner box the contens will be read with the outer box
+               bool const forcePlainLayout =
+                       (!inner_type.empty() || use_makebox) &&
+                       outer_type != "shaded" && outer_type != "framed";
+               Context context(true, parent_context.textclass);
+               if (forcePlainLayout)
+                       context.layout = &context.textclass.plainLayout();
+               else
+                       context.font = parent_context.font;
+
+               // If we have no inner box the contents will be read with the outer box
                if (!inner_type.empty())
                        parse_text(p, os, inner_flags, outer, context);
 
@@ -901,6 +945,10 @@ void parse_box(Parser & p, ostream & os, unsigned outer_flags,
                // Find end of outer box, output contents if inner_type is
                // empty and output possible comments
                if (!outer_type.empty()) {
+                       // If we already read the inner box we have to pop
+                       // the inner env
+                       if (!inner_type.empty() && (inner_flags & FLAG_END))
+                               active_environments.pop_back();
                        // This does not output anything but comments if
                        // inner_type is not empty (see use_ert)
                        parse_text(p, os, outer_flags, outer, context);
@@ -948,6 +996,22 @@ void parse_outer_box(Parser & p, ostream & os, unsigned flags, bool outer,
        }
        string inner;
        unsigned int inner_flags = 0;
+       p.pushPosition();
+       if (outer_type == "minipage" || outer_type == "parbox") {
+               p.skip_spaces(true);
+               while (p.hasOpt()) {
+                       p.getArg('[', ']');
+                       p.skip_spaces(true);
+               }
+               p.getArg('{', '}');
+               p.skip_spaces(true);
+               if (outer_type == "parbox") {
+                       // Eat '{'
+                       if (p.next_token().cat() == catBegin)
+                               p.get_token();
+                       eat_whitespace(p, os, parent_context, false);
+               }
+       }
        if (outer_type == "shaded") {
                // These boxes never have an inner box
                ;
@@ -955,25 +1019,31 @@ void parse_outer_box(Parser & p, ostream & os, unsigned flags, bool outer,
                inner = p.get_token().cs();
                inner_flags = FLAG_ITEM;
        } else if (p.next_token().asInput() == "\\begin") {
-               // Is this a minipage?
+               // Is this a minipage or shaded box?
                p.pushPosition();
                p.get_token();
                inner = p.getArg('{', '}');
                p.popPosition();
-               if (inner == "minipage") {
-                       p.get_token();
-                       p.getArg('{', '}');
-                       eat_whitespace(p, os, parent_context, false);
+               if (inner == "minipage" || inner == "shaded")
                        inner_flags = FLAG_END;
-               else
+               else
                        inner = "";
        }
+       p.popPosition();
        if (inner_flags == FLAG_END) {
-               active_environments.push_back(inner);
+               if (inner != "shaded")
+               {
+                       p.get_token();
+                       p.getArg('{', '}');
+                       eat_whitespace(p, os, parent_context, false);
+               }
                parse_box(p, os, flags, FLAG_END, outer, parent_context,
                          outer_type, special, inner);
-               active_environments.pop_back();
        } else {
+               if (inner_flags == FLAG_ITEM) {
+                       p.get_token();
+                       eat_whitespace(p, os, parent_context, false);
+               }
                parse_box(p, os, flags, inner_flags, outer, parent_context,
                          outer_type, special, inner);
        }
@@ -1035,7 +1105,8 @@ void parse_unknown_environment(Parser & p, string const & name, ostream & os,
 
 
 void parse_environment(Parser & p, ostream & os, bool outer,
-                       string & last_env, Context & parent_context)
+                       string & last_env, bool & title_layout_found,
+                       Context & parent_context)
 {
        Layout const * newlayout;
        InsetLayout const * newinsetlayout = 0;
@@ -1142,7 +1213,29 @@ void parse_environment(Parser & p, ostream & os, bool outer,
 
        else if (name == "minipage") {
                eat_whitespace(p, os, parent_context, false);
-               parse_box(p, os, 0, FLAG_END, outer, parent_context, "", "", name);
+               // Test whether this is an outer box of a shaded box
+               p.pushPosition();
+               // swallow arguments
+               while (p.hasOpt()) {
+                       p.getArg('[', ']');
+                       p.skip_spaces(true);
+               }
+               p.getArg('{', '}');
+               p.skip_spaces(true);
+               Token t = p.get_token();
+               bool shaded = false;
+               if (t.asInput() == "\\begin") {
+                       p.skip_spaces(true);
+                       if (p.getArg('{', '}') == "shaded")
+                               shaded = true;
+               }
+               p.popPosition();
+               if (shaded)
+                       parse_outer_box(p, os, FLAG_END, outer,
+                                       parent_context, name, "shaded");
+               else
+                       parse_box(p, os, 0, FLAG_END, outer, parent_context,
+                                 "", "", name);
                p.skip_spaces();
        }
 
@@ -1165,6 +1258,8 @@ void parse_environment(Parser & p, ostream & os, bool outer,
                parse_text_in_inset(p, os, FLAG_END, outer, parent_context);
                end_inset(os);
                p.skip_spaces();
+               if (!preamble.notefontcolor().empty())
+                       preamble.registerAutomaticallyLoadedPackage("color");
        }
 
        else if (name == "framed" || name == "shaded") {
@@ -1176,6 +1271,8 @@ void parse_environment(Parser & p, ostream & os, bool outer,
        else if (name == "lstlisting") {
                eat_whitespace(p, os, parent_context, false);
                // FIXME handle listings with parameters
+               //       If this is added, don't forgot to handle the
+               //       automatic color package loading
                if (p.hasOpt())
                        parse_unknown_environment(p, name, os, FLAG_END,
                                                  outer, parent_context);
@@ -1328,6 +1425,8 @@ void parse_environment(Parser & p, ostream & os, bool outer,
                context.check_end_deeper(os);
                parent_context.new_paragraph(os);
                p.skip_spaces();
+               if (!title_layout_found)
+                       title_layout_found = newlayout->intitle;
        }
 
        // The single '=' is meant here.
@@ -1717,6 +1816,7 @@ void parse_text(Parser & p, ostream & os, unsigned flags, bool outer,
        bool const use_natbib = preamble.isPackageUsed("natbib");
        bool const use_jurabib = preamble.isPackageUsed("jurabib");
        string last_env;
+       bool title_layout_found = false;
        while (p.good()) {
                Token const & t = p.get_token();
 
@@ -2023,7 +2123,8 @@ void parse_text(Parser & p, ostream & os, unsigned flags, bool outer,
                }
 
                else if (t.cs() == "begin")
-                       parse_environment(p, os, outer, last_env, context);
+                       parse_environment(p, os, outer, last_env,
+                                         title_layout_found, context);
 
                else if (t.cs() == "end") {
                        if (flags & FLAG_END) {
@@ -2138,6 +2239,8 @@ void parse_text(Parser & p, ostream & os, unsigned flags, bool outer,
                                        output_command_layout(os, p, outer,
                                                        context, newlayout);
                                        p.skip_spaces();
+                                       if (!title_layout_found)
+                                               title_layout_found = newlayout->intitle;
                                } else
                                        handle_ert(os, "\\date{" + date + '}',
                                                        context);
@@ -2153,6 +2256,8 @@ void parse_text(Parser & p, ostream & os, unsigned flags, bool outer,
                        p.get_token();
                        output_command_layout(os, p, outer, context, newlayout);
                        p.skip_spaces();
+                       if (!title_layout_found)
+                               title_layout_found = newlayout->intitle;
                }
 
                // Section headings and the like
@@ -2161,6 +2266,8 @@ void parse_text(Parser & p, ostream & os, unsigned flags, bool outer,
                        // write the layout
                        output_command_layout(os, p, outer, context, newlayout);
                        p.skip_spaces();
+                       if (!title_layout_found)
+                               title_layout_found = newlayout->intitle;
                }
 
                else if (t.cs() == "caption") {
@@ -2443,10 +2550,11 @@ void parse_text(Parser & p, ostream & os, unsigned flags, bool outer,
                }
 
                else if (t.cs() == "makeindex" || t.cs() == "maketitle") {
-                       // FIXME: Somehow prevent title layouts if
-                       // "maketitle" was not found
-                       // swallow this
-                       skip_spaces_braces(p);
+                       if (title_layout_found) {
+                               // swallow this
+                               skip_spaces_braces(p);
+                       } else
+                               handle_ert(os, t.asInput(), context);
                }
 
                else if (t.cs() == "tableofcontents") {
@@ -2556,6 +2664,7 @@ void parse_text(Parser & p, ostream & os, unsigned flags, bool outer,
                                        parse_text_snippet(p, os, FLAG_ITEM, outer, context);
                                        context.check_layout(os);
                                        os << "\n\\color inherit\n";
+                                       preamble.registerAutomaticallyLoadedPackage("color");
                        } else
                                // for custom defined colors
                                handle_ert(os, t.asInput() + "{" + color + "}", context);
@@ -2573,6 +2682,7 @@ void parse_text(Parser & p, ostream & os, unsigned flags, bool outer,
                        parse_text_snippet(p, os, FLAG_ITEM, outer, context);
                        context.check_layout(os);
                        os << "\n\\bar default\n";
+                       preamble.registerAutomaticallyLoadedPackage("ulem");
                }
 
                else if (t.cs() == "sout") {
@@ -2581,6 +2691,7 @@ void parse_text(Parser & p, ostream & os, unsigned flags, bool outer,
                        parse_text_snippet(p, os, FLAG_ITEM, outer, context);
                        context.check_layout(os);
                        os << "\n\\strikeout default\n";
+                       preamble.registerAutomaticallyLoadedPackage("ulem");
                }
 
                else if (t.cs() == "uuline" || t.cs() == "uwave" ||
@@ -2590,9 +2701,54 @@ void parse_text(Parser & p, ostream & os, unsigned flags, bool outer,
                        parse_text_snippet(p, os, FLAG_ITEM, outer, context);
                        context.check_layout(os);
                        os << "\n\\" << t.cs() << " default\n";
+                       if (t.cs() == "uuline" || t.cs() == "uwave")
+                               preamble.registerAutomaticallyLoadedPackage("ulem");
+               }
+
+               else if (t.cs() == "lyxadded" || t.cs() == "lyxdeleted") {
+                       context.check_layout(os);
+                       string name = p.getArg('{', '}');
+                       string localtime = p.getArg('{', '}');
+                       preamble.registerAuthor(name);
+                       Author const & author = preamble.getAuthor(name);
+                       // from_ctime() will fail if LyX decides to output the
+                       // time in the text language. It might also use a wrong
+                       // time zone (if the original LyX document was exported
+                       // with a different time zone).
+                       time_t ptime = from_ctime(localtime);
+                       if (ptime == static_cast<time_t>(-1)) {
+                               cerr << "Warning: Could not parse time `" << localtime
+                                    << "ยด for change tracking, using current time instead.\n";
+                               ptime = current_time();
+                       }
+                       if (t.cs() == "lyxadded")
+                               os << "\n\\change_inserted ";
+                       else
+                               os << "\n\\change_deleted ";
+                       os << author.bufferId() << ' ' << ptime << '\n';
+                       parse_text_snippet(p, os, FLAG_ITEM, outer, context);
+                       bool dvipost    = LaTeXPackages::isAvailable("dvipost");
+                       bool xcolorulem = LaTeXPackages::isAvailable("ulem") &&
+                                         LaTeXPackages::isAvailable("xcolor");
+                       // No need to test for luatex, since luatex comes in
+                       // two flavours (dvi and pdf), like latex, and those
+                       // are detected by pdflatex.
+                       if (pdflatex || xetex) {
+                               if (xcolorulem) {
+                                       preamble.registerAutomaticallyLoadedPackage("ulem");
+                                       preamble.registerAutomaticallyLoadedPackage("xcolor");
+                                       preamble.registerAutomaticallyLoadedPackage("pdfcolmk");
+                               }
+                       } else {
+                               if (dvipost) {
+                                       preamble.registerAutomaticallyLoadedPackage("dvipost");
+                               } else if (xcolorulem) {
+                                       preamble.registerAutomaticallyLoadedPackage("ulem");
+                                       preamble.registerAutomaticallyLoadedPackage("xcolor");
+                               }
+                       }
                }
 
-               // FIXME, the inset layout should be plain, not standard, see bug #7846
                else if (t.cs() == "phantom" || t.cs() == "hphantom" ||
                             t.cs() == "vphantom") {
                        context.check_layout(os);
@@ -2603,7 +2759,8 @@ void parse_text(Parser & p, ostream & os, unsigned flags, bool outer,
                        if (t.cs() == "vphantom")
                                begin_inset(os, "Phantom VPhantom\n");
                        os << "status open\n";
-                       parse_text_in_inset(p, os, FLAG_ITEM, outer, context);
+                       parse_text_in_inset(p, os, FLAG_ITEM, outer, context,
+                                           "Phantom");
                        end_inset(os);
                }
 
@@ -2900,6 +3057,8 @@ void parse_text(Parser & p, ostream & os, unsigned flags, bool outer,
                        os << t.cs().substr(4) << '\n';
                        parse_text_in_inset(p, os, FLAG_ITEM, false, context);
                        end_inset(os);
+                       if (t.cs() == "textsubscript")
+                               preamble.registerAutomaticallyLoadedPackage("subscript");
                }
 
                else if (is_known(t.cs(), known_quotes)) {
@@ -3325,8 +3484,35 @@ void parse_text(Parser & p, ostream & os, unsigned flags, bool outer,
                        end_inset(os);
                }
 
-               else if (t.cs() == "parbox")
-                       parse_box(p, os, 0, FLAG_ITEM, outer, context, "", "", t.cs());
+               else if (t.cs() == "parbox") {
+                       // Test whether this is an outer box of a shaded box
+                       p.pushPosition();
+                       // swallow arguments
+                       while (p.hasOpt()) {
+                               p.getArg('[', ']');
+                               p.skip_spaces(true);
+                       }
+                       p.getArg('{', '}');
+                       p.skip_spaces(true);
+                       // eat the '{'
+                       if (p.next_token().cat() == catBegin)
+                               p.get_token();
+                       p.skip_spaces(true);
+                       Token to = p.get_token();
+                       bool shaded = false;
+                       if (to.asInput() == "\\begin") {
+                               p.skip_spaces(true);
+                               if (p.getArg('{', '}') == "shaded")
+                                       shaded = true;
+                       }
+                       p.popPosition();
+                       if (shaded) {
+                               parse_outer_box(p, os, FLAG_ITEM, outer,
+                                               context, "parbox", "shaded");
+                       } else
+                               parse_box(p, os, 0, FLAG_ITEM, outer, context,
+                                         "", "", t.cs());
+               }
 
                else if (t.cs() == "ovalbox" || t.cs() == "Ovalbox" ||
                         t.cs() == "shadowbox" || t.cs() == "doublebox")