src/ToolbarBackend.cpp

   1 /**
   2  * \file ToolbarBackend.cpp
   3  * This file is part of LyX, the document processor.
   4  * Licence details can be found in the file COPYING.
   5  *
   6  * \author Jean-Marc Lasgouttes
   7  * \author John Levon
   8  *
   9  * Full author contact details are available in file CREDITS.
  10  */
  11
  12 #include <config.h>
  13
  14 #include "ToolbarBackend.h"
  15 #include "FuncRequest.h"
  16 #include "Lexer.h"
  17 #include "LyXAction.h"
  18 #include "support/lstrings.h"
  19
  20 #include "support/debug.h"
  21 #include "support/gettext.h"
  22
  23 #include <boost/bind.hpp>
  24
  25 #include <algorithm>
  26
  27 using namespace std;
  28 using namespace lyx::support;
  29
  30 namespace lyx {
  31
  32 namespace {
  33
  34 class ToolbarNamesEqual
  35 {
  36 public:
  37         ToolbarNamesEqual(string const & name) : name_(name) {}
  38         bool operator()(ToolbarInfo const & tbinfo) const
  39         {
  40                 return tbinfo.name == name_;
  41         }
  42 private:
  43         string name_;
  44 };
  45
  46 } // namespace anon
  47
  48
  49 ToolbarBackend toolbarbackend;
  50
  51
  52 ToolbarItem::ToolbarItem(Type type, FuncRequest const & func, docstring const & label)
  53         : type_(type), func_(func), label_(label)
  54 {
  55 }
  56
  57
  58 ToolbarItem::ToolbarItem(Type type, string const & name, docstring const & label)
  59         : type_(type), label_(label), name_(name)
  60 {
  61 }
  62
  63
  64 ToolbarItem::~ToolbarItem()
  65 {}
  66
  67
  68 void ToolbarInfo::add(ToolbarItem const & item)
  69 {
  70         items.push_back(item);
  71         items.back().func_.origin = FuncRequest::TOOLBAR;
  72 }
  73
  74
  75 ToolbarInfo & ToolbarInfo::read(Lexer & lex)
  76 {
  77         enum tooltags {
  78                 TO_COMMAND = 1,
  79                 TO_ENDTOOLBAR,
  80                 TO_SEPARATOR,
  81                 TO_LAYOUTS,
  82                 TO_MINIBUFFER,
  83                 TO_TABLEINSERT,
  84                 TO_POPUPMENU,
  85                 TO_ICONPALETTE,
  86                 TO_LAST
  87         };
  88
  89         struct keyword_item toolTags[TO_LAST - 1] = {
  90                 { "end", TO_ENDTOOLBAR },
  91                 { "iconpalette", TO_ICONPALETTE },
  92                 { "item", TO_COMMAND },
  93                 { "layouts", TO_LAYOUTS },
  94                 { "minibuffer", TO_MINIBUFFER },
  95                 { "popupmenu", TO_POPUPMENU },
  96                 { "separator", TO_SEPARATOR },
  97                 { "tableinsert", TO_TABLEINSERT }
  98         };
  99
 100         //consistency check
 101         if (compare_ascii_no_case(lex.getString(), "toolbar")) {
 102                 LYXERR0("ToolbarInfo::read: ERROR wrong token:`"
 103                        << lex.getString() << '\'');
 104         }
 105
 106         lex.next(true);
 107         name = lex.getString();
 108
 109         lex.next(true);
 110         gui_name = lex.getString();
 111
 112         // FIXME what to do here?
 113         if (!lex) {
 114                 LYXERR0("ToolbarInfo::read: Malformed toolbar "
 115                         "description " <<  lex.getString());
 116                 return *this;
 117         }
 118
 119         bool quit = false;
 120
 121         lex.pushTable(toolTags, TO_LAST - 1);
 122
 123         if (lyxerr.debugging(Debug::PARSER))
 124                 lex.printTable(lyxerr);
 125
 126         while (lex.isOK() && !quit) {
 127                 switch (lex.lex()) {
 128                 case TO_COMMAND:
 129                         if (lex.next(true)) {
 130                                 docstring const tooltip = translateIfPossible(lex.getDocString());
 131                                 lex.next(true);
 132                                 string const func_arg = lex.getString();
 133                                 LYXERR(Debug::PARSER, "ToolbarInfo::read TO_COMMAND func: `"
 134                                         << func_arg << '\'');
 135
 136                                 FuncRequest func =
 137                                         lyxaction.lookupFunc(func_arg);
 138                                 add(ToolbarItem(ToolbarItem::COMMAND, func, tooltip));
 139                         }
 140                         break;
 141
 142                 case TO_MINIBUFFER:
 143                         add(ToolbarItem(ToolbarItem::MINIBUFFER,
 144                                 FuncRequest(kb_action(ToolbarItem::MINIBUFFER))));
 145                         break;
 146
 147                 case TO_SEPARATOR:
 148                         add(ToolbarItem(ToolbarItem::SEPARATOR,
 149                                 FuncRequest(kb_action(ToolbarItem::SEPARATOR))));
 150                         break;
 151
 152                 case TO_POPUPMENU:
 153                         if (lex.next(true)) {
 154                                 string const name = lex.getString();
 155                                 lex.next(true);
 156                                 docstring const label = lex.getDocString();
 157                                 add(ToolbarItem(ToolbarItem::POPUPMENU, name, label));
 158                         }
 159                         break;
 160
 161                 case TO_ICONPALETTE:
 162                         if (lex.next(true)) {
 163                                 string const name = lex.getString();
 164                                 lex.next(true);
 165                                 docstring const label = lex.getDocString();
 166                                 add(ToolbarItem(ToolbarItem::ICONPALETTE, name, label));
 167                         }
 168                         break;
 169
 170                 case TO_LAYOUTS:
 171                         add(ToolbarItem(ToolbarItem::LAYOUTS,
 172                                 FuncRequest(kb_action(ToolbarItem::LAYOUTS))));
 173                         break;
 174
 175                 case TO_TABLEINSERT:
 176                         if (lex.next(true)) {
 177                                 docstring const tooltip = lex.getDocString();
 178                                 add(ToolbarItem(ToolbarItem::TABLEINSERT,
 179                                         FuncRequest(kb_action(ToolbarItem::TABLEINSERT)), tooltip));
 180                         }
 181                         break;
 182
 183                 case TO_ENDTOOLBAR:
 184                         quit = true;
 185                         break;
 186
 187                 default:
 188                         lex.printError("ToolbarInfo::read: "
 189                                        "Unknown toolbar tag: `$$Token'");
 190                         break;
 191                 }
 192         }
 193
 194         lex.popTable();
 195         return *this;
 196 }
 197
 198
 199
 200
 201 ToolbarBackend::ToolbarBackend()
 202 {
 203 }
 204
 205
 206 void ToolbarBackend::readToolbars(Lexer & lex)
 207 {
 208         enum tooltags {
 209                 TO_TOOLBAR = 1,
 210                 TO_ENDTOOLBARSET,
 211                 TO_LAST
 212         };
 213
 214         struct keyword_item toolTags[TO_LAST - 1] = {
 215                 { "end", TO_ENDTOOLBARSET },
 216                 { "toolbar", TO_TOOLBAR }
 217         };
 218
 219         //consistency check
 220         if (compare_ascii_no_case(lex.getString(), "toolbarset")) {
 221                 LYXERR0("ToolbarBackend::readToolbars: ERROR wrong token:`"
 222                        << lex.getString() << '\'');
 223         }
 224
 225         lex.pushTable(toolTags, TO_LAST - 1);
 226
 227         if (lyxerr.debugging(Debug::PARSER))
 228                 lex.printTable(lyxerr);
 229
 230         bool quit = false;
 231         while (lex.isOK() && !quit) {
 232                 switch (lex.lex()) {
 233                 case TO_TOOLBAR: {
 234                         ToolbarInfo tbinfo;
 235                         tbinfo.read(lex);
 236                         toolbars.push_back(tbinfo);
 237                         break;
 238                         }
 239                 case TO_ENDTOOLBARSET:
 240                         quit = true;
 241                         break;
 242                 default:
 243                         lex.printError("ToolbarBackend::readToolbars: "
 244                                        "Unknown toolbar tag: `$$Token'");
 245                         break;
 246                 }
 247         }
 248
 249         lex.popTable();
 250 }
 251
 252
 253 void ToolbarBackend::readToolbarSettings(Lexer & lex)
 254 {
 255         //consistency check
 256         if (compare_ascii_no_case(lex.getString(), "toolbars")) {
 257                 LYXERR0("ToolbarBackend::readToolbarSettings: ERROR wrong token:`"
 258                        << lex.getString() << '\'');
 259         }
 260
 261         lex.next(true);
 262
 263         while (lex.isOK()) {
 264                 string name = lex.getString();
 265                 lex.next(true);
 266
 267                 if (!compare_ascii_no_case(name, "end"))
 268                         return;
 269
 270                 Toolbars::iterator tcit = toolbars.begin();
 271                 Toolbars::iterator tend = toolbars.end();
 272                 for (; tcit != tend; ++tcit) {
 273                         if (tcit->name == name)
 274                                 break;
 275                 }
 276
 277                 if (tcit == tend) {
 278                         LYXERR0("ToolbarBackend: undefined toolbar " << name);
 279                         return;
 280                 }
 281
 282                 tcit->flags = static_cast<ToolbarInfo::Flags>(0);
 283                 string flagstr = lex.getString();
 284                 lex.next(true);
 285                 vector<string> flags = getVectorFromString(flagstr);
 286
 287                 vector<string>::const_iterator cit = flags.begin();
 288                 vector<string>::const_iterator end = flags.end();
 289
 290                 for (; cit != end; ++cit) {
 291                         int flag = 0;
 292                         if (!compare_ascii_no_case(*cit, "off"))
 293                                 flag = ToolbarInfo::OFF;
 294                         else if (!compare_ascii_no_case(*cit, "on"))
 295                                 flag = ToolbarInfo::ON;
 296                         else if (!compare_ascii_no_case(*cit, "math"))
 297                                 flag = ToolbarInfo::MATH;
 298                         else if (!compare_ascii_no_case(*cit, "table"))
 299                                 flag = ToolbarInfo::TABLE;
 300                         else if (!compare_ascii_no_case(*cit, "mathmacrotemplate"))
 301                                 flag = ToolbarInfo::MATHMACROTEMPLATE;
 302                         else if (!compare_ascii_no_case(*cit, "review"))
 303                                 flag = ToolbarInfo::REVIEW;
 304                         else if (!compare_ascii_no_case(*cit, "top"))
 305                                 flag = ToolbarInfo::TOP;
 306                         else if (!compare_ascii_no_case(*cit, "bottom"))
 307                                 flag = ToolbarInfo::BOTTOM;
 308                         else if (!compare_ascii_no_case(*cit, "left"))
 309                                 flag = ToolbarInfo::LEFT;
 310                         else if (!compare_ascii_no_case(*cit, "right"))
 311                                 flag = ToolbarInfo::RIGHT;
 312                         else if (!compare_ascii_no_case(*cit, "auto"))
 313                                 flag = ToolbarInfo::AUTO;
 314                         else {
 315                                 LYXERR(Debug::ANY,
 316                                         "ToolbarBackend::readToolbarSettings: unrecognised token:`"
 317                                         << *cit << '\'');
 318                         }
 319                         tcit->flags = static_cast<ToolbarInfo::Flags>(tcit->flags | flag);
 320                 }
 321
 322                 usedtoolbars.push_back(*tcit);
 323         }
 324 }
 325
 326
 327 ToolbarInfo const * ToolbarBackend::getDefinedToolbarInfo(string const & name) const
 328 {
 329         Toolbars::const_iterator it = find_if(toolbars.begin(), toolbars.end(), ToolbarNamesEqual(name));
 330         if (it == toolbars.end())
 331                 return 0;
 332         return &(*it);
 333 }
 334
 335
 336 ToolbarInfo * ToolbarBackend::getUsedToolbarInfo(string const &name)
 337 {
 338         Toolbars::iterator it = find_if(usedtoolbars.begin(), usedtoolbars.end(), ToolbarNamesEqual(name));
 339         if (it == usedtoolbars.end())
 340                 return 0;
 341         return &(*it);
 342 }
 343
 344 } // namespace lyx