src/insets/insetbranch.C

   1 /**
   2  * \file insetbranch.C
   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 "BranchList.h"
  18 #include "cursor.h"
  19 #include "dispatchresult.h"
  20 #include "funcrequest.h"
  21 #include "FuncStatus.h"
  22 #include "gettext.h"
  23 #include "LColor.h"
  24 #include "lyxlex.h"
  25 #include "paragraph.h"
  26
  27 #include <sstream>
  28
  29 using std::string;
  30 using std::auto_ptr;
  31 using std::istringstream;
  32 using std::ostream;
  33 using std::ostringstream;
  34
  35
  36 void InsetBranch::init()
  37 {
  38         setInsetName("Branch");
  39         setButtonLabel();
  40 }
  41
  42
  43 InsetBranch::InsetBranch(BufferParams const & bp,
  44                          InsetBranchParams const & params)
  45         : InsetCollapsable(bp), params_(params)
  46 {
  47         init();
  48 }
  49
  50
  51 InsetBranch::InsetBranch(InsetBranch const & in)
  52         : InsetCollapsable(in), params_(in.params_)
  53 {
  54         init();
  55 }
  56
  57
  58 InsetBranch::~InsetBranch()
  59 {
  60         InsetBranchMailer(*this).hideDialog();
  61 }
  62
  63
  64 auto_ptr<InsetBase> InsetBranch::doClone() const
  65 {
  66         return auto_ptr<InsetBase>(new InsetBranch(*this));
  67 }
  68
  69
  70 string const InsetBranch::editMessage() const
  71 {
  72         return _("Opened Branch Inset");
  73 }
  74
  75
  76 void InsetBranch::write(Buffer const & buf, ostream & os) const
  77 {
  78         params_.write(os);
  79         InsetCollapsable::write(buf, os);
  80 }
  81
  82
  83 void InsetBranch::read(Buffer const & buf, LyXLex & lex)
  84 {
  85         params_.read(lex);
  86         InsetCollapsable::read(buf, lex);
  87         setButtonLabel();
  88 }
  89
  90
  91 void InsetBranch::setButtonLabel()
  92 {
  93         LyXFont font(LyXFont::ALL_SANE);
  94         font.decSize();
  95         font.decSize();
  96
  97         string s = _("Branch: ") + params_.branch;
  98         setLabel(isOpen() ? s : getNewLabel(s) );
  99         font.setColor(LColor::foreground);
 100         if (!params_.branch.empty())
 101                 setBackgroundColor(lcolor.getFromLyXName(params_.branch));
 102         else
 103                 setBackgroundColor(LColor::background);
 104         setLabelFont(font);
 105 }
 106
 107
 108 bool InsetBranch::showInsetDialog(BufferView * bv) const
 109 {
 110         InsetBranchMailer(const_cast<InsetBranch &>(*this)).showDialog(bv);
 111         return true;
 112 }
 113
 114
 115 void InsetBranch::doDispatch(LCursor & cur, FuncRequest & cmd)
 116 {
 117         switch (cmd.action) {
 118         case LFUN_INSET_MODIFY: {
 119                 InsetBranchParams params;
 120                 InsetBranchMailer::string2params(cmd.argument, params);
 121                 params_.branch = params.branch;
 122                 setButtonLabel();
 123                 break;
 124         }
 125
 126         case LFUN_MOUSE_PRESS:
 127                 if (cmd.button() != mouse_button::button3)
 128                         InsetCollapsable::doDispatch(cur, cmd);
 129                 else
 130                         cur.undispatched();
 131                 break;
 132
 133         case LFUN_INSET_DIALOG_UPDATE:
 134                 InsetBranchMailer(*this).updateDialog(&cur.bv());
 135                 break;
 136
 137         case LFUN_MOUSE_RELEASE:
 138                 if (cmd.button() == mouse_button::button3 && hitButton(cmd))
 139                         InsetBranchMailer(*this).showDialog(&cur.bv());
 140                 else
 141                         InsetCollapsable::doDispatch(cur, cmd);
 142                 break;
 143
 144
 145         case LFUN_INSET_TOGGLE:
 146                 if (cmd.argument == "assign" || cmd.argument.empty()) {
 147                         // The branch inset uses "assign".
 148                         BranchList const & branchlist =
 149                                 cur.buffer().params().branchlist();
 150                         if (isBranchSelected(branchlist)) {
 151                                 if (status() != Open)
 152                                         setStatus(cur, Open);
 153                                 else
 154                                         cur.undispatched();
 155                         } else {
 156                                 if (status() != Collapsed)
 157                                         setStatus(cur, Collapsed);
 158                                 else
 159                                         cur.undispatched();
 160                         }
 161                 }
 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(LCursor & 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.enabled(true);
 180                 break;
 181
 182         case LFUN_INSET_TOGGLE:
 183                 if (cmd.argument == "open" || cmd.argument == "close" ||
 184                     cmd.argument == "toggle")
 185                         flag.enabled(true);
 186                 else if (cmd.argument == "assign"
 187                            || cmd.argument.empty()) {
 188                         BranchList const & branchlist =
 189                                 cur.buffer().params().branchlist();
 190                         if (isBranchSelected(branchlist))
 191                                 flag.enabled(status() != Open);
 192                         else
 193                                 flag.enabled(status() != Collapsed);
 194                 } else
 195                         flag.enabled(true);
 196                 break;
 197
 198         default:
 199                 return InsetCollapsable::getStatus(cur, cmd, flag);
 200         }
 201         return true;
 202 }
 203
 204
 205 bool InsetBranch::isBranchSelected(BranchList const & branchlist) const
 206 {
 207         BranchList::const_iterator const end = branchlist.end();
 208         BranchList::const_iterator it =
 209                 std::find_if(branchlist.begin(), end,
 210                              BranchNamesEqual(params_.branch));
 211         if (it == end)
 212                 return false;
 213         return it->getSelected();
 214 }
 215
 216
 217 int InsetBranch::latex(Buffer const & buf, ostream & os,
 218                        OutputParams const & runparams) const
 219 {
 220         return isBranchSelected(buf.params().branchlist()) ?
 221                 InsetText::latex(buf, os, runparams) : 0;
 222 }
 223
 224
 225 int InsetBranch::linuxdoc(Buffer const & buf, std::ostream & os,
 226                           OutputParams const & runparams) const
 227 {
 228         return isBranchSelected(buf.params().branchlist()) ?
 229                 InsetText::linuxdoc(buf, os, runparams) : 0;
 230 }
 231
 232
 233 int InsetBranch::docbook(Buffer const & buf, std::ostream & os,
 234                          OutputParams const & runparams) const
 235 {
 236         return isBranchSelected(buf.params().branchlist()) ?
 237                 InsetText::docbook(buf, os, runparams) : 0;
 238 }
 239
 240
 241 int InsetBranch::plaintext(Buffer const & buf, std::ostream & os,
 242                            OutputParams const & runparams) const
 243 {
 244         return isBranchSelected(buf.params().branchlist()) ?
 245                 InsetText::plaintext(buf, os, runparams): 0;
 246 }
 247
 248
 249 void InsetBranch::validate(LaTeXFeatures & features) const
 250 {
 251         InsetText::validate(features);
 252 }
 253
 254
 255
 256 string const InsetBranchMailer::name_("branch");
 257
 258 InsetBranchMailer::InsetBranchMailer(InsetBranch & inset)
 259         : inset_(inset)
 260 {}
 261
 262
 263 string const InsetBranchMailer::inset2string(Buffer const &) const
 264 {
 265         return params2string(inset_.params());
 266 }
 267
 268
 269 string const InsetBranchMailer::params2string(InsetBranchParams const & params)
 270 {
 271         ostringstream data;
 272         data << name_ << ' ';
 273         params.write(data);
 274         return data.str();
 275 }
 276
 277
 278 void InsetBranchMailer::string2params(string const & in,
 279                                       InsetBranchParams & params)
 280 {
 281         params = InsetBranchParams();
 282         if (in.empty())
 283                 return;
 284
 285         istringstream data(in);
 286         LyXLex lex(0,0);
 287         lex.setStream(data);
 288
 289         string name;
 290         lex >> name;
 291         if (name != name_)
 292                 return print_mailer_error("InsetBranchMailer", in, 1, name_);
 293
 294         // This is part of the inset proper that is usually swallowed
 295         // by LyXText::readInset
 296         string id;
 297         lex >> id;
 298         if (!lex || id != "Branch")
 299                 return print_mailer_error("InsetBranchMailer", in, 2, "Branch");
 300
 301         params.read(lex);
 302 }
 303
 304
 305 void InsetBranchParams::write(ostream & os) const
 306 {
 307         os << "Branch " << branch << '\n';
 308 }
 309
 310
 311 void InsetBranchParams::read(LyXLex & lex)
 312 {
 313         lex >> branch;
 314 }