hex_data_source_view.h

Go to the documentation of this file.

 
#pragma once
 
#include <config.h>
 
#include "ui/recent.h"
 
#include <QAbstractScrollArea>
#include <QFont>
#include <QColor>
#include <QVector>
#include <QMenu>
#include <QSize>
#include <QString>
#include <QVector>
 
#include <limits>
 
#include "base_data_source_view.h"
 
#include <ui/qt/utils/byte_view_text_cells.h>
#include <ui/qt/utils/data_printer.h>
#include <ui/qt/utils/idata_printable.h>
 
// XXX - Is there any reason we shouldn't add ImageDataSourceView, etc?

class HexDataSourceView : public BaseDataSourceView, public IDataPrintable
{
    Q_OBJECT
    Q_INTERFACES(IDataPrintable)
 
public:
    struct ByteViewAnnotation {
        int start;       
        int length;      
        QColor color;    
        QString comment; 
    };

    explicit HexDataSourceView(const QByteArray &data,
                                packet_char_enc encoding = PACKET_CHAR_ENC_CHAR_ASCII,
                                QWidget *parent = nullptr);

    ~HexDataSourceView();

    void setFormat(bytes_view_type format);

    void setAnnotations(const QVector<ByteViewAnnotation> &annotations);
 
    // ── Selection accessors ───────────────────────────────────────────────

    bool selectionRange(int *start, int *length) const;

    int selectionAnchor() const;

    int selectionEnd() const;

    int contextByteOffset() const;

    int dataSize() const {
        Q_ASSERT(data_.size() <= std::numeric_limits<int>::max());
        return static_cast<int>(data_.size());
    }
 
    // ── Offset marker accessors ───────────────────────────────────────────

    int offsetStart() const { return offset_start_byte_; }

    int offsetEnd() const { return offset_end_byte_; }

    void setOffsetStart(int byte);

    void setOffsetEnd(int byte);

    void clearOffsetMarkers();
 
    // ── Selected-field metadata accessors ────────────────────────────────

    int selectedFieldStart() const { return field_start_; }

    int selectedFieldLength() const { return field_len_; }

    int selectedProtocolStart() const { return proto_start_; }

    int selectedProtocolLength() const { return proto_len_; }

    bool selectedFieldIsProtocol() const { return selected_field_is_protocol_; }

    bool selectedFieldUsesOwnRange() const { return selected_field_use_own_range_; }

    void setSelectedFieldIsProtocol(bool is_protocol) {
        selected_field_is_protocol_ = is_protocol;
    }

    void setSelectedFieldUsesOwnRange(bool use_own_range) {
        selected_field_use_own_range_ = use_own_range;
    }
 
signals:
    void byteViewSettingsChanged();

    void addAnnotationRequested();

    void editAnnotationRequested();

    void removeAnnotationRequested();

    void offsetStartRequested(int byte);

    void offsetEndRequested(int byte);

    void offsetMarkersCleared();
 
public slots:
    void setMonospaceFont(const QFont &mono_font) override;

    void updateByteViewSettings();

    void markProtocol(int start, int length) override;

    void markField(int start, int length, bool scroll_to = true, bool hover = false) override;

    void markAppendix(int start, int length) override;

    void unmarkField() override;
 
protected:
    virtual void paintEvent(QPaintEvent *event) override;

    virtual void resizeEvent(QResizeEvent *event) override;

    virtual void showEvent(QShowEvent *event) override;

    virtual void mousePressEvent(QMouseEvent *event) override;

    virtual void mouseMoveEvent(QMouseEvent *event) override;

    virtual void mouseReleaseEvent(QMouseEvent *event) override;

    virtual void leaveEvent(QEvent *event) override;

    virtual void contextMenuEvent(QContextMenuEvent *event) override;

    virtual void keyPressEvent(QKeyEvent *event) override;
 
private:
    struct RowPaintContext {
        bool has_selection = false; 
        int sel_start = -1;         
        int sel_length = 0;         
        QColor sel_bg;              
        QColor sel_fg;              
        QColor sel_overlay;         
        QColor marker_start_bg;     
        QColor marker_end_bg;       
        int hover_start = -1;       
        int hover_length = 0;       
        QColor invalid_fg;          
    };

    struct ByteStyle {
        QColor bg; 
        QColor fg; 
    };

    struct Row {
        int offset;                
        int last;                  
        int y;                     
        QVector<ByteStyle> styles; 
        QVector<ByteStyle> gaps;   
    };

    void updateLayoutMetrics();

    int stringWidth(const QString &line);

    void drawLine(QPainter *painter, const Row &row, const RowPaintContext &ctx);

