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