]> git.lyx.org Git - lyx.git/blobdiff - src/insets/InsetERT.cpp
DocBook: fix XML in comments (-- forbidden for some historical reason).
[lyx.git] / src / insets / InsetERT.cpp
index 1fe2af0af8db88a67729d13930a09de1f96457e2..a023f7a464af403154af95fa6ae37737f977997e 100644 (file)
@@ -3,8 +3,8 @@
  * This file is part of LyX, the document processor.
  * Licence details can be found in the file COPYING.
  *
- * \author Jürgen Vigna
- * \author Lars Gullik Bjønnes
+ * \author Jürgen Vigna
+ * \author Lars Gullik Bjønnes
  *
  * Full author contact details are available in file CREDITS.
  */
 #include "BufferParams.h"
 #include "BufferView.h"
 #include "Cursor.h"
-#include "debug.h"
 #include "DispatchResult.h"
 #include "FuncRequest.h"
 #include "FuncStatus.h"
-#include "gettext.h"
 #include "Language.h"
 #include "Layout.h"
-#include "Color.h"
-#include "LyXAction.h"
 #include "Lexer.h"
-#include "TextClass.h"
-#include "MetricsInfo.h"
+#include "LyXAction.h"
+#include "OutputParams.h"
+#include "xml.h"
 #include "ParagraphParameters.h"
 #include "Paragraph.h"
+#include <output_docbook.h>
 
-#include "frontends/alert.h"
+#include "support/docstream.h"
+#include "support/gettext.h"
+#include "support/lstrings.h"
+#include "support/TempFile.h"
 
 #include <sstream>
 
