change path string into AZ::IO::Path

Signed-off-by: Wojciech Czerski <[email protected]>

Author: w-czerski

Gems/FPSProfiler/Code/Include/FPSProfiler/FPSProfilerBus.h

@@ -52,14 +52,14 @@ namespace FPSProfiler
          * @warning This function is NOT runtime safe. Use @ref SafeChangeSavePath instead.
          * @param newSavePath The new file path where profiling data should be saved.
          */
-        virtual void ChangeSavePath(const AZStd::string& newSavePath) = 0;
+        virtual void ChangeSavePath(const AZ::IO::Path& newSavePath) = 0;
 
         /**
          * @brief Safely changes the save path during runtime.
          * This method stops profiling, saves the current data, and then updates the path.
          * @param newSavePath The new file path where profiling data should be saved.
          */
-        virtual void SafeChangeSavePath(const AZStd::string& newSavePath) = 0;
+        virtual void SafeChangeSavePath(const AZ::IO::Path& newSavePath) = 0;
 
         /**
          * @brief Retrieves the minimum recorded FPS during the profiling session.
@@ -107,7 +107,7 @@ namespace FPSProfiler
          * @param newSavePath The csv file path where the log should be saved.
          * @param useSafeChangePath If true, the function will use @ref SafeChangeSavePath to ensure runtime safety.
          */
