/***************************************************************************
 *   This library is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU Lesser General Public License version   *
 *   2.1 as published by the Free Software Foundation.                     *
 *                                                                         *
 *   This library 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     *
 *   Lesser General Public License for more details.                       *
 *                                                                         *
 *   You should have received a copy of the GNU Lesser General Public      *
 *   License along with this library; if not, write to the Free Software   *
 *   Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA         *
 *   02110-1301  USA                                                       *
 *                                                                         *
 *   Alternatively, this file is available under the Mozilla Public        *
 *   License Version 1.1.  You may obtain a copy of the License at         *
 *   http://www.mozilla.org/MPL/                                           *
 ***************************************************************************/

#ifndef TAGLIB_MATROSKAELEMENT_H
#define TAGLIB_MATROSKAELEMENT_H
#ifndef DO_NOT_DOCUMENT

#include <memory>
#include "taglib_export.h"
#include "taglib.h"
#include "tlist.h"
#include "matroskawritestyle.h"

namespace TagLib {
  class File;
  class ByteVector;

  namespace Matroska {
    class TAGLIB_EXPORT Element
    {
    public:
      using ID = unsigned int;
      explicit Element(ID id);
      virtual ~Element();

      offset_t size() const;
      offset_t offset() const;
      ID id() const;
      void setOffset(offset_t offset);
      void adjustOffset(offset_t delta);
      void setSize(offset_t size);
      void setID(ID id);
      virtual bool render();
      void setNeedsRender(bool needsRender);
      bool needsRender() const;
      void setData(const ByteVector &data);
      const ByteVector &data() const;
      virtual void write(TagLib::File &file);
      void clearSizeListeners();
      void addSizeListener(Element *element);
      void addSizeListeners(const List<Element *> &elements);
      bool emitSizeChanged(offset_t delta);
      virtual bool sizeChanged(Element &caller, offset_t delta);

      void setWriteStyle(WriteStyle style);
      WriteStyle writeStyle() const;
      void setIsLastElement(bool isLast);
      void setAppendOffset(offset_t appendOffset);
      bool wasMoved() const;
      //! Mark this element as the trailing element of the segment (no other
      //! element follows it in the file). Trailing elements may shrink even
      //! in non-Compact write styles because no offsets need to be preserved.
      void setIsTrailingInSegment(bool isTrailing);
      bool isTrailingInSegment() const;

    protected:
      offset_t sizeRenderedOrWritten() const;

    private:
      virtual ByteVector renderInternal() = 0;

      class ElementPrivate;
      TAGLIB_MSVC_SUPPRESS_WARNING_NEEDS_TO_HAVE_DLL_INTERFACE
      std::unique_ptr<ElementPrivate> e;
    };
  }
}

#endif
#endif