Event refactor builds on Windows

include/icsneo/api/event.h

@@ -0,0 +1,150 @@
+#ifndef __ICSNEO_API_EVENT_H_
+#define __ICSNEO_API_EVENT_H_
+
+#include <stdint.h>
+#include <time.h>
+
+typedef struct {
+	const char* description;
+	time_t timestamp;
+	uint32_t eventNumber;
+	uint8_t severity;
+	char serial[7];
+	uint8_t reserved[16];
+} neoevent_t;
+
+#ifdef __cplusplus
+
+#include <vector>
+#include <chrono>
+#include <string>
+#include <ostream>
+
+namespace icsneo {
+
+class Device;
+
+class APIEvent {
+public:
+	typedef std::chrono::system_clock EventClock;
+	typedef std::chrono::time_point<EventClock> EventTimePoint;
+
+	enum class Type : uint32_t {
+		Any = 0, // Used for filtering, should not appear in data
+
+		// API Events
+		InvalidNeoDevice = 0x1000, // api
+		RequiredParameterNull = 0x1001,
+		BufferInsufficient = 0x1002,
+		OutputTruncated = 0x1003, // just a warning
+		ParameterOutOfRange = 0x1004,
+		DeviceCurrentlyOpen = 0x1005,
+		DeviceCurrentlyClosed = 0x1006,
+		DeviceCurrentlyOnline = 0x1007,
+		DeviceCurrentlyOffline = 0x1008,
+		DeviceCurrentlyPolling = 0x1009,
+		DeviceNotCurrentlyPolling = 0x1010,
+		UnsupportedTXNetwork = 0x1011,
+		MessageMaxLengthExceeded = 0x1012,
+		
+		// Device Events
+		PollingMessageOverflow = 0x2000,
+		NoSerialNumber = 0x2001, // api
+		IncorrectSerialNumber = 0x2002, // api
+		SettingsReadError = 0x2003,
+		SettingsVersionError = 0x2004,
+		SettingsLengthError = 0x2005,
+		SettingsChecksumError = 0x2006,
+		SettingsNotAvailable = 0x2007,
+		SettingsReadOnly = 0x2008,
+		CANSettingsNotAvailable = 0x2009,
+		CANFDSettingsNotAvailable = 0x2010,
+		LSFTCANSettingsNotAvailable = 0x2011,
+		SWCANSettingsNotAvailable = 0x2012,
+		BaudrateNotFound = 0x2013,
+		UnexpectedNetworkType = 0x2014,
+		DeviceFirmwareOutOfDate = 0x2015,
+		SettingsStructureMismatch = 0x2016,
+		SettingsStructureTruncated = 0x2017,
+		NoDeviceResponse = 0x2018,
+		MessageFormattingError = 0x2019,
+		CANFDNotSupported = 0x2020,
+		RTRNotSupported = 0x2021,
+
+		// Transport Events
+		FailedToRead = 0x3000,
+		FailedToWrite = 0x3001,
+		DriverFailedToOpen = 0x3002,
+		DriverFailedToClose = 0x3003,
+		PacketChecksumError = 0x3004,
+		TransmitBufferFull = 0x3005,
+		PCAPCouldNotStart = 0x3102,
+		PCAPCouldNotFindDevices = 0x3103,
+		PacketDecodingError = 0x3104,
+		
+		NoErrorFound = 0xFFFFFFFD,
+		TooManyEvents = 0xFFFFFFFE,
+		Unknown = 0xFFFFFFFF
+	};
+	enum class Severity : uint8_t {
+		Any = 0, // Used for filtering, should not appear in data
+		EventInfo = 0x10,
+		EventWarning = 0x20,
+		Error = 0x30
+	};
+
+	APIEvent() : eventStruct({}), device(nullptr), serial(), timepoint() {}
+	APIEvent(APIEvent::Type event, APIEvent::Severity severity, const Device* device = nullptr);
+	
+	const neoevent_t* getNeoEvent() const noexcept { return &eventStruct; }
+	Type getType() const noexcept { return Type(eventStruct.eventNumber); }
+	Severity getSeverity() const noexcept { return Severity(eventStruct.severity); }
+	std::string getDescription() const noexcept { return std::string(eventStruct.description); }
+	const Device* getDevice() const noexcept { return device; } // Will return nullptr if this is an API-wide event
+	EventTimePoint getTimestamp() const noexcept { return timepoint; }
+
+	bool isForDevice(const Device* forDevice) const noexcept { return forDevice == device; }
+	bool isForDevice(std::string serial) const noexcept;
+	
+	// As opposed to getDescription, this will also add text such as "neoVI FIRE 2 CY2468 Error: " to fully describe the problem
+	std::string describe() const noexcept;
+	friend std::ostream& operator<<(std::ostream& os, const APIEvent& event) {
+		os << event.describe();
+		return os;
+	}
+
+	static const char* DescriptionForType(Type type);
+
+private:
+	neoevent_t eventStruct;
+	std::string serial;
+	EventTimePoint timepoint;
+	const Device* device;
+
+	void init(Type event, APIEvent::Severity);
+};
+
+class EventFilter {
+public:
+	EventFilter() {} // Empty filter matches anything
+	EventFilter(APIEvent::Type type) : type(type) {}
+	EventFilter(APIEvent::Severity severity) : severity(severity) {}
+	EventFilter(const Device* device, APIEvent::Type type = APIEvent::Type::Any) : type(type), matchOnDevicePtr(true), device(device) {}
+	EventFilter(const Device* device, APIEvent::Severity severity) : severity(severity), matchOnDevicePtr(true), device(device) {}
+	EventFilter(std::string serial, APIEvent::Type type = APIEvent::Type::Any) : type(type), serial(serial) {}
+	EventFilter(std::string serial, APIEvent::Severity severity) : severity(severity), serial(serial) {}
+
+	bool match(const APIEvent& event) const noexcept;
+
+	APIEvent::Type type = APIEvent::Type::Any;
+	APIEvent::Severity severity = APIEvent::Severity::Any;
+	bool matchOnDevicePtr = false;
+	const Device* device = nullptr; // nullptr will match on "no device, generic API event"
+	std::string serial; // Empty serial will match any, including no device. Not affected by matchOnDevicePtr
+};
+
+}
+
+#endif // __cplusplus
+
+#endif