aboutsummaryrefslogtreecommitdiff
path: root/src/MenuCreator.cc
blob: 515650562136b3b3213cd7bcccb0e95d433df2b1 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
// MenuCreator.cc for Fluxbox
// Copyright (c) 2004-2008 Henrik Kinnunen (fluxgen at fluxbox dot org)
//                and Simon Bowden    (rathnor at users.sourceforge.net)
//
// Permission is hereby granted, free of charge, to any person obtaining a
// copy of this software and associated documentation files (the "Software"),
// to deal in the Software without restriction, including without limitation
// the rights to use, copy, modify, merge, publish, distribute, sublicense,
// and/or sell copies of the Software, and to permit persons to whom the
// Software is furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
// THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
// DEALINGS IN THE SOFTWARE.

#include "MenuCreator.hh"

#include "defaults.hh"
#include "Screen.hh"
#include "FbTk/CommandParser.hh"
#include "fluxbox.hh"
#include "Window.hh"
#include "WindowCmd.hh"
#include "CurrentWindowCmd.hh"
#include "WindowMenuAccessor.hh"

#include "ClientMenu.hh"
#include "FbCommands.hh"
#include "WorkspaceMenu.hh"
#include "LayerMenu.hh"
#include "SendToMenu.hh"
#include "AlphaMenu.hh"
#include "Layer.hh"

#include "StyleMenuItem.hh"
#include "RootCmdMenuItem.hh"

#include "FbTk/I18n.hh"
#include "FbTk/LuaUtil.hh"
#include "FbTk/MultiButtonMenuItem.hh"
#include "FbTk/BoolMenuItem.hh"
#include "FbTk/RefCount.hh"
#include "FbTk/MacroCommand.hh"
#include "FbTk/SimpleCommand.hh"
#include "FbTk/StringUtil.hh"
#include "FbTk/FileUtil.hh"
#include "FbTk/MenuSeparator.hh"
#include "FbTk/Transparent.hh"

#include <iostream>
#include <algorithm>

using std::cerr;
using std::endl;
using std::string;
using std::vector;
using std::list;
using std::less;
using FbTk::AutoReloadHelper;

