2019-11-23 20:27:39 +08:00
|
|
|
/****************************************************************************
|
|
|
|
Copyright (c) 2014-2016 Chukong Technologies Inc.
|
|
|
|
Copyright (c) 2017-2018 Xiamen Yaji Software Co., Ltd.
|
2024-07-11 23:28:31 +08:00
|
|
|
Copyright (c) 2019-present Axmol Engine contributors (see AUTHORS.md).
|
|
|
|
|
2024-06-10 02:25:43 +08:00
|
|
|
https://axmol.dev/
|
2021-12-25 10:04:45 +08:00
|
|
|
|
2019-11-23 20:27:39 +08:00
|
|
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
|
|
of this software and associated documentation files (the "Software"), to deal
|
|
|
|
in the Software without restriction, including without limitation the rights
|
|
|
|
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
|
|
copies of the Software, and to permit persons to whom the Software is
|
|
|
|
furnished to do so, subject to the following conditions:
|
2021-12-25 10:04:45 +08:00
|
|
|
|
2019-11-23 20:27:39 +08:00
|
|
|
The above copyright notice and this permission notice shall be included in
|
|
|
|
all copies or substantial portions of the Software.
|
2021-12-25 10:04:45 +08:00
|
|
|
|
2019-11-23 20:27:39 +08:00
|
|
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
|
|
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
|
|
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
|
|
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
|
|
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
|
|
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
|
|
|
THE SOFTWARE.
|
|
|
|
****************************************************************************/
|
|
|
|
|
2022-07-16 10:43:05 +08:00
|
|
|
#ifndef __AX_BUNDLE_READER_H__
|
|
|
|
#define __AX_BUNDLE_READER_H__
|
2019-11-23 20:27:39 +08:00
|
|
|
|
|
|
|
#include <string>
|
|
|
|
#include <vector>
|
|
|
|
|
2024-05-03 22:15:08 +08:00
|
|
|
#include "base/Object.h"
|
2023-06-11 13:08:08 +08:00
|
|
|
#include "platform/PlatformMacros.h"
|
2024-04-05 14:25:22 +08:00
|
|
|
#include "base/Logging.h"
|
2019-11-23 20:27:39 +08:00
|
|
|
|
2022-07-11 17:50:21 +08:00
|
|
|
NS_AX_BEGIN
|
2019-11-23 20:27:39 +08:00
|
|
|
|
|
|
|
/**
|
|
|
|
* @addtogroup _3d
|
|
|
|
* @{
|
|
|
|
*/
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @brief BundleReader is an interface for reading sequence of bytes.
|
|
|
|
* @js NA
|
|
|
|
* @lua NA
|
|
|
|
*/
|
2024-05-03 22:15:08 +08:00
|
|
|
class BundleReader : public ax::Object
|
2019-11-23 20:27:39 +08:00
|
|
|
{
|
|
|
|
public:
|
|
|
|
/**
|
|
|
|
* Constructor
|
|
|
|
*/
|
|
|
|
BundleReader();
|
2021-12-25 10:04:45 +08:00
|
|
|
|
2019-11-23 20:27:39 +08:00
|
|
|
/**
|
|
|
|
* Destructor
|
|
|
|
*/
|
|
|
|
~BundleReader();
|
2021-12-25 10:04:45 +08:00
|
|
|
|
2019-11-23 20:27:39 +08:00
|
|
|
/**
|
|
|
|
* initialise
|
|
|
|
* @param buffer The data buffer pointer
|
|
|
|
* @param length The data buffer size
|
|
|
|
*/
|
|
|
|
void init(char* buffer, ssize_t length);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Reads an array of elements.
|
|
|
|
*
|
|
|
|
* @param ptr The pointer to the memory to copy into.
|
|
|
|
* The available size should be at least bytes.
|
|
|
|
* @param size The size of each element to be read, in bytes.
|
|
|
|
* @param count The number of elements to read.
|
|
|
|
*
|
|
|
|
* @return The number of elements read.
|
|
|
|
*/
|
|
|
|
ssize_t read(void* ptr, ssize_t size, ssize_t count);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Reads a line from the buffer.
|
|
|
|
*/
|
|
|
|
char* readLine(int num, char* line);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Returns true if the end of the buffer has been reached.
|
|
|
|
*/
|
|
|
|
bool eof();
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Returns the length of the buffer in bytes.
|
|
|
|
*/
|
|
|
|
ssize_t length();
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Returns the position of the file pointer.
|
|
|
|
*/
|
|
|
|
ssize_t tell();
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Sets the position of the file pointer.
|
|
|
|
*/
|
2021-09-05 20:45:32 +08:00
|
|
|
bool seek(int32_t offset, int origin);
|
2019-11-23 20:27:39 +08:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Sets the file pointer at the start of the file.
|
|
|
|
*/
|
|
|
|
bool rewind();
|
|
|
|
|
|
|
|
/**
|
|
|
|
* read binary typed value.
|
|
|
|
*/
|
2021-12-25 10:04:45 +08:00
|
|
|
template <typename T>
|
|
|
|
bool read(T* ptr);
|
|
|
|
template <typename T>
|
|
|
|
bool readArray(unsigned int* length, std::vector<T>* values);
|
2019-11-23 20:27:39 +08:00
|
|
|
|
|
|
|
/**
|
|
|
|
* first read length, then read string text
|
|
|
|
*/
|
|
|
|
std::string readString();
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Read the matrix.
|
|
|
|
* @note the matrix type must be the 4*4 float matrix
|
|
|
|
*/
|
|
|
|
bool readMatrix(float* m);
|
|
|
|
|
|
|
|
private:
|
|
|
|
ssize_t _position;
|
2021-12-25 10:04:45 +08:00
|
|
|
ssize_t _length;
|
2019-11-23 20:27:39 +08:00
|
|
|
char* _buffer;
|
|
|
|
};
|
|
|
|
|
2021-12-25 10:04:45 +08:00
|
|
|
/// @cond
|
2019-11-23 20:27:39 +08:00
|
|
|
|
|
|
|
/**
|
2021-12-25 10:04:45 +08:00
|
|
|
* template read routines
|
|
|
|
*/
|
|
|
|
template <typename T>
|
|
|
|
inline bool BundleReader::read(T* ptr)
|
2019-11-23 20:27:39 +08:00
|
|
|
{
|
|
|
|
return (read(ptr, sizeof(T), 1) == 1);
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
2021-12-25 10:04:45 +08:00
|
|
|
* template function to read array of value.
|
|
|
|
*/
|
|
|
|
template <typename T>
|
|
|
|
inline bool BundleReader::readArray(unsigned int* length, std::vector<T>* values)
|
2019-11-23 20:27:39 +08:00
|
|
|
{
|
|
|
|
if (!read(length))
|
|
|
|
{
|
|
|
|
return false;
|
|
|
|
}
|
2021-12-25 10:04:45 +08:00
|
|
|
|
2019-11-23 20:27:39 +08:00
|
|
|
if (*length > 0 && values)
|
|
|
|
{
|
|
|
|
values->resize(*length);
|
|
|
|
if (read(&(*values)[0], sizeof(T), *length) != *length)
|
|
|
|
{
|
|
|
|
return false;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
return true;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
2021-12-25 10:04:45 +08:00
|
|
|
* specialization for char
|
|
|
|
*/
|
|
|
|
template <>
|
|
|
|
inline bool BundleReader::read<char>(char* ptr)
|
2019-11-23 20:27:39 +08:00
|
|
|
{
|
|
|
|
if (read(ptr, sizeof(char), 1) == 1)
|
|
|
|
{
|
|
|
|
return true;
|
|
|
|
}
|
|
|
|
else
|
|
|
|
{
|
|
|
|
*ptr = -1;
|
|
|
|
return false;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
2021-12-25 10:04:45 +08:00
|
|
|
* specialization for std::string
|
|
|
|
*/
|
|
|
|
template <>
|
2019-11-23 20:27:39 +08:00
|
|
|
inline bool BundleReader::read<std::string>(std::string* /*ptr*/)
|
|
|
|
{
|
2024-07-05 07:51:36 +08:00
|
|
|
AXLOGW("can not read std::string, use readString() instead");
|
2019-11-23 20:27:39 +08:00
|
|
|
return false;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
2021-12-25 10:04:45 +08:00
|
|
|
* template function to read array of value.
|
|
|
|
*/
|
|
|
|
template <>
|
|
|
|
inline bool BundleReader::readArray<std::string>(unsigned int* length, std::vector<std::string>* values)
|
2019-11-23 20:27:39 +08:00
|
|
|
{
|
|
|
|
if (!read(length))
|
|
|
|
{
|
|
|
|
return false;
|
|
|
|
}
|
|
|
|
values->clear();
|
|
|
|
if (*length > 0 && values)
|
|
|
|
{
|
|
|
|
for (int i = 0; i < (int)*length; ++i)
|
|
|
|
{
|
2022-08-08 13:18:33 +08:00
|
|
|
values->emplace_back(readString());
|
2019-11-23 20:27:39 +08:00
|
|
|
}
|
|
|
|
}
|
|
|
|
return true;
|
|
|
|
}
|
|
|
|
|
|
|
|
/// @endcond
|
|
|
|
|
|
|
|
// end of 3d group
|
|
|
|
/// @}
|
|
|
|
|
2022-07-11 17:50:21 +08:00
|
|
|
NS_AX_END
|
2019-11-23 20:27:39 +08:00
|
|
|
|
|
|
|
#endif
|