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         if (!params_.branch.empty()) {
  88                 // FIXME UNICODE
  89                 ColorCode c = lcolor.getFromLyXName(to_utf8(params_.branch));
  90                 if (c == Color_none)
  91                         s = _("Undef: ") + s;
  92         }
  93         if (decoration() == InsetLayout::CLASSIC)
  94                 return isOpen(bv) ? s : getNewLabel(s);
  95         else
  96                 return params_.branch + ": " + getNewLabel(s);
  97 }
  98
  99
 100 ColorCode InsetBranch::backgroundColor() const
 101 {
 102         if (params_.branch.empty())
 103                 return Inset::backgroundColor();
 104         // FIXME UNICODE
 105         ColorCode c = lcolor.getFromLyXName(to_utf8(params_.branch));
 106         if (c == Color_none)
 107                 c = Color_error;
 108         return c;
 109 }
 110
 111
 112 bool InsetBranch::showInsetDialog(BufferView * bv) const
 113 {
 114         bv->showDialog("branch", params2string(params()),
 115                         const_cast<InsetBranch *>(this));
 116         return true;
 117 }
 118
 119
 120 void InsetBranch::doDispatch(Cursor & cur, FuncRequest & cmd)
 121 {
 122         switch (cmd.action) {
 123         case LFUN_INSET_MODIFY: {
 124                 InsetBranchParams params;
 125                 InsetBranch::string2params(to_utf8(cmd.argument()), params);
 126                 params_.branch = params.branch;
 127                 setLayout(cur.buffer()->params());
 128                 break;
 129         }
 130
 131         case LFUN_MOUSE_PRESS:
 132                 if (cmd.button() != mouse_button::button3)
 133                         InsetCollapsable::doDispatch(cur, cmd);
 134                 else
 135                         cur.undispatched();
 136                 break;
 137
 138         case LFUN_INSET_DIALOG_UPDATE:
 139                 cur.bv().updateDialog("branch", params2string(params()));
 140                 break;
 141
 142         case LFUN_INSET_TOGGLE:
 143                 if (cmd.argument() == "assign") {
 144                         // The branch inset uses "assign".
 145                         if (isBranchSelected()) {
 146                                 if (status(cur.bv()) != Open)
 147                                         setStatus(cur, Open);
 148                                 else
 149                                         cur.undispatched();
 150                         } else {
 151                                 if (status(cur.bv()) != Collapsed)
 152                                         setStatus(cur, Collapsed);
 153                                 else
 154                                         cur.undispatched();
 155                         }
 156                 }
 157                 else
 158                         InsetCollapsable::doDispatch(cur, cmd);
 159                 break;
 160
 161         default:
 162                 InsetCollapsable::doDispatch(cur, cmd);
 163                 break;
 164         }
 165 }
 166
 167
 168 bool InsetBranch::getStatus(Cursor & cur, FuncRequest const & cmd,
 169                 FuncStatus & flag) const
 170 {
 171         switch (cmd.action) {
 172         case LFUN_INSET_MODIFY:
 173         case LFUN_INSET_DIALOG_UPDATE:
 174                 flag.setEnabled(true);
 175                 break;
 176
 177         case LFUN_INSET_TOGGLE:
 178                 if (cmd.argument() == "open")
 179                         flag.setEnabled(status_ != Open);
 180                 else if (cmd.argument() == "close")
 181                         flag.setEnabled(status_ == Open);
 182                 else if (cmd.argument() == "toggle")
 183                         flag.setEnabled(true);
 184                 else if (cmd.argument() == "assign" || cmd.argument().empty()) {
 185                         if (isBranchSelected())
 186                                 flag.setEnabled(status(cur.bv()) != Open);
 187                         else
 188                                 flag.setEnabled(status(cur.bv()) != Collapsed);
 189                 } else
 190                         flag.setEnabled(true);
 191                 break;
 192
 193         default:
 194                 return InsetCollapsable::getStatus(cur, cmd, flag);
 195         }
 196         return true;
 197 }
 198
 199
 200 bool InsetBranch::isBranchSelected() const
 201 {
 202         Buffer const & realbuffer = *buffer().masterBuffer();
 203         BranchList const & branchlist = realbuffer.params().branchlist();
 204         Branch const * ourBranch = branchlist.find(params_.branch);
 205         if (!ourBranch)
 206                 return false;
 207         return ourBranch->isSelected();
 208 }
 209
 210
 211 int InsetBranch::latex(odocstream & os, OutputParams const & runparams) const
 212 {
 213         return isBranchSelected() ?  InsetText::latex(os, runparams) : 0;
 214 }
 215
 216
 217 int InsetBranch::plaintext(odocstream & os,
 218                            OutputParams const & runparams) const
 219 {
 220         if (!isBranchSelected())
 221                 return 0;
 222
 223         os << '[' << buffer().B_("branch") << ' ' << params_.branch << ":\n";
 224         InsetText::plaintext(os, runparams);
 225         os << "\n]";
 226
 227         return PLAINTEXT_NEWLINE + 1; // one char on a separate line
 228 }
 229
 230
 231 int InsetBranch::docbook(odocstream & os,
 232                          OutputParams const & runparams) const
 233 {
 234         return isBranchSelected() ?  InsetText::docbook(os, runparams) : 0;
 235 }
 236
 237
 238 void InsetBranch::tocString(odocstream & os) const
 239 {
 240         if (isBranchSelected())
 241                 InsetCollapsable::tocString(os);
 242 }
 243
 244
 245 void InsetBranch::validate(LaTeXFeatures & features) const
 246 {
 247         if (isBranchSelected())
 248                 InsetCollapsable::validate(features);
 249 }
 250
 251
 252 bool InsetBranch::isMacroScope() const
 253 {
 254         // Its own scope if not selected by buffer
 255         return !isBranchSelected();
 256 }
 257
 258
 259 string InsetBranch::params2string(InsetBranchParams const & params)
 260 {
 261         ostringstream data;
 262         data << "branch" << ' ';
 263         params.write(data);
 264         return data.str();
 265 }
 266
 267
 268 void InsetBranch::string2params(string const & in, InsetBranchParams & params)
 269 {
 270         params = InsetBranchParams();
 271         if (in.empty())
 272                 return;
 273
 274         istringstream data(in);
 275         Lexer lex;
 276         lex.setStream(data);
 277         lex.setContext("InsetBranch::string2params");
 278         lex >> "branch" >> "Branch";
 279         params.read(lex);
 280 }
 281
 282
 283 void InsetBranch::addToToc(DocIterator const & cpit)
 284 {
 285         DocIterator pit = cpit;
 286         pit.push_back(CursorSlice(*this));
 287
 288         Toc & toc = buffer().tocBackend().toc("branch");
 289         docstring const str = params_.branch + ": " + text().getPar(0).asString();
 290         toc.push_back(TocItem(pit, 0, str));
 291         // Proceed with the rest of the inset.
 292         InsetCollapsable::addToToc(cpit);
 293 }
 294
 295
 296 void InsetBranchParams::write(ostream & os) const
 297 {
 298         os << "Branch " << to_utf8(branch) << '\n';
 299 }
 300
 301
 302 void InsetBranchParams::read(Lexer & lex)
 303 {
 304         lex.eatLine();
 305         branch = lex.getDocString();
 306 }
 307
 308 } // namespace lyx