mactext.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 GRAPHICS_MACGUI_MACTEXT_H
#define GRAPHICS_MACGUI_MACTEXT_H

#include "graphics/macgui/mactext-canvas.h"

namespace Graphics {

struct SelectedText {
    int startX, startY;
    int endX, endY;
    int startRow, startCol;
    int endRow, endCol;

    SelectedText() {
        startX = startY = -1;
        endX = endY = -1;
        startRow = startCol = -1;
        endRow = endCol = -1;
    }

    bool needsRender() {
        return startX != endX || startY != endY;
    }
};

class MacText : public MacWidget {
public:
    MacText(MacWidget *parent, int x, int y, int w, int h, MacWindowManager *wm, const Common::U32String &s, const MacFont *font, uint32 fgcolor, uint32 bgcolor, int maxWidth, TextAlign textAlignment = kTextAlignLeft, int interlinear = 0, uint16 border = 0, uint16 gutter = 0, uint16 boxShadow = 0, uint16 textShadow = 0, bool fixedDims = true, bool scrollBar = false);
    // 0 pixels between the lines by default

    MacText(const Common::U32String &s, MacWindowManager *wm, const MacFont *font, uint32 fgcolor, uint32 bgcolor, int maxWidth, TextAlign textAlignment, int interlinear = 0, bool fixedDims = true, bool scrollBar = false);

    MacText(const Common::U32String &s, MacWindowManager *wm, const Font *font, uint32 fgcolor, uint32 bgcolor, int maxWidth, TextAlign textAlignment, int interlinear = 0, bool fixedDims = true, bool scrollBar = false);

    virtual ~MacText();

    virtual void resize(int w, int h);
    bool processEvent(Common::Event &event) override;

    bool needsRedraw() override { return _contentIsDirty || _cursorDirty; }

    WindowClick isInScrollBar(int x, int y) const;
    void setScrollBar(bool enable);
    void resizeScrollBar(int w, int h);

    void setAutoSelect(bool enable) { _autoSelect = enable; }

    void render();
    void undrawCursor();
    void draw(ManagedSurface *g, int x, int y, int w, int h, int xoff, int yoff);
    bool draw(ManagedSurface *g, bool forceRedraw = false) override;
    bool draw(bool forceRedraw = false) override;
    void drawToPoint(ManagedSurface *g, Common::Rect srcRect, Common::Point dstPoint);
    void drawToPoint(ManagedSurface *g, Common::Point dstPoint);

    ManagedSurface *getSurface() { return _canvas._surface; }
    ManagedSurface *getGlyphMask() { return _canvas._glyphMask; }
    ManagedSurface *getCharBoxMask() { return _canvas._charBoxMask; }

    int getInterLinear() { return _canvas._interLinear; }
    void setInterLinear(int interLinear);
    void setMaxWidth(int maxWidth);
    void setDefaultFormatting(uint16 fontId, byte textSlant, uint16 fontSize,
                                                        uint16 palinfo1, uint16 palinfo2, uint16 palinfo3);
    const MacFontRun &getDefaultFormatting() { return _defaultFormatting; }

    void setAlignOffset(TextAlign align);
    TextAlign getAlign() { return _canvas._textAlignment; }
    virtual Common::Point calculateOffset();
    void setActive(bool active) override;
    void setEditable(bool editable);
    void setInputPadding(bool enable){ _addInputPadding = enable; }

    void setColors(uint32 fg, uint32 bg) override;
    // set fgcolor for line x
    void setTextColor(uint32 color, uint32 line);
    void setTextColor(uint32 color, uint32 start, uint32 end);

    void appendText(const Common::U32String &str, int fontId = kMacFontSystem, int fontSize = 12, int fontSlant = kMacFontRegular, bool skipAdd = false);
    void appendText(const Common::U32String &str, int fontId = kMacFontSystem, int fontSize = 12, int fontSlant = kMacFontRegular, uint16 r = 0, uint16 g = 0, uint16 b = 0, bool skipAdd = false);
    void appendText(const Common::U32String &str, const Font *font, uint16 r = 0, uint16 g = 0, uint16 b = 0, bool skipAdd = false);

    int getTextFont() { return _defaultFormatting.fontId; }
    void enforceTextFont(uint16 fontId);

    int getRowCount();

    // because currently, we are counting linespacing as font height
    int getTextSize() { return _defaultFormatting.fontSize; }
    void setTextSize(int textSize);

    int getTextSize(int start, int end);
    void setTextSize(int textSize, int start, int end);

