v1/v2: Add support for const iterators where necessary
git-svn-id: https://matroska.svn.sourceforge.net/svnroot/matroska/trunk/libebml@149 a6f86f6d-0131-4f8e-9e7b-e335508773d5
This commit is contained in:
Steve Lhomme
parent
2753bfd8a3
commit
da7b4816f3
@ -1,222 +1,228 @@
|
||||
/****************************************************************************
|
||||
** libebml : parse EBML files, see http://embl.sourceforge.net/
|
||||
**
|
||||
** <file/class description>
|
||||
**
|
||||
** Copyright (C) 2002-2010 Steve Lhomme. All rights reserved.
|
||||
**
|
||||
** This file is part of libebml.
|
||||
**
|
||||
** This library is free software; you can redistribute it and/or
|
||||
** modify it under the terms of the GNU Lesser General Public
|
||||
** License as published by the Free Software Foundation; either
|
||||
** version 2.1 of the License, or (at your option) any later version.
|
||||
**
|
||||
** 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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
|
||||
**
|
||||
** See http://www.matroska.org/license/lgpl/ for LGPL licensing information.
|
||||
**
|
||||
** Contact license@matroska.org if any conditions of this licensing are
|
||||
** not clear to you.
|
||||
**
|
||||
**********************************************************************/
|
||||
|
||||
/*!
|
||||
\file
|
||||
\version \$Id: EbmlMaster.h 1232 2005-10-15 15:56:52Z robux4 $
|
||||
\author Steve Lhomme <robux4 @ users.sf.net>
|
||||
*/
|
||||
#ifndef LIBEBML_MASTER_H
|
||||
#define LIBEBML_MASTER_H
|
||||
|
||||
#include <string>
|
||||
#include <vector>
|
||||
|
||||
#include "EbmlTypes.h"
|
||||
#include "EbmlElement.h"
|
||||
#include "EbmlCrc32.h"
|
||||
|
||||
#define EBML_MASTER_ITERATOR std::vector<EbmlElement *>::const_iterator
|
||||
#define EBML_MASTER_RITERATOR std::vector<EbmlElement *>::const_reverse_iterator
|
||||
|
||||
START_LIBEBML_NAMESPACE
|
||||
|
||||
const bool bChecksumUsedByDefault = false;
|
||||
|
||||
/*!
|
||||
\class EbmlMaster
|
||||
\brief Handle all operations on an EBML element that contains other EBML elements
|
||||
*/
|
||||
class EBML_DLL_API EbmlMaster : public EbmlElement {
|
||||
public:
|
||||
EbmlMaster(const EbmlSemanticContext & aContext, bool bSizeIsKnown = true);
|
||||
EbmlMaster(const EbmlMaster & ElementToClone);
|
||||
virtual bool ValidateSize() const {return true;}
|
||||
/*!
|
||||
\warning be carefull to clear the memory allocated in the ElementList elsewhere
|
||||
*/
|
||||
virtual ~EbmlMaster();
|
||||
|
||||
filepos_t RenderData(IOCallback & output, bool bForceRender, bool bWithDefault = false);
|
||||
filepos_t ReadData(IOCallback & input, ScopeMode ReadFully);
|
||||
filepos_t UpdateSize(bool bWithDefault = false, bool bForceRender = false);
|
||||
|
||||
/*!
|
||||
\brief Set wether the size is finite (size is known in advance when writing, or infinite size is not known on writing)
|
||||
*/
|
||||
bool SetSizeInfinite(bool aIsInfinite = true) {SetSizeIsFinite(!aIsInfinite); return true;}
|
||||
|
||||
bool PushElement(EbmlElement & element);
|
||||
uint64 GetSize() const {
|
||||
if (IsFiniteSize())
|
||||
return EbmlElement::GetSize();
|
||||
else
|
||||
return (0-1);
|
||||
}
|
||||
|
||||
uint64 GetDataStart() const {
|
||||
return GetElementPosition() + EBML_ID_LENGTH((const EbmlId&)*this) + CodedSizeLength(GetSize(), GetSizeLength(), IsFiniteSize());
|
||||
}
|
||||
|
||||
/*!
|
||||
\brief find the element corresponding to the ID of the element, NULL if not found
|
||||
*/
|
||||
EbmlElement *FindElt(const EbmlCallbacks & Callbacks) const;
|
||||
/*!
|
||||
\brief find the first element corresponding to the ID of the element
|
||||
*/
|
||||
EbmlElement *FindFirstElt(const EbmlCallbacks & Callbacks, bool bCreateIfNull);
|
||||
EbmlElement *FindFirstElt(const EbmlCallbacks & Callbacks) const;
|
||||
|
||||
/*!
|
||||
\brief find the element of the same type of PasElt following in the list of elements
|
||||
*/
|
||||
EbmlElement *FindNextElt(const EbmlElement & PastElt, bool bCreateIfNull);
|
||||
EbmlElement *FindNextElt(const EbmlElement & PastElt) const;
|
||||
EbmlElement *AddNewElt(const EbmlCallbacks & Callbacks);
|
||||
|
||||
/*!
|
||||
\brief add an element at a specified location
|
||||
*/
|
||||
bool InsertElement(EbmlElement & element, size_t position = 0);
|
||||
bool InsertElement(EbmlElement & element, const EbmlElement & before);
|
||||
|
||||
/*!
|
||||
\brief Read the data and keep the known children
|
||||
*/
|
||||
void Read(EbmlStream & inDataStream, const EbmlSemanticContext & Context, int & UpperEltFound, EbmlElement * & FoundElt, bool AllowDummyElt, ScopeMode ReadFully = SCOPE_ALL_DATA);
|
||||
|
||||
/*!
|
||||
\brief sort Data when they can
|
||||
*/
|
||||
void Sort();
|
||||
|
||||
size_t ListSize() const {return ElementList.size();}
|
||||
|
||||
inline EBML_MASTER_ITERATOR begin() const {return ElementList.begin();}
|
||||
inline EBML_MASTER_ITERATOR end() const {return ElementList.end();}
|
||||
inline EBML_MASTER_RITERATOR rbegin() const {return ElementList.rbegin();}
|
||||
inline EBML_MASTER_RITERATOR rend() const {return ElementList.rend();}
|
||||
|
||||
EbmlElement * operator[](unsigned int position) {return ElementList[position];}
|
||||
const EbmlElement * operator[](unsigned int position) const {return ElementList[position];}
|
||||
|
||||
bool IsDefaultValue() const {
|
||||
return (ElementList.size() == 0);
|
||||
}
|
||||
virtual bool IsMaster() const {return true;}
|
||||
|
||||
/*!
|
||||
\brief verify that all mandatory elements are present
|
||||
\note usefull after reading or before writing
|
||||
*/
|
||||
bool CheckMandatory() const;
|
||||
|
||||
/*!
|
||||
\brief Remove an element from the list of the master
|
||||
*/
|
||||
void Remove(size_t Index);
|
||||
void Remove(const EBML_MASTER_ITERATOR & Itr);
|
||||
void Remove(const EBML_MASTER_RITERATOR & Itr);
|
||||
|
||||
/*!
|
||||
\brief remove all elements, even the mandatory ones
|
||||
*/
|
||||
void RemoveAll() {ElementList.clear();}
|
||||
|
||||
/*!
|
||||
\brief facility for Master elements to write only the head and force the size later
|
||||
\warning
|
||||
*/
|
||||
filepos_t WriteHead(IOCallback & output, int SizeLength, bool bWithDefault = false);
|
||||
|
||||
void EnableChecksum(bool bIsEnabled = true) { bChecksumUsed = bIsEnabled; }
|
||||
bool HasChecksum() const {return bChecksumUsed;}
|
||||
bool VerifyChecksum() const;
|
||||
uint32 GetCrc32() const {return Checksum.GetCrc32();}
|
||||
void ForceChecksum(uint32 NewChecksum) {
|
||||
Checksum.ForceCrc32(NewChecksum);
|
||||
bChecksumUsed = true;
|
||||
}
|
||||
|
||||
/*!
|
||||
\brief drill down all sub-elements, finding any missing elements
|
||||
*/
|
||||
std::vector<std::string> FindAllMissingElements();
|
||||
|
||||
#if defined(EBML_STRICT_API)
|
||||
private:
|
||||
#else
|
||||
protected:
|
||||
#endif
|
||||
std::vector<EbmlElement *> ElementList;
|
||||
|
||||
const EbmlSemanticContext & Context;
|
||||
|
||||
bool bChecksumUsed;
|
||||
EbmlCrc32 Checksum;
|
||||
|
||||
private:
|
||||
/*!
|
||||
\brief Add all the mandatory elements to the list
|
||||
*/
|
||||
bool ProcessMandatory();
|
||||
};
|
||||
|
||||
///< \todo add a restriction to only elements legal in the context
|
||||
template <typename Type>
|
||||
Type & GetChild(EbmlMaster & Master)
|
||||
{
|
||||
return *(static_cast<Type *>(Master.FindFirstElt(EBML_INFO(Type), true)));
|
||||
}
|
||||
// call with
|
||||
// MyDocType = GetChild<EDocType>(TestHead);
|
||||
|
||||
template <typename Type>
|
||||
Type * FindChild(EbmlMaster & Master)
|
||||
{
|
||||
return static_cast<Type *>(Master.FindFirstElt(EBML_INFO(Type), false));
|
||||
}
|
||||
|
||||
template <typename Type>
|
||||
Type & GetNextChild(EbmlMaster & Master, const Type & PastElt)
|
||||
{
|
||||
return *(static_cast<Type *>(Master.FindNextElt(PastElt, true)));
|
||||
}
|
||||
|
||||
template <typename Type>
|
||||
Type & AddNewChild(EbmlMaster & Master)
|
||||
{
|
||||
return *(static_cast<Type *>(Master.AddNewElt(EBML_INFO(Type))));
|
||||
}
|
||||
|
||||
END_LIBEBML_NAMESPACE
|
||||
|
||||
#endif // LIBEBML_MASTER_H
|
||||
/****************************************************************************
|
||||
** libebml : parse EBML files, see http://embl.sourceforge.net/
|
||||
**
|
||||
** <file/class description>
|
||||
**
|
||||
** Copyright (C) 2002-2010 Steve Lhomme. All rights reserved.
|
||||
**
|
||||
** This file is part of libebml.
|
||||
**
|
||||
** This library is free software; you can redistribute it and/or
|
||||
** modify it under the terms of the GNU Lesser General Public
|
||||
** License as published by the Free Software Foundation; either
|
||||
** version 2.1 of the License, or (at your option) any later version.
|
||||
**
|
||||
** 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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
|
||||
**
|
||||
** See http://www.matroska.org/license/lgpl/ for LGPL licensing information.
|
||||
**
|
||||
** Contact license@matroska.org if any conditions of this licensing are
|
||||
** not clear to you.
|
||||
**
|
||||
**********************************************************************/
|
||||
|
||||
/*!
|
||||
\file
|
||||
\version \$Id: EbmlMaster.h 1232 2005-10-15 15:56:52Z robux4 $
|
||||
\author Steve Lhomme <robux4 @ users.sf.net>
|
||||
*/
|
||||
#ifndef LIBEBML_MASTER_H
|
||||
#define LIBEBML_MASTER_H
|
||||
|
||||
#include <string>
|
||||
#include <vector>
|
||||
|
||||
#include "EbmlTypes.h"
|
||||
#include "EbmlElement.h"
|
||||
#include "EbmlCrc32.h"
|
||||
|
||||
#define EBML_MASTER_ITERATOR std::vector<EbmlElement *>::iterator
|
||||
#define EBML_MASTER_CONST_ITERATOR std::vector<EbmlElement *>::const_iterator
|
||||
#define EBML_MASTER_RITERATOR std::vector<EbmlElement *>::reverse_iterator
|
||||
#define EBML_MASTER_CONST_RITERATOR std::vector<EbmlElement *>::const_reverse_iterator
|
||||
|
||||
START_LIBEBML_NAMESPACE
|
||||
|
||||
const bool bChecksumUsedByDefault = false;
|
||||
|
||||
/*!
|
||||
\class EbmlMaster
|
||||
\brief Handle all operations on an EBML element that contains other EBML elements
|
||||
*/
|
||||
class EBML_DLL_API EbmlMaster : public EbmlElement {
|
||||
public:
|
||||
EbmlMaster(const EbmlSemanticContext & aContext, bool bSizeIsKnown = true);
|
||||
EbmlMaster(const EbmlMaster & ElementToClone);
|
||||
virtual bool ValidateSize() const {return true;}
|
||||
/*!
|
||||
\warning be carefull to clear the memory allocated in the ElementList elsewhere
|
||||
*/
|
||||
virtual ~EbmlMaster();
|
||||
|
||||
filepos_t RenderData(IOCallback & output, bool bForceRender, bool bWithDefault = false);
|
||||
filepos_t ReadData(IOCallback & input, ScopeMode ReadFully);
|
||||
filepos_t UpdateSize(bool bWithDefault = false, bool bForceRender = false);
|
||||
|
||||
/*!
|
||||
\brief Set wether the size is finite (size is known in advance when writing, or infinite size is not known on writing)
|
||||
*/
|
||||
bool SetSizeInfinite(bool aIsInfinite = true) {SetSizeIsFinite(!aIsInfinite); return true;}
|
||||
|
||||
bool PushElement(EbmlElement & element);
|
||||
uint64 GetSize() const {
|
||||
if (IsFiniteSize())
|
||||
return EbmlElement::GetSize();
|
||||
else
|
||||
return (0-1);
|
||||
}
|
||||
|
||||
uint64 GetDataStart() const {
|
||||
return GetElementPosition() + EBML_ID_LENGTH((const EbmlId&)*this) + CodedSizeLength(GetSize(), GetSizeLength(), IsFiniteSize());
|
||||
}
|
||||
|
||||
/*!
|
||||
\brief find the element corresponding to the ID of the element, NULL if not found
|
||||
*/
|
||||
EbmlElement *FindElt(const EbmlCallbacks & Callbacks) const;
|
||||
/*!
|
||||
\brief find the first element corresponding to the ID of the element
|
||||
*/
|
||||
EbmlElement *FindFirstElt(const EbmlCallbacks & Callbacks, bool bCreateIfNull);
|
||||
EbmlElement *FindFirstElt(const EbmlCallbacks & Callbacks) const;
|
||||
|
||||
/*!
|
||||
\brief find the element of the same type of PasElt following in the list of elements
|
||||
*/
|
||||
EbmlElement *FindNextElt(const EbmlElement & PastElt, bool bCreateIfNull);
|
||||
EbmlElement *FindNextElt(const EbmlElement & PastElt) const;
|
||||
EbmlElement *AddNewElt(const EbmlCallbacks & Callbacks);
|
||||
|
||||
/*!
|
||||
\brief add an element at a specified location
|
||||
*/
|
||||
bool InsertElement(EbmlElement & element, size_t position = 0);
|
||||
bool InsertElement(EbmlElement & element, const EbmlElement & before);
|
||||
|
||||
/*!
|
||||
\brief Read the data and keep the known children
|
||||
*/
|
||||
void Read(EbmlStream & inDataStream, const EbmlSemanticContext & Context, int & UpperEltFound, EbmlElement * & FoundElt, bool AllowDummyElt, ScopeMode ReadFully = SCOPE_ALL_DATA);
|
||||
|
||||
/*!
|
||||
\brief sort Data when they can
|
||||
*/
|
||||
void Sort();
|
||||
|
||||
size_t ListSize() const {return ElementList.size();}
|
||||
|
||||
inline EBML_MASTER_ITERATOR begin() {return ElementList.begin();}
|
||||
inline EBML_MASTER_ITERATOR end() {return ElementList.end();}
|
||||
inline EBML_MASTER_RITERATOR rbegin() {return ElementList.rbegin();}
|
||||
inline EBML_MASTER_RITERATOR rend() {return ElementList.rend();}
|
||||
inline EBML_MASTER_CONST_ITERATOR begin() const {return ElementList.begin();}
|
||||
inline EBML_MASTER_CONST_ITERATOR end() const {return ElementList.end();}
|
||||
inline EBML_MASTER_CONST_RITERATOR rbegin() const {return ElementList.rbegin();}
|
||||
inline EBML_MASTER_CONST_RITERATOR rend() const {return ElementList.rend();}
|
||||
|
||||
EbmlElement * operator[](unsigned int position) {return ElementList[position];}
|
||||
const EbmlElement * operator[](unsigned int position) const {return ElementList[position];}
|
||||
|
||||
bool IsDefaultValue() const {
|
||||
return (ElementList.size() == 0);
|
||||
}
|
||||
virtual bool IsMaster() const {return true;}
|
||||
|
||||
/*!
|
||||
\brief verify that all mandatory elements are present
|
||||
\note usefull after reading or before writing
|
||||
*/
|
||||
bool CheckMandatory() const;
|
||||
|
||||
/*!
|
||||
\brief Remove an element from the list of the master
|
||||
*/
|
||||
void Remove(size_t Index);
|
||||
void Remove(EBML_MASTER_ITERATOR & Itr);
|
||||
void Remove(EBML_MASTER_RITERATOR & Itr);
|
||||
|
||||
/*!
|
||||
\brief remove all elements, even the mandatory ones
|
||||
*/
|
||||
void RemoveAll() {ElementList.clear();}
|
||||
|
||||
/*!
|
||||
\brief facility for Master elements to write only the head and force the size later
|
||||
\warning
|
||||
*/
|
||||
filepos_t WriteHead(IOCallback & output, int SizeLength, bool bWithDefault = false);
|
||||
|
||||
void EnableChecksum(bool bIsEnabled = true) { bChecksumUsed = bIsEnabled; }
|
||||
bool HasChecksum() const {return bChecksumUsed;}
|
||||
bool VerifyChecksum() const;
|
||||
uint32 GetCrc32() const {return Checksum.GetCrc32();}
|
||||
void ForceChecksum(uint32 NewChecksum) {
|
||||
Checksum.ForceCrc32(NewChecksum);
|
||||
bChecksumUsed = true;
|
||||
}
|
||||
|
||||
/*!
|
||||
\brief drill down all sub-elements, finding any missing elements
|
||||
*/
|
||||
std::vector<std::string> FindAllMissingElements();
|
||||
|
||||
#if defined(EBML_STRICT_API)
|
||||
private:
|
||||
#else
|
||||
protected:
|
||||
#endif
|
||||
std::vector<EbmlElement *> ElementList;
|
||||
|
||||
const EbmlSemanticContext & Context;
|
||||
|
||||
bool bChecksumUsed;
|
||||
EbmlCrc32 Checksum;
|
||||
|
||||
private:
|
||||
/*!
|
||||
\brief Add all the mandatory elements to the list
|
||||
*/
|
||||
bool ProcessMandatory();
|
||||
};
|
||||
|
||||
///< \todo add a restriction to only elements legal in the context
|
||||
template <typename Type>
|
||||
Type & GetChild(EbmlMaster & Master)
|
||||
{
|
||||
return *(static_cast<Type *>(Master.FindFirstElt(EBML_INFO(Type), true)));
|
||||
}
|
||||
// call with
|
||||
// MyDocType = GetChild<EDocType>(TestHead);
|
||||
|
||||
template <typename Type>
|
||||
Type * FindChild(EbmlMaster & Master)
|
||||
{
|
||||
return static_cast<Type *>(Master.FindFirstElt(EBML_INFO(Type), false));
|
||||
}
|
||||
|
||||
template <typename Type>
|
||||
Type & GetNextChild(EbmlMaster & Master, const Type & PastElt)
|
||||
{
|
||||
return *(static_cast<Type *>(Master.FindNextElt(PastElt, true)));
|
||||
}
|
||||
|
||||
template <typename Type>
|
||||
Type & AddNewChild(EbmlMaster & Master)
|
||||
{
|
||||
return *(static_cast<Type *>(Master.AddNewElt(EBML_INFO(Type))));
|
||||
}
|
||||
|
||||
END_LIBEBML_NAMESPACE
|
||||
|
||||
#endif // LIBEBML_MASTER_H
|
||||
|
||||
@ -482,12 +482,12 @@ void EbmlMaster::Remove(size_t Index)
|
||||
}
|
||||
}
|
||||
|
||||
void EbmlMaster::Remove(const std::vector<EbmlElement *>::const_iterator & Itr)
|
||||
void EbmlMaster::Remove(EBML_MASTER_ITERATOR & Itr)
|
||||
{
|
||||
ElementList.erase(Itr);
|
||||
}
|
||||
|
||||
void EbmlMaster::Remove(const std::vector<EbmlElement *>::const_reverse_iterator & Itr)
|
||||
void EbmlMaster::Remove(EBML_MASTER_RITERATOR & Itr)
|
||||
{
|
||||
ElementList.erase(Itr.base());
|
||||
}
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user