├── .gitignore
├── ApplicationLauncher
    ├── translations
    │   ├── de.ts
    │   ├── es.ts
    │   └── fr.ts
    ├── CMakeLists.txt
    ├── main.cpp
    ├── applicationlauncher.h
    └── applicationlauncher.cpp
├── wm-configs
    ├── ross-shell.desktop
    └── awesome
    │   └── rc.lua
├── README.md
└── LICENSE


/.gitignore:
--------------------------------------------------------------------------------
1 | doc/*
2 | ApplicationLauncher/CMakeLists.txt.user*
3 | ApplicationLauncher/build/
4 | 


--------------------------------------------------------------------------------
/ApplicationLauncher/translations/de.ts:
--------------------------------------------------------------------------------
1 | <?xml version="1.0" encoding="utf-8"?>
2 | <!DOCTYPE TS>
3 | <TS version="2.1">
4 | </TS>
5 | 


--------------------------------------------------------------------------------
/ApplicationLauncher/translations/es.ts:
--------------------------------------------------------------------------------
1 | <?xml version="1.0" encoding="utf-8"?>
2 | <!DOCTYPE TS>
3 | <TS version="2.1">
4 | </TS>
5 | 


--------------------------------------------------------------------------------
/ApplicationLauncher/translations/fr.ts:
--------------------------------------------------------------------------------
1 | <?xml version="1.0" encoding="utf-8"?>
2 | <!DOCTYPE TS>
3 | <TS version="2.1">
4 | </TS>
5 | 


--------------------------------------------------------------------------------
/wm-configs/ross-shell.desktop:
--------------------------------------------------------------------------------
1 | [Desktop Entry]
2 | Name=ROSS Shell
3 | Comment=GUI designed for maximum efficiency and ease of use
4 | TryExec=awesome
5 | Exec=awesome -c /etc/xdg/awesome/ross/rc.lua
6 | Type=Application
7 | 


--------------------------------------------------------------------------------
/ApplicationLauncher/CMakeLists.txt:
--------------------------------------------------------------------------------
 1 | cmake_minimum_required(VERSION 3.5)
 2 | 
 3 | project(ApplicationLauncher LANGUAGES CXX)
 4 | 
 5 | set(CMAKE_INCLUDE_CURRENT_DIR ON)
 6 | 
 7 | set(CMAKE_AUTOUIC ON)
 8 | set(CMAKE_AUTOMOC ON)
 9 | set(CMAKE_AUTORCC ON)
10 | 
11 | set(CMAKE_CXX_STANDARD 11)
12 | set(CMAKE_CXX_STANDARD_REQUIRED ON)
13 | 
14 | find_package(Qt5 COMPONENTS Widgets DBus LinguistTools REQUIRED)
15 | find_package(Qt5Xdg)
16 | 
17 | set(PROJECT_SOURCES
18 |     main.cpp
19 |     applicationlauncher.cpp
20 |     applicationlauncher.h
21 | )
22 | 
23 | set(LANGUAGES de es fr)
24 | foreach(LANGUAGE ${LANGUAGES})
25 |     set(TS_FILES ${TS_FILES} translations/${LANGUAGE}.ts)
26 | endforeach(LANGUAGE)
27 | 
28 | qt5_create_translation(QM_FILES
29 |     ${PROJECT_SOURCES}
30 |     ${TS_FILES}
31 | )
32 | 
33 | add_executable(ApplicationLauncher
34 |     ${PROJECT_SOURCES}
35 |     ${QM_FILES}
36 | )
37 | 
38 | target_link_libraries(ApplicationLauncher PRIVATE Qt5::Widgets Qt5::DBus Qt5Xdg)
39 | 
40 | install(TARGETS ApplicationLauncher RUNTIME DESTINATION bin)
41 | 


--------------------------------------------------------------------------------
/ApplicationLauncher/main.cpp:
--------------------------------------------------------------------------------
 1 | #include "applicationlauncher.h"
 2 | 
 3 | #include <QApplication>
 4 | #include <QDBusConnectionInterface>
 5 | #include <QTextStream>
 6 | #include <QTranslator>
 7 | 
 8 | int main(int argc, char *argv[])
 9 | {
10 |     QApplication app(argc, argv);
11 |     app.setOrganizationName("ROSS");
12 |     app.setApplicationName("ApplicationLauncher");
13 | 
14 |     QTranslator translator;
15 |     translator.load(QLocale::system().name());
16 |     app.installTranslator(&translator);
17 | 
18 |     QDBusConnection dbus = QDBusConnection::sessionBus();
19 |     if(!dbus.registerService("org.ROSS.ApplicationLauncher")) {
20 |         QTextStream(stderr) << "ApplicationLauncher is already running!";
21 |         exit(EXIT_FAILURE);
22 |     }
23 | 
24 |     ApplicationLauncher applicationLauncher;
25 |     QObject::connect(&app, &QApplication::applicationStateChanged, [&applicationLauncher](Qt::ApplicationState state) {
26 |         if (state == Qt::ApplicationInactive && applicationLauncher.isVisible()) {
27 |             applicationLauncher.toggle();
28 |         }
29 |     });
30 |     dbus.registerObject("/App", &applicationLauncher, QDBusConnection::ExportScriptableSlots);
31 | 
32 |     return app.exec();
33 | }
34 | 


--------------------------------------------------------------------------------
/ApplicationLauncher/applicationlauncher.h:
--------------------------------------------------------------------------------
 1 | #ifndef APPLICATIONLAUNCHER_H
 2 | #define APPLICATIONLAUNCHER_H
 3 | 
 4 | #include <QSettings>
 5 | #include <QWidget>
 6 | #include <XdgMenu>
 7 | 
 8 | class ApplicationLauncher : public QWidget
 9 | {
10 |     Q_CLASSINFO("D-Bus Interface", "org.ROSS.ApplicationLauncher")
11 |     Q_OBJECT
12 | 
13 | public:
14 |     ApplicationLauncher(QWidget *parent = nullptr);
15 |     ~ApplicationLauncher();
16 | 
17 | public slots:
18 |     Q_SCRIPTABLE void toggle();
19 | 
20 | private:
21 |     int centerCircleSize = 250;
22 |     int iconSize = 64;
23 |     int menuSize = 500;
24 |     int sliceCount = 8;
25 |     QSettings settings;
26 | 
27 |     int centerCirclePosition;
28 |     QList<int> currentPage;
29 |     int iconDistance;
30 |     int iconOffset;
31 |     QList<QDomElement> items;
32 |     bool leftClicking;
33 |     bool lock;
34 |     int menuOffset;
35 |     int pageCount;
36 |     float sliceLength;
37 |     int sliceSelected;
38 |     XdgMenu menu;
39 | 
40 |     void initializeSettings();
41 |     void navigate(int i);
42 | 
43 |     void closeEvent(QCloseEvent *event);
44 |     void mouseMoveEvent(QMouseEvent *event);
45 |     void mousePressEvent(QMouseEvent *event);
46 |     void mouseReleaseEvent(QMouseEvent *event);
47 |     void paintEvent(QPaintEvent *event);
48 | };
49 | #endif // APPLICATIONLAUNCHER_H
50 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
 1 | # ROSS Shell
 2 | 
 3 | The main goal of this project is to create the most effcient GUI possible. You can find the various components in the following folders:
 4 | - ApplicationLauncher: desktop independent application launcher using a radial menu
 5 | - wm-configs: session and configurations files
 6 | 
 7 | ## Installation and Usage
 8 | Follow the instructions in the [wiki](https://github.com/rosssoftware/Shell/wiki/ApplicationLauncher).
 9 | 
10 | ## Features
11 | - Plantext configuration: Editing configuration files *outside* of an interface makes it more portable and easier to work with.
12 | - (upcoming) Conditional status: For example, if you're playing *DOOM*, or working with *GIMP*, you should be able to unbind certain shortcuts. If you binded *CTRL-Click* to do something, but in those programs, you don't want that, then it should be possible to disable the shortcuts. Some other conditions that are not decided yet can also be added.
13 | - (upcoming) Profiles: This is an extension of the previous point, but with different profiles.
14 | 
15 | For the programming language and framework we use Qt with C++ and some small libraries like libqtxdg.
16 | 
17 | 
18 | ## Contribute
19 | We are still in planning stages. Contributions, discussions and research are welcome. Just join our [chat on Element.io](https://app.element.io/#/room/#ross:matrix.org) or make a pull request/issue for this repository.
20 | 
21 | ## Background: Ross Scott and the quest for the holy GUI 
22 | To quote Ross from Accursed Farms, "None of this would be possible without multiple mathematicians and scientists, working around the clock to break reality"
23 | > "Man must shape his tools lest they shape him."
24 | > -- <cite>[Arthur Miller][1]</cite>
25 | 
26 | [1]: https://www.azquotes.com/quote/654449
27 | 


--------------------------------------------------------------------------------
/ApplicationLauncher/applicationlauncher.cpp:
--------------------------------------------------------------------------------
  1 | #include "applicationlauncher.h"
  2 | 
  3 | #include <QIcon>
  4 | #include <QMouseEvent>
  5 | #include <QPainter>
  6 | #include <QProcess>
  7 | #include <QScreen>
  8 | #include <QtMath>
  9 | 
 10 | ApplicationLauncher::ApplicationLauncher(QWidget *parent)
 11 |     : QWidget(parent)
 12 | {
 13 |     setAttribute(Qt::WA_TranslucentBackground);
 14 |     setWindowFlags(Qt::FramelessWindowHint | Qt::WindowStaysOnTopHint);
 15 |     setMouseTracking(true);
 16 |     initializeSettings();
 17 |     centerCirclePosition = -centerCircleSize / 2;
 18 |     iconOffset = iconSize / 2;
 19 |     menuOffset = menuSize / 2;
 20 |     iconDistance = centerCircleSize / 2 + (menuSize - centerCircleSize) / 4;
 21 |     sliceLength = 2 * M_PI / sliceCount;
 22 |     menu.setEnvironments(QStringList() << qgetenv("XDG_CURRENT_DESKTOP"));
 23 |     QString menuFile = XdgMenu::getMenuFileName();
 24 |     if (!menu.read(menuFile)) {
 25 |         return;
 26 |     }
 27 | }
 28 | 
 29 | ApplicationLauncher::~ApplicationLauncher()
 30 | {
 31 | }
 32 | 
 33 | void ApplicationLauncher::toggle()
 34 | {
 35 |     if (isVisible()) {
 36 |         hide();
 37 |         leftClicking = false;
 38 |     } else {
 39 |         sliceSelected = -1;
 40 |         items.clear();
 41 |         currentPage.clear();
 42 |         items << menu.xml().documentElement();
 43 |         currentPage.append(0);
 44 |         navigate(0);
 45 |         showFullScreen();
 46 |         QCursor::setPos(screen()->size().width() / 2, screen()->size().height() / 2);
 47 |     }
 48 | }
 49 | 
 50 | void ApplicationLauncher::initializeSettings()
 51 | {
 52 |     if (settings.allKeys().isEmpty()) {
 53 |         settings.beginGroup("settings");
 54 |         settings.setValue("sliceCount", sliceCount);
 55 |         settings.endGroup();
 56 |         settings.beginGroup("size");
 57 |         settings.setValue("centerCircle", centerCircleSize);
 58 |         settings.setValue("icons", iconSize);
 59 |         settings.setValue("menu", menuSize);
 60 |         settings.endGroup();
 61 |     }
 62 |     settings.beginGroup("settings");
 63 |     sliceCount = settings.value("sliceCount", centerCircleSize).toInt();
 64 |     settings.endGroup();
 65 |     settings.beginGroup("size");
 66 |     centerCircleSize = settings.value("centerCircle", centerCircleSize).toInt();
 67 |     iconSize = settings.value("icons", iconSize).toInt();
 68 |     menuSize = settings.value("menu", menuSize).toInt();
 69 |     settings.endGroup();
 70 | }
 71 | 
 72 | void ApplicationLauncher::navigate(int i)
 73 | {
 74 |     QDomElement e;
 75 |     if (i == -1) {
 76 |         QDomNode n = items[0].parentNode().parentNode();
 77 |         if (n.isDocument()) {
 78 |             toggle();
 79 |             return;
 80 |         } else {
 81 |             currentPage.removeLast();
 82 |             e = n.firstChildElement();
 83 |         }
 84 |     } else {
 85 |         if(items[i + currentPage.last() * sliceCount].attribute("exec").isNull()) {
 86 |             e = items[i + currentPage.last() * sliceCount].firstChildElement();
 87 |             currentPage.append(0);
 88 |         } else {
 89 |             QProcess::startDetached(items[i + currentPage.last() * sliceCount].attribute("exec").split(" ")[0], {});
 90 |             toggle();
 91 |         }
 92 |     }
 93 |     items.clear();
 94 |     while (!e.isNull()) {
 95 |         if (e.tagName() == "Menu" || e.tagName() == "AppLink") {
 96 |             items << e;
 97 |         }
 98 |         e = e.nextSiblingElement();
 99 |     }
100 |     pageCount = (items.count() - 1) / sliceCount + 1;
101 |     update();
102 | }
103 | 
104 | void ApplicationLauncher::closeEvent(QCloseEvent *event)
105 | {
106 |     event->ignore();
107 |     toggle();
108 | }
109 | 
110 | void ApplicationLauncher::mouseMoveEvent(QMouseEvent *event)
111 | {
112 |     int menuPosX = event->x() - screen()->size().width() / 2;
113 |     int menuPosY = event->y() - screen()->size().height() / 2;
114 |     int distance = pow(menuPosX, 2) + pow(menuPosY, 2);
115 |     sliceSelected = -1;
116 |     if (distance >= pow(centerCircleSize / 2, 2)) {
117 |         for (int i = 0; i + currentPage.last() * sliceCount < items.count() && i < sliceCount; i++) {
118 |             float angle = M_PI - atan2(menuPosX, menuPosY);
119 |             float startangle = i * sliceLength - sliceLength / 2;
120 |             float endangle = startangle + sliceLength;
121 |             if (startangle < 0) {
122 |                 startangle += 2 * M_PI;
123 |             }
124 |             if ((startangle <= angle && angle <= endangle) || (endangle < startangle && (startangle <= angle || angle <= endangle))) {
125 |                 sliceSelected = i;
126 |             }
127 |         }
128 |         if (distance >= pow(menuSize / 2, 2)) {
129 |             if (!lock && sliceSelected != -1 && leftClicking) {
130 |                 navigate(sliceSelected);
131 |             }
132 |             lock = true;
133 |         } else {
134 |             lock = false;
135 |         }
136 |     } else {
137 |         lock = false;
138 |     }
139 |     update();
140 | }
141 | 
142 | void ApplicationLauncher::mousePressEvent(QMouseEvent *event)
143 | {
144 |     if (event->button() == Qt::LeftButton) {
145 |         leftClicking = true;
146 |     } else if (event->button() == Qt::MiddleButton) {
147 |         navigate(-1);
148 |     } else if (event->button() == Qt::RightButton) {
149 |         if (++currentPage.last() >= pageCount) {
150 |             currentPage.last() = 0;
151 |         }
152 |         update();
153 |     }
154 | }
155 | 
156 | void ApplicationLauncher::mouseReleaseEvent(QMouseEvent *event)
157 | {
158 |     if (event->button() == Qt::LeftButton) {
159 |         leftClicking = false;
160 |     }
161 | }
162 | 
163 | void ApplicationLauncher::paintEvent(QPaintEvent *event)
164 | {
165 |     QPainter painter(this);
166 |     painter.setRenderHint(QPainter::Antialiasing);
167 |     painter.translate(rect().center());
168 |     for (int i = 0; i < sliceCount; i++) {
169 |         if (sliceSelected == i) {
170 |             painter.setBrush(Qt::darkGray);
171 |         } else {
172 |             painter.setBrush(Qt::SolidPattern);
173 |         }
174 |         float sliceLengthDegrees = qRadiansToDegrees(sliceLength);
175 |         painter.drawPie(-menuOffset, -menuOffset, menuSize, menuSize, (90 - i * sliceLengthDegrees + qRadiansToDegrees(sliceLength) / 2) * 16, -sliceLengthDegrees * 16);
176 |     }
177 |     for (int i = 0; i + currentPage.last() * sliceCount < items.count() && i < sliceCount; i++) {
178 |         QPixmap icon = QIcon::fromTheme(items[i + currentPage.last() * sliceCount].attribute("icon")).pixmap(iconSize);
179 |         painter.drawPixmap(iconDistance * sin(i * sliceLength) - iconOffset, iconDistance * -cos(i * sliceLength) - iconOffset, icon);
180 |     }
181 |     painter.setBrush(Qt::SolidPattern);
182 |     painter.drawEllipse(centerCirclePosition, centerCirclePosition, centerCircleSize, centerCircleSize);
183 |     QString circleText;
184 |     if (sliceSelected + currentPage.last() * sliceCount < items.count() && sliceSelected != -1) {
185 |         circleText = items[sliceSelected + currentPage.last() * sliceCount].attribute("title");
186 |     } else {
187 |         circleText = "[Left Click Drag] Navigate\n[Middle Click] Back\n[Right Click] Next Page\n(" + QString::number(currentPage.last() + 1) + "/" + QString::number(pageCount) + ")";
188 |     }
189 |     painter.setPen(Qt::white);
190 |     painter.drawText(centerCirclePosition, centerCirclePosition, centerCircleSize, centerCircleSize, Qt::AlignCenter, circleText);
191 | }
192 | 


--------------------------------------------------------------------------------
/wm-configs/awesome/rc.lua:
--------------------------------------------------------------------------------
  1 | -- If LuaRocks is installed, make sure that packages installed through it are
  2 | -- found (e.g. lgi). If LuaRocks is not installed, do nothing.
  3 | pcall(require, "luarocks.loader")
  4 | 
  5 | -- Standard awesome library
  6 | local gears = require("gears")
  7 | local awful = require("awful")
  8 | require("awful.autofocus")
  9 | -- Widget and layout library
 10 | local wibox = require("wibox")
 11 | -- Theme handling library
 12 | local beautiful = require("beautiful")
 13 | -- Notification library
 14 | local naughty = require("naughty")
 15 | local menubar = require("menubar")
 16 | local hotkeys_popup = require("awful.hotkeys_popup")
 17 | -- Enable hotkeys help widget for VIM and other apps
 18 | -- when client with a matching name is opened:
 19 | require("awful.hotkeys_popup.keys")
 20 | 
 21 | -- Load Debian menu entries
 22 | --local debian = require("debian.menu")
 23 | --local has_fdo, freedesktop = pcall(require, "freedesktop")
 24 | 
 25 | -- {{{ Error handling
 26 | -- Check if awesome encountered an error during startup and fell back to
 27 | -- another config (This code will only ever execute for the fallback config)
 28 | if awesome.startup_errors then
 29 |     naughty.notify({ preset = naughty.config.presets.critical,
 30 |                      title = "Oops, there were errors during startup!",
 31 |                      text = awesome.startup_errors })
 32 | end
 33 | 
 34 | -- Handle runtime errors after startup
 35 | do
 36 |     local in_error = false
 37 |     awesome.connect_signal("debug::error", function (err)
 38 |         -- Make sure we don't go into an endless error loop
 39 |         if in_error then return end
 40 |         in_error = true
 41 | 
 42 |         naughty.notify({ preset = naughty.config.presets.critical,
 43 |                          title = "Oops, an error happened!",
 44 |                          text = tostring(err) })
 45 |         in_error = false
 46 |     end)
 47 | end
 48 | -- }}}
 49 | 
 50 | -- {{{ Variable definitions
 51 | -- Themes define colours, icons, font and wallpapers.
 52 | beautiful.init(gears.filesystem.get_themes_dir() .. "default/theme.lua")
 53 | 
 54 | -- This is used later as the default terminal and editor to run.
 55 | terminal = "x-terminal-emulator"
 56 | editor = os.getenv("EDITOR") or "editor"
 57 | editor_cmd = terminal .. " -e " .. editor
 58 | 
 59 | -- Default modkey.
 60 | -- Usually, Mod4 is the key with a logo between Control and Alt.
 61 | -- If you do not like this or do not have such a key,
 62 | -- I suggest you to remap Mod4 to another key using xmodmap or other tools.
 63 | -- However, you can use another modifier like Mod1, but it may interact with others.
 64 | modkey = "Mod4"
 65 | 
 66 | -- Table of layouts to cover with awful.layout.inc, order matters.
 67 | awful.layout.layouts = {
 68 |     --awful.layout.suit.floating,
 69 |     -- awful.layout.suit.tile,
 70 |     -- awful.layout.suit.tile.left,
 71 |     -- awful.layout.suit.tile.bottom,
 72 |     -- awful.layout.suit.tile.top,
 73 |     awful.layout.suit.fair,
 74 |     -- awful.layout.suit.fair.horizontal,
 75 |     -- awful.layout.suit.spiral,
 76 |     -- awful.layout.suit.spiral.dwindle,
 77 |     -- awful.layout.suit.max,
 78 |     -- awful.layout.suit.max.fullscreen,
 79 |     -- awful.layout.suit.magnifier,
 80 |     -- awful.layout.suit.corner.nw,
 81 |     -- awful.layout.suit.corner.ne,
 82 |     -- awful.layout.suit.corner.sw,
 83 |     -- awful.layout.suit.corner.se,
 84 | }
 85 | -- }}}
 86 | 
 87 | -- {{{ Menu
 88 | -- Create a launcher widget and a main menu
 89 | myawesomemenu = {
 90 |    { "hotkeys", function() hotkeys_popup.show_help(nil, awful.screen.focused()) end },
 91 |    { "manual", terminal .. " -e man awesome" },
 92 |    { "edit config", editor_cmd .. " " .. awesome.conffile },
 93 |    { "restart", awesome.restart },
 94 |    { "quit", function() awesome.quit() end },
 95 | }
 96 | 
 97 | -- Menubar configuration
 98 | menubar.utils.terminal = terminal -- Set the terminal for applications that require it
 99 | -- }}}
100 | 
101 | -- Keyboard map indicator and switcher
102 | mykeyboardlayout = awful.widget.keyboardlayout()
103 | 
104 | -- {{{ Wibar
105 | -- Create a textclock widget
106 | mytextclock = wibox.widget.textclock()
107 | 
108 | -- Create a wibox for each screen and add it
109 | local taglist_buttons = gears.table.join(
110 |                     awful.button({ }, 1, function(t) t:view_only() end),
111 |                     awful.button({ modkey }, 1, function(t)
112 |                                               if client.focus then
113 |                                                   client.focus:move_to_tag(t)
114 |                                               end
115 |                                           end),
116 |                     awful.button({ }, 3, awful.tag.viewtoggle),
117 |                     awful.button({ modkey }, 3, function(t)
118 |                                               if client.focus then
119 |                                                   client.focus:toggle_tag(t)
120 |                                               end
121 |                                           end),
122 |                     awful.button({ }, 4, function(t) awful.tag.viewnext(t.screen) end),
123 |                     awful.button({ }, 5, function(t) awful.tag.viewprev(t.screen) end)
124 |                 )
125 | 
126 | local tasklist_buttons = gears.table.join(
127 |                      awful.button({ }, 1, function (c)
128 |                                               if c == client.focus then
129 |                                                   c.minimized = true
130 |                                               else
131 |                                                   c:emit_signal(
132 |                                                       "request::activate",
133 |                                                       "tasklist",
134 |                                                       {raise = true}
135 |                                                   )
136 |                                               end
137 |                                           end),
138 |                      awful.button({ }, 3, function()
139 |                                               awful.menu.client_list({ theme = { width = 250 } })
140 |                                           end),
141 |                      awful.button({ }, 4, function ()
142 |                                               awful.client.focus.byidx(1)
143 |                                           end),
144 |                      awful.button({ }, 5, function ()
145 |                                               awful.client.focus.byidx(-1)
146 |                                           end))
147 | 
148 | local function set_wallpaper(s)
149 |     -- Wallpaper
150 |     if beautiful.wallpaper then
151 |         local wallpaper = beautiful.wallpaper
152 |         -- If wallpaper is a function, call it with the screen
153 |         if type(wallpaper) == "function" then
154 |             wallpaper = wallpaper(s)
155 |         end
156 |         gears.wallpaper.maximized(wallpaper, s, true)
157 |     end
158 | end
159 | 
160 | -- Re-set wallpaper when a screen's geometry changes (e.g. different resolution)
161 | screen.connect_signal("property::geometry", set_wallpaper)
162 | 
163 | awful.screen.connect_for_each_screen(function(s)
164 |     -- Wallpaper
165 |     set_wallpaper(s)
166 | 
167 |     -- Each screen has its own tag table.
168 |     awful.tag({ "1", "2", "3", "4", "5", "6", "7", "8", "9" }, s, awful.layout.layouts[1])
169 | 
170 |     -- Create a promptbox for each screen
171 |     s.mypromptbox = awful.widget.prompt()
172 |     -- Create an imagebox widget which will contain an icon indicating which layout we're using.
173 |     -- We need one layoutbox per screen.
174 |     s.mylayoutbox = awful.widget.layoutbox(s)
175 |     s.mylayoutbox:buttons(gears.table.join(
176 |                            awful.button({ }, 1, function () awful.layout.inc( 1) end),
177 |                            awful.button({ }, 3, function () awful.layout.inc(-1) end),
178 |                            awful.button({ }, 4, function () awful.layout.inc( 1) end),
179 |                            awful.button({ }, 5, function () awful.layout.inc(-1) end)))
180 |     -- Create a taglist widget
181 |     s.mytaglist = awful.widget.taglist {
182 |         screen  = s,
183 |         filter  = awful.widget.taglist.filter.all,
184 |         buttons = taglist_buttons
185 |     }
186 | 
187 |     -- Create a tasklist widget
188 |     s.mytasklist = awful.widget.tasklist {
189 |         screen  = s,
190 |         filter  = awful.widget.tasklist.filter.currenttags,
191 |         buttons = tasklist_buttons
192 |     }
193 | 
194 |     -- Create the wibox
195 |     s.mywibox = awful.wibar({ position = "top", screen = s })
196 | 
197 |     -- Add widgets to the wibox
198 |     s.mywibox:setup {
199 |         layout = wibox.layout.align.horizontal,
200 |         { -- Left widgets
201 |             layout = wibox.layout.fixed.horizontal,
202 |             --mylauncher,
203 |             s.mytaglist,
204 |             s.mypromptbox,
205 |         },
206 |         s.mytasklist, -- Middle widget
207 |         { -- Right widgets
208 |             layout = wibox.layout.fixed.horizontal,
209 |             mykeyboardlayout,
210 |             wibox.widget.systray(),
211 |             mytextclock,
212 |             s.mylayoutbox,
213 |         },
214 |     }
215 | end)
216 | -- }}}
217 | 
218 | -- {{{ Mouse bindings
219 | root.buttons(gears.table.join(
220 |     --awful.button({ }, 3, function () mymainmenu:toggle() end),
221 |     awful.button({ }, 4, awful.tag.viewnext),
222 |     awful.button({ }, 5, awful.tag.viewprev)
223 | ))
224 | -- }}}
225 | 
226 | -- {{{ Key bindings
227 | globalkeys = gears.table.join(
228 |     awful.key({ modkey,           }, "Left",   awful.tag.viewprev,
229 |               {description = "view previous", group = "tag"}),
230 |     awful.key({ modkey,           }, "Right",  awful.tag.viewnext,
231 |               {description = "view next", group = "tag"}),
232 |     awful.key({ modkey,           }, "Escape", awful.tag.history.restore,
233 |               {description = "go back", group = "tag"}),
234 | 
235 |     awful.key({ modkey,           }, "j",
236 |         function ()
237 |             awful.client.focus.byidx( 1)
238 |         end,
239 |         {description = "focus next by index", group = "client"}
240 |     ),
241 |     awful.key({ modkey,           }, "k",
242 |         function ()
243 |             awful.client.focus.byidx(-1)
244 |         end,
245 |         {description = "focus previous by index", group = "client"}
246 |     ),
247 |     awful.key({ modkey,           }, "w", function () mymainmenu:show() end,
248 |               {description = "show main menu", group = "awesome"}),
249 | 
250 |     -- Layout manipulation
251 |     awful.key({ modkey, "Shift"   }, "j", function () awful.client.swap.byidx(  1)    end,
252 |               {description = "swap with next client by index", group = "client"}),
253 |     awful.key({ modkey, "Shift"   }, "k", function () awful.client.swap.byidx( -1)    end,
254 |               {description = "swap with previous client by index", group = "client"}),
255 |     awful.key({ modkey, "Control" }, "j", function () awful.screen.focus_relative( 1) end,
256 |               {description = "focus the next screen", group = "screen"}),
257 |     awful.key({ modkey, "Control" }, "k", function () awful.screen.focus_relative(-1) end,
258 |               {description = "focus the previous screen", group = "screen"}),
259 |     awful.key({ modkey,           }, "u", awful.client.urgent.jumpto,
260 |               {description = "jump to urgent client", group = "client"}),
261 |     awful.key({ modkey,           }, "Tab",
262 |         function ()
263 |             awful.client.focus.history.previous()
264 |             if client.focus then
265 |                 client.focus:raise()
266 |             end
267 |         end,
268 |         {description = "go back", group = "client"}),
269 | 
270 |     -- Standard program
271 |     awful.key({ modkey,           }, "<", function () awful.spawn(terminal) end,
272 |               {description = "open a terminal", group = "launcher"}),
273 |     awful.key({ modkey,		  }, "q", function () awful.spawn("dbus-send --dest=org.ROSS.ApplicationLauncher --type=method_call /App org.ROSS.ApplicationLauncher.toggle") end,
274 |               {description = "toggle ApplicationLauncher", group = "launcher"}),
275 |     awful.key({ modkey, "Control" }, "r", awesome.restart,
276 |               {description = "reload awesome", group = "awesome"}),
277 |     awful.key({ modkey, "Shift"   }, "q", awesome.quit,
278 |               {description = "quit awesome", group = "awesome"}),
279 | 
280 |     awful.key({ modkey,           }, "l",     function () awful.tag.incmwfact( 0.05)          end,
281 |               {description = "increase master width factor", group = "layout"}),
282 |     awful.key({ modkey,           }, "h",     function () awful.tag.incmwfact(-0.05)          end,
283 |               {description = "decrease master width factor", group = "layout"}),
284 |     awful.key({ modkey, "Shift"   }, "h",     function () awful.tag.incnmaster( 1, nil, true) end,
285 |               {description = "increase the number of master clients", group = "layout"}),
286 |     awful.key({ modkey, "Shift"   }, "l",     function () awful.tag.incnmaster(-1, nil, true) end,
287 |               {description = "decrease the number of master clients", group = "layout"}),
288 |     awful.key({ modkey, "Control" }, "h",     function () awful.tag.incncol( 1, nil, true)    end,
289 |               {description = "increase the number of columns", group = "layout"}),
290 |     awful.key({ modkey, "Control" }, "l",     function () awful.tag.incncol(-1, nil, true)    end,
291 |               {description = "decrease the number of columns", group = "layout"}),
292 |     awful.key({ modkey, "Shift"   }, "space", function () awful.layout.inc(-1)                end,
293 |               {description = "select previous", group = "layout"}),
294 | 
295 |     awful.key({ modkey, "Control" }, "n",
296 |               function ()
297 |                   local c = awful.client.restore()
298 |                   -- Focus restored client
299 |                   if c then
300 |                     c:emit_signal(
301 |                         "request::activate", "key.unminimize", {raise = true}
302 |                     )
303 |                   end
304 |               end,
305 |               {description = "restore minimized", group = "client"}),
306 | 
307 |     -- Prompt
308 |     awful.key({ modkey },            "r",     function () awful.screen.focused().mypromptbox:run() end,
309 |               {description = "run prompt", group = "launcher"}),
310 | 
311 |     awful.key({ modkey }, "x",
312 |               function ()
313 |                   awful.prompt.run {
314 |                     prompt       = "Run Lua code: ",
315 |                     textbox      = awful.screen.focused().mypromptbox.widget,
316 |                     exe_callback = awful.util.eval,
317 |                     history_path = awful.util.get_cache_dir() .. "/history_eval"
318 |                   }
319 |               end,
320 |               {description = "lua execute prompt", group = "awesome"}),
321 |     -- Menubar
322 |     awful.key({ modkey }, "p", function() menubar.show() end,
323 |               {description = "show the menubar", group = "launcher"})
324 | )
325 | 
326 | clientkeys = gears.table.join(
327 |     awful.key({ modkey,           }, "f",
328 |         function (c)
329 |             c.fullscreen = not c.fullscreen
330 |             c:raise()
331 |         end,
332 |         {description = "toggle fullscreen", group = "client"}),
333 |     awful.key({ modkey, "Control" }, "space",  awful.client.floating.toggle                     ,
334 |               {description = "toggle floating", group = "client"}),
335 |     awful.key({ modkey, "Control" }, "Return", function (c) c:swap(awful.client.getmaster()) end,
336 |               {description = "move to master", group = "client"}),
337 |     awful.key({ modkey,           }, "o",      function (c) c:move_to_screen()               end,
338 |               {description = "move to screen", group = "client"}),
339 |     awful.key({ modkey,           }, "t",      function (c) c.ontop = not c.ontop            end,
340 |               {description = "toggle keep on top", group = "client"}),
341 |     awful.key({ modkey,           }, "n",
342 |         function (c)
343 |             -- The client currently has the input focus, so it cannot be
344 |             -- minimized, since minimized clients can't have the focus.
345 |             c.minimized = true
346 |         end ,
347 |         {description = "minimize", group = "client"}),
348 |     awful.key({ modkey,           }, "m",
349 |         function (c)
350 |             c.maximized = not c.maximized
351 |             c:raise()
352 |         end ,
353 |         {description = "(un)maximize", group = "client"}),
354 |     awful.key({ modkey, "Control" }, "m",
355 |         function (c)
356 |             c.maximized_vertical = not c.maximized_vertical
357 |             c:raise()
358 |         end ,
359 |         {description = "(un)maximize vertically", group = "client"}),
360 |     awful.key({ modkey, "Shift"   }, "m",
361 |         function (c)
362 |             c.maximized_horizontal = not c.maximized_horizontal
363 |             c:raise()
364 |         end ,
365 |         {description = "(un)maximize horizontally", group = "client"})
366 | )
367 | 
368 | -- Bind all key numbers to tags.
369 | -- Be careful: we use keycodes to make it work on any keyboard layout.
370 | -- This should map on the top row of your keyboard, usually 1 to 9.
371 | for i = 1, 9 do
372 |     globalkeys = gears.table.join(globalkeys,
373 |         -- View tag only.
374 |         awful.key({ modkey }, "#" .. i + 9,
375 |                   function ()
376 |                         local screen = awful.screen.focused()
377 |                         local tag = screen.tags[i]
378 |                         if tag then
379 |                            tag:view_only()
380 |                         end
381 |                   end,
382 |                   {description = "view tag #"..i, group = "tag"}),
383 |         -- Toggle tag display.
384 |         awful.key({ modkey, "Control" }, "#" .. i + 9,
385 |                   function ()
386 |                       local screen = awful.screen.focused()
387 |                       local tag = screen.tags[i]
388 |                       if tag then
389 |                          awful.tag.viewtoggle(tag)
390 |                       end
391 |                   end,
392 |                   {description = "toggle tag #" .. i, group = "tag"}),
393 |         -- Move client to tag.
394 |         awful.key({ modkey, "Shift" }, "#" .. i + 9,
395 |                   function ()
396 |                       if client.focus then
397 |                           local tag = client.focus.screen.tags[i]
398 |                           if tag then
399 |                               client.focus:move_to_tag(tag)
400 |                           end
401 |                      end
402 |                   end,
403 |                   {description = "move focused client to tag #"..i, group = "tag"}),
404 |         -- Toggle tag on focused client.
405 |         awful.key({ modkey, "Control", "Shift" }, "#" .. i + 9,
406 |                   function ()
407 |                       if client.focus then
408 |                           local tag = client.focus.screen.tags[i]
409 |                           if tag then
410 |                               client.focus:toggle_tag(tag)
411 |                           end
412 |                       end
413 |                   end,
414 |                   {description = "toggle focused client on tag #" .. i, group = "tag"})
415 |     )
416 | end
417 | 
418 | clientbuttons = gears.table.join(
419 |     awful.button({ modkey }, 2, function (c) c:kill() end),
420 |     awful.button({ }, 1, function (c)
421 |         c:emit_signal("request::activate", "mouse_click", {raise = true})
422 |     end),
423 |     awful.button({ modkey }, 1, function (c)
424 |         c:emit_signal("request::activate", "mouse_click", {raise = true})
425 |         awful.mouse.client.move(c)
426 |     end),
427 |     awful.button({ modkey }, 3, function (c)
428 |         c:emit_signal("request::activate", "mouse_click", {raise = true})
429 |         awful.mouse.client.resize(c)
430 |     end)
431 | )
432 | 
433 | -- Set keys
434 | root.keys(globalkeys)
435 | -- }}}
436 | 
437 | -- {{{ Rules
438 | -- Rules to apply to new clients (through the "manage" signal).
439 | awful.rules.rules = {
440 |     -- All clients will match this rule.
441 |     { rule = { },
442 |       properties = { border_width = beautiful.border_width,
443 |                      border_color = beautiful.border_normal,
444 |                      focus = awful.client.focus.filter,
445 |                      raise = true,
446 |                      keys = clientkeys,
447 |                      buttons = clientbuttons,
448 |                      screen = awful.screen.preferred,
449 |                      placement = awful.placement.no_overlap+awful.placement.no_offscreen
450 |      }
451 |     },
452 | 
453 |     -- Floating clients.
454 |     { rule_any = {
455 |         instance = {
456 |           "DTA",  -- Firefox addon DownThemAll.
457 |           "copyq",  -- Includes session name in class.
458 |           "pinentry",
459 |         },
460 |         class = {
461 |           "ApplicationLauncher",
462 |           "Arandr",
463 |           "Blueman-manager",
464 |           "Gpick",
465 |           "Kruler",
466 |           "MessageWin",  -- kalarm.
467 |           "Sxiv",
468 |           "Tor Browser", -- Needs a fixed window size to avoid fingerprinting by screen size.
469 |           "Wpa_gui",
470 |           "veromix",
471 |           "xtightvncviewer"},
472 | 
473 |         -- Note that the name property shown in xprop might be set slightly after creation of the client
474 |         -- and the name shown there might not match defined rules here.
475 |         name = {
476 |           "Event Tester",  -- xev.
477 |         },
478 |         role = {
479 |           "AlarmWindow",  -- Thunderbird's calendar.
480 |           "ConfigManager",  -- Thunderbird's about:config.
481 |           "pop-up",       -- e.g. Google Chrome's (detached) Developer Tools.
482 |         }
483 |       }, properties = { floating = true }},
484 | 
485 |     -- Add titlebars to normal clients and dialogs
486 |     --{ rule_any = {type = { "normal", "dialog" }
487 |     --  }, properties = { titlebars_enabled = true }
488 |     --},
489 | 
490 |     -- Set Firefox to always map on the tag named "2" on screen 1.
491 |     -- { rule = { class = "Firefox" },
492 |     --   properties = { screen = 1, tag = "2" } },
493 |     
494 |     -- Make ApplicationLauncher centered
495 |     { rule = { class = "ApplicationLauncher" },
496 |       properties = { placement = awful.placement. centered } },
497 | }
498 | -- }}}
499 | 
500 | -- {{{ Signals
501 | -- Signal function to execute when a new client appears.
502 | client.connect_signal("manage", function (c)
503 |     -- Set the windows at the slave,
504 |     -- i.e. put it at the end of others instead of setting it master.
505 |     -- if not awesome.startup then awful.client.setslave(c) end
506 | 
507 |     if awesome.startup
508 |       and not c.size_hints.user_position
509 |       and not c.size_hints.program_position then
510 |         -- Prevent clients from being unreachable after screen count changes.
511 |         awful.placement.no_offscreen(c)
512 |     end
513 | end)
514 | 
515 | -- Add a titlebar if titlebars_enabled is set to true in the rules.
516 | client.connect_signal("request::titlebars", function(c)
517 |     -- buttons for the titlebar
518 |     local buttons = gears.table.join(
519 |         awful.button({ }, 1, function()
520 |             c:emit_signal("request::activate", "titlebar", {raise = true})
521 |             awful.mouse.client.move(c)
522 |         end),
523 |         awful.button({ }, 3, function()
524 |             c:emit_signal("request::activate", "titlebar", {raise = true})
525 |             awful.mouse.client.resize(c)
526 |         end)
527 |     )
528 | 
529 |     awful.titlebar(c) : setup {
530 |         { -- Left
531 |             awful.titlebar.widget.iconwidget(c),
532 |             buttons = buttons,
533 |             layout  = wibox.layout.fixed.horizontal
534 |         },
535 |         { -- Middle
536 |             { -- Title
537 |                 align  = "center",
538 |                 widget = awful.titlebar.widget.titlewidget(c)
539 |             },
540 |             buttons = buttons,
541 |             layout  = wibox.layout.flex.horizontal
542 |         },
543 |         { -- Right
544 |             awful.titlebar.widget.floatingbutton (c),
545 |             awful.titlebar.widget.maximizedbutton(c),
546 |             awful.titlebar.widget.stickybutton   (c),
547 |             awful.titlebar.widget.ontopbutton    (c),
548 |             awful.titlebar.widget.closebutton    (c),
549 |             layout = wibox.layout.fixed.horizontal()
550 |         },
551 |         layout = wibox.layout.align.horizontal
552 |     }
553 | end)
554 | 
555 | -- Enable sloppy focus, so that focus follows mouse.
556 | client.connect_signal("mouse::enter", function(c)
557 |     c:emit_signal("request::activate", "mouse_enter", {raise = false})
558 | end)
559 | 
560 | client.connect_signal("focus", function(c) c.border_color = beautiful.border_focus end)
561 | client.connect_signal("unfocus", function(c) c.border_color = beautiful.border_normal end)
562 | -- }}}
563 | 
564 | awful.spawn("ApplicationLauncher")
565 | 


--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
  1 |                     GNU GENERAL PUBLIC LICENSE
  2 |                        Version 3, 29 June 2007
  3 | 
  4 |  Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
  5 |  Everyone is permitted to copy and distribute verbatim copies
  6 |  of this license document, but changing it is not allowed.
  7 | 
  8 |                             Preamble
  9 | 
 10 |   The GNU General Public License is a free, copyleft license for
 11 | software and other kinds of works.
 12 | 
 13 |   The licenses for most software and other practical works are designed
 14 | to take away your freedom to share and change the works.  By contrast,
 15 | the GNU General Public License is intended to guarantee your freedom to
 16 | share and change all versions of a program--to make sure it remains free
 17 | software for all its users.  We, the Free Software Foundation, use the
 18 | GNU General Public License for most of our software; it applies also to
 19 | any other work released this way by its authors.  You can apply it to
 20 | your programs, too.
 21 | 
 22 |   When we speak of free software, we are referring to freedom, not
 23 | price.  Our General Public Licenses are designed to make sure that you
 24 | have the freedom to distribute copies of free software (and charge for
 25 | them if you wish), that you receive source code or can get it if you
 26 | want it, that you can change the software or use pieces of it in new
 27 | free programs, and that you know you can do these things.
 28 | 
 29 |   To protect your rights, we need to prevent others from denying you
 30 | these rights or asking you to surrender the rights.  Therefore, you have
 31 | certain responsibilities if you distribute copies of the software, or if
 32 | you modify it: responsibilities to respect the freedom of others.
 33 | 
 34 |   For example, if you distribute copies of such a program, whether
 35 | gratis or for a fee, you must pass on to the recipients the same
 36 | freedoms that you received.  You must make sure that they, too, receive
 37 | or can get the source code.  And you must show them these terms so they
 38 | know their rights.
 39 | 
 40 |   Developers that use the GNU GPL protect your rights with two steps:
 41 | (1) assert copyright on the software, and (2) offer you this License
 42 | giving you legal permission to copy, distribute and/or modify it.
 43 | 
 44 |   For the developers' and authors' protection, the GPL clearly explains
 45 | that there is no warranty for this free software.  For both users' and
 46 | authors' sake, the GPL requires that modified versions be marked as
 47 | changed, so that their problems will not be attributed erroneously to
 48 | authors of previous versions.
 49 | 
 50 |   Some devices are designed to deny users access to install or run
 51 | modified versions of the software inside them, although the manufacturer
 52 | can do so.  This is fundamentally incompatible with the aim of
 53 | protecting users' freedom to change the software.  The systematic
 54 | pattern of such abuse occurs in the area of products for individuals to
 55 | use, which is precisely where it is most unacceptable.  Therefore, we
 56 | have designed this version of the GPL to prohibit the practice for those
 57 | products.  If such problems arise substantially in other domains, we
 58 | stand ready to extend this provision to those domains in future versions
 59 | of the GPL, as needed to protect the freedom of users.
 60 | 
 61 |   Finally, every program is threatened constantly by software patents.
 62 | States should not allow patents to restrict development and use of
 63 | software on general-purpose computers, but in those that do, we wish to
 64 | avoid the special danger that patents applied to a free program could
 65 | make it effectively proprietary.  To prevent this, the GPL assures that
 66 | patents cannot be used to render the program non-free.
 67 | 
 68 |   The precise terms and conditions for copying, distribution and
 69 | modification follow.
 70 | 
 71 |                        TERMS AND CONDITIONS
 72 | 
 73 |   0. Definitions.
 74 | 
 75 |   "This License" refers to version 3 of the GNU General Public License.
 76 | 
 77 |   "Copyright" also means copyright-like laws that apply to other kinds of
 78 | works, such as semiconductor masks.
 79 | 
 80 |   "The Program" refers to any copyrightable work licensed under this
 81 | License.  Each licensee is addressed as "you".  "Licensees" and
 82 | "recipients" may be individuals or organizations.
 83 | 
 84 |   To "modify" a work means to copy from or adapt all or part of the work
 85 | in a fashion requiring copyright permission, other than the making of an
 86 | exact copy.  The resulting work is called a "modified version" of the
 87 | earlier work or a work "based on" the earlier work.
 88 | 
 89 |   A "covered work" means either the unmodified Program or a work based
 90 | on the Program.
 91 | 
 92 |   To "propagate" a work means to do anything with it that, without
 93 | permission, would make you directly or secondarily liable for
 94 | infringement under applicable copyright law, except executing it on a
 95 | computer or modifying a private copy.  Propagation includes copying,
 96 | distribution (with or without modification), making available to the
 97 | public, and in some countries other activities as well.
 98 | 
 99 |   To "convey" a work means any kind of propagation that enables other
100 | parties to make or receive copies.  Mere interaction with a user through
101 | a computer network, with no transfer of a copy, is not conveying.
102 | 
103 |   An interactive user interface displays "Appropriate Legal Notices"
104 | to the extent that it includes a convenient and prominently visible
105 | feature that (1) displays an appropriate copyright notice, and (2)
106 | tells the user that there is no warranty for the work (except to the
107 | extent that warranties are provided), that licensees may convey the
108 | work under this License, and how to view a copy of this License.  If
109 | the interface presents a list of user commands or options, such as a
110 | menu, a prominent item in the list meets this criterion.
111 | 
112 |   1. Source Code.
113 | 
114 |   The "source code" for a work means the preferred form of the work
115 | for making modifications to it.  "Object code" means any non-source
116 | form of a work.
117 | 
118 |   A "Standard Interface" means an interface that either is an official
119 | standard defined by a recognized standards body, or, in the case of
120 | interfaces specified for a particular programming language, one that
121 | is widely used among developers working in that language.
122 | 
123 |   The "System Libraries" of an executable work include anything, other
124 | than the work as a whole, that (a) is included in the normal form of
125 | packaging a Major Component, but which is not part of that Major
126 | Component, and (b) serves only to enable use of the work with that
127 | Major Component, or to implement a Standard Interface for which an
128 | implementation is available to the public in source code form.  A
129 | "Major Component", in this context, means a major essential component
130 | (kernel, window system, and so on) of the specific operating system
131 | (if any) on which the executable work runs, or a compiler used to
132 | produce the work, or an object code interpreter used to run it.
133 | 
134 |   The "Corresponding Source" for a work in object code form means all
135 | the source code needed to generate, install, and (for an executable
136 | work) run the object code and to modify the work, including scripts to
137 | control those activities.  However, it does not include the work's
138 | System Libraries, or general-purpose tools or generally available free
139 | programs which are used unmodified in performing those activities but
140 | which are not part of the work.  For example, Corresponding Source
141 | includes interface definition files associated with source files for
142 | the work, and the source code for shared libraries and dynamically
143 | linked subprograms that the work is specifically designed to require,
144 | such as by intimate data communication or control flow between those
145 | subprograms and other parts of the work.
146 | 
147 |   The Corresponding Source need not include anything that users
148 | can regenerate automatically from other parts of the Corresponding
149 | Source.
150 | 
151 |   The Corresponding Source for a work in source code form is that
152 | same work.
153 | 
154 |   2. Basic Permissions.
155 | 
156 |   All rights granted under this License are granted for the term of
157 | copyright on the Program, and are irrevocable provided the stated
158 | conditions are met.  This License explicitly affirms your unlimited
159 | permission to run the unmodified Program.  The output from running a
160 | covered work is covered by this License only if the output, given its
161 | content, constitutes a covered work.  This License acknowledges your
162 | rights of fair use or other equivalent, as provided by copyright law.
163 | 
164 |   You may make, run and propagate covered works that you do not
165 | convey, without conditions so long as your license otherwise remains
166 | in force.  You may convey covered works to others for the sole purpose
167 | of having them make modifications exclusively for you, or provide you
168 | with facilities for running those works, provided that you comply with
169 | the terms of this License in conveying all material for which you do
170 | not control copyright.  Those thus making or running the covered works
171 | for you must do so exclusively on your behalf, under your direction
172 | and control, on terms that prohibit them from making any copies of
173 | your copyrighted material outside their relationship with you.
174 | 
175 |   Conveying under any other circumstances is permitted solely under
176 | the conditions stated below.  Sublicensing is not allowed; section 10
177 | makes it unnecessary.
178 | 
179 |   3. Protecting Users' Legal Rights From Anti-Circumvention Law.
180 | 
181 |   No covered work shall be deemed part of an effective technological
182 | measure under any applicable law fulfilling obligations under article
183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or
184 | similar laws prohibiting or restricting circumvention of such
185 | measures.
186 | 
187 |   When you convey a covered work, you waive any legal power to forbid
188 | circumvention of technological measures to the extent such circumvention
189 | is effected by exercising rights under this License with respect to
190 | the covered work, and you disclaim any intention to limit operation or
191 | modification of the work as a means of enforcing, against the work's
192 | users, your or third parties' legal rights to forbid circumvention of
193 | technological measures.
194 | 
195 |   4. Conveying Verbatim Copies.
196 | 
197 |   You may convey verbatim copies of the Program's source code as you
198 | receive it, in any medium, provided that you conspicuously and
199 | appropriately publish on each copy an appropriate copyright notice;
200 | keep intact all notices stating that this License and any
201 | non-permissive terms added in accord with section 7 apply to the code;
202 | keep intact all notices of the absence of any warranty; and give all
203 | recipients a copy of this License along with the Program.
204 | 
205 |   You may charge any price or no price for each copy that you convey,
206 | and you may offer support or warranty protection for a fee.
207 | 
208 |   5. Conveying Modified Source Versions.
209 | 
210 |   You may convey a work based on the Program, or the modifications to
211 | produce it from the Program, in the form of source code under the
212 | terms of section 4, provided that you also meet all of these conditions:
213 | 
214 |     a) The work must carry prominent notices stating that you modified
215 |     it, and giving a relevant date.
216 | 
217 |     b) The work must carry prominent notices stating that it is
218 |     released under this License and any conditions added under section
219 |     7.  This requirement modifies the requirement in section 4 to
220 |     "keep intact all notices".
221 | 
222 |     c) You must license the entire work, as a whole, under this
223 |     License to anyone who comes into possession of a copy.  This
224 |     License will therefore apply, along with any applicable section 7
225 |     additional terms, to the whole of the work, and all its parts,
226 |     regardless of how they are packaged.  This License gives no
227 |     permission to license the work in any other way, but it does not
228 |     invalidate such permission if you have separately received it.
229 | 
230 |     d) If the work has interactive user interfaces, each must display
231 |     Appropriate Legal Notices; however, if the Program has interactive
232 |     interfaces that do not display Appropriate Legal Notices, your
233 |     work need not make them do so.
234 | 
235 |   A compilation of a covered work with other separate and independent
236 | works, which are not by their nature extensions of the covered work,
237 | and which are not combined with it such as to form a larger program,
238 | in or on a volume of a storage or distribution medium, is called an
239 | "aggregate" if the compilation and its resulting copyright are not
240 | used to limit the access or legal rights of the compilation's users
241 | beyond what the individual works permit.  Inclusion of a covered work
242 | in an aggregate does not cause this License to apply to the other
243 | parts of the aggregate.
244 | 
245 |   6. Conveying Non-Source Forms.
246 | 
247 |   You may convey a covered work in object code form under the terms
248 | of sections 4 and 5, provided that you also convey the
249 | machine-readable Corresponding Source under the terms of this License,
250 | in one of these ways:
251 | 
252 |     a) Convey the object code in, or embodied in, a physical product
253 |     (including a physical distribution medium), accompanied by the
254 |     Corresponding Source fixed on a durable physical medium
255 |     customarily used for software interchange.
256 | 
257 |     b) Convey the object code in, or embodied in, a physical product
258 |     (including a physical distribution medium), accompanied by a
259 |     written offer, valid for at least three years and valid for as
260 |     long as you offer spare parts or customer support for that product
261 |     model, to give anyone who possesses the object code either (1) a
262 |     copy of the Corresponding Source for all the software in the
263 |     product that is covered by this License, on a durable physical
264 |     medium customarily used for software interchange, for a price no
265 |     more than your reasonable cost of physically performing this
266 |     conveying of source, or (2) access to copy the
267 |     Corresponding Source from a network server at no charge.
268 | 
269 |     c) Convey individual copies of the object code with a copy of the
270 |     written offer to provide the Corresponding Source.  This
271 |     alternative is allowed only occasionally and noncommercially, and
272 |     only if you received the object code with such an offer, in accord
273 |     with subsection 6b.
274 | 
275 |     d) Convey the object code by offering access from a designated
276 |     place (gratis or for a charge), and offer equivalent access to the
277 |     Corresponding Source in the same way through the same place at no
278 |     further charge.  You need not require recipients to copy the
279 |     Corresponding Source along with the object code.  If the place to
280 |     copy the object code is a network server, the Corresponding Source
281 |     may be on a different server (operated by you or a third party)
282 |     that supports equivalent copying facilities, provided you maintain
283 |     clear directions next to the object code saying where to find the
284 |     Corresponding Source.  Regardless of what server hosts the
285 |     Corresponding Source, you remain obligated to ensure that it is
286 |     available for as long as needed to satisfy these requirements.
287 | 
288 |     e) Convey the object code using peer-to-peer transmission, provided
289 |     you inform other peers where the object code and Corresponding
290 |     Source of the work are being offered to the general public at no
291 |     charge under subsection 6d.
292 | 
293 |   A separable portion of the object code, whose source code is excluded
294 | from the Corresponding Source as a System Library, need not be
295 | included in conveying the object code work.
296 | 
297 |   A "User Product" is either (1) a "consumer product", which means any
298 | tangible personal property which is normally used for personal, family,
299 | or household purposes, or (2) anything designed or sold for incorporation
300 | into a dwelling.  In determining whether a product is a consumer product,
301 | doubtful cases shall be resolved in favor of coverage.  For a particular
302 | product received by a particular user, "normally used" refers to a
303 | typical or common use of that class of product, regardless of the status
304 | of the particular user or of the way in which the particular user
305 | actually uses, or expects or is expected to use, the product.  A product
306 | is a consumer product regardless of whether the product has substantial
307 | commercial, industrial or non-consumer uses, unless such uses represent
308 | the only significant mode of use of the product.
309 | 
310 |   "Installation Information" for a User Product means any methods,
311 | procedures, authorization keys, or other information required to install
312 | and execute modified versions of a covered work in that User Product from
313 | a modified version of its Corresponding Source.  The information must
314 | suffice to ensure that the continued functioning of the modified object
315 | code is in no case prevented or interfered with solely because
316 | modification has been made.
317 | 
318 |   If you convey an object code work under this section in, or with, or
319 | specifically for use in, a User Product, and the conveying occurs as
320 | part of a transaction in which the right of possession and use of the
321 | User Product is transferred to the recipient in perpetuity or for a
322 | fixed term (regardless of how the transaction is characterized), the
323 | Corresponding Source conveyed under this section must be accompanied
324 | by the Installation Information.  But this requirement does not apply
325 | if neither you nor any third party retains the ability to install
326 | modified object code on the User Product (for example, the work has
327 | been installed in ROM).
328 | 
329 |   The requirement to provide Installation Information does not include a
330 | requirement to continue to provide support service, warranty, or updates
331 | for a work that has been modified or installed by the recipient, or for
332 | the User Product in which it has been modified or installed.  Access to a
333 | network may be denied when the modification itself materially and
334 | adversely affects the operation of the network or violates the rules and
335 | protocols for communication across the network.
336 | 
337 |   Corresponding Source conveyed, and Installation Information provided,
338 | in accord with this section must be in a format that is publicly
339 | documented (and with an implementation available to the public in
340 | source code form), and must require no special password or key for
341 | unpacking, reading or copying.
342 | 
343 |   7. Additional Terms.
344 | 
345 |   "Additional permissions" are terms that supplement the terms of this
346 | License by making exceptions from one or more of its conditions.
347 | Additional permissions that are applicable to the entire Program shall
348 | be treated as though they were included in this License, to the extent
349 | that they are valid under applicable law.  If additional permissions
350 | apply only to part of the Program, that part may be used separately
351 | under those permissions, but the entire Program remains governed by
352 | this License without regard to the additional permissions.
353 | 
354 |   When you convey a copy of a covered work, you may at your option
355 | remove any additional permissions from that copy, or from any part of
356 | it.  (Additional permissions may be written to require their own
357 | removal in certain cases when you modify the work.)  You may place
358 | additional permissions on material, added by you to a covered work,
359 | for which you have or can give appropriate copyright permission.
360 | 
361 |   Notwithstanding any other provision of this License, for material you
362 | add to a covered work, you may (if authorized by the copyright holders of
363 | that material) supplement the terms of this License with terms:
364 | 
365 |     a) Disclaiming warranty or limiting liability differently from the
366 |     terms of sections 15 and 16 of this License; or
367 | 
368 |     b) Requiring preservation of specified reasonable legal notices or
369 |     author attributions in that material or in the Appropriate Legal
370 |     Notices displayed by works containing it; or
371 | 
372 |     c) Prohibiting misrepresentation of the origin of that material, or
373 |     requiring that modified versions of such material be marked in
374 |     reasonable ways as different from the original version; or
375 | 
376 |     d) Limiting the use for publicity purposes of names of licensors or
377 |     authors of the material; or
378 | 
379 |     e) Declining to grant rights under trademark law for use of some
380 |     trade names, trademarks, or service marks; or
381 | 
382 |     f) Requiring indemnification of licensors and authors of that
383 |     material by anyone who conveys the material (or modified versions of
384 |     it) with contractual assumptions of liability to the recipient, for
385 |     any liability that these contractual assumptions directly impose on
386 |     those licensors and authors.
387 | 
388 |   All other non-permissive additional terms are considered "further
389 | restrictions" within the meaning of section 10.  If the Program as you
390 | received it, or any part of it, contains a notice stating that it is
391 | governed by this License along with a term that is a further
392 | restriction, you may remove that term.  If a license document contains
393 | a further restriction but permits relicensing or conveying under this
394 | License, you may add to a covered work material governed by the terms
395 | of that license document, provided that the further restriction does
396 | not survive such relicensing or conveying.
397 | 
398 |   If you add terms to a covered work in accord with this section, you
399 | must place, in the relevant source files, a statement of the
400 | additional terms that apply to those files, or a notice indicating
401 | where to find the applicable terms.
402 | 
403 |   Additional terms, permissive or non-permissive, may be stated in the
404 | form of a separately written license, or stated as exceptions;
405 | the above requirements apply either way.
406 | 
407 |   8. Termination.
408 | 
409 |   You may not propagate or modify a covered work except as expressly
410 | provided under this License.  Any attempt otherwise to propagate or
411 | modify it is void, and will automatically terminate your rights under
412 | this License (including any patent licenses granted under the third
413 | paragraph of section 11).
414 | 
415 |   However, if you cease all violation of this License, then your
416 | license from a particular copyright holder is reinstated (a)
417 | provisionally, unless and until the copyright holder explicitly and
418 | finally terminates your license, and (b) permanently, if the copyright
419 | holder fails to notify you of the violation by some reasonable means
420 | prior to 60 days after the cessation.
421 | 
422 |   Moreover, your license from a particular copyright holder is
423 | reinstated permanently if the copyright holder notifies you of the
424 | violation by some reasonable means, this is the first time you have
425 | received notice of violation of this License (for any work) from that
426 | copyright holder, and you cure the violation prior to 30 days after
427 | your receipt of the notice.
428 | 
429 |   Termination of your rights under this section does not terminate the
430 | licenses of parties who have received copies or rights from you under
431 | this License.  If your rights have been terminated and not permanently
432 | reinstated, you do not qualify to receive new licenses for the same
433 | material under section 10.
434 | 
435 |   9. Acceptance Not Required for Having Copies.
436 | 
437 |   You are not required to accept this License in order to receive or
438 | run a copy of the Program.  Ancillary propagation of a covered work
439 | occurring solely as a consequence of using peer-to-peer transmission
440 | to receive a copy likewise does not require acceptance.  However,
441 | nothing other than this License grants you permission to propagate or
442 | modify any covered work.  These actions infringe copyright if you do
443 | not accept this License.  Therefore, by modifying or propagating a
444 | covered work, you indicate your acceptance of this License to do so.
445 | 
446 |   10. Automatic Licensing of Downstream Recipients.
447 | 
448 |   Each time you convey a covered work, the recipient automatically
449 | receives a license from the original licensors, to run, modify and
450 | propagate that work, subject to this License.  You are not responsible
451 | for enforcing compliance by third parties with this License.
452 | 
453 |   An "entity transaction" is a transaction transferring control of an
454 | organization, or substantially all assets of one, or subdividing an
455 | organization, or merging organizations.  If propagation of a covered
456 | work results from an entity transaction, each party to that
457 | transaction who receives a copy of the work also receives whatever
458 | licenses to the work the party's predecessor in interest had or could
459 | give under the previous paragraph, plus a right to possession of the
460 | Corresponding Source of the work from the predecessor in interest, if
461 | the predecessor has it or can get it with reasonable efforts.
462 | 
463 |   You may not impose any further restrictions on the exercise of the
464 | rights granted or affirmed under this License.  For example, you may
465 | not impose a license fee, royalty, or other charge for exercise of
466 | rights granted under this License, and you may not initiate litigation
467 | (including a cross-claim or counterclaim in a lawsuit) alleging that
468 | any patent claim is infringed by making, using, selling, offering for
469 | sale, or importing the Program or any portion of it.
470 | 
471 |   11. Patents.
472 | 
473 |   A "contributor" is a copyright holder who authorizes use under this
474 | License of the Program or a work on which the Program is based.  The
475 | work thus licensed is called the contributor's "contributor version".
476 | 
477 |   A contributor's "essential patent claims" are all patent claims
478 | owned or controlled by the contributor, whether already acquired or
479 | hereafter acquired, that would be infringed by some manner, permitted
480 | by this License, of making, using, or selling its contributor version,
481 | but do not include claims that would be infringed only as a
482 | consequence of further modification of the contributor version.  For
483 | purposes of this definition, "control" includes the right to grant
484 | patent sublicenses in a manner consistent with the requirements of
485 | this License.
486 | 
487 |   Each contributor grants you a non-exclusive, worldwide, royalty-free
488 | patent license under the contributor's essential patent claims, to
489 | make, use, sell, offer for sale, import and otherwise run, modify and
490 | propagate the contents of its contributor version.
491 | 
492 |   In the following three paragraphs, a "patent license" is any express
493 | agreement or commitment, however denominated, not to enforce a patent
494 | (such as an express permission to practice a patent or covenant not to
495 | sue for patent infringement).  To "grant" such a patent license to a
496 | party means to make such an agreement or commitment not to enforce a
497 | patent against the party.
498 | 
499 |   If you convey a covered work, knowingly relying on a patent license,
500 | and the Corresponding Source of the work is not available for anyone
501 | to copy, free of charge and under the terms of this License, through a
502 | publicly available network server or other readily accessible means,
503 | then you must either (1) cause the Corresponding Source to be so
504 | available, or (2) arrange to deprive yourself of the benefit of the
505 | patent license for this particular work, or (3) arrange, in a manner
506 | consistent with the requirements of this License, to extend the patent
507 | license to downstream recipients.  "Knowingly relying" means you have
508 | actual knowledge that, but for the patent license, your conveying the
509 | covered work in a country, or your recipient's use of the covered work
510 | in a country, would infringe one or more identifiable patents in that
511 | country that you have reason to believe are valid.
512 | 
513 |   If, pursuant to or in connection with a single transaction or
514 | arrangement, you convey, or propagate by procuring conveyance of, a
515 | covered work, and grant a patent license to some of the parties
516 | receiving the covered work authorizing them to use, propagate, modify
517 | or convey a specific copy of the covered work, then the patent license
518 | you grant is automatically extended to all recipients of the covered
519 | work and works based on it.
520 | 
521 |   A patent license is "discriminatory" if it does not include within
522 | the scope of its coverage, prohibits the exercise of, or is
523 | conditioned on the non-exercise of one or more of the rights that are
524 | specifically granted under this License.  You may not convey a covered
525 | work if you are a party to an arrangement with a third party that is
526 | in the business of distributing software, under which you make payment
527 | to the third party based on the extent of your activity of conveying
528 | the work, and under which the third party grants, to any of the
529 | parties who would receive the covered work from you, a discriminatory
530 | patent license (a) in connection with copies of the covered work
531 | conveyed by you (or copies made from those copies), or (b) primarily
532 | for and in connection with specific products or compilations that
533 | contain the covered work, unless you entered into that arrangement,
534 | or that patent license was granted, prior to 28 March 2007.
535 | 
536 |   Nothing in this License shall be construed as excluding or limiting
537 | any implied license or other defenses to infringement that may
538 | otherwise be available to you under applicable patent law.
539 | 
540 |   12. No Surrender of Others' Freedom.
541 | 
542 |   If conditions are imposed on you (whether by court order, agreement or
543 | otherwise) that contradict the conditions of this License, they do not
544 | excuse you from the conditions of this License.  If you cannot convey a
545 | covered work so as to satisfy simultaneously your obligations under this
546 | License and any other pertinent obligations, then as a consequence you may
547 | not convey it at all.  For example, if you agree to terms that obligate you
548 | to collect a royalty for further conveying from those to whom you convey
549 | the Program, the only way you could satisfy both those terms and this
550 | License would be to refrain entirely from conveying the Program.
551 | 
552 |   13. Use with the GNU Affero General Public License.
553 | 
554 |   Notwithstanding any other provision of this License, you have
555 | permission to link or combine any covered work with a work licensed
556 | under version 3 of the GNU Affero General Public License into a single
557 | combined work, and to convey the resulting work.  The terms of this
558 | License will continue to apply to the part which is the covered work,
559 | but the special requirements of the GNU Affero General Public License,
560 | section 13, concerning interaction through a network will apply to the
561 | combination as such.
562 | 
563 |   14. Revised Versions of this License.
564 | 
565 |   The Free Software Foundation may publish revised and/or new versions of
566 | the GNU General Public License from time to time.  Such new versions will
567 | be similar in spirit to the present version, but may differ in detail to
568 | address new problems or concerns.
569 | 
570 |   Each version is given a distinguishing version number.  If the
571 | Program specifies that a certain numbered version of the GNU General
572 | Public License "or any later version" applies to it, you have the
573 | option of following the terms and conditions either of that numbered
574 | version or of any later version published by the Free Software
575 | Foundation.  If the Program does not specify a version number of the
576 | GNU General Public License, you may choose any version ever published
577 | by the Free Software Foundation.
578 | 
579 |   If the Program specifies that a proxy can decide which future
580 | versions of the GNU General Public License can be used, that proxy's
581 | public statement of acceptance of a version permanently authorizes you
582 | to choose that version for the Program.
583 | 
584 |   Later license versions may give you additional or different
585 | permissions.  However, no additional obligations are imposed on any
586 | author or copyright holder as a result of your choosing to follow a
587 | later version.
588 | 
589 |   15. Disclaimer of Warranty.
590 | 
591 |   THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
592 | APPLICABLE LAW.  EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
596 | PURPOSE.  THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
597 | IS WITH YOU.  SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
599 | 
600 |   16. Limitation of Liability.
601 | 
602 |   IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
610 | SUCH DAMAGES.
611 | 
612 |   17. Interpretation of Sections 15 and 16.
613 | 
614 |   If the disclaimer of warranty and limitation of liability provided
615 | above cannot be given local legal effect according to their terms,
616 | reviewing courts shall apply local law that most closely approximates
617 | an absolute waiver of all civil liability in connection with the
618 | Program, unless a warranty or assumption of liability accompanies a
619 | copy of the Program in return for a fee.
620 | 
621 |                      END OF TERMS AND CONDITIONS
622 | 
623 |             How to Apply These Terms to Your New Programs
624 | 
625 |   If you develop a new program, and you want it to be of the greatest
626 | possible use to the public, the best way to achieve this is to make it
627 | free software which everyone can redistribute and change under these terms.
628 | 
629 |   To do so, attach the following notices to the program.  It is safest
630 | to attach them to the start of each source file to most effectively
631 | state the exclusion of warranty; and each file should have at least
632 | the "copyright" line and a pointer to where the full notice is found.
633 | 
634 |     <one line to give the program's name and a brief idea of what it does.>
635 |     Copyright (C) <year>  <name of author>
636 | 
637 |     This program is free software: you can redistribute it and/or modify
638 |     it under the terms of the GNU General Public License as published by
639 |     the Free Software Foundation, either version 3 of the License, or
640 |     (at your option) any later version.
641 | 
642 |     This program is distributed in the hope that it will be useful,
643 |     but WITHOUT ANY WARRANTY; without even the implied warranty of
644 |     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
645 |     GNU General Public License for more details.
646 | 
647 |     You should have received a copy of the GNU General Public License
648 |     along with this program.  If not, see <https://www.gnu.org/licenses/>.
649 | 
650 | Also add information on how to contact you by electronic and paper mail.
651 | 
652 |   If the program does terminal interaction, make it output a short
653 | notice like this when it starts in an interactive mode:
654 | 
655 |     <program>  Copyright (C) <year>  <name of author>
656 |     This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
657 |     This is free software, and you are welcome to redistribute it
658 |     under certain conditions; type `show c' for details.
659 | 
660 | The hypothetical commands `show w' and `show c' should show the appropriate
661 | parts of the General Public License.  Of course, your program's commands
662 | might be different; for a GUI interface, you would use an "about box".
663 | 
664 |   You should also get your employer (if you work as a programmer) or school,
665 | if any, to sign a "copyright disclaimer" for the program, if necessary.
666 | For more information on this, and how to apply and follow the GNU GPL, see
667 | <https://www.gnu.org/licenses/>.
668 | 
669 |   The GNU General Public License does not permit incorporating your program
670 | into proprietary programs.  If your program is a subroutine library, you
671 | may consider it more useful to permit linking proprietary applications with
672 | the library.  If this is what you want to do, use the GNU Lesser General
673 | Public License instead of this License.  But first, please read
674 | <https://www.gnu.org/licenses/why-not-lgpl.html>.
675 | 


--------------------------------------------------------------------------------