| 1 |
/*************************************************************************** |
| 2 |
* Copyright (C) 2005-2019 by the FIFE team * |
| 3 |
* http://www.fifengine.net * |
| 4 |
* This file is part of FIFE. * |
| 5 |
* * |
| 6 |
* FIFE is free software; you can redistribute it and/or * |
| 7 |
* modify it under the terms of the GNU Lesser General Public * |
| 8 |
* License as published by the Free Software Foundation; either * |
| 9 |
* version 2.1 of the License, or (at your option) any later version. * |
| 10 |
* * |
| 11 |
* This library is distributed in the hope that it will be useful, * |
| 12 |
* but WITHOUT ANY WARRANTY; without even the implied warranty of * |
| 13 |
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * |
| 14 |
* Lesser General Public License for more details. * |
| 15 |
* * |
| 16 |
* You should have received a copy of the GNU Lesser General Public * |
| 17 |
* License along with this library; if not, write to the * |
| 18 |
* Free Software Foundation, Inc., * |
| 19 |
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA * |
| 20 |
***************************************************************************/ |
| 21 |
|
| 22 |
#ifndef FIFE_VFS_RAW_RAWDATASOURCE_H |
| 23 |
#define FIFE_VFS_RAW_RAWDATASOURCE_H |
| 24 |
|
| 25 |
// Standard C++ library includes |
| 26 |
|
| 27 |
// Platform specific includes |
| 28 |
#include "util/base/fife_stdint.h" |
| 29 |
|
| 30 |
// 3rd party library includes |
| 31 |
|
| 32 |
// FIFE includes |
| 33 |
// These includes are split up in two parts, separated by one empty line |
| 34 |
// First block: files included from the FIFE root src directory |
| 35 |
// Second block: files included from the same folder |
| 36 |
|
| 37 |
namespace FIFE { |
| 38 |
|
| 39 |
/** Abstract baseclass - provides data for RawData |
| 40 |
* |
| 41 |
* RawData uses RawDataSources to access the data - if you want to add support for a new archivetype this is one of |
| 42 |
* the classes you need. |
| 43 |
*/ |
| 44 |
class RawDataSource { |
| 45 |
|
| 46 |
public: |
| 47 |
RawDataSource(); |
| 48 |
virtual ~RawDataSource(); |
| 49 |
|
| 50 |
/** get the complete datasize */ |
| 51 |
virtual uint32_t getSize() const = 0; |
| 52 |
|
| 53 |
/** read data from the source |
| 54 |
* |
| 55 |
* @param buffer the data will be written into buffer |
| 56 |
* @param start the startindex inside the source |
| 57 |
* @param length length bytes will be written into buffer |
| 58 |
*/ |
| 59 |
virtual void readInto(uint8_t* buffer, uint32_t start, uint32_t length) = 0; |
| 60 |
|
| 61 |
}; |
| 62 |
|
| 63 |
} |
| 64 |
|
| 65 |
#endif |