namespace {

typedef FbTk::RefCount<FbTk::Menu> RefMenu;
typedef FbTk::RefCount<FbTk::Command<void> > RefCmd;

void createStyleMenu(FbTk::Menu &menu, AutoReloadHelper *reloader, const string &directory) {

    // perform shell style ~ home directory expansion
    string stylesdir(FbTk::StringUtil::expandFilename(directory));

    if (!FbTk::FileUtil::isDirectory(stylesdir.c_str()))
        return;

    if (reloader)
        reloader->addFile(stylesdir);

    FbTk::Directory dir(stylesdir.c_str());

    // create a vector of all the filenames in the directory
    // and sort it
    vector<string> filelist(dir.entries());
    for (size_t file_index = 0; file_index < dir.entries(); ++file_index)
        filelist[file_index] = dir.readFilename();

    sort(filelist.begin(), filelist.end(), less<string>());

    // for each file in directory add filename and path to menu
    for (size_t file_index = 0; file_index < dir.entries(); file_index++) {
        string style(stylesdir + '/' + filelist[file_index]);
        // add to menu only if the file is a regular file, and not a
        // .file or a backup~ file
        if ((FbTk::FileUtil::isRegularFile(style.c_str()) &&
             (filelist[file_index][0] != '.') &&
             (style[style.length() - 1] != '~')) ||
            FbTk::FileUtil::isRegularFile((style + "/theme.cfg").c_str()) ||
            FbTk::FileUtil::isRegularFile((style + "/style.cfg").c_str()))
            menu.insert(new StyleMenuItem(filelist[file_index], style));
    }
    // update menu graphics
    menu.updateMenu();
}

void createRootCmdMenu(FbTk::Menu &menu, const string &directory, AutoReloadHelper *reloader,
                       const string &cmd) {

    // perform shell style ~ home directory expansion
    string rootcmddir(FbTk::StringUtil::expandFilename(directory));

    if (!FbTk::FileUtil::isDirectory(rootcmddir.c_str()))
        return;

    if (reloader)
        reloader->addFile(rootcmddir);

    FbTk::Directory dir(rootcmddir.c_str());

    // create a vector of all the filenames in the directory
    // add sort it
    vector<string> filelist(dir.entries());
    for (size_t file_index = 0; file_index < dir.entries(); ++file_index)
        filelist[file_index] = dir.readFilename();

    sort(filelist.begin(), filelist.end(), less<string>());

    // for each file in directory add filename and path to menu
    for (size_t file_index = 0; file_index < dir.entries(); file_index++) {

        string rootcmd(rootcmddir+ '/' + filelist[file_index]);
        // add to menu only if the file is a regular file, and not a
        // .file or a backup~ file
        if ((FbTk::FileUtil::isRegularFile(rootcmd.c_str()) &&
             (filelist[file_index][0] != '.') &&
             (rootcmd[rootcmd.length() - 1] != '~')))
            menu.insert(new RootCmdMenuItem(filelist[file_index], rootcmd, cmd));
    }
    // update menu graphics
    menu.updateMenu();
}


class MenuContext: public LayerObject {
public:
    void moveToLayer(int layer_number) {
        if (FbMenu::window() == 0)
            return;
        FbMenu::window()->moveToLayer(layer_number);
    }
    int layerNumber() const {
        if (FbMenu::window() == 0)
            return -1;
        return FbMenu::window()->layerItem().getLayerNum();
    }

};

string getField(lua::state &l, int pos, const char *field, FbTk::StringConvertor *conv = NULL) {
    lua::stack_sentry s(l);
    l.checkstack(1);
    _FB_USES_NLS;

    string val;
    l.rawgetfield(pos, field); {
        if(l.isstring(-1))
            val = l.tostring(-1);
        else if(! l.isnil(-1)) {
            fprintf(stderr, _FB_CONSOLETEXT(Menu, FieldNotString,
                        "Warning: Menu field %s is not a string", "One %s for field name.").c_str(),
                    field);
            fputs("\n", stderr);
        }
    } l.pop();
    return conv ? conv->recode(val) : val;
}

void
createMenu_(FbTk::Menu &inject_into, lua::state &l, FbTk::StringConvertor &conv,
            FbTk::AutoReloadHelper *reloader);

void
insertMenuItem(lua::state &l, FbTk::Menu &menu, FbTk::StringConvertor &parent_conv,
                FbTk::AutoReloadHelper *reloader) {
    _FB_USES_NLS;
    lua::stack_sentry s(l, -1);
    l.checkstack(1);

    if(l.type(-1) != lua::TTABLE)
        throw std::runtime_error(_FB_CONSOLETEXT(Menu, MenuNotTable, "Warning: Menu is not a lua table", "Menu is not a lua table"));

    // if menu specifies an encoding, create a convertor for it
    std::auto_ptr<FbTk::StringConvertor> my_conv;

    FbTk::StringConvertor *conv = &parent_conv;
    const string &encoding = getField(l, -1, "encoding");
    if(! encoding.empty()) {
        my_conv.reset(new FbTk::StringConvertor(FbTk::StringConvertor::ToFbString));
        conv = my_conv.get();
        conv->setSource(encoding);
    }

    const string &str_label = getField(l, -1, "label", conv);
    const string &str_key = getField(l, -1, "type");
    const FbTk::CommandParser<void> &parser = FbTk::CommandParser<void>::instance();
    int screen_number = menu.screenNumber();
    BScreen *screen = Fluxbox::instance()->findScreen(screen_number);
    size_t old_size = menu.numberOfItems();

    // first items that don't need additional parameters
    if(str_key == "separator")
        menu.insert(new FbTk::MenuSeparator());
    else if(str_key == "nop") {
        int size = menu.insert(str_label);
        menu.setItemEnabled(size-1, false);
    } else if(str_key == "icons") {
        RefMenu submenu = MenuCreator::createMenuType("iconmenu", screen_number);
        if (! submenu)
            return;
        if (str_label.empty())
            menu.insert(_FB_XTEXT(Menu, Icons, "Icons", "Iconic windows menu title"), submenu);
        else
            menu.insert(str_label, submenu);
    } else if (str_key == "exit") { // exit
        RefCmd exit_cmd(FbTk::CommandParser<void>::instance().parse("exit"));
        if (str_label.empty())
            menu.insert(_FB_XTEXT(Menu, Exit, "Exit", "Exit Command"), exit_cmd);
        else
            menu.insert(str_label, exit_cmd);
    } else if (str_key == "config") {
        menu.insert(str_label, RefMenu(screen->configMenu()) );
    } else if (str_key == "lua") {
        l.rawgetfield(-1, "param");
        menu.insert(str_label, RefCmd(new FbCommands::LuaCmd(l)) );
    } else if(str_key == "menu") {
        RefMenu t(MenuCreator::createMenu("", screen_number));
        l.pushvalue(-1);
        createMenu_(*t, l, *conv, reloader);
        menu.insert(str_label, t);
    } else {
        // items that have a parameter
        const string &str_cmd = getField(l, -1, "param");

        if(str_key == "command") {
            menu.insert(str_label, RefCmd( parser.parse(str_cmd)) );
        } else if(str_key == "exec") {
            menu.insert(str_label, RefCmd( parser.parse("exec", str_cmd)) );
        } else if(str_key == "style")
            menu.insert(new StyleMenuItem(str_label, str_cmd));
        else if (str_key == "stylesdir")
            createStyleMenu(menu, reloader, str_cmd);
        else if (str_key == "wallpapers") {
            string program = getField(l, -1, "program");
            if(program.empty())
                program = realProgramName("fbsetbg");
            createRootCmdMenu(menu, str_cmd, reloader, program);
        } else if (str_key == "workspaces") {
            menu.insert(str_label, RefMenu(screen->workspaceMenu()) );
        // finally, try window-related commands
        } else if(! MenuCreator::createWindowMenuItem(str_key, str_label, menu)) {
            // everything failed, we give up
            int size = menu.insert(_FB_XTEXT(Menu, UnknownType, "Unknown menu type: ",
                        "The text will be followed by the actual type") + str_key);
            menu.setItemEnabled(size-1, false);
        }
    }

    const string &icon = getField(l, -1, "icon");
    if(! icon.empty()) {
        while(old_size < menu.numberOfItems())
            menu.find(old_size++)->setIcon(icon, menu.screenNumber());
    }
}

void
createMenu_(FbTk::Menu &inject_into, lua::state &l, FbTk::StringConvertor &conv,
            FbTk::AutoReloadHelper *reloader) {

    lua::stack_sentry s(l, -1);
    l.checkstack(1);

    std::string title = getField(l, -1, "title", &conv);
    if(title.empty())
        title = getField(l, -1, "label", &conv);
    inject_into.setLabel(title);

    for(int i = 1; l.rawgeti(-1, i), !l.isnil(-1); ++i) {
        try {
            insertMenuItem(l, inject_into, conv, reloader);
        }
        catch(std::runtime_error &e) {
            cerr << e.what() << endl;
        }
    } l.pop();

    inject_into.updateMenu();

    l.pop();
}

} // end of anonymous namespace

