Core - StorageFile

.gitignore

@@ -1,6 +1,7 @@
 .*/
 build/
 build.nx/
+config/
 *~
 *.bak
 *.nro
@@ -9,3 +10,4 @@ build.nx/
 .vscode
 builddir
 *.dksh
+.DS_Store

demo/main.cpp

@@ -30,6 +30,7 @@
 #include "components_tab.hpp"
 #include "main_activity.hpp"
 #include "recycling_list_tab.hpp"
+#include "storage_file_demo.hpp"
 
 using namespace brls::literals; // for _i18n
 
@@ -60,6 +61,7 @@ int main(int argc, char* argv[])
     brls::Application::registerXMLView("CaptionedImage", CaptionedImage::create);
     brls::Application::registerXMLView("RecyclingListTab", RecyclingListTab::create);
     brls::Application::registerXMLView("ComponentsTab", ComponentsTab::create);
+    brls::Application::registerXMLView("StorageFileDemo", StorageFileDemo::create);
 
     // Add custom values to the theme
     brls::getLightTheme().addColor("captioned_image/caption", nvgRGB(2, 176, 183));

demo/settings_file.hpp

@@ -0,0 +1,29 @@
+/*
+    Copyright 2021 EmreTech
+
+    Licensed under the Apache License, Version 2.0 (the "License");
+    you may not use this file except in compliance with the License.
+    You may obtain a copy of the License at
+
+        http://www.apache.org/licenses/LICENSE-2.0
+
+    Unless required by applicable law or agreed to in writing, software
+    distributed under the License is distributed on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+    See the License for the specific language governing permissions and
+    limitations under the License.
+*/
+#pragma once
+
+#include <borealis.hpp>
+
+struct SettingsFile : public brls::StorageFile
+{
+    BRLS_STORAGE_FILE_INIT(SettingsFile, "settings", "borealis_demo")
+
+    BRLS_STORAGE_BOOL(boolTest, "boolTest");
+    BRLS_STORAGE_STRING(username, "username");
+
+    BRLS_STORAGE_STRING_LIST(favoriteWords, "favoriteWords");
+    BRLS_STORAGE_INT_LIST(coolNumbers, "coolNumbers");
+};

demo/storage_file_demo.cpp

@@ -0,0 +1,82 @@
+/*
+    Copyright 2021 EmreTech
+
+    Licensed under the Apache License, Version 2.0 (the "License");
+    you may not use this file except in compliance with the License.
+    You may obtain a copy of the License at
+
+        http://www.apache.org/licenses/LICENSE-2.0
+
+    Unless required by applicable law or agreed to in writing, software
+    distributed under the License is distributed on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+    See the License for the specific language governing permissions and
+    limitations under the License.
+*/
+
+// Note: This file, it's header counterpart, and any other files relating to the Storage File Demo can be taken down at demand.
+// They are only here for testing purposes.
+
+#include "storage_file_demo.hpp"
+
+StorageFileDemo::StorageFileDemo()
+{
+    this->inflateFromXMLRes("xml/tabs/storage_file.xml");
+
+    BRLS_REGISTER_CLICK_BY_ID("writeData", this->onWriteDataButtonPressed);
+    BRLS_REGISTER_CLICK_BY_ID("readData", this->onReadDataButtonPressed);
+}
+
+bool StorageFileDemo::onWriteDataButtonPressed(brls::View* view)
+{
+    // Clear data in ListStorageObjects to ensure we aren't writting multiple items into the file
+    settings->favoriteWords.getVector().clear();
+    settings->coolNumbers.getVector().clear();
+
+    // Set values
+    settings->boolTest = true;
+    settings->username = "EmreTech";
+    settings->favoriteWords.pushValue("Hello");
+    settings->favoriteWords.pushValue("Watermelon");
+
+    for (int i = 1; i < 11; i++)
+        settings->coolNumbers.pushValue(i);
+
+    // Save
+    settings->boolTest.save();
+    settings->username.save();
+    settings->favoriteWords.save();
+    settings->coolNumbers.save();
+
+    verboseText->setText("Sucessfully written data to the Storage File.");
+
+    return true;
+}
+
+bool StorageFileDemo::onReadDataButtonPressed(brls::View* view)
+{
+    // Read data from the file
+    settings->readFromFile("boolTest", settings->boolTest);
+    settings->readFromFile("username", settings->username);
+    settings->readFromFile("favoriteWords", settings->favoriteWords);
+    settings->readFromFile("coolNumbers", settings->coolNumbers);
+
+    // Print out the values to the user
+    brls::Logger::info("Read from file: boolTest: {}", settings->boolTest.getValue());
+    brls::Logger::info("Read from file: username: {}", settings->username.getValue());
+
+    for (size_t i{0}; i < settings->favoriteWords.size(); i++)
+        brls::Logger::info("Read from file: favoriteWords index #{}: {}", i, settings->favoriteWords.getValue(i));
+
+    for (size_t i{0}; i < settings->coolNumbers.size(); i++)
+        brls::Logger::info("Read from file: coolNumbers index #{}: {}", i, settings->coolNumbers.getValue(i));
+
+    verboseText->setText("Please read the console log for the read data.");
+
+    return true;
+}
+
+brls::View* StorageFileDemo::create()
+{
+    return new StorageFileDemo();
+}

demo/storage_file_demo.hpp

@@ -0,0 +1,41 @@
+/*
+    Copyright 2021 EmreTech
+
+    Licensed under the Apache License, Version 2.0 (the "License");
+    you may not use this file except in compliance with the License.
+    You may obtain a copy of the License at
+
+        http://www.apache.org/licenses/LICENSE-2.0
+
+    Unless required by applicable law or agreed to in writing, software
+    distributed under the License is distributed on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+    See the License for the specific language governing permissions and
+    limitations under the License.
+*/
+
+// Note: This file, it's source counterpart, and any other files relating to the Storage File Demo can be taken down at demand.
+// They are only here for testing purposes.
+
+#pragma once
+
+#include <borealis.hpp>
+#include <iostream>
+#include <string>
+
+#include "settings_file.hpp"
+
+struct StorageFileDemo : public brls::Box
+{
+    StorageFileDemo();
+
+    static brls::View* create();
+
+  private:
+    bool onWriteDataButtonPressed(brls::View* view);
+    bool onReadDataButtonPressed(brls::View* view);
+
+    BRLS_BIND(brls::Label, verboseText, "verboseText");
+
+    SettingsFile *settings = new SettingsFile();
+};

library/include/borealis.hpp

@@ -33,11 +33,13 @@
 #include <borealis/core/input.hpp>
 #include <borealis/core/logger.hpp>
 #include <borealis/core/platform.hpp>
+#include <borealis/core/storage_file.hpp>
 #include <borealis/core/style.hpp>
 #include <borealis/core/task.hpp>
 #include <borealis/core/theme.hpp>
 #include <borealis/core/time.hpp>
 #include <borealis/core/timer.hpp>
+#include <borealis/core/util.hpp>
 #include <borealis/core/video.hpp>
 #include <borealis/core/view.hpp>