Os::File::open Bounded Inputs

Os/File.cpp

@@ -3,6 +3,7 @@
 // \brief common function implementation for Os::File
 // ======================================================================
 #include <Fw/Types/Assert.hpp>
+#include <Fw/Types/StringUtils.hpp>
 #include <Os/File.hpp>
 #include <algorithm>
 
@@ -48,8 +49,18 @@
 }
 
 File::Status File::open(const CHAR* filepath, File::Mode requested_mode, File::OverwriteType overwrite) {
+    FW_ASSERT(nullptr != filepath);
+    return this->open(filepath, static_cast<FwSizeType>(FW_FIXED_LENGTH_STRING_SIZE + 1), requested_mode, overwrite);
+}
+
+File::Status File::open(const CHAR* filepath, FwSizeType length, File::Mode requested_mode) {
+    return this->open(filepath, length, requested_mode, OverwriteType::NO_OVERWRITE);
+}
+
+File::Status File::open(const CHAR* filepath, FwSizeType length, File::Mode requested_mode, File::OverwriteType overwrite) {
     FW_ASSERT(&this->m_delegate == reinterpret_cast<FileInterface*>(&this->m_handle_storage[0]));
     FW_ASSERT(nullptr != filepath);
+    FW_ASSERT(Fw::StringUtils::string_length(filepath, length) < length);
     FW_ASSERT(File::Mode::OPEN_NO_MODE < requested_mode && File::Mode::MAX_OPEN_MODE > requested_mode);
     FW_ASSERT((0 <= this->m_mode) && (this->m_mode < Mode::MAX_OPEN_MODE));
     FW_ASSERT((0 <= overwrite) && (overwrite < OverwriteType::MAX_OVERWRITE_TYPE));
@@ -68,6 +79,14 @@
     return status;
 }
 
+File::Status File::open(const Fw::StringBase& path, File::Mode requested_mode) {
+    return this->open(path.toChar(), static_cast<FwSizeType>(path.getCapacity()), requested_mode, OverwriteType::NO_OVERWRITE);
+}
+
+File::Status File::open(const Fw::StringBase& path, File::Mode requested_mode, File::OverwriteType overwrite) {
+    return this->open(path.toChar(), static_cast<FwSizeType>(path.getCapacity()), requested_mode, overwrite);
+}
+
 void File::close() {
     FW_ASSERT(&this->m_delegate == reinterpret_cast<FileInterface*>(&this->m_handle_storage[0]));
     FW_ASSERT(this->m_mode < Mode::MAX_OPEN_MODE);

Os/File.hpp

@@ -6,6 +6,7 @@
 #define Os_File_hpp_
 
 #include <Fw/FPrimeBasicTypes.hpp>
+#include <Fw/Types/StringBase.hpp>
 #include <Os/Os.hpp>
 
 // Forward declaration for UTs
@@ -264,6 +265,51 @@ class File final : public FileInterface {
     //!
     Os::FileInterface::Status open(const char* path, Mode mode);
 
+    //! \brief open file with supplied path, bounded length, and mode
+    //!
+    //! Open the file passed in with the given mode. The path length is bounded by `length`.
+    //! Opening files with `OPEN_CREATE` mode will not clobber existing files. Use the overload
+    //! accepting `OverwriteType` to set overwrite flag and clobber existing files.
+    //!
+    //! It is invalid to send `nullptr` as the path.
+    //! It is invalid to supply `mode` as a non-enumerated value.
+    //! It is invalid for the path to not be null-terminated within `length` characters.
+    //!
+    //! \param path: c-string of path to open
+    //! \param length: bound on the path buffer size
+    //! \param mode: file operation mode
+    //! \return: status of the open
+    //!
+    Os::FileInterface::Status open(const char* path, FwSizeType length, Mode mode);
+
+    //! \brief open file with supplied StringBase path and mode
+    //!
+    //! Open the file passed in with the given mode. Opening files with `OPEN_CREATE` mode will not clobber existing
+    //! files. Use the overload accepting `OverwriteType` to set overwrite flag and clobber existing files.
+    //!
+    //! It is invalid to supply `mode` as a non-enumerated value.
+    //!
+    //! \param path: StringBase reference of path to open
+    //! \param mode: file operation mode
+    //! \return: status of the open
+    //!
+    Os::FileInterface::Status open(const Fw::StringBase& path, Mode mode);
+
+    //! \brief open file with supplied StringBase path, mode, and overwrite type
+    //!
+    //! Open the file passed in with the given mode. If overwrite is set to OVERWRITE, then opening files in
+    //! OPEN_CREATE mode will clobber existing files. Set overwrite to NO_OVERWRITE to preserve existing files.
+    //!
+    //! It is invalid to supply `mode` as a non-enumerated value.
+    //! It is invalid to supply `overwrite` as a non-enumerated value.
+    //!
+    //! \param path: StringBase reference of path to open
+    //! \param mode: file operation mode
+    //! \param overwrite: overwrite existing file on create
+    //! \return: status of the open
+    //!
+    Os::FileInterface::Status open(const Fw::StringBase& path, Mode mode, OverwriteType overwrite);
+
     //! \brief read data from this file into supplied buffer bounded by size
     //!
     //! Read data from this file up to the `size` and store it in `buffer`.  This version will
@@ -321,6 +367,26 @@ class File final : public FileInterface {
     //!
     Os::FileInterface::Status open(const char* path, Mode mode, OverwriteType overwrite) override;
 
+    //! \brief open file with supplied path, bounded length, mode, and overwrite type
+    //!
+    //! Open the file passed in with the given mode. The path length is bounded by `length`.
+    //! If overwrite is set to OVERWRITE, then opening files in OPEN_CREATE mode will clobber
+    //! existing files. Set overwrite to NO_OVERWRITE to preserve existing files. This is the
+    //! core open implementation to which all other open overloads delegate.
+    //!
+    //! It is invalid to send `nullptr` as the path.
+    //! It is invalid to supply `mode` as a non-enumerated value.
+    //! It is invalid to supply `overwrite` as a non-enumerated value.
+    //! It is invalid for the path to not be null-terminated within `length` characters.
+    //!
+    //! \param path: c-string of path to open
+    //! \param length: bound on the path buffer size
+    //! \param mode: file operation mode
+    //! \param overwrite: overwrite existing file on create
+    //! \return: status of the open
+    //!
+    Os::FileInterface::Status open(const char* path, FwSizeType length, Mode mode, OverwriteType overwrite);
+
     //! \brief close the file, if not opened then do nothing
     //!
     //! Closes the file, if open. Otherwise this function does nothing. Delegates to the chosen implementation's