-        virtual void SaveLogToFileWithNewPath(const AZStd::string& newSavePath, bool useSafeChangePath) = 0;
+        virtual void SaveLogToFileWithNewPath(const AZ::IO::Path& newSavePath, bool useSafeChangePath) = 0;
 
         /**
          * @brief Enables or disables FPS display on-screen.

Gems/FPSProfiler/Code/Source/Clients/FPSProfilerComponent.cpp

@@ -324,7 +324,7 @@ namespace FPSProfiler
         return m_configRecord.m_RecordStats != Configs::RecordStatistics::None;
     }
 
-    void FPSProfilerComponent::ChangeSavePath(const AZStd::string& newSavePath)
+    void FPSProfilerComponent::ChangeSavePath(const AZ::IO::Path& newSavePath)
     {
         if (!IsPathValid(newSavePath))
         {
@@ -335,7 +335,7 @@ namespace FPSProfiler
         AZ_Warning("FPS Profiler", !m_configDebug.m_PrintDebugInfo && !m_isProfiling, "Path changed during activated profiling.");
     }
 
-    void FPSProfilerComponent::SafeChangeSavePath(const AZStd::string& newSavePath)
+    void FPSProfilerComponent::SafeChangeSavePath(const AZ::IO::Path& newSavePath)
     {
         // If profiling is enabled, save current opened file and stop profiling.
         StopProfiling();
@@ -393,7 +393,7 @@ namespace FPSProfiler
         WriteDataToFile();
     }
 
-    void FPSProfilerComponent::SaveLogToFileWithNewPath(const AZStd::string& newSavePath, bool useSafeChangePath)
+    void FPSProfilerComponent::SaveLogToFileWithNewPath(const AZ::IO::Path& newSavePath, bool useSafeChangePath)
     {
         if (useSafeChangePath)
         {
@@ -485,10 +485,9 @@ namespace FPSProfiler
             char timestamp[20];
             strftime(timestamp, sizeof(timestamp), "%Y%m%d_%H%M%S", &timeInfo);
 
-            AZ::IO::Path logFilePath(m_configFile.m_OutputFilename);
-            logFilePath.ReplaceFilename((logFilePath.Stem().String() + "_" + timestamp + logFilePath.Extension().String()).data());
-
-            m_configFile.m_OutputFilename = logFilePath.c_str();
+            m_configFile.m_OutputFilename.ReplaceFilename(
+                (m_configFile.m_OutputFilename.Stem().String() + "_" + timestamp + m_configFile.m_OutputFilename.Extension().String())
+                    .data());
         }
 
         // Write profiling headers to file
@@ -531,19 +530,17 @@ namespace FPSProfiler
         return static_cast<float>(bytes) / (1024.0f * 1024.0f);
     }
 
-    bool FPSProfilerComponent::IsPathValid(const AZStd::string& path) const
+    bool FPSProfilerComponent::IsPathValid(const AZ::IO::Path& path) const
     {
         AZ::IO::FileIOBase* fileIO = AZ::IO::FileIOBase::GetInstance();
-        AZ::IO::Path pathToValidate(path.c_str());
 
-        if (pathToValidate.empty() || !pathToValidate.HasFilename() || !pathToValidate.HasExtension() || !fileIO ||
-            !fileIO->ResolvePath(pathToValidate))
+        if (path.empty() || !path.HasFilename() || !path.HasExtension() || !fileIO || !fileIO->ResolvePath(path))
         {
-            const char* reason = pathToValidate.empty() ? "Path cannot be empty."
-                : !pathToValidate.HasFilename()         ? "Path must have a file at the end."
-                : !pathToValidate.HasExtension()        ? "Path must have a *.csv extension."
-                : !fileIO                               ? "Could not get a FileIO object. Try again."
-                                                        : "Path is not registered or recognizable by O3DE FileIO System.";
+            const char* reason = path.empty() ? "Path cannot be empty."
+                : !path.HasFilename()         ? "Path must have a file at the end."
+                : !path.HasExtension()        ? "Path must have a *.csv extension."
+                : !fileIO                     ? "Could not get a FileIO object. Try again."
+                                              : "Path is not registered or recognizable by O3DE FileIO System.";
 
             AZ_Warning("FPSProfiler::IsPathValid", !m_configDebug.m_PrintDebugInfo, "%s", reason);
             return false;

Gems/FPSProfiler/Code/Source/Clients/FPSProfilerComponent.h

@@ -45,16 +45,16 @@ namespace FPSProfiler
         void ResetProfilingData() override;
         [[nodiscard]] bool IsProfiling() const override;
         [[nodiscard]] bool IsAnySaveOptionEnabled() const override;
-        void ChangeSavePath(const AZStd::string& newSavePath) override;
-        void SafeChangeSavePath(const AZStd::string& newSavePath) override;
+        void ChangeSavePath(const AZ::IO::Path& newSavePath) override;
+        void SafeChangeSavePath(const AZ::IO::Path& newSavePath) override;
         [[nodiscard]] float GetMinFps() const override;
         [[nodiscard]] float GetMaxFps() const override;
         [[nodiscard]] float GetAvgFps() const override;
         [[nodiscard]] float GetCurrentFps() const override;
         [[nodiscard]] AZStd::pair<AZStd::size_t, AZStd::size_t> GetCpuMemoryUsed() const override;
         [[nodiscard]] AZStd::pair<AZStd::size_t, AZStd::size_t> GetGpuMemoryUsed() const override;
         void SaveLogToFile() override;
-        void SaveLogToFileWithNewPath(const AZStd::string& newSavePath, bool useSafeChangePath) override;
+        void SaveLogToFileWithNewPath(const AZ::IO::Path& newSavePath, bool useSafeChangePath) override;
         void ShowFpsOnScreen(bool enable) override;
 
     public:
@@ -88,7 +88,7 @@ namespace FPSProfiler
         // Utility Functions
         void CalculateFpsData(const float& deltaTime);
         static float BytesToMB(AZStd::size_t bytes);
-        [[nodiscard]] bool IsPathValid(const AZStd::string& path) const;
+        [[nodiscard]] bool IsPathValid(const AZ::IO::Path& path) const;
 
         // Debug Display
         void ShowFps() const;

Gems/FPSProfiler/Code/Source/Configurations/FPSProfilerConfig.h

@@ -40,7 +40,7 @@ namespace FPSProfiler::Configs
         AZ_TYPE_INFO(FileSaveSettings, FPSProfilerConfigFileTypeId);
         static void Reflect(AZ::ReflectContext* context);
 
-        AZStd::string m_OutputFilename = "@user@/fps_log.csv";
+        AZ::IO::Path m_OutputFilename = "@user@/fps_log.csv";
         bool m_AutoSave = true;
         int m_AutoSaveAtFrame = 100;
         bool m_SaveWithTimestamp = true;