src/insets/InsetIPA.cpp

   1 /**
   2  * \file InsetIPA.cpp
   3  * This file is part of LyX, the document processor.
   4  * Licence details can be found in the file COPYING.
   5  *
   6  * \author Jürgen Spitzmüller
   7  *
   8  * Full author contact details are available in file CREDITS.
   9  */
  10 #include "config.h"
  11
  12 #include "InsetIPA.h"
  13
  14 #include "Buffer.h"
  15 #include "BufferParams.h"
  16 #include "BufferView.h"
  17 #include "Cursor.h"
  18 #include "FuncRequest.h"
  19 #include "FuncStatus.h"
  20 #include "LaTeXFeatures.h"
  21 #include "Lexer.h"
  22 #include "LyXRC.h"
  23 #include "MetricsInfo.h"
  24 #include "OutputParams.h"
  25 #include "RenderPreview.h"
  26
  27 #include "frontends/Painter.h"
  28
  29 #include "graphics/PreviewImage.h"
  30
  31 #include <sstream>
  32
  33 using namespace std;
  34
  35 namespace lyx {
  36
  37
  38 InsetIPA::InsetIPA(Buffer * buf)
  39         : InsetText(buf),
  40           preview_(new RenderPreview(this)), use_preview_(true)
  41 {
  42         setAutoBreakRows(true);
  43         setDrawFrame(true);
  44         setFrameColor(Color_insetframe);
  45 }
  46
  47
  48 InsetIPA::~InsetIPA()
  49 {}
  50
  51
  52 InsetIPA::InsetIPA(InsetIPA const & other)
  53         : InsetText(other)
  54 {
  55         preview_.reset(new RenderPreview(*other.preview_, this));
  56 }
  57
  58
  59 void InsetIPA::write(ostream & os) const
  60 {
  61         os << "IPA" << "\n";
  62         text().write(os);
  63 }
  64
  65
  66 void InsetIPA::doDispatch(Cursor & cur, FuncRequest & cmd)
  67 {
  68         switch (cmd.action()) {
  69         case LFUN_QUOTE_INSERT: {
  70                 FuncRequest fr(LFUN_SELF_INSERT, "\"");
  71                 InsetText::doDispatch(cur, fr);
  72                 break;
  73         }
  74         default:
  75                 InsetText::doDispatch(cur, cmd);
  76                 break;
  77         }
  78
  79 }
  80
  81
  82 bool InsetIPA::getStatus(Cursor & cur, FuncRequest const & cmd,
  83                 FuncStatus & flag) const
  84 {
  85         switch (cmd.action()) {
  86         case LFUN_SCRIPT_INSERT: {
  87                 if (cmd.argument() == "subscript") {
  88                         flag.setEnabled(false);
  89                         return true;
  90                 }
  91                 break;
  92         }
  93         case LFUN_IN_IPA:
  94                 flag.setEnabled(true);
  95                 return true;
  96                 break;
  97         default:
  98                 break;
  99         }
 100         return InsetText::getStatus(cur, cmd, flag);
 101 }
 102
 103
 104 void InsetIPA::addPreview(DocIterator const & inset_pos,
 105         graphics::PreviewLoader &) const
 106 {
 107         preparePreview(inset_pos);
 108 }
 109
 110
 111 void InsetIPA::preparePreview(DocIterator const & pos) const
 112 {
 113         TexRow texrow;
 114         odocstringstream str;
 115         otexstream os(str, texrow);
 116         OutputParams runparams(&pos.buffer()->params().encoding());
 117         latex(os, runparams);
 118         docstring const snippet = str.str();
 119         preview_->addPreview(snippet, *pos.buffer());
 120 }
 121
 122
 123 bool InsetIPA::previewState(BufferView * bv) const
 124 {
 125         if (!editing(bv) && (RenderPreview::status() == LyXRC::PREVIEW_ON ||
 126                              RenderPreview::status() == LyXRC::PREVIEW_NO_MATH)) {
 127                 graphics::PreviewImage const * pimage =
 128                         preview_->getPreviewImage(bv->buffer());
 129                 return pimage && pimage->image();
 130         }
 131         return false;
 132 }
 133
 134
 135 void InsetIPA::reloadPreview(DocIterator const & pos) const
 136 {
 137         preparePreview(pos);
 138         preview_->startLoading(*pos.buffer());
 139 }
 140
 141
 142 void InsetIPA::draw(PainterInfo & pi, int x, int y) const
 143 {
 144         use_preview_ = previewState(pi.base.bv);
 145
 146         if (use_preview_) {
 147                 preview_->draw(pi, x + TEXT_TO_INSET_OFFSET, y);
 148                 setPosCache(pi, x, y);
 149                 return;
 150         }
 151         InsetText::draw(pi, x, y);
 152 }
 153
 154
 155 void InsetIPA::edit(Cursor & cur, bool front, EntryDirection entry_from)
 156 {
 157         cur.push(*this);
 158         InsetText::edit(cur, front, entry_from);
 159 }
 160
 161
 162 Inset * InsetIPA::editXY(Cursor & cur, int x, int y)
 163 {
 164         if (use_preview_) {
 165                 edit(cur, true, ENTRY_DIRECTION_IGNORE);
 166                 return this;
 167         }
 168         cur.push(*this);
 169         return InsetText::editXY(cur, x, y);
 170 }
 171
 172
 173 void InsetIPA::metrics(MetricsInfo & mi, Dimension & dim) const
 174 {
 175         if (previewState(mi.base.bv)) {
 176                 preview_->metrics(mi, dim);
 177                 mi.base.textwidth += 2 * TEXT_TO_INSET_OFFSET;
 178
 179                 dim.wid = max(dim.wid, 4);
 180                 dim.asc = max(dim.asc, 4);
 181
 182                 dim.asc += TEXT_TO_INSET_OFFSET;
 183                 dim.des += TEXT_TO_INSET_OFFSET;
 184                 dim.wid += TEXT_TO_INSET_OFFSET;
 185                 dim_ = dim;
 186                 dim.wid += TEXT_TO_INSET_OFFSET;
 187                 // insert a one pixel gap
 188                 dim.wid += 1;
 189                 // Cache the inset dimension.
 190                 setDimCache(mi, dim);
 191                 Dimension dim_dummy;
 192                 MetricsInfo mi_dummy = mi;
 193                 InsetText::metrics(mi_dummy, dim_dummy);
 194                 return;
 195         }
 196         InsetText::metrics(mi, dim);
 197 }
 198
 199
 200 bool InsetIPA::notifyCursorLeaves(Cursor const & old, Cursor & cur)
 201 {
 202         reloadPreview(old);
 203         cur.screenUpdateFlags(Update::Force);
 204         return InsetText::notifyCursorLeaves(old, cur);
 205 }
 206
 207
 208 void InsetIPA::validate(LaTeXFeatures & features) const
 209 {
 210         features.require("tipa");
 211         features.require("tipx");
 212
 213         InsetText::validate(features);
 214 }
 215
 216
 217 void InsetIPA::latex(otexstream & os, OutputParams const & runparams_in) const
 218 {
 219         OutputParams runparams(runparams_in);
 220         runparams.inIPA = true;
 221         bool const multipar = (text().paragraphs().size() > 1);
 222         // fontspec knows \textipa, but not the IPA environment
 223         bool const nontexfonts = buffer_->params().useNonTeXFonts;
 224         if (multipar && !nontexfonts)
 225                 os << "\\begin{IPA}\n";
 226         else
 227                 os << "\\textipa{";
 228         InsetText::latex(os, runparams);
 229         if (multipar && !nontexfonts)
 230                 os << "\n\\end{IPA}";
 231         else
 232                 os << "}";
 233 }
 234
 235
 236 bool InsetIPA::insetAllowed(InsetCode code) const
 237 {
 238         switch (code) {
 239         // code that is allowed
 240         case ERT_CODE:
 241         case IPACHAR_CODE:
 242         case IPADECO_CODE:
 243         case SCRIPT_CODE:
 244                 return true;
 245         default:
 246                 return false;
 247         }
 248 }
 249
 250
 251 } // namespace lyx