Added tests

Author: ThirtySomething

.gitignore

@@ -74,3 +74,4 @@ Thumbs.db
 ### Added by ThirtySomething
 CMakeLists.txt.user
 build*
+.vscode

CMakeLists.txt

@@ -1,4 +1,4 @@
-# ******************************************************************************
+# *******************************************************************************
 # Copyright (C) 1999 Jim Wanner and the SourceMonitor team.
 #
 # Permission is hereby granted, free of charge, to any person obtaining a
@@ -18,26 +18,31 @@
 # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 # FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
 # DEALINGS IN THE SOFTWARE.
-# ******************************************************************************
+# *******************************************************************************
 
 cmake_minimum_required(VERSION 3.5)
 
 project(SourceMonitorOS LANGUAGES CXX VERSION 0.0.1 DESCRIPTION "SourceMonitor OpenSource")
 
-# ******************************************************************************
+# *******************************************************************************
 # Settings for smcore
-# ******************************************************************************
+# *******************************************************************************
 add_subdirectory(smcore)
 
-# ******************************************************************************
+# *******************************************************************************
 # Settings for smcli
-# ******************************************************************************
+# *******************************************************************************
 add_subdirectory(smcli)
 target_include_directories(smcli PRIVATE smcore)
 
-# ******************************************************************************
+# *******************************************************************************
 # Settings for smgui
-# ******************************************************************************
+# *******************************************************************************
 add_subdirectory(smgui)
 target_include_directories(smgui PRIVATE smcore)
 
+# *******************************************************************************
+# Settings for smtest
+# *******************************************************************************
+add_subdirectory(smtest)
+target_include_directories(smtest PRIVATE smcore)

LICENSE

@@ -1,21 +1,21 @@
 MIT License
 
-Copyright (c) 2022 by Jim Wanner and the SourceMonitor Team
+Copyright (C) 1999 by Jim Wanner and the SourceMonitor team
 
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
+Permission is hereby granted, free of charge, to any person obtaining a
+copy of this software and associated documentation files (the "Software"),
+to deal in the Software without restriction, including without limitation
+the rights to use, copy, modify, merge, publish, distribute, sublicense,
+and/or sell copies of the Software, and to permit persons to whom the
+Software is furnished to do so, subject to the following conditions:
 
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
+The above copyright notice and this permission notice shall be included
+in all copies or substantial portions of the Software.
 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
+OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
+THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+DEALINGS IN THE SOFTWARE.

documentation/history.md

@@ -1,3 +1,18 @@
 # History of SourceMonitorOS
 
-2022-11-12: Start SourceMonitorOS from scratch, initial setup with smgui, smcore and smcli.
+2022-11-23
+
+* Added documentation for settings.
+* Added missing translation feature to smcore.
+* Added subproject for tests, smtest.
+* Improved CMakeLists.txt with details for translation.
+* Enable all compile warnings in CMakeLists.txt files.
+* Uniform header for CMakeLists.txt and source files.
+
+2022-11-20
+
+* Added basic settings object.
+
+2022-11-12
+
+* Start SourceMonitorOS from scratch, initial setup with smgui, smcore and smcli.

documentation/readme.md

