This defines the internal interface for packing values into a DCField. More...
#include "dcPackerInterface.h"
Public Member Functions | |
DCPackerInterface (const std::string &name=std::string()) | |
DCPackerInterface (const DCPackerInterface ©) | |
virtual DCClassParameter * | as_class_parameter () |
virtual const DCClassParameter * | as_class_parameter () const |
virtual DCField * | as_field () |
virtual const DCField * | as_field () const |
virtual DCSwitchParameter * | as_switch_parameter () |
virtual const DCSwitchParameter * | as_switch_parameter () const |
virtual int | calc_num_nested_fields (size_t length_bytes) const |
This flavor of get_num_nested_fields is used during unpacking. More... | |
bool | check_match (const DCPackerInterface *other) const |
Returns true if the other interface is bitwise the same as this one–that is, a uint32 only matches a uint32, etc. More... | |
bool | check_match (const std::string &description, DCFile *dcfile=nullptr) const |
Returns true if this interface is bitwise the same as the interface described with the indicated formatted string, e.g. More... | |
virtual bool | do_check_match_array_parameter (const DCArrayParameter *other) const |
Returns true if this field matches the indicated array parameter, false otherwise. More... | |
virtual bool | do_check_match_atomic_field (const DCAtomicField *other) const |
Returns true if this field matches the indicated atomic field, false otherwise. More... | |
virtual bool | do_check_match_class_parameter (const DCClassParameter *other) const |
Returns true if this field matches the indicated class parameter, false otherwise. More... | |
virtual bool | do_check_match_molecular_field (const DCMolecularField *other) const |
Returns true if this field matches the indicated molecular field, false otherwise. More... | |
virtual bool | do_check_match_simple_parameter (const DCSimpleParameter *other) const |
Returns true if this field matches the indicated simple parameter, false otherwise. More... | |
virtual bool | do_check_match_switch_parameter (const DCSwitchParameter *other) const |
Returns true if this field matches the indicated switch parameter, false otherwise. More... | |
int | find_seek_index (const std::string &name) const |
Returns the index number to be passed to a future call to DCPacker::seek() to seek directly to the named field without having to look up the field name in a table later, or -1 if the named field cannot be found. More... | |
const DCPackerCatalog * | get_catalog () const |
Returns the DCPackerCatalog associated with this field, listing all of the nested fields by name. More... | |
size_t | get_fixed_byte_size () const |
If has_fixed_byte_size() returns true, this returns the number of bytes this field type will use. More... | |
const std::string & | get_name () const |
Returns the name of this field, or empty string if the field is unnamed. More... | |
virtual DCPackerInterface * | get_nested_field (int n) const |
Returns the DCPackerInterface object that represents the nth nested field. More... | |
size_t | get_num_length_bytes () const |
Returns the number of bytes that should be written into the stream on a push() to record the number of bytes in the record up until the next pop(). More... | |
int | get_num_nested_fields () const |
Returns the number of nested fields required by this field type. More... | |
DCPackType | get_pack_type () const |
Returns the type of value expected by this field. More... | |
bool | has_fixed_byte_size () const |
Returns true if this field type always packs to the same number of bytes, false if it is variable. More... | |
bool | has_fixed_structure () const |
Returns true if this field type always has the same structure regardless of the data in the stream, or false if its structure may vary. More... | |
bool | has_nested_fields () const |
Returns true if this field type has any nested fields (and thus expects a push() . More... | |
bool | has_range_limits () const |
Returns true if this field, or any sub-field of this field, has a limit imposed in the DC file on its legal values. More... | |
virtual void | pack_blob (DCPackData &pack_data, const vector_uchar &value, bool &pack_error, bool &range_error) const |
Packs the indicated numeric or string value into the stream. More... | |
virtual bool | pack_default_value (DCPackData &pack_data, bool &pack_error) const |
Packs the field's specified default value (or a sensible default if no value is specified) into the stream. More... | |
virtual void | pack_double (DCPackData &pack_data, double value, bool &pack_error, bool &range_error) const |
Packs the indicated numeric or string value into the stream. More... | |
virtual void | pack_int (DCPackData &pack_data, int value, bool &pack_error, bool &range_error) const |
Packs the indicated numeric or string value into the stream. More... | |
virtual void | pack_int64 (DCPackData &pack_data, int64_t value, bool &pack_error, bool &range_error) const |
Packs the indicated numeric or string value into the stream. More... | |
virtual void | pack_string (DCPackData &pack_data, const std::string &value, bool &pack_error, bool &range_error) const |
Packs the indicated numeric or string value into the stream. More... | |
virtual void | pack_uint (DCPackData &pack_data, unsigned int value, bool &pack_error, bool &range_error) const |
Packs the indicated numeric or string value into the stream. More... | |
virtual void | pack_uint64 (DCPackData &pack_data, uint64_t value, bool &pack_error, bool &range_error) const |
Packs the indicated numeric or string value into the stream. More... | |
virtual void | set_name (const std::string &name) |
Sets the name of this field. More... | |
virtual void | unpack_blob (const char *data, size_t length, size_t &p, vector_uchar &value, bool &pack_error, bool &range_error) const |
Unpacks the current numeric or string value from the stream. More... | |
virtual void | unpack_double (const char *data, size_t length, size_t &p, double &value, bool &pack_error, bool &range_error) const |
Unpacks the current numeric or string value from the stream. More... | |
virtual void | unpack_int (const char *data, size_t length, size_t &p, int &value, bool &pack_error, bool &range_error) const |
Unpacks the current numeric or string value from the stream. More... | |
virtual void | unpack_int64 (const char *data, size_t length, size_t &p, int64_t &value, bool &pack_error, bool &range_error) const |
Unpacks the current numeric or string value from the stream. More... | |
virtual bool | unpack_skip (const char *data, size_t length, size_t &p, bool &pack_error) const |
Increments p to the end of the current field without actually unpacking any data or performing any range validation. More... | |
virtual void | unpack_string (const char *data, size_t length, size_t &p, std::string &value, bool &pack_error, bool &range_error) const |
Unpacks the current numeric or string value from the stream. More... | |
virtual void | unpack_uint (const char *data, size_t length, size_t &p, unsigned int &value, bool &pack_error, bool &range_error) const |
Unpacks the current numeric or string value from the stream. More... | |
virtual void | unpack_uint64 (const char *data, size_t length, size_t &p, uint64_t &value, bool &pack_error, bool &range_error) const |
Unpacks the current numeric or string value from the stream. More... | |
virtual bool | unpack_validate (const char *data, size_t length, size_t &p, bool &pack_error, bool &range_error) const |
Internally unpacks the current numeric or string value and validates it against the type range limits, but does not return the value. More... | |
virtual bool | validate_num_nested_fields (int num_nested_fields) const |
After a number of fields have been packed via push() . More... | |
Static Public Member Functions | |
static void | do_pack_float64 (char *buffer, double value) |
static void | do_pack_int16 (char *buffer, int value) |
static void | do_pack_int32 (char *buffer, int value) |
static void | do_pack_int64 (char *buffer, int64_t value) |
static void | do_pack_int8 (char *buffer, int value) |
static void | do_pack_uint16 (char *buffer, unsigned int value) |
static void | do_pack_uint32 (char *buffer, unsigned int value) |
static void | do_pack_uint64 (char *buffer, uint64_t value) |
static void | do_pack_uint8 (char *buffer, unsigned int value) |
static double | do_unpack_float64 (const char *buffer) |
static int | do_unpack_int16 (const char *buffer) |
static int | do_unpack_int32 (const char *buffer) |
static int64_t | do_unpack_int64 (const char *buffer) |
static int | do_unpack_int8 (const char *buffer) |
static unsigned int | do_unpack_uint16 (const char *buffer) |
static unsigned int | do_unpack_uint32 (const char *buffer) |
static uint64_t | do_unpack_uint64 (const char *buffer) |
static unsigned int | do_unpack_uint8 (const char *buffer) |
static void | validate_int64_limits (int64_t value, int num_bits, bool &range_error) |
Confirms that the signed value fits within num_bits bits. More... | |
static void | validate_int_limits (int value, int num_bits, bool &range_error) |
Confirms that the signed value fits within num_bits bits. More... | |
static void | validate_uint64_limits (uint64_t value, int num_bits, bool &range_error) |
Confirms that the unsigned value fits within num_bits bits. More... | |
static void | validate_uint_limits (unsigned int value, int num_bits, bool &range_error) |
Confirms that the unsigned value fits within num_bits bits. More... | |
This defines the internal interface for packing values into a DCField.
The various different DC objects inherit from this.
Normally these methods are called only by the DCPacker object; the user wouldn't normally call these directly.
Definition at line 68 of file dcPackerInterface.h.
|
virtual |
This flavor of get_num_nested_fields is used during unpacking.
It returns the number of nested fields to expect, given a certain length in bytes (as read from the _num_length_bytes stored in the stream on the push). This will only be called if _num_length_bytes is nonzero.
Reimplemented in DCSimpleParameter, and DCArrayParameter.
Definition at line 178 of file dcPackerInterface.cxx.
Referenced by DCPacker::push().
|
inline |
Returns true if the other interface is bitwise the same as this one–that is, a uint32 only matches a uint32, etc.
Names of components, and range limits, are not compared.
Definition at line 28 of file dcPackerInterface.I.
Referenced by DCSwitch::do_check_match_switch().
bool DCPackerInterface::check_match | ( | const std::string & | description, |
DCFile * | dcfile = nullptr |
||
) | const |
Returns true if this interface is bitwise the same as the interface described with the indicated formatted string, e.g.
"(uint8, uint8, int16)", or false otherwise.
If DCFile is not NULL, it specifies the DCFile that was previously loaded, from which some predefined structs and typedefs may be referenced in the description string.
Definition at line 141 of file dcPackerInterface.cxx.
|
virtual |
Returns true if this field matches the indicated array parameter, false otherwise.
Definition at line 426 of file dcPackerInterface.cxx.
|
virtual |
Returns true if this field matches the indicated atomic field, false otherwise.
Definition at line 435 of file dcPackerInterface.cxx.
|
virtual |
Returns true if this field matches the indicated class parameter, false otherwise.
Definition at line 408 of file dcPackerInterface.cxx.
|
virtual |
Returns true if this field matches the indicated molecular field, false otherwise.
Definition at line 444 of file dcPackerInterface.cxx.
|
virtual |
Returns true if this field matches the indicated simple parameter, false otherwise.
Definition at line 399 of file dcPackerInterface.cxx.
|
virtual |
Returns true if this field matches the indicated switch parameter, false otherwise.
Definition at line 417 of file dcPackerInterface.cxx.
int DCPackerInterface::find_seek_index | ( | const std::string & | name | ) | const |
Returns the index number to be passed to a future call to DCPacker::seek() to seek directly to the named field without having to look up the field name in a table later, or -1 if the named field cannot be found.
If the named field is nested within a switch or some similar dynamic structure that reveals different fields based on the contents of the data, this mechanism cannot be used to pre-fetch the field index number–you must seek for the field by name.
Definition at line 79 of file dcPackerInterface.cxx.
References DCPackerCatalog::find_entry_by_name(), and get_catalog().
const DCPackerCatalog * DCPackerInterface::get_catalog | ( | ) | const |
Returns the DCPackerCatalog associated with this field, listing all of the nested fields by name.
Definition at line 387 of file dcPackerInterface.cxx.
Referenced by find_seek_index(), and DCPacker::seek().
|
inline |
If has_fixed_byte_size() returns true, this returns the number of bytes this field type will use.
Definition at line 46 of file dcPackerInterface.I.
Referenced by DCAtomicField::add_element(), DCSwitch::SwitchFields::add_field(), and DCArrayParameter::calc_num_nested_fields().
|
inline |
Returns the name of this field, or empty string if the field is unnamed.
Definition at line 18 of file dcPackerInterface.I.
Referenced by DCSwitch::SwitchFields::add_field(), DCPacker::get_current_field_name(), and DCTypedef::get_name().
|
virtual |
Returns the DCPackerInterface object that represents the nth nested field.
This may return NULL if there is no such field (but it shouldn't do this if n is in the range 0 <= n < get_num_nested_fields()).
Reimplemented in DCSwitch::SwitchFields, DCAtomicField, DCSimpleParameter, DCArrayParameter, DCMolecularField, DCClassParameter, and DCSwitchParameter.
Definition at line 188 of file dcPackerInterface.cxx.
Referenced by DCPacker::push().
|
inline |
Returns the number of bytes that should be written into the stream on a push() to record the number of bytes in the record up until the next pop().
This is only meaningful if _has_nested_fields is true.
Definition at line 79 of file dcPackerInterface.I.
Referenced by DCPacker::pop(), and DCPacker::push().
|
inline |
Returns the number of nested fields required by this field type.
These may be array elements or structure elements. The return value may be -1 to indicate the number of nested fields is variable.
Definition at line 101 of file dcPackerInterface.I.
Referenced by DCMolecularField::add_atomic(), DCPacker::pop(), and DCPacker::push().
|
inline |
Returns the type of value expected by this field.
Definition at line 109 of file dcPackerInterface.I.
|
inline |
Returns true if this field type always packs to the same number of bytes, false if it is variable.
Definition at line 37 of file dcPackerInterface.I.
Referenced by DCAtomicField::add_element(), DCSwitch::SwitchFields::add_field(), and DCArrayParameter::calc_num_nested_fields().
|
inline |
Returns true if this field type always has the same structure regardless of the data in the stream, or false if its structure may vary.
This is almost, but not quite, the same thing as has_fixed_byte_size. The difference is that a DCSwitch may have multiple cases all with the same byte size, but they will still (presumably) have different structures, in the sense that the actual list of fields varies according to the live data.
Definition at line 59 of file dcPackerInterface.I.
Referenced by DCAtomicField::add_element(), and DCSwitch::SwitchFields::add_field().
|
inline |
Returns true if this field type has any nested fields (and thus expects a push() .
. pop() interface to the DCPacker), or false otherwise. If this returns true, get_num_nested_fields() may be called to determine how many nested fields are expected.
Definition at line 91 of file dcPackerInterface.I.
Referenced by DCPacker::has_nested_fields().
|
inline |
Returns true if this field, or any sub-field of this field, has a limit imposed in the DC file on its legal values.
If this is false, then unpack_validate() is trivial.
Definition at line 69 of file dcPackerInterface.I.
Referenced by DCAtomicField::add_element(), and DCSwitch::SwitchFields::add_field().
|
virtual |
Packs the indicated numeric or string value into the stream.
Reimplemented in DCSimpleParameter, and DCArrayParameter.
Definition at line 255 of file dcPackerInterface.cxx.
|
virtual |
Packs the field's specified default value (or a sensible default if no value is specified) into the stream.
Returns true if the default value is packed, false if the field doesn't know how to pack its default value.
Reimplemented in DCField, DCSimpleParameter, DCArrayParameter, and DCSwitchParameter.
Definition at line 265 of file dcPackerInterface.cxx.
|
virtual |
Packs the indicated numeric or string value into the stream.
Reimplemented in DCSimpleParameter.
Definition at line 207 of file dcPackerInterface.cxx.
|
virtual |
Packs the indicated numeric or string value into the stream.
Reimplemented in DCSimpleParameter.
Definition at line 215 of file dcPackerInterface.cxx.
|
virtual |
Packs the indicated numeric or string value into the stream.
Reimplemented in DCSimpleParameter.
Definition at line 231 of file dcPackerInterface.cxx.
|
virtual |
Packs the indicated numeric or string value into the stream.
Reimplemented in DCSimpleParameter, and DCArrayParameter.
Definition at line 247 of file dcPackerInterface.cxx.
|
virtual |
Packs the indicated numeric or string value into the stream.
Reimplemented in DCSimpleParameter.
Definition at line 223 of file dcPackerInterface.cxx.
|
virtual |
Packs the indicated numeric or string value into the stream.
Reimplemented in DCSimpleParameter.
Definition at line 239 of file dcPackerInterface.cxx.
|
virtual |
Sets the name of this field.
Reimplemented in DCField.
Definition at line 167 of file dcPackerInterface.cxx.
Referenced by DCField::set_name().
|
virtual |
Unpacks the current numeric or string value from the stream.
Reimplemented in DCSimpleParameter, and DCArrayParameter.
Definition at line 321 of file dcPackerInterface.cxx.
|
virtual |
Unpacks the current numeric or string value from the stream.
Reimplemented in DCSimpleParameter.
Definition at line 273 of file dcPackerInterface.cxx.
|
virtual |
Unpacks the current numeric or string value from the stream.
Reimplemented in DCSimpleParameter.
Definition at line 281 of file dcPackerInterface.cxx.
|
virtual |
Unpacks the current numeric or string value from the stream.
Reimplemented in DCSimpleParameter.
Definition at line 297 of file dcPackerInterface.cxx.
|
virtual |
Increments p to the end of the current field without actually unpacking any data or performing any range validation.
Returns true on success, false on failure (e.g. we don't know how to skip this field).
Reimplemented in DCSimpleParameter.
Definition at line 346 of file dcPackerInterface.cxx.
|
virtual |
Unpacks the current numeric or string value from the stream.
Reimplemented in DCSimpleParameter, and DCArrayParameter.
Definition at line 313 of file dcPackerInterface.cxx.
|
virtual |
Unpacks the current numeric or string value from the stream.
Reimplemented in DCSimpleParameter.
Definition at line 289 of file dcPackerInterface.cxx.
|
virtual |
Unpacks the current numeric or string value from the stream.
Reimplemented in DCSimpleParameter.
Definition at line 305 of file dcPackerInterface.cxx.
|
virtual |
Internally unpacks the current numeric or string value and validates it against the type range limits, but does not return the value.
Returns true on success, false on failure (e.g. we don't know how to validate this field).
Reimplemented in DCSimpleParameter.
Definition at line 332 of file dcPackerInterface.cxx.
|
inlinestatic |
Confirms that the signed value fits within num_bits bits.
Sets range_error true if it does not.
Definition at line 345 of file dcPackerInterface.I.
|
inlinestatic |
Confirms that the signed value fits within num_bits bits.
Sets range_error true if it does not.
Definition at line 325 of file dcPackerInterface.I.
|
virtual |
After a number of fields have been packed via push() .
. pack_*() .. pop(), this is called to confirm that the number of nested fields that were added is valid for this type. This is primarily useful for array types with dynamic ranges that can't validate the number of fields any other way.
Reimplemented in DCArrayParameter.
Definition at line 199 of file dcPackerInterface.cxx.
Referenced by DCPacker::pop().
|
inlinestatic |
Confirms that the unsigned value fits within num_bits bits.
Sets range_error true if it does not.
Definition at line 376 of file dcPackerInterface.I.
|
inlinestatic |
Confirms that the unsigned value fits within num_bits bits.
Sets range_error true if it does not.
Definition at line 359 of file dcPackerInterface.I.
Referenced by DCPacker::pop().