src/insets/InsetBranch.cpp

   1 /**
   2  * \file InsetBranch.cpp
   3  * This file is part of LyX, the document processor.
   4  * Licence details can be found in the file COPYING.
   5  *
   6  * \author Martin Vermeer
   7  *
   8  * Full author contact details are available in file CREDITS.
   9  */
  10
  11 #include <config.h>
  12
  13 #include "InsetBranch.h"
  14
  15 #include "Buffer.h"
  16 #include "BufferParams.h"
  17 #include "BufferView.h"
  18 #include "BranchList.h"
  19 #include "ColorSet.h"
  20 #include "Cursor.h"
  21 #include "DispatchResult.h"
  22 #include "FuncRequest.h"
  23 #include "FuncStatus.h"
  24 #include "Lexer.h"
  25 #include "LyX.h"
  26 #include "output_docbook.h"
  27 #include "output_xhtml.h"
  28 #include "TextClass.h"
  29 #include "TocBackend.h"
  30
  31 #include "support/convert.h"
  32 #include "support/debug.h"
  33 #include "support/gettext.h"
  34 #include "support/lstrings.h"
  35
  36 #include "frontends/alert.h"
  37 #include "frontends/Application.h"
  38
  39 #include <sstream>
  40
  41 using namespace std;
  42
  43
  44 namespace lyx {
  45
  46 InsetBranch::InsetBranch(Buffer * buf, InsetBranchParams const & params)
  47         : InsetCollapsible(buf, InsetText::DefaultLayout), params_(params)
  48 {}
  49
  50
  51 void InsetBranch::write(ostream & os) const
  52 {
  53         os << "Branch ";
  54         params_.write(os);
  55         os << '\n';
  56         InsetCollapsible::write(os);
  57 }
  58
  59
  60 void InsetBranch::read(Lexer & lex)
  61 {
  62         params_.read(lex);
  63         InsetCollapsible::read(lex);
  64 }
  65
  66
  67 docstring InsetBranch::toolTip(BufferView const & bv, int, int) const
  68 {
  69         docstring const masterstatus = isBranchSelected() ?
  70                 _("active") : _("non-active");
  71         docstring const childstatus = isBranchSelected(true) ?
  72                 _("active") : _("non-active");
  73         docstring const status = (masterstatus == childstatus) ?
  74                 masterstatus :
  75                 support::bformat(_("master %1$s, child %2$s"),
  76                                                  masterstatus, childstatus);
  77
  78         docstring const masteron = producesOutput() ?
  79                 _("on") : _("off");
  80         docstring const childon =
  81                 (isBranchSelected(true) != params_.inverted) ?
  82                         _("on") : _("off");
  83         docstring const onoff = (masteron == childon) ?
  84                 masteron :
  85                 support::bformat(_("master %1$s, child %2$s"),
  86                                                  masteron, childon);
  87
  88         docstring const heading =
  89                 support::bformat(_("Branch Name: %1$s\nBranch Status: %2$s\nInset Status: %3$s"),
  90                                                  params_.branch, status, onoff);
  91
  92         if (isOpen(bv))
  93                 return heading;
  94         return toolTipText(heading + from_ascii("\n"));
  95 }
  96
  97
  98 docstring const InsetBranch::buttonLabel(BufferView const &) const
  99 {
 100         static char_type const tick = 0x2714; // ✔ U+2714 HEAVY CHECK MARK
 101         static char_type const cross = 0x2716; // ✖ U+2716 HEAVY MULTIPLICATION X
 102
 103         Buffer const & realbuffer = *buffer().masterBuffer();
 104         BranchList const & branchlist = realbuffer.params().branchlist();
 105         bool const inmaster = branchlist.find(params_.branch);
 106         bool const inchild = buffer().params().branchlist().find(params_.branch);
 107
 108         bool const master_selected = producesOutput();
 109         bool const child_selected = isBranchSelected(true) != params_.inverted;
 110
 111         docstring symb = docstring(1, master_selected ? tick : cross);
 112         if (inchild && master_selected != child_selected)
 113                 symb += (child_selected ? tick : cross);
 114
 115     docstring inv_symb = from_ascii(params_.inverted ? "~" : "");
 116
 117         if (decoration() == InsetDecoration::MINIMALISTIC)
 118                 return symb + inv_symb + params_.branch;
 119
 120         docstring s;
 121         if (inmaster && inchild)
 122                 s = _("Branch: ");
 123         else if (inchild) // && !inmaster
 124                 s = _("Branch (child): ");
 125         else if (inmaster) // && !inchild
 126                 s = _("Branch (master): ");
 127         else // !inmaster && !inchild
 128                 s = _("Branch (undefined): ");
 129         s += inv_symb + params_.branch;
 130
 131         return symb + s;
 132 }
 133
 134
 135 ColorCode InsetBranch::backgroundColor(PainterInfo const & pi) const
 136 {
 137         if (params_.branch.empty())
 138                 return Inset::backgroundColor(pi);
 139         // FIXME UNICODE
 140         string const branchcol = "branch" + convert<string>(buffer().params().branchlist().id())
 141                         + to_utf8(params_.branch);
 142         ColorCode c = lcolor.getFromLyXName(branchcol);
 143         if (c == Color_none)
 144                 c = Color_error;
 145         return c;
 146 }
 147
 148
 149 void InsetBranch::doDispatch(Cursor & cur, FuncRequest & cmd)
 150 {
 151         switch (cmd.action()) {
 152         case LFUN_INSET_MODIFY: {
 153                 InsetBranchParams params;
 154                 InsetBranch::string2params(to_utf8(cmd.argument()), params);
 155
 156                 cur.recordUndoInset(this);
 157                 params_.branch = params.branch;
 158                 params_.inverted = params.inverted;
 159                 // what we really want here is a TOC update, but that means
 160                 // a full buffer update
 161                 cur.forceBufferUpdate();
 162                 break;
 163         }
 164         case LFUN_BRANCH_ACTIVATE:
 165         case LFUN_BRANCH_DEACTIVATE:
 166         case LFUN_BRANCH_MASTER_ACTIVATE:
 167         case LFUN_BRANCH_MASTER_DEACTIVATE: {
 168                 bool const master = (cmd.action() == LFUN_BRANCH_MASTER_ACTIVATE
 169                                      || cmd.action() == LFUN_BRANCH_MASTER_DEACTIVATE);
 170                 Buffer * buf = master ? const_cast<Buffer *>(buffer().masterBuffer())
 171                                       : &buffer();
 172
 173                 Branch * our_branch = buf->params().branchlist().find(params_.branch);
 174                 if (!our_branch)
 175                         break;
 176
 177                 bool const activate = (cmd.action() == LFUN_BRANCH_ACTIVATE
 178                                        || cmd.action() == LFUN_BRANCH_MASTER_ACTIVATE);
 179                 if (our_branch->isSelected() != activate) {
 180                         // FIXME If the branch is in the master document, we cannot
 181                         // call recordUndo..., because the master may be hidden, and
 182                         // the code presently assumes that hidden documents can never
 183                         // be dirty. See GuiView::closeBufferAll(), for example.
 184                         // An option would be to check if the master is hidden.
 185                         // If it is, unhide.
 186                         if (!master)
 187                                 buffer().undo().recordUndoBufferParams(cur);
 188                         else
 189                                 // at least issue a warning for now (ugly, but better than dataloss).
 190                                 frontend::Alert::warning(_("Branch state changes in master document"),
 191                                     lyx::support::bformat(_("The state of the branch '%1$s' "
 192                                         "was changed in the master file. "
 193                                         "Please make sure to save the master."), params_.branch), true);
 194                         our_branch->setSelected(activate);
 195                         // cur.forceBufferUpdate() is not enough
 196                         buf->updateBuffer();
 197                 }
 198
 199                 // if branch exists in a descendant, update previews.
 200                 // TODO: only needed if "Show preview" is enabled in the included inset.
 201                 bool exists_in_desc = false;
 202                 for (auto const & it : buf->getDescendants()) {
 203                         if (it->params().branchlist().find(params_.branch))
 204                                 exists_in_desc = true;
 205                 }
 206                 if (exists_in_desc) {
 207                         // TODO: ideally we would only update the previews of the
 208                         // specific children that have this branch directly or
 209                         // in one of their descendants
 210                         buf->removePreviews();
 211                         buf->updatePreviews();
 212                 }
 213                 break;
 214         }
 215         case LFUN_BRANCH_INVERT:
 216                 cur.recordUndoInset(this);
 217                 params_.inverted = !params_.inverted;
 218                 // what we really want here is a TOC update, but that means
 219                 // a full buffer update
 220                 cur.forceBufferUpdate();
 221                 break;
 222         case LFUN_BRANCH_ADD:
 223                 lyx::dispatch(FuncRequest(LFUN_BRANCH_ADD, params_.branch));
 224                 break;
 225         case LFUN_INSET_TOGGLE:
 226                 if (cmd.argument() == "assign")
 227                         setStatus(cur, isBranchSelected() ? Open : Collapsed);
 228                 else
 229                         InsetCollapsible::doDispatch(cur, cmd);
 230                 break;
 231
 232         default:
 233                 InsetCollapsible::doDispatch(cur, cmd);
 234                 break;
 235         }
 236 }
 237
 238
 239 bool InsetBranch::getStatus(Cursor & cur, FuncRequest const & cmd,
 240                 FuncStatus & flag) const
 241 {
 242         bool const known_branch =
 243                 buffer().params().branchlist().find(params_.branch);
 244
 245         switch (cmd.action()) {
 246         case LFUN_INSET_MODIFY:
 247                 flag.setEnabled(true);
 248                 break;
 249
 250         case LFUN_BRANCH_ACTIVATE:
 251                 flag.setEnabled(known_branch && !isBranchSelected(true));
 252                 break;
 253
 254         case LFUN_BRANCH_INVERT:
 255                 flag.setEnabled(true);
 256                 flag.setOnOff(params_.inverted);
 257                 break;
 258
 259         case LFUN_BRANCH_ADD:
 260                 flag.setEnabled(!known_branch);
 261                 break;
 262
 263         case LFUN_BRANCH_DEACTIVATE:
 264                 flag.setEnabled(isBranchSelected(true));
 265                 break;
 266
 267         case LFUN_BRANCH_MASTER_ACTIVATE:
 268                 flag.setEnabled(buffer().parent()
 269                                 && buffer().masterBuffer()->params().branchlist().find(params_.branch)
 270                                 && !isBranchSelected());
 271                 break;
 272
 273         case LFUN_BRANCH_MASTER_DEACTIVATE:
 274                 flag.setEnabled(buffer().parent() && isBranchSelected());
 275                 break;
 276
 277         case LFUN_INSET_TOGGLE:
 278                 if (cmd.argument() == "assign")
 279                         flag.setEnabled(true);
 280                 else
 281                         return InsetCollapsible::getStatus(cur, cmd, flag);
 282                 break;
 283
 284         default:
 285                 return InsetCollapsible::getStatus(cur, cmd, flag);
 286         }
 287         return true;
 288 }
 289
 290
 291 bool InsetBranch::isBranchSelected(bool const child) const
 292 {
 293         Buffer const & realbuffer = child ? buffer() : *buffer().masterBuffer();
 294         BranchList const & branchlist = realbuffer.params().branchlist();
 295         Branch const * ourBranch = branchlist.find(params_.branch);
 296
 297         if (!ourBranch) {
 298                 // this branch is defined in child only
 299                 ourBranch = buffer().params().branchlist().find(params_.branch);
 300                 if (!ourBranch)
 301                         return false;
 302         }
 303         return ourBranch->isSelected();
 304 }
 305
 306
 307 bool InsetBranch::producesOutput() const
 308 {
 309         return isBranchSelected() != params_.inverted;
 310 }
 311
 312
 313 void InsetBranch::latex(otexstream & os, OutputParams const & runparams) const
 314 {
 315         if (producesOutput()) {
 316                 OutputParams rp = runparams;
 317                 rp.inbranch = true;
 318                 InsetText::latex(os, rp);
 319                 // These need to be passed upstream
 320                 runparams.need_maketitle = rp.need_maketitle;
 321                 runparams.have_maketitle = rp.have_maketitle;
 322         }
 323 }
 324
 325
 326 int InsetBranch::plaintext(odocstringstream & os,
 327                            OutputParams const & runparams, size_t max_length) const
 328 {
 329         if (!producesOutput())
 330                 return 0;
 331
 332         int len = InsetText::plaintext(os, runparams, max_length);
 333         return len;
 334 }
 335
 336
 337 void InsetBranch::docbook(XMLStream & xs, OutputParams const & runparams) const
 338 {
 339         if (producesOutput()) {
 340                 OutputParams rp = runparams;
 341                 rp.par_begin = 0;
 342                 rp.par_end = text().paragraphs().size();
 343                 docbookParagraphs(text(), buffer(), xs, rp);
 344         }
 345 }
 346
 347
 348 docstring InsetBranch::xhtml(XMLStream & xs, OutputParams const & rp) const
 349 {
 350         if (producesOutput()) {
 351                 OutputParams newrp = rp;
 352                 newrp.par_begin = 0;
 353                 newrp.par_end = text().paragraphs().size();
 354                 xhtmlParagraphs(text(), buffer(), xs, newrp);
 355         }
 356         return docstring();
 357 }
 358
 359
 360 void InsetBranch::toString(odocstream & os) const
 361 {
 362         if (producesOutput())
 363                 InsetCollapsible::toString(os);
 364 }
 365
 366
 367 void InsetBranch::forOutliner(docstring & os, size_t const maxlen,
 368                                                           bool const shorten) const
 369 {
 370         if (producesOutput())
 371                 InsetCollapsible::forOutliner(os, maxlen, shorten);
 372 }
 373
 374
 375 void InsetBranch::validate(LaTeXFeatures & features) const
 376 {
 377         if (producesOutput())
 378                 InsetCollapsible::validate(features);
 379 }
 380
 381
 382 string InsetBranch::contextMenuName() const
 383 {
 384         return "context-branch";
 385 }
 386
 387
 388 bool InsetBranch::isMacroScope() const
 389 {
 390         // Its own scope if not selected by buffer
 391         return !producesOutput();
 392 }
 393
 394
 395 string InsetBranch::params2string(InsetBranchParams const & params)
 396 {
 397         ostringstream data;
 398         params.write(data);
 399         return data.str();
 400 }
 401
 402
 403 void InsetBranch::string2params(string const & in, InsetBranchParams & params)
 404 {
 405         params = InsetBranchParams();
 406         if (in.empty())
 407                 return;
 408
 409         istringstream data(in);
 410         Lexer lex;
 411         lex.setStream(data);
 412         lex.setContext("InsetBranch::string2params");
 413         params.read(lex);
 414 }
 415
 416
 417 void InsetBranch::updateBuffer(ParIterator const & it, UpdateType utype, bool const deleted)
 418 {
 419         setLabel(params_.branch + (params_.inverted ? " (-)" : ""));
 420         InsetCollapsible::updateBuffer(it, utype, deleted);
 421 }
 422
 423
 424 void InsetBranchParams::write(ostream & os) const
 425 {
 426         os << to_utf8(branch)
 427            << '\n'
 428            << "inverted "
 429            << inverted;
 430 }
 431
 432
 433 void InsetBranchParams::read(Lexer & lex)
 434 {
 435         // There may be a space in branch name
 436         // if we wanted to use lex>>, the branch name should be properly in quotes
 437         lex.eatLine();
 438         branch = lex.getDocString();
 439         lex >> "inverted" >> inverted;
 440 }
 441
 442 } // namespace lyx