ProtocolAnalyzerDialog.h

Go to the documentation of this file.

/***********************************************************************************************************************
*                                                                                                                      *
* ngscopeclient                                                                                                        *
*                                                                                                                      *
* Copyright (c) 2012-2026 Andrew D. Zonenberg and contributors                                                         *
* All rights reserved.                                                                                                 *
*                                                                                                                      *
* Redistribution and use in source and binary forms, with or without modification, are permitted provided that the     *
* following conditions are met:                                                                                        *
*                                                                                                                      *
*    * Redistributions of source code must retain the above copyright notice, this list of conditions, and the         *
*      following disclaimer.                                                                                           *
*                                                                                                                      *
*    * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the       *
*      following disclaimer in the documentation and/or other materials provided with the distribution.                *
*                                                                                                                      *
*    * Neither the name of the author nor the names of any contributors may be used to endorse or promote products     *
*      derived from this software without specific prior written permission.                                           *
*                                                                                                                      *
* THIS SOFTWARE IS PROVIDED BY THE AUTHORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED   *
* TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL *
* THE AUTHORS BE HELD LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES        *
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR       *
* BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT *
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE       *
* POSSIBILITY OF SUCH DAMAGE.                                                                                          *
*                                                                                                                      *
***********************************************************************************************************************/
 
#ifndef ProtocolAnalyzerDialog_h
#define ProtocolAnalyzerDialog_h
 
#include "Dialog.h"
#include "Session.h"
 
#include "../scopehal/PacketDecoder.h"
 
class MainWindow;
 
class ProtocolAnalyzerDialog
    : public Dialog
    , public SinkNode
{
public:
    ProtocolAnalyzerDialog(
        PacketDecoder* filter,
        std::shared_ptr<PacketManager> mgr,
        Session* session,
        MainWindow* wnd);
    virtual ~ProtocolAnalyzerDialog();
 
    virtual bool DoRender() override;
    virtual bool Render() override;
 
    bool PollForSelectionChanges()
    {
        bool changed = m_waveformChanged;
        m_waveformChanged = false;
        return changed;
    }
 
    TimePoint GetSelectedWaveformTimestamp()
    { return m_lastSelectedWaveform; }
 
    PacketDecoder* GetFilter()
    { return dynamic_cast<PacketDecoder*>(GetInput(0).m_channel); }
 
    void OnWaveformLoaded(TimePoint t)
    { m_lastSelectedWaveform = t; }
 
    void OnCursorMoved(int64_t offset);
 
    const std::string& GetFilterExpression()
    { return m_filterExpression; }
 
    void SetFilterExpression(const std::string& f);
 
protected:
    std::shared_ptr<PacketManager> m_mgr;
 
    bool m_waveformChanged;
 
    TimePoint m_lastSelectedWaveform;
 
    Packet* m_selectedPacket;
 
    enum
    {
        FORMAT_HEX,
        FORMAT_ASCII,
        FORMAT_HEXDUMP
    } m_dataFormat;
 
    bool m_needToScrollToSelectedPacket;
 
    void DoDataColumn(Packet* pack, FontWithSize dataFont, std::vector<RowData>& rows, size_t nrow);
    void DoImageColumn(PacketDecoder* f, Packet* pack, std::vector<RowData>& rows, size_t nrow);
 
    bool m_firstDataBlockOfFrame;
 
    size_t m_bytesPerLine;
 
    std::string m_filterExpression;
 
    std::string m_committedFilterExpression;
};
 
#endif