/* 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. * */ #include "common/util.h" #include "common/stack.h" #include "graphics/primitives.h" #include "sci/sci.h" #include "sci/engine/state.h" #include "sci/graphics/cache.h" #include "sci/graphics/coordadjuster.h" #include "sci/graphics/ports.h" #include "sci/graphics/paint16.h" #include "sci/graphics/font.h" #include "sci/graphics/screen.h" #include "sci/graphics/text16.h" namespace Sci { GfxText16::GfxText16(GfxCache *cache, GfxPorts *ports, GfxPaint16 *paint16, GfxScreen *screen) : _cache(cache), _ports(ports), _paint16(paint16), _screen(screen) { init(); } GfxText16::~GfxText16() { } void GfxText16::init() { _font = NULL; _codeFonts = NULL; _codeFontsCount = 0; _codeColors = NULL; _codeColorsCount = 0; } GuiResourceId GfxText16::GetFontId() { return _ports->_curPort->fontId; } GfxFont *GfxText16::GetFont() { if ((_font == NULL) || (_font->getResourceId() != _ports->_curPort->fontId)) _font = _cache->getFont(_ports->_curPort->fontId); return _font; } void GfxText16::SetFont(GuiResourceId fontId) { if ((_font == NULL) || (_font->getResourceId() != fontId)) _font = _cache->getFont(fontId); _ports->_curPort->fontId = _font->getResourceId(); _ports->_curPort->fontHeight = _font->getHeight(); } void GfxText16::ClearChar(int16 chr) { if (_ports->_curPort->penMode != 1) return; Common::Rect rect; rect.top = _ports->_curPort->curTop; rect.bottom = rect.top + _ports->_curPort->fontHeight; rect.left = _ports->_curPort->curLeft; rect.right = rect.left + GetFont()->getCharWidth(chr); _paint16->eraseRect(rect); } // This internal function gets called as soon as a '|' is found in a text. It // will process the encountered code and set new font/set color. // Returns textcode character count. int16 GfxText16::CodeProcessing(const char *&text, GuiResourceId orgFontId, int16 orgPenColor, bool doingDrawing) { const char *textCode = text; int16 textCodeSize = 0; char curCode; signed char curCodeParm; // Find the end of the textcode while ((++textCodeSize) && (*text != 0) && (*text++ != 0x7C)) { } // possible TextCodes: // c -> sets textColor to current port pen color // cX -> sets textColor to _textColors[X-1] curCode = textCode[0]; curCodeParm = strtol(textCode+1, NULL, 10); if (!Common::isDigit(textCode[1])) { curCodeParm = -1; } switch (curCode) { case 'c': // set text color if (curCodeParm == -1) { _ports->_curPort->penClr = orgPenColor; } else { if (curCodeParm < _codeColorsCount) { _ports->_curPort->penClr = _codeColors[curCodeParm]; } } break; case 'f': // set text font if (curCodeParm == -1) { SetFont(orgFontId); } else { if (curCodeParm < _codeFontsCount) { SetFont(_codeFonts[curCodeParm]); } } break; case 'r': // reference (used in pepper) if (doingDrawing) { if (_codeRefTempRect.top == -1) { // Starting point _codeRefTempRect.top = _ports->_curPort->curTop; _codeRefTempRect.left = _ports->_curPort->curLeft; } else { // End point reached _codeRefTempRect.bottom = _ports->_curPort->curTop + _ports->_curPort->fontHeight; _codeRefTempRect.right = _ports->_curPort->curLeft; _codeRefRects.push_back(_codeRefTempRect); _codeRefTempRect.left = _codeRefTempRect.top = -1; } } break; } return textCodeSize; } // Has actually punctuation and characters in it, that may not be the first in a line // SCI1 didn't check for exclamation nor question marks, us checking for those too shouldn't be bad static const uint16 text16_shiftJIS_punctuation[] = { 0x4181, 0x4281, 0x7681, 0x7881, 0x4981, 0x4881, 0 }; // Table from Quest for Glory 1 PC-98 (SCI01) // has pronunciation and small combining form characters on top (details right after this table) static const uint16 text16_shiftJIS_punctuation_SCI01[] = { 0x9F82, 0xA182, 0xA382, 0xA582, 0xA782, 0xC182, 0xE182, 0xE382, 0xE582, 0xEC82, 0x4083, 0x4283, 0x4483, 0x4683, 0x4883, 0x6283, 0x8383, 0x8583, 0x8783, 0x8E83, 0x9583, 0x9683, 0x5B81, 0x4181, 0x4281, 0x7681, 0x7881, 0x4981, 0x4881, 0 }; // Police Quest 2 (SCI0) only checked for: 0x4181, 0x4281, 0x7681, 0x7881, 0x4981, 0x4881 // Castle of Dr. Brain/King's Quest 5/Space Quest 4 (SCI1) only checked for: 0x4181, 0x4281, 0x7681, 0x7881 // SCI0/SCI01/SCI1: // 0x4181 -> comma, 0x4281 -> period / full stop // 0x7681 -> ending quotation mark, 0x7881 -> secondary quotation mark // SCI0/SCI01: // 0x4981 -> exclamation mark, 0x4881 -> question mark // SCI01 (Quest for Glory only): // 0x9F82, 0xA182, 0xA382, 0xA582, 0xA782 -> specifies vowel part of prev. hiragana char or pronunciation/extension of vowel // 0xC182 -> pronunciation // 0xE182, 0xE382, 0xE582, 0xEC82 -> small combining form of hiragana // 0x4083, 0x4283, 0x4483, 0x4683, 0x4883 -> small combining form of katagana // 0x6283 -> glottal stop / sokuon // 0x8383, 0x8583 0x8783, 0x8E83 -> small combining form of katagana // 0x9583 -> combining form // 0x9683 -> abbreviation for the kanji (ka), the counter for months, places or provisions // 0x5b81 -> low line / underscore (full width) // return max # of chars to fit maxwidth with full words, does not include // breaking space // Also adjusts text pointer to the new position for the caller // // Special cases in games: // Laura Bow 2 - Credits in the game menu - all the text lines start with spaces (bug #5159) // Act 6 Coroner questionaire - the text of all control buttons has trailing spaces // "Detective Ryan Hanrahan O'Riley" contains even more spaces (bug #5334) // Conquests of Camelot - talking with Cobb - one text box of the dialogue contains a longer word, // that will be broken into 2 lines (bug #5159) int16 GfxText16::GetLongest(const char *&textPtr, int16 maxWidth, GuiResourceId orgFontId) { uint16 curChar = 0; const char *textStartPtr = textPtr; const char *lastSpacePtr = NULL; int16 lastSpaceCharCount = 0; int16 curCharCount = 0, resultCharCount = 0; uint16 curWidth = 0, tempWidth = 0; GuiResourceId previousFontId = GetFontId(); int16 previousPenColor = _ports->_curPort->penClr; GetFont(); if (!_font) return 0; for (;;) { curChar = (*(const byte *)textPtr); if (_font->isDoubleByte(curChar)) { curChar |= (*(const byte *)(textPtr + 1)) << 8; } switch (curChar) { case 0x7C: if (getSciVersion() >= SCI_VERSION_1_1) { curCharCount++; textPtr++; curCharCount += CodeProcessing(textPtr, orgFontId, previousPenColor, false); continue; } break; // We need to add 0xD, 0xA and 0xD 0xA to curCharCount and then exit // which means, we split text like for example // - 'Mature, experienced software analyst available.' 0xD 0xA // 'Bug installation a proven speciality. "No version too clean."' (normal game text, this is from lsl2) // - 0xA '-------' 0xA (which is the official sierra subtitle separator) (found in multilingual versions) // Sierra did it the same way. case 0xD: // Check, if 0xA is following, if so include it as well if ((*(const byte *)(textPtr + 1)) == 0xA) { curCharCount++; textPtr++; } // fall through case 0xA: case 0x9781: // this one is used by SQ4/japanese as line break as well (was added for SCI1/PC98) curCharCount++; textPtr++; if (curChar > 0xFF) { // skip another byte in case char is double-byte (PC-98) curCharCount++; textPtr++; } // fall through case 0: SetFont(previousFontId); _ports->penColor(previousPenColor); return curCharCount; case ' ': lastSpaceCharCount = curCharCount; // return count up to (but not including) breaking space lastSpacePtr = textPtr + 1; // remember position right after the current space break; } tempWidth += _font->getCharWidth(curChar); // Width is too large? -> break out if (tempWidth > maxWidth) break; // still fits, remember width curWidth = tempWidth; // go to next character curCharCount++; textPtr++; if (curChar > 0xFF) { // Double-Byte curCharCount++; textPtr++; } } if (lastSpaceCharCount) { // Break and at least one space was found before that resultCharCount = lastSpaceCharCount; // additionally skip over all spaces, that are following that space, but don't count them for displaying purposes textPtr = lastSpacePtr; while (*textPtr == ' ') textPtr++; } else { // Break without spaces found, we split the very first word - may also be Kanji/Japanese if (curChar > 0xFF) { // current charracter is Japanese // PC-9801 SCI actually added the last character, which shouldn't fit anymore, still onto the // screen in case maxWidth wasn't fully reached with the last character if (( maxWidth - 1 ) > curWidth) { curCharCount += 2; textPtr += 2; curChar = (*(const byte *)textPtr); if (_font->isDoubleByte(curChar)) { curChar |= (*(const byte *)(textPtr + 1)) << 8; } } // But it also checked, if the current character is not inside a punctuation table and it even // went backwards in case it found multiple ones inside that table. // Note: PQ2 PC-98 only went back 1 character and not multiple ones uint nonBreakingPos = 0; const uint16 *punctuationTable; if (getSciVersion() != SCI_VERSION_01) { punctuationTable = text16_shiftJIS_punctuation; } else { // Quest for Glory 1 PC-98 only punctuationTable = text16_shiftJIS_punctuation_SCI01; } for (;;) { // Look up if character shouldn't be the first on a new line nonBreakingPos = 0; while (punctuationTable[nonBreakingPos]) { if (punctuationTable[nonBreakingPos] == curChar) break; nonBreakingPos++; } if (!punctuationTable[nonBreakingPos]) { // character is fine break; } // Character is not acceptable, seek backward in the text curCharCount -= 2; textPtr -= 2; if (textPtr < textStartPtr) error("Seeking back went too far, data corruption?"); curChar = (*(const byte *)textPtr); if (!_font->isDoubleByte(curChar)) error("Non double byte while seeking back"); curChar |= (*(const byte *)(textPtr + 1)) << 8; } if (curChar == 0x4081) { // Skip over alphabetic double-byte space // This was introduced for SCI1 // Happens in Castle of Dr. Brain PC-98 in room 120, when looking inside the mirror // (game mentions Mixed Up Fairy Tales and uses English letters for that) textPtr += 2; } } // We split the word in that case resultCharCount = curCharCount; } SetFont(previousFontId); _ports->penColor(previousPenColor); return resultCharCount; } void GfxText16::Width(const char *text, int16 from, int16 len, GuiResourceId orgFontId, int16 &textWidth, int16 &textHeight, bool restoreFont) { uint16 curChar; GuiResourceId previousFontId = GetFontId(); int16 previousPenColor = _ports->_curPort->penClr; textWidth = 0; textHeight = 0; GetFont(); if (_font) { text += from; while (len--) { curChar = (*(const byte *)text++); if (_font->isDoubleByte(curChar)) { curChar |= (*(const byte *)text++) << 8; len--; } switch (curChar) { case 0x0A: case 0x0D: case 0x9781: // this one is used by SQ4/japanese as line break as well textHeight = MAX (textHeight, _ports->_curPort->fontHeight); break; case 0x7C: if (getSciVersion() >= SCI_VERSION_1_1) { len -= CodeProcessing(text, orgFontId, 0, false); break; } default: textHeight = MAX (textHeight, _ports->_curPort->fontHeight); textWidth += _font->getCharWidth(curChar); } } } // When calculating size, we do not restore font because we need the current (code modified) font active // If we are drawing this is called inbetween, so font needs to get restored // If we are calculating size of just one fixed string (::StringWidth), then we need to restore if (restoreFont) { SetFont(previousFontId); _ports->penColor(previousPenColor); } return; } void GfxText16::StringWidth(const Common::String &str, GuiResourceId orgFontId, int16 &textWidth, int16 &textHeight) { Width(str.c_str(), 0, str.size(), orgFontId, textWidth, textHeight, true); } void GfxText16::ShowString(const Common::String &str, GuiResourceId orgFontId, int16 orgPenColor) { Show(str.c_str(), 0, str.size(), orgFontId, orgPenColor); } void GfxText16::DrawString(const Common::String &str, GuiResourceId orgFontId, int16 orgPenColor) { Draw(str.c_str(), 0, str.size(), orgFontId, orgPenColor); } int16 GfxText16::Size(Common::Rect &rect, const char *text, uint16 languageSplitter, GuiResourceId fontId, int16 maxWidth) { GuiResourceId previousFontId = GetFontId(); int16 previousPenColor = _ports->_curPort->penClr; int16 charCount; int16 maxTextWidth = 0, textWidth; int16 totalHeight = 0, textHeight; if (fontId != -1) SetFont(fontId); else fontId = previousFontId; rect.top = rect.left = 0; if (maxWidth < 0) { // force output as single line if (g_sci->getLanguage() == Common::JA_JPN) SwitchToFont900OnSjis(text, languageSplitter); StringWidth(text, fontId, textWidth, textHeight); rect.bottom = textHeight; rect.right = textWidth; } else { // rect.right=found widest line with RTextWidth and GetLongest // rect.bottom=num. lines * GetPointSize rect.right = (maxWidth ? maxWidth : 192); const char *curTextPos = text; // in work position for GetLongest() const char *curTextLine = text; // starting point of current line while (*curTextPos) { // We need to check for Shift-JIS every line if (g_sci->getLanguage() == Common::JA_JPN) SwitchToFont900OnSjis(curTextPos, languageSplitter); charCount = GetLongest(curTextPos, rect.right, fontId); if (charCount == 0) break; Width(curTextLine, 0, charCount, fontId, textWidth, textHeight, false); maxTextWidth = MAX(textWidth, maxTextWidth); totalHeight += textHeight; curTextLine = curTextPos; } rect.bottom = totalHeight; rect.right = maxWidth ? maxWidth : MIN(rect.right, maxTextWidth); } SetFont(previousFontId); _ports->penColor(previousPenColor); return rect.right; } // returns maximum font height used void GfxText16::Draw(const char *text, int16 from, int16 len, GuiResourceId orgFontId, int16 orgPenColor) { uint16 curChar, charWidth; Common::Rect rect; GetFont(); if (!_font) return; rect.top = _ports->_curPort->curTop; rect.bottom = rect.top + _ports->_curPort->fontHeight; text += from; while (len--) { curChar = (*(const byte *)text++); if (_font->isDoubleByte(curChar)) { curChar |= (*(const byte *)text++) << 8; len--; } switch (curChar) { case 0x0A: case 0x0D: case 0: case 0x9781: // this one is used by SQ4/japanese as line break as well break; case 0x7C: if (getSciVersion() >= SCI_VERSION_1_1) { len -= CodeProcessing(text, orgFontId, orgPenColor, true); break; } default: charWidth = _font->getCharWidth(curChar); // clear char if (_ports->_curPort->penMode == 1) { rect.left = _ports->_curPort->curLeft; rect.right = rect.left + charWidth; _paint16->eraseRect(rect); } // CharStd _font->draw(curChar, _ports->_curPort->top + _ports->_curPort->curTop, _ports->_curPort->left + _ports->_curPort->curLeft, _ports->_curPort->penClr, _ports->_curPort->greyedOutput); _ports->_curPort->curLeft += charWidth; } } } // returns maximum font height used void GfxText16::Show(const char *text, int16 from, int16 len, GuiResourceId orgFontId, int16 orgPenColor) { Common::Rect rect; rect.top = _ports->_curPort->curTop; rect.bottom = rect.top + _ports->getPointSize(); rect.left = _ports->_curPort->curLeft; Draw(text, from, len, orgFontId, orgPenColor); rect.right = _ports->_curPort->curLeft; _paint16->bitsShow(rect); } // Draws a text in rect. void GfxText16::Box(const char *text, uint16 languageSplitter, bool show, const Common::Rect &rect, TextAlignment alignment, GuiResourceId fontId) { int16 textWidth, maxTextWidth, textHeight, charCount; int16 offset = 0; int16 hline = 0; GuiResourceId previousFontId = GetFontId(); int16 previousPenColor = _ports->_curPort->penClr; bool doubleByteMode = false; const char *curTextPos = text; const char *curTextLine = text; if (fontId != -1) SetFont(fontId); else fontId = previousFontId; // Reset reference code rects _codeRefRects.clear(); _codeRefTempRect.left = _codeRefTempRect.top = -1; maxTextWidth = 0; while (*curTextPos) { // We need to check for Shift-JIS every line // Police Quest 2 PC-9801 often draws English + Japanese text during the same call if (g_sci->getLanguage() == Common::JA_JPN) { if (SwitchToFont900OnSjis(curTextPos, languageSplitter)) doubleByteMode = true; } charCount = GetLongest(curTextPos, rect.width(), fontId); if (charCount == 0) break; Width(curTextLine, 0, charCount, fontId, textWidth, textHeight, true); maxTextWidth = MAX(maxTextWidth, textWidth); switch (alignment) { case SCI_TEXT16_ALIGNMENT_RIGHT: offset = rect.width() - textWidth; break; case SCI_TEXT16_ALIGNMENT_CENTER: offset = (rect.width() - textWidth) / 2; break; case SCI_TEXT16_ALIGNMENT_LEFT: offset = 0; break; default: warning("Invalid alignment %d used in TextBox()", alignment); } _ports->moveTo(rect.left + offset, rect.top + hline); if (show) { Show(curTextLine, 0, charCount, fontId, previousPenColor); } else { Draw(curTextLine, 0, charCount, fontId, previousPenColor); } hline += textHeight; curTextLine = curTextPos; } SetFont(previousFontId); _ports->penColor(previousPenColor); if (doubleByteMode) { // Kanji is written by pc98 rom to screen directly. Because of // GetLongest() behavior (not cutting off the last char, that causes a // new line), results in the script thinking that the text would need // less space. The coordinate adjustment in fontsjis.cpp handles the // incorrect centering because of that and this code actually shows all // of the chars - if we don't do this, the scripts will only show most // of the chars, but the last few pixels won't get shown most of the // time. Common::Rect kanjiRect = rect; _ports->offsetRect(kanjiRect); kanjiRect.left &= 0xFFC; kanjiRect.right = kanjiRect.left + maxTextWidth; kanjiRect.bottom = kanjiRect.top + hline; kanjiRect.left *= 2; kanjiRect.right *= 2; kanjiRect.top *= 2; kanjiRect.bottom *= 2; _screen->copyDisplayRectToScreen(kanjiRect); } } void GfxText16::DrawString(const Common::String &text) { GuiResourceId previousFontId = GetFontId(); int16 previousPenColor = _ports->_curPort->penClr; Draw(text.c_str(), 0, text.size(), previousFontId, previousPenColor); SetFont(previousFontId); _ports->penColor(previousPenColor); } // we need to have a separate status drawing code // In KQ4 the IV char is actually 0xA, which would otherwise get considered as linebreak and not printed void GfxText16::DrawStatus(const Common::String &str) { uint16 curChar, charWidth; const byte *text = (const byte *)str.c_str(); uint16 textLen = str.size(); Common::Rect rect; GetFont(); if (!_font) return; rect.top = _ports->_curPort->curTop; rect.bottom = rect.top + _ports->_curPort->fontHeight; while (textLen--) { curChar = *text++; switch (curChar) { case 0: break; default: charWidth = _font->getCharWidth(curChar); _font->draw(curChar, _ports->_curPort->top + _ports->_curPort->curTop, _ports->_curPort->left + _ports->_curPort->curLeft, _ports->_curPort->penClr, _ports->_curPort->greyedOutput); _ports->_curPort->curLeft += charWidth; } } } // Sierra did this in their PC98 interpreter only, they identify a text as being // sjis and then switch to font 900 bool GfxText16::SwitchToFont900OnSjis(const char *text, uint16 languageSplitter) { byte firstChar = (*(const byte *)text++); if (languageSplitter != 0x6a23) { // #j prefix as language splitter if (((firstChar >= 0x81) && (firstChar <= 0x9F)) || ((firstChar >= 0xE0) && (firstChar <= 0xEF))) { SetFont(900); return true; } } return false; } reg_t GfxText16::allocAndFillReferenceRectArray() { uint rectCount = _codeRefRects.size(); if (rectCount) { reg_t rectArray; byte *rectArrayPtr = g_sci->getEngineState()->_segMan->allocDynmem(4 * 2 * (rectCount + 1), "text code reference rects", &rectArray); GfxCoordAdjuster16 *coordAdjuster = g_sci->_gfxCoordAdjuster; for (uint curRect = 0; curRect < rectCount; curRect++) { coordAdjuster->kernelLocalToGlobal(_codeRefRects[curRect].left, _codeRefRects[curRect].top); coordAdjuster->kernelLocalToGlobal(_codeRefRects[curRect].right, _codeRefRects[curRect].bottom); WRITE_LE_UINT16(rectArrayPtr + 0, _codeRefRects[curRect].left); WRITE_LE_UINT16(rectArrayPtr + 2, _codeRefRects[curRect].top); WRITE_LE_UINT16(rectArrayPtr + 4, _codeRefRects[curRect].right); WRITE_LE_UINT16(rectArrayPtr + 6, _codeRefRects[curRect].bottom); rectArrayPtr += 8; } WRITE_LE_UINT16(rectArrayPtr + 0, 0x7777); WRITE_LE_UINT16(rectArrayPtr + 2, 0x7777); WRITE_LE_UINT16(rectArrayPtr + 4, 0x7777); WRITE_LE_UINT16(rectArrayPtr + 6, 0x7777); return rectArray; } return NULL_REG; } void GfxText16::kernelTextSize(const char *text, uint16 languageSplitter, int16 font, int16 maxWidth, int16 *textWidth, int16 *textHeight) { Common::Rect rect(0, 0, 0, 0); Size(rect, text, languageSplitter, font, maxWidth); *textWidth = rect.width(); *textHeight = rect.height(); } // Used SCI1+ for text codes void GfxText16::kernelTextFonts(int argc, reg_t *argv) { int i; delete _codeFonts; _codeFontsCount = argc; _codeFonts = new GuiResourceId[argc]; for (i = 0; i < argc; i++) { _codeFonts[i] = (GuiResourceId)argv[i].toUint16(); } } // Used SCI1+ for text codes void GfxText16::kernelTextColors(int argc, reg_t *argv) { int i; delete _codeColors; _codeColorsCount = argc; _codeColors = new uint16[argc]; for (i = 0; i < argc; i++) { _codeColors[i] = argv[i].toUint16(); } } } // End of namespace Sci