File: autotext.cpp

package info (click to toggle)
scummvm 2.9.1%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 450,580 kB
  • sloc: cpp: 4,299,825; asm: 28,322; python: 12,901; sh: 11,302; java: 9,289; xml: 7,895; perl: 2,639; ansic: 2,465; yacc: 1,670; javascript: 1,020; makefile: 933; lex: 578; awk: 275; objc: 82; sed: 11; php: 1
file content (205 lines) | stat: -rw-r--r-- 6,427 bytes parent folder | download | duplicates (2)
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
/* 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 3 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, see <http://www.gnu.org/licenses/>.
 *
 */

#include "engines/nancy/action/autotext.h"
#include "engines/nancy/state/scene.h"

#include "engines/nancy/util.h"
#include "engines/nancy/graphics.h"
#include "engines/nancy/nancy.h"
#include "engines/nancy/resource.h"

namespace Nancy {
namespace Action {

void Autotext::readData(Common::SeekableReadStream &stream) {
	_transparency = stream.readUint16LE();
	_surfaceID = stream.readUint16LE();
	_fontID = stream.readUint16LE();
	_defaultTextColor = stream.readUint16LE();
	_offset.x = stream.readUint16LE();
	_offset.y = stream.readUint16LE();
	_surfWidth = stream.readUint16LE();
	_surfHeight = stream.readUint16LE();

	Common::Path imageName;
	readFilename(stream, imageName);

	uint16 numImages = stream.readUint16LE();
	if (numImages) {
		for (uint i = 0; i < numImages; ++i) {
			uint16 line = stream.readUint16LE();
			Common::Rect src;
			readRect(stream, src);
			addImage(line, src);
		}

		setImageName(imageName);
	}
	stream.skip((5 - numImages) * (2 + 16));

	readExtraData(stream);
}

void Autotext::readExtraData(Common::SeekableReadStream &stream) {
	_useAutotextChunk = stream.readByte();
	readFilename(stream, _textKey);

	uint sizeText = stream.readUint16LE();

	if (sizeText) {
		char *buf = new char[sizeText];
		stream.read(buf, sizeText);
		assembleTextLine(buf, _embeddedText, sizeText);
		delete[] buf;
	}
}

void Autotext::execute() {
	g_nancy->_resource->loadImage(_imageName, _image);

	if (_surfaceID > 2) {
		// Surfaces 3+ are journal surfaces, and their text contents are saved. Texts MUST be in CONVO chunk,
		// so we do not check _useAutotextChunk
		Nancy::JournalData *journalData = (Nancy::JournalData *)NancySceneState.getPuzzleData(Nancy::JournalData::getTag());
		assert(journalData);
		const CVTX *autotext = (const CVTX *)g_nancy->getEngineData("AUTOTEXT");
		assert(autotext);

		if (g_nancy->getGameType() == kGameTypeNancy7) {
			// In nancy7 ONLY, ids 6, 7 & 8 mean LIFO ordering for a suface
			if (_surfaceID > 5) {
				_order = kListLIFO;
				_surfaceID -= 3;
			}
		}

		Common::String stringToPush;
		auto &entriesForSurface = journalData->journalEntries[_surfaceID];
		bool foundThisKey = false;
		for (auto &entry : entriesForSurface) {
			Common::String &stringID = entry.stringID;
			Common::String withTags = autotext->texts[stringID];

			if (entry.mark % 10) {
				withTags = Common::String::format("<%u>", entry.mark % 10) + withTags;
			}

			bool hasHotspot = false;

			if (entry.mark >= 10 && entry.sceneID != kNoScene) {
				// The original engine uses tags <H#> and <L>
				withTags = "<H>" + withTags + "<L>";
				hasHotspot = true;
			}

			if (_order == kListFIFO) {
				// Add to end of string
				stringToPush += withTags;

				if (hasHotspot) {
					_hotspotScenes.push_back(entry.sceneID);
				}
			} else {
				// Add to front of string
				stringToPush = withTags + stringToPush;

				if (hasHotspot) {
					_hotspotScenes.insert_at(0, entry.sceneID);
				}
			}

			if (!_textKey.empty() && stringID == _textKey) {
				foundThisKey = true;
			}
		}

		// A text key may not be present in the data (see AutotextEntryList), so do not attempt to add to the list then
		if (!foundThisKey && !_textKey.empty()) {
			// Key inside this Autotext instance wasn't found inside existing list, push it back and add it to string to draw
			if (_order == kListFIFO) {
				// Add to end of string
				stringToPush += autotext->texts[_textKey];
			} else {
				// Add to front of string
				stringToPush = autotext->texts[_textKey] + stringToPush;
			}

			// Entry is always added to end; on-screen ordering happens when reading list
			entriesForSurface.push_back(JournalData::Entry(_textKey));
		}

		addTextLine(stringToPush);
	} else {
		// Surfaces 0-2 have their contents cleared every scene (though we only bother doing so when we need to reuse)
		if (_useAutotextChunk) {
			// We have a key into the AUTOTEXT chunk
			const CVTX *autotext = (const CVTX *)g_nancy->getEngineData("AUTOTEXT");
			assert(autotext);

			addTextLine(autotext->texts[_textKey]);
		} else {
			// We have text embedded inside this Autotext instance
			addTextLine(_embeddedText);
		}
	}

	// A height of zero means the surface doesn't need to be drawn
	if (_surfHeight) {
		// Guesstimate the height of the surface
		uint surfHeight = _textLines[0].size() / 144 * _surfWidth;
		surfHeight = MAX<uint>(surfHeight, _surfHeight + 20);
		Graphics::ManagedSurface &surf = g_nancy->_graphics->getAutotextSurface(_surfaceID);
		Common::Rect &surfBounds = g_nancy->_graphics->getAutotextSurfaceBounds(_surfaceID);
		surf.create(_surfWidth + 1, surfHeight, g_nancy->_graphics->getInputPixelFormat());
		if (_transparency) {
			surf.clear(g_nancy->_graphics->getTransColor());
		}

		_fullSurface.create(surf, surf.getBounds());
		if(_transparency == kPlayOverlayTransparent) {
			_fullSurface.setTransparentColor(g_nancy->_graphics->getTransColor());
		}

		Common::Rect textBounds = surf.getBounds();
		textBounds.left += _offset.x;
		textBounds.top += _offset.y;

		const Font *font = g_nancy->_graphics->getFont(_fontID);
		assert(font);
		uint d = (font->getFontHeight() + 1) / 2 + 1;

		textBounds.top += d + 1;
		textBounds.left += d;

		// Original engine uses a particular value in the TBOX chunk in all
		// text rendering, including Autotext
		auto *tbox = GetEngineData(TBOX);

		drawAllText(textBounds, tbox->leftOffset - textBounds.left, _fontID, _fontID);
		surfBounds = Common::Rect(_fullSurface.w, _drawnTextHeight);
	}

	_isDone = true;
}

} // End of namespace Action
} // End of namespace Nancy