]> git.lyx.org Git - features.git/blobdiff - src/insets/InsetNewpage.cpp
DocBook: add a TODO for a newly discovered bug.
[features.git] / src / insets / InsetNewpage.cpp
index f9c75b1128c82eb64af81e24011fd8f6f052ee2c..da944526321eb299cca73cc096ca368541d13749 100644 (file)
@@ -3,7 +3,8 @@
  * This file is part of LyX, the document processor.
  * Licence details can be found in the file COPYING.
  *
- * \author André Pönitz
+ * \author André Pönitz
+ * \author Jürgen Spitzmüller
  *
  * Full author contact details are available in file CREDITS.
  */
 
 #include "InsetNewpage.h"
 
-#include "Text.h"
+#include "Cursor.h"
+#include "FuncRequest.h"
+#include "FuncStatus.h"
+#include "Lexer.h"
 #include "MetricsInfo.h"
-#include "OutputParams.h"
+#include "xml.h"
+#include "texstream.h"
+#include "Text.h"
 #include "TextMetrics.h"
 
 #include "frontends/FontMetrics.h"
@@ -30,30 +36,138 @@ using namespace std;
 
 namespace lyx {
 
-void InsetNewpage::read( Lexer &)
+       InsetNewpage::InsetNewpage() : Inset(nullptr)
+{}
+
+
+InsetNewpage::InsetNewpage(InsetNewpageParams const & params)
+       : Inset(nullptr), params_(params)
+{}
+
+
+void InsetNewpageParams::write(ostream & os) const
+{
+       switch (kind) {
+       case InsetNewpageParams::NEWPAGE:
+               os << "newpage";
+               break;
+       case InsetNewpageParams::PAGEBREAK:
+               os <<  "pagebreak";
+               break;
+       case InsetNewpageParams::CLEARPAGE:
+               os <<  "clearpage";
+               break;
+       case InsetNewpageParams::CLEARDOUBLEPAGE:
+               os <<  "cleardoublepage";
+               break;
+       case InsetNewpageParams::NOPAGEBREAK:
+               os <<  "nopagebreak";
+               break;
+       }
+}
+
+
+void InsetNewpageParams::read(Lexer & lex)
 {
-       /* Nothing to read */
+       lex.setContext("InsetNewpageParams::read");
+       string token;
+       lex >> token;
+
+       if (token == "newpage")
+               kind = InsetNewpageParams::NEWPAGE;
+       else if (token == "pagebreak")
+               kind = InsetNewpageParams::PAGEBREAK;
+       else if (token == "clearpage")
+               kind = InsetNewpageParams::CLEARPAGE;
+       else if (token == "cleardoublepage")
+               kind = InsetNewpageParams::CLEARDOUBLEPAGE;
+       else if (token == "nopagebreak")
+               kind = InsetNewpageParams::NOPAGEBREAK;
+       else
+               lex.printError("Unknown kind");
 }
 
 
 void InsetNewpage::write(ostream & os) const
 {
-       os << "\n" << getCmdName() << '\n';
+       os << "Newpage ";
+       params_.write(os);
+}
+
+
+void InsetNewpage::read(Lexer & lex)
+{
+       params_.read(lex);
+       lex >> "\\end_inset";
 }
 
 
 void InsetNewpage::metrics(MetricsInfo & mi, Dimension & dim) const
 {
+       if (params_.kind == InsetNewpageParams::NOPAGEBREAK) {
+               frontend::FontMetrics const & fm = theFontMetrics(mi.base.font);
+               dim.asc = fm.maxAscent();
+               dim.des = fm.maxDescent();
+               dim.wid = 3 * fm.width('n');
+               return;
+       }
+
        dim.asc = defaultRowHeight();
        dim.des = defaultRowHeight();
        dim.wid = mi.base.textwidth;
-       // Cache the inset dimension. 
-       setDimCache(mi, dim);
 }
 
 
 void InsetNewpage::draw(PainterInfo & pi, int x, int y) const
 {
+       if (params_.kind == InsetNewpageParams::NOPAGEBREAK) {
+
+               FontInfo font;
+               font.setColor(ColorName());
+
+               frontend::FontMetrics const & fm = theFontMetrics(pi.base.font);
+               int const wid = 3 * fm.width('n');
+               int const asc = fm.maxAscent();
+
+               int xp[3];
+               int yp[3];
+
+               //left side arrow
+               yp[0] = int(y - 0.875 * asc * 0.75);
+               yp[1] = int(y - 0.500 * asc * 0.75);
+               yp[2] = int(y - 0.125 * asc * 0.75);
+               xp[0] = int(x + wid * 0.25);
+               xp[1] = int(x + wid * 0.4); 
+               xp[2] = int(x + wid * 0.25);
+               pi.pain.lines(xp, yp, 3, ColorName());
+
+               yp[0] = yp[1] = int(y - 0.500 * asc * 0.75);
+               xp[0] = int(x + wid * 0.03);
+               xp[1] = int(x + wid * 0.4); 
+               pi.pain.lines(xp, yp, 2, ColorName());
+
+               //right side arrow
+               yp[0] = int(y - 0.875 * asc * 0.75);
+               yp[1] = int(y - 0.500 * asc * 0.75);
+               yp[2] = int(y - 0.125 * asc * 0.75);
+               xp[0] = int(x + wid * 0.75);
+               xp[1] = int(x + wid * 0.6); 
+               xp[2] = int(x + wid * 0.75);
+               pi.pain.lines(xp, yp, 3, ColorName());
+
+               yp[0] = yp[1] = int(y - 0.500 * asc * 0.75);
+               xp[0] = int(x + wid * 0.97);
+               xp[1] = int(x + wid * 0.6); 
+               pi.pain.lines(xp, yp, 2, ColorName());
+
+               //mid-rule
+               xp[0] = xp[1] = int(x + wid * 0.5);
+               yp[0] = int(y - 0.875 * asc * 0.75);
+               yp[1] = int(y - 0.125 * asc * 0.75);
+               pi.pain.lines(xp, yp, 2, ColorName());
+               return;
+       }
+
        using frontend::Painter;
 
        FontInfo font;
@@ -80,24 +194,169 @@ void InsetNewpage::draw(PainterInfo & pi, int x, int y) const
 }
 
 
-int InsetNewpage::latex(odocstream & os, OutputParams const &) const
+void InsetNewpage::doDispatch(Cursor & cur, FuncRequest & cmd)
+{
+       switch (cmd.action()) {
+
+       case LFUN_INSET_MODIFY: {
+               InsetNewpageParams params;
+               cur.recordUndo();
+               string2params(to_utf8(cmd.argument()), params);
+               params_.kind = params.kind;
+               break;
+       }
+
+       default:
+               Inset::doDispatch(cur, cmd);
+               break;
+       }
+}
+
+
+bool InsetNewpage::getStatus(Cursor & cur, FuncRequest const & cmd,
+       FuncStatus & status) const
 {
-       os << from_ascii(getCmdName()) << "{}";
-       return 0;
+       switch (cmd.action()) {
+       // we handle these
+       case LFUN_INSET_MODIFY:
+               if (cmd.getArg(0) == "newpage") {
+                       InsetNewpageParams params;
+                       string2params(to_utf8(cmd.argument()), params);
+                       status.setOnOff(params_.kind == params.kind);
+               }
+               status.setEnabled(true);
+               return true;
+       default:
+               return Inset::getStatus(cur, cmd, status);
+       }
 }
 
 
-int InsetNewpage::plaintext(odocstream & os, OutputParams const &) const
+docstring InsetNewpage::insetLabel() const
 {
+       switch (params_.kind) {
+               case InsetNewpageParams::NEWPAGE:
+                       return _("New Page");
+               case InsetNewpageParams::PAGEBREAK:
+                       return _("Page Break");
+               case InsetNewpageParams::CLEARPAGE:
+                       return _("Clear Page");
+               case InsetNewpageParams::CLEARDOUBLEPAGE:
+                       return _("Clear Double Page");
+               case InsetNewpageParams::NOPAGEBREAK:
+                       return _("No Page Break");
+               default:
+                       return _("New Page");
+       }
+}
+
+
+ColorCode InsetNewpage::ColorName() const
+{
+       switch (params_.kind) {
+               case InsetNewpageParams::PAGEBREAK:
+               case InsetNewpageParams::NOPAGEBREAK:
+                       return Color_pagebreak;
+               case InsetNewpageParams::NEWPAGE:
+               case InsetNewpageParams::CLEARPAGE:
+               case InsetNewpageParams::CLEARDOUBLEPAGE:
+                       return Color_newpage;
+       }
+       // not really useful, but to avoids gcc complaints
+       return Color_newpage;
+}
+
+
+void InsetNewpage::latex(otexstream & os, OutputParams const & runparams) const
+{
+       if (runparams.inDeletedInset) {
+               os << "\\mbox{}\\\\\\makebox[\\columnwidth]{\\dotfill\\ "
+                  << insetLabel() << "\\ \\dotfill}";
+       } else {
+               switch (params_.kind) {
+               case InsetNewpageParams::NEWPAGE:
+                       os << "\\newpage" << termcmd;
+                       break;
+               case InsetNewpageParams::PAGEBREAK:
+                       if (runparams.moving_arg)
+                               os << "\\protect";
+                       os << "\\pagebreak" << termcmd;
+                       break;
+               case InsetNewpageParams::CLEARPAGE:
+                       os << "\\clearpage" << termcmd;
+                       break;
+               case InsetNewpageParams::CLEARDOUBLEPAGE:
+                       os << "\\cleardoublepage" << termcmd;
+                       break;
+               case InsetNewpageParams::NOPAGEBREAK:
+                       os << "\\nopagebreak" << termcmd;
+                       break;
+               default:
+                       os << "\\newpage" << termcmd;
+                       break;
+               }
+       }
+}
+
+
+int InsetNewpage::plaintext(odocstringstream & os,
+        OutputParams const &, size_t) const
+{
+       if (params_.kind ==  InsetNewpageParams::NOPAGEBREAK)
+               return 0;
        os << '\n';
        return PLAINTEXT_NEWLINE;
 }
 
 
-int InsetNewpage::docbook(odocstream & os, OutputParams const &) const
+void InsetNewpage::docbook(XMLStream & os, OutputParams const &) const
 {
-       os << '\n';
-       return 0;
+       if (params_.kind !=  InsetNewpageParams::NOPAGEBREAK)
+               os << xml::CR();
+}
+
+
+docstring InsetNewpage::xhtml(XMLStream & xs, OutputParams const &) const
+{
+       if (params_.kind !=  InsetNewpageParams::NOPAGEBREAK)
+               xs << xml::CompTag("br");
+       return docstring();
+}
+
+
+string InsetNewpage::contextMenuName() const
+{
+       return "context-newpage";
+}
+
+
+void InsetNewpage::string2params(string const & in, InsetNewpageParams & params)
+{
+       params = InsetNewpageParams();
+       if (in.empty())
+               return;
+
+       istringstream data(in);
+       Lexer lex;
+       lex.setStream(data);
+
+       string name;
+       lex >> name;
+       if (!lex || name != "newpage") {
+               LYXERR0("Expected arg 2 to be \"wrap\" in " << in);
+               return;
+       }
+
+       params.read(lex);
+}
+
+
+string InsetNewpage::params2string(InsetNewpageParams const & params)
+{
+       ostringstream data;
+       data << "newpage" << ' ';
+       params.write(data);
+       return data.str();
 }