dialog return codes, cleaning comments, readme

Author: flipcoder

README.md

@@ -211,12 +211,19 @@ The launch instruction is the script that gets called when the user hits Ok (aft
 
 Your app should then read the resultant settings.json file and use a json parser to extract the settings.
 
-## Questions or Feature Requests?
+## Return Codes
+
+Fig gives different return codes based on how the dialog was closed.
+
+- 0: User pressed "Ok" and settings were saved
+- 1: Dialog window closed or "Cancel" button hit
+- 2: Error: Most likely fig failed to load schema
+
+## Questions, Bugs, Feature Requests?
 
 If you have any questions or want to discuss this project, I'm always open for communication.
 
-If you have a feature or pull request, let me know and I may have some tips on how to go
-about implementing it, even if I don't have the time to do so myself.
+Post bugs and feature requests to github issues.  This is a new project so you might run into limitations or issues.
 
 If you find this useful, give it a star on github. Thanks!
 

src/FigApp.cpp

@@ -23,7 +23,7 @@ FigApp :: FigApp(int& argc, char* argv[]):
         m_pSettings = make_shared<Meta>(m_SettingsFn);
     }catch(Error& e){
         QMessageBox::critical(m_pWindow.get(), "Error", "Could not load settings file.");
-        quit();
+        fail();
         goto return_ctor;
     }
 
@@ -32,16 +32,21 @@ FigApp :: FigApp(int& argc, char* argv[]):
         //m_pSchema = make_shared<Schema>(make_shared<Meta>(m_SchemaFn));
     }catch(Error& e){
         QMessageBox::critical(m_pWindow.get(), "Error", "Could not load schema file.");
-        quit();
+        fail();
         goto return_ctor;
     }
 
     m_Title = m_Args.value_or("title", "Settings");
     if(m_pSchema->has(".title"))
         m_Title = m_pSchema->at<string>(".title");
 
-    init();
-    m_Success = true;
+    if(!init()){
+        QMessageBox::critical(m_pWindow.get(), "Error", "Failed to initialize schema.");
+        fail();
+        goto return_ctor;
+    }
+        
+    m_ReturnCode = RC_SUCCESS; // ctor passed, tell main() we didn't fail
 
     return_ctor: {}
 }
@@ -93,19 +98,12 @@ string FigApp :: as_string(const MetaElement& me)
 
 }
 
-void FigApp :: init()
+bool FigApp :: init()
 {
     m_pWindow = make_unique<FigWindow>(this);
 
-    //QPushButton *button1 = new QPushButton("One");
-    //QPushButton *button2 = new QPushButton("Two");
     QVBoxLayout* layout = new QVBoxLayout;
     //layout->setObjectName("layout");
-    //auto widget = new QWidget();
-    //layout->addWidget(button1);
-    //layout->addWidget(button2);
-    //m_pWindow->setLayout(layout);
-    //m_pWindow->setCentralWidget(widget);
 
     if(m_pSchema->has(".icon")){
         auto icon = m_pSchema->at<string>(".icon");
@@ -225,8 +223,7 @@ void FigApp :: init()
             else if(vals)
             {
                 auto box = new QComboBox;
-                box->setObjectName("box");
-                // if values exist, use a combobox
+                //box->setObjectName("box");
                 int j=0;
                 for(auto&& val: *vals){
                     string v = as_string(val);
@@ -329,9 +326,12 @@ void FigApp :: init()
     m_pWindow->setLayout(layout);
     m_pWindow->setWindowTitle(m_Title.c_str());
 
-    load();
+    if(!load())
+        return false;
 
     m_pWindow->show();
+
+    return true;
 }
 
 bool FigApp :: save()
@@ -456,7 +456,7 @@ bool FigApp :: save()
     return not fail;
 }
 
-void FigApp :: load()
+bool FigApp :: load()
 {
     for(auto&& category: *m_pSettings)
     {
@@ -540,6 +540,8 @@ void FigApp :: load()
             }
         }
     }
+    
+    return true;
 }
 
 template<class T>