void
MenuCreator::createMenu(FbTk::Menu &inject_into, lua::state &l, FbTk::AutoReloadHelper *reloader) {
    lua::stack_sentry s(l, -1);

    if(l.type(-1) != lua::TTABLE) {
        _FB_USES_NLS;
        cerr << _FB_CONSOLETEXT(Menu, MenuNotTable, "Warning: Menu is not a lua table",
                        "Menu is not a lua table") << endl;
        return;
    }

    std::auto_ptr<FbTk::StringConvertor> conv(new FbTk::StringConvertor(FbTk::StringConvertor::ToFbString));

    // if menu specifies an encoding, create a convertor for it
    const std::string &enc = getField(l, -1, "encoding");
    if(!enc.empty())
        conv->setSource(enc);

    createMenu_(inject_into, l, *conv, reloader);
}


FbMenu *MenuCreator::createMenu(const string &label, int screen_number) {
    BScreen *screen = Fluxbox::instance()->findScreen(screen_number);
    if (screen == 0)
        return 0;

    FbMenu *menu = new FbMenu(screen->menuTheme(),
                                  screen->imageControl(),
                                  *screen->layerManager().getLayer(LAYERMENU));
    if (!label.empty())
        menu->setLabel(label);

    return menu;
}

void MenuCreator::createFromFile(const string &filename,
                                 FbTk::Menu &inject_into,
                                 AutoReloadHelper *reloader) {
    string real_filename = FbTk::StringUtil::expandFilename(filename);

    lua::state &l = Fluxbox::instance()->lua();
    l.checkstack(1);
    lua::stack_sentry s(l);

    l.loadfile(real_filename.c_str());
    l.call(0, 1);
    createMenu(inject_into, l, reloader);
}

