|
Serialization
|
type_info/typeid()
to perform
the following functions
std::type_info
std::typeid()
is not available in all environments. Support for this function depends upon
runtime typing(RTTI) support from the compiler. This may be non-existent
or not enabled for reasons such as a percieved inefficiency.
std::type_info
includes a string
containing type name. This would seem to satisfy 2) above.
But the format of this string is not consistent accross compilers, libraries,
and operating systems. This makes it unusable for support of portable archives.
extended_type_info
is an implementation
of std::type_info
functionality with the
following features:
extended_type_info
records - one for each type
serialized.
typeid()
to find the external identifier
of a class while another might not.
namespace boost {
namespace serialization {
class extended_type_info
{
protected:
// this class can't be used as is. It's just the
// common functionality for all type_info replacement
// systems. Hence, make these protected
extended_type_info(
const unsigned int type_info_key,
const char * key
);
~extended_type_info();
void key_register();
void key_unregister();
public:
const char * get_key() const;
bool operator<(const extended_type_info &rhs) const;
bool operator==(const extended_type_info &rhs) const;
bool operator!=(const extended_type_info &rhs) const {
return !(operator==(rhs));
}
// for plugins
virtual void * construct(unsigned int count = 0, ...) const;
virtual void destroy(void const * const p) const;
static const extended_type_info * find(const char *key);
};
} // namespace serialization
} // namespace boost
Generally, there will be one and only one
extended_type_info
instance created for each type. However, this is enforced only at the executable
module level. That is, if a program includes some shared libraries or DLLS,
there may be more than one instance of this class correponding to a particular type.
For this reason the comparison functions below can't just compare the addresses of
this instance but rather must be programmed to compare the actual information
the instances contain.
extended_type_info(unsigned int type_info_key, const char *key);
The second argument is a const string which is the external name of the type to which this record corresponds. It may sometimes be referred to as a GUID - a Global Unique IDentifier. It is passed through archives from one program invocation to another to uniquely identify the types that the archive contains. If the "export" facility is not going to be used, this value may be NULL.
void key_register();
void key_unregister();
extended_type_info
records.
This table is used when loading pointers to objects serialized
through a base class pointer. In this case, the archive
contains a string which is looked up in this table to
determine which extended_type_info
to use for creating a new object.
These functions are called by constructors and
destructors of classes which implement
extended_type_info
to add and remove entries from this table.
const char *get_key() const;
extended_type_info
instance. If no key has been associated with the instance, then a NULL is returned.
bool operator<(const extended_type_info & rhs) const;
bool operator==(const extended_type_info & rhs) const;
bool operator!=(const extended_type_info & rhs) const;
extended_type_info
objects. They impose a strict total ordering on all
extended_type_info
records.
virtual void * construct(unsigned int count = 0, ...) const;
extended_type_info
record corresponds. This function takes a variable list of up to 4 arguments
of any type. These arguments are passed to the type's constructor
at runtime. In order to use the facility,
one must declare a type sequence for the constructor arguments.
Arguments for this function must match in number and type
with those specified when the type was exported.
This function permits one to create instances of
any exported type given only the exported GUID assigned
with BOOST_CLASS_EXPORT.
If these types are defined in DLLS or shared libraries loaded at runtime,
these constructors can be called until the module is unloaded.
Such modules are referred to as plugins.
virtual void destroy(void const * const p) const;
static const extended_type_info * find(const char *key);
extended_type_info
object.
extended_type_info
,
(referred to as ETI here), must be derived from
extended_type_info
and also implement the following:
template<class ETI>
const extended_type_info *
ETI::get_derived_extended_type_info(const T & t) const;
extended_type_info
instance that corresponds to
the "true type" of the type T. The "true type" is the lowest type in the
hierarchy of classes. The type T can always be cast to the "true type" with
a static cast. Implementation of this function will vary among type id systems
and sometimes will make presumptions about the type T than can be identified
with a particular extended_type_info
implementation.
virtual bool ETI::is_less_than(const extended_type_info &rhs) const;
extended_type_info
implementation.
virtual bool ETI::is_equal(const extended_type_info &rhs) const;
extended_type_info
implementation.
Return true
if the types referred
to are the same. Otherwise return
false
const char ETI::get_key() const;
virtual void * construct(unsigned int count, ...) const;
virtual void * destroy(void const * const ptr ) const;
extended_type_info
implementations.
is implemented in terms of the standard typeid(). It presumes that RTTI support is enabled
by the compiler.
extended_type_info_typeid
is implemented in a way that doesn't rely on the existence RTTI.
Instead, it requires that all polymorphic types be explictly exported.
In addition, if the export facility is to be used to serialize types
through base class pointers, those types are required to implement
a virtual function with the signature:
extended_type_info_no_rtti
which returns a unique string the most derived object this class.
This function must be virtual in order to implement the functionality required by
virtual const char * get_key();
ETI::get_derived_extended_type_info
as described above.
test_no_rtti
implements this function in terms of the
extended_type_info
API above to return the export key associated with the class.
This requires that non-abstract types be exported. It also demonstrates the
inter-operability between two different implementations of
extended_type_info
.
namespace boost {
namespace serialization {
template
struct extended_type_info_typeid>T>;
template
struct extended_type_info_typeid>const T>;
} // serialization
} // boost
For those using the serialization library, this step can be skipped
as it is done automatically. The serialization library includes
the macro:
BOOST_CLASS_TYPE_INFO(
my_type,
extended_type_info_typeid>my_class>
)
which is used to specify which extended_type_info
system is to
be used for a given type.
extended_type_info
includes a facility for constructing
instances of types without knowing what the exact types are. This is done
with the function
virtual void * extended_type_info::construct(unsigned int count = 0, ...) const;
. For example:
struct base {
...
};
struct derived : public base {
...
};
...
extended_type_info *eti = extended_type_info::find("my_class")
base * b = eti->construct(...);
The construct
takes an argument count and up to
four parameters of any type. The arguments are passed to the
constructor of "my_class".
A complete example of this can be found
here
© Copyright Robert Ramey 2005-2009. Distributed under the Boost Software License, Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)