2 * This file is part of the libsigrok project.
4 * Copyright (C) 2013-2014 Martin Ling <martin-sigrok@earth.li>
6 * This program is free software: you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation, either version 3 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with this program. If not, see <http://www.gnu.org/licenses/>.
22 @mainpage API Reference
27 The sigrok++ API provides an object-oriented C++ interface to the functionality
28 in libsigrok, including automatic memory and resource management.
30 It is built on top of the public libsigrok C API, and is designed to be used as
31 a standalone alternative API. Programs should not mix usage of the C and C++
32 APIs; the C++ interface code needs to have full control of all C API calls for
33 resources to be managed correctly.
38 All runtime objects created through the C++ API are passed and accessed via
39 shared pointers, using the C++11 std::shared_ptr implementation. This means
40 that a reference count is kept for each object.
42 Shared pointers can be copied and assigned in a user's program, automatically
43 updating their reference count and deleting objects when they are no longer in
44 use. The C++ interface code also keeps track of internal dependencies between
45 libsigrok resources, and ensures that objects are not prematurely deleted when
46 their resources are in use by other objects.
48 This means that management of sigrok++ objects and their underlying libsigrok
49 resources can be treated as fully automatic. As long as all shared pointers to
50 objects are deleted or reassigned when no longer in use, all underlying
51 resources will be released at the right time.
56 Usage of the C++ API needs to begin with a call to sigrok::Context::create().
57 This will create the global libsigrok context and returns a shared pointer to
58 the sigrok::Context object. Methods on this object provide access to the
59 hardware drivers, input and output formats supported by the library, as well
60 as means of creating other objects such as sessions and triggers.
65 When any libsigrok C API call returns an error, a sigrok::Error exception is
66 raised, which provides access to the error code and description.
73 #include "libsigrok/libsigrok.h"
74 #include <glibmm-2.4/glibmm.h>
86 /* Forward declarations */
91 class SR_API HardwareDevice;
93 class SR_API EventSource;
95 class SR_API ConfigKey;
96 class SR_API InputFormat;
97 class SR_API OutputFormat;
98 class SR_API LogLevel;
99 class SR_API ChannelGroup;
100 class SR_API Trigger;
101 class SR_API TriggerStage;
102 class SR_API TriggerMatch;
103 class SR_API TriggerMatchType;
104 class SR_API ChannelType;
106 class SR_API PacketPayload;
107 class SR_API PacketType;
108 class SR_API Quantity;
110 class SR_API QuantityFlag;
112 class SR_API InputDevice;
114 class SR_API DataType;
117 /** Exception thrown when an error code is returned by any libsigrok call. */
118 class SR_API Error: public exception
124 const char *what() const throw();
127 /* Base template for classes whose resources are owned by a parent object. */
128 template <class Class, class Parent, typename Struct>
129 class SR_API ParentOwned
132 /* Parent object which owns this child object's underlying structure.
134 This shared pointer will be null when this child is unused, but
135 will be assigned to point to the parent before any shared pointer
136 to this child is handed out to the user.
138 When the reference count of this child falls to zero, this shared
139 pointer to its parent is reset by a custom deleter on the child's
142 This strategy ensures that the destructors for both the child and
143 the parent are called at the correct time, i.e. only when all
144 references to both the parent and all its children are gone. */
145 shared_ptr<Parent> parent;
147 /* Weak pointer for shared_from_this() implementation. */
148 weak_ptr<Class> weak_this;
151 /* Note, this implementation will create a new smart_ptr if none exists. */
152 shared_ptr<Class> shared_from_this()
154 shared_ptr<Class> shared;
156 if (!(shared = weak_this.lock()))
158 shared = shared_ptr<Class>((Class *) this, reset_parent);
165 shared_ptr<Class> get_shared_pointer(shared_ptr<Parent> parent)
168 throw Error(SR_ERR_BUG);
169 this->parent = parent;
170 return shared_from_this();
173 shared_ptr<Class> get_shared_pointer(Parent *parent)
176 throw Error(SR_ERR_BUG);
177 return get_shared_pointer(parent->shared_from_this());
180 static void reset_parent(Class *object)
183 throw Error(SR_ERR_BUG);
184 object->parent.reset();
189 ParentOwned<Class, Parent, Struct>(Struct *structure) :
195 /* Base template for classes whose resources are owned by the user. */
196 template <class Class, typename Struct>
197 class SR_API UserOwned : public enable_shared_from_this<Class>
200 shared_ptr<Class> shared_from_this()
202 auto shared = enable_shared_from_this<Class>::shared_from_this();
204 throw Error(SR_ERR_BUG);
210 UserOwned<Class, Struct>(Struct *structure) :
215 /* Deleter needed to allow shared_ptr use with protected destructor. */
219 void operator()(Class *object) { delete object; }
223 /** Type of log callback */
224 typedef function<void(const LogLevel *, string message)> LogCallbackFunction;
226 /** The global libsigrok context */
227 class SR_API Context : public UserOwned<Context, struct sr_context>
230 /** Create new context */
231 static shared_ptr<Context> create();
232 /** libsigrok package version. */
233 string get_package_version();
234 /** libsigrok library version. */
235 string get_lib_version();
236 /** Available hardware drivers, indexed by name. */
237 map<string, shared_ptr<Driver> > get_drivers();
238 /** Available input formats, indexed by name. */
239 map<string, shared_ptr<InputFormat> > get_input_formats();
240 /** Available output formats, indexed by name. */
241 map<string, shared_ptr<OutputFormat> > get_output_formats();
242 /** Current log level. */
243 const LogLevel *get_log_level();
244 /** Set the log level.
245 * @param level LogLevel to use. */
246 void set_log_level(const LogLevel *level);
247 /** Current log domain. */
248 string get_log_domain();
249 /** Set the log domain.
250 * @param value Log domain prefix string. */
251 void set_log_domain(string value);
252 /** Set the log callback.
253 * @param callback Callback of the form callback(LogLevel, string). */
254 void set_log_callback(LogCallbackFunction callback);
255 /** Set the log callback to the default handler. */
256 void set_log_callback_default();
257 /** Create a new session. */
258 shared_ptr<Session> create_session();
259 /** Load a saved session.
260 * @param filename File name string. */
261 shared_ptr<Session> load_session(string filename);
262 /** Create a new trigger.
263 * @param name Name string for new trigger. */
264 shared_ptr<Trigger> create_trigger(string name);
265 /** Open an input file.
266 * @param filename File name string. */
267 shared_ptr<Input> open_file(string filename);
268 /** Open an input stream based on header data.
269 * @param header Initial data from stream. */
270 shared_ptr<Input> open_stream(string header);
272 map<string, Driver *> drivers;
273 map<string, InputFormat *> input_formats;
274 map<string, OutputFormat *> output_formats;
276 LogCallbackFunction log_callback;
279 friend class Deleter;
280 friend class Session;
284 /** An object that can be configured. */
285 class SR_API Configurable
288 /** Read configuration for the given key.
289 * @param key ConfigKey to read. */
290 Glib::VariantBase config_get(const ConfigKey *key);
291 /** Set configuration for the given key to a specified value.
292 * @param key ConfigKey to set.
293 * @param value Value to set. */
294 void config_set(const ConfigKey *key, Glib::VariantBase value);
295 /** Enumerate available values for the given configuration key.
296 * @param key ConfigKey to enumerate values for. */
297 Glib::VariantContainerBase config_list(const ConfigKey *key);
298 /** Enumerate available keys, according to a given index key. */
299 vector<const ConfigKey *> config_keys(const ConfigKey *key);
300 /** Check for a key in the list from a given index key. */
301 bool config_check(const ConfigKey *key, const ConfigKey *index_key);
304 struct sr_dev_driver *driver,
305 struct sr_dev_inst *sdi,
306 struct sr_channel_group *channel_group);
307 virtual ~Configurable();
308 struct sr_dev_driver *config_driver;
309 struct sr_dev_inst *config_sdi;
310 struct sr_channel_group *config_channel_group;
313 /** A hardware driver provided by the library */
314 class SR_API Driver :
315 public ParentOwned<Driver, Context, struct sr_dev_driver>,
319 /** Name of this driver. */
321 /** Long name for this driver. */
322 string get_long_name();
323 /** Scan for devices and return a list of devices found.
324 * @param options Mapping of (ConfigKey, value) pairs. */
325 vector<shared_ptr<HardwareDevice> > scan(
326 map<const ConfigKey *, Glib::VariantBase> options = {});
329 vector<HardwareDevice *> devices;
330 Driver(struct sr_dev_driver *structure);
332 friend class Context;
333 friend class HardwareDevice;
334 friend class ChannelGroup;
337 /** A generic device, either hardware or virtual */
338 class SR_API Device : public Configurable
341 /** Description identifying this device. */
342 string get_description();
343 /** Vendor name for this device. */
345 /** Model name for this device. */
347 /** Version string for this device. */
348 string get_version();
349 /** List of the channels available on this device. */
350 vector<shared_ptr<Channel> > get_channels();
351 /** Channel groups available on this device, indexed by name. */
352 map<string, shared_ptr<ChannelGroup> > get_channel_groups();
358 Device(struct sr_dev_inst *structure);
360 virtual shared_ptr<Device> get_shared_from_this() = 0;
361 shared_ptr<Channel> get_channel(struct sr_channel *ptr);
362 struct sr_dev_inst *structure;
363 map<struct sr_channel *, Channel *> channels;
364 map<string, ChannelGroup *> channel_groups;
365 /** Deleter needed to allow shared_ptr use with protected destructor. */
369 void operator()(Device *device) { delete device; }
371 friend class Deleter;
372 friend class Session;
373 friend class Channel;
374 friend class ChannelGroup;
379 /** A real hardware device, connected via a driver */
380 class SR_API HardwareDevice :
381 public ParentOwned<HardwareDevice, Context, struct sr_dev_inst>,
385 /** Driver providing this device. */
386 shared_ptr<Driver> get_driver();
388 HardwareDevice(Driver *driver, struct sr_dev_inst *structure);
390 shared_ptr<Device> get_shared_from_this();
393 friend class ChannelGroup;
396 /** A channel on a device */
397 class SR_API Channel :
398 public ParentOwned<Channel, Device, struct sr_channel>
401 /** Current name of this channel. */
403 /** Set the name of this channel. *
404 * @param name Name string to set. */
405 void set_name(string name);
406 /** Type of this channel. */
407 const ChannelType *get_type();
408 /** Enabled status of this channel. */
410 /** Set the enabled status of this channel.
411 * @param value Boolean value to set. */
412 void set_enabled(bool value);
413 /** Get the index number of this channel. */
414 unsigned int get_index();
416 Channel(struct sr_channel *structure);
418 const ChannelType * const type;
420 friend class ChannelGroup;
421 friend class Session;
422 friend class TriggerStage;
425 /** A group of channels on a device, which share some configuration */
426 class SR_API ChannelGroup :
427 public ParentOwned<ChannelGroup, Device, struct sr_channel_group>,
431 /** Name of this channel group. */
433 /** List of the channels in this group. */
434 vector<shared_ptr<Channel> > get_channels();
436 ChannelGroup(Device *device, struct sr_channel_group *structure);
438 vector<Channel *> channels;
442 /** A trigger configuration */
443 class SR_API Trigger : public UserOwned<Trigger, struct sr_trigger>
446 /** Name of this trigger configuration. */
448 /** List of the stages in this trigger. */
449 vector<shared_ptr<TriggerStage> > get_stages();
450 /** Add a new stage to this trigger. */
451 shared_ptr<TriggerStage> add_stage();
453 Trigger(shared_ptr<Context> context, string name);
455 shared_ptr<Context> context;
456 vector<TriggerStage *> stages;
457 friend class Deleter;
458 friend class Context;
459 friend class Session;
462 /** A stage in a trigger configuration */
463 class SR_API TriggerStage :
464 public ParentOwned<TriggerStage, Trigger, struct sr_trigger_stage>
467 /** Index number of this stage. */
469 /** List of match conditions on this stage. */
470 vector<shared_ptr<TriggerMatch> > get_matches();
471 /** Add a new match condition to this stage.
472 * @param channel Channel to match on.
473 * @param type TriggerMatchType to apply. */
474 void add_match(shared_ptr<Channel> channel, const TriggerMatchType *type);
475 /** Add a new match condition to this stage.
476 * @param channel Channel to match on.
477 * @param type TriggerMatchType to apply.
478 * @param value Threshold value. */
479 void add_match(shared_ptr<Channel> channel, const TriggerMatchType *type, float value);
481 vector<TriggerMatch *> matches;
482 TriggerStage(struct sr_trigger_stage *structure);
484 friend class Trigger;
487 /** A match condition in a trigger configuration */
488 class SR_API TriggerMatch :
489 public ParentOwned<TriggerMatch, TriggerStage, struct sr_trigger_match>
492 /** Channel this condition matches on. */
493 shared_ptr<Channel> get_channel();
494 /** Type of match. */
495 const TriggerMatchType *get_type();
496 /** Threshold value. */
499 TriggerMatch(struct sr_trigger_match *structure, shared_ptr<Channel> channel);
501 shared_ptr<Channel> channel;
502 friend class TriggerStage;
505 /** Type of datafeed callback */
506 typedef function<void(shared_ptr<Device>, shared_ptr<Packet>)>
507 DatafeedCallbackFunction;
509 /* Data required for C callback function to call a C++ datafeed callback */
510 class SR_PRIV DatafeedCallbackData
513 void run(const struct sr_dev_inst *sdi,
514 const struct sr_datafeed_packet *pkt);
516 DatafeedCallbackFunction callback;
517 DatafeedCallbackData(Session *session,
518 DatafeedCallbackFunction callback);
520 friend class Session;
523 /** Type of source callback */
524 typedef function<bool(Glib::IOCondition)>
525 SourceCallbackFunction;
527 /* Data required for C callback function to call a C++ source callback */
528 class SR_PRIV SourceCallbackData
531 bool run(int revents);
533 SourceCallbackData(shared_ptr<EventSource> source);
534 shared_ptr<EventSource> source;
535 friend class Session;
538 /** An I/O event source */
539 class SR_API EventSource
542 /** Create an event source from a file descriptor.
543 * @param fd File descriptor.
544 * @param events GLib IOCondition event mask.
545 * @param timeout Timeout in milliseconds.
546 * @param callback Callback of the form callback(events) */
547 static shared_ptr<EventSource> create(int fd, Glib::IOCondition events,
548 int timeout, SourceCallbackFunction callback);
549 /** Create an event source from a GLib PollFD
550 * @param pollfd GLib PollFD
551 * @param timeout Timeout in milliseconds.
552 * @param callback Callback of the form callback(events) */
553 static shared_ptr<EventSource> create(Glib::PollFD pollfd, int timeout,
554 SourceCallbackFunction callback);
555 /** Create an event source from a GLib IOChannel
556 * @param channel GLib IOChannel.
557 * @param events GLib IOCondition event mask.
558 * @param timeout Timeout in milliseconds.
559 * @param callback Callback of the form callback(events) */
560 static shared_ptr<EventSource> create(
561 Glib::RefPtr<Glib::IOChannel> channel, Glib::IOCondition events,
562 int timeout, SourceCallbackFunction callback);
564 EventSource(int timeout, SourceCallbackFunction callback);
573 Glib::RefPtr<Glib::IOChannel> channel;
574 Glib::IOCondition events;
576 SourceCallbackFunction callback;
577 /** Deleter needed to allow shared_ptr use with protected destructor. */
581 void operator()(EventSource *source) { delete source; }
583 friend class Deleter;
584 friend class Session;
585 friend class SourceCallbackData;
588 /** A sigrok session */
589 class SR_API Session : public UserOwned<Session, struct sr_session>
592 /** Add a device to this session.
593 * @param device Device to add. */
594 void add_device(shared_ptr<Device> device);
595 /** List devices attached to this session. */
596 vector<shared_ptr<Device> > get_devices();
597 /** Remove all devices from this session. */
598 void remove_devices();
599 /** Add a datafeed callback to this session.
600 * @param callback Callback of the form callback(Device, Packet). */
601 void add_datafeed_callback(DatafeedCallbackFunction callback);
602 /** Remove all datafeed callbacks from this session. */
603 void remove_datafeed_callbacks();
604 /** Add an I/O event source.
605 * @param source EventSource to add. */
606 void add_source(shared_ptr<EventSource> source);
607 /** Remove an event source.
608 * @param source EventSource to remove. */
609 void remove_source(shared_ptr<EventSource> source);
610 /** Start the session. */
612 /** Run the session event loop. */
614 /** Stop the session. */
616 /** Begin saving session to a file.
617 * @param filename File name string. */
618 void begin_save(string filename);
619 /** Append a packet to the session file being saved.
620 * @param packet Packet to append. */
621 void append(shared_ptr<Packet> packet);
622 /** Append raw logic data to the session file being saved. */
623 void append(void *data, size_t length, unsigned int unit_size);
624 /** Get current trigger setting. */
625 shared_ptr<Trigger> get_trigger();
626 /** Set trigger setting.
627 * @param trigger Trigger object to use. */
628 void set_trigger(shared_ptr<Trigger> trigger);
630 Session(shared_ptr<Context> context);
631 Session(shared_ptr<Context> context, string filename);
633 const shared_ptr<Context> context;
634 map<const struct sr_dev_inst *, shared_ptr<Device> > devices;
635 vector<DatafeedCallbackData *> datafeed_callbacks;
636 map<shared_ptr<EventSource>, SourceCallbackData *> source_callbacks;
638 bool save_initialized;
639 string save_filename;
640 uint64_t save_samplerate;
641 shared_ptr<Trigger> trigger;
642 friend class Deleter;
643 friend class Context;
644 friend class DatafeedCallbackData;
647 /** A packet on the session datafeed */
648 class SR_API Packet : public UserOwned<Packet, const struct sr_datafeed_packet>
651 /** Type of this packet. */
652 const PacketType *get_type();
653 /** Payload of this packet. */
654 shared_ptr<PacketPayload> get_payload();
656 Packet(shared_ptr<Device> device,
657 const struct sr_datafeed_packet *structure);
659 shared_ptr<Device> device;
660 PacketPayload *payload;
661 friend class Deleter;
662 friend class Session;
664 friend class DatafeedCallbackData;
671 /** Abstract base class for datafeed packet payloads */
672 class SR_API PacketPayload
676 virtual ~PacketPayload() = 0;
677 virtual shared_ptr<PacketPayload> get_shared_pointer(Packet *parent) = 0;
678 /** Deleter needed to allow shared_ptr use with protected destructor. */
682 void operator()(PacketPayload *payload) { delete payload; }
684 friend class Deleter;
689 /** Payload of a datafeed header packet */
690 class SR_API Header :
691 public ParentOwned<Header, Packet, const struct sr_datafeed_header>,
695 /* Feed version number. */
696 int get_feed_version();
697 /* Start time of this session. */
698 Glib::TimeVal get_start_time();
700 Header(const struct sr_datafeed_header *structure);
702 shared_ptr<PacketPayload> get_shared_pointer(Packet *parent);
706 /** Payload of a datafeed metadata packet */
708 public ParentOwned<Meta, Packet, const struct sr_datafeed_meta>,
712 /* Mapping of (ConfigKey, value) pairs. */
713 map<const ConfigKey *, Glib::VariantBase> get_config();
715 Meta(const struct sr_datafeed_meta *structure);
717 shared_ptr<PacketPayload> get_shared_pointer(Packet *parent);
718 map<const ConfigKey *, Glib::VariantBase> config;
722 /** Payload of a datafeed packet with logic data */
724 public ParentOwned<Logic, Packet, const struct sr_datafeed_logic>,
728 /* Pointer to data. */
729 void *get_data_pointer();
730 /* Data length in bytes. */
731 size_t get_data_length();
732 /* Size of each sample in bytes. */
733 unsigned int get_unit_size();
735 Logic(const struct sr_datafeed_logic *structure);
737 shared_ptr<PacketPayload> get_shared_pointer(Packet *parent);
741 /** Payload of a datafeed packet with analog data */
742 class SR_API Analog :
743 public ParentOwned<Analog, Packet, const struct sr_datafeed_analog>,
747 /** Pointer to data. */
748 float *get_data_pointer();
749 /** Number of samples in this packet. */
750 unsigned int get_num_samples();
751 /** Channels for which this packet contains data. */
752 vector<shared_ptr<Channel> > get_channels();
753 /** Measured quantity of the samples in this packet. */
754 const Quantity *get_mq();
755 /** Unit of the samples in this packet. */
756 const Unit *get_unit();
757 /** Measurement flags associated with the samples in this packet. */
758 vector<const QuantityFlag *> get_mq_flags();
760 Analog(const struct sr_datafeed_analog *structure);
762 shared_ptr<PacketPayload> get_shared_pointer(Packet *parent);
766 /** An input format supported by the library */
767 class SR_API InputFormat :
768 public ParentOwned<InputFormat, Context, const struct sr_input_module>
771 /** Name of this input format. */
773 /** Description of this input format. */
774 string get_description();
775 /** Options supported by this input format. */
776 map<string, shared_ptr<Option> > get_options();
777 /** Create an input using this input format.
778 * @param options Mapping of (option name, value) pairs. */
779 shared_ptr<Input> create_input(map<string, Glib::VariantBase> options = {});
781 InputFormat(const struct sr_input_module *structure);
783 friend class Context;
784 friend class InputDevice;
787 /** An input instance (an input format applied to a file or stream) */
788 class SR_API Input : public UserOwned<Input, const struct sr_input>
791 /** Virtual device associated with this input. */
792 shared_ptr<InputDevice> get_device();
793 /** Send next stream data.
794 * @param data Next stream data. */
795 void send(string data);
797 Input(shared_ptr<Context> context, const struct sr_input *structure);
799 shared_ptr<Context> context;
801 friend class Deleter;
802 friend class Context;
803 friend class InputFormat;
806 /** A virtual device associated with an input */
807 class SR_API InputDevice :
808 public ParentOwned<InputDevice, Input, struct sr_dev_inst>,
812 InputDevice(shared_ptr<Input> input, struct sr_dev_inst *sdi);
814 shared_ptr<Device> get_shared_from_this();
815 shared_ptr<Input> input;
819 /** An option used by an output format */
820 class SR_API Option : public UserOwned<Option, const struct sr_option>
823 /** Short name of this option suitable for command line usage. */
825 /** Short name of this option suitable for GUI usage. */
827 /** Description of this option in a sentence. */
828 string get_description();
829 /** Default value for this option. */
830 Glib::VariantBase get_default_value();
831 /** Possible values for this option, if a limited set. */
832 vector<Glib::VariantBase> get_values();
834 Option(const struct sr_option *structure,
835 shared_ptr<const struct sr_option *> structure_array);
837 shared_ptr<const struct sr_option *> structure_array;
838 friend class Deleter;
839 friend class InputFormat;
840 friend class OutputFormat;
843 /** An output format supported by the library */
844 class SR_API OutputFormat :
845 public ParentOwned<OutputFormat, Context, const struct sr_output_module>
848 /** Name of this output format. */
850 /** Description of this output format. */
851 string get_description();
852 /** Options supported by this output format. */
853 map<string, shared_ptr<Option> > get_options();
854 /** Create an output using this format.
855 * @param device Device to output for.
856 * @param options Mapping of (option name, value) pairs. */
857 shared_ptr<Output> create_output(shared_ptr<Device> device,
858 map<string, Glib::VariantBase> options = {});
860 OutputFormat(const struct sr_output_module *structure);
862 friend class Context;
866 /** An output instance (an output format applied to a device) */
867 class SR_API Output : public UserOwned<Output, const struct sr_output>
870 /** Update output with data from the given packet.
871 * @param packet Packet to handle. */
872 string receive(shared_ptr<Packet> packet);
874 Output(shared_ptr<OutputFormat> format, shared_ptr<Device> device);
875 Output(shared_ptr<OutputFormat> format,
876 shared_ptr<Device> device, map<string, Glib::VariantBase> options);
878 const shared_ptr<OutputFormat> format;
879 const shared_ptr<Device> device;
880 const map<string, Glib::VariantBase> options;
881 friend class Deleter;
882 friend class OutputFormat;
885 /** Base class for objects which wrap an enumeration value from libsigrok */
886 template <typename T> class SR_API EnumValue
889 /** The enum constant associated with this value. */
890 T get_id() const { return id; }
891 /** The name associated with this value. */
892 string get_name() const { return name; }
894 EnumValue(T id, const char name[]) : id(id), name(name) {}
904 #endif // LIBSIGROK_HPP