/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   Licensed to the Apache Software Foundation (ASF) under one or more
 *   contributor license agreements. See the NOTICE file distributed
 *   with this work for additional information regarding copyright
 *   ownership. The ASF licenses this file to you under the Apache
 *   License, Version 2.0 (the "License"); you may not use this file
 *   except in compliance with the License. You may obtain a copy of
 *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
 */

#pragma once

#include <sal/config.h>
#include <sal/log.hxx>

#include <memory>
#include <vector>

#include <editeng/outliner.hxx>
#include <o3tl/safeint.hxx>
#include <tools/link.hxx>

class Paragraph;
typedef struct _xmlTextWriter* xmlTextWriterPtr;

class ParagraphList
{
public:
    void            Clear();

    sal_Int32       GetParagraphCount() const
    {
        size_t nSize = maEntries.size();
        if (nSize > SAL_MAX_INT32)
        {
            SAL_WARN( "editeng", "ParagraphList::GetParagraphCount - overflow " << nSize);
            return SAL_MAX_INT32;
        }
        return nSize;
    }

    Paragraph*      GetParagraph( sal_Int32 nPos ) const
    {
        return 0 <= nPos && o3tl::make_unsigned(nPos) < maEntries.size() ? maEntries[nPos].get() : nullptr;
    }

    sal_Int32       GetAbsPos( Paragraph const * pParent ) const;

    void            Append( std::unique_ptr<Paragraph> pPara);
    void            Insert( std::unique_ptr<Paragraph> pPara, sal_Int32 nAbsPos);
    void            Remove( sal_Int32 nPara );
    void            MoveParagraphs( sal_Int32 nStart, sal_Int32 nDest, sal_Int32 nCount );

    Paragraph*      GetParent( Paragraph const * pParagraph ) const;
    bool            HasChildren( Paragraph const * pParagraph ) const;
    bool            HasHiddenChildren( Paragraph const * pParagraph ) const;
    bool            HasVisibleChildren( Paragraph const * pParagraph ) const;
    sal_Int32       GetChildCount( Paragraph const * pParagraph ) const;

    void            Expand( Paragraph const * pParent );
    void            Collapse( Paragraph const * pParent );

    void            SetVisibleStateChangedHdl( const Link<Paragraph&,void>& rLink ) { aVisibleStateChangedHdl = rLink; }

    void            dumpAsXml(xmlTextWriterPtr pWriter) const;

private:

    Link<Paragraph&,void> aVisibleStateChangedHdl;
    std::vector<std::unique_ptr<Paragraph>> maEntries;
};

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */