/****************************************************************************
**
** 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 "highlightingmarksiterator.h"

#include <clang-c/Index.h>

#include <vector>

namespace ClangBackEnd {

using uint = unsigned int;
class HighlightingMarkContainer;

class HighlightingMarks
{
public:
    using const_iterator = HighlightingMarksIterator;
    using value_type = HighlightingMark;

public:
    HighlightingMarks() = default;
    HighlightingMarks(CXTranslationUnit cxTranslationUnit, CXToken *tokens, uint tokensCount);
    ~HighlightingMarks();

    bool isEmpty() const;
    bool isNull() const;
    uint size() const;

    HighlightingMark operator[](size_t index) const;

    const_iterator begin() const;
    const_iterator end() const;

    QVector<HighlightingMarkContainer> toHighlightingMarksContainers() const;

    bool currentOutputArgumentRangesAreEmpty() const;

private:
    mutable std::vector<CXSourceRange> currentOutputArgumentRanges;
    CXTranslationUnit cxTranslationUnit = nullptr;
    CXToken *const cxToken = nullptr;
    const uint cxTokenCount = 0;

    std::vector<CXCursor> cxCursor;
};

std::ostream &operator<<(std::ostream &out, const HighlightingMarks &marks);

} // namespace ClangBackEnd
