qt-creator/src/tools/clangbackend/ipcsource/clangtranslationunits.h

/****************************************************************************
**
** Copyright (C) 2016 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of Qt Creator.
**
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/contact-us.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 3 as published by the Free Software
** Foundation with exceptions as appearing in the file LICENSE.GPL3-EXCEPT
** included in the packaging of this file. Please review the following
** information to ensure the GNU General Public License requirements will
** be met: https://www.gnu.org/licenses/gpl-3.0.html.
**
****************************************************************************/

#pragma once

#include "clangbackend_global.h"
#include "clangclock.h"

#include <utf8string.h>

#include <clang-c/Index.h>

#include <QList>
#include <QSharedPointer>

namespace ClangBackEnd {

class TranslationUnit;

class TranslationUnits
{
public:
    class TranslationUnitData {
    public:
        TranslationUnitData(const Utf8String &id);
        ~TranslationUnitData();

        Utf8String id;

        CXTranslationUnit cxTranslationUnit = nullptr;
        CXIndex cxIndex = nullptr;

        TimePoint parseTimePoint;
    };
    using TranslationUnitDataPtr = QSharedPointer<TranslationUnitData>;

public:
    TranslationUnits(const Utf8String &filePath);

    TranslationUnit createAndAppend();
    TranslationUnit get(PreferredTranslationUnit type = PreferredTranslationUnit::RecentlyParsed);
    void updateParseTimePoint(const Utf8String &translationUnitId, TimePoint timePoint);

    bool areAllTranslationUnitsParsed() const;

public: // for tests
    int size() const;
    TimePoint parseTimePoint(const Utf8String &translationUnitId);

private:
    TranslationUnit getPreferredTranslationUnit(PreferredTranslationUnit type);
    TranslationUnitData &findUnit(const Utf8String &translationUnitId);
    TranslationUnit toTranslationUnit(const TranslationUnitDataPtr &unit);

private:
    Utf8String m_filePath;
    QList<TranslationUnitDataPtr> m_units;
};

} // namespace ClangBackEnd