Merge all the documentation from Archivable.h together
This commit is contained in:
Niels Sascha Reedijk
@@ -187,6 +187,513 @@
|
||||
*/
|
||||
|
||||
|
||||
///// BArchiver /////
|
||||
|
||||
|
||||
/*!
|
||||
\class BArchiver
|
||||
\ingroup support
|
||||
\ingroup libbe
|
||||
\brief A class that simplifies the archiving of complicated BArchivable
|
||||
hierarchies.
|
||||
|
||||
The BArchiver class is a small class that is used for archiving of
|
||||
complicated BArchivable hierarchies. Such a hierarchy may include
|
||||
multiple BArchivable objects, each of which might be referenced by
|
||||
many BArchivable objects. With the BArchiver class, you can be certain
|
||||
that each BArchivable object is archived only once with very little work.
|
||||
When used in conjuction with the BArchivable::AllArchived() and
|
||||
BArchivable::AllUnarchived() methods, it is simple to rebuild your system of
|
||||
references upon unarchival so that they are equivalent to those that were
|
||||
present in your original hierarchy.
|
||||
|
||||
The objects you archive can be retrieved using a BUnarchiver object.
|
||||
*/
|
||||
|
||||
|
||||
/*!
|
||||
\fn BArchiver::BArchiver(BMessage* archive)
|
||||
\brief Constructs a BArchiver object that manages \c archive.
|
||||
*/
|
||||
|
||||
|
||||
/*!
|
||||
\fn BArchiver::~BArchiver()
|
||||
\brief Destroys a BArchiver object. If the BArchiver object has not had its
|
||||
Finish() method called, this will be done now.
|
||||
*/
|
||||
|
||||
|
||||
/*!
|
||||
\fn status_t BArchiver::AddArchivable(const char* name,
|
||||
BArchivable* archivable, bool deep = true)
|
||||
\brief Adds a reference to \c archivable to the archive used to
|
||||
construct this BArchiver. May call \c archivable's Archive() method.
|
||||
|
||||
\param name Where this reference will be stored in the archive.
|
||||
\param archivable The BArchivable* object that to reference.
|
||||
\param deep Passed to \c archivable->Archive() if \c archivable must
|
||||
be archived.
|
||||
|
||||
Adds a reference to \c archivable to your archive. If \c archivable has
|
||||
not yet been archived, then its Archive() method is called. BArchiver
|
||||
can only track BArchivable objects that have been archived through this
|
||||
method or the GetTokenForArchivable() methods.
|
||||
|
||||
\warning If you manually archive an object, and then pass it to
|
||||
AddArchivable() or GetTokenForArchivable(), it will be archived again,
|
||||
and when unarchived you will end up with two different BArchivable
|
||||
objects.
|
||||
*/
|
||||
|
||||
|
||||
/*!
|
||||
\fn status_t BArchiver::GetTokenForArchivable(BArchivable* archivable,
|
||||
bool deep, int32& _token);
|
||||
\brief Get a token representing a BArchivable object for this archiving
|
||||
session.
|
||||
|
||||
\param archivable The BArchivable object for which you wish to get a
|
||||
token.
|
||||
\param deep Controls how \c archivable will be archived, if it has not yet
|
||||
been archived in this session.
|
||||
\param[out] _token The token representing \c archivable is stored here.
|
||||
|
||||
Retrieves or creates a token to represent \c archivable in this archiving
|
||||
session. If \c archivable has not yet been archived, it will be now. If
|
||||
\c archivable gets archived, the \c deep parameter will be passed to its
|
||||
Archive() method.
|
||||
|
||||
\warning If you manually archive an object, and then pass it to
|
||||
GetTokenForArchivable(), it will be archived again, and when unarchived
|
||||
you will end up with two different BArchivable objects.
|
||||
*/
|
||||
|
||||
|
||||
/*!
|
||||
\fn status_t BArchiver::GetTokenForArchivable(BArchivable* archivable,
|
||||
int32 &_token)
|
||||
\brief Equivalent to calling the expanded GetTokenForArchivable(
|
||||
BArchivable*, bool, int32&), with the deep parameter equal to true.
|
||||
|
||||
\see GetTokenForArchivable(BArchivable*, bool, int32&)
|
||||
*/
|
||||
|
||||
|
||||
/*!
|
||||
\fn bool BArchiver::IsArchived(BArchivable* archivable);
|
||||
\brief Returns whether \c archivable has already been archived in this
|
||||
session.
|
||||
|
||||
\retval true \c archivable has been archived in this archiving session.
|
||||
\retval false \c archivable has not been archived in this archiving session.
|
||||
*/
|
||||
|
||||
|
||||
/*!
|
||||
\fn status_t BArchiver::Finish(status_t err = B_OK);
|
||||
\brief Report any archiving errors and possibly complete the archiving
|
||||
session.
|
||||
\return The first error reported in this archiving session, or B_OK.
|
||||
|
||||
This method may finish an archiving session (triggering the call of all
|
||||
archived objects' AllArchived() methods) if the following conditions
|
||||
are true:
|
||||
\li No errors have been reported to this or any other BArchiver object
|
||||
within this session.
|
||||
\li This is the last remaining BArchiver that has not had its Finish()
|
||||
method invoked.
|
||||
If you call this method with an error code not equal to B_OK, then this
|
||||
archiving session has failed, archived objects will not have their
|
||||
AllArchived() methods called, and any subsequent calls to this method
|
||||
on any BArchiver objects in this session will return your error code.
|
||||
*/
|
||||
|
||||
|
||||
/*!
|
||||
\fn const BMessage* BArchiver::ArchiveMessage() const
|
||||
\brief Returns the BMessage* used to construct this BArchiver. This is
|
||||
the archive that AddArchivable() modifies.
|
||||
*/
|
||||
|
||||
|
||||
///// BUnarchiver /////
|
||||
|
||||
|
||||
/*!
|
||||
\class BUnarchiver
|
||||
\ingroup support
|
||||
\ingroup libbe
|
||||
\brief A class that simplifies the unarchiving of complicated BArchivable
|
||||
hierarchies.
|
||||
|
||||
The BUnarchiver class is a small class used to recover BArchivable objects
|
||||
that have been archived with the BArchiver class. It also provides ownership
|
||||
semantics, so that memory leaks can be avoided during the unarchival
|
||||
process. When retrieving an object (either via GetObject() or FindObject()),
|
||||
you can specify a BUnarchiver::ownership_policy. If you specify
|
||||
BUnarchiver::B_ASSUME_OWNERSHIP, you will become responsible for deleting
|
||||
the retrieved item. If you specify BUnarchiver::B_DONT_ASSUME_OWNERSHIP,
|
||||
you will not become responsible. You cannot take ownership of the same
|
||||
object twice. After the unarchival process finishes, any unclaimed objects,
|
||||
excluding the root object (the object being instantiated via
|
||||
instantiate_object() or BUnarchiver::InstantiateObject()), will be deleted.
|
||||
|
||||
If you are updating a class that previously did not use the BArchiver and
|
||||
BUnarchiver helper classes, and want to maintain backwards compatibility
|
||||
with old archive, this can be done using the IsArchiveManaged() method.
|
||||
|
||||
\warning Calling methods on your BUnarchiver with a legacy archive (one that
|
||||
was not managed by a BArchiver during archival) will result in a
|
||||
call to debugger().
|
||||
*/
|
||||
|
||||
|
||||
/*!
|
||||
\fn BUnarchiver::BUnarchiver(const BMessage* archive)
|
||||
\brief Constructs a BUnarchiver object to manage \c archive.
|
||||
|
||||
\note To guarantee that your AllUnarchived() method will be called during
|
||||
archival, you must create a BUnarchiver object in your archive
|
||||
constructor. It is necessary to do this even if you won't use the
|
||||
BUnarchiver object in your archive constructor.
|
||||
|
||||
\warning Do not construct a BUnarchiver object without first calling
|
||||
BUnarchiver::PrepareArchive() on \c archive. It is only safe to build a
|
||||
BUnarchiver without this call in your AllUnarchived() implementation.
|
||||
|
||||
\see BUnarchiver::PrepareArchive()
|
||||
*/
|
||||
|
||||
|
||||
/*!
|
||||
\fn BUnarchiver::~BUnarchiver()
|
||||
\brief Destroys a BUnarchiver object.
|
||||
|
||||
Calls this objects Finish() method, if it has not yet been called.
|
||||
*/
|
||||
|
||||
|
||||
/*!
|
||||
\fn status_t BUnarchiver::EnsureUnarchived(int32 token)
|
||||
\brief Ensure the object represented by \a token is unarchived and
|
||||
instantiated.
|
||||
|
||||
\param token the object \a token
|
||||
|
||||
\returns A status code.
|
||||
*/
|
||||
|
||||
|
||||
/*!
|
||||
\fn status_t BUnarchiver::EnsureUnarchived(const char* name,
|
||||
int32 index = 0)
|
||||
\brief Ensure the object archived under \a name at \a index is unarchived
|
||||
and instantiated.
|
||||
|
||||
\param name The archive \a name.
|
||||
\param index The archive \a index.
|
||||
|
||||
\returns A status code.
|
||||
*/
|
||||
|
||||
|
||||
/*!
|
||||
\fn bool BUnarchiver::IsInstantiated(int32 token)
|
||||
\brief Checks whether the object represented by \c token has been
|
||||
instantiated in this session.
|
||||
|
||||
\param token The object \a token.
|
||||
|
||||
\returns \c true if instantiated, \c false otherwise
|
||||
*/
|
||||
|
||||
|
||||
/*!
|
||||
\fn bool BUnarchiver::IsInstantiated(const char* name, int32 index = 0)
|
||||
\brief Checks whether the object archived under \a name at \a index has been
|
||||
instantiated in this session.
|
||||
|
||||
\param name The archive \a name.
|
||||
\param index The arcive \a token.
|
||||
|
||||
\returns \c true if instantiated, \c false otherwise.
|
||||
*/
|
||||
|
||||
|
||||
/*!
|
||||
\fn template<class T> status_t BUnarchiver::GetObject(int32 token,
|
||||
ownership_policy owning, T*& object)
|
||||
\brief Recover an object by token that was archived by a BArchiver object.
|
||||
If the object has not yet been instantiated, and this request is not coming
|
||||
from an AllUnarchived() implementation, the object will be instantiated now.
|
||||
|
||||
If the retrieved object is not of the type T, then this method will fail.
|
||||
If this method fails, you will not receive ownership of the object, no
|
||||
matter what you specified in \c owning.
|
||||
|
||||
\tparam T The type of \a object you wish to find.
|
||||
|
||||
\param token The \a token you got for this object from
|
||||
BArchiver::GetTokenForArchivable() during archival.
|
||||
\param owning Whether or not you wish to take ownership of the
|
||||
retrieved object.
|
||||
\param object Return parameter for the retrieved object of type T.
|
||||
|
||||
\returns A status code.
|
||||
\retval B_OK The object retrieved was of type T.
|
||||
\retval B_BAD_TYPE The object retrieved was not of type T.
|
||||
*/
|
||||
|
||||
|
||||
/*!
|
||||
\fn template<class T> status_t BUnarchiver::GetObject(int32 token,
|
||||
T*& object)
|
||||
\brief Recover and take ownership of an object represented by \a token.
|
||||
|
||||
Equivalent to calling GetObject(token, \c B_ASSUME_OWNERSHIP, object)
|
||||
|
||||
\tparam T The type of \a object you wish to find.
|
||||
|
||||
\param token The \a token you got for this object from
|
||||
BArchiver::GetTokenForArchivable() during archival.
|
||||
\param object The return parameter for the retrieved object of type T.
|
||||
|
||||
\returns A status code.
|
||||
\retval B_OK The object retrieved was of type T.
|
||||
\retval B_BAD_TYPE The object retrieved was not of type T.
|
||||
*/
|
||||
|
||||
|
||||
/*!
|
||||
\fn template<class T> status_t BUnarchiver::FindObject(const char* name,
|
||||
int32 index, ownership_policy owning, T*& object)
|
||||
\brief Recover an object that had previously been archived using
|
||||
the BArchiver::AddArchivable() method.
|
||||
|
||||
If the object has not yet been instantiated, and this request is not
|
||||
coming from an AllUnarchived() implementation, the object will be
|
||||
instantiated now.
|
||||
|
||||
If the retrieved object is not of the type T, then this method will fail.
|
||||
If this method fails, you will not receive ownership of the object, no
|
||||
matter what you specified in \c owning.
|
||||
|
||||
\tparam T The type of object you wish to find.
|
||||
|
||||
\param name The name that was passed to BArchiver::AddArchivable() when
|
||||
adding this object.
|
||||
\param index The index of the object you wish to recover (\c 0-based,
|
||||
like BMessage::FindData().
|
||||
\param owning Dictates whether or not you wish to take ownership of the
|
||||
retrieved object.
|
||||
\param object Return parameter for the retrieved object of type T.
|
||||
|
||||
\returns A status code.
|
||||
\retval B_OK The object retrieved was of type T.
|
||||
\retval B_BAD_TYPE The object retrieved was not of type T.
|
||||
*/
|
||||
|
||||
|
||||
/*!
|
||||
\fn template<class T> status_t BUnarchiver::FindObject(const char* name,
|
||||
int32 index, T*& object)
|
||||
\brief Recover and take ownership of an object that had previously been
|
||||
archived using the BArchiver::AddArchivable() method.
|
||||
|
||||
\tparam T The type of object you wish to find.
|
||||
|
||||
\param name The name that was passed to BArchiver::AddArchivable() when
|
||||
adding this object.
|
||||
\param index The index of the object you wish to recover (\c 0-based,
|
||||
like #BMessage::FindData().
|
||||
\param object Return parameter for the retrieved object of type T.
|
||||
|
||||
\returns A status code.
|
||||
\retval B_OK The object retrieved was of type T.
|
||||
\retval B_BAD_TYPE The object retrieved was not of type T.
|
||||
*/
|
||||
|
||||
|
||||
/*!
|
||||
\fn template<class T> status_t BUnarchiver::FindObject(const char* name,
|
||||
ownership_policy owning, T*& object)
|
||||
\brief Recover an object at index \c 0 that had previously been
|
||||
archived using the BArchiver::AddArchivable() method.
|
||||
|
||||
Equivalent to calling FindObject(name, \c 0, owning, object).
|
||||
|
||||
\tparam T The type of \a object you wish to find.
|
||||
|
||||
\param name The name that was passed to BArchiver::AddArchivable() when
|
||||
adding this object.
|
||||
\param owning Dictates whether or not you wish to take ownership of the
|
||||
retrieved object.
|
||||
\param object Return parameter for the retrieved object of type T.
|
||||
|
||||
\returns A status code.
|
||||
\retval B_OK The object retrieved was of type T.
|
||||
\retval B_BAD_TYPE The object retrieved was not of type T.
|
||||
*/
|
||||
|
||||
|
||||
/*!
|
||||
\fn template<class T> status_t BUnarchiver::FindObject(const char* name,
|
||||
T*& object)
|
||||
\brief Recover and take ownership of an object at index \c 0 that had
|
||||
previously been archived using the BArchiver::AddArchivable() method.
|
||||
|
||||
Equivalent to calling FindObject(name, \c 0,
|
||||
BUnarchiver::B_ASSUME_OWNERSHIP, object).
|
||||
|
||||
\tparam T The type of \a object you wish to find.
|
||||
|
||||
\param name The name that was passed to BArchiver::AddArchivable() when
|
||||
adding this object.
|
||||
\param object Return parameter for the retrieved \a object of type T.
|
||||
|
||||
\returns A status code.
|
||||
\retval B_OK The \a object retrieved was of type T.
|
||||
\retval B_BAD_TYPE The \a object retrieved was not of type T.
|
||||
*/
|
||||
|
||||
|
||||
/*!
|
||||
\fn status_t BUnarchiver::Finish(status_t err = B_OK);
|
||||
\brief Report any unarchiving errors and possibly complete the archiving
|
||||
session.
|
||||
|
||||
This method may finish an unarchiving session (triggering the call of all
|
||||
instantiated objects' AllUnarchived() methods) if the following conditions
|
||||
are true:
|
||||
|
||||
\li No errors have been reported to this or any other BUnarchiver
|
||||
object within this session.
|
||||
\li This is the last remaining BUnarchiver that has not had its
|
||||
Finish() method invoked.
|
||||
|
||||
If you call this method with an error code not equal to B_OK, then this
|
||||
unarchiving session has failed, instantiated objects will not have their
|
||||
AllUnarchived() methods called, and any subsequent calls to this method
|
||||
on any BUnarchiver objects in this session will return your error code.
|
||||
Furthermore, any objects that have been instantiated, but have not had
|
||||
their ownership assumed by another object will now be deleted (excluding
|
||||
the root object).
|
||||
|
||||
\return The first error reported in this unarchiving session, or \c B_OK.
|
||||
*/
|
||||
|
||||
|
||||
/*!
|
||||
\fn const BMessage* BUnarchiver::ArchiveMessage() const
|
||||
\brief Returns the BMessage* used to construct this BUnarchiver.
|
||||
|
||||
This is the archive that FindObject() uses.
|
||||
*/
|
||||
|
||||
|
||||
/*!
|
||||
\fn static bool BUnarchiver::IsArchiveManaged(const BMessage* archive)
|
||||
\brief Checks whether \a archive was managed by a BArchiver object.
|
||||
|
||||
This method can be used to maintain archive backwards-compatibility for a
|
||||
class that has been updated to use the BArchiver class. If there is a
|
||||
possibility that you are may dealing with a legacy archive, you can use
|
||||
this method to find out before calling any methods on your BUnarchiver
|
||||
object.
|
||||
|
||||
Here is an example of how you might use this method. Note that you
|
||||
must still call PrepareArchive(archive) either way.
|
||||
|
||||
\code
|
||||
MyArchivableClas::MyArchivableClass(BMessage* archive)
|
||||
:
|
||||
BArchivable(BUnarchiver::PrepareArchive(archive))
|
||||
{
|
||||
BUnarchiver unarchiver(archive);
|
||||
|
||||
if (BUnarchiver::IsArchiveManaged(archive)) {
|
||||
// ... calls to FindObject() or GetObject() here ...
|
||||
} else {
|
||||
// ... calls to BMessage::FindMessage() here ...
|
||||
}
|
||||
}
|
||||
\endcode
|
||||
|
||||
\returns Whether \a archive was managed by a BArchiver object.
|
||||
\retval true if \a archive was managed by a BArchiver object.
|
||||
\retval false otherwise.
|
||||
*/
|
||||
|
||||
|
||||
/*!
|
||||
\fn static BMessage* BUnarchiver::PrepareArchive(BMessage* &archive)
|
||||
\brief Prepares \c archive for use by a BUnarchiver.
|
||||
|
||||
This method must be called if you plan to use a BUnarchiver on an archive.
|
||||
It must be called once for each class an object inherits from that
|
||||
will use a BUnarchiver.
|
||||
|
||||
\warning This method \b must be called \b before a call to the
|
||||
archive constructor of your parent class.
|
||||
|
||||
Notice the use of this method in the example provided below.
|
||||
\code
|
||||
MyArchivableClas::MyArchivableClas(BMessage* archive)
|
||||
:
|
||||
BArchivable(BUnarchiver::PrepareArchive(archive))
|
||||
{
|
||||
// ...
|
||||
}
|
||||
\endcode
|
||||
|
||||
\param archive The archive you wish to have prepared.
|
||||
|
||||
\return The same #BMessage as is passed in.
|
||||
*/
|
||||
|
||||
|
||||
/*!
|
||||
\fn void BUnarchiver::AssumeOwnership(BArchivable* archivable)
|
||||
\brief Become the owner of \a archivable.
|
||||
|
||||
After calling this method you are responsible for deleting the
|
||||
\a archivable.
|
||||
|
||||
\param archivable The \a archivable object.
|
||||
*/
|
||||
|
||||
|
||||
/*!
|
||||
\fn void BUnarchiver::RelinquishOwnership(BArchivable* archivable)
|
||||
\brief Relinquish ownership of \a archivable. If \a archivable remains
|
||||
unclaimed at the end of the unarchiving session, it will be deleted
|
||||
(unless it is the root object).
|
||||
|
||||
\param archivable The \a archivable object.
|
||||
*/
|
||||
|
||||
|
||||
/*!
|
||||
\fn template<class T> status_t BUnarchiver::InstantiateObject(
|
||||
BMessage* from, T*& object)
|
||||
\brief Attempt to instantiate an object of type T from BMessage*
|
||||
\a from.
|
||||
|
||||
If the instantiated object is not of type T, then it will be deleted,
|
||||
and this method will return \c B_BAD_TYPE. This method is similar to
|
||||
the instantiate_object() function, but provides error reporting and
|
||||
protection from memory leaks.
|
||||
|
||||
\param from The #BMessage to instantiate from.
|
||||
\param object Return parameter for the retrieved object of type T.
|
||||
|
||||
\returns A status code.
|
||||
\retval B_OK The object retrieved was of type T.
|
||||
\retval B_BAD_TYPE The object retrieved was not of type T.
|
||||
*/
|
||||
|
||||
|
||||
///// Global methods /////
|
||||
|
||||
|
||||
|
||||
@@ -1,148 +0,0 @@
|
||||
/*
|
||||
* Copyright 2010 Haiku, Inc. All rights reserved.
|
||||
* Distributed under the terms of the MIT License.
|
||||
*
|
||||
* Author:
|
||||
* Alex Wilson, [email protected]
|
||||
*
|
||||
* Corresponds to:
|
||||
* headers/os/support/Archivable.h rev 37751
|
||||
* src/kits/support/Archivable.cpp rev 44303
|
||||
*/
|
||||
|
||||
|
||||
/*!
|
||||
\file Archivable.h
|
||||
\ingroup support
|
||||
\ingroup libbe
|
||||
\brief Contains BArchiver class.
|
||||
*/
|
||||
|
||||
|
||||
/*!
|
||||
\class BArchiver
|
||||
\ingroup support
|
||||
\ingroup libbe
|
||||
\brief A class that simplifies the archiving of complicated BArchivable
|
||||
hierarchies.
|
||||
|
||||
The BArchiver class is a small class that is used for archiving of
|
||||
complicated BArchivable hierarchies. Such a hierarchy may include
|
||||
multiple BArchivable objects, each of which might be referenced by
|
||||
many BArchivable objects. With the BArchiver class, you can be certain
|
||||
that each BArchivable object is archived only once with very little work.
|
||||
When used in conjuction with the BArchivable::AllArchived() and
|
||||
BArchivable::AllUnarchived() methods, it is simple to rebuild your system of
|
||||
references upon unarchival so that they are equivalent to those that were
|
||||
present in your original hierarchy.
|
||||
|
||||
The objects you archive can be retrieved using a BUnarchiver object.
|
||||
*/
|
||||
|
||||
|
||||
/*!
|
||||
\fn BArchiver::BArchiver(BMessage* archive)
|
||||
\brief Constructs a BArchiver object that manages \c archive.
|
||||
*/
|
||||
|
||||
|
||||
/*!
|
||||
\fn BArchiver::~BArchiver()
|
||||
\brief Destroys a BArchiver object. If the BArchiver object has not had its
|
||||
Finish() method called, this will be done now.
|
||||
*/
|
||||
|
||||
|
||||
/*!
|
||||
\fn status_t BArchiver::AddArchivable(const char* name,
|
||||
BArchivable* archivable, bool deep = true)
|
||||
\brief Adds a reference to \c archivable to the archive used to
|
||||
construct this BArchiver. May call \c archivable's Archive() method.
|
||||
|
||||
\param name Where this reference will be stored in the archive.
|
||||
\param archivable The BArchivable* object that to reference.
|
||||
\param deep Passed to \c archivable->Archive() if \c archivable must
|
||||
be archived.
|
||||
|
||||
Adds a reference to \c archivable to your archive. If \c archivable has
|
||||
not yet been archived, then its Archive() method is called. BArchiver
|
||||
can only track BArchivable objects that have been archived through this
|
||||
method or the GetTokenForArchivable() methods.
|
||||
|
||||
\warning If you manually archive an object, and then pass it to
|
||||
AddArchivable() or GetTokenForArchivable(), it will be archived again,
|
||||
and when unarchived you will end up with two different BArchivable
|
||||
objects.
|
||||
*/
|
||||
|
||||
|
||||
/*!
|
||||
\fn status_t BArchiver::GetTokenForArchivable(BArchivable* archivable,
|
||||
bool deep, int32& _token);
|
||||
\brief Get a token representing a BArchivable object for this archiving
|
||||
session.
|
||||
|
||||
\param archivable The BArchivable object for which you wish to get a
|
||||
token.
|
||||
\param deep Controls how \c archivable will be archived, if it has not yet
|
||||
been archived in this session.
|
||||
\param[out] _token The token representing \c archivable is stored here.
|
||||
|
||||
Retrieves or creates a token to represent \c archivable in this archiving
|
||||
session. If \c archivable has not yet been archived, it will be now. If
|
||||
\c archivable gets archived, the \c deep parameter will be passed to its
|
||||
Archive() method.
|
||||
|
||||
\warning If you manually archive an object, and then pass it to
|
||||
GetTokenForArchivable(), it will be archived again, and when unarchived
|
||||
you will end up with two different BArchivable objects.
|
||||
*/
|
||||
|
||||
|
||||
/*!
|
||||
\fn status_t BArchiver::GetTokenForArchivable(BArchivable* archivable,
|
||||
int32 &_token)
|
||||
\brief Equivalent to calling the expanded GetTokenForArchivable(
|
||||
BArchivable*, bool, int32&), with the deep parameter equal to true.
|
||||
|
||||
\see GetTokenForArchivable(BArchivable*, bool, int32&)
|
||||
*/
|
||||
|
||||
|
||||
/*!
|
||||
\fn bool BArchiver::IsArchived(BArchivable* archivable);
|
||||
\brief Returns whether \c archivable has already been archived in this
|
||||
session.
|
||||
|
||||
\retval true \c archivable has been archived in this archiving session.
|
||||
\retval false \c archivable has not been archived in this archiving session.
|
||||
*/
|
||||
|
||||
|
||||
/*!
|
||||
\fn status_t BArchiver::Finish(status_t err = B_OK);
|
||||
\brief Report any archiving errors and possibly complete the archiving
|
||||
session.
|
||||
\return The first error reported in this archiving session, or B_OK.
|
||||
|
||||
This method may finish an archiving session (triggering the call of all
|
||||
archived objects' AllArchived() methods) if the following conditions
|
||||
are true:
|
||||
\li No errors have been reported to this or any other BArchiver object
|
||||
within this session.
|
||||
\li This is the last remaining BArchiver that has not had its Finish()
|
||||
method invoked.
|
||||
If you call this method with an error code not equal to B_OK, then this
|
||||
archiving session has failed, archived objects will not have their
|
||||
AllArchived() methods called, and any subsequent calls to this method
|
||||
on any BArchiver objects in this session will return your error code.
|
||||
*/
|
||||
|
||||
|
||||
/*!
|
||||
\fn const BMessage* BArchiver::ArchiveMessage() const
|
||||
\brief Returns the BMessage* used to construct this BArchiver. This is
|
||||
the archive that AddArchivable() modifies.
|
||||
*/
|
||||
|
||||
|
||||
@@ -1,394 +0,0 @@
|
||||
/*
|
||||
* Copyright 2010 Haiku, Inc. All rights reserved.
|
||||
* Distributed under the terms of the MIT License.
|
||||
*
|
||||
* Author:
|
||||
* Alex Wilson, [email protected]
|
||||
*
|
||||
* Corresponds to:
|
||||
* headers/os/support/Archivable.h rev 37751
|
||||
* src/kits/support/Archivable.cpp rev 37751
|
||||
*/
|
||||
|
||||
|
||||
/*!
|
||||
\file Archivable.h
|
||||
\ingroup support
|
||||
\ingroup libbe
|
||||
\brief Contains BUnarchiver class used to simplify the unarchiving of
|
||||
complicated BArchivable hierarchies.
|
||||
*/
|
||||
|
||||
|
||||
/*!
|
||||
\class BUnarchiver
|
||||
\ingroup support
|
||||
\ingroup libbe
|
||||
\brief A class that simplifies the unarchiving of complicated BArchivable
|
||||
hierarchies.
|
||||
|
||||
The BUnarchiver class is a small class used to recover BArchivable objects
|
||||
that have been archived with the BArchiver class. It also provides ownership
|
||||
semantics, so that memory leaks can be avoided during the unarchival
|
||||
process. When retrieving an object (either via GetObject() or FindObject()),
|
||||
you can specify a BUnarchiver::ownership_policy. If you specify
|
||||
BUnarchiver::B_ASSUME_OWNERSHIP, you will become responsible for deleting
|
||||
the retrieved item. If you specify BUnarchiver::B_DONT_ASSUME_OWNERSHIP,
|
||||
you will not become responsible. You cannot take ownership of the same
|
||||
object twice. After the unarchival process finishes, any unclaimed objects,
|
||||
excluding the root object (the object being instantiated via
|
||||
instantiate_object() or BUnarchiver::InstantiateObject()), will be deleted.
|
||||
|
||||
If you are updating a class that previously did not use the BArchiver and
|
||||
BUnarchiver helper classes, and want to maintain backwards compatibility
|
||||
with old archive, this can be done using the IsArchiveManaged() method.
|
||||
|
||||
\warning Calling methods on your BUnarchiver with a legacy archive (one that
|
||||
was not managed by a BArchiver during archival) will result in a
|
||||
call to debugger().
|
||||
*/
|
||||
|
||||
|
||||
/*!
|
||||
\fn BUnarchiver::BUnarchiver(const BMessage* archive)
|
||||
\brief Constructs a BUnarchiver object to manage \c archive.
|
||||
|
||||
\note To guarantee that your AllUnarchived() method will be called during
|
||||
archival, you must create a BUnarchiver object in your archive
|
||||
constructor. It is necessary to do this even if you won't use the
|
||||
BUnarchiver object in your archive constructor.
|
||||
|
||||
\warning Do not construct a BUnarchiver object without first calling
|
||||
BUnarchiver::PrepareArchive() on \c archive. It is only safe to build a
|
||||
BUnarchiver without this call in your AllUnarchived() implementation.
|
||||
|
||||
\see BUnarchiver::PrepareArchive()
|
||||
*/
|
||||
|
||||
|
||||
/*!
|
||||
\fn BUnarchiver::~BUnarchiver()
|
||||
\brief Destroys a BUnarchiver object.
|
||||
|
||||
Calls this objects Finish() method, if it has not yet been called.
|
||||
*/
|
||||
|
||||
|
||||
/*!
|
||||
\fn status_t BUnarchiver::EnsureUnarchived(int32 token)
|
||||
\brief Ensure the object represented by \a token is unarchived and
|
||||
instantiated.
|
||||
|
||||
\param token the object \a token
|
||||
|
||||
\returns A status code.
|
||||
*/
|
||||
|
||||
|
||||
/*!
|
||||
\fn status_t BUnarchiver::EnsureUnarchived(const char* name,
|
||||
int32 index = 0)
|
||||
\brief Ensure the object archived under \a name at \a index is unarchived
|
||||
and instantiated.
|
||||
|
||||
\param name The archive \a name.
|
||||
\param index The archive \a index.
|
||||
|
||||
\returns A status code.
|
||||
*/
|
||||
|
||||
|
||||
/*!
|
||||
\fn bool BUnarchiver::IsInstantiated(int32 token)
|
||||
\brief Checks whether the object represented by \c token has been
|
||||
instantiated in this session.
|
||||
|
||||
\param token The object \a token.
|
||||
|
||||
\returns \c true if instantiated, \c false otherwise
|
||||
*/
|
||||
|
||||
|
||||
/*!
|
||||
\fn bool BUnarchiver::IsInstantiated(const char* name, int32 index = 0)
|
||||
\brief Checks whether the object archived under \a name at \a index has been
|
||||
instantiated in this session.
|
||||
|
||||
\param name The archive \a name.
|
||||
\param index The arcive \a token.
|
||||
|
||||
\returns \c true if instantiated, \c false otherwise.
|
||||
*/
|
||||
|
||||
|
||||
/*!
|
||||
\fn template<class T> status_t BUnarchiver::GetObject(int32 token,
|
||||
ownership_policy owning, T*& object)
|
||||
\brief Recover an object by token that was archived by a BArchiver object.
|
||||
If the object has not yet been instantiated, and this request is not coming
|
||||
from an AllUnarchived() implementation, the object will be instantiated now.
|
||||
|
||||
If the retrieved object is not of the type T, then this method will fail.
|
||||
If this method fails, you will not receive ownership of the object, no
|
||||
matter what you specified in \c owning.
|
||||
|
||||
\tparam T The type of \a object you wish to find.
|
||||
|
||||
\param token The \a token you got for this object from
|
||||
BArchiver::GetTokenForArchivable() during archival.
|
||||
\param owning Whether or not you wish to take ownership of the
|
||||
retrieved object.
|
||||
\param object Return parameter for the retrieved object of type T.
|
||||
|
||||
\returns A status code.
|
||||
\retval B_OK The object retrieved was of type T.
|
||||
\retval B_BAD_TYPE The object retrieved was not of type T.
|
||||
*/
|
||||
|
||||
|
||||
/*!
|
||||
\fn template<class T> status_t BUnarchiver::GetObject(int32 token,
|
||||
T*& object)
|
||||
\brief Recover and take ownership of an object represented by \a token.
|
||||
|
||||
Equivalent to calling GetObject(token, \c B_ASSUME_OWNERSHIP, object)
|
||||
|
||||
\tparam T The type of \a object you wish to find.
|
||||
|
||||
\param token The \a token you got for this object from
|
||||
BArchiver::GetTokenForArchivable() during archival.
|
||||
\param object The return parameter for the retrieved object of type T.
|
||||
|
||||
\returns A status code.
|
||||
\retval B_OK The object retrieved was of type T.
|
||||
\retval B_BAD_TYPE The object retrieved was not of type T.
|
||||
*/
|
||||
|
||||
|
||||
/*!
|
||||
\fn template<class T> status_t BUnarchiver::FindObject(const char* name,
|
||||
int32 index, ownership_policy owning, T*& object)
|
||||
\brief Recover an object that had previously been archived using
|
||||
the BArchiver::AddArchivable() method.
|
||||
|
||||
If the object has not yet been instantiated, and this request is not
|
||||
coming from an AllUnarchived() implementation, the object will be
|
||||
instantiated now.
|
||||
|
||||
If the retrieved object is not of the type T, then this method will fail.
|
||||
If this method fails, you will not receive ownership of the object, no
|
||||
matter what you specified in \c owning.
|
||||
|
||||
\tparam T The type of object you wish to find.
|
||||
|
||||
\param name The name that was passed to BArchiver::AddArchivable() when
|
||||
adding this object.
|
||||
\param index The index of the object you wish to recover (\c 0-based,
|
||||
like BMessage::FindData().
|
||||
\param owning Dictates whether or not you wish to take ownership of the
|
||||
retrieved object.
|
||||
\param object Return parameter for the retrieved object of type T.
|
||||
|
||||
\returns A status code.
|
||||
\retval B_OK The object retrieved was of type T.
|
||||
\retval B_BAD_TYPE The object retrieved was not of type T.
|
||||
*/
|
||||
|
||||
|
||||
/*!
|
||||
\fn template<class T> status_t BUnarchiver::FindObject(const char* name,
|
||||
int32 index, T*& object)
|
||||
\brief Recover and take ownership of an object that had previously been
|
||||
archived using the BArchiver::AddArchivable() method.
|
||||
|
||||
\tparam T The type of object you wish to find.
|
||||
|
||||
\param name The name that was passed to BArchiver::AddArchivable() when
|
||||
adding this object.
|
||||
\param index The index of the object you wish to recover (\c 0-based,
|
||||
like #BMessage::FindData().
|
||||
\param object Return parameter for the retrieved object of type T.
|
||||
|
||||
\returns A status code.
|
||||
\retval B_OK The object retrieved was of type T.
|
||||
\retval B_BAD_TYPE The object retrieved was not of type T.
|
||||
*/
|
||||
|
||||
|
||||
/*!
|
||||
\fn template<class T> status_t BUnarchiver::FindObject(const char* name,
|
||||
ownership_policy owning, T*& object)
|
||||
\brief Recover an object at index \c 0 that had previously been
|
||||
archived using the BArchiver::AddArchivable() method.
|
||||
|
||||
Equivalent to calling FindObject(name, \c 0, owning, object).
|
||||
|
||||
\tparam T The type of \a object you wish to find.
|
||||
|
||||
\param name The name that was passed to BArchiver::AddArchivable() when
|
||||
adding this object.
|
||||
\param owning Dictates whether or not you wish to take ownership of the
|
||||
retrieved object.
|
||||
\param object Return parameter for the retrieved object of type T.
|
||||
|
||||
\returns A status code.
|
||||
\retval B_OK The object retrieved was of type T.
|
||||
\retval B_BAD_TYPE The object retrieved was not of type T.
|
||||
*/
|
||||
|
||||
|
||||
/*!
|
||||
\fn template<class T> status_t BUnarchiver::FindObject(const char* name,
|
||||
T*& object)
|
||||
\brief Recover and take ownership of an object at index \c 0 that had
|
||||
previously been archived using the BArchiver::AddArchivable() method.
|
||||
|
||||
Equivalent to calling FindObject(name, \c 0,
|
||||
BUnarchiver::B_ASSUME_OWNERSHIP, object).
|
||||
|
||||
\tparam T The type of \a object you wish to find.
|
||||
|
||||
\param name The name that was passed to BArchiver::AddArchivable() when
|
||||
adding this object.
|
||||
\param object Return parameter for the retrieved \a object of type T.
|
||||
|
||||
\returns A status code.
|
||||
\retval B_OK The \a object retrieved was of type T.
|
||||
\retval B_BAD_TYPE The \a object retrieved was not of type T.
|
||||
*/
|
||||
|
||||
|
||||
/*!
|
||||
\fn status_t BUnarchiver::Finish(status_t err = B_OK);
|
||||
\brief Report any unarchiving errors and possibly complete the archiving
|
||||
session.
|
||||
|
||||
This method may finish an unarchiving session (triggering the call of all
|
||||
instantiated objects' AllUnarchived() methods) if the following conditions
|
||||
are true:
|
||||
|
||||
\li No errors have been reported to this or any other BUnarchiver
|
||||
object within this session.
|
||||
\li This is the last remaining BUnarchiver that has not had its
|
||||
Finish() method invoked.
|
||||
|
||||
If you call this method with an error code not equal to B_OK, then this
|
||||
unarchiving session has failed, instantiated objects will not have their
|
||||
AllUnarchived() methods called, and any subsequent calls to this method
|
||||
on any BUnarchiver objects in this session will return your error code.
|
||||
Furthermore, any objects that have been instantiated, but have not had
|
||||
their ownership assumed by another object will now be deleted (excluding
|
||||
the root object).
|
||||
|
||||
\return The first error reported in this unarchiving session, or \c B_OK.
|
||||
*/
|
||||
|
||||
|
||||
/*!
|
||||
\fn const BMessage* BUnarchiver::ArchiveMessage() const
|
||||
\brief Returns the BMessage* used to construct this BUnarchiver.
|
||||
|
||||
This is the archive that FindObject() uses.
|
||||
*/
|
||||
|
||||
|
||||
/*!
|
||||
\fn static bool BUnarchiver::IsArchiveManaged(const BMessage* archive)
|
||||
\brief Checks whether \a archive was managed by a BArchiver object.
|
||||
|
||||
This method can be used to maintain archive backwards-compatibility for a
|
||||
class that has been updated to use the BArchiver class. If there is a
|
||||
possibility that you are may dealing with a legacy archive, you can use
|
||||
this method to find out before calling any methods on your BUnarchiver
|
||||
object.
|
||||
|
||||
Here is an example of how you might use this method. Note that you
|
||||
must still call PrepareArchive(archive) either way.
|
||||
|
||||
\code
|
||||
MyArchivableClas::MyArchivableClass(BMessage* archive)
|
||||
:
|
||||
BArchivable(BUnarchiver::PrepareArchive(archive))
|
||||
{
|
||||
BUnarchiver unarchiver(archive);
|
||||
|
||||
if (BUnarchiver::IsArchiveManaged(archive)) {
|
||||
// ... calls to FindObject() or GetObject() here ...
|
||||
} else {
|
||||
// ... calls to BMessage::FindMessage() here ...
|
||||
}
|
||||
}
|
||||
\endcode
|
||||
|
||||
\returns Whether \a archive was managed by a BArchiver object.
|
||||
\retval true if \a archive was managed by a BArchiver object.
|
||||
\retval false otherwise.
|
||||
*/
|
||||
|
||||
|
||||
/*!
|
||||
\fn static BMessage* BUnarchiver::PrepareArchive(BMessage* &archive)
|
||||
\brief Prepares \c archive for use by a BUnarchiver.
|
||||
|
||||
This method must be called if you plan to use a BUnarchiver on an archive.
|
||||
It must be called once for each class an object inherits from that
|
||||
will use a BUnarchiver.
|
||||
|
||||
\warning This method \b must be called \b before a call to the
|
||||
archive constructor of your parent class.
|
||||
|
||||
Notice the use of this method in the example provided below.
|
||||
\code
|
||||
MyArchivableClas::MyArchivableClas(BMessage* archive)
|
||||
:
|
||||
BArchivable(BUnarchiver::PrepareArchive(archive))
|
||||
{
|
||||
// ...
|
||||
}
|
||||
\endcode
|
||||
|
||||
\param archive The archive you wish to have prepared.
|
||||
|
||||
\return The same #BMessage as is passed in.
|
||||
*/
|
||||
|
||||
|
||||
/*!
|
||||
\fn void BUnarchiver::AssumeOwnership(BArchivable* archivable)
|
||||
\brief Become the owner of \a archivable.
|
||||
|
||||
After calling this method you are responsible for deleting the
|
||||
\a archivable.
|
||||
|
||||
\param archivable The \a archivable object.
|
||||
*/
|
||||
|
||||
|
||||
/*!
|
||||
\fn void BUnarchiver::RelinquishOwnership(BArchivable* archivable)
|
||||
\brief Relinquish ownership of \a archivable. If \a archivable remains
|
||||
unclaimed at the end of the unarchiving session, it will be deleted
|
||||
(unless it is the root object).
|
||||
|
||||
\param archivable The \a archivable object.
|
||||
*/
|
||||
|
||||
|
||||
/*!
|
||||
\fn template<class T> status_t BUnarchiver::InstantiateObject(
|
||||
BMessage* from, T*& object)
|
||||
\brief Attempt to instantiate an object of type T from BMessage*
|
||||
\a from.
|
||||
|
||||
If the instantiated object is not of type T, then it will be deleted,
|
||||
and this method will return \c B_BAD_TYPE. This method is similar to
|
||||
the instantiate_object() function, but provides error reporting and
|
||||
protection from memory leaks.
|
||||
|
||||
\param from The #BMessage to instantiate from.
|
||||
\param object Return parameter for the retrieved object of type T.
|
||||
|
||||
\returns A status code.
|
||||
\retval B_OK The object retrieved was of type T.
|
||||
\retval B_BAD_TYPE The object retrieved was not of type T.
|
||||
*/
|
||||
Reference in New Issue
Block a user