comment to JSON lib and add ML annotation path

Author: Gin

Common/Cpp/Json/JsonTools.cpp

@@ -38,6 +38,8 @@ void string_to_file(const std::string& filename, const std::string& str){
     }
     file.close();
 }
+
+
 std::string file_to_string(const std::string& filename){
     QFile file(QString::fromStdString(filename));
     if (!file.open(QFile::ReadOnly)){
@@ -47,6 +49,16 @@ std::string file_to_string(const std::string& filename){
 }
 
 
+bool file_to_string(const std::string& filename, std::string& content){
+    QFile file(QString::fromStdString(filename));
+    if (!file.open(QFile::ReadOnly)){
+        return false;
+    }
+    content = file.readAll().toStdString();
+    return true;
+}
+
+
 
 
 JsonValue from_nlohmann(const nlohmann::json& json){

Common/Cpp/Json/JsonTools.h

@@ -17,7 +17,11 @@ namespace PokemonAutomation{
 
 
 void string_to_file(const std::string& filename, const std::string& str);
+// Load file from `filename` into a string
+// If unable to open the file, FileException is thrown
 std::string file_to_string(const std::string& filename);
+// Load file from `filename` into a string. Return true if the file can be read successfully 
+bool file_to_string(const std::string& filename, std::string& content);
 
 JsonValue from_nlohmann(const nlohmann::json& json);
 nlohmann::json to_nlohmann(const JsonValue& json);

Common/Cpp/Json/JsonValue.h

@@ -160,7 +160,14 @@ class JsonValue{
     } u;
 };
 
+// Given a string as a raw JSON, parse it into a `JsonValue`.
+// If there is error parsing the JSON, it will not throw exception.
+// The input string is usually loaded directly from a JSON file.
+// You can call JsonTools.h:file_to_string() to load a file as a raw JSON string.
 JsonValue parse_json(const std::string& str);
+// Load file from `filename` and parse it into a `JsonValue`.
+// If unable to open the file, FileException is thrown
+// If there is error parsing the JSON, it will not throw exception.
 JsonValue load_json_file(const std::string& filename);
 
 

SerialPrograms/Source/CommonFramework/Globals.cpp

@@ -200,7 +200,10 @@ const std::string& TRAINING_PATH(){
     return path;
 }
 
-
+const std::string& ML_ANNOTATION_PATH(){
+    static const std::string path = RUNTIME_BASE_PATH() + "DataAnnotation/";
+    return path;
+}
 
 }
 

SerialPrograms/Source/CommonFramework/Globals.h

@@ -60,6 +60,9 @@ const std::string& RESOURCE_PATH();
 // Hold ML training data.
 const std::string& TRAINING_PATH();
 
+// Folder path (end with "/") to hold data annotation for ML labeling programs
+const std::string& ML_ANNOTATION_PATH();
+
 
 enum class ProgramState{
     NOT_READY,