src/insets/InsetCaption.cpp

   1 /**
   2  * \file InsetCaption.cpp
   3  * This file is part of LyX, the document processor.
   4  * Licence details can be found in the file COPYING.
   5  *
   6  * \author Lars Gullik Bjønnes
   7  *
   8  * Full author contact details are available in file CREDITS.
   9  */
  10
  11 #include <config.h>
  12
  13 #include "InsetCaption.h"
  14 #include "InsetFloat.h"
  15 #include "InsetWrap.h"
  16
  17 #include "Buffer.h"
  18 #include "BufferParams.h"
  19 #include "BufferView.h"
  20 #include "Counters.h"
  21 #include "Cursor.h"
  22 #include "Dimension.h"
  23 #include "Floating.h"
  24 #include "FloatList.h"
  25 #include "FuncRequest.h"
  26 #include "FuncStatus.h"
  27 #include "InsetList.h"
  28 #include "Language.h"
  29 #include "MetricsInfo.h"
  30 #include "output_latex.h"
  31 #include "output_xhtml.h"
  32 #include "OutputParams.h"
  33 #include "Paragraph.h"
  34 #include "ParIterator.h"
  35 #include "TextClass.h"
  36 #include "TextMetrics.h"
  37 #include "TocBackend.h"
  38
  39 #include "frontends/FontMetrics.h"
  40 #include "frontends/Painter.h"
  41
  42 #include "support/gettext.h"
  43 #include "support/lstrings.h"
  44
  45 #include <sstream>
  46
  47 using namespace std;
  48 using namespace lyx::support;
  49
  50 namespace lyx {
  51
  52
  53 InsetCaption::InsetCaption(Buffer * buf, string const & type)
  54     : InsetText(buf, InsetText::PlainLayout), type_(type)
  55 {
  56         setAutoBreakRows(true);
  57         setDrawFrame(true);
  58         setFrameColor(Color_collapsableframe);
  59 }
  60
  61
  62 void InsetCaption::write(ostream & os) const
  63 {
  64         os << "Caption";
  65         if (!type_.empty()) {
  66                 os << " "
  67                    << type_;
  68         }
  69         os << "\n";
  70         text().write(os);
  71 }
  72
  73
  74 docstring InsetCaption::layoutName() const
  75 {
  76         if (type_.empty())
  77                 return from_ascii("Caption");
  78         return from_utf8("Caption:" + type_);
  79 }
  80
  81
  82 void InsetCaption::cursorPos(BufferView const & bv,
  83                 CursorSlice const & sl, bool boundary, int & x, int & y) const
  84 {
  85         InsetText::cursorPos(bv, sl, boundary, x, y);
  86         x += labelwidth_;
  87 }
  88
  89
  90 void InsetCaption::setCustomLabel(docstring const & label)
  91 {
  92         custom_label_ = translateIfPossible(label);
  93 }
  94
  95
  96 void InsetCaption::addToToc(DocIterator const & cpit, bool output_active) const
  97 {
  98         if (floattype_.empty())
  99                 return;
 100
 101         DocIterator pit = cpit;
 102         pit.push_back(CursorSlice(const_cast<InsetCaption &>(*this)));
 103
 104         Toc & toc = buffer().tocBackend().toc(floattype_);
 105         docstring str = full_label_;
 106         int length = output_active ? INT_MAX : TOC_ENTRY_LENGTH;
 107         text().forOutliner(str, length);
 108         toc.push_back(TocItem(pit, 0, str, output_active));
 109
 110         // Proceed with the rest of the inset.
 111         InsetText::addToToc(cpit, output_active);
 112 }
 113
 114
 115 void InsetCaption::metrics(MetricsInfo & mi, Dimension & dim) const
 116 {
 117         FontInfo tmpfont = mi.base.font;
 118         mi.base.font = mi.base.bv->buffer().params().getFont().fontInfo();
 119         labelwidth_ = theFontMetrics(mi.base.font).width(full_label_);
 120         // add some space to separate the label from the inset text
 121         labelwidth_ += 2 * TEXT_TO_INSET_OFFSET;
 122         dim.wid = labelwidth_;
 123         Dimension textdim;
 124         // Correct for button and label width
 125         mi.base.textwidth -= dim.wid;
 126         InsetText::metrics(mi, textdim);
 127         mi.base.font = tmpfont;
 128         mi.base.textwidth += dim.wid;
 129         dim.des = max(dim.des - textdim.asc + dim.asc, textdim.des);
 130         dim.asc = textdim.asc;
 131         dim.wid += textdim.wid;
 132 }
 133
 134
 135 void InsetCaption::drawBackground(PainterInfo & pi, int x, int y) const
 136 {
 137         TextMetrics & tm = pi.base.bv->textMetrics(&text());
 138         int const h = tm.height() + 2 * TEXT_TO_INSET_OFFSET;
 139         int const yy = y - TEXT_TO_INSET_OFFSET - tm.ascent();
 140         pi.pain.fillRectangle(x, yy, labelwidth_, h, pi.backgroundColor(this));
 141 }
 142
 143
 144 void InsetCaption::draw(PainterInfo & pi, int x, int y) const
 145 {
 146         // We must draw the label, we should get the label string
 147         // from the enclosing float inset.
 148         // The question is: Who should draw the label, the caption inset,
 149         // the text inset or the paragraph?
 150         // We should also draw the float number (Lgb)
 151
 152         // Answer: the text inset (in buffer_funcs.cpp: setCaption).
 153
 154         FontInfo tmpfont = pi.base.font;
 155         pi.base.font = pi.base.bv->buffer().params().getFont().fontInfo();
 156         pi.base.font.setColor(pi.textColor(pi.base.font.color()).baseColor);
 157         int const xx = x + TEXT_TO_INSET_OFFSET;
 158         pi.pain.text(xx, y, full_label_, pi.base.font);
 159         InsetText::draw(pi, x + labelwidth_, y);
 160         pi.base.font = tmpfont;
 161 }
 162
 163
 164 void InsetCaption::edit(Cursor & cur, bool front, EntryDirection entry_from)
 165 {
 166         cur.push(*this);
 167         InsetText::edit(cur, front, entry_from);
 168 }
 169
 170
 171 Inset * InsetCaption::editXY(Cursor & cur, int x, int y)
 172 {
 173         cur.push(*this);
 174         return InsetText::editXY(cur, x, y);
 175 }
 176
 177
 178 bool InsetCaption::insetAllowed(InsetCode code) const
 179 {
 180         switch (code) {
 181         // code that is not allowed in a caption
 182         case CAPTION_CODE:
 183         case FLOAT_CODE:
 184         case FOOT_CODE:
 185         case NEWPAGE_CODE:
 186         case MARGIN_CODE:
 187         case MATHMACRO_CODE:
 188         case TABULAR_CODE:
 189         case WRAP_CODE:
 190                 return false;
 191         default:
 192                 return InsetText::insetAllowed(code);
 193         }
 194 }
 195
 196
 197 void InsetCaption::doDispatch(Cursor & cur, FuncRequest & cmd)
 198 {
 199         switch (cmd.action()) {
 200
 201         case LFUN_INSET_MODIFY: {
 202                 if (cmd.getArg(0) == "changetype") {
 203                         cur.recordUndoInset(ATOMIC_UNDO, this);
 204                         type_ = cmd.getArg(1);
 205                         cur.forceBufferUpdate();
 206                         break;
 207                 }
 208         }
 209
 210         default:
 211                 InsetText::doDispatch(cur, cmd);
 212                 break;
 213         }
 214 }
 215
 216
 217 bool InsetCaption::getStatus(Cursor & cur, FuncRequest const & cmd,
 218         FuncStatus & status) const
 219 {
 220         switch (cmd.action()) {
 221
 222         case LFUN_INSET_MODIFY: {
 223                 string const first_arg = cmd.getArg(0);
 224                 if (first_arg == "changetype") {
 225                         string const type = cmd.getArg(1);
 226                         status.setOnOff(type == type_);
 227                         bool varia = type != "LongTableNoNumber";
 228                         // check if the immediate parent inset allows caption variation
 229                         if (cur.depth() > 1) {
 230                                 varia = cur[cur.depth() - 2].inset().allowsCaptionVariation(type);
 231                         }
 232                         status.setEnabled(varia
 233                                           && buffer().params().documentClass().hasInsetLayout(
 234                                                 from_ascii("Caption:" + type)));
 235                         return true;
 236                 }
 237                 return InsetText::getStatus(cur, cmd, status);
 238         }
 239
 240         case LFUN_INSET_TOGGLE:
 241                 // pass back to owner
 242                 cur.undispatched();
 243                 return false;
 244
 245         default:
 246                 return InsetText::getStatus(cur, cmd, status);
 247         }
 248 }
 249
 250
 251 void InsetCaption::latex(otexstream & os,
 252                          OutputParams const & runparams_in) const
 253 {
 254         if (runparams_in.inFloat == OutputParams::SUBFLOAT)
 255                 // caption is output as an optional argument
 256                 return;
 257         // This is a bit too simplistic to take advantage of
 258         // caption options we must add more later. (Lgb)
 259         // This code is currently only able to handle the simple
 260         // \caption{...}, later we will make it take advantage
 261         // of the one of the caption packages. (Lgb)
 262         OutputParams runparams = runparams_in;
 263         InsetText::latex(os, runparams);
 264         // Backwards compatibility: We always had a linebreak after
 265         // the caption (see #8514)
 266         os << breakln;
 267         runparams_in.encoding = runparams.encoding;
 268 }
 269
 270
 271 int InsetCaption::plaintext(odocstringstream & os,
 272                             OutputParams const & runparams, size_t max_length) const
 273 {
 274         os << '[' << full_label_ << "\n";
 275         InsetText::plaintext(os, runparams, max_length);
 276         os << "\n]";
 277
 278         return PLAINTEXT_NEWLINE + 1; // one char on a separate line
 279 }
 280
 281
 282 int InsetCaption::docbook(odocstream & os,
 283                           OutputParams const & runparams) const
 284 {
 285         int ret;
 286         os << "<title>";
 287         ret = InsetText::docbook(os, runparams);
 288         os << "</title>\n";
 289         return ret;
 290 }
 291
 292
 293 docstring InsetCaption::xhtml(XHTMLStream & xs, OutputParams const & rp) const
 294 {
 295         if (rp.html_disable_captions)
 296                 return docstring();
 297         InsetLayout const & il = getLayout();
 298         string const & tag = il.htmltag();
 299         string attr = il.htmlattr();
 300         if (!type_.empty()) {
 301                 string const our_class = "float-caption-" + type_;
 302                 size_t const loc = attr.find("class='");
 303                 if (loc != string::npos)
 304                         attr.insert(loc + 7, our_class+ " ");
 305                 else
 306                         attr = attr + " class='" + our_class + "'";
 307         }
 308         xs << html::StartTag(tag, attr);
 309         docstring def = getCaptionAsHTML(xs, rp);
 310         xs << html::EndTag(tag);
 311         return def;
 312 }
 313
 314
 315 void InsetCaption::getArgument(otexstream & os,
 316                         OutputParams const & runparams) const
 317 {
 318         InsetLayout const & il = getLayout();
 319
 320         if (!il.leftdelim().empty())
 321                 os << il.leftdelim();
 322
 323         OutputParams rp = runparams;
 324         if (isPassThru())
 325                 rp.pass_thru = true;
 326         if (il.isNeedProtect())
 327                 rp.moving_arg = true;
 328         rp.par_begin = 0;
 329         rp.par_end = paragraphs().size();
 330
 331         // Output the contents of the inset
 332         latexParagraphs(buffer(), text(), os, rp);
 333         runparams.encoding = rp.encoding;
 334
 335         if (!il.rightdelim().empty())
 336                 os << il.rightdelim();
 337 }
 338
 339
 340 int InsetCaption::getCaptionAsPlaintext(odocstream & os,
 341                         OutputParams const & runparams) const
 342 {
 343         os << full_label_ << ' ';
 344         odocstringstream ods;
 345         int const retval = InsetText::plaintext(ods, runparams);
 346         os << ods.str();
 347         return retval;
 348 }
 349
 350
 351 docstring InsetCaption::getCaptionAsHTML(XHTMLStream & xs,
 352                         OutputParams const & runparams) const
 353 {
 354         xs << full_label_ << ' ';
 355         InsetText::XHTMLOptions const opts =
 356                 InsetText::WriteLabel | InsetText::WriteInnerTag;
 357         return InsetText::insetAsXHTML(xs, runparams, opts);
 358 }
 359
 360
 361 void InsetCaption::updateBuffer(ParIterator const & it, UpdateType utype)
 362 {
 363         Buffer const & master = *buffer().masterBuffer();
 364         DocumentClass const & tclass = master.params().documentClass();
 365         string const & lang = it.paragraph().getParLanguage(master.params())->code();
 366         Counters & cnts = tclass.counters();
 367         string const & type = cnts.current_float();
 368         if (utype == OutputUpdate) {
 369                 // counters are local to the caption
 370                 cnts.saveLastCounter();
 371         }
 372         // Memorize type for addToToc().
 373         floattype_ = type;
 374         if (type.empty())
 375                 full_label_ = master.B_("Senseless!!! ");
 376         else {
 377                 // FIXME: life would be _much_ simpler if listings was
 378                 // listed in Floating.
 379                 docstring name;
 380                 if (type == "listing")
 381                         name = master.B_("Listing");
 382                 else
 383                         name = master.B_(tclass.floats().getType(type).name());
 384                 docstring counter = from_utf8(type);
 385                 if (cnts.isSubfloat()) {
 386                         // only standard captions allowed in subfloats
 387                         type_ = "Standard";
 388                         counter = "sub-" + from_utf8(type);
 389                         name = bformat(_("Sub-%1$s"),
 390                                        master.B_(tclass.floats().getType(type).name()));
 391                 }
 392                 docstring sec;
 393                 docstring const lstring = getLayout().labelstring();
 394                 docstring const labelstring = isAscii(lstring) ?
 395                                 master.B_(to_ascii(lstring)) : lstring;
 396                 if (cnts.hasCounter(counter)) {
 397                         // for longtables, we step the counter upstream
 398                         if (!cnts.isLongtable())
 399                                 cnts.step(counter, utype);
 400                         sec = cnts.theCounter(counter, lang);
 401                 }
 402                 if (labelstring != master.B_("standard")) {
 403                         if (!sec.empty())
 404                                 sec += from_ascii(" ");
 405                         sec += bformat(from_ascii("(%1$s)"), labelstring);
 406                 }
 407                 if (!sec.empty())
 408                         full_label_ = bformat(from_ascii("%1$s %2$s:"), name, sec);
 409                 else
 410                         full_label_ = bformat(from_ascii("%1$s #:"), name);
 411         }
 412
 413         // Do the real work now.
 414         InsetText::updateBuffer(it, utype);
 415         if (utype == OutputUpdate)
 416                 cnts.restoreLastCounter();
 417 }
 418
 419
 420 string InsetCaption::contextMenuName() const
 421 {
 422         return "context-caption";
 423 }
 424
 425
 426 } // namespace lyx