@@ -652,19 +654,33 @@ void FigApp :: restore_defaults()
 void FigApp :: save_and_quit()
 {
     if(save()){
+        m_ReturnCode = RC_SUCCESS;
         if(m_pSchema->has(".launch")){
             auto launch = m_pSchema->at<string>(".launch");
             if(!QProcess::startDetached(launch.c_str())){
                 string e = string("Unable to launch \"") + launch + "\".";
                 QMessageBox::critical(m_pWindow.get(), "Error", e.c_str());
+                m_ReturnCode = RC_ERROR;
             }
         }
         QApplication::quit();
     }
+    else{
+        // failed save() calls show dialog
+        m_ReturnCode = RC_ERROR;
+        QApplication::quit();
+    }
 }
 
 void FigApp :: quit()
 {
+    m_ReturnCode = RC_CLOSE;
+    QApplication::quit();
+}
+
+void FigApp :: fail()
+{
+    m_ReturnCode = RC_ERROR;
     QApplication::quit();
 }
 

src/FigApp.h

@@ -28,17 +28,26 @@ class FigApp:
         virtual ~FigApp();
 
         bool event(QEvent* event) override;
-        bool failed() const { return not m_Success; }
-        void init();
+        void return_code(int r) { m_ReturnCode=r; } // called from FigApp on window close
+        int return_code() const { return m_ReturnCode; }
+        bool failed() const { return m_ReturnCode != 0; }
+        bool init();
+        void fail();
 
         static std::string as_string(std::shared_ptr<Meta> m, std::string key);
         static std::string as_string(const MetaElement& me);
         bool save();
-        void load();
+        bool load();
 
         template<class T>
         int index_of_meta(std::shared_ptr<Meta>& m, T v);
 
+        enum eReturnCodes {
+            RC_SUCCESS = 0,
+            RC_CLOSE = 1,
+            RC_ERROR = 2
+        };
+
     private Q_SLOTS:
 
         void quit();
@@ -62,7 +71,9 @@ class FigApp:
 
         std::unique_ptr<FigWindow> m_pWindow;
 
-        bool m_Success = false;
+        // this return code is both the ctor result (checked in main)
+        // and the final app return code
+        int m_ReturnCode = RC_ERROR; // start on error, since ctor can fail
 };
 
 #endif

src/FigWindow.cpp

@@ -1,32 +1,18 @@
 #include "FigWindow.h"
+#include "FigApp.h"
 using namespace std;
 
 FigWindow :: FigWindow(FigApp* app):
     m_pApp(app)
 {
-    //m_UI.setupUi(this);
-    //m_UI.taskList->setShowGrid(false);
-    //m_UI.taskList->setContextMenuPolicy(Qt::CustomContextMenu);
-    //connect(
-    //    m_UI.taskList,
-    //    SIGNAL(customContextMenuRequested(const QPoint&)),
-    //    app,
-    //    SLOT(ctxMenu(const QPoint&))
-    //);
-    //show();
 }
 
 FigWindow :: ~FigWindow()
 {
-    
 }
 
 void FigWindow :: closeEvent(QCloseEvent* ev)
 {
-    //if(m_pApp->tray()->isVisible())
-    //{
-    //    hide();
-    //    ev->ignore();
-    //}
+    m_pApp->return_code(FigApp::RC_CLOSE);
 }
 

src/Main.cpp

@@ -6,10 +6,16 @@ using namespace std;
 int main(int argc, char **argv)
 {
     FigApp app(argc, argv);
-
+    
     if(app.failed())
-        return 1;
+        return FigApp::RC_ERROR;
 
-    return app.exec();
+    int r = app.exec();
+
+    int rc = app.return_code();
+    if(rc != 0)
+        return rc;
+
+    return r;
 }