hypertext.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 NANCY_MISC_HYPERTEXT_H
#define NANCY_MISC_HYPERTEXT_H

#include "engines/nancy/renderobject.h"
#include "engines/nancy/graphics.h"

namespace Nancy {

class Font;

namespace Misc {

// Base class for handling the engine's custom hypertext format
// Used by the Textbox and by Autotext action records
class HypertextParser {
public:
    HypertextParser() :
        _backgroundColor(0),
        _highlightBackgroundColor(0),
        _numDrawnLines(0),
        _drawnTextHeight(0),
        _needsTextRedraw(false),
        _defaultTextColor(0),
        _imageVerticalOffset(0) {}
    virtual ~HypertextParser() {};

    bool hasBeenDrawn() const { return !_needsTextRedraw; }

protected:
    enum Justification { kJustifyLeft, kJustifyRight, kJustifyCenter };

    // Image embedded in the text via the <iNAME,left,top,right,bottom> tag
    struct InlineImage {
        Common::Path name;
        Common::Rect src; // empty means the whole image
    };

    void initSurfaces(uint width, uint height, const struct Graphics::PixelFormat &format, uint32 backgroundColor, uint32 highlightBackgroundColor);

    void addTextLine(const Common::String &text);
    void addImage(uint16 lineID, const Common::Rect &src);
    void setImageName(const Common::Path &name);

    void drawAllText(const Common::Rect &textBounds, uint leftOffsetNonNewline, uint fontID, uint highlightFontID);
    virtual void clear();

    void drawInlineImage(const InlineImage &inlineImage, const Common::Rect &textBounds, uint horizontalOffset, uint justification, const Font *font);

    // Nancy16 UI text starts out in a color of its own, until a color tag picks one of
    // the font colors; that color then gets used in place of _defaultTextColor
    void setDefaultTextRGB(byte r, byte g, byte b);

    Graphics::ManagedSurface _fullSurface;          // Contains all rendered text (may be cropped)
    Graphics::ManagedSurface _textHighlightSurface; // Same as above, but drawn with the highlight font

    uint32 _backgroundColor;
    uint32 _highlightBackgroundColor;
    uint _defaultTextColor;
    uint _defaultJustification = kJustifyLeft;
    FontColorState _fontColorState = kFontColorNormal;  // Nancy16+: picks the color of a color tag
    int _imageVerticalOffset;

    Common::Array<Common::String> _textLines;
    Common::Array<Common::Rect> _hotspots;

    // When set, drawAllText records the dest rect of every drawn mark glyph
    // (in _fullSurface coords, in draw order). The notebook uses this to hit-
    // test the tasklist's clickable checkboxes.
    bool _recordMarkHotspots = false;
    Common::Array<Common::Rect> _markHotspots;

    // Data for displaying images inside text; used in Hypertext
    Common::Path _imageName;
    Common::Array<uint16> _imageLineIDs;
    Common::Array<Common::Rect> _imageSrcs;

    uint16 _numDrawnLines;
    uint16 _drawnTextHeight;
    bool _needsTextRedraw;

private:
    // Color IDs are font color IDs, or this for the color given to setDefaultTextRGB()
    static const int kDefaultRGB = -1;

    void drawTextRun(Graphics::ManagedSurface &surface, const Font *font, const Common::String &text, int x, int y, int width, int colorID) const;
    uint32 getColorPixel(const Font *font, int colorID) const;

    bool _hasDefaultTextRGB = false;
    byte _defaultTextRGB[3] = {};
};

} // End of namespace Misc
} // End of namespace Nancy

#endif // NANCY_MISC_HYPERTEXT_H