textrenderer.h

Go to the documentation of this file.

// edbee - Copyright (c) 2012-2025 by Rick Blommers and contributors
// SPDX-License-Identifier: MIT
 
#pragma once
 
#include "edbee/exports.h"
 
#include <QCache>
#include <QObject>
#include <QHash>
#include <QRect>
 
 
#include "edbee/models/textbuffer.h"
 
class QPainter;
class QRect;
 
namespace edbee {
 
class AbstractComponent;
class TextDocument;
class TextEditorConfig;
class TextEditorController;
class TextEditorWidget;
class TextRangeSet;
class TextSelection;
class TextTheme;
class TextThemeStyler;
class TextLayout;

class EDBEE_EXPORT TextRenderer : public QObject
{
Q_OBJECT
 
public:
    TextRenderer( TextEditorController* controller );
    virtual ~TextRenderer();
    virtual void init();
    virtual void reset();
 
// calculation functions
    int lineHeight();
    int rawLineIndexForYpos( int y );
    int lineIndexForYpos( int y );
    int totalWidth();
    int totalHeight();
    int emWidth();
    int nrWidth();
    int viewHeightInLines();
    int firstVisibleLine();
 
    int columnIndexForXpos( int line, int x );
    int xPosForColumn( int line, int column );
    int xPosForOffset( int offset );
    int yPosForLine( int line );
    int yPosForOffset( int offset );
 
// Document access functions (Document vs Placeholder text)
    int lineCount();
    QString getLine(int index);
 
// caching
    TextLayout* textLayoutForLine( int line );
    TextLayout* textLayoutForLineForPlaceholder( int line );
    TextLayout* textLayoutForLineNormal( int line );
 
// rendering
    void renderBegin(const QRect& rect );
    void renderEnd( const QRect& rect );
 
// getters / setters
    TextDocument* textDocument();
    TextDocument* placeholderTextDocument();
    TextSelection *textSelection();
    TextEditorConfig* config();
    TextEditorController* controller();
    TextEditorWidget* textWidget();
 
    void setViewport( const QRect& viewport );
 
    void resetCaretTime();
    bool shouldRenderCaret();
    bool isCaretVisible();
    void setCaretVisible(bool visible);
 
    QRect viewport() { return viewport_; }
    int viewportX() { return viewport_.x(); }
    int viewportY(){ return viewport_.y(); }
    int viewportWidth() { return viewport_.width(); }
    int viewportHeight() { return viewport_.height(); }
 
// theme support
    TextThemeStyler* themeStyler() { return textThemeStyler_; }
 
    QString themeName() const;
    TextTheme* theme();
    void setThemeByName( const QString& name );
    void setTheme( TextTheme* theme );
 
// temporary getters only valid while rendering!!
    const QRect* clipRect() { return clipRectRef_; }                
    int startOffset() { return startOffset_; }                      
    int endOffset() { return endOffset_; }                          
    int startLine() { return startLine_; }                          
    int endLine() { return endLine_; }                              
 
private:
    void updateWidthCacheForRange( int offset, int length );
 
protected slots:
 
    void textDocumentChanged( edbee::TextDocument* oldDocument, edbee::TextDocument* newDocument );
    void textChanged( edbee::TextBufferChange change, QString oldText = QString() );
 
    void lastScopedOffsetChanged( int previousOffset, int newOffset );
 
public slots:
 
    void invalidateTextLayoutCaches(int fromLine=0);
    void invalidateCaches();
 
signals:
    void themeChanged( TextTheme* theme );
 
 
private:
 
    TextEditorController* controllerRef_;    
    qint64 caretTime_;                      
    qint64 caretBlinkRate_;                 
 
    QCache<int,TextLayout> cachedTextLayoutList_;   
 
    QRect viewport_;                                
    int totalWidthCache_;                           
 
    TextThemeStyler* textThemeStyler_;              
 
    // temporary variables only valid the int the current context
    const QRect* clipRectRef_;                
    int startOffset_;                         
    int endOffset_;                           
    int startLine_;                           
    int endLine_;                             
 
    TextDocument* placeHolderDocument_;
};
 
} // edbee
    int endLine() { return endLine_; }                               {…}
    int startLine() { return startLine_; }                           {…}
    int endOffset() { return endOffset_; }                           {…}
    int startOffset() { return startOffset_; }                       {…}
class EDBEE_EXPORT TextRenderer : public QObject {…};