From 4b45731adfd1d6fd1cf1fc49ac364ace1b5d26fc Mon Sep 17 00:00:00 2001
From: Patrick Gaskin <patrick@pgaskin.net>
Date: Wed, 22 Apr 2020 13:01:55 -0400
Subject: [PATCH] Renamed subsystem to action

---
 .gitignore                         |  4 ++--
 Makefile                           |  2 +-
 res/doc                            | 34 +++++++++++++++---------------
 src/{subsys_c.c => action_c.c}     |  8 +++----
 src/action_c.h                     | 14 ++++++++++++
 src/{subsys_cc.cc => action_cc.cc} |  4 ++--
 src/action_cc.h                    | 12 +++++++++++
 src/config.c                       |  4 ++--
 src/config.h                       |  2 +-
 src/init.c                         | 10 ++++-----
 src/menu.cc                        |  2 +-
 src/menu.h                         |  2 +-
 src/subsys_c.h                     | 14 ------------
 src/subsys_cc.h                    | 12 -----------
 14 files changed, 62 insertions(+), 62 deletions(-)
 rename src/{subsys_c.c => action_c.c} (64%)
 create mode 100644 src/action_c.h
 rename src/{subsys_cc.cc => action_cc.cc} (97%)
 create mode 100644 src/action_cc.h
 delete mode 100644 src/subsys_c.h
 delete mode 100644 src/subsys_cc.h

diff --git a/.gitignore b/.gitignore
index dacc5a5..26e4f95 100644
--- a/.gitignore
+++ b/.gitignore
@@ -8,9 +8,9 @@
 
 /src/failsafe.o
 /src/init.o
-/src/subsys_c.o
 /src/config.o
 /src/dlhook.o
+/src/action_c.o
 
 /src/menu.o
-/src/subsys_cc.o
+/src/action_cc.o
diff --git a/Makefile b/Makefile
index e9a5831..d24b654 100644
--- a/Makefile
+++ b/Makefile
@@ -72,7 +72,7 @@ override GENERATED += KoboRoot KoboRoot.tgz
 src/libnmi.so: override CFLAGS   += $(PTHREAD_CFLAGS) -fPIC
 src/libnmi.so: override CXXFLAGS += $(PTHREAD_CFLAGS) $(QT5CORE_CFLAGS) $(QT5WIDGETS_CFLAGS) -fPIC
 src/libnmi.so: override LDFLAGS  += $(PTHREAD_LIBS) $(QT5CORE_LIBS) $(QT5WIDGETS_LIBS) -ldl -Wl,-soname,libnmi.so
-src/libnmi.so: src/qtplugin.o src/init.o src/config.o src/dlhook.o src/failsafe.o src/menu.o src/subsys_c.o src/subsys_cc.o
+src/libnmi.so: src/qtplugin.o src/init.o src/config.o src/dlhook.o src/failsafe.o src/menu.o src/action_c.o src/action_cc.o
 
 override LIBRARIES += src/libnmi.so
 override MOCS      += src/qtplugin.moc
diff --git a/res/doc b/res/doc
index 844c5ca..05ee454 100644
--- a/res/doc
+++ b/res/doc
@@ -11,25 +11,25 @@
 # They can be named anything, and should consist of multiple lines either
 # starting with # for a comment, or in the the following format:
 #
-#   menu_item:<location>:<label>:<subsystem>:<arg>
+#   menu_item:<location>:<label>:<action>:<arg>
 #     Adds a menu item (spaces around fields are ignored).
 #
-#     <location>   the menu to add the item to, one of:
-#                    main   - the menu in the top-left corner of the home screen
-#                    reader - the overflow menu in the reader
-#     <label>      the label to show on the menu item (must not contain :)
-#     <subsystem>  the type of action to run, one of:
-#                    dbg_syslog     - writes a message to syslog (for testing)
-#                    dbg_error      - always returns an error (for testing)
-#                    kfmon          - triggers a kfmon action (coming soon)
-#                    nickel_setting - toggles a boolean setting (coming soon)
-#     <arg>        the argument passed to the subsystem:
-#                    dbg_syslog     - the text to write
-#                    dbg_error      - the error message
-#                    kfmon          - TODO
-#                    nickel_setting - one of:
-#                                       invert      - toggles FeatureSettings.InvertScreen (all versions)
-#                                       screenshots - toggles FeatureSettings.Screenshots (all versions)
+#     <location>  the menu to add the item to, one of:
+#                   main   - the menu in the top-left corner of the home screen
+#                   reader - the overflow menu in the reader
+#     <label>     the label to show on the menu item (must not contain :)
+#     <action>    the type of action to run, one of:
+#                   dbg_syslog     - writes a message to syslog (for testing)
+#                   dbg_error      - always returns an error (for testing)
+#                   kfmon          - triggers a kfmon action (coming soon)
+#                   nickel_setting - toggles a boolean setting (coming soon)
+#     <arg>       the argument passed to the action:
+#                   dbg_syslog     - the text to write
+#                   dbg_error      - the error message
+#                   kfmon          - TODO
+#                   nickel_setting - one of:
+#                                      invert      - toggles FeatureSettings.InvertScreen (all versions)
+#                                      screenshots - toggles FeatureSettings.Screenshots (all versions)
 #
 # For example, you might have a configuration file in KOBOeReader/.adds/nmi/mystuff like:
 #