FbTk::RefCount<FbMenu> MenuCreator::createMenuType(const string &type, int screen_num) {
    FbTk::RefCount<FbMenu> menu;
    BScreen *screen = Fluxbox::instance()->findScreen(screen_num);

    if (type == "iconmenu")
        menu.reset(new ClientMenu(*screen, screen->iconList(),
                              true)); // listen to icon list changes
    else if (type == "workspacemenu")
         menu.reset(new WorkspaceMenu(*screen));

    return menu;
}

bool MenuCreator::createWindowMenuItem(const string &type,
                                       const string &label,
                                       FbTk::Menu &menu) {
    _FB_USES_NLS;

    static MenuContext context;

    if (type == "shade") {
        static WindowMenuAccessor<bool> res(&FluxboxWindow::isShaded, &FluxboxWindow::setShaded, false);
        menu.insert(new FbTk::BoolMenuItem(
                        label.empty()?_FB_XTEXT(Windowmenu, Shade, "Shade", "Shade the window"):label, 
                        res));

    } else if (type == "maximize") {
        RefCmd maximize_cmd(new WindowCmd<void>(&FluxboxWindow::maximizeFull));
        RefCmd maximize_vert_cmd(new WindowCmd<void>(&FluxboxWindow::maximizeVertical));
        RefCmd maximize_horiz_cmd(new WindowCmd<void>(&FluxboxWindow::maximizeHorizontal));
        FbTk::MultiButtonMenuItem *maximize_item =
            new FbTk::MultiButtonMenuItem(3,
                                          label.empty()?
                                          _FB_XTEXT(Windowmenu, Maximize,
                                                  "Maximize", "Maximize the window"):
                                          label);
        // create maximize item with:
        // button1: Maximize normal
        // button2: Maximize Vertical
        // button3: Maximize Horizontal
        maximize_item->setCommand(1, maximize_cmd);
        maximize_item->setCommand(2, maximize_vert_cmd);
        maximize_item->setCommand(3, maximize_horiz_cmd);
        menu.insert(maximize_item);
    } else if (type == "iconify") {
        static WindowMenuAccessor<bool> res(&FluxboxWindow::isIconic, &FluxboxWindow::setIconic, false);
        menu.insert(new FbTk::BoolMenuItem(
                        label.empty() ?
                        _FB_XTEXT(Windowmenu, Iconify,
                                  "Iconify", "Iconify the window") :
                        label, res));
    } else if (type == "close") {
        RefCmd close_cmd(new WindowCmd<void>(&FluxboxWindow::close));
        menu.insert(label.empty() ?
                    _FB_XTEXT(Windowmenu, Close,
                              "Close", "Close the window") :
                    label, close_cmd);
    } else if (type == "kill" || type == "killwindow") {
        RefCmd kill_cmd(new WindowCmd<void>(&FluxboxWindow::kill));
        menu.insert(label.empty() ?
                    _FB_XTEXT(Windowmenu, Kill,
                              "Kill", "Kill the window"):
                    label, kill_cmd);
    } else if (type == "lower") {
        RefCmd lower_cmd(new WindowCmd<void>(&FluxboxWindow::lower));
        menu.insert( label.empty() ?
                     _FB_XTEXT(Windowmenu, Lower,
                               "Lower", "Lower the window"):
                     label, lower_cmd);
    } else if (type == "raise") {
        RefCmd raise_cmd(new WindowCmd<void>(&FluxboxWindow::raise));
        menu.insert(label.empty() ?
                    _FB_XTEXT(Windowmenu, Raise,
                              "Raise", "Raise the window"):
                    label, raise_cmd);

    } else if (type == "stick") {
        static WindowMenuAccessor<bool> res(&FluxboxWindow::isStuck, &FluxboxWindow::setStuck, false);
        menu.insert(new FbTk::BoolMenuItem(
                        label.empty() ?
                        _FB_XTEXT(Windowmenu, Stick,
                                  "Stick", "Stick the window"):
                        label, res));
    } else if (type == "settitledialog") {
        RefCmd setname_cmd(new SetTitleDialogCmd());
        menu.insert(label.empty() ?
                    _FB_XTEXT(Windowmenu, SetTitle,
                              "Set Title", "Change the title of the window"):
                    label, setname_cmd);
#ifdef HAVE_XRENDER
    } else if (type == "alpha") {
        if (FbTk::Transparent::haveComposite() || 
            FbTk::Transparent::haveRender()) {
            BScreen *screen = Fluxbox::instance()->findScreen(menu.screenNumber());
            if (screen == 0)
                return false;

            RefMenu submenu( new AlphaMenu(screen->menuTheme(), screen->imageControl(),
                              *screen->layerManager().getLayer(LAYERMENU)) );
            submenu->disableTitle();
            menu.insert(label.empty() ? _FB_XTEXT(Configmenu, Transparency, "Transparency",
                                                  "Menu containing various transparency options"): label,
                        submenu);
        }
#endif // HAVE_XRENDER
    } else if (type == "extramenus") {
        BScreen *screen = Fluxbox::instance()->findScreen(menu.screenNumber());
        BScreen::ExtraMenus::iterator it = screen->extraWindowMenus().begin();
        BScreen::ExtraMenus::iterator it_end = screen->extraWindowMenus().end();
        for (; it != it_end; ++it) {
            it->second->disableTitle();
            menu.insert(it->first, it->second);
        }

    } else if (type == "sendto") {
        menu.insert(label.empty() ? _FB_XTEXT(Windowmenu, SendTo, "Send To...", "Send to menu item name"):
                    label, RefMenu(new SendToMenu(*Fluxbox::instance()->findScreen(menu.screenNumber()))) );
    } else if (type == "layer") {
        BScreen *screen = Fluxbox::instance()->findScreen(menu.screenNumber());
        if (screen == 0)
            return false;

        RefMenu submenu( new LayerMenu(screen->menuTheme(),
                                            screen->imageControl(),
                                            *screen->layerManager().getLayer(LAYERMENU),
                                            &context,
                                            false) );
        submenu->disableTitle();
        menu.insert(label.empty()?_FB_XTEXT(Windowmenu, Layer, "Layer ...", "Layer menu"):label, submenu);


    } else if (type == "separator") {
        menu.insert(new FbTk::MenuSeparator());
    } else
        return false;

    return true;
}