AstModel.h

Go to the documentation of this file.

/*$!{
* Aurora Clang AST Viewer (ACAV)
* 
* Copyright (c) 2026 Min Liu
* Copyright (c) 2026 Michael David Adams
* 
* SPDX-License-Identifier: GPL-2.0-or-later
* 
* 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 2 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 <https://www.gnu.org/licenses/>.
}$!*/

#pragma once
 
#include "core/AstNode.h"
#include <QAbstractItemModel>
#include <QString>
#include <vector>
 
namespace acav {

class AstModel : public QAbstractItemModel {
  Q_OBJECT
 
public:
  explicit AstModel(QObject *parent = nullptr);
  ~AstModel() override;

  void setEmptyMessage(const QString &message);

  void setRootNode(AstViewNode *root);

  void setTotalNodeCount(std::size_t count) { totalNodeCount_ = count; }

  void clear();

  int visibleNodeCount() const;
 
  // QAbstractItemModel interface
  QModelIndex index(int row, int column,
                    const QModelIndex &parent = QModelIndex()) const override;
  QModelIndex parent(const QModelIndex &child) const override;
  int rowCount(const QModelIndex &parent = QModelIndex()) const override;
  int columnCount(const QModelIndex &parent = QModelIndex()) const override;
  QVariant data(const QModelIndex &index,
                int role = Qt::DisplayRole) const override;
  QVariant headerData(int section, Qt::Orientation orientation,
                      int role = Qt::DisplayRole) const override;
  Qt::ItemFlags flags(const QModelIndex &index) const override;
 
  // Custom roles
  enum CustomRoles {
    NodePtrRole = Qt::UserRole + 1 // Returns AstViewNode*
  };

  QModelIndex selectNode(AstViewNode *node);

  void updateSelectionFromIndex(const QModelIndex &index);

  AstViewNode *selectedNode() const { return selectedNode_; }

  bool hasNodes() const { return root_ != nullptr; }
 
signals:
  void nodeSelected(AstViewNode *node);
 
private:
  AstViewNode *getNodeFromIndex(const QModelIndex &index) const;

  QModelIndex findNodeIndex(AstViewNode *node) const;

  const std::vector<AstViewNode *> &
  visibleChildrenFor(AstViewNode *parent) const;

  int visibleRow(AstViewNode *node) const;
 
  AstViewNode *root_ = nullptr; // Not owned - AstContext owns all nodes
  AstViewNode *selectedNode_ = nullptr;
  std::size_t totalNodeCount_ = 0;
  QString emptyMessage_;
};
 
} // namespace acav