diff --git a/src/subsys_c.c b/src/action_c.c
similarity index 64%
rename from src/subsys_c.c
rename to src/action_c.c
index 13a919f..8836ad9 100644
--- a/src/subsys_c.c
+++ b/src/action_c.c
@@ -1,22 +1,22 @@
 #define _GNU_SOURCE // asprintf
 
-#include "subsys_c.h"
+#include "action_c.h"
 #include "util.h"
 
-int nmi_subsys_dbgsyslog(const char *arg, char **err_out) {
+int nmi_action_dbgsyslog(const char *arg, char **err_out) {
     #define NMI_ERR_RET 1
     NMI_LOG("dbgsyslog: %s", arg);
     NMI_RETURN_OK(0);
     #undef NMI_ERR_RET
 }
 
-int nmi_subsys_dbgerror(const char *arg, char **err_out) {
+int nmi_action_dbgerror(const char *arg, char **err_out) {
     #define NMI_ERR_RET 1
     NMI_RETURN_ERR("%s", arg);
     #undef NMI_ERR_RET
 }
 
-int nmi_subsys_kfmon(const char *arg, char **err_out) {
+int nmi_action_kfmon(const char *arg, char **err_out) {
     #define NMI_ERR_RET 1
     NMI_RETURN_ERR("not implemented yet (arg=%s)", arg); // TODO
     #undef NMI_ERR_RET
diff --git a/src/action_c.h b/src/action_c.h
new file mode 100644
index 0000000..7d3ec8c
--- /dev/null
+++ b/src/action_c.h
@@ -0,0 +1,14 @@
+#ifndef NMI_ACTION_C_H
+#define NMI_ACTION_C_H
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+int nmi_action_dbgsyslog(const char *arg, char **err_out);
+int nmi_action_dbgerror(const char *arg, char **err_out);
+int nmi_action_kfmon(const char *arg, char **err_out);
+
+#ifdef __cplusplus
+}
+#endif
+#endif
diff --git a/src/subsys_cc.cc b/src/action_cc.cc
similarity index 97%
rename from src/subsys_cc.cc
rename to src/action_cc.cc
index 106c4b6..e1c0163 100644
--- a/src/subsys_cc.cc
+++ b/src/action_cc.cc
@@ -4,13 +4,13 @@
 #include <stdint.h>
 #include <string.h>
 
-#include "subsys_cc.h"
+#include "action_cc.h"
 #include "util.h"
 
 typedef void Device;
 typedef void Settings;
 
-extern "C" int nmi_subsys_nickelsetting(const char *arg, char **err_out) {
+extern "C" int nmi_action_nickelsetting(const char *arg, char **err_out) {
     #define NMI_ERR_RET 1
 
     Device *(*Device_getCurrentDevice)();
diff --git a/src/action_cc.h b/src/action_cc.h
new file mode 100644
index 0000000..6807dcf
--- /dev/null
+++ b/src/action_cc.h
@@ -0,0 +1,12 @@
+#ifndef NMI_ACTION_CC_H
+#define NMI_ACTION_CC_H
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+int nmi_action_nickelsetting(const char *arg, char **err_out);
+
+#ifdef __cplusplus
+}
+#endif
+#endif
diff --git a/src/config.c b/src/config.c
index 61c370f..6233b60 100644
--- a/src/config.c
+++ b/src/config.c
@@ -5,11 +5,11 @@
 #include <stdlib.h>
 #include <string.h>
 
+#include "action_c.h"
+#include "action_cc.h"
 #include "config.h"
 #include "menu.h"
 #include "util.h"
-#include "subsys_c.h"
-#include "subsys_cc.h"
 
 typedef enum {
     NMI_CONFIG_TYPE_MENU_ITEM = 1,
diff --git a/src/config.h b/src/config.h
index bb5523a..822efc1 100644
--- a/src/config.h
+++ b/src/config.h
@@ -11,7 +11,7 @@ typedef struct nmi_config_t nmi_config_t;
 
 // nmi_config_parse parses the configuration files in /mnt/onboard/.adds/nmi.
 // An error is returned if there are syntax errors, file access errors, or
-// invalid subsystem names for menu_item.
+// invalid action names for menu_item.
 nmi_config_t *nmi_config_parse(char **err_out);
 
 // nmi_config_get_menu gets a malloc'd array of pointers to the menu items
diff --git a/src/init.c b/src/init.c
index d07f9dc..d9daa04 100644
--- a/src/init.c
+++ b/src/init.c
@@ -7,10 +7,10 @@
 #include <string.h>
 #include <unistd.h>
 
+#include "action_c.h"
 #include "config.h"
 #include "failsafe.h"
 #include "menu.h"
-#include "subsys_c.h"
 #include "util.h"
 
 __attribute__((constructor)) void nmi_init() {
@@ -48,10 +48,10 @@ __attribute__((constructor)) void nmi_init() {
         items   = calloc(items_n, sizeof(nmi_menu_item_t*));
         *items  = calloc(items_n, sizeof(nmi_menu_item_t));
     
-        items[0]->loc     = NMI_MENU_LOCATION_MAIN_MENU;
-        items[0]->lbl     = strdup("Config Error");
-        items[0]->arg     = strdup(err);
-        items[0]->execute = nmi_subsys_dbgerror;
+        items[0]->loc = NMI_MENU_LOCATION_MAIN_MENU;
+        items[0]->lbl = strdup("Config Error");
+        items[0]->arg = strdup(err);
+        items[0]->act = nmi_action_dbgerror;
 
         free(err);
     } else if (!(items = nmi_config_get_menu(cfg, &items_n))) {
diff --git a/src/menu.cc b/src/menu.cc
index 5a5b385..21c9286 100644
--- a/src/menu.cc
+++ b/src/menu.cc
@@ -89,7 +89,7 @@ extern "C" MenuTextItem* _nmi_menu_hook(void* _this, QMenu* menu, QString const&
         QObject::connect(action, &QAction::triggered, std::function<void(bool)>([it](bool checked){
             NMI_LOG("Item '%s' pressed...", it->lbl);
             char *err;
-            if (it->execute(it->arg, &err) && err) {
+            if (it->act(it->arg, &err) && err) {
                 NMI_LOG("Got error %s, displaying...", err);
                 ConfirmationDialogFactory_showOKDialog(QString::fromUtf8(it->lbl), QString::fromUtf8(err));
                 free(err);
diff --git a/src/menu.h b/src/menu.h
index 497659f..77af1d2 100644
--- a/src/menu.h
+++ b/src/menu.h
@@ -15,7 +15,7 @@ typedef struct {
     nmi_menu_location_t loc;
     char *lbl;
     char *arg;
-    int (*execute)(const char *arg, char **out_err); // can block, must return 0 on success, nonzero with out_err set to the malloc'd error message on error
+    int (*act)(const char *arg, char **out_err); // can block, must return 0 on success, nonzero with out_err set to the malloc'd error message on error
 } nmi_menu_item_t;
 
 // nmi_menu_hook hooks a dlopen'd libnickel handle to add the specified menus,
diff --git a/src/subsys_c.h b/src/subsys_c.h
deleted file mode 100644
index b04c538..0000000
--- a/src/subsys_c.h
+++ /dev/null
@@ -1,14 +0,0 @@
-#ifndef NMI_SUBSYS_C_H
-#define NMI_SUBSYS_C_H
-#ifdef __cplusplus
-extern "C" {
-#endif
-
-int nmi_subsys_dbgsyslog(const char *arg, char **err_out);
-int nmi_subsys_dbgerror(const char *arg, char **err_out);
-int nmi_subsys_kfmon(const char *arg, char **err_out);
-
-#ifdef __cplusplus
-}
-#endif
-#endif
diff --git a/src/subsys_cc.h b/src/subsys_cc.h
deleted file mode 100644
index 8a5fc80..0000000
--- a/src/subsys_cc.h
+++ /dev/null
@@ -1,12 +0,0 @@
-#ifndef NMI_SUBSYS_CC_H
-#define NMI_SUBSYS_CC_H
-#ifdef __cplusplus
-extern "C" {
-#endif
-
-int nmi_subsys_nickelsetting(const char *arg, char **err_out);
-
-#ifdef __cplusplus
-}
-#endif
-#endif