text.h

/* 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/>.
 *
 */

#ifndef TWINE_TEXT_H
#define TWINE_TEXT_H

#include "common/scummsys.h"
#include "common/str.h"
#include "common/rect.h"
#include "twine/shared.h"

namespace TwinE {

class TextEntry;

#define TEXT_MAX_FADE_IN_CHR 32

enum class ProgressiveTextState {
    End = 0,                
    ContinueRunning = 1,    
    NextPage = 2            
};

class TwinEEngine;

class Text {
private:
    TwinEEngine *_engine;
    void initVoxBank(TextBankId bankIdx);
    void drawCharacter(int32 x, int32 y, uint16 character);
    void drawCharacterShadow(int32 x, int32 y, uint16 character, int32 color, Common::Rect& dirtyRect);
    void initProgressiveTextBuffer();
    struct WordSize {
        int32 inChar = 0;
        int32 inPixel = 0;
    };
    struct LineCharacter {
        int16 chr = 0;
        int16 x = 0;
    };
    WordSize getWordSize(const char *completeText, char *wordBuf, int32 wordBufSize);
    uint16 getNextChar(const char *&dialogue);
    void processTextLine();
    void appendProgressiveTextBuffer(const char *s, int &x, uint &i);
    // draw next page arrow polygon
    void renderContinueReadingTriangle();
    void fillFadeInBuffer(int16 baseX, int16 y, const LineCharacter &chr);
    void fadeInCharacters(int32 counter, int32 fontColor);

    TextBankId _currentBankIdx = TextBankId::None;

    LineCharacter _progressiveTextBuffer[256];
    const char *_currentTextPosition = nullptr;

    int32 _dialTextBaseXPos = 0;
    int32 _dialTextYPos = 0;

    const LineCharacter *_progressiveTextBufferPtr = nullptr;

    int32 _dialTextBoxCurrentLine = 0;
    struct BlendInCharacter {
        int16 chr = 0;
        int16 x = 0;
        int16 y = 0;
    };
    BlendInCharacter _fadeInCharacters[TEXT_MAX_FADE_IN_CHR];
    int32 _fadeInCharactersPos = 0;

    const char *_currDialTextPtr = nullptr;
    int32 _currDialTextSize = 0;

    char _currMenuTextBuffer[256];
    TextBankId _currMenuTextBank = TextBankId::None;
    TextId _currMenuTextIndex = TextId::kNone;

    int32 _dialSpaceBetween = 0;
    int32 _dialCharSpace = 0;
    int32 _dialTextColor = 0;

    int32 _dialTextStartColor = 0;
    int32 _dialTextStopColor = 0;
    int32 _dialTextStepSize = 0;
    int32 _dialTextBufferSize = 0;

    Common::Rect _dialTextBox { 0, 0, 0, 0};

    int32 _dialTextBoxLines = 0; // dialogueBoxParam1
    int32 _dialTextBoxMaxX = 0; // dialogueBoxParam2

    bool _isShiftJIS = false;
    bool _isVisualRTL = false;

    bool displayText(TextId index, bool showText, bool playVox, bool loop);
public:
    Text(TwinEEngine *engine);
    ~Text();

    static const int32 lineHeight = 38;

    // TODO: refactor all this variables and related functions
    bool _hasValidTextHandle = false;
    // renders a triangle if the next side of the text can get activated
    bool _renderTextTriangle = false;
    bool _drawTextBoxBackground = false;
    bool _hasHiddenVox = false; // printTextVar5
    int32 _voxHiddenIndex = 0;
    // ---

    const TextEntry *_currDialTextEntry = nullptr; // ordered entry
    Common::String _currentVoxBankFile;
    // used for the android version (dotemu)
    Common::String _currentOggBaseFile;

    bool _showDialogueBubble = true;

    void initDial(TextBankId bankIdx);
    void initSceneTextBank();
    inline TextBankId textBank() const {
        return _currentBankIdx;
    }

    void drawText(int32 x, int32 y, const char *dialogue, bool shadow = false);

    bool drawTextProgressive(TextId index, bool playVox = true, bool loop = true);

    int32 getTextSize(const char *dialogue);
    int32 getCharWidth(uint16 chr) const;
    int32 getCharHeight(uint16 chr) const;

    void initDialogueBox();
    void initInventoryDialogueBox();

    void initText(TextId index);
    void initLine();
    void initInventoryText(InventoryItems index);
    void initItemFoundText(InventoryItems index);
    void fadeInRemainingChars();
    ProgressiveTextState updateProgressiveText();

    void setFontParameters(int32 spaceBetween, int32 charSpace);

    void setFontCrossColor(int32 color);

    void setFontColor(int32 color);

    void setTextCrossColor(int32 stopColor, int32 startColor, int32 stepSize);

    bool getText(TextId index);

    bool getMenuText(TextId index, char *text, uint32 textSize);

    void bigWinDial();
    void normalWinDial();

    void drawAskQuestion(TextId index);
    void drawHolomapLocation(TextId index);

    bool playVox(const TextEntry *text);
    bool playVoxSimple(const TextEntry *text);
    bool stopVox(const TextEntry *text);
    bool initVoxToPlay(const TextEntry *text);
    bool initVoxToPlayTextId(TextId index);
};

} // namespace TwinE

#endif