Remove dependency to UI, use RAII to handle resources (#1678)

* Remove dependency to UI : removal from solver * Remove dependency to UI : calling the main arguments pre-processing from outside * Remove dependency to UI : removal from analyzer * Remove dependency to UI : replace the dependency to UI in other stand alone targets + correct new target include files paths * Remove dependency to UI : forgot to add header file to repository * Remove dependency to UI : introduce a RAII to automatically destroy the allocated memory * Add & use IntoUTF8ArgsTranslator::convert (#1684) * Add & use IntoUTF8ArgsTranslator::convert * Fix header inclusion * Fix windows build * Fix build * Fix build (bis) * Remove ref to argc, make IntoUTF8ArgsTranslator's API homogenous * Apply clang-format --------- Co-authored-by: Florian Omnès <[email protected]>
AntaresSimulatorTeam · Oct 9, 2023 · c79f00e · c79f00e
1 parent 3b8c7b7
commit c79f00e
Show file tree

Hide file tree

Showing 25 changed files with 122 additions and 105 deletions.
diff --git a/src/analyzer/CMakeLists.txt b/src/analyzer/CMakeLists.txt
@@ -51,6 +51,7 @@ INSTALL(EXPORT antares-analyzer
 target_link_libraries(antares-${ANTARES_PRG_VERSION}-analyzer
 		PRIVATE
 			yuni-static-core
+			Antares::args_helper
 			${CMAKE_THREADS_LIBS_INIT}
 		antares-core #local.h
 		PUBLIC

diff --git a/src/analyzer/main.cpp b/src/analyzer/main.cpp
@@ -28,7 +28,7 @@
 #include <yuni/yuni.h>
 #include <antares/logs/logs.h>
 #include <yuni/core/getopt.h>
-#include "../ui/common/winmain.hxx"
+#include <antares/args/args_to_utf8.h>
 #include <antares/version.h>
 #include "atsp/atsp.h"
 #include <antares/logs/hostinfo.h>
@@ -115,7 +115,8 @@ int main(int argc, char* argv[])
     InitializeDefaultLocale();
 
     logs.applicationName("analyzer");
-    argv = AntaresGetUTF8Arguments(argc, argv);
+    IntoUTF8ArgsTranslator toUTF8ArgsTranslator(argc, argv);
+    std::tie(argc, argv) = toUTF8ArgsTranslator.convert();
 
     String optSettings;
 

diff --git a/src/libs/antares/CMakeLists.txt b/src/libs/antares/CMakeLists.txt
@@ -1,6 +1,7 @@
 
 OMESSAGE("Antares Core library")
 
+add_subdirectory(args)
 add_subdirectory(writer)
 add_subdirectory(memory)
 

diff --git a/src/libs/antares/args/CMakeLists.txt b/src/libs/antares/args/CMakeLists.txt
@@ -0,0 +1,22 @@
+set(SRC_ARGS_HELPER
+        include/antares/args/args_to_utf8.h
+        args_to_utf8.cpp
+)
+
+source_group("misc\\args_helper" FILES ${SRC_ARGS_HELPER})
+
+add_library(args_helper
+        ${SRC_ARGS_HELPER}
+)
+
+add_library(Antares::args_helper ALIAS args_helper)
+
+target_link_libraries(args_helper
+        PRIVATE
+			yuni-static-core
+        )
+
+target_include_directories(args_helper
+        PUBLIC
+        ${CMAKE_CURRENT_SOURCE_DIR}/include
+)
diff --git a/src/libs/antares/args/args_to_utf8.cpp b/src/libs/antares/args/args_to_utf8.cpp
@@ -0,0 +1,44 @@
+
+#include <yuni/yuni.h>
+#include "antares/args/args_to_utf8.h"
+
+#ifdef YUNI_OS_WINDOWS
+#include <string.h>
+#include <cstdlib>
+#ifndef WIN32_LEAN_AND_MEAN
+#define WIN32_LEAN_AND_MEAN 1
+#endif // WIN32_LEAN_AND_MEAN
+#include <windows.h>
+#include <shellapi.h>
+#endif // YUNI_OS_WINDOWS
+
+IntoUTF8ArgsTranslator::IntoUTF8ArgsTranslator(int argc, char** argv) : argc_(argc), argv_(argv)
+{
+}
+
+std::pair<int, char**> IntoUTF8ArgsTranslator::convert()
+{
+#ifdef YUNI_OS_WINDOWS
+    wchar_t** wargv = CommandLineToArgvW(GetCommandLineW(), &argc_);
+    argv_ = (char**)malloc(argc_ * sizeof(char*));
+    for (int i = 0; i != argc_; ++i)
+    {
+        const uint len = (uint)wcslen(wargv[i]);
+        const uint newLen = WideCharToMultiByte(CP_UTF8, 0, wargv[i], len, NULL, 0, NULL, NULL);
+        argv_[i] = (char*)malloc((newLen + 1) * sizeof(char));
+        memset(argv_[i], 0, (newLen + 1) * sizeof(char));
+        WideCharToMultiByte(CP_UTF8, 0, wargv[i], len, argv_[i], newLen, NULL, NULL);
+        argv_[i][newLen] = '\0';
+    }
+#endif
+    return {argc_, argv_};
+}
+
+IntoUTF8ArgsTranslator::~IntoUTF8ArgsTranslator()
+{
+#ifdef YUNI_OS_WINDOWS
+    for (int i = 0; i != argc_; ++i)
+        free(argv_[i]);
+    free(argv_);
+#endif
+}
diff --git a/src/libs/antares/args/include/antares/args/args_to_utf8.h b/src/libs/antares/args/include/antares/args/args_to_utf8.h
@@ -0,0 +1,15 @@
+#pragma once
+
+#include <utility>
+
+class IntoUTF8ArgsTranslator
+{
+public:
+    IntoUTF8ArgsTranslator(int argc, char** argv);
+    std::pair<int, char**> convert();
+    ~IntoUTF8ArgsTranslator();
+
+private:
+    int argc_;
+    char** argv_;
+};
diff --git a/src/solver/CMakeLists.txt b/src/solver/CMakeLists.txt
@@ -74,6 +74,7 @@ add_executable(antares-solver
 set_target_properties(antares-solver PROPERTIES OUTPUT_NAME ${exec_name})
 
 set(ANTARES_SOLVER_LIBS
+	Antares::args_helper
 	Antares::date
 	Antares::benchmarking
 	Antares::result_writer

diff --git a/src/solver/main.cpp b/src/solver/main.cpp
@@ -28,7 +28,7 @@
 
 #include <antares/logs/logs.h>
 #include "application.h"
-#include "../ui/common/winmain.hxx"  //TODO: remove that reverse dependency to UI
+#include <antares/args/args_to_utf8.h>
 
 #include <antares/fatal-error.h>
 #include <antares/memory/memory.h>
@@ -127,15 +127,13 @@ int main(int argc, char** argv)
         InitializeDefaultLocale();
 
         // Getting real UTF8 arguments
-        argv = AntaresGetUTF8Arguments(argc, argv);
-
+        IntoUTF8ArgsTranslator toUTF8ArgsTranslator(argc, argv);
+        std::tie(argc, argv) = toUTF8ArgsTranslator.convert();
         Antares::Solver::Application application;
         application.prepare(argc, argv);
         application.execute();
         application.writeExectutionInfo();
 
-        FreeUTF8Arguments(argc, argv);
-
         // to avoid a bug from wxExecute, we should wait a little before returning
         SuspendMilliSeconds(200 /*ms*/);
 

diff --git a/src/tools/batchrun/CMakeLists.txt b/src/tools/batchrun/CMakeLists.txt
@@ -39,6 +39,7 @@ set(BATCHRUN_LIBS
 		antares-core #local.h
 		yuni-static-core
 		${CMAKE_THREADS_LIBS_INIT}
+		Antares::args_helper
 		Antares::study
 )
 

diff --git a/src/tools/batchrun/main.cpp b/src/tools/batchrun/main.cpp
@@ -35,7 +35,7 @@
 #include <yuni/core/string.h>
 #include <yuni/core/getopt.h>
 #include <antares/study/finder.h>
-#include "../../ui/common/winmain.hxx"
+#include <antares/args/args_to_utf8.h>
 #include <antares/version.h>
 #include <antares/locale.h>
 #ifdef YUNI_OS_WINDOWS
@@ -78,8 +78,8 @@ int main(int argc, char* argv[])
     InitializeDefaultLocale();
 
     logs.applicationName("batchrun");
-    argv = AntaresGetUTF8Arguments(argc, argv);
-
+    IntoUTF8ArgsTranslator toUTF8ArgsTranslator(argc, argv);
+    std::tie(argc, argv) = toUTF8ArgsTranslator.convert();
     // Initializing the toolbox
     Antares::Resources::Initialize(argc, argv, true);
 

diff --git a/src/tools/cleaner/CMakeLists.txt b/src/tools/cleaner/CMakeLists.txt
@@ -26,6 +26,7 @@ INSTALL(EXPORT antares-study-cleaner
 
 set(CLEANER_LIBS
 	yuni-static-core
+	Antares::args_helper
 	Antares::study
 	Antares::sys
 	antares-core #version.h

diff --git a/src/tools/cleaner/main.cpp b/src/tools/cleaner/main.cpp
@@ -28,7 +28,7 @@
 #include <antares/logs/logs.h>
 #include <antares/study/finder.h>
 #include <yuni/core/getopt.h>
-#include "../../ui/common/winmain.hxx"
+#include <antares/args/args_to_utf8.h>
 #include <antares/utils/utils.h>
 #include <antares/study/cleaner.h>
 #include <antares/version.h>
@@ -97,8 +97,8 @@ int main(int argc, char* argv[])
     InitializeDefaultLocale();
 
     Antares::logs.applicationName("cleaner");
-    argv = AntaresGetUTF8Arguments(argc, argv);
-
+    IntoUTF8ArgsTranslator toUTF8ArgsTranslator(argc, argv);
+    std::tie(argc, argv) = toUTF8ArgsTranslator.convert();
     String::Vector optInput;
     bool optPrintOnly = false;
     bool optMrProper = false;

diff --git a/src/tools/config/CMakeLists.txt b/src/tools/config/CMakeLists.txt
@@ -30,6 +30,7 @@ INSTALL(EXPORT antares-config
 
 set(CONFIG_LIBS
 		yuni-static-core
+		Antares::args_helper
 		${CMAKE_THREADS_LIBS_INIT}
 )
 

diff --git a/src/tools/config/main.cpp b/src/tools/config/main.cpp
@@ -29,7 +29,7 @@
 #include <antares/resources/resources.h>
 #include <iostream>
 #include <yuni/core/getopt.h>
-#include "../../ui/common/winmain.hxx"
+#include <antares/args/args_to_utf8.h>
 #include <antares/version.h>
 #include <yuni/core/system/username.h>
 #include <antares/locale.h>
@@ -44,8 +44,8 @@ int main(int argc, char* argv[])
     InitializeDefaultLocale();
 
     logs.applicationName("config");
-    argv = AntaresGetUTF8Arguments(argc, argv);
-
+    IntoUTF8ArgsTranslator toUTF8ArgsTranslator(argc, argv);
+    std::tie(argc, argv) = toUTF8ArgsTranslator.convert();
     // Initializing the toolbox
     Antares::Resources::Initialize(argc, argv, true);
 

diff --git a/src/tools/finder/CMakeLists.txt b/src/tools/finder/CMakeLists.txt
@@ -28,6 +28,7 @@ INSTALL(EXPORT antares-study-finder
 set(FINDER_LIBS
 	antares-core
 	yuni-static-core
+	Antares::args_helper
 	${CMAKE_THREADS_LIBS_INIT}
 )
 

diff --git a/src/tools/finder/main.cpp b/src/tools/finder/main.cpp
@@ -28,7 +28,7 @@
 #include <antares/logs/logs.h>
 #include <antares/study/finder.h>
 #include <yuni/core/getopt.h>
-#include "../../ui/common/winmain.hxx"
+#include <antares/args/args_to_utf8.h>
 #include <antares/utils/utils.h>
 #include <antares/version.h>
 #include <antares/locale.h>
@@ -73,8 +73,8 @@ int main(int argc, char* argv[])
     InitializeDefaultLocale();
 
     logs.applicationName("finder");
-    argv = AntaresGetUTF8Arguments(argc, argv);
-
+    IntoUTF8ArgsTranslator toUTF8ArgsTranslator(argc, argv);
+    std::tie(argc, argv) = toUTF8ArgsTranslator.convert();
     Yuni::String::Vector optInput;
     bool optExtra = false;
     bool optCSV = false;

diff --git a/src/tools/updater/CMakeLists.txt b/src/tools/updater/CMakeLists.txt
@@ -26,6 +26,7 @@ INSTALL(EXPORT antares-study-updater
 
 set(UPDATER_LIBS
 		yuni-static-core
+		Antares::args_helper
 		Antares::study
 		Antares::sys
 		antares-core #version.h

diff --git a/src/tools/updater/main.cpp b/src/tools/updater/main.cpp
@@ -29,7 +29,7 @@
 #include <antares/logs/logs.h>
 #include <antares/study/finder.h>
 #include <yuni/core/getopt.h>
-#include "../../ui/common/winmain.hxx"
+#include <antares/args/args_to_utf8.h>
 #include <antares/utils/utils.h>
 #include <antares/study/cleaner.h>
 #include <antares/version.h>
@@ -170,7 +170,8 @@ int main(int argc, char* argv[])
     InitializeDefaultLocale();
 
     logs.applicationName("updater");
-    argv = AntaresGetUTF8Arguments(argc, argv);
+    IntoUTF8ArgsTranslator toUTF8ArgsTranslator(argc, argv);
+    std::tie(argc, argv) = toUTF8ArgsTranslator.convert();
 
     String::Vector optInput;
     bool optCleanup = false;

diff --git a/src/tools/vacuum/CMakeLists.txt b/src/tools/vacuum/CMakeLists.txt
@@ -36,6 +36,7 @@ set(VACUUM_LIBS
 	antares-fswalker
 	yuni-static-core
 	${CMAKE_THREADS_LIBS_INIT}
+	Antares::args_helper
 	Antares::study
 )
 

diff --git a/src/tools/vacuum/main.cpp b/src/tools/vacuum/main.cpp
@@ -35,7 +35,7 @@
 #include <antares/antares.h>
 #include <fswalker/fswalker.h>
 #include <antares/logs/logs.h>
-#include "../../ui/common/winmain.hxx"
+#include <antares/args/args_to_utf8.h>
 #include <antares/version.h>
 #include <antares/locale.h>
 #include "modified-inode.h"
@@ -247,7 +247,8 @@ int main(int argc, char** argv)
     InitializeDefaultLocale();
 
     logs.applicationName("vacuum");
-    argv = AntaresGetUTF8Arguments(argc, argv);
+    IntoUTF8ArgsTranslator toUTF8ArgsTranslator(argc, argv);
+    std::tie(argc, argv) = toUTF8ArgsTranslator.convert();
     String::Vector optInput;
     String::Vector optEachFolderIn;
     uint optMaxDays = 90; // days

diff --git a/src/tools/yby-aggregator/CMakeLists.txt b/src/tools/yby-aggregator/CMakeLists.txt
@@ -48,6 +48,7 @@ INSTALL(EXPORT antares-ybyaggregator
 
 set(YBY_AGGREGATOR_LIBS
 	antares-core #version.h
+	Antares::args_helper
 	Antares::date
 	Antares::logs
 	yuni-static-core

diff --git a/src/tools/yby-aggregator/main.cpp b/src/tools/yby-aggregator/main.cpp
@@ -28,7 +28,7 @@
 #include <yuni/yuni.h>
 #include <antares/logs/logs.h>
 #include <yuni/core/getopt.h>
-#include "../../ui/common/winmain.hxx"
+#include <antares/args/args_to_utf8.h>
 #include <antares/utils/utils.h>
 #include <antares/version.h>
 #include <antares/sys/policy.h>
@@ -602,8 +602,8 @@ int main(int argc, char* argv[])
     if (not memory.initializeTemporaryFolder())
         return EXIT_FAILURE;
 
-    argv = AntaresGetUTF8Arguments(argc, argv);
-
+    IntoUTF8ArgsTranslator toUTF8ArgsTranslator(argc, argv);
+    std::tie(argc, argv) = toUTF8ArgsTranslator.convert();
     // Load the local policy settings
     LocalPolicy::Open();
     LocalPolicy::CheckRootPrefix(argv[0]);