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 "Counters.h"
  21 #include "Cursor.h"
  22 #include "DispatchResult.h"
  23 #include "FuncRequest.h"
  24 #include "FuncStatus.h"
  25 #include "Lexer.h"
  26 #include "LyX.h"
  27 #include "OutputParams.h"
  28 #include "output_xhtml.h"
  29 #include "TextClass.h"
  30 #include "TocBackend.h"
  31
  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         if (decoration() == InsetLayout::MINIMALISTIC)
 116                 return symb + params_.branch;
 117
 118         docstring s;
 119         if (inmaster && inchild)
 120                 s = _("Branch: ");
 121         else if (inchild) // && !inmaster
 122                 s = _("Branch (child): ");
 123         else if (inmaster) // && !inchild
 124                 s = _("Branch (master): ");
 125         else // !inmaster && !inchild
 126                 s = _("Branch (undefined): ");
 127         s += params_.branch;
 128
 129         return symb + s;
 130 }
 131
 132
 133 ColorCode InsetBranch::backgroundColor(PainterInfo const & pi) const
 134 {
 135         if (params_.branch.empty())
 136                 return Inset::backgroundColor(pi);
 137         // FIXME UNICODE
 138         ColorCode c = lcolor.getFromLyXName(to_utf8(params_.branch));
 139         if (c == Color_none)
 140                 c = Color_error;
 141         return c;
 142 }
 143
 144
 145 void InsetBranch::doDispatch(Cursor & cur, FuncRequest & cmd)
 146 {
 147         switch (cmd.action()) {
 148         case LFUN_INSET_MODIFY: {
 149                 InsetBranchParams params;
 150                 InsetBranch::string2params(to_utf8(cmd.argument()), params);
 151
 152                 cur.recordUndoInset(this);
 153                 params_.branch = params.branch;
 154                 params_.inverted = params.inverted;
 155                 // what we really want here is a TOC update, but that means
 156                 // a full buffer update
 157                 cur.forceBufferUpdate();
 158                 break;
 159         }
 160         case LFUN_BRANCH_ACTIVATE:
 161         case LFUN_BRANCH_DEACTIVATE:
 162         case LFUN_BRANCH_MASTER_ACTIVATE:
 163         case LFUN_BRANCH_MASTER_DEACTIVATE: {
 164                 bool const master = (cmd.action() == LFUN_BRANCH_MASTER_ACTIVATE
 165                                      || cmd.action() == LFUN_BRANCH_MASTER_DEACTIVATE);
 166                 Buffer * buf = master ? const_cast<Buffer *>(buffer().masterBuffer())
 167                                       : &buffer();
 168
 169                 Branch * our_branch = buf->params().branchlist().find(params_.branch);
 170                 if (!our_branch)
 171                         break;
 172
 173                 bool const activate = (cmd.action() == LFUN_BRANCH_ACTIVATE
 174                                        || cmd.action() == LFUN_BRANCH_MASTER_ACTIVATE);
 175                 if (our_branch->isSelected() != activate) {
 176                         // FIXME If the branch is in the master document, we cannot
 177                         // call recordUndo..., because the master may be hidden, and
 178                         // the code presently assumes that hidden documents can never
 179                         // be dirty. See GuiView::closeBufferAll(), for example.
 180                         // An option would be to check if the master is hidden.
 181                         // If it is, unhide.
 182                         if (!master)
 183                                 buffer().undo().recordUndoBufferParams(cur);
 184                         else
 185                                 // at least issue a warning for now (ugly, but better than dataloss).
 186                                 frontend::Alert::warning(_("Branch state changes in master document"),
 187                                     lyx::support::bformat(_("The state of the branch '%1$s' "
 188                                         "was changed in the master file. "
 189                                         "Please make sure to save the master."), params_.branch), true);
 190                         our_branch->setSelected(activate);
 191                         // cur.forceBufferUpdate() is not enough
 192                         buf->updateBuffer();
 193                 }
 194                 break;
 195         }
 196         case LFUN_BRANCH_INVERT:
 197                 cur.recordUndoInset(this);
 198                 params_.inverted = !params_.inverted;
 199                 // what we really want here is a TOC update, but that means
 200                 // a full buffer update
 201                 cur.forceBufferUpdate();
 202                 break;
 203         case LFUN_BRANCH_ADD:
 204                 lyx::dispatch(FuncRequest(LFUN_BRANCH_ADD, params_.branch));
 205                 break;
 206         case LFUN_INSET_TOGGLE:
 207                 if (cmd.argument() == "assign")
 208                         setStatus(cur, isBranchSelected() ? Open : Collapsed);
 209                 else
 210                         InsetCollapsible::doDispatch(cur, cmd);
 211                 break;
 212
 213         default:
 214                 InsetCollapsible::doDispatch(cur, cmd);
 215                 break;
 216         }
 217 }
 218
 219
 220 bool InsetBranch::getStatus(Cursor & cur, FuncRequest const & cmd,
 221                 FuncStatus & flag) const
 222 {
 223         bool const known_branch =
 224                 buffer().params().branchlist().find(params_.branch);
 225
 226         switch (cmd.action()) {
 227         case LFUN_INSET_MODIFY:
 228                 flag.setEnabled(true);
 229                 break;
 230
 231         case LFUN_BRANCH_ACTIVATE:
 232                 flag.setEnabled(known_branch && !isBranchSelected(true));
 233                 break;
 234
 235         case LFUN_BRANCH_INVERT:
 236                 flag.setEnabled(true);
 237                 flag.setOnOff(params_.inverted);
 238                 break;
 239
 240         case LFUN_BRANCH_ADD:
 241                 flag.setEnabled(!known_branch);
 242                 break;
 243
 244         case LFUN_BRANCH_DEACTIVATE:
 245                 flag.setEnabled(isBranchSelected(true));
 246                 break;
 247
 248         case LFUN_BRANCH_MASTER_ACTIVATE:
 249                 flag.setEnabled(buffer().parent()
 250                                 && buffer().masterBuffer()->params().branchlist().find(params_.branch)
 251                                 && !isBranchSelected());
 252                 break;
 253
 254         case LFUN_BRANCH_MASTER_DEACTIVATE:
 255                 flag.setEnabled(buffer().parent() && isBranchSelected());
 256                 break;
 257
 258         case LFUN_INSET_TOGGLE:
 259                 if (cmd.argument() == "assign")
 260                         flag.setEnabled(true);
 261                 else
 262                         return InsetCollapsible::getStatus(cur, cmd, flag);
 263                 break;
 264
 265         default:
 266                 return InsetCollapsible::getStatus(cur, cmd, flag);
 267         }
 268         return true;
 269 }
 270
 271
 272 bool InsetBranch::isBranchSelected(bool const child) const
 273 {
 274         Buffer const & realbuffer = child ? buffer() : *buffer().masterBuffer();
 275         BranchList const & branchlist = realbuffer.params().branchlist();
 276         Branch const * ourBranch = branchlist.find(params_.branch);
 277
 278         if (!ourBranch) {
 279                 // this branch is defined in child only
 280                 ourBranch = buffer().params().branchlist().find(params_.branch);
 281                 if (!ourBranch)
 282                         return false;
 283         }
 284         return ourBranch->isSelected();
 285 }
 286
 287
 288 bool InsetBranch::producesOutput() const
 289 {
 290         return isBranchSelected() != params_.inverted;
 291 }
 292
 293
 294 void InsetBranch::latex(otexstream & os, OutputParams const & runparams) const
 295 {
 296         if (producesOutput()) {
 297                 OutputParams rp = runparams;
 298                 rp.inbranch = true;
 299                 InsetText::latex(os, rp);
 300         }
 301 }
 302
 303
 304 int InsetBranch::plaintext(odocstringstream & os,
 305                            OutputParams const & runparams, size_t max_length) const
 306 {
 307         if (!producesOutput())
 308                 return 0;
 309
 310         int len = InsetText::plaintext(os, runparams, max_length);
 311         return len;
 312 }
 313
 314
 315 int InsetBranch::docbook(odocstream & os,
 316                          OutputParams const & runparams) const
 317 {
 318         return producesOutput() ?  InsetText::docbook(os, runparams) : 0;
 319 }
 320
 321
 322 docstring InsetBranch::xhtml(XHTMLStream & xs, OutputParams const & rp) const
 323 {
 324         if (producesOutput()) {
 325                 OutputParams newrp = rp;
 326                 newrp.par_begin = 0;
 327                 newrp.par_end = text().paragraphs().size();
 328                 xhtmlParagraphs(text(), buffer(), xs, newrp);
 329         }
 330         return docstring();
 331 }
 332
 333
 334 void InsetBranch::toString(odocstream & os) const
 335 {
 336         if (producesOutput())
 337                 InsetCollapsible::toString(os);
 338 }
 339
 340
 341 void InsetBranch::forOutliner(docstring & os, size_t const maxlen,
 342                                                           bool const shorten) const
 343 {
 344         if (producesOutput())
 345                 InsetCollapsible::forOutliner(os, maxlen, shorten);
 346 }
 347
 348
 349 void InsetBranch::validate(LaTeXFeatures & features) const
 350 {
 351         if (producesOutput())
 352                 InsetCollapsible::validate(features);
 353 }
 354
 355
 356 string InsetBranch::contextMenuName() const
 357 {
 358         return "context-branch";
 359 }
 360
 361
 362 bool InsetBranch::isMacroScope() const
 363 {
 364         // Its own scope if not selected by buffer
 365         return !producesOutput();
 366 }
 367
 368
 369 string InsetBranch::params2string(InsetBranchParams const & params)
 370 {
 371         ostringstream data;
 372         params.write(data);
 373         return data.str();
 374 }
 375
 376
 377 void InsetBranch::string2params(string const & in, InsetBranchParams & params)
 378 {
 379         params = InsetBranchParams();
 380         if (in.empty())
 381                 return;
 382
 383         istringstream data(in);
 384         Lexer lex;
 385         lex.setStream(data);
 386         lex.setContext("InsetBranch::string2params");
 387         params.read(lex);
 388 }
 389
 390
 391 void InsetBranch::updateBuffer(ParIterator const & it, UpdateType utype)
 392 {
 393         setLabel(params_.branch + (params_.inverted ? " (-)" : ""));
 394         InsetCollapsible::updateBuffer(it, utype);
 395 }
 396
 397
 398 void InsetBranchParams::write(ostream & os) const
 399 {
 400         os << to_utf8(branch)
 401            << '\n'
 402            << "inverted "
 403            << inverted;
 404 }
 405
 406
 407 void InsetBranchParams::read(Lexer & lex)
 408 {
 409         // There may be a space in branch name
 410         // if we wanted to use lex>>, the branch name should be properly in quotes
 411         lex.eatLine();
 412         branch = lex.getDocString();
 413         lex >> "inverted" >> inverted;
 414 }
 415
 416 } // namespace lyx