X-Git-Url: https://sigrok.org/gitweb/?a=blobdiff_plain;f=bindings%2Fcxx%2Finclude%2Flibsigrok%2Flibsigrok.hpp;h=1c99670360c5657a82b62f3f7c4866ecfbf54ce8;hb=304be4a77186f4524e3894af8279690f28ffd98f;hp=6595802e9c3e8d121043203566a50a6543be714c;hpb=d01d2314879988e9d9ab80872889340e89ec8cc8;p=libsigrok.git diff --git a/bindings/cxx/include/libsigrok/libsigrok.hpp b/bindings/cxx/include/libsigrok/libsigrok.hpp index 6595802e..1c996703 100644 --- a/bindings/cxx/include/libsigrok/libsigrok.hpp +++ b/bindings/cxx/include/libsigrok/libsigrok.hpp @@ -77,6 +77,7 @@ raised, which provides access to the error code and description. #include #include #include +#include namespace sigrok { @@ -113,6 +114,7 @@ class SR_API InputDevice; class SR_API Output; class SR_API DataType; class SR_API Option; +class SR_API UserDevice; /** Exception thrown when an error code is returned by any libsigrok call. */ class SR_API Error: public exception @@ -124,9 +126,9 @@ public: const char *what() const throw(); }; -/* Base template for most classes which wrap a struct type from libsigrok. */ -template class SR_API StructureWrapper : - public enable_shared_from_this > +/* Base template for classes whose resources are owned by a parent object. */ +template +class SR_API ParentOwned { protected: /* Parent object which owns this child object's underlying structure. @@ -142,63 +144,116 @@ protected: This strategy ensures that the destructors for both the child and the parent are called at the correct time, i.e. only when all references to both the parent and all its children are gone. */ - shared_ptr parent; + shared_ptr _parent; + + /* Weak pointer for shared_from_this() implementation. */ + weak_ptr _weak_this; public: - shared_ptr > - get_shared_pointer(Parent *parent) + /* Get parent object that owns this object. */ + shared_ptr parent() + { + return _parent; + } + + /* Note, this implementation will create a new smart_ptr if none exists. */ + shared_ptr shared_from_this() + { + shared_ptr shared; + + if (!(shared = _weak_this.lock())) + { + shared = shared_ptr((Class *) this, reset_parent); + _weak_this = shared; + } + + return shared; + } + + shared_ptr get_shared_pointer(shared_ptr parent) { - this->parent = static_pointer_cast(parent->shared_from_this()); - return shared_ptr >( - this, reset_parent); + if (!parent) + throw Error(SR_ERR_BUG); + this->_parent = parent; + return shared_from_this(); } - shared_ptr > - get_shared_pointer(shared_ptr parent) + + shared_ptr get_shared_pointer(Parent *parent) { - this->parent = parent; - return shared_ptr >( - this, reset_parent); + if (!parent) + throw Error(SR_ERR_BUG); + return get_shared_pointer(parent->shared_from_this()); } protected: - static void reset_parent(StructureWrapper *object) + static void reset_parent(Class *object) { - object->parent.reset(); + if (!object->_parent) + throw Error(SR_ERR_BUG); + object->_parent.reset(); } - Struct *structure; + Struct *_structure; - StructureWrapper(Struct *structure) : - structure(structure) + ParentOwned(Struct *structure) : + _structure(structure) { } }; +/* Base template for classes whose resources are owned by the user. */ +template +class SR_API UserOwned : public enable_shared_from_this +{ +public: + shared_ptr shared_from_this() + { + auto shared = enable_shared_from_this::shared_from_this(); + if (!shared) + throw Error(SR_ERR_BUG); + return shared; + } +protected: + Struct *_structure; + + UserOwned(Struct *structure) : + _structure(structure) + { + } + + /* Deleter needed to allow shared_ptr use with protected destructor. */ + class Deleter + { + public: + void operator()(Class *object) { delete object; } + }; +}; + /** Type of log callback */ typedef function LogCallbackFunction; /** The global libsigrok context */ -class SR_API Context : public enable_shared_from_this +class SR_API Context : public UserOwned { public: /** Create new context */ static shared_ptr create(); /** libsigrok package version. */ - string get_package_version(); + string package_version(); /** libsigrok library version. */ - string get_lib_version(); + string lib_version(); /** Available hardware drivers, indexed by name. */ - map > get_drivers(); + map > drivers(); /** Available input formats, indexed by name. */ - map > get_input_formats(); + map > input_formats(); /** Available output formats, indexed by name. */ - map > get_output_formats(); + map > output_formats(); /** Current log level. */ - const LogLevel *get_log_level(); + const LogLevel *log_level(); /** Set the log level. * @param level LogLevel to use. */ void set_log_level(const LogLevel *level); /** Current log domain. */ - string get_log_domain(); + string log_domain(); /** Set the log domain. * @param value Log domain prefix string. */ void set_log_domain(string value); @@ -209,6 +264,22 @@ public: void set_log_callback_default(); /** Create a new session. */ shared_ptr create_session(); + /** Create a new user device. */ + shared_ptr create_user_device( + string vendor, string model, string version); + /** Create a header packet. */ + shared_ptr create_header_packet(Glib::TimeVal start_time); + /** Create a meta packet. */ + shared_ptr create_meta_packet( + map config); + /** Create a logic packet. */ + shared_ptr create_logic_packet( + void *data_pointer, size_t data_length, unsigned int unit_size); + /** Create an analog packet. */ + shared_ptr create_analog_packet( + vector > channels, + float *data_pointer, unsigned int num_samples, const Quantity *mq, + const Unit *unit, vector mqflags); /** Load a saved session. * @param filename File name string. */ shared_ptr load_session(string filename); @@ -222,45 +293,22 @@ public: * @param header Initial data from stream. */ shared_ptr open_stream(string header); protected: - struct sr_context *structure; - map drivers; - map input_formats; - map output_formats; - Session *session; - LogCallbackFunction log_callback; + map _drivers; + map _input_formats; + map _output_formats; + Session *_session; + LogCallbackFunction _log_callback; Context(); ~Context(); - /** Deleter needed to allow shared_ptr use with protected destructor. */ - class Deleter - { - public: - void operator()(Context *context) { delete context; } - }; friend class Deleter; friend class Session; friend class Driver; }; -/** A hardware driver provided by the library */ -class SR_API Driver : public StructureWrapper -{ -public: - /** Name of this driver. */ - string get_name(); - /** Long name for this driver. */ - string get_long_name(); - /** Scan for devices and return a list of devices found. - * @param options Mapping of (ConfigKey, value) pairs. */ - vector > scan( - map options = {}); -protected: - bool initialized; - vector devices; - Driver(struct sr_dev_driver *structure); - ~Driver(); - friend class Context; - friend class HardwareDevice; - friend class ChannelGroup; +enum Capability { + GET = SR_CONF_GET, + SET = SR_CONF_SET, + LIST = SR_CONF_LIST }; /** An object that can be configured. */ @@ -277,6 +325,10 @@ public: /** Enumerate available values for the given configuration key. * @param key ConfigKey to enumerate values for. */ Glib::VariantContainerBase config_list(const ConfigKey *key); + /** Enumerate available keys, according to a given index key. */ + map > config_keys(const ConfigKey *key); + /** Check for a key in the list from a given index key. */ + bool config_check(const ConfigKey *key, const ConfigKey *index_key); protected: Configurable( struct sr_dev_driver *driver, @@ -288,22 +340,49 @@ protected: struct sr_channel_group *config_channel_group; }; +/** A hardware driver provided by the library */ +class SR_API Driver : + public ParentOwned, + public Configurable +{ +public: + /** Name of this driver. */ + string name(); + /** Long name for this driver. */ + string long_name(); + /** Scan for devices and return a list of devices found. + * @param options Mapping of (ConfigKey, value) pairs. */ + vector > scan( + map options = + map()); +protected: + bool _initialized; + vector _devices; + Driver(struct sr_dev_driver *structure); + ~Driver(); + friend class Context; + friend class HardwareDevice; + friend class ChannelGroup; +}; + /** A generic device, either hardware or virtual */ class SR_API Device : public Configurable { public: - /** Description identifying this device. */ - string get_description(); /** Vendor name for this device. */ - string get_vendor(); + string vendor(); /** Model name for this device. */ - string get_model(); + string model(); /** Version string for this device. */ - string get_version(); + string version(); + /** Serial number for this device. */ + string serial_number(); + /** Connection ID for this device. */ + string connection_id(); /** List of the channels available on this device. */ - vector > get_channels(); + vector > channels(); /** Channel groups available on this device, indexed by name. */ - map > get_channel_groups(); + map > channel_groups(); /** Open device. */ void open(); /** Close device. */ @@ -313,9 +392,9 @@ protected: ~Device(); virtual shared_ptr get_shared_from_this() = 0; shared_ptr get_channel(struct sr_channel *ptr); - struct sr_dev_inst *structure; - map channels; - map channel_groups; + struct sr_dev_inst *_structure; + map _channels; + map _channel_groups; /** Deleter needed to allow shared_ptr use with protected destructor. */ class Deleter { @@ -332,100 +411,127 @@ protected: /** A real hardware device, connected via a driver */ class SR_API HardwareDevice : - public StructureWrapper, + public UserOwned, public Device { public: /** Driver providing this device. */ - shared_ptr get_driver(); + shared_ptr driver(); protected: - HardwareDevice(Driver *driver, struct sr_dev_inst *structure); + HardwareDevice(shared_ptr driver, struct sr_dev_inst *structure); ~HardwareDevice(); shared_ptr get_shared_from_this(); - Driver *driver; + shared_ptr _driver; + /** Deleter needed to allow shared_ptr use with protected destructor. */ + class Deleter + { + public: + void operator()(HardwareDevice *device) { delete device; } + }; + friend class Deleter; friend class Driver; friend class ChannelGroup; }; +/** A virtual device, created by the user */ +class SR_API UserDevice : + public UserOwned, + public Device +{ +public: + /** Add a new channel to this device. */ + shared_ptr add_channel(unsigned int index, const ChannelType *type, string name); +protected: + UserDevice(string vendor, string model, string version); + ~UserDevice(); + shared_ptr get_shared_from_this(); + /** Deleter needed to allow shared_ptr use with protected destructor. */ + class Deleter + { + public: + void operator()(UserDevice *device) { delete device; } + }; + friend class Context; + friend class Deleter; +}; + /** A channel on a device */ -class SR_API Channel : public StructureWrapper +class SR_API Channel : + public ParentOwned { public: /** Current name of this channel. */ - string get_name(); + string name(); /** Set the name of this channel. * * @param name Name string to set. */ void set_name(string name); /** Type of this channel. */ - const ChannelType *get_type(); + const ChannelType *type(); /** Enabled status of this channel. */ - bool get_enabled(); + bool enabled(); /** Set the enabled status of this channel. * @param value Boolean value to set. */ void set_enabled(bool value); /** Get the index number of this channel. */ - unsigned int get_index(); + unsigned int index(); protected: Channel(struct sr_channel *structure); ~Channel(); - const ChannelType * const type; + const ChannelType * const _type; friend class Device; + friend class UserDevice; friend class ChannelGroup; friend class Session; friend class TriggerStage; + friend class Context; }; /** A group of channels on a device, which share some configuration */ class SR_API ChannelGroup : - public StructureWrapper, + public ParentOwned, public Configurable { public: /** Name of this channel group. */ - string get_name(); + string name(); /** List of the channels in this group. */ - vector > get_channels(); + vector > channels(); protected: ChannelGroup(Device *device, struct sr_channel_group *structure); ~ChannelGroup(); - vector channels; + vector _channels; friend class Device; }; /** A trigger configuration */ -class SR_API Trigger : public enable_shared_from_this +class SR_API Trigger : public UserOwned { public: /** Name of this trigger configuration. */ - string get_name(); + string name(); /** List of the stages in this trigger. */ - vector > get_stages(); + vector > stages(); /** Add a new stage to this trigger. */ shared_ptr add_stage(); protected: Trigger(shared_ptr context, string name); ~Trigger(); - struct sr_trigger *structure; - shared_ptr context; - vector stages; - /** Deleter needed to allow shared_ptr use with protected destructor. */ - class Deleter - { - public: - void operator()(Trigger *trigger) { delete trigger; } - }; + shared_ptr _context; + vector _stages; + friend class Deleter; friend class Context; friend class Session; }; /** A stage in a trigger configuration */ -class SR_API TriggerStage : public StructureWrapper +class SR_API TriggerStage : + public ParentOwned { public: /** Index number of this stage. */ - int get_number(); + int number(); /** List of match conditions on this stage. */ - vector > get_matches(); + vector > matches(); /** Add a new match condition to this stage. * @param channel Channel to match on. * @param type TriggerMatchType to apply. */ @@ -436,26 +542,27 @@ public: * @param value Threshold value. */ void add_match(shared_ptr channel, const TriggerMatchType *type, float value); protected: - vector matches; + vector _matches; TriggerStage(struct sr_trigger_stage *structure); ~TriggerStage(); friend class Trigger; }; /** A match condition in a trigger configuration */ -class SR_API TriggerMatch : public StructureWrapper +class SR_API TriggerMatch : + public ParentOwned { public: /** Channel this condition matches on. */ - shared_ptr get_channel(); + shared_ptr channel(); /** Type of match. */ - const TriggerMatchType *get_type(); + const TriggerMatchType *type(); /** Threshold value. */ - float get_value(); + float value(); protected: TriggerMatch(struct sr_trigger_match *structure, shared_ptr channel); ~TriggerMatch(); - shared_ptr channel; + shared_ptr _channel; friend class TriggerStage; }; @@ -470,10 +577,10 @@ public: void run(const struct sr_dev_inst *sdi, const struct sr_datafeed_packet *pkt); protected: - DatafeedCallbackFunction callback; + DatafeedCallbackFunction _callback; DatafeedCallbackData(Session *session, DatafeedCallbackFunction callback); - Session *session; + Session *_session; friend class Session; }; @@ -488,7 +595,7 @@ public: bool run(int revents); protected: SourceCallbackData(shared_ptr source); - shared_ptr source; + shared_ptr _source; friend class Session; }; @@ -524,13 +631,13 @@ protected: SOURCE_FD, SOURCE_POLLFD, SOURCE_IOCHANNEL - } type; - int fd; - Glib::PollFD pollfd; - Glib::RefPtr channel; - Glib::IOCondition events; - int timeout; - SourceCallbackFunction callback; + } _type; + int _fd; + Glib::PollFD _pollfd; + Glib::RefPtr _channel; + Glib::IOCondition _events; + int _timeout; + SourceCallbackFunction _callback; /** Deleter needed to allow shared_ptr use with protected destructor. */ class Deleter { @@ -542,15 +649,34 @@ protected: friend class SourceCallbackData; }; +/** A virtual device associated with a stored session */ +class SR_API SessionDevice : + public ParentOwned, + public Device +{ +protected: + SessionDevice(struct sr_dev_inst *sdi); + ~SessionDevice(); + shared_ptr get_shared_from_this(); + /** Deleter needed to allow shared_ptr use with protected destructor. */ + class Deleter + { + public: + void operator()(SessionDevice *device) { delete device; } + }; + friend class Deleter; + friend class Session; +}; + /** A sigrok session */ -class SR_API Session +class SR_API Session : public UserOwned { public: /** Add a device to this session. * @param device Device to add. */ void add_device(shared_ptr device); /** List devices attached to this session. */ - vector > get_devices(); + vector > devices(); /** Remove all devices from this session. */ void remove_devices(); /** Add a datafeed callback to this session. @@ -579,56 +705,48 @@ public: /** Append raw logic data to the session file being saved. */ void append(void *data, size_t length, unsigned int unit_size); /** Get current trigger setting. */ - shared_ptr get_trigger(); + shared_ptr trigger(); /** Set trigger setting. * @param trigger Trigger object to use. */ void set_trigger(shared_ptr trigger); + /** Get filename this session was loaded from. */ + string filename(); protected: Session(shared_ptr context); Session(shared_ptr context, string filename); ~Session(); - struct sr_session *structure; - const shared_ptr context; - map > devices; - vector datafeed_callbacks; - map, SourceCallbackData *> source_callbacks; - bool saving; - bool save_initialized; - string save_filename; - uint64_t save_samplerate; - shared_ptr trigger; - /** Deleter needed to allow shared_ptr use with protected destructor. */ - class Deleter - { - public: - void operator()(Session *session) { delete session; } - }; + shared_ptr get_device(const struct sr_dev_inst *sdi); + const shared_ptr _context; + map _owned_devices; + map > _other_devices; + vector _datafeed_callbacks; + map, SourceCallbackData *> _source_callbacks; + string _filename; + bool _saving; + bool _save_initialized; + string _save_filename; + uint64_t _save_samplerate; + shared_ptr _trigger; friend class Deleter; friend class Context; friend class DatafeedCallbackData; + friend class SessionDevice; }; /** A packet on the session datafeed */ -class SR_API Packet : public enable_shared_from_this +class SR_API Packet : public UserOwned { public: /** Type of this packet. */ - const PacketType *get_type(); + const PacketType *type(); /** Payload of this packet. */ - shared_ptr get_payload(); + shared_ptr payload(); protected: Packet(shared_ptr device, const struct sr_datafeed_packet *structure); ~Packet(); - const struct sr_datafeed_packet *structure; - shared_ptr device; - PacketPayload *payload; - /** Deleter needed to allow shared_ptr use with protected destructor. */ - class Deleter - { - public: - void operator()(Packet *packet) { delete packet; } - }; + shared_ptr _device; + PacketPayload *_payload; friend class Deleter; friend class Session; friend class Output; @@ -637,6 +755,7 @@ protected: friend class Meta; friend class Logic; friend class Analog; + friend class Context; }; /** Abstract base class for datafeed packet payloads */ @@ -645,9 +764,7 @@ class SR_API PacketPayload protected: PacketPayload(); virtual ~PacketPayload() = 0; - shared_ptr get_shared_pointer(Packet *parent) { - return static_pointer_cast(get_shared_pointer(parent)); - } + virtual shared_ptr get_shared_pointer(Packet *parent) = 0; /** Deleter needed to allow shared_ptr use with protected destructor. */ class Deleter { @@ -660,92 +777,97 @@ protected: }; /** Payload of a datafeed header packet */ -class SR_API Header : public PacketPayload, - public StructureWrapper +class SR_API Header : + public ParentOwned, + public PacketPayload { public: /* Feed version number. */ - int get_feed_version(); + int feed_version(); /* Start time of this session. */ - Glib::TimeVal get_start_time(); + Glib::TimeVal start_time(); protected: Header(const struct sr_datafeed_header *structure); ~Header(); - const struct sr_datafeed_header *structure; + shared_ptr get_shared_pointer(Packet *parent); friend class Packet; }; /** Payload of a datafeed metadata packet */ -class SR_API Meta : public PacketPayload, - public StructureWrapper +class SR_API Meta : + public ParentOwned, + public PacketPayload { public: /* Mapping of (ConfigKey, value) pairs. */ - map get_config(); + map config(); protected: Meta(const struct sr_datafeed_meta *structure); ~Meta(); - const struct sr_datafeed_meta *structure; - map config; + shared_ptr get_shared_pointer(Packet *parent); + map _config; friend class Packet; }; /** Payload of a datafeed packet with logic data */ -class SR_API Logic : public PacketPayload, - public StructureWrapper +class SR_API Logic : + public ParentOwned, + public PacketPayload { public: /* Pointer to data. */ - void *get_data_pointer(); + void *data_pointer(); /* Data length in bytes. */ - size_t get_data_length(); + size_t data_length(); /* Size of each sample in bytes. */ - unsigned int get_unit_size(); + unsigned int unit_size(); protected: Logic(const struct sr_datafeed_logic *structure); ~Logic(); - const struct sr_datafeed_logic *structure; + shared_ptr get_shared_pointer(Packet *parent); friend class Packet; }; /** Payload of a datafeed packet with analog data */ -class SR_API Analog : public PacketPayload, - public StructureWrapper +class SR_API Analog : + public ParentOwned, + public PacketPayload { public: /** Pointer to data. */ - float *get_data_pointer(); + float *data_pointer(); /** Number of samples in this packet. */ - unsigned int get_num_samples(); + unsigned int num_samples(); /** Channels for which this packet contains data. */ - vector > get_channels(); + vector > channels(); /** Measured quantity of the samples in this packet. */ - const Quantity *get_mq(); + const Quantity *mq(); /** Unit of the samples in this packet. */ - const Unit *get_unit(); + const Unit *unit(); /** Measurement flags associated with the samples in this packet. */ - vector get_mq_flags(); + vector mq_flags(); protected: Analog(const struct sr_datafeed_analog *structure); ~Analog(); - const struct sr_datafeed_analog *structure; + shared_ptr get_shared_pointer(Packet *parent); friend class Packet; }; /** An input format supported by the library */ class SR_API InputFormat : - public StructureWrapper + public ParentOwned { public: /** Name of this input format. */ - string get_name(); + string name(); /** Description of this input format. */ - string get_description(); + string description(); /** Options supported by this input format. */ - map > get_options(); + map > options(); /** Create an input using this input format. * @param options Mapping of (option name, value) pairs. */ - shared_ptr create_input(map options = {}); + shared_ptr create_input(map options = + map()); protected: InputFormat(const struct sr_input_module *structure); ~InputFormat(); @@ -754,27 +876,21 @@ protected: }; /** An input instance (an input format applied to a file or stream) */ -class SR_API Input : public enable_shared_from_this +class SR_API Input : public UserOwned { public: /** Virtual device associated with this input. */ - shared_ptr get_device(); + shared_ptr device(); /** Send next stream data. * @param data Next stream data. */ void send(string data); + /** Signal end of input data. */ + void end(); protected: Input(shared_ptr context, const struct sr_input *structure); ~Input(); - shared_ptr get_shared_from_this(); - const struct sr_input *structure; - shared_ptr context; - InputDevice *device; - /** Deleter needed to allow shared_ptr use with protected destructor. */ - class Deleter - { - public: - void operator()(Input *input) { delete input; } - }; + shared_ptr _context; + InputDevice *_device; friend class Deleter; friend class Context; friend class InputFormat; @@ -782,50 +898,36 @@ protected: /** A virtual device associated with an input */ class SR_API InputDevice : - public StructureWrapper, + public ParentOwned, public Device { protected: InputDevice(shared_ptr input, struct sr_dev_inst *sdi); ~InputDevice(); shared_ptr get_shared_from_this(); - shared_ptr input; - /** Deleter needed to allow shared_ptr use with protected destructor. */ - class Deleter - { - public: - void operator()(InputDevice *device) { delete device; } - }; - friend class Deleter; + shared_ptr _input; friend class Input; }; /** An option used by an output format */ -class SR_API Option +class SR_API Option : public UserOwned { public: /** Short name of this option suitable for command line usage. */ - string get_id(); + string id(); /** Short name of this option suitable for GUI usage. */ - string get_name(); + string name(); /** Description of this option in a sentence. */ - string get_description(); + string description(); /** Default value for this option. */ - Glib::VariantBase get_default_value(); + Glib::VariantBase default_value(); /** Possible values for this option, if a limited set. */ - vector get_values(); + vector values(); protected: Option(const struct sr_option *structure, shared_ptr structure_array); ~Option(); - const struct sr_option *structure; - shared_ptr structure_array; - /** Deleter needed to allow shared_ptr use with protected destructor. */ - class Deleter - { - public: - void operator()(Option *option) { delete option; } - }; + shared_ptr _structure_array; friend class Deleter; friend class InputFormat; friend class OutputFormat; @@ -833,20 +935,21 @@ protected: /** An output format supported by the library */ class SR_API OutputFormat : - public StructureWrapper + public ParentOwned { public: /** Name of this output format. */ - string get_name(); + string name(); /** Description of this output format. */ - string get_description(); + string description(); /** Options supported by this output format. */ - map > get_options(); + map > options(); /** Create an output using this format. * @param device Device to output for. * @param options Mapping of (option name, value) pairs. */ shared_ptr create_output(shared_ptr device, - map options = {}); + map options = + map()); protected: OutputFormat(const struct sr_output_module *structure); ~OutputFormat(); @@ -855,7 +958,7 @@ protected: }; /** An output instance (an output format applied to a device) */ -class SR_API Output +class SR_API Output : public UserOwned { public: /** Update output with data from the given packet. @@ -866,33 +969,53 @@ protected: Output(shared_ptr format, shared_ptr device, map options); ~Output(); - const struct sr_output *structure; - const shared_ptr format; - const shared_ptr device; - const map options; - /** Deleter needed to allow shared_ptr use with protected destructor. */ - class Deleter - { - public: - void operator()(Output *output) { delete output; } - }; + const shared_ptr _format; + const shared_ptr _device; + const map _options; friend class Deleter; friend class OutputFormat; }; /** Base class for objects which wrap an enumeration value from libsigrok */ -template class SR_API EnumValue +template class SR_API EnumValue { public: - /** The enum constant associated with this value. */ - T get_id() const { return id; } + /** The integer constant associated with this value. */ + int id() const + { + return static_cast(_id); + } /** The name associated with this value. */ - string get_name() const { return name; } + string name() const + { + return _name; + } + /** Get value associated with a given integer constant. */ + static const Class *get(int id) + { + auto key = static_cast(id); + if (_values.find(key) == _values.end()) + throw Error(SR_ERR_ARG); + return _values.at(key); + } + /** Get possible values. */ + static std::vector values() + { + std::vector result; + for (auto entry : _values) + result.push_back(entry.second); + return result; + } protected: - EnumValue(T id, const char name[]) : id(id), name(name) {} - ~EnumValue() {} - const T id; - const string name; + EnumValue(Enum id, const char name[]) : _id(id), _name(name) + { + } + ~EnumValue() + { + } + static const std::map _values; + const Enum _id; + const string _name; }; #include "enums.hpp"