+using namespace std;
+using namespace lyx::support;
 
 namespace lyx {
 
-using support::token;
-
-using std::endl;
-using std::min;
-
-using std::istringstream;
-using std::ostream;
-using std::ostringstream;
-using std::string;
-
-
-void InsetERT::init()
+InsetERT::InsetERT(Buffer * buf, CollapseStatus status)
+       : InsetCollapsible(buf)
 {
-       setButtonLabel();
-       setLabelFont(layout_.labelfont);
-       // FIXME: what to do with those?
-       //text_.current_font.setLanguage(latex_language);
-       //text_.real_current_font.setLanguage(latex_language);
+       status_ = status;
 }
 
 
-InsetERT::InsetERT(BufferParams const & bp, CollapseStatus status)
-       : InsetCollapsable(bp, status)
-{
-       setLayout(bp);
-       init();
-}
-
-
-InsetERT::InsetERT(InsetERT const & in)
-       : InsetCollapsable(in)
-{
-       init();
-}
-
-
-Inset * InsetERT::clone() const
-{
-       return new InsetERT(*this);
-}
-
-
-#if 0
-InsetERT::InsetERT(BufferParams const & bp,
-                  Language const *, string const & contents, CollapseStatus status)
-       : InsetCollapsable(bp, status)
-{
-       Font font(Font::ALL_INHERIT, latex_language);
-       paragraphs().begin()->insert(0, contents, font);
-
-       // the init has to be after the initialization of the paragraph
-       // because of the label settings (draw_label for ert insets).
-       init();
-}
-#endif
-
-
-InsetERT::~InsetERT()
-{
-       InsetERTMailer(*this).hideDialog();
-}
+InsetERT::InsetERT(InsetERT const & old)
+       : InsetCollapsible(old)
+{}
 
 
-void InsetERT::write(Buffer const & buf, ostream & os) const
+void InsetERT::write(ostream & os) const
 {
        os << "ERT" << "\n";
-       InsetCollapsable::write(buf, os);
+       InsetCollapsible::write(os);
 }
 
 
-void InsetERT::read(Buffer const & buf, Lexer & lex)
+int InsetERT::plaintext(odocstringstream & os,
+        OutputParams const & rp, size_t max_length) const
 {
-       InsetCollapsable::read(buf, lex);
-
-       // Force default font
-       // This avoids paragraphs in buffer language that would have a
-       // foreign language after a document langauge change, and it ensures
-       // that all new text in ERT gets the "latex" language, since new text
-       // inherits the language from the last position of the existing text.
-       // As a side effect this makes us also robust against bugs in LyX
-       // that might lead to font changes in ERT in .lyx files.
-       Font font(Font::ALL_INHERIT, latex_language);
-       ParagraphList::iterator par = paragraphs().begin();
-       ParagraphList::iterator const end = paragraphs().end();
-       while (par != end) {
-               pos_type siz = par->size();
-               for (pos_type i = 0; i <= siz; ++i) {
-                       par->setFont(i, font);
-               }
-               ++par;
-       }
-}
+       if (!rp.inIndexEntry)
+               // do not output TeX code
+               return 0;
 
-
-docstring const InsetERT::editMessage() const
-{
-       return _("Opened ERT Inset");
-}
-
-
-int InsetERT::latex(Buffer const &, odocstream & os,
-                   OutputParams const &) const
-{
        ParagraphList::const_iterator par = paragraphs().begin();
        ParagraphList::const_iterator end = paragraphs().end();
 
-       int lines = 0;
-       while (par != end) {
+       while (par != end && os.str().size() <= max_length) {
                pos_type siz = par->size();
                for (pos_type i = 0; i < siz; ++i) {
-                       // ignore all struck out text
-                       if (par->isDeleted(i))
-                               continue;
-
-                       os.put(par->getChar(i));
+                       char_type const c = par->getChar(i);
+                       // output the active characters
+                       switch (c) {
+                       case '|':
+                       case '!':
+                       case '@':
+                               os.put(c);
+                               break;
+                       default:
+                               break;
+                       }
                }
                ++par;
-               if (par != end) {
-                       os << "\n";
-                       ++lines;
-               }
        }
-
-       return lines;
+       return 0;
 }
 
 
-int InsetERT::plaintext(Buffer const &, odocstream &,
-                       OutputParams const &) const
+void InsetERT::docbook(XMLStream & xs, OutputParams const & runparams) const
 {
-       return 0; // do not output TeX code
-}
+       auto const begin = paragraphs().begin();
+       auto par = begin;
+       auto const end = paragraphs().end();
 
+       odocstringstream os2;
+       XMLStream xs2(os2);
 
-int InsetERT::docbook(Buffer const &, odocstream & os,
-                     OutputParams const &) const
-{
-       ParagraphList::const_iterator par = paragraphs().begin();
-       ParagraphList::const_iterator end = paragraphs().end();
-
-       int lines = 0;
+       // Recreate the logic of makeParagraphs in output_docbook.cpp, but much simplified: never open <para>
+       // in an ERT, use simple line breaks.
        while (par != end) {
-               pos_type siz = par->size();
-               for (pos_type i = 0; i < siz; ++i)
-                       os.put(par->getChar(i));
+               par->simpleDocBookOnePar(buffer(), xs2, runparams, text().outerFont(distance(begin, par)));
+
+               // New line after each paragraph of the ERT, save the last one.
                ++par;
-               if (par != end) {
-                       os << "\n";
-                       ++lines;
-               }
+               if (par != end)
+                       xs << "\n";
        }
 
-       return lines;
+       // Output the ERT as a comment with the appropriate escaping.
+       xs << XMLStream::ESCAPE_NONE << "<!-- ";
+       xs << XMLStream::ESCAPE_COMMENTS << os2.str();
+       xs << XMLStream::ESCAPE_NONE << " -->";
 }
 
 
 void InsetERT::doDispatch(Cursor & cur, FuncRequest & cmd)
 {
-       BufferParams const & bp = cur.buffer().params();
-       LayoutPtr const layout =
-                       bp.getTextClass().defaultLayout();
-       //lyxerr << "\nInsetERT::doDispatch (begin): cmd: " << cmd << endl;
-       switch (cmd.action) {
-
-       case LFUN_MOUSE_PRESS:
-               if (cmd.button() != mouse_button::button3)
-                       InsetCollapsable::doDispatch(cur, cmd);
-               else
-                       // This makes the cursor leave the
-                       // inset when it collapses on mouse-3
-                       cur.undispatched();
-               break;
-
-       case LFUN_QUOTE_INSERT: {
-               // We need to bypass the fancy quotes in Text
-               FuncRequest f(LFUN_SELF_INSERT, "\"");
-               dispatch(cur, f);
-               break;
-       }
-       case LFUN_INSET_MODIFY: {
-               InsetCollapsable::CollapseStatus st;
-               InsetERTMailer::string2params(to_utf8(cmd.argument()), st);
-               setStatus(cur, st);
-               break;
-       }
-       case LFUN_PASTE:
-       case LFUN_CLIPBOARD_PASTE:
-       case LFUN_PRIMARY_SELECTION_PASTE: {
-               InsetCollapsable::doDispatch(cur, cmd);
-
-               // Since we can only store plain text, we must reset all
-               // attributes.
-               // FIXME: Change only the pasted paragraphs
-
-               Font font = layout->font;
-               // ERT contents has always latex_language
-               font.setLanguage(latex_language);
-               ParagraphList::iterator const end = paragraphs().end();
-               for (ParagraphList::iterator par = paragraphs().begin();
-                    par != end; ++par) {
-                       // in case par had a manual label
-                       par->setBeginOfBody();
-                       pos_type const siz = par->size();
-                       for (pos_type i = 0; i < siz; ++i) {
-                               par->setFont(i, font);
-                       }
-                       par->params().clear();
+       switch (cmd.action()) {
+       case LFUN_INSET_MODIFY:
+               if (cmd.getArg(0) == "ert") {
+                       cur.recordUndoInset(this);
+                       setStatus(cur, string2params(to_utf8(cmd.argument())));
+                       break;
                }
-               break;
-       }
+               //fall-through
        default:
-               // Force any new text to latex_language
-               // FIXME: This should only be necessary in init(), but
-               // new paragraphs that are created by pressing enter at the
-               // start of an existing paragraph get the buffer language
-               // and not latex_language, so we take this brute force
-               // approach.
-               cur.current_font = layout->font;
-               cur.real_current_font = layout->font;
-               cur.current_font.setLanguage(latex_language);
-               cur.real_current_font.setLanguage(latex_language);
-               InsetCollapsable::doDispatch(cur, cmd);
+               InsetCollapsible::doDispatch(cur, cmd);
                break;
        }
+
 }
 
 
 bool InsetERT::getStatus(Cursor & cur, FuncRequest const & cmd,
        FuncStatus & status) const
 {
-       switch (cmd.action) {
-               // suppress these
-               case LFUN_ACCENT_ACUTE:
-               case LFUN_ACCENT_BREVE:
-               case LFUN_ACCENT_CARON:
-               case LFUN_ACCENT_CEDILLA:
-               case LFUN_ACCENT_CIRCLE:
-               case LFUN_ACCENT_CIRCUMFLEX:
-               case LFUN_ACCENT_DOT:
-               case LFUN_ACCENT_GRAVE:
-               case LFUN_ACCENT_HUNGARIAN_UMLAUT:
-               case LFUN_ACCENT_MACRON:
-               case LFUN_ACCENT_OGONEK:
-               case LFUN_ACCENT_SPECIAL_CARON:
-               case LFUN_ACCENT_TIE:
-               case LFUN_ACCENT_TILDE:
-               case LFUN_ACCENT_UMLAUT:
-               case LFUN_ACCENT_UNDERBAR:
-               case LFUN_ACCENT_UNDERDOT:
-               case LFUN_APPENDIX:
-               case LFUN_BREAK_LINE:
-               case LFUN_CAPTION_INSERT:
-               case LFUN_DEPTH_DECREMENT:
-               case LFUN_DEPTH_INCREMENT:
-               case LFUN_DOTS_INSERT:
-               case LFUN_END_OF_SENTENCE_PERIOD_INSERT:
-               case LFUN_ENVIRONMENT_INSERT:
-               case LFUN_ERT_INSERT:
-               case LFUN_FILE_INSERT:
-               case LFUN_FLOAT_INSERT:
-               case LFUN_FLOAT_WIDE_INSERT:
-               case LFUN_WRAP_INSERT:
-               case LFUN_FONT_BOLD:
-               case LFUN_FONT_TYPEWRITER:
-               case LFUN_FONT_DEFAULT:
-               case LFUN_FONT_EMPH:
-               case LFUN_FONT_FREE_APPLY:
-               case LFUN_FONT_FREE_UPDATE:
-               case LFUN_FONT_NOUN:
-               case LFUN_FONT_ROMAN:
-               case LFUN_FONT_SANS:
-               case LFUN_FONT_FRAK:
-               case LFUN_FONT_ITAL:
-               case LFUN_FONT_SIZE:
-               case LFUN_FONT_STATE:
-               case LFUN_FONT_UNDERLINE:
-               case LFUN_FOOTNOTE_INSERT:
-               case LFUN_HFILL_INSERT:
-               case LFUN_HTML_INSERT:
-               case LFUN_HYPHENATION_POINT_INSERT:
-               case LFUN_LIGATURE_BREAK_INSERT:
-               case LFUN_INDEX_INSERT:
-               case LFUN_INDEX_PRINT:
-               case LFUN_LABEL_INSERT:
-               case LFUN_OPTIONAL_INSERT:
-               case LFUN_BIBITEM_INSERT:
-               case LFUN_LINE_INSERT:
-               case LFUN_PAGEBREAK_INSERT:
-               case LFUN_CLEARPAGE_INSERT:
-               case LFUN_CLEARDOUBLEPAGE_INSERT:
-               case LFUN_LANGUAGE:
-               case LFUN_LAYOUT:
-               case LFUN_LAYOUT_PARAGRAPH:
-               case LFUN_LAYOUT_TABULAR:
-               case LFUN_MARGINALNOTE_INSERT:
-               case LFUN_MATH_DISPLAY:
-               case LFUN_MATH_INSERT:
-               case LFUN_MATH_MATRIX:
-               case LFUN_MATH_MODE:
-               case LFUN_MENU_OPEN:
-               case LFUN_MENU_SEPARATOR_INSERT:
-               case LFUN_BRANCH_INSERT:
-               case LFUN_FLEX_INSERT:
-               case LFUN_NOTE_INSERT:
-               case LFUN_BOX_INSERT:
-               case LFUN_NOTE_NEXT:
-               case LFUN_PARAGRAPH_SPACING:
-               case LFUN_LABEL_GOTO:
-               case LFUN_REFERENCE_NEXT:
-               case LFUN_SPACE_INSERT:
-               case LFUN_SERVER_GOTO_FILE_ROW:
-               case LFUN_SERVER_NOTIFY:
-               case LFUN_SERVER_SET_XY:
-               case LFUN_TABULAR_INSERT:
-               case LFUN_TOC_INSERT:
-               case LFUN_URL_INSERT:
-               case LFUN_FLOAT_LIST:
-               case LFUN_INSET_INSERT:
-               case LFUN_PARAGRAPH_PARAMS:
-               case LFUN_PARAGRAPH_PARAMS_APPLY:
-               case LFUN_PARAGRAPH_UPDATE:
-               case LFUN_NOMENCL_INSERT:
-               case LFUN_NOMENCL_PRINT:
-               case LFUN_NOACTION:
-                       status.enabled(false);
-                       return true;
-
-               case LFUN_QUOTE_INSERT:
-               case LFUN_INSET_MODIFY:
-               case LFUN_PASTE:
-               case LFUN_CLIPBOARD_PASTE:
-               case LFUN_PRIMARY_SELECTION_PASTE:
-                       status.enabled(true);
+       switch (cmd.action()) {
+       case LFUN_INSET_INSERT:
+               status.setEnabled(false);
+               return true;
+       case LFUN_INSET_MODIFY:
+               if (cmd.getArg(0) == "ert") {
+                       status.setEnabled(true);
                        return true;
-
-               // this one is difficult to get right. As a half-baked
-               // solution, we consider only the first action of the sequence
-               case LFUN_COMMAND_SEQUENCE: {
-                       // argument contains ';'-terminated commands
-                       string const firstcmd = token(to_utf8(cmd.argument()), ';', 0);
-                       FuncRequest func(lyxaction.lookupFunc(firstcmd));
-                       func.origin = cmd.origin;
-                       return getStatus(cur, func, status);
                }
+               //fall through
 
-               default:
-                       return InsetCollapsable::getStatus(cur, cmd, status);
+       default:
+               return InsetCollapsible::getStatus(cur, cmd, status);
        }
 }
 
 
-void InsetERT::setButtonLabel()
-{
-       // FIXME UNICODE
-       if (decoration() == Classic)
-               setLabel(isOpen() ? _("ERT") : getNewLabel(_("ERT")));
-       else
-               setLabel(getNewLabel(_("ERT")));
-}
-
-
-bool InsetERT::insetAllowed(Inset::Code /* code */) const
-{
-       return false;
-}
-
-
-void InsetERT::metrics(MetricsInfo & mi, Dimension & dim) const
-{
-       Font tmpfont = mi.base.font;
-       getDrawFont(mi.base.font);
-       mi.base.font.realize(tmpfont);
-       InsetCollapsable::metrics(mi, dim);
-       mi.base.font = tmpfont;
-}
-
-
-void InsetERT::draw(PainterInfo & pi, int x, int y) const
-{
-       Font tmpfont = pi.base.font;
-       getDrawFont(pi.base.font);
-       pi.base.font.realize(tmpfont);
-       const_cast<InsetERT &>(*this).setButtonLabel();
-       InsetCollapsable::draw(pi, x, y);
-       pi.base.font = tmpfont;
-}
-
 
-bool InsetERT::showInsetDialog(BufferView * bv) const
+docstring const InsetERT::buttonLabel(BufferView const & bv) const
 {
-       InsetERTMailer(const_cast<InsetERT &>(*this)).showDialog(bv);
-       return true;
-}
-
-
-void InsetERT::getDrawFont(Font & font) const
-{
-       font = Font(Font::ALL_INHERIT, latex_language);
-       font.realize(layout_.font);
-}
-
-
-string const InsetERTMailer::name_("ert");
-
-InsetERTMailer::InsetERTMailer(InsetERT & inset)
-       : inset_(inset)
-{}
-
-
-string const InsetERTMailer::inset2string(Buffer const &) const
-{
-       return params2string(inset_.status());
+       if (decoration() == InsetLayout::CLASSIC)
+               return isOpen(bv) ? _("ERT") : getNewLabel(_("ERT"));
+       else
+               return getNewLabel(_("ERT"));
 }
 
 
-void InsetERTMailer::string2params(string const & in,
-                                  InsetCollapsable::CollapseStatus & status)
+InsetCollapsible::CollapseStatus InsetERT::string2params(string const & in)
 {
-       status = InsetCollapsable::Collapsed;
        if (in.empty())
-               return;
-
+               return Collapsed;
        istringstream data(in);
-       Lexer lex(0,0);
+       Lexer lex;
        lex.setStream(data);
-
-       string name;
-       lex >> name;
-       if (name != name_)
-               return print_mailer_error("InsetERTMailer", in, 1, name_);
-
+       lex.setContext("InsetERT::string2params");
+       lex >> "ert";
        int s;
        lex >> s;
-       if (lex)
-               status = static_cast<InsetCollapsable::CollapseStatus>(s);
+       return static_cast<CollapseStatus>(s);
 }
 
 
-string const
-InsetERTMailer::params2string(InsetCollapsable::CollapseStatus status)
+string InsetERT::params2string(CollapseStatus status)
 {
        ostringstream data;
-       data << name_ << ' ' << status;
+       data << "ert" << ' ' << status;
        return data.str();
 }
 
 
+docstring InsetERT::xhtml(XMLStream &, OutputParams const &) const
+{
+       return docstring();
+}
+
 } // namespace lyx