TranslationUnitModel.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 "common/FileManager.h"
#include <QJsonArray>
#include <QJsonObject>
#include <QHash>
#include <QMap>
#include <QStandardItemModel>
#include <QString>
 
namespace acav {

class TranslationUnitModel : public QStandardItemModel {
  Q_OBJECT
 
public:
  explicit TranslationUnitModel(FileManager &fileManager, QObject *parent = nullptr);
  ~TranslationUnitModel() override = default;
 
  bool hasChildren(const QModelIndex &parent = QModelIndex()) const override;
  bool canFetchMore(const QModelIndex &parent) const override;
  void fetchMore(const QModelIndex &parent) override;

  void populateFromDependencies(const QJsonObject &dependenciesJson,
                                const QString &overrideProjectRoot = QString(),
                                const QString &compilationDbPath = QString());

  QString getSourceFilePathFromIndex(const QModelIndex &index) const;

  QStringList getIncludedHeadersForSource(const QString &sourceFilePath) const;

  QModelIndex findIndexByFilePath(const QString &filePath) const;
  QModelIndex findIndexByAnyFilePath(const QString &filePath) const;
  QModelIndex findIndexByAnyFilePathUnder(const QString &filePath,
                                          const QModelIndex &root) const;

  QModelIndex findIndexByFileId(FileID fileId) const;

  void clear();

  QString projectRoot() const { return projectRoot_; }
 
private:
  QString computeProjectRoot(const QStringList &sourceFilePaths) const;

  QString computeProjectRootSmart(const QStringList &sourceFilePaths,
                                  const QString &compilationDbPath) const;

  void buildDirectoryTree(QStandardItem *parent, const QStringList &filePaths,
                          const QString &rootPath,
                          const QHash<QString, QJsonObject> *fileDataMap);

  void addHeaderCategory(QStandardItem *parent, const QString &categoryName,
                         const QStringList &headers, const QString &rootPath);
 
  void populateHeadersForSourceItem(QStandardItem *sourceItem);
 
  FileManager &fileManager_;  
  QString projectRoot_;       
  QHash<QString, QStandardItem *> sourceItemByPath_;
};
 
} // namespace acav