/* -*- 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 .
 */

#ifndef INCLUDED_OOX_VML_VMLSHAPECONTAINER_HXX
#define INCLUDED_OOX_VML_VMLSHAPECONTAINER_HXX

#include <cstddef>
#include <memory>
#include <stack>

#include <com/sun/star/awt/Rectangle.hpp>
#include <com/sun/star/uno/Reference.hxx>
#include <oox/helper/refmap.hxx>
#include <oox/helper/refvector.hxx>
#include <rtl/ustring.hxx>

namespace com::sun::star {
    namespace drawing { class XShapes; }
}

namespace oox::vml {

class Drawing;
class ShapeType;
class ShapeBase;


struct ShapeParentAnchor
{
    css::awt::Rectangle maShapeRect;
    css::awt::Rectangle maCoordSys;
};


/** Container that holds a list of shapes and shape templates. */
class ShapeContainer
{
public:
    typedef RefVector< ShapeBase >                  ShapeVector;

    explicit            ShapeContainer( Drawing& rDrawing );
                        ~ShapeContainer();

    /** Returns the drawing this shape container is part of. */
    Drawing&     getDrawing() { return mrDrawing; }

    /** Creates and returns a new shape template object. */
    std::shared_ptr<ShapeType> createShapeType();
    /** Creates and returns a new shape object of the specified type. */
    template< typename ShapeT >
    std::shared_ptr<ShapeT> createShape();

    /** Final processing after import of the drawing fragment. */
    void                finalizeFragmentImport();

    /** Returns true, if this container does not contain any shapes. */
    bool         empty() const { return maShapes.empty(); }

    /** Returns the shape template with the passed identifier.
        Searches in all group shapes too. */
    const ShapeType*    getShapeTypeById( const OUString& rShapeId ) const;
    /** Returns the shape with the passed identifier.
        Searches in all group shapes too. */
    const ShapeBase*    getShapeById( const OUString& rShapeId ) const;

    /** Searches for a shape by using the passed functor that takes a constant
        reference of a ShapeBase object. */
    template< typename Functor >
    const ShapeBase*    findShape( const Functor& rFunctor ) const;

    /**
      (Word only) Returns the last shape in the collection, if it is after the last
      mark from pushMark(), and removes it.
    */
    std::shared_ptr< ShapeBase > takeLastShape();
    /**
      Adds a recursion mark to the stack. It is possible that a shape contains <w:txbxContent>
      which contains another shape, and writerfilter needs to know which shape is from the inner
      ooxml context and which from the outer ooxml context, while it is necessary to keep
      at least shape types across such blocks. Therefore this function marks beginning
      of each shape xml block, and takeLastShape() returns only shapes from this block.
    */
    void pushMark();
    /**
      Removes a recursion mark.
    */
    void popMark();

    /** Creates and inserts all UNO shapes into the passed container. */
    void                convertAndInsert(
                            const css::uno::Reference< css::drawing::XShapes >& rxShapes,
                            const ShapeParentAnchor* pParentAnchor = nullptr ) const;

    const ShapeVector & getAllShapes() const { return maShapes; }

private:
    typedef RefVector< ShapeType >                  ShapeTypeVector;
    typedef RefMap< OUString, ShapeType >    ShapeTypeMap;
    typedef RefMap< OUString, ShapeBase >    ShapeMap;

    Drawing&            mrDrawing;          ///< The VML drawing page that contains this shape.
    ShapeTypeVector     maTypes;            ///< All shape templates.
    ShapeVector         maShapes;           ///< All shape definitions.
    ShapeTypeMap        maTypesById;        ///< All shape templates mapped by identifier.
    ShapeMap            maShapesById;       ///< All shape definitions mapped by identifier.
    std::stack< size_t > markStack;         ///< Recursion marks from pushMark()/popMark().
};


template< typename ShapeT >
std::shared_ptr<ShapeT> ShapeContainer::createShape()
{
    auto xShape = std::make_shared<ShapeT>( mrDrawing );
    xShape->setContainer(this);
    maShapes.push_back( xShape );
    return xShape;
}

template< typename Functor >
const ShapeBase* ShapeContainer::findShape( const Functor& rFunctor ) const
{
    return maShapes.findIf( rFunctor ).get();
}


} // namespace oox::vml

#endif

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