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 "OutputParams.h"
  27 #include "TextClass.h"
  28 #include "TocBackend.h"
  29
  30 #include "support/debug.h"
  31 #include "support/gettext.h"
  32 #include "support/lstrings.h"
  33
  34 #include "frontends/Application.h"
  35
  36 #include <sstream>
  37
  38 using namespace std;
  39
  40
  41 namespace lyx {
  42
  43 InsetBranch::InsetBranch(Buffer const & buf, InsetBranchParams const & params)
  44         : InsetCollapsable(buf, InsetText::DefaultLayout), params_(params)
  45 {}
  46
  47
  48 InsetBranch::~InsetBranch()
  49 {
  50         hideDialogs("branch", this);
  51 }
  52
  53
  54 docstring InsetBranch::editMessage() const
  55 {
  56         return _("Opened Branch Inset");
  57 }
  58
  59
  60 void InsetBranch::write(ostream & os) const
  61 {
  62         params_.write(os);
  63         InsetCollapsable::write(os);
  64 }
  65
  66
  67 void InsetBranch::read(Lexer & lex)
  68 {
  69         params_.read(lex);
  70         InsetCollapsable::read(lex);
  71 }
  72
  73
  74 docstring InsetBranch::toolTip(BufferView const & bv, int x, int y) const
  75 {
  76         docstring const status = isBranchSelected() ?
  77                 _("active") : _("non-active");
  78         docstring const heading =
  79                 support::bformat(_("Branch (%1$s): %2$s"), status, params_.branch);
  80         docstring const contents = InsetCollapsable::toolTip(bv, x, y);
  81         if (isOpen(bv) || contents.empty())
  82                 return heading;
  83         else
  84                 return heading + from_ascii("\n") + contents;
  85 }
  86
  87
  88 docstring const InsetBranch::buttonLabel(BufferView const & bv) const
  89 {
  90         docstring s = _("Branch: ") + params_.branch;
  91         Buffer const & realbuffer = *buffer().masterBuffer();
  92         BranchList const & branchlist = realbuffer.params().branchlist();
  93         if (!branchlist.find(params_.branch)
  94             && buffer().params().branchlist().find(params_.branch))
  95                 s = _("Branch (child only): ") + params_.branch;
  96         else if (!branchlist.find(params_.branch))
  97                 s = _("Branch (undefined): ") + params_.branch;
  98         if (!params_.branch.empty()) {
  99                 // FIXME UNICODE
 100                 ColorCode c = lcolor.getFromLyXName(to_utf8(params_.branch));
 101                 if (c == Color_none)
 102                         s = _("Undef: ") + s;
 103         }
 104         s = char_type(isBranchSelected() ? 0x2714 : 0x2716) + s;
 105         if (decoration() == InsetLayout::CLASSIC)
 106                 return isOpen(bv) ? s : getNewLabel(s);
 107         else
 108                 return params_.branch + ": " + getNewLabel(s);
 109 }
 110
 111
 112 ColorCode InsetBranch::backgroundColor() const
 113 {
 114         if (params_.branch.empty())
 115                 return Inset::backgroundColor();
 116         // FIXME UNICODE
 117         ColorCode c = lcolor.getFromLyXName(to_utf8(params_.branch));
 118         if (c == Color_none)
 119                 c = Color_error;
 120         return c;
 121 }
 122
 123
 124 bool InsetBranch::showInsetDialog(BufferView * bv) const
 125 {
 126         bv->showDialog("branch", params2string(params()),
 127                         const_cast<InsetBranch *>(this));
 128         return true;
 129 }
 130
 131
 132 void InsetBranch::doDispatch(Cursor & cur, FuncRequest & cmd)
 133 {
 134         switch (cmd.action) {
 135         case LFUN_INSET_MODIFY: {
 136                 InsetBranchParams params;
 137                 InsetBranch::string2params(to_utf8(cmd.argument()), params);
 138                 params_.branch = params.branch;
 139                 setLayout();
 140                 break;
 141         }
 142
 143         case LFUN_INSET_DIALOG_UPDATE:
 144                 cur.bv().updateDialog("branch", params2string(params()));
 145                 break;
 146
 147         case LFUN_BRANCH_ACTIVATE:
 148         case LFUN_BRANCH_DEACTIVATE: {
 149                 // FIXME: I do not like this cast, but have no other idea...
 150                 Buffer const * buf = buffer().masterBuffer();
 151                 BranchList const & branchlist = buf->params().branchlist();
 152                 Branch * our_branch = const_cast<Branch *>(branchlist.find(params_.branch));
 153                 if (!our_branch) {
 154                         // child only?
 155                         our_branch = buffer().params().branchlist().find(params_.branch);
 156                         if (!our_branch)
 157                                 break;
 158                 }
 159                 our_branch->setSelected(cmd.action == LFUN_BRANCH_ACTIVATE);
 160                 break;
 161         }
 162
 163         case LFUN_INSET_TOGGLE:
 164                 if (cmd.argument() == "assign")
 165                         setStatus(cur, isBranchSelected() ? Open : Collapsed);
 166                 else
 167                         InsetCollapsable::doDispatch(cur, cmd);
 168                 break;
 169
 170         default:
 171                 InsetCollapsable::doDispatch(cur, cmd);
 172                 break;
 173         }
 174 }
 175
 176
 177 bool InsetBranch::getStatus(Cursor & cur, FuncRequest const & cmd,
 178                 FuncStatus & flag) const
 179 {
 180         switch (cmd.action) {
 181         case LFUN_INSET_MODIFY:
 182         case LFUN_INSET_DIALOG_UPDATE:
 183                 flag.setEnabled(true);
 184                 break;
 185
 186         case LFUN_BRANCH_ACTIVATE:
 187                 flag.setEnabled(!isBranchSelected());
 188                 break;
 189
 190         case LFUN_BRANCH_DEACTIVATE:
 191                 flag.setEnabled(isBranchSelected());
 192                 break;
 193
 194         case LFUN_INSET_TOGGLE:
 195                 if (cmd.argument() == "assign")
 196                         flag.setEnabled(true);
 197                 else
 198                         return InsetCollapsable::getStatus(cur, cmd, flag);
 199
 200         default:
 201                 return InsetCollapsable::getStatus(cur, cmd, flag);
 202         }
 203         return true;
 204 }
 205
 206
 207 bool InsetBranch::isBranchSelected() const
 208 {
 209         Buffer const & realbuffer = *buffer().masterBuffer();
 210         BranchList const & branchlist = realbuffer.params().branchlist();
 211         Branch const * ourBranch = branchlist.find(params_.branch);
 212
 213         if (!ourBranch) {
 214                 // this branch is defined in child only
 215                 ourBranch = buffer().params().branchlist().find(params_.branch);
 216                 if (!ourBranch)
 217                         return false;
 218         }
 219         return ourBranch->isSelected();
 220 }
 221
 222
 223 int InsetBranch::latex(odocstream & os, OutputParams const & runparams) const
 224 {
 225         return isBranchSelected() ?  InsetText::latex(os, runparams) : 0;
 226 }
 227
 228
 229 int InsetBranch::plaintext(odocstream & os,
 230                            OutputParams const & runparams) const
 231 {
 232         if (!isBranchSelected())
 233                 return 0;
 234
 235         os << '[' << buffer().B_("branch") << ' ' << params_.branch << ":\n";
 236         InsetText::plaintext(os, runparams);
 237         os << "\n]";
 238
 239         return PLAINTEXT_NEWLINE + 1; // one char on a separate line
 240 }
 241
 242
 243 int InsetBranch::docbook(odocstream & os,
 244                          OutputParams const & runparams) const
 245 {
 246         return isBranchSelected() ?  InsetText::docbook(os, runparams) : 0;
 247 }
 248
 249
 250 docstring InsetBranch::xhtml(odocstream & os, OutputParams const & rp) const
 251 {
 252         if (isBranchSelected())
 253                  return InsetText::xhtml(os, rp);
 254         return docstring();
 255 }
 256
 257
 258 void InsetBranch::tocString(odocstream & os) const
 259 {
 260         if (isBranchSelected())
 261                 InsetCollapsable::tocString(os);
 262 }
 263
 264
 265 void InsetBranch::validate(LaTeXFeatures & features) const
 266 {
 267         if (isBranchSelected())
 268                 InsetCollapsable::validate(features);
 269 }
 270
 271
 272 docstring InsetBranch::contextMenu(BufferView const &, int, int) const
 273 {
 274         return from_ascii("context-branch");
 275 }
 276
 277
 278 bool InsetBranch::isMacroScope() const
 279 {
 280         // Its own scope if not selected by buffer
 281         return !isBranchSelected();
 282 }
 283
 284
 285 string InsetBranch::params2string(InsetBranchParams const & params)
 286 {
 287         ostringstream data;
 288         data << "branch" << ' ';
 289         params.write(data);
 290         return data.str();
 291 }
 292
 293
 294 void InsetBranch::string2params(string const & in, InsetBranchParams & params)
 295 {
 296         params = InsetBranchParams();
 297         if (in.empty())
 298                 return;
 299
 300         istringstream data(in);
 301         Lexer lex;
 302         lex.setStream(data);
 303         lex.setContext("InsetBranch::string2params");
 304         lex >> "branch" >> "Branch";
 305         params.read(lex);
 306 }
 307
 308
 309 void InsetBranch::addToToc(DocIterator const & cpit)
 310 {
 311         DocIterator pit = cpit;
 312         pit.push_back(CursorSlice(*this));
 313
 314         Toc & toc = buffer().tocBackend().toc("branch");
 315         docstring const str = params_.branch + ": " + text().getPar(0).asString();
 316         toc.push_back(TocItem(pit, 0, str));
 317         // Proceed with the rest of the inset.
 318         InsetCollapsable::addToToc(cpit);
 319 }
 320
 321
 322 void InsetBranchParams::write(ostream & os) const
 323 {
 324         os << "Branch " << to_utf8(branch) << '\n';
 325 }
 326
 327
 328 void InsetBranchParams::read(Lexer & lex)
 329 {
 330         lex.eatLine();
 331         branch = lex.getDocString();
 332 }
 333
 334 } // namespace lyx