ScummVM API documentation
inputpersistenceblock.h
1 /* ScummVM - Graphic Adventure Engine
2  *
3  * ScummVM is the legal property of its developers, whose names
4  * are too numerous to list here. Please refer to the COPYRIGHT
5  * file distributed with this source distribution.
6  *
7  * This program is free software: you can redistribute it and/or modify
8  * it under the terms of the GNU General Public License as published by
9  * the Free Software Foundation, either version 3 of the License, or
10  * (at your option) any later version.
11  *
12  * This program is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with this program. If not, see <http://www.gnu.org/licenses/>.
19  *
20  */
21 
22 /*
23  * This code is based on Broken Sword 2.5 engine
24  *
25  * Copyright (c) Malte Thiesen, Daniel Queteschiner and Michael Elsdoerfer
26  *
27  * Licensed under GNU GPL v2
28  *
29  */
30 
31 #ifndef SWORD25_INPUTPERSISTENCEBLOCK_H
32 #define SWORD25_INPUTPERSISTENCEBLOCK_H
33 
34 #include "common/array.h"
35 #include "sword25/kernel/common.h"
36 #include "sword25/kernel/persistenceblock.h"
37 
38 namespace Sword25 {
39 
41 public:
42  enum ErrorState {
43  NONE,
44  END_OF_DATA,
45  OUT_OF_SYNC
46  };
47 
48  InputPersistenceBlock(const void *data, uint dataLength, int version);
49  virtual ~InputPersistenceBlock();
50 
51  void read(int16 &value);
52  void read(int32 &value);
53  void read(uint32 &value);
54  void read(float &value);
55  void read(bool &value);
56  void readString(Common::String &value);
57  void readByteArray(Common::Array<byte> &value);
58 
59  bool isGood() const {
60  return _errorState == NONE;
61  }
62  ErrorState getErrorState() const {
63  return _errorState;
64  }
65 
66  int getVersion() const { return _version; }
67 
68 private:
69  bool checkMarker(byte marker);
70  bool checkBlockSize(int size);
71 
72  Common::Array<byte> _data;
74  ErrorState _errorState;
75 
76  int _version;
77 };
78 
79 } // End of namespace Sword25
80 
81 #endif
Definition: str.h:59
Definition: console.h:27
const T * const_iterator
Definition: array.h:55
Definition: inputpersistenceblock.h:40
Definition: persistenceblock.h:38