Merge branch 'development' of https://github.com/o3de/o3de into carlitosan/development
chcurran
4 years ago
commit
a244d429c4
@ -0,0 +1,7 @@
|
|||||||
|
<svg width="24" height="33" viewBox="0 0 24 33" fill="none" xmlns="http://www.w3.org/2000/svg">
|
||||||
|
<rect x="5" y="7" width="2" height="12" fill="#808080"/>
|
||||||
|
<rect x="5" y="19" width="2" height="14" fill="#808080"/>
|
||||||
|
<rect x="17" y="16" width="2" height="12" transform="rotate(90 17 16)" fill="#808080"/>
|
||||||
|
<circle cx="6" cy="6" r="2" fill="#808080"/>
|
||||||
|
<circle cx="18" cy="17" r="2" fill="#808080"/>
|
||||||
|
</svg>
|
||||||
|
After Width: | Height: | Size: 398 B |
@ -0,0 +1,5 @@
|
|||||||
|
<svg width="24" height="24" viewBox="0 0 24 24" fill="none" xmlns="http://www.w3.org/2000/svg">
|
||||||
|
<rect x="5" width="2" height="12" fill="grey"/>
|
||||||
|
<rect x="17" y="12" width="2" height="12" transform="rotate(90 17 12)" fill="grey"/>
|
||||||
|
<circle cx="18" cy="13" r="2" fill="grey"/>
|
||||||
|
</svg>
|
||||||
|
After Width: | Height: | Size: 280 B |
@ -0,0 +1,6 @@
|
|||||||
|
<svg width="24" height="26" viewBox="0 0 24 26" fill="none" xmlns="http://www.w3.org/2000/svg">
|
||||||
|
<rect x="5" width="2" height="12" fill="grey"/>
|
||||||
|
<rect x="5" y="14" width="2" height="12" fill="grey"/>
|
||||||
|
<rect x="17" y="12" width="2" height="12" transform="rotate(90 17 12)" fill="grey"/>
|
||||||
|
<circle cx="18" cy="13" r="2" fill="grey"/>
|
||||||
|
</svg>
|
||||||
|
After Width: | Height: | Size: 335 B |
@ -0,0 +1,6 @@
|
|||||||
|
<svg width="24" height="24" viewBox="0 0 24 24" fill="none" xmlns="http://www.w3.org/2000/svg">
|
||||||
|
<rect x="5" y="7" width="2" height="7" fill="#808080"/>
|
||||||
|
<rect x="17" y="12" width="2" height="12" transform="rotate(90 17 12)" fill="#808080"/>
|
||||||
|
<circle cx="6" cy="6" r="2" fill="#808080"/>
|
||||||
|
<circle cx="18" cy="13" r="2" fill="#808080"/>
|
||||||
|
</svg>
|
||||||
|
After Width: | Height: | Size: 339 B |
@ -0,0 +1,200 @@
|
|||||||
|
/*
|
||||||
|
* Copyright (c) Contributors to the Open 3D Engine Project.
|
||||||
|
* For complete copyright and license terms please see the LICENSE at the root of this distribution.
|
||||||
|
*
|
||||||
|
* SPDX-License-Identifier: Apache-2.0 OR MIT
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
|
||||||
|
#include <AzCore/IO/FileReader.h>
|
||||||
|
#include <AzCore/IO/FileIO.h>
|
||||||
|
#include <AzCore/IO/Path/Path.h>
|
||||||
|
|
||||||
|
namespace AZ::IO
|
||||||
|
{
|
||||||
|
FileReader::FileReader() = default;
|
||||||
|
|
||||||
|
FileReader::FileReader(AZ::IO::FileIOBase* fileIoBase, const char* filePath)
|
||||||
|
{
|
||||||
|
Open(fileIoBase, filePath);
|
||||||
|
}
|
||||||
|
|
||||||
|
FileReader::~FileReader()
|
||||||
|
{
|
||||||
|
Close();
|
||||||
|
}
|
||||||
|
|
||||||
|
FileReader::FileReader(FileReader&& other)
|
||||||
|
{
|
||||||
|
AZStd::swap(m_file, other.m_file);
|
||||||
|
AZStd::swap(m_fileIoBase, other.m_fileIoBase);
|
||||||
|
}
|
||||||
|
|
||||||
|
FileReader& FileReader::operator=(FileReader&& other)
|
||||||
|
{
|
||||||
|
// Close the current file and take over other file
|
||||||
|
Close();
|
||||||
|
m_file = AZStd::move(other.m_file);
|
||||||
|
m_fileIoBase = AZStd::move(other.m_fileIoBase);
|
||||||
|
other.m_file = AZStd::monostate{};
|
||||||
|
other.m_fileIoBase = {};
|
||||||
|
|
||||||
|
return *this;
|
||||||
|
}
|
||||||
|
|
||||||
|
bool FileReader::Open(AZ::IO::FileIOBase* fileIoBase, const char* filePath)
|
||||||
|
{
|
||||||
|
// Close file if the FileReader has an instance open
|
||||||
|
Close();
|
||||||
|
|
||||||
|
if (fileIoBase != nullptr)
|
||||||
|
{
|
||||||
|
AZ::IO::HandleType fileHandle;
|
||||||
|
if (fileIoBase->Open(filePath, IO::OpenMode::ModeRead, fileHandle))
|
||||||
|
{
|
||||||
|
m_file = fileHandle;
|
||||||
|
m_fileIoBase = fileIoBase;
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
else
|
||||||
|
{
|
||||||
|
AZ::IO::SystemFile file;
|
||||||
|
if (file.Open(filePath, IO::SystemFile::OpenMode::SF_OPEN_READ_ONLY))
|
||||||
|
{
|
||||||
|
m_file = AZStd::move(file);
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
|
||||||
|
bool FileReader::IsOpen() const
|
||||||
|
{
|
||||||
|
if (auto fileHandle = AZStd::get_if<AZ::IO::HandleType>(&m_file); fileHandle != nullptr)
|
||||||
|
{
|
||||||
|
return *fileHandle != AZ::IO::InvalidHandle;
|
||||||
|
}
|
||||||
|
else if (auto systemFile = AZStd::get_if<AZ::IO::SystemFile>(&m_file); systemFile != nullptr)
|
||||||
|
{
|
||||||
|
return systemFile->IsOpen();
|
||||||
|
}
|
||||||
|
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
|
||||||
|
void FileReader::Close()
|
||||||
|
{
|
||||||
|
if (auto fileHandle = AZStd::get_if<AZ::IO::HandleType>(&m_file); fileHandle != nullptr)
|
||||||
|
{
|
||||||
|
if (AZ::IO::FileIOBase* fileIo = m_fileIoBase; fileIo != nullptr)
|
||||||
|
{
|
||||||
|
fileIo->Close(*fileHandle);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
m_file = AZStd::monostate{};
|
||||||
|
m_fileIoBase = {};
|
||||||
|
}
|
||||||
|
|
||||||
|
auto FileReader::Length() const -> SizeType
|
||||||
|
{
|
||||||
|
if (auto fileHandle = AZStd::get_if<AZ::IO::HandleType>(&m_file); fileHandle != nullptr)
|
||||||
|
{
|
||||||
|
if (SizeType fileSize{}; m_fileIoBase->Size(*fileHandle, fileSize))
|
||||||
|
{
|
||||||
|
return fileSize;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
else if (auto systemFile = AZStd::get_if<AZ::IO::SystemFile>(&m_file); systemFile != nullptr)
|
||||||
|
{
|
||||||
|
return systemFile->Length();
|
||||||
|
}
|
||||||
|
|
||||||
|
return 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
auto FileReader::Read(SizeType byteSize, void* buffer) -> SizeType
|
||||||
|
{
|
||||||
|
if (auto fileHandle = AZStd::get_if<AZ::IO::HandleType>(&m_file); fileHandle != nullptr)
|
||||||
|
{
|
||||||
|
if (SizeType bytesRead{}; m_fileIoBase->Read(*fileHandle, buffer, byteSize, false, &bytesRead))
|
||||||
|
{
|
||||||
|
return bytesRead;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
else if (auto systemFile = AZStd::get_if<AZ::IO::SystemFile>(&m_file); systemFile != nullptr)
|
||||||
|
{
|
||||||
|
return systemFile->Read(byteSize, buffer);
|
||||||
|
}
|
||||||
|
|
||||||
|
return 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
auto FileReader::Tell() const -> SizeType
|
||||||
|
{
|
||||||
|
if (auto fileHandle = AZStd::get_if<AZ::IO::HandleType>(&m_file); fileHandle != nullptr)
|
||||||
|
{
|
||||||
|
if (SizeType fileOffset{}; m_fileIoBase->Tell(*fileHandle, fileOffset))
|
||||||
|
{
|
||||||
|
return fileOffset;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
else if (auto systemFile = AZStd::get_if<AZ::IO::SystemFile>(&m_file); systemFile != nullptr)
|
||||||
|
{
|
||||||
|
return systemFile->Tell();
|
||||||
|
}
|
||||||
|
|
||||||
|
return 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
bool FileReader::Seek(AZ::s64 offset, SeekType type)
|
||||||
|
{
|
||||||
|
if (auto fileHandle = AZStd::get_if<AZ::IO::HandleType>(&m_file); fileHandle != nullptr)
|
||||||
|
{
|
||||||
|
return m_fileIoBase->Seek(*fileHandle, offset, type);
|
||||||
|
}
|
||||||
|
else if (auto systemFile = AZStd::get_if<AZ::IO::SystemFile>(&m_file); systemFile != nullptr)
|
||||||
|
{
|
||||||
|
systemFile->Seek(offset, static_cast<AZ::IO::SystemFile::SeekMode>(type));
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
|
||||||
|
bool FileReader::Eof() const
|
||||||
|
{
|
||||||
|
if (auto fileHandle = AZStd::get_if<AZ::IO::HandleType>(&m_file); fileHandle != nullptr)
|
||||||
|
{
|
||||||
|
return m_fileIoBase->Eof(*fileHandle);
|
||||||
|
}
|
||||||
|
else if (auto systemFile = AZStd::get_if<AZ::IO::SystemFile>(&m_file); systemFile != nullptr)
|
||||||
|
{
|
||||||
|
return systemFile->Eof();
|
||||||
|
}
|
||||||
|
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
|
||||||
|
bool FileReader::GetFilePath(AZ::IO::FixedMaxPath& filePath) const
|
||||||
|
{
|
||||||
|
if (auto fileHandle = AZStd::get_if<AZ::IO::HandleType>(&m_file); fileHandle != nullptr)
|
||||||
|
{
|
||||||
|
AZ::IO::FixedMaxPathString& pathStringRef = filePath.Native();
|
||||||
|
if (m_fileIoBase->GetFilename(*fileHandle, pathStringRef.data(), pathStringRef.capacity()))
|
||||||
|
{
|
||||||
|
pathStringRef.resize_no_construct(AZStd::char_traits<char>::length(pathStringRef.data()));
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
else if (auto systemFile = AZStd::get_if<AZ::IO::SystemFile>(&m_file); systemFile != nullptr)
|
||||||
|
{
|
||||||
|
filePath = systemFile->Name();
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
}
|
||||||
@ -0,0 +1,92 @@
|
|||||||
|
/*
|
||||||
|
* Copyright (c) Contributors to the Open 3D Engine Project.
|
||||||
|
* For complete copyright and license terms please see the LICENSE at the root of this distribution.
|
||||||
|
*
|
||||||
|
* SPDX-License-Identifier: Apache-2.0 OR MIT
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
#pragma once
|
||||||
|
|
||||||
|
#include <AzCore/IO/Path/Path_fwd.h>
|
||||||
|
#include <AzCore/IO/SystemFile.h>
|
||||||
|
#include <AzCore/std/containers/variant.h>
|
||||||
|
|
||||||
|
namespace AZ::IO
|
||||||
|
{
|
||||||
|
class FileIOBase;
|
||||||
|
enum class SeekType : AZ::u32;
|
||||||
|
|
||||||
|
//! Structure which encapsulates delegates File Read operations
|
||||||
|
//! to either the FileIOBase or SystemFile classes based if a FileIOBase* instance has been supplied
|
||||||
|
//! to the FileSystemReader class
|
||||||
|
//! the SettingsRegistry option to use FileIO
|
||||||
|
class FileReader
|
||||||
|
{
|
||||||
|
using HandleType = AZ::u32;
|
||||||
|
using FileHandleType = AZStd::variant<AZStd::monostate, AZ::IO::SystemFile, HandleType>;
|
||||||
|
public:
|
||||||
|
using SizeType = AZ::u64;
|
||||||
|
|
||||||
|
//! Creates FileReader instance in the default state with no file opend
|
||||||
|
FileReader();
|
||||||
|
~FileReader();
|
||||||
|
|
||||||
|
//! Creates a new FileReader instance and attempts to open the file at the supplied path
|
||||||
|
//! Uses the FileIOBase instance if supplied
|
||||||
|
//! @param fileIOBase pointer to fileIOBase instance
|
||||||
|
//! @param null-terminated filePath to open
|
||||||
|
FileReader(AZ::IO::FileIOBase* fileIoBase, const char* filePath);
|
||||||
|
|
||||||
|
//! Takes ownership of the supplied FileReader handle
|
||||||
|
FileReader(FileReader&& other);
|
||||||
|
|
||||||
|
//! Moves ownership of FileReader handle to this instance
|
||||||
|
FileReader& operator=(FileReader&& other);
|
||||||
|
|
||||||
|
//! Opens a File using the FileIOBase instance if non-nullptr
|
||||||
|
//! Otherwise fall back to use SystemFile
|
||||||
|
//! @param fileIOBase pointer to fileIOBase instance
|
||||||
|
//! @param null-terminated filePath to open
|
||||||
|
//! @return true if the File is opened successfully
|
||||||
|
bool Open(AZ::IO::FileIOBase* fileIoBase, const char* filePath);
|
||||||
|
|
||||||
|
//! Returns true if a file is currently open
|
||||||
|
//! @return true if the file is open
|
||||||
|
bool IsOpen() const;
|
||||||
|
|
||||||
|
//! Closes the File
|
||||||
|
void Close();
|
||||||
|
|
||||||
|
//! Retrieve the length of the OpenFile
|
||||||
|
SizeType Length() const;
|
||||||
|
|
||||||
|
//! Attempts to read up to byte size bytes into the supplied buffer
|
||||||
|
//! @param byteSize - Maximum number of bytes to read
|
||||||
|
//! @param buffer - Buffer to read bytes into
|
||||||
|
//! @returns the number of bytes read if the file is open, otherwise 0
|
||||||
|
SizeType Read(SizeType byteSize, void* buffer);
|
||||||
|
|
||||||
|
//! Returns the current file offset
|
||||||
|
//! @returns file offset if the file is open, otherwise 0
|
||||||
|
SizeType Tell() const;
|
||||||
|
|
||||||
|
//! Seeks within the open file to the offset supplied
|
||||||
|
//! @param offset File offset to seek to
|
||||||
|
//! @param type parameter to indicate the reference point to start the seek from
|
||||||
|
//! @returns true if the file is open and the seek succeeded
|
||||||
|
bool Seek(AZ::s64 offset, SeekType type);
|
||||||
|
|
||||||
|
//! Returns true if the file is open and in the EOF state
|
||||||
|
bool Eof() const;
|
||||||
|
|
||||||
|
//! Store the file path of the open file into the output file path parameter
|
||||||
|
//! The filePath reference is left unmodified, if the path was not stored
|
||||||
|
//! @return true if the filePath was stored
|
||||||
|
bool GetFilePath(AZ::IO::FixedMaxPath& filePath) const;
|
||||||
|
|
||||||
|
private:
|
||||||
|
|
||||||
|
FileHandleType m_file;
|
||||||
|
AZ::IO::FileIOBase* m_fileIoBase{};
|
||||||
|
};
|
||||||
|
}
|
||||||
@ -0,0 +1,72 @@
|
|||||||
|
/*
|
||||||
|
* Copyright (c) Contributors to the Open 3D Engine Project.
|
||||||
|
* For complete copyright and license terms please see the LICENSE at the root of this distribution.
|
||||||
|
*
|
||||||
|
* SPDX-License-Identifier: Apache-2.0 OR MIT
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
#include <AzCore/IO/FileReader.h>
|
||||||
|
#include <FileIOBaseTestTypes.h>
|
||||||
|
#include <AzCore/UnitTest/TestTypes.h>
|
||||||
|
|
||||||
|
namespace UnitTest
|
||||||
|
{
|
||||||
|
template <typename FileIOType>
|
||||||
|
class FileReaderTestFixture
|
||||||
|
: public ScopedAllocatorSetupFixture
|
||||||
|
{
|
||||||
|
public:
|
||||||
|
void SetUp() override
|
||||||
|
{
|
||||||
|
if constexpr (AZStd::is_same_v<FileIOType, TestFileIOBase>)
|
||||||
|
{
|
||||||
|
m_fileIo = AZStd::make_unique<TestFileIOBase>();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
void TearDown() override
|
||||||
|
{
|
||||||
|
m_fileIo.reset();
|
||||||
|
}
|
||||||
|
|
||||||
|
protected:
|
||||||
|
AZStd::unique_ptr<AZ::IO::FileIOBase> m_fileIo{};
|
||||||
|
};
|
||||||
|
|
||||||
|
using FileIOTypes = ::testing::Types<void, TestFileIOBase>;
|
||||||
|
|
||||||
|
TYPED_TEST_CASE(FileReaderTestFixture, FileIOTypes);
|
||||||
|
|
||||||
|
TYPED_TEST(FileReaderTestFixture, ConstructorWithFilePath_OpensFileSuccessfully)
|
||||||
|
{
|
||||||
|
AZ::IO::FileReader fileReader(this->m_fileIo.get(), AZ::IO::SystemFile::GetNullFilename());
|
||||||
|
EXPECT_TRUE(fileReader.IsOpen());
|
||||||
|
}
|
||||||
|
|
||||||
|
TYPED_TEST(FileReaderTestFixture, Open_OpensFileSucessfully)
|
||||||
|
{
|
||||||
|
AZ::IO::FileReader fileReader;
|
||||||
|
fileReader.Open(this->m_fileIo.get(), AZ::IO::SystemFile::GetNullFilename());
|
||||||
|
EXPECT_TRUE(fileReader.IsOpen());
|
||||||
|
}
|
||||||
|
|
||||||
|
TYPED_TEST(FileReaderTestFixture, Eof_OnNULDeviceFile_Succeeds)
|
||||||
|
{
|
||||||
|
AZ::IO::FileReader fileReader(this->m_fileIo.get(), AZ::IO::SystemFile::GetNullFilename());
|
||||||
|
EXPECT_TRUE(fileReader.Eof());
|
||||||
|
}
|
||||||
|
|
||||||
|
TYPED_TEST(FileReaderTestFixture, GetFilePath_ReturnsNULDeviceFilename_Succeeds)
|
||||||
|
{
|
||||||
|
AZ::IO::FileReader fileReader(this->m_fileIo.get(), AZ::IO::SystemFile::GetNullFilename());
|
||||||
|
AZ::IO::FixedMaxPath filePath;
|
||||||
|
EXPECT_TRUE(fileReader.GetFilePath(filePath));
|
||||||
|
AZ::IO::FixedMaxPath nulFilename{ AZ::IO::SystemFile::GetNullFilename() };
|
||||||
|
if (this->m_fileIo)
|
||||||
|
{
|
||||||
|
EXPECT_TRUE(this->m_fileIo->ResolvePath(nulFilename, nulFilename));
|
||||||
|
}
|
||||||
|
EXPECT_EQ(nulFilename, filePath);
|
||||||
|
}
|
||||||
|
|
||||||
|
} // namespace UnitTest
|
||||||
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in New Issue