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 "BranchList.h"
  18 #include "Cursor.h"
  19 #include "DispatchResult.h"
  20 #include "FuncRequest.h"
  21 #include "FuncStatus.h"
  22 #include "gettext.h"
  23 #include "Color.h"
  24 #include "Lexer.h"
  25 #include "Paragraph.h"
  26 #include "OutputParams.h"
  27
  28 #include <sstream>
  29
  30
  31 namespace lyx {
  32
  33 using std::string;
  34 using std::auto_ptr;
  35 using std::istringstream;
  36 using std::ostream;
  37 using std::ostringstream;
  38
  39
  40 void InsetBranch::init()
  41 {
  42         setButtonLabel();
  43 }
  44
  45
  46 InsetBranch::InsetBranch(BufferParams const & bp,
  47                          InsetBranchParams const & params)
  48         : InsetCollapsable(bp), params_(params)
  49 {
  50         init();
  51 }
  52
  53
  54 InsetBranch::InsetBranch(InsetBranch const & in)
  55         : InsetCollapsable(in), params_(in.params_)
  56 {
  57         init();
  58 }
  59
  60
  61 InsetBranch::~InsetBranch()
  62 {
  63         InsetBranchMailer(*this).hideDialog();
  64 }
  65
  66
  67 auto_ptr<Inset> InsetBranch::doClone() const
  68 {
  69         return auto_ptr<Inset>(new InsetBranch(*this));
  70 }
  71
  72
  73 docstring const InsetBranch::editMessage() const
  74 {
  75         return _("Opened Branch Inset");
  76 }
  77
  78
  79 void InsetBranch::write(Buffer const & buf, ostream & os) const
  80 {
  81         params_.write(os);
  82         InsetCollapsable::write(buf, os);
  83 }
  84
  85
  86 void InsetBranch::read(Buffer const & buf, Lexer & lex)
  87 {
  88         params_.read(lex);
  89         InsetCollapsable::read(buf, lex);
  90         setButtonLabel();
  91 }
  92
  93
  94 void InsetBranch::setButtonLabel()
  95 {
  96         Font font(Font::ALL_SANE);
  97         font.decSize();
  98         font.decSize();
  99
 100         docstring s = _("Branch: ") + params_.branch;
 101         font.setColor(Color::foreground);
 102         if (!params_.branch.empty()) {
 103                 // FIXME UNICODE
 104                 Color_color c = lcolor.getFromLyXName(to_utf8(params_.branch));
 105                 if (c == Color::none) {
 106                         c = Color::error;
 107                         s = _("Undef: ") + s;
 108                 }
 109                 setBackgroundColor(c);
 110         } else
 111                 setBackgroundColor(Color::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(Cursor & cur, FuncRequest & cmd)
 125 {
 126         switch (cmd.action) {
 127         case LFUN_INSET_MODIFY: {
 128                 InsetBranchParams params;
 129                 InsetBranchMailer::string2params(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(Cursor & 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, odocstream & os,
 225                        OutputParams const & runparams) const
 226 {
 227         return isBranchSelected(buf) ?
 228                 InsetText::latex(buf, os, runparams) : 0;
 229 }
 230
 231
 232 int InsetBranch::plaintext(Buffer const & buf, odocstream & os,
 233                            OutputParams const & runparams) const
 234 {
 235         if (!isBranchSelected(buf))
 236                 return 0;
 237
 238         os << '[' << buf.B_("branch") << ' ' << params_.branch << ":\n";
 239         InsetText::plaintext(buf, os, runparams);
 240         os << "\n]";
 241
 242         return PLAINTEXT_NEWLINE + 1; // one char on a separate line
 243 }
 244
 245
 246 int InsetBranch::docbook(Buffer const & buf, odocstream & os,
 247                          OutputParams const & runparams) const
 248 {
 249         return isBranchSelected(buf) ?
 250                 InsetText::docbook(buf, os, runparams) : 0;
 251 }
 252
 253
 254 void InsetBranch::textString(Buffer const & buf, odocstream & os) const
 255 {
 256         if (isBranchSelected(buf))
 257                 os << paragraphs().begin()->asString(buf, true);
 258 }
 259
 260
 261 void InsetBranch::validate(LaTeXFeatures & features) const
 262 {
 263         InsetText::validate(features);
 264 }
 265
 266
 267
 268 string const InsetBranchMailer::name_("branch");
 269
 270 InsetBranchMailer::InsetBranchMailer(InsetBranch & inset)
 271         : inset_(inset)
 272 {}
 273
 274
 275 string const InsetBranchMailer::inset2string(Buffer const &) const
 276 {
 277         return params2string(inset_.params());
 278 }
 279
 280
 281 string const InsetBranchMailer::params2string(InsetBranchParams const & params)
 282 {
 283         ostringstream data;
 284         data << name_ << ' ';
 285         params.write(data);
 286         return data.str();
 287 }
 288
 289
 290 void InsetBranchMailer::string2params(string const & in,
 291                                       InsetBranchParams & params)
 292 {
 293         params = InsetBranchParams();
 294         if (in.empty())
 295                 return;
 296
 297         istringstream data(in);
 298         Lexer lex(0,0);
 299         lex.setStream(data);
 300
 301         string name;
 302         lex >> name;
 303         if (name != name_)
 304                 return print_mailer_error("InsetBranchMailer", in, 1, name_);
 305
 306         // This is part of the inset proper that is usually swallowed
 307         // by Text::readInset
 308         string id;
 309         lex >> id;
 310         if (!lex || id != "Branch")
 311                 return print_mailer_error("InsetBranchMailer", in, 2, "Branch");
 312
 313         params.read(lex);
 314 }
 315
 316
 317 void InsetBranchParams::write(ostream & os) const
 318 {
 319         os << "Branch " << to_utf8(branch) << '\n';
 320 }
 321
 322
 323 void InsetBranchParams::read(Lexer & lex)
 324 {
 325         lex >> branch;
 326 }
 327
 328 } // namespace lyx