    void drawOffsetColumn(QPainter *painter, const Row &row);

    void drawHexPanel(QPainter *painter, const Row &row, const RowPaintContext &ctx);

    void drawTextPanel(QPainter *painter, const Row &row, const RowPaintContext &ctx);

    void drawMultiByteCell(QPainter *painter, const ByteViewTextCells::Cell &cell, int first, int last, const Row &row, const RowPaintContext &ctx);

    QColor cellTextColor(const ByteViewTextCells::Cell &cell, const ByteStyle &style, const RowPaintContext &ctx);

    ByteStyle byteStyle(int offset, const RowPaintContext &ctx, int length = 1);

    QColor annotationBackground(const ByteViewAnnotation &ann, const RowPaintContext &ctx);

    void ensureTextCells();

    ByteViewTextCells::Encoding textEncoding() const;

    int textPanelX();

    QRect textCellRect(int col, int row_y);

    QRect textSpanRect(int first_col, int last_col, int row_y);

    int hexCharsPerByte();

    QString byteText(uint8_t c);

    int hexPanelX();

    QRect hexCellRect(int col, int row_y);

    int hexColumnAtX(int x, bool allow_fuzzy);

    int textColumnAtX(int x, bool allow_fuzzy);

    int annotationIndexAt(int byte_offset) const;

    int annotationIndexIntersecting(int start, int length) const;

    void updateSelection(int byte_offset, bool extend, bool emit_signal);

    void updateAnnotationToolTip(int byte_offset, const QPoint &global_pos);

    void scrollToByte(int byte);

    void updateScrollbars();

    int byteOffsetAtPixel(QPoint pos, bool allow_fuzzy = false);

    void createContextMenu();

    void updateContextMenu();
 
    // ── Column layout helpers ─────────────────────────────────────────────

    int offsetChars(bool include_pad = true);

    int offsetPixels();

    int hexPixels();

    int asciiPixels();

    int totalPixels();

    const QByteArray printableData() override { return data_; }
 
    // ── Constants ─────────────────────────────────────────────────────────

    static const int separator_interval_;
 
    // ── State ─────────────────────────────────────────────────────────────
    bool layout_dirty_; 
 
    // Colors
    QColor offset_normal_fg_; 
    QColor offset_field_fg_;  
 
    // Data
    packet_char_enc encoding_; 
    QMenu ctx_menu_;           
 
    // Highlight ranges
    int hovered_byte_offset_; 
    int proto_start_;         
    int proto_len_;           
    int field_start_;         
    int field_len_;           
    int field_a_start_;       
    int field_a_len_;         
    int field_hover_start_;   
    int field_hover_len_;     
 
    // Display settings
    bool show_offset_;  
    bool show_hex_;     
    bool show_ascii_;   
    int row_width_;     
    int em_width_;      
    int line_height_;   

    QList<QRect> hover_outlines_;
 
    bool allow_hover_selection_; 
 
    QVector<ByteViewAnnotation> annotations_; 
 
    // Selection state
    int selection_anchor_; 
    int selection_start_;  
    int selection_end_;    
    bool selecting_;       
    int context_byte_offset_;   
    int cursor_byte_;           
    int hovered_annotation_index_; 
    int offset_start_byte_; 
    int offset_end_byte_;   
    bool selected_field_is_protocol_;   
    bool selected_field_use_own_range_; 
 
    ByteViewTextCells text_cells_; 
    bool text_cells_dirty_;        
 
    // Context menu actions
    QAction *action_allow_hover_selection_; 
    QAction *action_add_annotation_;        
    QAction *action_edit_annotation_;       
    QAction *action_remove_annotation_;     
    QAction *action_set_offset_start_;      
    QAction *action_set_offset_end_;        
    QAction *action_clear_offset_markers_;  
    QAction *action_bytes_hex_;             
    QAction *action_bytes_dec_;             
    QAction *action_bytes_oct_;             
    QAction *action_bytes_bits_;            
    QAction *action_bytes_enc_from_packet_; 
    QAction *action_bytes_enc_ascii_;       
    QAction *action_bytes_enc_ebcdic_;      
    QAction *action_bytes_enc_utf8_;        
 
private slots:
    void copyBytes(bool unused);

    void setHexDisplayFormat(QAction *action);

    void setCharacterEncoding(QAction *action);

    void toggleHoverAllowed(bool allowed);

    void requestAddAnnotation();

    void requestEditAnnotation();

    void requestRemoveAnnotation();

    void requestSetOffsetStart();

    void requestSetOffsetEnd();

    void requestClearOffsetMarkers();
};