aboutsummaryrefslogtreecommitdiff
path: root/engines/titanic/true_talk/tt_word.h
blob: 428a3e32297b52051d7abc19be2e3ffe5f96f244 (plain)
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
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
/* ScummVM - Graphic Adventure Engine
 *
 * ScummVM is the legal property of its developers, whose names
 * are too numerous to list here. Please refer to the COPYRIGHT
 * file distributed with this source distribution.
 *
 * 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 Street, Fifth Floor, Boston, MA 02110-1301, USA.
 *
 */

#ifndef TITANIC_TT_WORD_H
#define TITANIC_TT_WORD_H

#include "titanic/support/simple_file.h"
#include "titanic/true_talk/tt_string.h"
#include "titanic/true_talk/tt_synonym.h"

namespace Titanic {

/**
 * Types of words
 */
enum WordClass { 
	WC_UNKNOWN = 0, WC_ACTION = 1, WC_THING = 2, WC_ABSTRACT = 3,
	WC_ARTICLE = 4, WC_CONJUNCTION = 5, WC_PRONOUN = 6,
	WC_PREPOSITION = 7, WC_ADJECTIVE = 8, WC_ADVERB = 9,
	// TODO: These may not actually be part of this enum
	WC_UNK_ACTION = 10,
	WC_ATRANS = 11,		// transfer possession, eg: give/take
	WC_PTRANS = 12,		// physical transfer, eg: go
	WC_PROPEL = 13,		// act of applying a force, eg: hit
	WC_MTRANS = 14,		// mental transfer, eg: see, hear
	WC_BUILD = 15, WC_ATTEND = 16, WC_SPEAK = 17, WC_GRASP = 18,
	WC_MOVE = 19, WC_INGEST = 20, WC_EXPEL = 21, WC_STRANS = 22,
	WC_ISA = 23
};

class TTword {
protected:
	TTstringStatus _status;
	int _field24;
	int _field28;
protected:
	/**
	 * Read in a number
	 */
	uint readNumber(const char *str);

	bool testFileHandle(SimpleFile *file) const { return true; }
	bool testFileHandle(FileHandle resHandle) const;
public:
	TTword *_nextP;
	TTsynonym *_synP;
	TTstring _text;
	WordClass _wordClass;
	int _id;
	uint _tag;
public:
	TTword(const TTstring &str, WordClass wordClass, int val2);
	TTword(const TTword *src);
	virtual ~TTword();

	/**
	 * Delete any following words chained to the word
	 */
	void deleteSiblings();

	/**
	 * Read in a synonym for the given word
	 */
	int readSyn(SimpleFile *file);

	/**
	 * Set a new synonym for the word
	 */
	void setSyn(TTsynonym *synP);

	/**
	 * Set a new synonym string
	 */
	int setSynStr(TTstring &str);

	/**
	 * Returns true if synonyms have been set for the word
	 */
	bool hasSynonyms() const { return _synP != nullptr; }

	/**
	 * Either sets the first synonym for a word, or adds it to an existing one
	 */
	void appendNode(TTsynonym *node);

	/**
	 * Load the word
	 */
	int load(SimpleFile *file, WordClass wordClass);

	/**
	 * Finds a synonym in the word by name, if one exists
	 * @param str		Name to search for
	 * @param dest		Destination synonym instance to copy match into
	 * @returns			Returns true if a match was found
	 */
	bool findSynByName(const TTstring &str, TTsynonym *dest, int mode) const;

	const char *c_str() const { return _text.c_str(); }
	operator const char *() const { return c_str(); }

	/**
	 * Return the text of the word
	 */
	const TTstring getText() { return _text; }

	/**
	 * Compares the word's text to a passed string
	 */
	bool compareTo(const char *str) const;

	/**
	 * Compares the word's text to a passed string
	 */
	bool compareTo(TTstring *str) const {
		return compareTo(str->c_str());
	}

	/**
	 * Return the status of the word
	 */
	TTstringStatus getStatus() const { return _status; }

	/**
	 * Returns true if the word is in a valid state
	 */
	bool isValid() const { return _status == SS_VALID; }

	/**
	 * Return the status of the entire word chain
	 */
	TTstringStatus getChainStatus() const;

	/**
	 * Returns true if the word is of the specified class
	 */
	bool isClass(WordClass wordClass) const { return _wordClass == wordClass; }

	/**
	 * Copy the word and any attached to it
	 */
	TTword *copyWords();

	/**
	 * Creates a copy of the word
	 */
	virtual TTword *copy() const;
	
	virtual bool proc2(int val) const { return false; }
	virtual int proc3() const { return -1; }
	virtual void proc4() {}
	virtual void proc5() {}

	/**
	 * Checks whether the word's tag is a known type
	 */
	virtual bool checkTag() const { return false; }
	
	/**
	 * Compare the word's tag to a given tag value
	 */
	virtual bool compareTagTo(uint tag) const { return false; }

	/**
	 * Return the tag associated with the word
	 */
	virtual uint getTag() const { return 0; }
	
	virtual bool proc9(int val) const { return false; }
	virtual int proc10() const { return 0; }
	virtual void proc11() {}
	virtual bool proc12(int val) const { return false; }
	virtual int proc13() const { return 0; }
	virtual bool proc14(int val) const { return false; }
	virtual int proc15() const { return -1; }
	virtual bool proc16() const { return false; }
	virtual bool proc17() const { return false; }
	virtual bool proc18() const { return false; }
	virtual bool comparePronounTo(int val) const { return false; }
	virtual int proc20() const { return 0; }

	/**
	 * Returns the file associated with the word's first synonym
	 */
	virtual FileHandle getSynFile() const;

	/**
	 * Checks whether the file associated with the word's first
	 * synonym matches the specified file
	 */
	virtual bool checkSynFile(FileHandle file) const;

	/**
	 * Sets the file associated with a synonym
	 */
	virtual void setSynFile(FileHandle file);

	/**
	 * Dumps data associated with the word to file
	 */
	virtual int save(SimpleFile *file) const { return 0; }
};

} // End of namespace Titanic

#endif /* TITANIC_TT_WORD_H */