/* 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. * * MIT License: * * Copyright (c) 2009 Alexei Svitkine, Eugene Sandulenko * * Permission is hereby granted, free of charge, to any person * obtaining a copy of this software and associated documentation * files (the "Software"), to deal in the Software without * restriction, including without limitation the rights to use, * copy, modify, merge, publish, distribute, sublicense, and/or sell * copies of the Software, and to permit persons to whom the * Software is furnished to do so, subject to the following * conditions: * * The above copyright notice and this permission notice shall be * included in all copies or substantial portions of the Software. * * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES * OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT * HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR * OTHER DEALINGS IN THE SOFTWARE. * */ #include "common/system.h" #include "common/timer.h" #include "common/unzip.h" #include "graphics/cursorman.h" #include "graphics/fonts/bdf.h" #include "graphics/palette.h" #include "wage/wage.h" #include "wage/design.h" #include "wage/entities.h" #include "wage/gui.h" #include "wage/world.h" namespace Wage { enum { kMenuHeight = 20, kMenuPadding = 6, kMenuItemHeight = 20, kBorderWidth = 17, kDesktopArc = 7, kComponentsPadding = 10, kCursorHeight = 12 }; static const byte palette[] = { 0, 0, 0, // Black 0x80, 0x80, 0x80, // Gray 0xff, 0xff, 0xff, // White 0x00, 0xff, 0x00 // Green }; static byte checkersPattern[8] = { 0x55, 0xaa, 0x55, 0xaa, 0x55, 0xaa, 0x55, 0xaa }; static byte fillPattern[8] = { 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff }; static const byte macCursorArrow[] = { 2, 2, 3, 3, 3, 3, 3, 3, 3, 3, 3, 2, 0, 2, 3, 3, 3, 3, 3, 3, 3, 3, 2, 0, 0, 2, 3, 3, 3, 3, 3, 3, 3, 2, 0, 0, 0, 2, 3, 3, 3, 3, 3, 3, 2, 0, 0, 0, 0, 2, 3, 3, 3, 3, 3, 2, 0, 0, 0, 0, 0, 2, 3, 3, 3, 3, 2, 0, 0, 0, 0, 0, 0, 2, 3, 3, 3, 2, 0, 0, 0, 0, 0, 0, 0, 2, 3, 3, 2, 0, 0, 0, 0, 0, 0, 0, 0, 2, 3, 2, 0, 0, 0, 0, 0, 2, 2, 2, 2, 2, 2, 0, 0, 2, 0, 0, 2, 3, 3, 3, 3, 2, 0, 2, 3, 2, 0, 0, 2, 3, 3, 3, 2, 2, 3, 3, 2, 0, 0, 2, 3, 3, 3, 2, 3, 3, 3, 3, 2, 0, 0, 2, 3, 3, 3, 3, 3, 3, 3, 2, 0, 0, 2, 3, 3, 3, 3, 3, 3, 3, 3, 2, 2, 2, 3, 3 }; static const byte macCursorBeam[] = { 0, 0, 3, 3, 3, 0, 0, 3, 3, 3, 3, 3, 3, 0, 3, 0, 3, 3, 3, 3, 3, 3, 3, 3, 3, 0, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 0, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 0, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 0, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 0, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 0, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 0, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 0, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 0, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 0, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 0, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 0, 3, 3, 3, 3, 3, 3, 3, 3, 3, 0, 3, 0, 3, 3, 3, 3, 3, 3, 0, 0, 3, 3, 3, 0, 0, 3, 3, 3, 3, }; static void cursor_timer_handler(void *refCon) { Gui *gui = (Gui *)refCon; int x = gui->_cursorX; int y = gui->_cursorY; if (x == 0 && y == 0) return; if (!gui->_screen.getPixels()) return; x += gui->_consoleTextArea.left; y += gui->_consoleTextArea.top; gui->_screen.vLine(x, y, y + kCursorHeight, gui->_cursorState ? kColorBlack : kColorWhite); if (!gui->_cursorOff) gui->_cursorState = !gui->_cursorState; g_system->copyRectToScreen(gui->_screen.getBasePtr(x, y), gui->_screen.pitch, x, y, 1, kCursorHeight); g_system->updateScreen(); } Gui::Gui(WageEngine *engine) { _engine = engine; _scene = NULL; _sceneDirty = true; _consoleDirty = true; _bordersDirty = true; _menuDirty = true; _consoleFullRedraw = true; _screen.create(g_system->getWidth(), g_system->getHeight(), Graphics::PixelFormat::createFormatCLUT8()); _scrollPos = 0; _consoleLineHeight = 8; // Dummy value which makes sense _consoleNumLines = 24; // Dummy value _builtInFonts = false; _sceneIsActive = false; _cursorX = 0; _cursorY = 0; _cursorState = false; _cursorOff = false; g_system->getPaletteManager()->setPalette(palette, 0, 4); CursorMan.replaceCursorPalette(palette, 0, 4); CursorMan.replaceCursor(macCursorArrow, 11, 16, 1, 1, 3); _cursorIsArrow = true; CursorMan.showMouse(true); loadFonts(); g_system->getTimerManager()->installTimerProc(&cursor_timer_handler, 200000, this, "wageCursor"); } Gui::~Gui() { g_system->getTimerManager()->removeTimerProc(&cursor_timer_handler); } const Graphics::Font *Gui::getFont(const char *name, Graphics::FontManager::FontUsage fallback) { const Graphics::Font *font; if (!_builtInFonts) { font = FontMan.getFontByName(name); if (!font) warning("Cannot load font %s", name); } if (_builtInFonts || !font) font = FontMan.getFontByUsage(fallback); return font; } const Graphics::Font *Gui::getConsoleFont() { char fontName[128]; Scene *scene = _engine->_world->_player->_currentScene; snprintf(fontName, 128, "%s-%d", scene->getFontName(), scene->_fontSize); return getFont(fontName, Graphics::FontManager::kConsoleFont); } const Graphics::Font *Gui::getMenuFont() { return getFont("Chicago-12", Graphics::FontManager::kBigGUIFont); } const Graphics::Font *Gui::getTitleFont() { return getFont("Chicago-12", Graphics::FontManager::kBigGUIFont); } void Gui::clearOutput() { _out.clear(); } void Gui::appendText(String &str) { _consoleDirty = true; if (!str.contains('\n')) { _out.push_back(str); flowText(str); return; } // Okay, we got new lines, need to split it // and push substrings individually Common::String tmp = ""; for (int i = 0; i < str.size(); i++) { if (str[i] == '\n') { _out.push_back(tmp); flowText(tmp); tmp = ""; continue; } tmp += str[i]; } _out.push_back(tmp); flowText(tmp); } void Gui::draw() { if (_scene != _engine->_world->_player->_currentScene || _sceneDirty) { _scene = _engine->_world->_player->_currentScene; // Draw desktop Patterns p; p.push_back(checkersPattern); Common::Rect r(0, 0, _screen.w - 1, _screen.h - 1); Design::drawFilledRoundRect(&_screen, r, kDesktopArc, kColorBlack, p, 1); g_system->copyRectToScreen(_screen.getPixels(), _screen.pitch, 0, 0, _screen.w, _screen.h); _sceneDirty = true; _consoleDirty = true; _menuDirty = true; _consoleFullRedraw = true; _scene->paint(&_screen, 0 + kComponentsPadding, kMenuHeight + kComponentsPadding); _sceneArea.left = 0 + kComponentsPadding + kBorderWidth; _sceneArea.top = kMenuHeight + kComponentsPadding + kBorderWidth; _sceneArea.setWidth(_scene->_design->getBounds()->width() - 2 * kBorderWidth); _sceneArea.setHeight(_scene->_design->getBounds()->height() - 2 * kBorderWidth); int sceneW = _scene->_design->getBounds()->width(); int consoleW = _screen.w - sceneW - 2 * kComponentsPadding - 2 * kBorderWidth; int consoleH = _scene->_design->getBounds()->height() - 2 * kBorderWidth; int consoleX = sceneW + kComponentsPadding + kBorderWidth; int consoleY = kMenuHeight + kComponentsPadding + kBorderWidth; _consoleTextArea.left = consoleX; _consoleTextArea.top = consoleY; _consoleTextArea.right = consoleX + consoleW; _consoleTextArea.bottom = consoleY + consoleH; } if (_scene && (_bordersDirty || _sceneDirty)) paintBorder(&_screen, _sceneArea, kWindowScene); // Render console if (_consoleDirty || _consoleFullRedraw) renderConsole(&_screen, _consoleTextArea); if (_bordersDirty || _consoleDirty || _consoleFullRedraw) paintBorder(&_screen, _consoleTextArea, kWindowConsole); if (_menuDirty) renderMenu(); _sceneDirty = false; _consoleDirty = false; _bordersDirty = false; _menuDirty = false; _consoleFullRedraw = false; } void Gui::drawBox(Graphics::Surface *g, int x, int y, int w, int h) { Common::Rect r(x, y, x + w + 1, y + h + 1); g->fillRect(r, kColorWhite); g->frameRect(r, kColorBlack); } void Gui::fillRect(Graphics::Surface *g, int x, int y, int w, int h) { Common::Rect r(x, y, x + w, y + h); g->fillRect(r, kColorBlack); } #define ARROW_W 12 #define ARROW_H 6 const int arrowPixels[ARROW_H][ARROW_W] = { {0,0,0,0,0,1,1,0,0,0,0,0}, {0,0,0,0,1,1,1,1,0,0,0,0}, {0,0,0,1,1,1,1,1,1,0,0,0}, {0,0,1,1,1,1,1,1,1,1,0,0}, {0,1,1,1,1,1,1,1,1,1,1,0}, {1,1,1,1,1,1,1,1,1,1,1,1}}; void Gui::paintBorder(Graphics::Surface *g, Common::Rect &r, WindowType windowType) { bool active, scrollable, closeable, closeBoxPressed, drawTitle; const int size = kBorderWidth; int x = r.left - size; int y = r.top - size; int width = r.width() + 2 * size; int height = r.height() + 2 * size; switch (windowType) { case kWindowScene: active = _sceneIsActive; scrollable = false; closeable = _sceneIsActive; closeBoxPressed = false; drawTitle = true; break; case kWindowConsole: active = !_sceneIsActive; scrollable = true; closeable = !_sceneIsActive; closeBoxPressed = false; drawTitle = false; break; } drawBox(g, x, y, size, size); drawBox(g, x+width-size-1, y, size, size); drawBox(g, x+width-size-1, y+height-size-1, size, size); drawBox(g, x, y+height-size-1, size, size); drawBox(g, x + size, y + 2, width - 2*size - 1, size - 4); drawBox(g, x + size, y + height - size + 1, width - 2*size - 1, size - 4); drawBox(g, x + 2, y + size, size - 4, height - 2*size - 1); drawBox(g, x + width - size + 1, y + size, size - 4, height - 2*size-1); if (active) { fillRect(g, x + size, y + 5, width - 2*size - 1, 8); fillRect(g, x + size, y + height - 13, width - 2*size - 1, 8); fillRect(g, x + 5, y + size, 8, height - 2*size - 1); if (!scrollable) { fillRect(g, x + width - 13, y + size, 8, height - 2*size - 1); } else { int x1 = x + width - 15; int y1 = y + size + 1; for (int yy = 0; yy < ARROW_H; yy++) { for (int xx = 0; xx < ARROW_W; xx++) { if (arrowPixels[yy][xx] != 0) { g->hLine(x1+xx, y1+yy, x1+xx, kColorBlack); } else { g->hLine(x1+xx, y1+yy, x1+xx, kColorWhite); } } } fillRect(g, x + width - 13, y + size + ARROW_H, 8, height - 2*size - 1 - ARROW_H*2); y1 += height - 2*size - ARROW_H - 2; for (int yy = 0; yy < ARROW_H; yy++) { for (int xx = 0; xx < ARROW_W; xx++) { if (arrowPixels[ARROW_H-yy-1][xx] != 0) { g->hLine(x1+xx, y1+yy, x1+xx, kColorBlack); } else { g->hLine(x1+xx, y1+yy, x1+xx, kColorWhite); } } } } if (closeable) { if (closeBoxPressed) { fillRect(g, x + 6, y + 6, 6, 6); } else { drawBox(g, x + 5, y + 5, 7, 7); } } } if (drawTitle) { const Graphics::Font *font = getTitleFont(); int yOff = _builtInFonts ? 3 : 1; int w = font->getStringWidth(_scene->_name) + 6; int maxWidth = width - size*2 - 7; if (w > maxWidth) w = maxWidth; drawBox(g, x + (width - w) / 2, y, w, size); font->drawString(g, _scene->_name, x + (width - w) / 2 + 3, y + yOff, w, kColorBlack); } g_system->copyRectToScreen(g->getBasePtr(x, y), g->pitch, x, y, width, height); } enum { kConWOverlap = 20, kConHOverlap = 20, kConWPadding = 3, kConHPadding = 4, kConOverscan = 3 }; void Gui::flowText(String &str) { Common::StringArray wrappedLines; int textW = _consoleTextArea.width() - kConWPadding * 2; const Graphics::Font *font = getConsoleFont(); font->wordWrapText(str, textW, wrappedLines); if (wrappedLines.size() == 0) // Sometimes we have empty lines _lines.push_back(""); for (Common::StringArray::const_iterator j = wrappedLines.begin(); j != wrappedLines.end(); ++j) _lines.push_back(*j); int pos = _scrollPos; _scrollPos = MAX(0, (_lines.size() - _consoleNumLines) * _consoleLineHeight); _cursorX = kConWPadding; if (_scrollPos) _cursorY = (_consoleNumLines) * _consoleLineHeight + kConHPadding; else _cursorY = (_lines.size()) * _consoleLineHeight + kConHPadding; if (pos != _scrollPos) _consoleFullRedraw = true; if (!_engine->_temporarilyHidden) draw(); } void Gui::renderConsole(Graphics::Surface *g, Common::Rect &r) { bool fullRedraw = _consoleFullRedraw; bool textReflow = false; int surfW = r.width() + kConWOverlap * 2; int surfH = r.height() + kConHOverlap * 2; Common::Rect boundsR(kConWOverlap - kConOverscan, kConHOverlap - kConOverscan, r.width() + kConWOverlap + kConOverscan, r.height() + kConHOverlap + kConOverscan); Common::Rect fullR(0, 0, surfW, surfH); if (_console.w != surfW || _console.h != surfH) { if (_console.w != surfW) textReflow = true; _console.free(); _console.create(surfW, surfH, Graphics::PixelFormat::createFormatCLUT8()); fullRedraw = true; } if (fullRedraw) _console.fillRect(fullR, kColorWhite); const Graphics::Font *font = getConsoleFont(); _consoleLineHeight = font->getFontHeight(); int textW = r.width() - kConWPadding * 2; int textH = r.height() - kConHPadding * 2; if (textReflow) { _lines.clear(); for (int i = 0; i < _out.size(); i++) flowText(_out[i]); } const int firstLine = _scrollPos / _consoleLineHeight; const int lastLine = MIN((_scrollPos + textH) / _consoleLineHeight + 1, _lines.size()); const int xOff = kConWOverlap; const int yOff = kConHOverlap; int x1 = xOff + kConWPadding; int y1 = yOff - (_scrollPos % _consoleLineHeight) + kConHPadding; if (fullRedraw) _consoleNumLines = (r.height() - 2 * kConWPadding) / _consoleLineHeight - 2; for (int line = firstLine; line < lastLine; line++) { const char *str = _lines[line].c_str(); if (*str) font->drawString(&_console, _lines[line], x1, y1, textW, kColorBlack); y1 += _consoleLineHeight; } g->copyRectToSurface(_console, r.left - kConOverscan, r.top - kConOverscan, boundsR); g_system->copyRectToScreen(g->getBasePtr(r.left, r.top), g->pitch, r.left, r.top, r.width(), r.height()); } void Gui::drawInput() { if (!_screen.getPixels()) return; if (_sceneIsActive) { _sceneIsActive = false; _bordersDirty = true; } const Graphics::Font *font = getConsoleFont(); int x = kConWPadding + _consoleTextArea.left; int y = _cursorY + _consoleTextArea.top; Common::String text(_engine->_inputText); int textW = font->getStringWidth(text); // undraw cursor _cursorOff = true; _cursorState = false; cursor_timer_handler(this); _cursorOff = false; Common::Rect r(x, y, x + textW + 10, y + font->getFontHeight()); _screen.fillRect(r, kColorWhite); font->drawString(&_screen, text, x, y, _screen.w, kColorBlack); g_system->copyRectToScreen(_screen.getBasePtr(x, y), _screen.pitch, x, y, textW + 10, font->getFontHeight()); _cursorX = font->getStringWidth(_engine->_inputText) + kConHPadding; } void Gui::loadFonts() { Common::Archive *dat; dat = Common::makeZipArchive("wage.dat"); if (!dat) { warning("Could not find wage.dat. Falling back to built-in fonts"); _builtInFonts = true; return; } Common::ArchiveMemberList list; dat->listMembers(list); for (Common::ArchiveMemberList::iterator it = list.begin(); it != list.end(); ++it) { Common::SeekableReadStream *stream = dat->createReadStreamForMember((*it)->getName()); Graphics::BdfFont *font = Graphics::BdfFont::loadFont(*stream); delete stream; Common::String fontName = (*it)->getName(); // Trim the .bdf extension for (int i = fontName.size() - 1; i >= 0; --i) { if (fontName[i] == '.') { while ((uint)i < fontName.size()) { fontName.deleteLastChar(); } break; } } FontMan.assignFontToName(fontName, font); debug(2, " %s", fontName.c_str()); } _builtInFonts = false; delete dat; } void Gui::mouseMove(int x, int y) { if (_consoleTextArea.contains(x, y)) { if (_cursorIsArrow) { CursorMan.replaceCursor(macCursorBeam, 11, 16, 3, 8, 3); _cursorIsArrow = false; } } else if (_cursorIsArrow == false) { CursorMan.replaceCursor(macCursorArrow, 11, 16, 1, 1, 3); _cursorIsArrow = true; } } static const char *menuItems[] = { "\xf0", "File", "Edit", "Commands", "Weapons", 0 }; void Gui::renderMenu() { Common::Rect r(0, 0, _screen.w - 1, kMenuHeight - 1); Patterns p; p.push_back(fillPattern); Design::drawFilledRoundRect(&_screen, r, kDesktopArc, kColorWhite, p, 1); r.top = 7; Design::drawFilledRect(&_screen, r, kColorWhite, p, 1); r.top = kMenuHeight - 1; Design::drawFilledRect(&_screen, r, kColorBlack, p, 1); const Graphics::Font *font = getMenuFont(); int y = _builtInFonts ? 3 : 2; int x = 18; for (int i = 0; menuItems[i]; i++) { const char *s = menuItems[i]; if (i == 0 && _builtInFonts) s = "\xa9"; // (c) Symbol as the most resembling apple int w = font->getStringWidth(s); font->drawString(&_screen, s, x, y, w, kColorBlack); x += w + 13; } g_system->copyRectToScreen(_screen.getPixels(), _screen.pitch, 0, 0, _screen.w, kMenuHeight); } Designed *Gui::getClickTarget(int x, int y) { if (_sceneArea.contains(x, y)) { if (!_sceneIsActive) { _sceneIsActive = true; _bordersDirty = true; } for (Common::List::const_iterator it = _scene->_objs.begin(); it != _scene->_objs.end(); ++it) { if ((*it)->_design->isPointOpaque(x - _sceneArea.left + kBorderWidth, y - _sceneArea.top + kBorderWidth)) return *it; } for (Common::List::const_iterator it = _scene->_chrs.begin(); it != _scene->_chrs.end(); ++it) { if ((*it)->_design->isPointOpaque(x - _sceneArea.left + kBorderWidth, y - _sceneArea.top + kBorderWidth)) return *it; } } else if (_consoleTextArea.contains(x, y)) { if (_sceneIsActive) { _sceneIsActive = false; _bordersDirty = true; } } return NULL; } } // End of namespace Wage