@@ -9,8 +9,10 @@ To get an information about the history of SourceMonitorOS, please see [here][fi
 ## Available descriptions
 
 - [Licsense][doc_license]
+- [Settings][doc_settings]
 
 [doc_license]: ./smcore/license.md
+[doc_settings]: ./smcore/settings.md
 [file_history]: ./history.md
 [markdown_github]: https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax
 [qt_help]: https://doc.qt.io/qt-6.2/qthelp-framework.html

documentation/smcore/license.md

@@ -6,14 +6,14 @@ This is a static function to get the license text to display. Actually this is a
 
 This is a functionality of `smcore` and located in `smcore/license.*`.
 
-### API
+### Public API
 
 ```c++
 namespace smos
 {
     namespace smcore
     {
-        class SMLicense
+        class SMCORE_EXPORT SMLicense
         {
         public:
             /**
@@ -22,6 +22,7 @@ namespace smos
              * @return QString
              */
             static QString getLicense(void);
+        }
     }
 }
 ```

documentation/smcore/settings.md

@@ -0,0 +1,79 @@
+# The settings object
+
+There is a need to have persistent settings somewhere. For this is this object. Because of the plattform independency the settings are stored in an [INI file][wiki_ini_file]. This kind of format is supported by [Qts settings object][qt_qsettings].
+
+## Implementation
+
+This is a functionality of `smcore` and located in `smcore/settings.*`.
+
+## Internals
+
+- Section names will be always in uppercase letters.
+- Key names will be always in lowercase letters.
+- For both the class will take care about.
+
+### Public API
+
+```c++
+namespace smos
+{
+    namespace smcore
+    {
+        class SMCORE_EXPORT SMSettings
+        {
+        public:
+            /**
+             * @brief Default constructor
+             *
+             * @param settingsfile Name of settings file
+             */
+            SMSettings(QString settingsfile);
+            /**
+             * @brief Default destructor
+             *
+             */
+            ~SMSettings(void);
+            /**
+             * @brief Load settings from INI file
+             */
+            void settingsLoad(void);
+            /**
+             * @brief Save settings to INI file
+             */
+            void settingsSave(void);
+            /**
+             * @brief Get the absolute path to the logfile
+             *
+             * @return QString The absolute path to the logfile
+             */
+            QString logfileNameGet(void);
+            /**
+             * @brief Set the name (and path) of the logfile
+             *
+             * @param logfileName Name (and path) of the logfile to use
+             */
+            void logfileNameSet(QString logfileName);
+        }
+    }
+}
+```
+
+### Usage
+
+```c++
+#include <settings.h>
+
+smos::smcore::SMSettings settings = smos::smcore::SMSettings("smos_core.ini");
+
+QString logfileOld = settings.logfileNameGet();
+settings.logfileNameSet("logfilenew.log");
+```
+
+## Possible issues
+
+This object could be a [singleton][wiki_singleton]. But the intention is to create an instance at the top most level and then [inject][wiki_dependency_injection] it into the core.
+
+[qt_qsettings]: https://doc.qt.io/qt-6.2/qsettings.html
+[wiki_dependency_injection]: https://en.wikipedia.org/wiki/Dependency_injection
+[wiki_ini_file]: https://en.wikipedia.org/wiki/INI_file
+[wiki_singleton]: https://en.wikipedia.org/wiki/Singleton_pattern

readme.md

@@ -17,6 +17,12 @@ _A journey of a thousand miles begins with a single step. - Laotse_
 - License: [MIT][licensemit]
 - Framework: [QT][qt] in verison 6.2 LTS
 
+## Required skills
+
+To support the project there is a need of at least one of the listed skills.
+
+[![My Skills](https://skillicons.dev/icons?i=cpp,cmake,git,github,githubactions,md,qt)](https://skillicons.dev)
+
 ## Project folder organization
 
 Allthough there are CMake files existing up to know you need to run them using QT Creator.
@@ -25,6 +31,7 @@ Allthough there are CMake files existing up to know you need to run them using Q
 - In the folder [smcli][folder_smcli] you can find the command line client of SourceMonitorOS
 - In the folder [smcore][folder_smcore] you can find the core functionality of SourceMonitorOS
 - In the folder [smgui][folder_smgui] you can find the UI of SourceMonitorOS
+- In the folder [smtest][folder_smtest] you can find the tests of at least the [smcore][folder_smcore].
 
 [campwoodsw]: https://www.campwoodsw.com/sourcemonitor.html
 [cmake]: https://www.cmake.org
@@ -33,6 +40,7 @@ Allthough there are CMake files existing up to know you need to run them using Q
 [folder_smcli]: ./smcli/readme.md
 [folder_smcore]: ./smcore/readme.md
 [folder_smgui]: ./smgui/readme.md
+[folder_smtest]: ./smtest/readme.md^
 [licensemit]: https://opensource.org/licenses/MIT
 [qt]: https://www.qt.io/
 [wannerjim]: https://campwoodsw.com/emcomp/about-us/

smcli/.gitignore

@@ -1,4 +1,4 @@
-# ******************************************************************************
+# *******************************************************************************
 # Copyright (C) 1999 Jim Wanner and the SourceMonitor team.
 #
 # Permission is hereby granted, free of charge, to any person obtaining a
@@ -18,7 +18,7 @@
 # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 # FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
 # DEALINGS IN THE SOFTWARE.
-# ******************************************************************************
+# *******************************************************************************
 
 cmake_minimum_required(VERSION 3.5)
 
@@ -36,20 +36,27 @@ set(CMAKE_CXX_STANDARD_REQUIRED ON)
 find_package(QT NAMES Qt6 Qt5 REQUIRED COMPONENTS Core LinguistTools)
 find_package(Qt${QT_VERSION_MAJOR} REQUIRED COMPONENTS Core LinguistTools)
 
-set(TS_FILES smcli_en_150.ts)
+set(SMCLI_TS_FILES
+    smcli_en_150.ts
+)
 
 add_executable(smcli
     main.cpp
-    ${TS_FILES}
+    ${SMCLI_TS_FILES}
     ${SMCORE_INCLUDE}
 )
+
+target_compile_options(smcli PRIVATE
+  $<$<CXX_COMPILER_ID:MSVC>:/W4 /WX>
+  $<$<NOT:$<CXX_COMPILER_ID:MSVC>>:-Wall -Wextra -Wpedantic -Werror>
+)
+
 target_link_libraries(smcli Qt${QT_VERSION_MAJOR}::Core smcore)
 
 if(COMMAND qt_create_translation)
-    qt_create_translation(QM_FILES ${CMAKE_SOURCE_DIR} ${TS_FILES})
-else()
-    qt5_create_translation(QM_FILES ${CMAKE_SOURCE_DIR} ${TS_FILES})
+    qt_create_translation(QM_FILES ${CMAKE_SOURCE_DIR} ${SMCLI_TS_FILES})
 endif()
 
-install(TARGETS smcli
-    LIBRARY DESTINATION ${CMAKE_INSTALL_LIBDIR})
+install(TARGETS smcli LIBRARY DESTINATION ${CMAKE_INSTALL_LIBDIR})
+
+qt_finalize_executable(smcli)

smcli/CMakeLists.txt

@@ -1,4 +1,4 @@
-//***************************************************************************
+//******************************************************************************
 // Copyright (C) 1999 Jim Wanner and the SourceMonitor team.
 //
 // Permission is hereby granted, free of charge, to any person obtaining a
@@ -18,7 +18,7 @@
 // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 // FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
 // DEALINGS IN THE SOFTWARE.
-//***************************************************************************
+//******************************************************************************
 
 #include <QCoreApplication>
 #include <QLocale>
@@ -42,7 +42,5 @@ int main(int argc, char *argv[])
         }
     }
 
-    QString license = smos::smcore::SMLicense::getLicense();
-
     return a.exec();
 }