    uint32 getTextColor() { return _defaultFormatting.fgcolor; }
    uint32 getTextColor(int start, int end);

    int getTextFont(int start, int end);
    void setTextFont(int fontId, int start, int end);

    int getTextSlant() { return _defaultFormatting.textSlant; }
    int getTextSlant(int start, int end);
    void setTextSlant(int textSlant, int start, int end);
    void enforceTextSlant(int textSlant);

    // director text related-functions
    int getMouseChar(int x, int y);
    int getMouseWord(int x, int y);
    int getMouseItem(int x, int y);
    int getMouseLine(int x, int y);
    Common::U32String getMouseLink(int x, int y);

    bool setImageArchive(const Common::Path &name) { return _canvas._imageArchive.setImageArchive(name); }

private:
    MacFontRun getTextChunks(int start, int end);
    void setTextChunks(int start, int end, int param, void (*callback)(MacFontRun &, int));

    void appendText_(const Common::U32String &strWithFont, uint oldLen);
    void deletePreviousCharInternal(int *row, int *col);
    void insertTextFromClipboard();
    MacFontRun getFgColor();

public:
    void appendTextDefault(const Common::U32String &str, bool skipAdd = false);
    void appendTextDefault(const Common::String &str, bool skipAdd = false);
    void clearText();
    void removeLastLine();
    int getLineCount() { return _canvas._text.size(); }
    int getLastLineWidth();
    int getTextHeight() { return _canvas._textMaxHeight; }
    int getLineHeight(int line);
    int getTextMaxWidth() { return _canvas._textMaxWidth; }

    void setText(const Common::U32String &str);

    void setFixDims(bool fixed) { _fixedDims = fixed; }
    bool getFixDims() { return _fixedDims; }

    void deleteSelection();
    void deletePreviousChar(int *row, int *col);
    void addNewLine(int *row, int *col);
    void insertChar(byte c, int *row, int *col);

    void getChunkPosFromIndex(int index, uint &lineNum, uint &chunkNum, uint &offset);
    void getRowCol(int x, int y, int *sx, int *sy, int *row, int *col, int *chunk_ = nullptr);
    void getLineCharacter(int x, int y, int *sx, int *sy, int *line, int *character, int *chunk_ = nullptr);
    Common::U32String getTextChunk(int startRow, int startCol, int endRow, int endCol, bool formatted = false, bool newlines = true);

    Common::U32String getSelection(bool formatted = false, bool newlines = true);
    uint getSelectionIndex(bool start);
    void clearSelection();
    Common::U32String cutSelection();
    const SelectedText *getSelectedText() { return &_selectedText; }
    bool hasSelection() { return _selectedText.endY != -1; }

    int getLineSpacing() { return _canvas._interLinear; }

    void setSelection(int pos, bool start);

    Common::U32String getEditedString();
    Common::U32String getText() { return _str; }
    Common::U32String getPlainText();

    void setSelRange(int selStart, int selEnd);

    void scroll(int delta);

    // Markdown
public:
    void setMarkdownText(const Common::U32String &str);

private:
    void init(uint32 fgcolor, uint32 bgcolor, int maxWidth, TextAlign textAlignment, int interlinear, uint16 textShadow, bool macFontMode);
    bool isCutAllowed();

    void recalcDims();

    void drawSelection(int xoff, int yoff);
    void updateCursorPos();

    void startMarking(int x, int y);
    void updateTextSelection(int x, int y);

    void clearChunkInput();

public:
    int _cursorX, _cursorY;
    bool _cursorState;
    int _cursorRow, _cursorCol;

    bool _cursorDirty;
    Common::Rect *_cursorRect;
    bool _cursorOff;
    bool _selectable;

    int _scrollPos;

    bool _fullRefresh;

protected:
    Common::U32String _str;
    const MacFont *_macFont;

    bool _fixedDims;
    bool _scrollBar;
    MacWindowBorder _scrollBorder;
    ManagedSurface _borderSurface;

    int _selEnd;
    int _selStart;

    MacTextCanvas _canvas;

    MacFontRun _defaultFormatting;
    MacFontRun _currentFormatting;

private:
    ManagedSurface *_cursorSurface;
    ManagedSurface *_cursorSurface2;

    int _editableRow;

    bool _addInputPadding;

    bool _inTextSelection;
    SelectedText _selectedText;
    bool _selectionIsDirty;

    MacMenu *_menu;

    bool _autoSelect;
};

int getStringWidth(MacFontRun &format, const Common::U32String &str);

} // End of namespace Graphics

#endif