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