/
dehreader.h
54 lines (48 loc) · 2.05 KB
/
dehreader.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
/** @file dehreader.h DeHackEd patch parser.
*
* Parses DeHackEd patches and updates the engine's definition databases.
*
* @ingroup dehreader
*
* @authors Copyright © 2013-2014 Daniel Swanson <danij@dengine.net>
* @authors Copyright © 2012-2014 Jaakko Keränen <jaakko.keranen@iki.fi>
*
* @par License
* GPL: http://www.gnu.org/licenses/gpl.html
*
* <small>This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by the
* Free Software Foundation; either version 2 of the License, or (at your
* option) any later version. This program is distributed in the hope that it
* will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty
* of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General
* Public License for more details. You should have received a copy of the GNU
* General Public License along with this program; if not, write to the Free
* Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
* 02110-1301 USA</small>
*/
#ifndef LIBDEHREAD_DEHREADER_H
#define LIBDEHREAD_DEHREADER_H
#include "importdeh.h"
#include <de/Block>
/// Maximum number of nested patch file inclussions. Set to zero to disable.
#define DEHREADER_INCLUDE_DEPTH_MAX 2
/// Flags used with @see readDehPatch() to alter read behavior.
enum DehReaderFlag
{
NoInclude = 0x1, ///< Including of other patch files is disabled.
NoText = 0x2, ///< Ignore Text patches.
IgnoreEOF = 0x4 ///< Ignore unexpected EOF characters in patches.
};
Q_DECLARE_FLAGS(DehReaderFlags, DehReaderFlag)
Q_DECLARE_OPERATORS_FOR_FLAGS(DehReaderFlags)
/**
* Parses a text stream as a DeHackEd patch and updates the engine's definition
* databases accordingly.
*
* @param patch DeHackEd patch to parse.
* @param patchIsCustom Source of the patch data is a user-supplied add-on
* @param flags @ref DehReaderFlags
*/
void readDehPatch(de::Block const &patch, bool patchIsCustom, DehReaderFlags flags = 0);
#endif // LIBDEHREAD_DEHREADER_H