diff --git a/module/CMakeLists.txt b/module/CMakeLists.txt index 461423b5..1c3e6e1c 100644 --- a/module/CMakeLists.txt +++ b/module/CMakeLists.txt @@ -76,6 +76,7 @@ add_library(SqModule MODULE SqBase.hpp Main.cpp Library/Utils.cpp Library/Utils.hpp Library/Utils/Map.cpp Library/Utils/Map.hpp Library/Utils/Vector.cpp Library/Utils/Vector.hpp + Library/ZMQ.cpp Library/ZMQ.hpp # Misc Misc/Broadcast.cpp Misc/Constants.cpp @@ -89,9 +90,11 @@ add_library(SqModule MODULE SqBase.hpp Main.cpp # POCO PocoLib/Crypto.cpp PocoLib/Crypto.hpp PocoLib/Data.cpp PocoLib/Data.hpp - PocoLib/Foundation.cpp PocoLib/Foundation.hpp PocoLib/JSON.cpp PocoLib/JSON.hpp PocoLib/Net.cpp PocoLib/Net.hpp + PocoLib/RegEx.cpp PocoLib/RegEx.hpp + PocoLib/Register.cpp PocoLib/Register.hpp + PocoLib/Time.cpp PocoLib/Time.hpp PocoLib/Util.cpp PocoLib/Util.hpp PocoLib/XML.cpp PocoLib/XML.hpp # @@ -105,7 +108,7 @@ if(WIN32 OR MINGW) target_link_libraries(SqModule wsock32 ws2_32 shlwapi) endif() # Link to base libraries -target_link_libraries(SqModule Squirrel FmtLib SimpleINI TinyDir ConcurrentQueue cpr maxminddb) +target_link_libraries(SqModule Squirrel FmtLib SimpleINI TinyDir ConcurrentQueue cpr maxminddb libzmq-static) # Link to POCO libraries target_link_libraries(SqModule Poco::Foundation Poco::Encodings Poco::Crypto Poco::Util Poco::Data Poco::Net Poco::JSON Poco::XML Poco::Zip Poco::JWT Poco::Redis Poco::MongoDB) # Does POCO have SQLite support? diff --git a/module/Core.cpp b/module/Core.cpp index 80804b18..fcdcff6a 100644 --- a/module/Core.cpp +++ b/module/Core.cpp @@ -37,7 +37,8 @@ namespace SqMod { extern bool RegisterAPI(HSQUIRRELVM vm); // ------------------------------------------------------------------------------------------------ -extern void PocoStartup(); +extern void ZmqProcess(); +extern void ZmqTerminate(); extern void InitializeTasks(); extern void InitializeRoutines(); extern void TerminateAreas(); @@ -46,7 +47,6 @@ extern void TerminateTasks(); extern void TerminateRoutines(); extern void TerminateCommands(); extern void TerminateSignals(); -//extern void TerminateWorkers(); // ------------------------------------------------------------------------------------------------ extern Buffer GetRealFilePath(const SQChar * path); @@ -501,8 +501,8 @@ void Core::Terminate(bool shutdown) TerminateAreas(); // Release privilege managers //TerminatePrivileges(); - // Terminate workers - //TerminateWorkers(); + // Release ZMQ sockets + ZmqTerminate(); // In case there's a payload for reload m_ReloadPayload.Release(); // Release null objects in case any reference to valid objects is stored in them diff --git a/module/Library/ZMQ.cpp b/module/Library/ZMQ.cpp new file mode 100644 index 00000000..b41f370b --- /dev/null +++ b/module/Library/ZMQ.cpp @@ -0,0 +1,287 @@ +// ------------------------------------------------------------------------------------------------ +#include "Library/ZMQ.hpp" + +// ------------------------------------------------------------------------------------------------ +#include + +// ------------------------------------------------------------------------------------------------ +namespace SqMod { + +// ------------------------------------------------------------------------------------------------ +SQMOD_DECL_TYPENAME(SqZContext, _SC("SqZmqContext")) +SQMOD_DECL_TYPENAME(SqZMessage, _SC("SqZmqMessage")) +SQMOD_DECL_TYPENAME(SqZSocket, _SC("SqZmqSocket")) + +// ------------------------------------------------------------------------------------------------ +void ZSkt::Flush(HSQUIRRELVM vm) +{ + // Need someone to receive the message + ZMsg msg; + // Try to get a message from the queue + while (mOutputQueue.try_dequeue(msg)) + { + // Is there a callback to receive the message? + if (!mOnData.IsNull()) + { + // Transform the message into a script object + LightObj o(SqTypeIdentity< ZMessage >{}, vm, std::make_shared< ZMsg >(std::move(msg))); + // Forward it to the callback + mOnData(o); + } + } +} + +// ------------------------------------------------------------------------------------------------ +LightObj ZContext::Socket(int type) const +{ + return LightObj(SqTypeIdentity< ZSocket >{}, SqVM(), *this, type); +} + +// ------------------------------------------------------------------------------------------------ +static void ZmqProcess() +{ + // Go over all sockets and try to update them + for (ZSkt * inst = ZSkt::sHead; inst && inst->mNext != ZSkt::sHead; inst = inst->mNext) + { + // Flush pending messages + inst->Flush(SqVM()); + } +} + +// ------------------------------------------------------------------------------------------------ +void ZmqTerminate() +{ + // Go over all sockets and try to close them + for (ZSkt * inst = ZSkt::sHead; inst && inst->mNext != ZSkt::sHead; inst = inst->mNext) + { + // Close the socket + inst->Close(); + // Flush pending messages + inst->Flush(SqVM()); + } +} + +// ================================================================================================ +void Register_ZMQ(HSQUIRRELVM vm) +{ + Table ns(vm); + + ns.Func(_SC("Process"), &ZmqProcess); + + // -------------------------------------------------------------------------------------------- + ns.Bind(_SC("Context"), + Class< ZContext, NoCopy< ZContext > >(vm, SqZContext::Str) + // Constructors + .Ctor() + // Meta-methods + .SquirrelFunc(_SC("_typename"), &SqZContext::Fn) + // Properties + .Prop(_SC("IsNull"), &ZContext::IsNull) + // Member Methods + .Func(_SC("Get"), &ZContext::Get) + .Func(_SC("Set"), &ZContext::Set) + .Func(_SC("Shutdown"), &ZContext::Shutdown) + .Func(_SC("Socket"), &ZContext::Socket) + ); + + // -------------------------------------------------------------------------------------------- + ns.Bind(_SC("Message"), + Class< ZMessage, NoCopy< ZMessage > >(vm, SqZMessage::Str) + // Constructors + .Ctor() + .Ctor< SQInteger >() + .Ctor< SQInteger, StackStrF & >() + // Meta-methods + .SquirrelFunc(_SC("_typename"), &SqZMessage::Fn) + // Properties + .Prop(_SC("IsNull"), &ZMessage::IsNull) + .Prop(_SC("More"), &ZMessage::More) + .Prop(_SC("Size"), &ZMessage::GetSize) + // Member Methods + .Func(_SC("Get"), &ZMessage::Get) + .Func(_SC("Set"), &ZMessage::Set) + .Func(_SC("Meta"), &ZMessage::Meta) + .Func(_SC("ToString"), &ZMessage::ToString) + ); + + // -------------------------------------------------------------------------------------------- + ns.Bind(_SC("Socket"), + Class< ZSocket, NoCopy< ZSocket > >(vm, SqZSocket::Str) + // Constructors + .Ctor() + // Meta-methods + .SquirrelFunc(_SC("_typename"), &SqZSocket::Fn) + // Properties + .Prop(_SC("IsNull"), &ZSocket::IsNull) + // Member Methods + .Func(_SC("Bind"), &ZSocket::Bind) + .Func(_SC("Connect"), &ZSocket::Connect) + .Func(_SC("Disconnect"), &ZSocket::Disconnect) + .Func(_SC("Run"), &ZSocket::Run) + .Func(_SC("Close"), &ZSocket::Close) + .CbFunc(_SC("OnData"), &ZSocket::OnData) + ); + + RootTable(vm).Bind(_SC("SqZMQ"), ns); + + ConstTable(vm).Enum(_SC("SqZmq"), Enumeration(vm) + /* Context options */ + .Const(_SC("IO_THREADS"), int32_t(ZMQ_IO_THREADS)) + .Const(_SC("MAX_SOCKETS"), int32_t(ZMQ_MAX_SOCKETS)) + .Const(_SC("SOCKET_LIMIT"), int32_t(ZMQ_SOCKET_LIMIT)) + .Const(_SC("THREAD_PRIORITY"), int32_t(ZMQ_THREAD_PRIORITY)) + .Const(_SC("THREAD_SCHED_POLICY"), int32_t(ZMQ_THREAD_SCHED_POLICY)) + .Const(_SC("MAX_MSGSZ"), int32_t(ZMQ_MAX_MSGSZ)) + .Const(_SC("MSG_T_SIZE"), int32_t(ZMQ_MSG_T_SIZE)) + .Const(_SC("THREAD_AFFINITY_CPU_ADD"), int32_t(ZMQ_THREAD_AFFINITY_CPU_ADD)) + .Const(_SC("THREAD_AFFINITY_CPU_REMOVE"), int32_t(ZMQ_THREAD_AFFINITY_CPU_REMOVE)) + .Const(_SC("THREAD_NAME_PREFIX"), int32_t(ZMQ_THREAD_NAME_PREFIX)) + /* Socket types. */ + .Const(_SC("PAIR"), int32_t(ZMQ_PAIR)) + .Const(_SC("PUB"), int32_t(ZMQ_PUB)) + .Const(_SC("SUB"), int32_t(ZMQ_SUB)) + .Const(_SC("REQ"), int32_t(ZMQ_REQ)) + .Const(_SC("REP"), int32_t(ZMQ_REP)) + .Const(_SC("DEALER"), int32_t(ZMQ_DEALER)) + .Const(_SC("ROUTER"), int32_t(ZMQ_ROUTER)) + .Const(_SC("PULL"), int32_t(ZMQ_PULL)) + .Const(_SC("PUSH"), int32_t(ZMQ_PUSH)) + .Const(_SC("XPUB"), int32_t(ZMQ_XPUB)) + .Const(_SC("XSUB"), int32_t(ZMQ_XSUB)) + .Const(_SC("STREAM"), int32_t(ZMQ_STREAM)) + /* Socket options */ + .Const(_SC("AFFINITY"), int32_t(ZMQ_AFFINITY)) + .Const(_SC("ROUTING_ID"), int32_t(ZMQ_ROUTING_ID)) + .Const(_SC("SUBSCRIBE"), int32_t(ZMQ_SUBSCRIBE)) + .Const(_SC("UNSUBSCRIBE"), int32_t(ZMQ_UNSUBSCRIBE)) + .Const(_SC("RATE"), int32_t(ZMQ_RATE)) + .Const(_SC("RECOVERY_IVL"), int32_t(ZMQ_RECOVERY_IVL)) + .Const(_SC("SNDBUF"), int32_t(ZMQ_SNDBUF)) + .Const(_SC("RCVBUF"), int32_t(ZMQ_RCVBUF)) + .Const(_SC("RCVMORE"), int32_t(ZMQ_RCVMORE)) + .Const(_SC("FD"), int32_t(ZMQ_FD)) + .Const(_SC("EVENTS"), int32_t(ZMQ_EVENTS)) + .Const(_SC("TYPE"), int32_t(ZMQ_TYPE)) + .Const(_SC("LINGER"), int32_t(ZMQ_LINGER)) + .Const(_SC("RECONNECT_IVL"), int32_t(ZMQ_RECONNECT_IVL)) + .Const(_SC("BACKLOG"), int32_t(ZMQ_BACKLOG)) + .Const(_SC("RECONNECT_IVL_MAX"), int32_t(ZMQ_RECONNECT_IVL_MAX)) + .Const(_SC("MAXMSGSIZE"), int32_t(ZMQ_MAXMSGSIZE)) + .Const(_SC("SNDHWM"), int32_t(ZMQ_SNDHWM)) + .Const(_SC("RCVHWM"), int32_t(ZMQ_RCVHWM)) + .Const(_SC("MULTICAST_HOPS"), int32_t(ZMQ_MULTICAST_HOPS)) + .Const(_SC("RCVTIMEO"), int32_t(ZMQ_RCVTIMEO)) + .Const(_SC("SNDTIMEO"), int32_t(ZMQ_SNDTIMEO)) + .Const(_SC("LAST_ENDPOINT"), int32_t(ZMQ_LAST_ENDPOINT)) + .Const(_SC("ROUTER_MANDATORY"), int32_t(ZMQ_ROUTER_MANDATORY)) + .Const(_SC("TCP_KEEPALIVE"), int32_t(ZMQ_TCP_KEEPALIVE)) + .Const(_SC("TCP_KEEPALIVE_CNT"), int32_t(ZMQ_TCP_KEEPALIVE_CNT)) + .Const(_SC("TCP_KEEPALIVE_IDLE"), int32_t(ZMQ_TCP_KEEPALIVE_IDLE)) + .Const(_SC("TCP_KEEPALIVE_INTVL"), int32_t(ZMQ_TCP_KEEPALIVE_INTVL)) + .Const(_SC("IMMEDIATE"), int32_t(ZMQ_IMMEDIATE)) + .Const(_SC("XPUB_VERBOSE"), int32_t(ZMQ_XPUB_VERBOSE)) + .Const(_SC("ROUTER_RAW"), int32_t(ZMQ_ROUTER_RAW)) + .Const(_SC("IPV6"), int32_t(ZMQ_IPV6)) + .Const(_SC("MECHANISM"), int32_t(ZMQ_MECHANISM)) + .Const(_SC("PLAIN_SERVER"), int32_t(ZMQ_PLAIN_SERVER)) + .Const(_SC("PLAIN_USERNAME"), int32_t(ZMQ_PLAIN_USERNAME)) + .Const(_SC("PLAIN_PASSWORD"), int32_t(ZMQ_PLAIN_PASSWORD)) + .Const(_SC("CURVE_SERVER"), int32_t(ZMQ_CURVE_SERVER)) + .Const(_SC("CURVE_PUBLICKEY"), int32_t(ZMQ_CURVE_PUBLICKEY)) + .Const(_SC("CURVE_SECRETKEY"), int32_t(ZMQ_CURVE_SECRETKEY)) + .Const(_SC("CURVE_SERVERKEY"), int32_t(ZMQ_CURVE_SERVERKEY)) + .Const(_SC("PROBE_ROUTER"), int32_t(ZMQ_PROBE_ROUTER)) + .Const(_SC("REQ_CORRELATE"), int32_t(ZMQ_REQ_CORRELATE)) + .Const(_SC("REQ_RELAXED"), int32_t(ZMQ_REQ_RELAXED)) + .Const(_SC("CONFLATE"), int32_t(ZMQ_CONFLATE)) + .Const(_SC("ZAP_DOMAIN"), int32_t(ZMQ_ZAP_DOMAIN)) + .Const(_SC("ROUTER_HANDOVER"), int32_t(ZMQ_ROUTER_HANDOVER)) + .Const(_SC("TOS"), int32_t(ZMQ_TOS)) + .Const(_SC("CONNECT_ROUTING_ID"), int32_t(ZMQ_CONNECT_ROUTING_ID)) + .Const(_SC("GSSAPI_SERVER"), int32_t(ZMQ_GSSAPI_SERVER)) + .Const(_SC("GSSAPI_PRINCIPAL"), int32_t(ZMQ_GSSAPI_PRINCIPAL)) + .Const(_SC("GSSAPI_SERVICE_PRINCIPAL"), int32_t(ZMQ_GSSAPI_SERVICE_PRINCIPAL)) + .Const(_SC("GSSAPI_PLAINTEXT"), int32_t(ZMQ_GSSAPI_PLAINTEXT)) + .Const(_SC("HANDSHAKE_IVL"), int32_t(ZMQ_HANDSHAKE_IVL)) + .Const(_SC("SOCKS_PROXY"), int32_t(ZMQ_SOCKS_PROXY)) + .Const(_SC("XPUB_NODROP"), int32_t(ZMQ_XPUB_NODROP)) + .Const(_SC("BLOCKY"), int32_t(ZMQ_BLOCKY)) + .Const(_SC("XPUB_MANUAL"), int32_t(ZMQ_XPUB_MANUAL)) + .Const(_SC("XPUB_WELCOME_MSG"), int32_t(ZMQ_XPUB_WELCOME_MSG)) + .Const(_SC("STREAM_NOTIFY"), int32_t(ZMQ_STREAM_NOTIFY)) + .Const(_SC("INVERT_MATCHING"), int32_t(ZMQ_INVERT_MATCHING)) + .Const(_SC("HEARTBEAT_IVL"), int32_t(ZMQ_HEARTBEAT_IVL)) + .Const(_SC("HEARTBEAT_TTL"), int32_t(ZMQ_HEARTBEAT_TTL)) + .Const(_SC("HEARTBEAT_TIMEOUT"), int32_t(ZMQ_HEARTBEAT_TIMEOUT)) + .Const(_SC("XPUB_VERBOSER"), int32_t(ZMQ_XPUB_VERBOSER)) + .Const(_SC("CONNECT_TIMEOUT"), int32_t(ZMQ_CONNECT_TIMEOUT)) + .Const(_SC("TCP_MAXRT"), int32_t(ZMQ_TCP_MAXRT)) + .Const(_SC("THREAD_SAFE"), int32_t(ZMQ_THREAD_SAFE)) + .Const(_SC("MULTICAST_MAXTPDU"), int32_t(ZMQ_MULTICAST_MAXTPDU)) + .Const(_SC("VMCI_BUFFER_SIZE"), int32_t(ZMQ_VMCI_BUFFER_SIZE)) + .Const(_SC("VMCI_BUFFER_MIN_SIZE"), int32_t(ZMQ_VMCI_BUFFER_MIN_SIZE)) + .Const(_SC("VMCI_BUFFER_MAX_SIZE"), int32_t(ZMQ_VMCI_BUFFER_MAX_SIZE)) + .Const(_SC("VMCI_CONNECT_TIMEOUT"), int32_t(ZMQ_VMCI_CONNECT_TIMEOUT)) + .Const(_SC("USE_FD"), int32_t(ZMQ_USE_FD)) + .Const(_SC("GSSAPI_PRINCIPAL_NAMETYPE"), int32_t(ZMQ_GSSAPI_PRINCIPAL_NAMETYPE)) + .Const(_SC("GSSAPI_SERVICE_PRINCIPAL_NAMETYPE"), int32_t(ZMQ_GSSAPI_SERVICE_PRINCIPAL_NAMETYPE)) + .Const(_SC("BINDTODEVICE"), int32_t(ZMQ_BINDTODEVICE)) + /* Message options */ + .Const(_SC("MORE"), int32_t(ZMQ_MORE)) + .Const(_SC("SHARED"), int32_t(ZMQ_SHARED)) + /* Send/recv options. */ + .Const(_SC("DONTWAIT"), int32_t(ZMQ_DONTWAIT)) + .Const(_SC("SNDMORE"), int32_t(ZMQ_SNDMORE)) + .Const(_SC("NULL"), int32_t(ZMQ_NULL)) + .Const(_SC("PLAIN"), int32_t(ZMQ_PLAIN)) + /* Security mechanisms */ + //.Const(_SC("CURVE"), int32_t(ZMQ_CURVE)) + //.Const(_SC("GSSAPI"), int32_t(ZMQ_GSSAPI)) + /* RADIO-DISH protocol */ + //.Const(_SC("GROUP_MAX_LENGTH"), int32_t(ZMQ_GROUP_MAX_LENGTH)) + /* GSSAPI principal name types */ + //.Const(_SC("GSSAPI_NT_HOSTBASED"), int32_t(ZMQ_GSSAPI_NT_HOSTBASED)) + //.Const(_SC("GSSAPI_NT_USER_NAME"), int32_t(ZMQ_GSSAPI_NT_USER_NAME)) + //.Const(_SC("GSSAPI_NT_KRB5_PRINCIPAL"), int32_t(ZMQ_GSSAPI_NT_KRB5_PRINCIPAL)) + /* Socket transport events (TCP, IPC and TIPC only) */ + //.Const(_SC("EVENT_CONNECTED"), int32_t(ZMQ_EVENT_CONNECTED)) + //.Const(_SC("EVENT_CONNECT_DELAYED"), int32_t(ZMQ_EVENT_CONNECT_DELAYED)) + //.Const(_SC("EVENT_CONNECT_RETRIED"), int32_t(ZMQ_EVENT_CONNECT_RETRIED)) + //.Const(_SC("EVENT_LISTENING"), int32_t(ZMQ_EVENT_LISTENING)) + //.Const(_SC("EVENT_BIND_FAILED"), int32_t(ZMQ_EVENT_BIND_FAILED)) + //.Const(_SC("EVENT_ACCEPTED"), int32_t(ZMQ_EVENT_ACCEPTED)) + //.Const(_SC("EVENT_ACCEPT_FAILED"), int32_t(ZMQ_EVENT_ACCEPT_FAILED)) + //.Const(_SC("EVENT_CLOSED"), int32_t(ZMQ_EVENT_CLOSED)) + //.Const(_SC("EVENT_CLOSE_FAILED"), int32_t(ZMQ_EVENT_CLOSE_FAILED)) + //.Const(_SC("EVENT_DISCONNECTED"), int32_t(ZMQ_EVENT_DISCONNECTED)) + //.Const(_SC("EVENT_MONITOR_STOPPED"), int32_t(ZMQ_EVENT_MONITOR_STOPPED)) + //.Const(_SC("EVENT_ALL"), int32_t(ZMQ_EVENT_ALL)) + //.Const(_SC("EVENT_HANDSHAKE_FAILED_NO_DETAIL"), int32_t(ZMQ_EVENT_HANDSHAKE_FAILED_NO_DETAIL)) + //.Const(_SC("EVENT_HANDSHAKE_SUCCEEDED"), int32_t(ZMQ_EVENT_HANDSHAKE_SUCCEEDED)) + //.Const(_SC("EVENT_HANDSHAKE_FAILED_PROTOCOL"), int32_t(ZMQ_EVENT_HANDSHAKE_FAILED_PROTOCOL)) + //.Const(_SC("EVENT_HANDSHAKE_FAILED_AUTH"), int32_t(ZMQ_EVENT_HANDSHAKE_FAILED_AUTH)) + //.Const(_SC("PROTOCOL_ERROR_ZMTP_UNSPECIFIED"), int32_t(ZMQ_PROTOCOL_ERROR_ZMTP_UNSPECIFIED)) + //.Const(_SC("PROTOCOL_ERROR_ZMTP_UNEXPECTED_COMMAND"), int32_t(ZMQ_PROTOCOL_ERROR_ZMTP_UNEXPECTED_COMMAND)) + //.Const(_SC("PROTOCOL_ERROR_ZMTP_INVALID_SEQUENCE"), int32_t(ZMQ_PROTOCOL_ERROR_ZMTP_INVALID_SEQUENCE)) + //.Const(_SC("PROTOCOL_ERROR_ZMTP_KEY_EXCHANGE"), int32_t(ZMQ_PROTOCOL_ERROR_ZMTP_KEY_EXCHANGE)) + //.Const(_SC("PROTOCOL_ERROR_ZMTP_MALFORMED_COMMAND_UNSPECIFIED"), int32_t(ZMQ_PROTOCOL_ERROR_ZMTP_MALFORMED_COMMAND_UNSPECIFIED)) + //.Const(_SC("PROTOCOL_ERROR_ZMTP_MALFORMED_COMMAND_MESSAGE"), int32_t(ZMQ_PROTOCOL_ERROR_ZMTP_MALFORMED_COMMAND_MESSAGE)) + //.Const(_SC("PROTOCOL_ERROR_ZMTP_MALFORMED_COMMAND_HELLO"), int32_t(ZMQ_PROTOCOL_ERROR_ZMTP_MALFORMED_COMMAND_HELLO)) + //.Const(_SC("PROTOCOL_ERROR_ZMTP_MALFORMED_COMMAND_INITIATE"), int32_t(ZMQ_PROTOCOL_ERROR_ZMTP_MALFORMED_COMMAND_INITIATE)) + //.Const(_SC("PROTOCOL_ERROR_ZMTP_MALFORMED_COMMAND_ERROR"), int32_t(ZMQ_PROTOCOL_ERROR_ZMTP_MALFORMED_COMMAND_ERROR)) + //.Const(_SC("PROTOCOL_ERROR_ZMTP_MALFORMED_COMMAND_READY"), int32_t(ZMQ_PROTOCOL_ERROR_ZMTP_MALFORMED_COMMAND_READY)) + //.Const(_SC("PROTOCOL_ERROR_ZMTP_MALFORMED_COMMAND_WELCOME"), int32_t(ZMQ_PROTOCOL_ERROR_ZMTP_MALFORMED_COMMAND_WELCOME)) + //.Const(_SC("PROTOCOL_ERROR_ZMTP_INVALID_METADATA"), int32_t(ZMQ_PROTOCOL_ERROR_ZMTP_INVALID_METADATA)) + //.Const(_SC("PROTOCOL_ERROR_ZMTP_CRYPTOGRAPHIC"), int32_t(ZMQ_PROTOCOL_ERROR_ZMTP_CRYPTOGRAPHIC)) + //.Const(_SC("PROTOCOL_ERROR_ZMTP_MECHANISM_MISMATCH"), int32_t(ZMQ_PROTOCOL_ERROR_ZMTP_MECHANISM_MISMATCH)) + //.Const(_SC("PROTOCOL_ERROR_ZAP_UNSPECIFIED"), int32_t(ZMQ_PROTOCOL_ERROR_ZAP_UNSPECIFIED)) + //.Const(_SC("PROTOCOL_ERROR_ZAP_MALFORMED_REPLY"), int32_t(ZMQ_PROTOCOL_ERROR_ZAP_MALFORMED_REPLY)) + //.Const(_SC("PROTOCOL_ERROR_ZAP_BAD_REQUEST_ID"), int32_t(ZMQ_PROTOCOL_ERROR_ZAP_BAD_REQUEST_ID)) + //.Const(_SC("PROTOCOL_ERROR_ZAP_BAD_VERSION"), int32_t(ZMQ_PROTOCOL_ERROR_ZAP_BAD_VERSION)) + //.Const(_SC("PROTOCOL_ERROR_ZAP_INVALID_STATUS_CODE"), int32_t(ZMQ_PROTOCOL_ERROR_ZAP_INVALID_STATUS_CODE)) + //.Const(_SC("PROTOCOL_ERROR_ZAP_INVALID_METADATA"), int32_t(ZMQ_PROTOCOL_ERROR_ZAP_INVALID_METADATA)) + //.Const(_SC("PROTOCOL_ERROR_WS_UNSPECIFIED"), int32_t(ZMQ_PROTOCOL_ERROR_WS_UNSPECIFIED)) + ); +} + +} // Namespace:: SqMod diff --git a/module/Library/ZMQ.hpp b/module/Library/ZMQ.hpp new file mode 100644 index 00000000..d4360558 --- /dev/null +++ b/module/Library/ZMQ.hpp @@ -0,0 +1,1078 @@ +#pragma once + +// ------------------------------------------------------------------------------------------------ +#include "Core/Utility.hpp" + +// ------------------------------------------------------------------------------------------------ +#include +#include +#include +#include +#include +#include +#include + +// ------------------------------------------------------------------------------------------------ +#include +#include + +// ------------------------------------------------------------------------------------------------ +namespace SqMod { + +// ------------------------------------------------------------------------------------------------ +struct ZSkt; +struct ZMsg; +struct ZCtx; +struct ZSocket; +struct ZMessage; +struct ZContext; + +/* ------------------------------------------------------------------------------------------------ + * Given as a function pointer to free memory using std::free(data). +*/ +inline void ZmqFreeSTD(void * data, void *) +{ + std::free(data); +} + +/* ------------------------------------------------------------------------------------------------ + * Given as a function pointer to free memory using delete data. +*/ +template < class T > inline void ZmqFreeDelete(void * data, void *) +{ + // If this throws an exception we may as well just be fked. But very (VERY!) low chances. + delete static_cast< T * >(data); +} + +/* ------------------------------------------------------------------------------------------------ + * Given as a function pointer to free memory using delete[] data. +*/ +template < class T > inline void ZmqFreeDeleteArray(void * data, void *) +{ + // If this throws an exception we may as well just be fked. But very (VERY!) low chances. + delete[] static_cast< T * >(data); +} + +/* ------------------------------------------------------------------------------------------------ + * Allocate raw memory for a string, fill it with data from a StackStrF instance and return it. +*/ +inline void * ZmqDataFromStackStrF(StackStrF & data) +{ + if (data.mLen) + { + // Allocate the string memory + auto * mem = new SQChar[static_cast< size_t >(data.mLen)]; + // Why not + assert(mem); + // Copy the string in the memory buffer + std::memcpy(mem, data.mPtr, static_cast< size_t >(data.mLen)); + /* normally you'd have to do static_cast< size_t >(data.mLen) * sizeof(SQChar) */ + /* but this SQChar is required to be 1 byte so we don't bother with it */ + // Yield ownership of the memory + return mem; + } + // Failed! + return nullptr; +} + +/* ------------------------------------------------------------------------------------------------ + * Core implementation and management for a ZMQ context. +*/ +struct ZCtx +{ + /* -------------------------------------------------------------------------------------------- + * Smart pointers to this type. Helper typedefs. + */ + using Ptr = std::shared_ptr< ZCtx >; + using Ref = std::weak_ptr< ZCtx >; + + /* -------------------------------------------------------------------------------------------- + * Context pointer. + */ + void * mPtr; + + /* -------------------------------------------------------------------------------------------- + * Default constructor. + */ + ZCtx() + : mPtr(zmq_ctx_new()) + { + if (!mPtr) + { + STHROWF("Unable to initialize context: %s", zmq_strerror(errno)); + } + } + + /* -------------------------------------------------------------------------------------------- + * Base constructor. + */ + explicit ZCtx(void * ptr) + : mPtr(ptr) + { + if (!mPtr) + { + STHROWF("Invalid context"); + } + } + + /* -------------------------------------------------------------------------------------------- + * Copy constructor (disabled). + */ + ZCtx(const ZCtx &) = delete; + + /* -------------------------------------------------------------------------------------------- + * Move constructor (disabled). + */ + ZCtx(ZCtx &&) noexcept = delete; + + /* -------------------------------------------------------------------------------------------- + * Destructor. + */ + ~ZCtx() + { + if (mPtr) + { + int r = zmq_ctx_term(mPtr); + // Just in case + if (r != 0) + { + LogFtl("Context failed to terminate properly: [%d], %s", r, zmq_strerror(r)); + } + } + } + + /* -------------------------------------------------------------------------------------------- + * Assignment operator (disabled). + */ + ZCtx & operator = (const ZCtx &) = delete; + + /* -------------------------------------------------------------------------------------------- + * Move assignment (disabled). + */ + ZCtx & operator = (ZCtx &&) noexcept = delete; + + /* -------------------------------------------------------------------------------------------- + * Implicit conversion to boolean operator. + */ + operator bool () const noexcept { return static_cast< bool >(mPtr); } // NOLINT(google-explicit-constructor) + + /* -------------------------------------------------------------------------------------------- + * Implicit conversion to context pointer (void *) operator. + */ + operator void * () const noexcept { return mPtr; } // NOLINT(google-explicit-constructor) +}; + +/* ------------------------------------------------------------------------------------------------ + * Core implementation and management for a ZMQ message. +*/ +struct ZMsg +{ + /* -------------------------------------------------------------------------------------------- + * Smart pointers to this type. Helper typedefs. + */ + using Ptr = std::shared_ptr< ZMsg >; + using Ref = std::weak_ptr< ZMsg >; + + /* -------------------------------------------------------------------------------------------- + * The underlying message. + */ + std::unique_ptr< zmq_msg_t > mMsg; + + /* -------------------------------------------------------------------------------------------- + * Default constructor. + */ + ZMsg() + : mMsg(std::make_unique< zmq_msg_t >()) + { + int r = zmq_msg_init(mMsg.get()); + // Validate result + if (r != 0) + { + STHROWF("Unable to initialize message: [%d] %s", r, zmq_strerror(r)); + } + } + + /* -------------------------------------------------------------------------------------------- + * Explicit message size constructor. + */ + explicit ZMsg(SQInteger size) + : mMsg(std::make_unique< zmq_msg_t >()) + { + int r = zmq_msg_init_size(mMsg.get(), ClampL< SQInteger, size_t >(size)); + // Validate result + if (r != 0) + { + STHROWF("Unable to initialize message: [%d] %s", r, zmq_strerror(r)); + } + } + + /* -------------------------------------------------------------------------------------------- + * Explicit message data and size constructor. + */ + ZMsg(void * data, SQInteger size, zmq_free_fn * ffn, void * hint = nullptr) + : mMsg(std::make_unique< zmq_msg_t >()) + { + // Make sure there's data if required + if (size > 0 && !data) + { + STHROWF("Invalid message data"); + } + // Now the message can be initialized + int r = zmq_msg_init_data(mMsg.get(), data, ClampL< SQInteger, size_t >(size), ffn, hint); + // Validate result + if (r != 0) + { + STHROWF("Unable to initialize message: [%d] %s", r, zmq_strerror(r)); + } + } + + /* -------------------------------------------------------------------------------------------- + * Copy constructor. + */ + ZMsg(const ZMsg & o) + : mMsg(std::make_unique< zmq_msg_t >()) + { + int r = zmq_msg_init(mMsg.get()); + // Validate result + if (r != 0) + { + LogFtl("Unable to initialize message: [%d] %s", r, zmq_strerror(r)); + } + r = zmq_msg_copy(mMsg.get(), o.mMsg.get()); + // Validate result + if (r != 0) + { + LogFtl("Unable to copy message: [%d] %s", r, zmq_strerror(r)); + } + } + + /* -------------------------------------------------------------------------------------------- + * Move constructor. + */ + ZMsg(ZMsg && o) noexcept = default; + + /* -------------------------------------------------------------------------------------------- + * Destructor. + */ + ~ZMsg() + { + if (mMsg) + { + zmq_msg_close(mMsg.get()); + // We don't really care if the above failed (i.e. returned EFAULT) + // We probably did it already before but we need to be sure + // This is something I can live with in this under the circumstances + } + } + + /* -------------------------------------------------------------------------------------------- + * Assignment operator. + */ + ZMsg & operator = (const ZMsg & o) + { + // Prevent self assignment + if (this != &o) + { + // We need a message, even if empty + if (!mMsg) + { + int r = zmq_msg_init(mMsg.get()); + // Validate result + if (r != 0) + { + LogFtl("Unable to initialize message: [%d] %s", r, zmq_strerror(r)); + } + } + // Do we have a message? + if (mMsg) + { + int r = zmq_msg_copy(mMsg.get(), o.mMsg.get()); + // Validate result + if (r != 0) + { + LogFtl("Unable to copy message: [%d] %s", r, zmq_strerror(r)); + } + } + } + return *this; + } + + /* -------------------------------------------------------------------------------------------- + * Move assignment. + */ + ZMsg & operator = (ZMsg && o) noexcept + { + // Prevent self assignment + if (this != &o) + { + // Close current message, if any + if (mMsg) + { + zmq_msg_close(mMsg.get()); + } + // Now the message can be moved + mMsg = std::move(o.mMsg); + } + return *this; + } + + /* -------------------------------------------------------------------------------------------- + * Implicit conversion to const message pointer (const zmq_msg_t *) operator. + */ + operator zmq_msg_t * () const noexcept { return mMsg.get(); } // NOLINT(google-explicit-constructor) +}; + +/* ------------------------------------------------------------------------------------------------ + * Core implementation and management for a ZMQ socket. +*/ +struct ZSkt : SqChainedInstances< ZSkt > +{ + /* -------------------------------------------------------------------------------------------- + * Smart pointers to this type. Helper typedefs. + */ + using Ptr = std::shared_ptr< ZSkt >; + using Ref = std::weak_ptr< ZSkt >; + + /* -------------------------------------------------------------------------------------------- + * List of messages. + */ + using List = std::vector< ZMsg >; + + /* -------------------------------------------------------------------------------------------- + * Message list item. + */ + using ListItem = std::unique_ptr< List >; + + /* -------------------------------------------------------------------------------------------- + * Message queue type. + */ + using Queue = moodycamel::ConcurrentQueue< ZMsg >; + + /* -------------------------------------------------------------------------------------------- + * Message list queue type. + */ + using ListQueue = moodycamel::ConcurrentQueue< ListItem >; + + /* -------------------------------------------------------------------------------------------- + * Context pointer. + */ + void * mPtr; + + /* -------------------------------------------------------------------------------------------- + * Socket status. + */ + int mStatus; + + /* -------------------------------------------------------------------------------------------- + * Synchronization mutex. + */ + std::mutex mMtx; + + /* -------------------------------------------------------------------------------------------- + * Messages received from the socket. + */ + Queue mOutputQueue; + + /* -------------------------------------------------------------------------------------------- + * Messages to be sent through the socket. + */ + Queue mInputQueue; + + /* -------------------------------------------------------------------------------------------- + * Multi-part messages to be sent through the socket. + */ + ListQueue mInputListQueue; + + /* -------------------------------------------------------------------------------------------- + * Message received callback. + */ + Function mOnData; + + /* -------------------------------------------------------------------------------------------- + * Processing thread. + */ + std::thread mThread; + + /* -------------------------------------------------------------------------------------------- + * Base constructor. + */ + ZSkt(void * ctx, int type) + : SqChainedInstances< ZSkt >() + /* normally we'd validate ctx. but i have a feeling we'd be fine here */ + , mPtr(zmq_socket(ctx, type)), mStatus(0), mMtx() + , mOutputQueue(4096), mInputQueue(4096), mInputListQueue(1024) + , mOnData(), mThread() + { + if (!mPtr) + { + STHROWF("Unable to initialize socket: %s", zmq_strerror(errno)); + } + // Remember this instance + ChainInstance(); + } + + /* -------------------------------------------------------------------------------------------- + * Copy constructor (disabled). + */ + ZSkt(const ZSkt &) = delete; + + /* -------------------------------------------------------------------------------------------- + * Move constructor (disabled). + */ + ZSkt(ZSkt &&) noexcept = delete; + + /* -------------------------------------------------------------------------------------------- + * Destructor. + */ + ~ZSkt() + { + if (mPtr) + { + int r = zmq_close(mPtr); + // Just in case + if (r != 0) + { + LogFtl("Socket failed to close properly: [%d], %s", r, zmq_strerror(r)); + } + } + // Forget about this instance + UnchainInstance(); + } + + /* -------------------------------------------------------------------------------------------- + * Assignment operator (disabled). + */ + ZSkt & operator = (const ZSkt &) = delete; + + /* -------------------------------------------------------------------------------------------- + * Move assignment (disabled). + */ + ZSkt & operator = (ZSkt &&) noexcept = delete; + + /* -------------------------------------------------------------------------------------------- + * Implicit conversion to boolean operator. + */ + operator bool () const noexcept { return static_cast< bool >(mPtr); } // NOLINT(google-explicit-constructor) + + /* -------------------------------------------------------------------------------------------- + * Implicit conversion to socket pointer (void *) operator. + */ + operator void * () const noexcept { return mPtr; } // NOLINT(google-explicit-constructor) + + /* -------------------------------------------------------------------------------------------- + * Internal processing thread. + * NOTE: Messages are being sent in whatever order we can. + * Don't expect them be in the order you sent or receive them. + * That's the cost of simplicity. And something I can live with under the circumstances. + */ + void Proc() + { + + while (mStatus > 0) + { + using namespace std::chrono_literals; + // Wait a bit before each iteration to not exhaust resources + std::this_thread::sleep_for(50ms); + // Acquire exclusive access to the socket + std::lock_guard< std::mutex > guard(mMtx); + // Perform tasks + Recv(); + Send(); + SendMore(); + } + } + + /* -------------------------------------------------------------------------------------------- + * Flush messages from the queue to the script. + */ + void Flush(HSQUIRRELVM vm); + + /* -------------------------------------------------------------------------------------------- + * Stop sockets and prepare for a shutdown. + */ + void Close() + { + // Is the processing thread running? + if (mThread.joinable()) + { + // Acquire exclusive access + mMtx.lock(); + // Stop the loop + mStatus = 0; + // Yield exclusive access + mMtx.unlock(); + // Wait for the thread + mThread.join(); + } + // Make sure it wasn't closed already + if (mPtr != nullptr) + { + // Now close the socket + int r = zmq_close(mPtr); + // Forget about this socket + mPtr = nullptr; + // Validate result + if (r != 0) + { + STHROWF("Unable to close socket: [%d] %s", r, zmq_strerror(r)); + } + } + } + +protected: + + /* -------------------------------------------------------------------------------------------- + * Receive one message from the socket. + */ + void Recv() + { + // Need someone to receive the message + ZMsg msg; + // Ask for a message, if any + int r = zmq_msg_recv(msg, mPtr, ZMQ_DONTWAIT); + // Did we have a message? + if (r >= 0) + { + mOutputQueue.enqueue(std::move(msg)); // Put it in the queue + } + } + + /* -------------------------------------------------------------------------------------------- + * Send one message to the socket. + */ + bool Send() + { + // Need someone to receive the message + ZMsg msg; + // Try to get a message from the queue + if (mInputQueue.try_dequeue(msg)) + { + // Attempt to send the message + int r = zmq_msg_send(msg, mPtr, ZMQ_DONTWAIT); + // Could we send what the message had? + if (r != zmq_msg_size(msg)) + { + LogErr("Unable to send data to socket: [%d], %s", r, zmq_strerror(r)); + } + // One item was found in the queue + return true; + } + else + { + return false; // No item in the queue + } + } + + /* -------------------------------------------------------------------------------------------- + * Send a multi-part message to the socket. + */ + bool SendMore() + { + ListItem mp_msg; + // Try to get a multi-part message from the queue + if (mInputListQueue.try_dequeue(mp_msg)) + { + // Need someone to receive the message + ZMsg msg; + // Send all message parts + for (size_t i = 0, n = mp_msg->size(); i < n; ++i) + { + // Attempt to send the message + int r = zmq_msg_send((*mp_msg)[i], mPtr, (i + 1) == n ? ZMQ_DONTWAIT : ZMQ_SNDMORE); + // Could we send what the message had? + if (r != zmq_msg_size(msg)) + { + LogErr("Unable to send multi-part data to socket: [%d], %s", r, zmq_strerror(r)); + } + } + // One item was found in the queue + return true; + } + else + { + return false; // No item in the queue + } + } +}; + +/* ------------------------------------------------------------------------------------------------ + * Interface for ZMQ contexts. +*/ +struct ZContext +{ + /* -------------------------------------------------------------------------------------------- + * Default constructor. + */ + ZContext() + : m_Ptr(std::make_shared< ZCtx >()) + { + } + + /* -------------------------------------------------------------------------------------------- + * Pointer constructor. + */ + explicit ZContext(ZCtx::Ptr ptr) + : m_Ptr(std::move(ptr)) + { + } + + /* -------------------------------------------------------------------------------------------- + * Copy constructor. + */ + ZContext(const ZContext &) = default; + + /* -------------------------------------------------------------------------------------------- + * Move constructor. + */ + ZContext(ZContext &&) noexcept = default; + + /* -------------------------------------------------------------------------------------------- + * Destructor. + */ + ~ZContext() = default; + + /* -------------------------------------------------------------------------------------------- + * Assignment operator. + */ + ZContext & operator = (const ZContext &) = default; + + /* -------------------------------------------------------------------------------------------- + * Move assignment. + */ + ZContext & operator = (ZContext &&) noexcept = default; + + /* -------------------------------------------------------------------------------------------- + * Make sure a context instance is referenced. + */ + void Validate() const + { + if (!m_Ptr) + { + STHROWF("Invalid context instance"); + } + } + + /* -------------------------------------------------------------------------------------------- + * Make sure a context instance is referenced and return the context. + */ + SQMOD_NODISCARD ZCtx & Valid() { Validate(); return *m_Ptr; } + + /* -------------------------------------------------------------------------------------------- + * Make sure a context instance is referenced and return the context. + */ + SQMOD_NODISCARD const ZCtx & Valid() const { Validate(); return *m_Ptr; } + + /* -------------------------------------------------------------------------------------------- + * Make sure a context instance is referenced and return the reference. + */ + SQMOD_NODISCARD ZCtx::Ptr & ValidRef() { Validate(); return m_Ptr; } + + /* -------------------------------------------------------------------------------------------- + * Make sure a context instance is referenced and return the reference. + */ + SQMOD_NODISCARD const ZCtx::Ptr & ValidRef() const { Validate(); return m_Ptr; } + + /* -------------------------------------------------------------------------------------------- + * Check if a context instance is referenced. + */ + SQMOD_NODISCARD bool IsNull() const + { + return static_cast< bool >(m_Ptr); + } + + /* -------------------------------------------------------------------------------------------- + * Retrieve the value of an option. + */ + SQMOD_NODISCARD int Get(int opt) const + { + return zmq_ctx_get(Valid(), opt); + } + + /* -------------------------------------------------------------------------------------------- + * Modify the value of an option. + */ + void Set(int opt, int value) + { + int r = zmq_ctx_set(Valid(), opt, value); + // Validate result + if (r != 0) + { + STHROWF("Unable to set context option: [%d] %s", r, zmq_strerror(r)); + } + } + + /* -------------------------------------------------------------------------------------------- + * Modify the value of an option. + */ + void Shutdown() const + { + int r = zmq_ctx_shutdown(Valid()); + // Validate result + if (r != 0) + { + STHROWF("Unable to shutdown context: %s", zmq_strerror(r)); + } + } + + /* -------------------------------------------------------------------------------------------- + * Helper function to create sockets. + */ + SQMOD_NODISCARD LightObj Socket(int type) const; + +private: + + /* -------------------------------------------------------------------------------------------- + * Pointer to the interfaced context. + */ + ZCtx::Ptr m_Ptr; +}; + +/* ------------------------------------------------------------------------------------------------ + * Interface for ZMQ messages. +*/ +struct ZMessage +{ + /* -------------------------------------------------------------------------------------------- + * Default constructor. + */ + ZMessage() + : m_Ptr(std::make_shared< ZMsg >()) + { + } + + /* -------------------------------------------------------------------------------------------- + * Explicit message size constructor. + */ + explicit ZMessage(SQInteger size) + : m_Ptr(std::make_shared< ZMsg >(size)) + { + } + + /* -------------------------------------------------------------------------------------------- + * Explicit message data and size constructor. + */ + ZMessage(SQInteger size, StackStrF & data) + : m_Ptr(std::make_shared< ZMsg >(size < 0 ? data.mLen : size)) + { + // Make sure the requested size is within range + if (size < 0 || size > data.mLen) + { + size = data.mLen; + } + // Copy the string in the memory buffer + std::memcpy(zmq_msg_data(*m_Ptr), data.mPtr, static_cast< size_t >(size)); + /* normally you'd have to do static_cast< size_t >(data.mLen) * sizeof(SQChar) */ + /* but this SQChar is required to be 1 byte so we don't bother with it */ + } + + /* -------------------------------------------------------------------------------------------- + * Pointer constructor. + */ + explicit ZMessage(ZMsg::Ptr ptr) + : m_Ptr(std::move(ptr)) + { + } + + /* -------------------------------------------------------------------------------------------- + * Copy constructor. + */ + ZMessage(const ZMessage &) = default; + + /* -------------------------------------------------------------------------------------------- + * Move constructor. + */ + ZMessage(ZMessage &&) noexcept = default; + + /* -------------------------------------------------------------------------------------------- + * Destructor. + */ + ~ZMessage() = default; + + /* -------------------------------------------------------------------------------------------- + * Assignment operator. + */ + ZMessage & operator = (const ZMessage &) = default; + + /* -------------------------------------------------------------------------------------------- + * Move assignment. + */ + ZMessage & operator = (ZMessage &&) noexcept = default; + + /* -------------------------------------------------------------------------------------------- + * Make sure a message instance is referenced. + */ + void Validate() const + { + if (!m_Ptr) + { + STHROWF("Invalid message instance"); + } + } + + /* -------------------------------------------------------------------------------------------- + * Make sure a message instance is referenced and return the message. + */ + SQMOD_NODISCARD ZMsg & Valid() { Validate(); return *m_Ptr; } + + /* -------------------------------------------------------------------------------------------- + * Make sure a message instance is referenced and return the message. + */ + SQMOD_NODISCARD const ZMsg & Valid() const { Validate(); return *m_Ptr; } + + /* -------------------------------------------------------------------------------------------- + * Make sure a message instance is referenced and return the reference. + */ + SQMOD_NODISCARD ZMsg::Ptr & ValidRef() { Validate(); return m_Ptr; } + + /* -------------------------------------------------------------------------------------------- + * Make sure a message instance is referenced and return the reference. + */ + SQMOD_NODISCARD const ZMsg::Ptr & ValidRef() const { Validate(); return m_Ptr; } + + /* -------------------------------------------------------------------------------------------- + * Check if a context instance is referenced. + */ + SQMOD_NODISCARD bool IsNull() const + { + return static_cast< bool >(m_Ptr); + } + + /* -------------------------------------------------------------------------------------------- + * Retrieve the value of a property. + */ + SQMOD_NODISCARD int Get(int opt) const + { + return zmq_msg_get(Valid(), opt); + } + + /* -------------------------------------------------------------------------------------------- + * Modify the value of an property. + */ + void Set(int prop, int value) + { + int r = zmq_msg_set(Valid(), prop, value); + // Validate result + if (r != 0) + { + STHROWF("Unable to set context option: [%d] %s", r, zmq_strerror(r)); + } + } + + /* -------------------------------------------------------------------------------------------- + * Retrieve the value of a meta-data property. + */ + SQMOD_NODISCARD const SQChar * Meta(StackStrF & prop) const + { + return zmq_msg_gets (Valid(), prop.mPtr); + } + + /* -------------------------------------------------------------------------------------------- + * Indicate if there are more message parts to receive. + */ + SQMOD_NODISCARD bool More() const + { + return static_cast< bool >(zmq_msg_more(Valid())); + } + + /* -------------------------------------------------------------------------------------------- + * Retrieve message content size in bytes. + */ + SQMOD_NODISCARD SQInteger GetSize() const + { + return static_cast< SQInteger >(zmq_msg_size(Valid())); + } + + /* -------------------------------------------------------------------------------------------- + * Retrieve the message data as a string. + */ + SQMOD_NODISCARD LightObj ToString() const + { + return LightObj(static_cast< const SQChar * >(zmq_msg_data(Valid())), GetSize()); + } + +private: + + /* -------------------------------------------------------------------------------------------- + * Pointer to the interfaced message. + */ + ZMsg::Ptr m_Ptr; +}; + +/* ------------------------------------------------------------------------------------------------ + * Interface for ZMQ sockets. +*/ +struct ZSocket +{ + /* -------------------------------------------------------------------------------------------- + * Default constructor. + */ + ZSocket(const ZContext & ctx, int type) + : m_Ptr(std::make_shared< ZSkt >(ctx.Valid(), type)) + { + } + + /* -------------------------------------------------------------------------------------------- + * Pointer constructor. + */ + explicit ZSocket(ZSkt::Ptr ptr) + : m_Ptr(std::move(ptr)) + { + } + + /* -------------------------------------------------------------------------------------------- + * Copy constructor. + */ + ZSocket(const ZSocket &) = default; + + /* -------------------------------------------------------------------------------------------- + * Move constructor. + */ + ZSocket(ZSocket &&) noexcept = default; + + /* -------------------------------------------------------------------------------------------- + * Destructor. + */ + ~ZSocket() + { + Close(); + } + + /* -------------------------------------------------------------------------------------------- + * Assignment operator. + */ + ZSocket & operator = (const ZSocket &) = default; + + /* -------------------------------------------------------------------------------------------- + * Move assignment. + */ + ZSocket & operator = (ZSocket &&) noexcept = default; + + /* -------------------------------------------------------------------------------------------- + * Make sure a socket instance is referenced. + */ + void Validate() const + { + if (!m_Ptr) + { + STHROWF("Invalid socket instance"); + } + } + + /* -------------------------------------------------------------------------------------------- + * Make sure a socket instance is referenced and return the socket. + */ + SQMOD_NODISCARD ZSkt & Valid() { Validate(); return *m_Ptr; } + + /* -------------------------------------------------------------------------------------------- + * Make sure a socket instance is referenced and return the socket. + */ + SQMOD_NODISCARD const ZSkt & Valid() const { Validate(); return *m_Ptr; } + + /* -------------------------------------------------------------------------------------------- + * Make sure a socket instance is referenced and return the reference. + */ + SQMOD_NODISCARD ZSkt::Ptr & ValidRef() { Validate(); return m_Ptr; } + + /* -------------------------------------------------------------------------------------------- + * Make sure a socket instance is referenced and return the reference. + */ + SQMOD_NODISCARD const ZSkt::Ptr & ValidRef() const { Validate(); return m_Ptr; } + + /* -------------------------------------------------------------------------------------------- + * Check if a context instance is referenced. + */ + SQMOD_NODISCARD bool IsNull() const + { + return static_cast< bool >(m_Ptr); + } + + /* -------------------------------------------------------------------------------------------- + * Accept incoming connections on the socket. + */ + void Bind(StackStrF & ep) + { + // Acquire exclusive access to the socket + std::lock_guard< std::mutex > guard(Valid().mMtx); + // Attempt to bind the socket + int r = zmq_bind(Valid(), ep.mPtr); + // Validate result + if (r != 0) + { + STHROWF("Unable to bind socket: [%d] %s", r, zmq_strerror(r)); + } + } + + /* -------------------------------------------------------------------------------------------- + * Create outgoing connection from the socket + */ + void Connect(StackStrF & ep) + { + // Acquire exclusive access to the socket + std::lock_guard< std::mutex > guard(Valid().mMtx); + // Attempt to connect the socket + int r = zmq_connect(Valid(), ep.mPtr); + // Validate result + if (r != 0) + { + STHROWF("Unable to connect socket: [%d] %s", r, zmq_strerror(r)); + } + } + + /* -------------------------------------------------------------------------------------------- + * Create outgoing connection from the socket + */ + void Disconnect(StackStrF & ep) + { + // Acquire exclusive access to the socket + std::lock_guard< std::mutex > guard(Valid().mMtx); + // Attempt to connect the socket + int r = zmq_disconnect(Valid(), ep.mPtr); + // Validate result + if (r != 0) + { + STHROWF("Unable to disconnect socket: [%d] %s", r, zmq_strerror(r)); + } + } + + /* -------------------------------------------------------------------------------------------- + * Run the managed socket. + */ + void Run() + { + // Make sure thread exists already + if (Valid().mThread.joinable()) + { + STHROWF("Socket is already running"); + } + // Allow the thread to run + m_Ptr->mStatus = 1; + // Now we can create the thread + Valid().mThread = std::thread(&ZSkt::Proc, &Valid()); + } + + /* -------------------------------------------------------------------------------------------- + * Close the managed socket. + */ + void Close() + { + Valid().Close(); + } + + /* -------------------------------------------------------------------------------------------- + * Callback to receive incoming messages. + */ + void OnData(Function & cb) + { + Valid().mOnData = std::move(cb); + } + +private: + + /* -------------------------------------------------------------------------------------------- + * Pointer to the interfaced socket. + */ + ZSkt::Ptr m_Ptr; +}; + + +} // Namespace:: SqMod diff --git a/module/PocoLib/Crypto.cpp b/module/PocoLib/Crypto.cpp index df948cc1..63e6ef01 100644 --- a/module/PocoLib/Crypto.cpp +++ b/module/PocoLib/Crypto.cpp @@ -5,14 +5,6 @@ #include #include -// ------------------------------------------------------------------------------------------------ -#include -#include -#include -#include -// ------------------------------------------------------------------------------------------------ -#include - // ------------------------------------------------------------------------------------------------ namespace SqMod { @@ -240,7 +232,7 @@ static SQInteger SqGetADLER32(HSQUIRRELVM vm) } // ================================================================================================ -void Register_POCO_Crypto(HSQUIRRELVM vm) +void Register_POCO_Crypto(HSQUIRRELVM vm, Table &) { Table ns(vm); diff --git a/module/PocoLib/Crypto.hpp b/module/PocoLib/Crypto.hpp index b2b2c5c1..ea39d24c 100644 --- a/module/PocoLib/Crypto.hpp +++ b/module/PocoLib/Crypto.hpp @@ -4,7 +4,12 @@ #include "Core/Common.hpp" // ------------------------------------------------------------------------------------------------ -#include "Poco/Crypto/DigestEngine.h" +#include +#include +#include +#include +#include +#include // ------------------------------------------------------------------------------------------------ namespace SqMod { diff --git a/module/PocoLib/Data.cpp b/module/PocoLib/Data.cpp index 9bd42775..0d033645 100644 --- a/module/PocoLib/Data.cpp +++ b/module/PocoLib/Data.cpp @@ -390,10 +390,10 @@ static void Register_POCO_Data_Binding(HSQUIRRELVM vm, Table & ns, const SQChar } // ================================================================================================ -void Register_POCO_Data(HSQUIRRELVM vm) +void Register_POCO_Data(HSQUIRRELVM vm, Table &) { Table ns(vm); - //Poco::Data::Keywords::into() + // -------------------------------------------------------------------------------------------- ns.Bind(_SC("Session"), Class< SqDataSession >(vm, SqPcDataSession::Str) diff --git a/module/PocoLib/JSON.cpp b/module/PocoLib/JSON.cpp index c66c7c39..c6329892 100644 --- a/module/PocoLib/JSON.cpp +++ b/module/PocoLib/JSON.cpp @@ -8,7 +8,7 @@ namespace SqMod { // ================================================================================================ -void Register_POCO_JSON(HSQUIRRELVM vm) +void Register_POCO_JSON(HSQUIRRELVM vm, Table &) { Table ns(vm); diff --git a/module/PocoLib/Net.cpp b/module/PocoLib/Net.cpp index 9876a643..958812ac 100644 --- a/module/PocoLib/Net.cpp +++ b/module/PocoLib/Net.cpp @@ -8,7 +8,7 @@ namespace SqMod { // ================================================================================================ -void Register_POCO_Net(HSQUIRRELVM vm) +void Register_POCO_Net(HSQUIRRELVM vm, Table &) { Table ns(vm); diff --git a/module/PocoLib/Foundation.cpp b/module/PocoLib/RegEx.cpp similarity index 79% rename from module/PocoLib/Foundation.cpp rename to module/PocoLib/RegEx.cpp index ddfce6f5..7c60150d 100644 --- a/module/PocoLib/Foundation.cpp +++ b/module/PocoLib/RegEx.cpp @@ -1,5 +1,5 @@ // ------------------------------------------------------------------------------------------------ -#include "PocoLib/Foundation.hpp" +#include "PocoLib/RegEx.hpp" // ------------------------------------------------------------------------------------------------ namespace SqMod { @@ -8,11 +8,11 @@ namespace SqMod { // ================================================================================================ -void Register_POCO_Foundation(HSQUIRRELVM vm) +void Register_POCO_RegEx(HSQUIRRELVM vm, Table &) { Table ns(vm); - RootTable(vm).Bind(_SC("SqPOCO"), ns); + RootTable(vm).Bind(_SC("SqRegEx"), ns); } } // Namespace:: SqMod diff --git a/module/PocoLib/Foundation.hpp b/module/PocoLib/RegEx.hpp similarity index 100% rename from module/PocoLib/Foundation.hpp rename to module/PocoLib/RegEx.hpp diff --git a/module/PocoLib/Register.cpp b/module/PocoLib/Register.cpp new file mode 100644 index 00000000..196a6082 --- /dev/null +++ b/module/PocoLib/Register.cpp @@ -0,0 +1,34 @@ +// ------------------------------------------------------------------------------------------------ +#include "PocoLib/Register.hpp" + +// ------------------------------------------------------------------------------------------------ +namespace SqMod { + +// ------------------------------------------------------------------------------------------------ +extern Register_POCO_Crypto(HSQUIRRELVM vm, Table & ns); +extern Register_POCO_Data(HSQUIRRELVM vm, Table & ns); +extern Register_POCO_JSON(HSQUIRRELVM vm, Table & ns); +extern Register_POCO_Net(HSQUIRRELVM vm, Table & ns); +extern Register_POCO_RegEx(HSQUIRRELVM vm, Table & ns); +extern Register_POCO_Time(HSQUIRRELVM vm, Table & ns); +extern Register_POCO_Util(HSQUIRRELVM vm, Table & ns); +extern Register_POCO_XML(HSQUIRRELVM vm, Table & ns); + +// ================================================================================================ +void Register_POCO(HSQUIRRELVM vm) +{ + Table ns(vm); + + Register_POCO_Crypto(vm, ns); + Register_POCO_Data(vm, ns); + Register_POCO_JSON(vm, ns); + Register_POCO_Net(vm, ns); + Register_POCO_RegEx(vm, ns); + Register_POCO_Time(vm, ns); + Register_POCO_Util(vm, ns); + Register_POCO_XML(vm, ns); + + RootTable(vm).Bind(_SC("Sq"), ns); +} + +} // Namespace:: SqMod diff --git a/module/PocoLib/Register.hpp b/module/PocoLib/Register.hpp new file mode 100644 index 00000000..4eca0ee6 --- /dev/null +++ b/module/PocoLib/Register.hpp @@ -0,0 +1,11 @@ +#pragma once + +// ------------------------------------------------------------------------------------------------ +#include "Core/Common.hpp" + +// ------------------------------------------------------------------------------------------------ +namespace SqMod { + + + +} // Namespace:: SqMod diff --git a/module/PocoLib/Time.cpp b/module/PocoLib/Time.cpp new file mode 100644 index 00000000..5dc57e23 --- /dev/null +++ b/module/PocoLib/Time.cpp @@ -0,0 +1,60 @@ +// ------------------------------------------------------------------------------------------------ +#include "PocoLib/Time.hpp" + +// ------------------------------------------------------------------------------------------------ +namespace SqMod { + +// ------------------------------------------------------------------------------------------------ +SQMOD_DECL_TYPENAME(SqClock, _SC("SqClock")) +SQMOD_DECL_TYPENAME(SqDateTime, _SC("SqDateTime")) +SQMOD_DECL_TYPENAME(SqDateTimeFormatter, _SC("SqDateTimeFormatter")) +SQMOD_DECL_TYPENAME(SqDateTimeParser, _SC("SqDateTimeParser")) +SQMOD_DECL_TYPENAME(SqLocalDateTime, _SC("SqLocalDateTime")) +SQMOD_DECL_TYPENAME(SqStopwatch, _SC("SqStopwatch")) +SQMOD_DECL_TYPENAME(SqTimespan, _SC("SqTimespan")) +SQMOD_DECL_TYPENAME(SqTimestamp, _SC("SqTimestamp")) +SQMOD_DECL_TYPENAME(SqTimezone, _SC("SqTimezone")) + +// ================================================================================================ +void Register_POCO_Time(HSQUIRRELVM vm, Table & ns) +{ + // -------------------------------------------------------------------------------------------- + ns.Bind(_SC("Timespan"), + Class< Timespan >(vm, SqTimespan::Str) + // Constructors + .Ctor() + .Ctor< const Timespan & >() + .Ctor< long, long >() + .Ctor< int, int, int, int, int >() + // Meta-methods + .SquirrelFunc(_SC("_typename"), &SqTimespan::Fn) + // Properties + .Prop(_SC("Days"), &Timespan::days) + .Prop(_SC("Hours"), &Timespan::hours) + .Prop(_SC("TotalHours"), &Timespan::totalHours) + .Prop(_SC("Minutes"), &Timespan::minutes) + .Prop(_SC("TotalMinutes"), &Timespan::totalMinutes) + .Prop(_SC("Seconds"), &Timespan::seconds) + .Prop(_SC("TotalSeconds"), &Timespan::totalSeconds) + .Prop(_SC("Milliseconds"), &Timespan::milliseconds) + .Prop(_SC("TotalMilliseconds"), &Timespan::totalMilliseconds) + .Prop(_SC("Microseconds"), &Timespan::microseconds) + .Prop(_SC("Useconds"), &Timespan::useconds) + .Prop(_SC("TotalMicroseconds"), &Timespan::totalMicroseconds) + // Member Methods + .FmtFunc(_SC("Swap"), &Timespan::swap) + // Member Overloads + .Overload< Timespan & (Timespan::*)(long, long) > + (_SC("Assign"), &Timespan::assign) + .Overload< Timespan & (Timespan::*)(int, int, int, int, int) > + (_SC("Assign"), &Timespan::assign) + // Static Values + .SetStaticValue(_SC("MILLISECONDS"), static_cast< SQInteger >(Timespan::MILLISECONDS)) + .SetStaticValue(_SC("SECONDS"), static_cast< SQInteger >(Timespan::SECONDS)) + .SetStaticValue(_SC("MINUTES"), static_cast< SQInteger >(Timespan::MINUTES)) + .SetStaticValue(_SC("HOURS"), static_cast< SQInteger >(Timespan::HOURS)) + .SetStaticValue(_SC("DAYS"), static_cast< SQInteger >(Timespan::DAYS)) + ); +} + +} // Namespace:: SqMod diff --git a/module/PocoLib/Time.hpp b/module/PocoLib/Time.hpp new file mode 100644 index 00000000..d7dfdf09 --- /dev/null +++ b/module/PocoLib/Time.hpp @@ -0,0 +1,31 @@ +#pragma once + +// ------------------------------------------------------------------------------------------------ +#include "Core/Common.hpp" + +// ------------------------------------------------------------------------------------------------ +#include +#include +#include +#include +#include +#include +#include +#include +#include + +// ------------------------------------------------------------------------------------------------ +namespace SqMod { + +// ------------------------------------------------------------------------------------------------ +using Poco::Clock; +using Poco::DateTime; +using Poco::DateTimeFormatter; +using Poco::DateTimeParser; +using Poco::LocalDateTime; +using Poco::Stopwatch; +using Poco::Timespan; +using Poco::Timestamp; +using Poco::Timezone; + +} // Namespace:: SqMod diff --git a/module/PocoLib/Util.cpp b/module/PocoLib/Util.cpp index f3abd7d6..31f4cd38 100644 --- a/module/PocoLib/Util.cpp +++ b/module/PocoLib/Util.cpp @@ -8,7 +8,7 @@ namespace SqMod { // ================================================================================================ -void Register_POCO_Util(HSQUIRRELVM vm) +void Register_POCO_Util(HSQUIRRELVM vm, Table &) { } diff --git a/module/PocoLib/XML.cpp b/module/PocoLib/XML.cpp index 5c4dcebb..af051b62 100644 --- a/module/PocoLib/XML.cpp +++ b/module/PocoLib/XML.cpp @@ -8,7 +8,7 @@ namespace SqMod { // ================================================================================================ -void Register_POCO_XML(HSQUIRRELVM vm) +void Register_POCO_XML(HSQUIRRELVM vm, Table &) { Table ns(vm); diff --git a/module/Register.cpp b/module/Register.cpp index 0471f064..a94e357c 100644 --- a/module/Register.cpp +++ b/module/Register.cpp @@ -34,21 +34,14 @@ extern void Register_CVehicle(HSQUIRRELVM vm); extern void Register_Chrono(HSQUIRRELVM vm); extern void Register_CURL(HSQUIRRELVM vm); extern void Register_IO(HSQUIRRELVM vm); -extern void Register_Job(HSQUIRRELVM vm); -extern void Register_MMDB(HSQUIRRELVM vm); -extern void Register_MySQL(HSQUIRRELVM vm); extern void Register_Numeric(HSQUIRRELVM vm); -extern void Register_Socket(HSQUIRRELVM vm); -extern void Register_SQLite(HSQUIRRELVM vm); extern void Register_String(HSQUIRRELVM vm); extern void Register_System(HSQUIRRELVM vm); extern void Register_Utils(HSQUIRRELVM vm); -extern void Register_Worker(HSQUIRRELVM vm); -extern void Register_Web(HSQUIRRELVM vm); +extern void Register_ZMQ(HSQUIRRELVM vm); // ------------------------------------------------------------------------------------------------ -extern void Register_POCO_Crypto(HSQUIRRELVM vm); -extern void Register_POCO_Data(HSQUIRRELVM vm); +extern void Register_POCO(HSQUIRRELVM vm); // ------------------------------------------------------------------------------------------------ extern void Register_Constants(HSQUIRRELVM vm); @@ -91,20 +84,13 @@ bool RegisterAPI(HSQUIRRELVM vm) Register_Chrono(vm); Register_CURL(vm); Register_IO(vm); - //Register_Job(vm); - //Register_MMDB(vm); - //Register_MySQL(vm); Register_Numeric(vm); - //Register_Socket(vm); - //Register_SQLite(vm); Register_String(vm); Register_System(vm); Register_Utils(vm); - //Register_Worker(vm); - //Register_Web(vm); + Register_ZMQ(vm); - Register_POCO_Crypto(vm); - Register_POCO_Data(vm); + Register_POCO(vm); Register_Constants(vm); Register_Log(vm); diff --git a/module/Sqrat/sqratUtil.h b/module/Sqrat/sqratUtil.h index 2c83147e..787a4cbb 100644 --- a/module/Sqrat/sqratUtil.h +++ b/module/Sqrat/sqratUtil.h @@ -138,7 +138,7 @@ static _Noreturn void unreachable() { return; } /// Removes unused variable warnings in a way that Doxygen can understand ///////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// template -void SQUNUSED(const T&) { +inline void SQUNUSED(const T&) { } /// @endcond @@ -2202,88 +2202,86 @@ template < typename T > struct SqChainedInstances ///////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// /// Default constructor. ///////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// - SqChainedInstances() - : m_Prev(nullptr), m_Next(nullptr) + SqChainedInstances() noexcept + : mPrev(nullptr), mNext(nullptr) { //... } -protected: + T * mPrev; // Previous instance in the chain. + T * mNext; // Next instance in the chain. - SqChainedInstances * m_Prev; // Previous instance in the chain. - SqChainedInstances * m_Next; // Next instance in the chain. - - static SqChainedInstances * s_Head; // The head of the instance chain. + static T * sHead; // The head of the instance chain. ///////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// /// Attach the instance to the chain. ///////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// - void ChainInstance() + void ChainInstance() noexcept { // Is there an existing head? - if (s_Head == nullptr) + if (sHead == nullptr) { // There was no existing head - m_Prev = m_Next = nullptr; + mPrev = mNext = nullptr; // We're the head - s_Head = this; + sHead = static_cast< T * >(this); } // Is there a preceding instance before the current head? - else if (s_Head->m_Prev == nullptr) + else if (sHead->mPrev == nullptr) { // Grab the current head as the next instance in the chain - m_Next = s_Head; + mNext = sHead; // Become the new head and the preceding instance of the current head - m_Next->m_Prev = s_Head = this; + mNext->mPrev = sHead = static_cast< T * >(this); } else { // Grab the current head as the next instance in the chain - m_Next = s_Head; + mNext = sHead; // Become the new head and the next instance of the preceding instance of the current head - m_Next->m_Prev->m_Next = s_Head = this; + mNext->mPrev->mNext = sHead = static_cast< T * >(this); // Become the preceding instance of the current head - m_Next->m_Prev = this; + mNext->mPrev = static_cast< T * >(this); } } ///////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// /// Detach the instance from the chain. ///////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// - void UnchainInstance() + void UnchainInstance() noexcept { // Is there an instance after us? - if (m_Next != nullptr) + if (mNext != nullptr) { // Link the next instance with the one before us - m_Next->m_Prev = m_Prev; + mNext->mPrev = mPrev; // Are we the current head? - if (s_Head == this) + if (sHead == static_cast< T * >(this)) { - s_Head = m_Next; // Make the next one the head + sHead = mNext; // Make the next one the head } } // Is there an instance before us? - if (m_Prev != nullptr) + if (mPrev != nullptr) { // Link the previous instance with the one after us - m_Prev->m_Next = m_Next; + mPrev->mNext = mNext; // Are we the current head? - if (s_Head == nullptr || s_Head == this) + if (sHead == nullptr || sHead == static_cast< T * >(this)) { // If there was no instance after us then make the previous one the head - s_Head = m_Prev; + sHead = mPrev; } } // Are we the current and the only head? - else if (s_Head == this) + else if (sHead == static_cast< T * >(this)) { - s_Head = nullptr; // No more instances of this type + sHead = nullptr; // No more instances of this type } } }; -template < typename T > SqChainedInstances< T > * SqChainedInstances< T >::s_Head = nullptr; +template < typename T > T * SqChainedInstances< T >::sHead = nullptr; ///////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// /// @cond DEV diff --git a/vendor/CMakeLists.txt b/vendor/CMakeLists.txt index 2f5b87fc..8649f5f3 100644 --- a/vendor/CMakeLists.txt +++ b/vendor/CMakeLists.txt @@ -38,3 +38,11 @@ add_subdirectory(POCO) if (WIN32 AND MINGW) target_compile_definitions(Foundation PUBLIC POCO_NO_FPENVIRONMENT=1) endif() +# We have these on GCC +if(MINGW OR GCC) + set(ENABLE_INTRINSICS ON CACHE INTERNAL "" FORCE) +endif() +set(BUILD_TESTS OFF CACHE INTERNAL "" FORCE) +set(BUILD_SHARED OFF CACHE INTERNAL "" FORCE) +set(BUILD_STATIC ON CACHE INTERNAL "" FORCE) +add_subdirectory(ZMQ) \ No newline at end of file diff --git a/vendor/ConcurrentQueue/include/blockingconcurrentqueue.h b/vendor/ConcurrentQueue/include/blockingconcurrentqueue.h index 9b713396..66579b6c 100644 --- a/vendor/ConcurrentQueue/include/blockingconcurrentqueue.h +++ b/vendor/ConcurrentQueue/include/blockingconcurrentqueue.h @@ -56,7 +56,7 @@ public: // includes making the memory effects of construction visible, possibly with a // memory barrier). explicit BlockingConcurrentQueue(size_t capacity = 6 * BLOCK_SIZE) - : inner(capacity), sema(create(0, (int)Traits::MAX_SEMA_SPINS), &BlockingConcurrentQueue::template destroy) + : inner(capacity), sema(create(0, (int)Traits::MAX_SEMA_SPINS), &BlockingConcurrentQueue::template destroy) { assert(reinterpret_cast((BlockingConcurrentQueue*)1) == &((BlockingConcurrentQueue*)1)->inner && "BlockingConcurrentQueue must have ConcurrentQueue as its first member"); if (!sema) { @@ -65,7 +65,7 @@ public: } BlockingConcurrentQueue(size_t minCapacity, size_t maxExplicitProducers, size_t maxImplicitProducers) - : inner(minCapacity, maxExplicitProducers, maxImplicitProducers), sema(create(0, (int)Traits::MAX_SEMA_SPINS), &BlockingConcurrentQueue::template destroy) + : inner(minCapacity, maxExplicitProducers, maxImplicitProducers), sema(create(0, (int)Traits::MAX_SEMA_SPINS), &BlockingConcurrentQueue::template destroy) { assert(reinterpret_cast((BlockingConcurrentQueue*)1) == &((BlockingConcurrentQueue*)1)->inner && "BlockingConcurrentQueue must have ConcurrentQueue as its first member"); if (!sema) { diff --git a/vendor/ConcurrentQueue/include/concurrentqueue.h b/vendor/ConcurrentQueue/include/concurrentqueue.h index 830b8193..ff3156f7 100644 --- a/vendor/ConcurrentQueue/include/concurrentqueue.h +++ b/vendor/ConcurrentQueue/include/concurrentqueue.h @@ -1688,7 +1688,7 @@ private: { } - virtual ~ProducerBase() { }; + virtual ~ProducerBase() { } template inline bool dequeue(U& element) @@ -1897,7 +1897,7 @@ private: ++pr_blockIndexSlotsUsed; } - MOODYCAMEL_CONSTEXPR_IF (!MOODYCAMEL_NOEXCEPT_CTOR(T, U, new ((T*)nullptr) T(std::forward(element)))) { + MOODYCAMEL_CONSTEXPR_IF (!MOODYCAMEL_NOEXCEPT_CTOR(T, U, new (static_cast(nullptr)) T(std::forward(element)))) { // The constructor may throw. We want the element not to appear in the queue in // that case (without corrupting the queue): MOODYCAMEL_TRY { @@ -1923,7 +1923,7 @@ private: blockIndex.load(std::memory_order_relaxed)->front.store(pr_blockIndexFront, std::memory_order_release); pr_blockIndexFront = (pr_blockIndexFront + 1) & (pr_blockIndexSize - 1); - MOODYCAMEL_CONSTEXPR_IF (!MOODYCAMEL_NOEXCEPT_CTOR(T, U, new ((T*)nullptr) T(std::forward(element)))) { + MOODYCAMEL_CONSTEXPR_IF (!MOODYCAMEL_NOEXCEPT_CTOR(T, U, new (static_cast(nullptr)) T(std::forward(element)))) { this->tailIndex.store(newTailIndex, std::memory_order_release); return true; } @@ -2139,7 +2139,7 @@ private: block = block->next; } - MOODYCAMEL_CONSTEXPR_IF (MOODYCAMEL_NOEXCEPT_CTOR(T, decltype(*itemFirst), new ((T*)nullptr) T(details::deref_noexcept(itemFirst)))) { + MOODYCAMEL_CONSTEXPR_IF (MOODYCAMEL_NOEXCEPT_CTOR(T, decltype(*itemFirst), new (static_cast(nullptr)) T(details::deref_noexcept(itemFirst)))) { blockIndex.load(std::memory_order_relaxed)->front.store((pr_blockIndexFront - 1) & (pr_blockIndexSize - 1), std::memory_order_release); } } @@ -2158,7 +2158,7 @@ private: if (details::circular_less_than(newTailIndex, stopIndex)) { stopIndex = newTailIndex; } - MOODYCAMEL_CONSTEXPR_IF (MOODYCAMEL_NOEXCEPT_CTOR(T, decltype(*itemFirst), new ((T*)nullptr) T(details::deref_noexcept(itemFirst)))) { + MOODYCAMEL_CONSTEXPR_IF (MOODYCAMEL_NOEXCEPT_CTOR(T, decltype(*itemFirst), new (static_cast(nullptr)) T(details::deref_noexcept(itemFirst)))) { while (currentTailIndex != stopIndex) { new ((*this->tailBlock)[currentTailIndex++]) T(*itemFirst++); } @@ -2173,7 +2173,7 @@ private: // may only define a (noexcept) move constructor, and so calls to the // cctor will not compile, even if they are in an if branch that will never // be executed - new ((*this->tailBlock)[currentTailIndex]) T(details::nomove_if<(bool)!MOODYCAMEL_NOEXCEPT_CTOR(T, decltype(*itemFirst), new ((T*)nullptr) T(details::deref_noexcept(itemFirst)))>::eval(*itemFirst)); + new ((*this->tailBlock)[currentTailIndex]) T(details::nomove_if(nullptr)) T(details::deref_noexcept(itemFirst)))>::eval(*itemFirst)); ++currentTailIndex; ++itemFirst; } @@ -2220,7 +2220,7 @@ private: this->tailBlock = this->tailBlock->next; } - MOODYCAMEL_CONSTEXPR_IF (!MOODYCAMEL_NOEXCEPT_CTOR(T, decltype(*itemFirst), new ((T*)nullptr) T(details::deref_noexcept(itemFirst)))) { + MOODYCAMEL_CONSTEXPR_IF (!MOODYCAMEL_NOEXCEPT_CTOR(T, decltype(*itemFirst), new (static_cast(nullptr)) T(details::deref_noexcept(itemFirst)))) { if (firstAllocatedBlock != nullptr) blockIndex.load(std::memory_order_relaxed)->front.store((pr_blockIndexFront - 1) & (pr_blockIndexSize - 1), std::memory_order_release); } @@ -2239,7 +2239,7 @@ private: desiredCount = desiredCount < max ? desiredCount : max; std::atomic_thread_fence(std::memory_order_acquire); - auto myDequeueCount = this->dequeueOptimisticCount.fetch_add(desiredCount, std::memory_order_relaxed);; + auto myDequeueCount = this->dequeueOptimisticCount.fetch_add(desiredCount, std::memory_order_relaxed); tail = this->tailIndex.load(std::memory_order_acquire); auto actualCount = static_cast(tail - (myDequeueCount - overcommit)); @@ -2501,7 +2501,7 @@ private: #endif newBlock->ConcurrentQueue::Block::template reset_empty(); - MOODYCAMEL_CONSTEXPR_IF (!MOODYCAMEL_NOEXCEPT_CTOR(T, U, new ((T*)nullptr) T(std::forward(element)))) { + MOODYCAMEL_CONSTEXPR_IF (!MOODYCAMEL_NOEXCEPT_CTOR(T, U, new (static_cast(nullptr)) T(std::forward(element)))) { // May throw, try to insert now before we publish the fact that we have this new block MOODYCAMEL_TRY { new ((*newBlock)[currentTailIndex]) T(std::forward(element)); @@ -2519,7 +2519,7 @@ private: this->tailBlock = newBlock; - MOODYCAMEL_CONSTEXPR_IF (!MOODYCAMEL_NOEXCEPT_CTOR(T, U, new ((T*)nullptr) T(std::forward(element)))) { + MOODYCAMEL_CONSTEXPR_IF (!MOODYCAMEL_NOEXCEPT_CTOR(T, U, new (static_cast(nullptr)) T(std::forward(element)))) { this->tailIndex.store(newTailIndex, std::memory_order_release); return true; } @@ -2697,7 +2697,7 @@ private: if (details::circular_less_than(newTailIndex, stopIndex)) { stopIndex = newTailIndex; } - MOODYCAMEL_CONSTEXPR_IF (MOODYCAMEL_NOEXCEPT_CTOR(T, decltype(*itemFirst), new ((T*)nullptr) T(details::deref_noexcept(itemFirst)))) { + MOODYCAMEL_CONSTEXPR_IF (MOODYCAMEL_NOEXCEPT_CTOR(T, decltype(*itemFirst), new (static_cast(nullptr)) T(details::deref_noexcept(itemFirst)))) { while (currentTailIndex != stopIndex) { new ((*this->tailBlock)[currentTailIndex++]) T(*itemFirst++); } @@ -2705,7 +2705,7 @@ private: else { MOODYCAMEL_TRY { while (currentTailIndex != stopIndex) { - new ((*this->tailBlock)[currentTailIndex]) T(details::nomove_if<(bool)!MOODYCAMEL_NOEXCEPT_CTOR(T, decltype(*itemFirst), new ((T*)nullptr) T(details::deref_noexcept(itemFirst)))>::eval(*itemFirst)); + new ((*this->tailBlock)[currentTailIndex]) T(details::nomove_if(nullptr)) T(details::deref_noexcept(itemFirst)))>::eval(*itemFirst)); ++currentTailIndex; ++itemFirst; } @@ -3459,7 +3459,7 @@ private: } auto newHash = new (raw) ImplicitProducerHash; - newHash->capacity = (size_t)newCapacity; + newHash->capacity = static_cast(newCapacity); newHash->entries = reinterpret_cast(details::align_for(raw + sizeof(ImplicitProducerHash))); for (size_t i = 0; i != newCapacity; ++i) { new (newHash->entries + i) ImplicitProducerKVP; @@ -3698,7 +3698,7 @@ ConsumerToken::ConsumerToken(ConcurrentQueue& queue) : itemsConsumedFromCurrent(0), currentProducer(nullptr), desiredProducer(nullptr) { initialOffset = queue.nextExplicitConsumerId.fetch_add(1, std::memory_order_release); - lastKnownGlobalOffset = (std::uint32_t)-1; + lastKnownGlobalOffset = static_cast(-1); } template @@ -3706,7 +3706,7 @@ ConsumerToken::ConsumerToken(BlockingConcurrentQueue& queue) : itemsConsumedFromCurrent(0), currentProducer(nullptr), desiredProducer(nullptr) { initialOffset = reinterpret_cast*>(&queue)->nextExplicitConsumerId.fetch_add(1, std::memory_order_release); - lastKnownGlobalOffset = (std::uint32_t)-1; + lastKnownGlobalOffset = static_cast(-1); } template diff --git a/vendor/ConcurrentQueue/include/lightweightsemaphore.h b/vendor/ConcurrentQueue/include/lightweightsemaphore.h index 78eaa7dc..b0f24e1c 100644 --- a/vendor/ConcurrentQueue/include/lightweightsemaphore.h +++ b/vendor/ConcurrentQueue/include/lightweightsemaphore.h @@ -139,7 +139,7 @@ public: { mach_timespec_t ts; ts.tv_sec = static_cast(timeout_usecs / 1000000); - ts.tv_nsec = (timeout_usecs % 1000000) * 1000; + ts.tv_nsec = static_cast((timeout_usecs % 1000000) * 1000); // added in OSX 10.10: https://developer.apple.com/library/prerelease/mac/documentation/General/Reference/APIDiffsMacOSX10_10SeedDiff/modules/Darwin.html kern_return_t rc = semaphore_timedwait(m_sema, ts); @@ -175,7 +175,7 @@ public: Semaphore(int initialCount = 0) { assert(initialCount >= 0); - int rc = sem_init(&m_sema, 0, initialCount); + int rc = sem_init(&m_sema, 0, static_cast(initialCount)); assert(rc == 0); (void)rc; } diff --git a/vendor/ZMQ/AUTHORS b/vendor/ZMQ/AUTHORS new file mode 100644 index 00000000..42b865fa --- /dev/null +++ b/vendor/ZMQ/AUTHORS @@ -0,0 +1,152 @@ +Corporate Contributors +====================== + +Copyright (c) 2007-2014 iMatix Corporation +Copyright (c) 2009-2011 250bpm s.r.o. +Copyright (c) 2010-2011 Miru Limited +Copyright (c) 2011 VMware, Inc. +Copyright (c) 2012 Spotify AB +Copyright (c) 2013 Ericsson AB +Copyright (c) 2014 AppDynamics Inc. +Copyright (c) 2015 Google, Inc. +Copyright (c) 2015-2016 Brocade Communications Systems Inc. + +Individual Contributors +======================= + +AJ Lewis +Alexej Lotz +Andrew Thompson +André Caron +Asko Kauppi +Attila Mark +Barak Amar +Ben Gray +Bernd Melchers +Bernd Prager +Bob Beaty +Brandon Carpenter +Brett Cameron +Brian Buchanan +Burak Arslan +Carl Clemens +Chia-liang Kao +Chris Busbey +Chris Rempel +Chris Wong +Christian Gudrian +Christian Kamm +Chuck Remes +Conrad D. Steenberg +Constantin Rack +Daniel J. Bernstein +Dhammika Pathirana +Dhruva Krishnamurthy +Dirk O. Kaar +Doron Somech +Douglas Creager +Drew Crawford +Erich Heine +Erik Hugne +Erik Rigtorp +Fabien Ninoles +Frank Denis +George Neill +Gerard Toonstra +Ghislain Putois +Gonzalo Diethelm +Guido Goldstein +Harald Achitz +Hardeep Singh +Hiten Pandya +Ian Barber +Ilja Golshtein +Ilya Kulakov +Ivo Danihelka +Jacob Rideout +Joe Thornber +Jon Dyte +Kamil Shakirov +Ken Steele +Kouhei Sutou +Laurent Alebarde +Leonardo J. Consoni +Lionel Flandrin +Lourens Naudé +Luca Boccassi +Marc Rossi +Mark Barbisan +Martin Hurton +Martin Lucina +Martin Pales +Martin Sustrik +Matus Hamorsky +Max Wolf +McClain Looney +Michael Compton +Mika Fischer +Mikael Helbo Kjaer +Mike Gatny +Mikko Koppanen +Min Ragan-Kelley +Neale Ferguson +Nir Soffer +Osiris Pedroso +Paul Betts +Paul Colomiets +Pavel Gushcha +Pavol Malosek +Perry Kundert +Peter Bourgon +Philip Kovacs +Pieter Hintjens +Piotr Trojanek +Reza Ebrahimi +Richard Newton +Rik van der Heijden +Robert G. Jakabosky +Sebastian Otaegui +Stefan Radomski +Steven McCoy +Stuart Webster +Tamara Kustarova +Taras Shpot +Tero Marttila +Terry Wilson +Thijs Terlouw +Thomas Rodgers +Tim Mossbarger +Toralf Wittner +Tore Halvorsen +Trevor Bernard +Vitaly Mayatskikh + +Credits +======= + +Aamir Mohammad +Adrian von Bidder +Aleksey Yeschenko +Alessio Spadaro +Alexander Majorov +Anh Vu +Bernd Schumacher +Brian Granger +Carsten Dinkelmann +David Bahi +Dirk Eddelbuettel +Evgueny Khartchenko +Frank Vanden Berghen +Ian Barber +John Apps +Markus Fischer +Matt Muggeridge +Michael Santy +Oleg Sevostyanov +Paulo Henrique Silva +Peter Busser +Peter Lemenkov +Robert Zhang +Toralf Wittner +Zed Shaw + diff --git a/vendor/ZMQ/CMakeLists.txt b/vendor/ZMQ/CMakeLists.txt new file mode 100644 index 00000000..0863c23f --- /dev/null +++ b/vendor/ZMQ/CMakeLists.txt @@ -0,0 +1,1823 @@ +# CMake build script for ZeroMQ +project(ZeroMQ) + +if(${CMAKE_SYSTEM_NAME} STREQUAL Darwin) + cmake_minimum_required(VERSION 3.0.2) +else() + cmake_minimum_required(VERSION 2.8.12) +endif() + +include(CheckIncludeFiles) +include(CheckCCompilerFlag) +include(CheckCXXCompilerFlag) +include(CheckLibraryExists) +include(CheckCSourceCompiles) +include(CheckCSourceRuns) +include(CMakeDependentOption) +include(CheckCXXSymbolExists) +include(CheckTypeSize) +include(FindThreads) +include(GNUInstallDirs) +include(CheckTypeSize) +include(CMakePackageConfigHelpers) + +list(INSERT CMAKE_MODULE_PATH 0 "${CMAKE_CURRENT_SOURCE_DIR}") +set(ZMQ_CMAKE_MODULES_DIR ${CMAKE_CURRENT_SOURCE_DIR}/builds/cmake/Modules) +list(APPEND CMAKE_MODULE_PATH ${ZMQ_CMAKE_MODULES_DIR}) + +include(TestZMQVersion) +include(ZMQSourceRunChecks) +include(ZMQSupportMacros) + +find_package(PkgConfig) + +# Set lists to empty beforehand as to not accidentally take values from parent +set(sources) +set(cxx-sources) +set(html-docs) +set(target_outputs) + +option(ENABLE_ASAN "Build with address sanitizer" OFF) +if(ENABLE_ASAN) + message(STATUS "Instrumenting with Address Sanitizer") + set(CMAKE_BUILD_TYPE "RelWithDebInfo") + set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -fsanitize=address -fsanitize-address-use-after-scope -fno-omit-frame-pointer") + set(CMAKE_CXX_FLAGS + "${CMAKE_CXX_FLAGS} -fsanitize=address -fsanitize-address-use-after-scope -fno-omit-frame-pointer") + set(CMAKE_SHARED_LINKER_FLAGS "${CMAKE_SHARED_LINKER_FLAGS} -fsanitize=address -fsanitize-address-use-after-scope") + set(CMAKE_EXE_LINKER_FLAGS "${CMAKE_EXE_LINKER_FLAGS} -fsanitize=address -fsanitize-address-use-after-scope") +endif() + +# NOTE: Running libzmq under TSAN doesn't make much sense -- synchronization in libzmq is to some extent +# handled by the code "knowing" what threads are allowed to do, rather than by enforcing those +# restrictions, so TSAN generates a lot of (presumably) false positives from libzmq. +# The settings below are intended to enable libzmq to be built with minimal support for TSAN +# such that it can be used along with other code that is also built with TSAN. +option(ENABLE_TSAN "Build with thread sanitizer" OFF) +if(ENABLE_TSAN) + message(STATUS "Instrumenting with Thread Sanitizer") + set(CMAKE_BUILD_TYPE "RelWithDebInfo") + set(TSAN_FLAGS "-fno-omit-frame-pointer -fsanitize=thread") + set(TSAN_CCFLAGS "${TSAN_CCFLAGS} -mllvm -tsan-instrument-memory-accesses=0") + set(TSAN_CCFLAGS "${TSAN_CCFLAGS} -mllvm -tsan-instrument-atomics=0") + set(TSAN_CCFLAGS "${TSAN_CCFLAGS} -mllvm -tsan-instrument-func-entry-exit=1") + set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} ${TSAN_FLAGS} ${TSAN_CCFLAGS} -fPIE") + set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} ${TSAN_FLAGS} ${TSAN_CCFLAGS} -fPIE") + set(CMAKE_SHARED_LINKER_FLAGS "${CMAKE_SHARED_LINKER_FLAGS} ${TSAN_FLAGS} -pie -Qunused-arguments") + set(CMAKE_EXE_LINKER_FLAGS "${CMAKE_EXE_LINKER_FLAGS} ${TSAN_FLAGS} -pie -Qunused-arguments") +endif() + +option(ENABLE_UBSAN "Build with undefined behavior sanitizer" OFF) +if(ENABLE_UBSAN) + message(STATUS "Instrumenting with Undefined Behavior Sanitizer") + set(CMAKE_BUILD_TYPE "RelWithDebInfo") + set(UBSAN_FLAGS "${UBSAN_FLAGS} -fno-omit-frame-pointer") + set(UBSAN_FLAGS "${UBSAN_FLAGS} -fsanitize=undefined") + set(UBSAN_FLAGS "${UBSAN_FLAGS} -fsanitize=implicit-conversion") + set(UBSAN_FLAGS "${UBSAN_FLAGS} -fsanitize=implicit-integer-truncation") + set(UBSAN_FLAGS "${UBSAN_FLAGS} -fsanitize=integer") + set(UBSAN_FLAGS "${UBSAN_FLAGS} -fsanitize=nullability") + set(UBSAN_FLAGS "${UBSAN_FLAGS} -fsanitize=vptr") + set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} ${UBSAN_FLAGS}") + set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} ${UBSAN_FLAGS}") + set(CMAKE_SHARED_LINKER_FLAGS "${CMAKE_SHARED_LINKER_FLAGS} ${UBSAN_FLAGS}") + set(CMAKE_EXE_LINKER_FLAGS "${CMAKE_EXE_LINKER_FLAGS} ${UBSAN_FLAGS}") +endif() + +option(ENABLE_INTRINSICS "Build using compiler intrinsics for atomic ops" OFF) +if(ENABLE_INTRINSICS) + message(STATUS "Using compiler intrinsics for atomic ops") + add_definitions(-DZMQ_HAVE_ATOMIC_INTRINSICS) +endif() + +set(ZMQ_OUTPUT_BASENAME + "zmq" + CACHE STRING "Output zmq library base name") + +if(${CMAKE_SYSTEM_NAME} STREQUAL Darwin) + # Find more information: https://cmake.org/Wiki/CMake_RPATH_handling + + # Apply CMP0042: MACOSX_RPATH is enabled by default + cmake_policy(SET CMP0042 NEW) + + # Add an install rpath if it is not a system directory + list(FIND CMAKE_PLATFORM_IMPLICIT_LINK_DIRECTORIES "${CMAKE_INSTALL_PREFIX}/${CMAKE_INSTALL_LIBDIR}" isSystemDir) + if("${isSystemDir}" STREQUAL "-1") + set(CMAKE_INSTALL_RPATH "${CMAKE_INSTALL_PREFIX}/${CMAKE_INSTALL_LIBDIR}") + endif() + + # Add linker search paths pointing to external dependencies + set(CMAKE_INSTALL_RPATH_USE_LINK_PATH TRUE) +endif() + +if (NOT MSVC) + if(NOT CMAKE_CXX_FLAGS MATCHES "-std=") + # use C++11 by default if supported + check_cxx_compiler_flag("-std=gnu++11" COMPILER_SUPPORTS_CXX11) + if(COMPILER_SUPPORTS_CXX11) + set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -std=gnu++11") + endif() + endif() + if(NOT CMAKE_C_FLAGS MATCHES "-std=") + check_c_compiler_flag("-std=gnu11" COMPILER_SUPPORTS_C11) + if(COMPILER_SUPPORTS_C11) + set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -std=gnu11") + else() + set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -std=gnu99") + endif() + endif() + + # clang 6 has a warning that does not make sense on multi-platform code + check_cxx_compiler_flag("-Wno-tautological-constant-compare" CXX_HAS_TAUT_WARNING) + if(CXX_HAS_TAUT_WARNING) + set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Wno-tautological-constant-compare") + endif() + check_c_compiler_flag("-Wno-tautological-constant-compare" CC_HAS_TAUT_WARNING) + if(CC_HAS_TAUT_WARNING) + set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -Wno-tautological-constant-compare") + endif() +endif() + +# Will be used to add flags to pkg-config useful when apps want to statically link +set(pkg_config_libs_private "") +set(pkg_config_names_private "") + +option(WITH_OPENPGM "Build with support for OpenPGM" OFF) +option(WITH_NORM "Build with support for NORM" OFF) +option(WITH_VMCI "Build with support for VMware VMCI socket" OFF) + +if(APPLE) + option(ZMQ_BUILD_FRAMEWORK "Build as OS X framework" OFF) +endif() + +if(EXISTS "${CMAKE_SOURCE_DIR}/.git") + message(STATUS "Build and install draft classes and methods") + option(ENABLE_DRAFTS "Build and install draft classes and methods" ON) +else() + message(STATUS "Not building draft classes and methods") + option(ENABLE_DRAFTS "Build and install draft classes and methods" OFF) +endif() + +# Enable WebSocket transport and RadixTree +if(ENABLE_DRAFTS) + set(ZMQ_BUILD_DRAFT_API 1) + option(ENABLE_WS "Enable WebSocket transport" ON) + option(ENABLE_RADIX_TREE "Use radix tree implementation to manage subscriptions" ON) +else() + option(ENABLE_WS "Enable WebSocket transport" OFF) + option(ENABLE_RADIX_TREE "Use radix tree implementation to manage subscriptions" OFF) +endif() + +if(ENABLE_RADIX_TREE) + message(STATUS "Using radix tree implementation to manage subscriptions") + set(ZMQ_USE_RADIX_TREE 1) +endif() + +if(ENABLE_WS) + list( + APPEND + sources + ${CMAKE_CURRENT_SOURCE_DIR}/src/ws_address.cpp + ${CMAKE_CURRENT_SOURCE_DIR}/src/ws_connecter.cpp + ${CMAKE_CURRENT_SOURCE_DIR}/src/ws_decoder.cpp + ${CMAKE_CURRENT_SOURCE_DIR}/src/ws_encoder.cpp + ${CMAKE_CURRENT_SOURCE_DIR}/src/ws_engine.cpp + ${CMAKE_CURRENT_SOURCE_DIR}/src/ws_listener.cpp + ${CMAKE_CURRENT_SOURCE_DIR}/src/ws_address.hpp + ${CMAKE_CURRENT_SOURCE_DIR}/src/ws_connecter.hpp + ${CMAKE_CURRENT_SOURCE_DIR}/src/ws_decoder.hpp + ${CMAKE_CURRENT_SOURCE_DIR}/src/ws_encoder.hpp + ${CMAKE_CURRENT_SOURCE_DIR}/src/ws_engine.hpp + ${CMAKE_CURRENT_SOURCE_DIR}/src/ws_listener.hpp + ${CMAKE_CURRENT_SOURCE_DIR}/src/ws_protocol.hpp) + set(ZMQ_HAVE_WS 1) + + message(STATUS "Enable WebSocket transport") + + option(WITH_TLS "Use TLS for WSS support" ON) + option(WITH_NSS "Use NSS instead of builtin sha1" OFF) + + if(WITH_TLS) + find_package("GnuTLS" 3.6.7) + if(GNUTLS_FOUND) + set(pkg_config_names_private "${pkg_config_names_private} gnutls") + list(APPEND sources ${CMAKE_CURRENT_SOURCE_DIR}/src/wss_address.hpp + ${CMAKE_CURRENT_SOURCE_DIR}/src/wss_address.cpp ${CMAKE_CURRENT_SOURCE_DIR}/src/wss_engine.hpp + ${CMAKE_CURRENT_SOURCE_DIR}/src/wss_engine.cpp) + + message(STATUS "Enable WSS transport") + set(ZMQ_USE_GNUTLS 1) + set(ZMQ_HAVE_WSS 1) + else() + message(WARNING "No WSS support, you may want to install GnuTLS and run cmake again") + endif() + endif() +endif() + +if(NOT ZMQ_USE_GNUTLS) + if(WITH_NSS) + pkg_check_modules(NSS3 "nss") + if(NSS3_FOUND) + set(pkg_config_names_private "${pkg_config_names_private} nss") + message(STATUS "Using NSS") + set(ZMQ_USE_NSS 1) + else() + find_package("NSS3") + if(NSS3_FOUND) + set(pkg_config_libs_private "${pkg_config_libs_private} -lnss3") + message(STATUS "Using NSS") + set(ZMQ_USE_NSS 1) + else() + message(WARNING "No nss installed, if you don't want builtin SHA1, install NSS or GnuTLS") + endif() + endif() + endif() + if(NOT ZMQ_USE_NSS) + list(APPEND sources ${CMAKE_CURRENT_SOURCE_DIR}/external/sha1/sha1.c + ${CMAKE_CURRENT_SOURCE_DIR}/external/sha1/sha1.h) + message(STATUS "Using builtin sha1") + set(ZMQ_USE_BUILTIN_SHA1 1) + endif() +endif() + +if(NOT MSVC) + option(WITH_LIBBSD "Use libbsd instead of builtin strlcpy" ON) + if(WITH_LIBBSD) + pkg_check_modules(LIBBSD "libbsd") + if(LIBBSD_FOUND) + message(STATUS "Using libbsd") + set(pkg_config_names_private "${pkg_config_names_private} libbsd") + set(ZMQ_HAVE_LIBBSD 1) + endif() + endif() + check_cxx_symbol_exists(strlcpy string.h ZMQ_HAVE_STRLCPY) +endif() + +# Select curve encryption library, defaults to tweetnacl To use libsodium instead, use --with-libsodium(must be +# installed) To disable curve, use --disable-curve + +option(WITH_LIBSODIUM "Use libsodium instead of built-in tweetnacl" ON) +option(WITH_LIBSODIUM_STATIC "Use static libsodium library" OFF) +option(ENABLE_CURVE "Enable CURVE security" ON) + +if(ENABLE_CURVE) + if(WITH_LIBSODIUM) + # The package name passed to `find_package_handle_standard_args` (sodium) + # does not match the name of the calling package (Sodium). This can lead to + # problems in calling code that expects `find_package` result variables + # (e.g., `_FOUND`) to follow a certain pattern. + #find_package("Sodium") + find_package("sodium") + if(SODIUM_FOUND) + message(STATUS "Using libsodium for CURVE security") + include_directories(${SODIUM_INCLUDE_DIRS}) + if(WITH_LIBSODIUM_STATIC) + add_compile_definitions(SODIUM_STATIC) + endif() + set(ZMQ_USE_LIBSODIUM 1) + set(ZMQ_HAVE_CURVE 1) + else() + message( + WARNING + "libsodium not installed, instead using builtin tweetnacl, you may want to install libsodium and run cmake again" + ) + endif() + endif() + if(NOT ZMQ_HAVE_CURVE) + message(STATUS "Using tweetnacl for CURVE security") + list(APPEND sources ${CMAKE_CURRENT_SOURCE_DIR}/src/tweetnacl.c) + set(ZMQ_USE_TWEETNACL 1) + set(ZMQ_HAVE_CURVE 1) + endif() +else() + message(STATUS "CURVE security is disabled") +endif() + +set(SOURCE_DIR "${CMAKE_CURRENT_SOURCE_DIR}") + +option(WITH_MILITANT "Enable militant assertions" OFF) +if(WITH_MILITANT) + add_definitions(-DZMQ_ACT_MILITANT) +endif() + +set(API_POLLER + "" + CACHE STRING "Choose polling system for zmq_poll(er)_*. valid values are + poll or select [default=poll unless POLLER=select]") + +set(POLLER + "" + CACHE STRING "Choose polling system for I/O threads. valid values are + kqueue, epoll, devpoll, pollset, poll or select [default=autodetect]") + +if(WIN32) + if(CMAKE_SYSTEM_NAME STREQUAL "WindowsStore" AND CMAKE_SYSTEM_VERSION MATCHES "^10.0") + set(ZMQ_HAVE_WINDOWS_UWP ON) + set(ZMQ_HAVE_IPC OFF) + # to remove compile warninging "D9002 ignoring unknown option" + string(REPLACE "/Zi" "" CMAKE_CXX_FLAGS_DEBUG ${CMAKE_CXX_FLAGS_DEBUG}) + set(CMAKE_CXX_FLAGS_DEBUG + ${CMAKE_CXX_FLAGS_DEBUG} + CACHE STRING "" FORCE) + string(REPLACE "/Zi" "" CMAKE_CXX_FLAGS_RELWITHDEBINFO ${CMAKE_CXX_FLAGS_RELWITHDEBINFO}) + set(CMAKE_CXX_FLAGS_RELWITHDEBINFO + ${CMAKE_CXX_FLAGS_RELWITHDEBINFO} + CACHE STRING "" FORCE) + string(REPLACE "/Zi" "" CMAKE_CXX_FLAGS_DEBUG ${CMAKE_CXX_FLAGS_DEBUG}) + endif() + # from https://stackoverflow.com/a/40217291/2019765 + macro(get_WIN32_WINNT version) + if(CMAKE_SYSTEM_VERSION) + set(ver ${CMAKE_SYSTEM_VERSION}) + string(REGEX MATCH "^([0-9]+).([0-9])" ver ${ver}) + string(REGEX MATCH "^([0-9]+)" verMajor ${ver}) + # Check for Windows 10, b/c we'll need to convert to hex 'A'. + if("${verMajor}" MATCHES "10") + set(verMajor "A") + string(REGEX REPLACE "^([0-9]+)" ${verMajor} ver ${ver}) + endif("${verMajor}" MATCHES "10") + # Remove all remaining '.' characters. + string(REPLACE "." "" ver ${ver}) + # Prepend each digit with a zero. + string(REGEX REPLACE "([0-9A-Z])" "0\\1" ver ${ver}) + set(${version} "0x${ver}") + endif(CMAKE_SYSTEM_VERSION) + endmacro(get_WIN32_WINNT) + + get_win32_winnt(ZMQ_WIN32_WINNT_DEFAULT) + message(STATUS "Detected _WIN32_WINNT from CMAKE_SYSTEM_VERSION: ${ZMQ_WIN32_WINNT_DEFAULT}") + + # TODO limit _WIN32_WINNT to the actual Windows SDK version, which might be different from the default version + # installed with Visual Studio + if(MSVC_VERSION STREQUAL "1500" AND CMAKE_SYSTEM_VERSION VERSION_GREATER "6.0") + set(ZMQ_WIN32_WINNT_LIMIT "0x0600") + elseif(MSVC_VERSION STREQUAL "1600" AND CMAKE_SYSTEM_VERSION VERSION_GREATER "6.1") + set(ZMQ_WIN32_WINNT_LIMIT "0x0601") + elseif(MSVC_VERSION STREQUAL "1700" AND CMAKE_SYSTEM_VERSION VERSION_GREATER "6.1") + set(ZMQ_WIN32_WINNT_LIMIT "0x0601") + elseif(MSVC_VERSION STREQUAL "1800" AND CMAKE_SYSTEM_VERSION VERSION_GREATER "6.2") + set(ZMQ_WIN32_WINNT_LIMIT "0x0602") + endif() + if(ZMQ_WIN32_WINNT_LIMIT) + message( + STATUS + "Mismatch of Visual Studio Version (${MSVC_VERSION}) and CMAKE_SYSTEM_VERSION (${CMAKE_SYSTEM_VERSION}), limiting _WIN32_WINNT to ${ZMQ_WIN32_WINNT_LIMIT}, you may override this by setting ZMQ_WIN32_WINNT" + ) + set(ZMQ_WIN32_WINNT_DEFAULT "${ZMQ_WIN32_WINNT_LIMIT}") + endif() + + set(ZMQ_WIN32_WINNT + "${ZMQ_WIN32_WINNT_DEFAULT}" + CACHE STRING "Value to set _WIN32_WINNT to for building [default=autodetect from build environment]") + + # On Windows Vista or greater, with MSVC 2013 or greater, default to epoll (which is required on Win 10 for ipc + # support) + if(ZMQ_WIN32_WINNT GREATER "0x05FF" + AND MSVC_VERSION GREATER 1799 + AND POLLER STREQUAL "" + AND NOT ZMQ_HAVE_WINDOWS_UWP) + set(POLLER "epoll") + endif() + + add_definitions(-D_WIN32_WINNT=${ZMQ_WIN32_WINNT}) +endif(WIN32) + +if(NOT MSVC) + if(POLLER STREQUAL "") + check_cxx_symbol_exists(kqueue sys/event.h HAVE_KQUEUE) + if(HAVE_KQUEUE) + set(POLLER "kqueue") + endif() + endif() + + if(POLLER STREQUAL "") + check_cxx_symbol_exists(epoll_create sys/epoll.h HAVE_EPOLL) + if(HAVE_EPOLL) + set(POLLER "epoll") + check_cxx_symbol_exists(epoll_create1 sys/epoll.h HAVE_EPOLL_CLOEXEC) + if(HAVE_EPOLL_CLOEXEC) + set(ZMQ_IOTHREAD_POLLER_USE_EPOLL_CLOEXEC 1) + endif() + endif() + endif() + + if(POLLER STREQUAL "") + set(CMAKE_EXTRA_INCLUDE_FILES sys/devpoll.h) + check_type_size("struct pollfd" DEVPOLL) + set(CMAKE_EXTRA_INCLUDE_FILES) + if(HAVE_DEVPOLL) + set(POLLER "devpoll") + endif() + endif() + + if(POLLER STREQUAL "") + check_cxx_symbol_exists(pollset_create sys/pollset.h HAVE_POLLSET) + if(HAVE_POLLSET) + set(POLLER "pollset") + endif() + endif() + + if(POLLER STREQUAL "") + check_cxx_symbol_exists(poll poll.h HAVE_POLL) + if(HAVE_POLL) + set(POLLER "poll") + endif() + endif() +endif() + +if(POLLER STREQUAL "") + if(WIN32) + set(HAVE_SELECT 1) + else() + check_cxx_symbol_exists(select sys/select.h HAVE_SELECT) + endif() + if(HAVE_SELECT) + set(POLLER "select") + else() + message(FATAL_ERROR "Could not autodetect polling method") + endif() +endif() + +if(POLLER STREQUAL "kqueue" + OR POLLER STREQUAL "epoll" + OR POLLER STREQUAL "devpoll" + OR POLLER STREQUAL "pollset" + OR POLLER STREQUAL "poll" + OR POLLER STREQUAL "select") + message(STATUS "Using polling method in I/O threads: ${POLLER}") + string(TOUPPER ${POLLER} UPPER_POLLER) + set(ZMQ_IOTHREAD_POLLER_USE_${UPPER_POLLER} 1) +else() + message(FATAL_ERROR "Invalid polling method") +endif() + +if(POLLER STREQUAL "epoll" AND WIN32) + message(STATUS "Including wepoll") + list(APPEND sources ${CMAKE_CURRENT_SOURCE_DIR}/external/wepoll/wepoll.c + ${CMAKE_CURRENT_SOURCE_DIR}/external/wepoll/wepoll.h) +endif() + +if(API_POLLER STREQUAL "") + if(POLLER STREQUAL "select") + set(API_POLLER "select") + else() + set(API_POLLER "poll") + endif() +endif() + +message(STATUS "Using polling method in zmq_poll(er)_* API: ${API_POLLER}") +string(TOUPPER ${API_POLLER} UPPER_API_POLLER) +set(ZMQ_POLL_BASED_ON_${UPPER_API_POLLER} 1) + +execute_process( + COMMAND getconf LEVEL1_DCACHE_LINESIZE + OUTPUT_VARIABLE CACHELINE_SIZE + ERROR_QUIET OUTPUT_STRIP_TRAILING_WHITESPACE) +if(CACHELINE_SIZE STREQUAL "" + OR CACHELINE_SIZE EQUAL 0 + OR CACHELINE_SIZE EQUAL -1) + set(ZMQ_CACHELINE_SIZE 64) +else() + set(ZMQ_CACHELINE_SIZE ${CACHELINE_SIZE}) +endif() +message(STATUS "Using ${ZMQ_CACHELINE_SIZE} bytes alignment for lock-free data structures") + +if(NOT CYGWIN) + # TODO cannot we simply do 'if(WIN32) set(ZMQ_HAVE_WINDOWS ON)' or similar? + check_include_files(windows.h ZMQ_HAVE_WINDOWS) +endif() + +if(NOT WIN32) + set(ZMQ_HAVE_IPC 1) +else() + check_include_files("winsock2.h;afunix.h" ZMQ_HAVE_IPC) +endif() + +# ##################### BEGIN condition_variable_t selection +if(NOT ZMQ_CV_IMPL) + # prefer C++11 STL std::condition_variable implementation, if available + check_include_files(condition_variable ZMQ_HAVE_STL_CONDITION_VARIABLE LANGUAGE CXX) + + if(ZMQ_HAVE_STL_CONDITION_VARIABLE) + set(ZMQ_CV_IMPL_DEFAULT "stl11") + else() + if(WIN32 AND NOT CMAKE_SYSTEM_VERSION VERSION_LESS "6.0") + # Win32API CONDITION_VARIABLE is supported from Windows Vista only + set(ZMQ_CV_IMPL_DEFAULT "win32api") + elseif(CMAKE_USE_PTHREADS_INIT) + set(ZMQ_CV_IMPL_DEFAULT "pthreads") + else() + set(ZMQ_CV_IMPL_DEFAULT "none") + endif() + endif() + + # TODO a vxworks implementation also exists, but vxworks is not currently supported with cmake at all + set(ZMQ_CV_IMPL + "${ZMQ_CV_IMPL_DEFAULT}" + CACHE STRING "Choose condition_variable_t implementation. Valid values are + stl11, win32api, pthreads, none [default=autodetect]") +endif() + +message(STATUS "Using condition_variable_t implementation: ${ZMQ_CV_IMPL}") +if(ZMQ_CV_IMPL STREQUAL "stl11") + set(ZMQ_USE_CV_IMPL_STL11 1) +elseif(ZMQ_CV_IMPL STREQUAL "win32api") + set(ZMQ_USE_CV_IMPL_WIN32API 1) +elseif(ZMQ_CV_IMPL STREQUAL "pthreads") + set(ZMQ_USE_CV_IMPL_PTHREADS 1) +elseif(ZMQ_CV_IMPL STREQUAL "none") + set(ZMQ_USE_CV_IMPL_NONE 1) +else() + message(ERROR "Unknown value for ZMQ_CV_IMPL: ${ZMQ_CV_IMPL}") +endif() +# ##################### END condition_variable_t selection + +if(NOT MSVC) + check_include_files(ifaddrs.h ZMQ_HAVE_IFADDRS) + check_include_files(sys/uio.h ZMQ_HAVE_UIO) + check_include_files(sys/eventfd.h ZMQ_HAVE_EVENTFD) + if(ZMQ_HAVE_EVENTFD AND NOT CMAKE_CROSSCOMPILING) + zmq_check_efd_cloexec() + endif() +endif() + +if(ZMQ_HAVE_WINDOWS) + # Cannot use check_library_exists because the symbol is always declared as char(*)(void) + set(CMAKE_REQUIRED_LIBRARIES "ws2_32.lib") + check_cxx_symbol_exists(WSAStartup "winsock2.h" HAVE_WS2_32) + + set(CMAKE_REQUIRED_LIBRARIES "rpcrt4.lib") + check_cxx_symbol_exists(UuidCreateSequential "rpc.h" HAVE_RPCRT4) + + set(CMAKE_REQUIRED_LIBRARIES "iphlpapi.lib") + check_cxx_symbol_exists(GetAdaptersAddresses "winsock2.h;iphlpapi.h" HAVE_IPHLAPI) + check_cxx_symbol_exists(if_nametoindex "iphlpapi.h" HAVE_IF_NAMETOINDEX) + + set(CMAKE_REQUIRED_LIBRARIES "") + # TODO: This not the symbol we're looking for. What is the symbol? + check_library_exists(ws2 fopen "" HAVE_WS2) +else() + check_cxx_symbol_exists(if_nametoindex net/if.h HAVE_IF_NAMETOINDEX) + check_cxx_symbol_exists(SO_PEERCRED sys/socket.h ZMQ_HAVE_SO_PEERCRED) + check_cxx_symbol_exists(LOCAL_PEERCRED sys/socket.h ZMQ_HAVE_LOCAL_PEERCRED) +endif() + +if(NOT MINGW) + find_library(RT_LIBRARY rt) + if(RT_LIBRARY) + set(pkg_config_libs_private "${pkg_config_libs_private} -lrt") + endif() +endif() + +find_package(Threads) + +if(WIN32 AND NOT CYGWIN) + if(NOT HAVE_WS2_32 AND NOT HAVE_WS2) + message(FATAL_ERROR "Cannot link to ws2_32 or ws2") + endif() + + if(NOT HAVE_RPCRT4) + message(FATAL_ERROR "Cannot link to rpcrt4") + endif() + + if(NOT HAVE_IPHLAPI) + message(FATAL_ERROR "Cannot link to iphlapi") + endif() +endif() + +if(NOT MSVC) + set(CMAKE_REQUIRED_LIBRARIES rt) + check_cxx_symbol_exists(clock_gettime time.h HAVE_CLOCK_GETTIME) + set(CMAKE_REQUIRED_LIBRARIES) + + check_cxx_symbol_exists(fork unistd.h HAVE_FORK) + check_cxx_symbol_exists(gethrtime sys/time.h HAVE_GETHRTIME) + check_cxx_symbol_exists(mkdtemp stdlib.h HAVE_MKDTEMP) + check_cxx_symbol_exists(accept4 sys/socket.h HAVE_ACCEPT4) + check_cxx_symbol_exists(strnlen string.h HAVE_STRNLEN) +else() + set(HAVE_STRNLEN 1) +endif() + +add_definitions(-D_REENTRANT -D_THREAD_SAFE) +add_definitions(-DZMQ_CUSTOM_PLATFORM_HPP) + +option(ENABLE_EVENTFD "Enable/disable eventfd" ZMQ_HAVE_EVENTFD) + +macro(zmq_check_cxx_flag_prepend flag) + check_cxx_compiler_flag("${flag}" HAVE_FLAG_${flag}) + + if(HAVE_FLAG_${flag}) + set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} ${flag}") + endif() +endmacro() + +option(ENABLE_ANALYSIS "Build with static analysis(make take very long)" OFF) + +if(MSVC) + if(ENABLE_ANALYSIS) + zmq_check_cxx_flag_prepend("/W4") + + zmq_check_cxx_flag_prepend("/analyze") + + # C++11/14/17-specific, but maybe possible via conditional defines + zmq_check_cxx_flag_prepend("/wd26440") # Function '...' can be declared 'noexcept' + zmq_check_cxx_flag_prepend("/wd26432") # If you define or delete any default operation in the type '...', define or + # delete them all + zmq_check_cxx_flag_prepend("/wd26439") # This kind of function may not throw. Declare it 'noexcept' + zmq_check_cxx_flag_prepend("/wd26447") # The function is declared 'noexcept' but calls function '...' which may + # throw exceptions + zmq_check_cxx_flag_prepend("/wd26433") # Function '...' should be marked with 'override' + zmq_check_cxx_flag_prepend("/wd26409") # Avoid calling new and delete explicitly, use std::make_unique instead + # Requires GSL + zmq_check_cxx_flag_prepend("/wd26429") # Symbol '...' is never tested for nullness, it can be marked as not_null + zmq_check_cxx_flag_prepend("/wd26446") # Prefer to use gsl::at() + zmq_check_cxx_flag_prepend("/wd26481") # Don't use pointer arithmetic. Use span instead + zmq_check_cxx_flag_prepend("/wd26472") # Don't use a static_cast for arithmetic conversions. Use brace + # initialization, gsl::narrow_cast or gsl::narow + zmq_check_cxx_flag_prepend("/wd26448") # Consider using gsl::finally if final action is intended + zmq_check_cxx_flag_prepend("/wd26400") # Do not assign the result of an allocation or a function call with an + # owner return value to a raw pointer, use owner instead + zmq_check_cxx_flag_prepend("/wd26485") # Expression '...': No array to pointer decay(bounds.3) + else() + zmq_check_cxx_flag_prepend("/W3") + endif() + + if(MSVC_IDE) + set(MSVC_TOOLSET "-${CMAKE_VS_PLATFORM_TOOLSET}") + else() + set(MSVC_TOOLSET "") + endif() +else() + zmq_check_cxx_flag_prepend("-Wall") +endif() + +if(CMAKE_COMPILER_IS_GNUCXX OR CMAKE_CXX_COMPILER_ID MATCHES "Clang") + zmq_check_cxx_flag_prepend("-Wextra") +endif() + +option(LIBZMQ_PEDANTIC "" ON) +option(LIBZMQ_WERROR "" OFF) + +# TODO: why is -Wno-long-long defined differently than in configure.ac? +if(NOT MSVC) + zmq_check_cxx_flag_prepend("-Wno-long-long") + zmq_check_cxx_flag_prepend("-Wno-uninitialized") + + if(LIBZMQ_PEDANTIC) + zmq_check_cxx_flag_prepend("-pedantic") + + if(${CMAKE_CXX_COMPILER_ID} MATCHES "Intel") + zmq_check_cxx_flag_prepend("-strict-ansi") + endif() + + if(${CMAKE_CXX_COMPILER_ID} MATCHES "SunPro") + zmq_check_cxx_flag_prepend("-compat=5") + endif() + endif() +endif() + +if(LIBZMQ_WERROR) + if(MSVC) + zmq_check_cxx_flag_prepend("/WX") + else() + zmq_check_cxx_flag_prepend("-Werror") + if(NOT "${CMAKE_CXX_COMPILER_ID}" STREQUAL "GNU") + zmq_check_cxx_flag_prepend("-errwarn=%all") + endif() + endif() +endif() + +if(CMAKE_SYSTEM_PROCESSOR MATCHES "^sparc") + zmq_check_cxx_flag_prepend("-mcpu=v9") +endif() + +if(${CMAKE_CXX_COMPILER_ID} MATCHES "SunPro") + zmq_check_cxx_flag_prepend("-features=zla") +endif() + +if(CMAKE_SYSTEM_NAME MATCHES "SunOS" + OR CMAKE_SYSTEM_NAME MATCHES "NetBSD" + OR CMAKE_SYSTEM_NAME MATCHES "QNX") + message(STATUS "Checking whether atomic operations can be used") + check_c_source_compiles( + "\ + #include \ + \ + int main() \ + { \ + uint32_t value; \ + atomic_cas_32(&value, 0, 0); \ + return 0; \ + } \ + " + HAVE_ATOMIC_H) + + if(NOT HAVE_ATOMIC_H) + set(ZMQ_FORCE_MUTEXES 1) + endif() +endif() + +if(NOT ANDROID) + zmq_check_noexcept() +endif() + +# ----------------------------------------------------------------------------- +if(NOT CMAKE_CROSSCOMPILING AND NOT MSVC) + zmq_check_sock_cloexec() + zmq_check_o_cloexec() + zmq_check_so_bindtodevice() + zmq_check_so_keepalive() + zmq_check_so_priority() + zmq_check_tcp_keepcnt() + zmq_check_tcp_keepidle() + zmq_check_tcp_keepintvl() + zmq_check_tcp_keepalive() + zmq_check_tcp_tipc() + zmq_check_pthread_setname() + zmq_check_pthread_setaffinity() + zmq_check_getrandom() +endif() + +if(CMAKE_SYSTEM_NAME MATCHES "Linux" + OR CMAKE_SYSTEM_NAME MATCHES "GNU/kFreeBSD" + OR CMAKE_SYSTEM_NAME MATCHES "GNU/Hurd" + OR CYGWIN) + add_definitions(-D_GNU_SOURCE) +elseif(CMAKE_SYSTEM_NAME MATCHES "FreeBSD") + add_definitions(-D__BSD_VISIBLE) +elseif(CMAKE_SYSTEM_NAME MATCHES "NetBSD") + add_definitions(-D_NETBSD_SOURCE) +elseif(CMAKE_SYSTEM_NAME MATCHES "OpenBSD") + add_definitions(-D_OPENBSD_SOURCE) +elseif(CMAKE_SYSTEM_NAME MATCHES "SunOS") + add_definitions(-D_PTHREADS) +elseif(CMAKE_SYSTEM_NAME MATCHES "HP-UX") + add_definitions(-D_POSIX_C_SOURCE=200112L) + zmq_check_cxx_flag_prepend(-Ae) +elseif(CMAKE_SYSTEM_NAME MATCHES "Darwin") + add_definitions(-D_DARWIN_C_SOURCE) +endif() + +find_package(AsciiDoc) + +cmake_dependent_option(WITH_DOC "Build Reference Guide documentation(requires DocBook)" ON "ASCIIDOC_FOUND;NOT WIN32" + OFF) # Do not build docs on Windows due to issues with symlinks + +if(MSVC) + if(WITH_OPENPGM) + # set(OPENPGM_ROOT "" CACHE PATH "Location of OpenPGM") + set(OPENPGM_VERSION_MAJOR 5) + set(OPENPGM_VERSION_MINOR 2) + set(OPENPGM_VERSION_MICRO 122) + if(CMAKE_CL_64) + find_path( + OPENPGM_ROOT include/pgm/pgm.h + PATHS + "[HKEY_LOCAL_MACHINE\\SOFTWARE\\Miru\\OpenPGM ${OPENPGM_VERSION_MAJOR}.${OPENPGM_VERSION_MINOR}.${OPENPGM_VERSION_MICRO}]" + NO_DEFAULT_PATH) + message(STATUS "OpenPGM x64 detected - ${OPENPGM_ROOT}") + else() + find_path( + OPENPGM_ROOT include/pgm/pgm.h + PATHS + "[HKEY_LOCAL_MACHINE\\SOFTWARE\\Wow6432Node\\Miru\\OpenPGM ${OPENPGM_VERSION_MAJOR}.${OPENPGM_VERSION_MINOR}.${OPENPGM_VERSION_MICRO}]" + "[HKEY_LOCAL_MACHINE\\SOFTWARE\\Miru\\OpenPGM ${OPENPGM_VERSION_MAJOR}.${OPENPGM_VERSION_MINOR}.${OPENPGM_VERSION_MICRO}]" + NO_DEFAULT_PATH) + message(STATUS "OpenPGM x86 detected - ${OPENPGM_ROOT}") + endif() + set(OPENPGM_INCLUDE_DIRS ${OPENPGM_ROOT}/include) + set(OPENPGM_LIBRARY_DIRS ${OPENPGM_ROOT}/lib) + set(OPENPGM_LIBRARIES + optimized + libpgm${MSVC_TOOLSET}-mt-${OPENPGM_VERSION_MAJOR}_${OPENPGM_VERSION_MINOR}_${OPENPGM_VERSION_MICRO}.lib debug + libpgm${MSVC_TOOLSET}-mt-gd-${OPENPGM_VERSION_MAJOR}_${OPENPGM_VERSION_MINOR}_${OPENPGM_VERSION_MICRO}.lib) + endif() +else() + if(WITH_OPENPGM) + # message(FATAL_ERROR "WITH_OPENPGM not implemented") + + if(NOT OPENPGM_PKGCONFIG_NAME) + set(OPENPGM_PKGCONFIG_NAME "openpgm-5.2") + endif() + + set(OPENPGM_PKGCONFIG_NAME + ${OPENPGM_PKGCONFIG_NAME} + CACHE STRING "Name pkg-config shall use to find openpgm libraries and include paths" FORCE) + + pkg_check_modules(OPENPGM ${OPENPGM_PKGCONFIG_NAME}) + + if(OPENPGM_FOUND) + message(STATUS ${OPENPGM_PKGCONFIG_NAME}" found") + set(pkg_config_names_private "${pkg_config_names_private} ${OPENPGM_PKGCONFIG_NAME}") + else() + message( + FATAL_ERROR + ${OPENPGM_PKGCONFIG_NAME}" not found. openpgm is searchd via `pkg-config ${OPENPGM_PKGCONFIG_NAME}`. Consider providing a valid OPENPGM_PKGCONFIG_NAME" + ) + endif() + + # DSO symbol visibility for openpgm + if(HAVE_FLAG_VISIBILITY_HIDDEN) + + elseif(HAVE_FLAG_LDSCOPE_HIDDEN) + + endif() + endif() +endif() + +# ----------------------------------------------------------------------------- +# force off-tree build + +if(${CMAKE_CURRENT_SOURCE_DIR} STREQUAL ${CMAKE_CURRENT_BINARY_DIR}) + message( + FATAL_ERROR + "CMake generation is not allowed within the source directory! \ + Remove the CMakeCache.txt file and try again from another folder, e.g.: \ + \ + rm CMakeCache.txt \ + mkdir cmake-make \ + cd cmake-make \ + cmake ..") +endif() + +# ----------------------------------------------------------------------------- +# default to Release build + +if(NOT CMAKE_BUILD_TYPE AND NOT CMAKE_CONFIGURATION_TYPES) + # CMAKE_BUILD_TYPE is not used for multi-configuration generators like Visual Studio/XCode which instead use + # CMAKE_CONFIGURATION_TYPES + set(CMAKE_BUILD_TYPE + Release + CACHE STRING "Choose the type of build, options are: None Debug Release RelWithDebInfo MinSizeRel." FORCE) +endif() + +# ----------------------------------------------------------------------------- +# output directories + +zmq_set_with_default(CMAKE_RUNTIME_OUTPUT_DIRECTORY "${ZeroMQ_BINARY_DIR}/bin") +if(UNIX) + set(zmq_library_directory "lib") +else() + set(zmq_library_directory "bin") +endif() +zmq_set_with_default(CMAKE_LIBRARY_OUTPUT_DIRECTORY "${ZeroMQ_BINARY_DIR}/${zmq_library_directory}") +zmq_set_with_default(CMAKE_ARCHIVE_OUTPUT_DIRECTORY "${ZeroMQ_BINARY_DIR}/lib") + +# ----------------------------------------------------------------------------- +# platform specifics + +if(WIN32) + # Socket limit is 16K(can be raised arbitrarily) + add_definitions(-DFD_SETSIZE=16384) + add_definitions(-D_CRT_SECURE_NO_WARNINGS) + add_definitions(-D_WINSOCK_DEPRECATED_NO_WARNINGS) +endif() + +if(MSVC) + # Parallel make. + set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} /MP") + set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} /MP") + + # Compile the static lib with debug information included note: we assume here that the default flags contain some /Z + # flag + string(REGEX REPLACE "/Z.[^:]" "/Z7 " CMAKE_CXX_FLAGS_DEBUG "${CMAKE_CXX_FLAGS_DEBUG}") + string(REGEX REPLACE "/Z.[^:]" "/Z7 " CMAKE_CXX_FLAGS_RELWITHDEBINFO "${CMAKE_CXX_FLAGS_RELWITHDEBINFO}") + + # Optimization flags. http://msdn.microsoft.com/en-us/magazine/cc301698.aspx + if(NOT ${CMAKE_BUILD_TYPE} MATCHES "Debug") + set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} /GL") + set(CMAKE_EXE_LINKER_FLAGS "${CMAKE_EXE_LINKER_FLAGS} /LTCG") + set(CMAKE_SHARED_LINKER_FLAGS "${CMAKE_SHARED_LINKER_FLAGS} /LTCG") + set(CMAKE_MODULE_LINKER_FLAGS "${CMAKE_MODULE_LINKER_FLAGS} /LTCG") + endif() +endif() + +# ----------------------------------------------------------------------------- +# source files + +set(cxx-sources + precompiled.cpp + address.cpp + channel.cpp + client.cpp + clock.cpp + ctx.cpp + curve_mechanism_base.cpp + curve_client.cpp + curve_server.cpp + dealer.cpp + devpoll.cpp + dgram.cpp + dist.cpp + endpoint.cpp + epoll.cpp + err.cpp + fq.cpp + io_object.cpp + io_thread.cpp + ip.cpp + ipc_address.cpp + ipc_connecter.cpp + ipc_listener.cpp + kqueue.cpp + lb.cpp + mailbox.cpp + mailbox_safe.cpp + mechanism.cpp + mechanism_base.cpp + metadata.cpp + msg.cpp + mtrie.cpp + norm_engine.cpp + object.cpp + options.cpp + own.cpp + null_mechanism.cpp + pair.cpp + peer.cpp + pgm_receiver.cpp + pgm_sender.cpp + pgm_socket.cpp + pipe.cpp + plain_client.cpp + plain_server.cpp + poll.cpp + poller_base.cpp + polling_util.cpp + pollset.cpp + proxy.cpp + pub.cpp + pull.cpp + push.cpp + random.cpp + raw_encoder.cpp + raw_decoder.cpp + raw_engine.cpp + reaper.cpp + rep.cpp + req.cpp + router.cpp + select.cpp + server.cpp + session_base.cpp + signaler.cpp + socket_base.cpp + socks.cpp + socks_connecter.cpp + stream.cpp + stream_engine_base.cpp + sub.cpp + tcp.cpp + tcp_address.cpp + tcp_connecter.cpp + tcp_listener.cpp + thread.cpp + trie.cpp + radix_tree.cpp + v1_decoder.cpp + v1_encoder.cpp + v2_decoder.cpp + v2_encoder.cpp + v3_1_encoder.cpp + xpub.cpp + xsub.cpp + zmq.cpp + zmq_utils.cpp + decoder_allocators.cpp + socket_poller.cpp + timers.cpp + config.hpp + radio.cpp + dish.cpp + udp_engine.cpp + udp_address.cpp + scatter.cpp + gather.cpp + ip_resolver.cpp + zap_client.cpp + zmtp_engine.cpp + # at least for VS, the header files must also be listed + address.hpp + array.hpp + atomic_counter.hpp + atomic_ptr.hpp + blob.hpp + channel.hpp + client.hpp + clock.hpp + command.hpp + compat.hpp + condition_variable.hpp + config.hpp + ctx.hpp + curve_client.hpp + curve_client_tools.hpp + curve_mechanism_base.hpp + curve_server.hpp + dbuffer.hpp + dealer.hpp + decoder.hpp + decoder_allocators.hpp + devpoll.hpp + dgram.hpp + dish.hpp + dist.hpp + encoder.hpp + endpoint.hpp + epoll.hpp + err.hpp + fd.hpp + fq.hpp + gather.hpp + generic_mtrie.hpp + generic_mtrie_impl.hpp + gssapi_client.hpp + gssapi_mechanism_base.hpp + gssapi_server.hpp + i_decoder.hpp + i_encoder.hpp + i_engine.hpp + i_mailbox.hpp + i_poll_events.hpp + io_object.hpp + io_thread.hpp + ip.hpp + ipc_address.hpp + ipc_connecter.hpp + ipc_listener.hpp + kqueue.hpp + lb.hpp + likely.hpp + macros.hpp + mailbox.hpp + mailbox_safe.hpp + mechanism.hpp + mechanism_base.hpp + metadata.hpp + msg.hpp + mtrie.hpp + mutex.hpp + norm_engine.hpp + null_mechanism.hpp + object.hpp + options.hpp + own.hpp + pair.hpp + peer.hpp + pgm_receiver.hpp + pgm_sender.hpp + pgm_socket.hpp + pipe.hpp + plain_client.hpp + plain_common.hpp + plain_server.hpp + poll.hpp + poller.hpp + poller_base.hpp + polling_util.hpp + pollset.hpp + precompiled.hpp + proxy.hpp + pub.hpp + pull.hpp + push.hpp + radio.hpp + random.hpp + raw_decoder.hpp + raw_encoder.hpp + raw_engine.hpp + reaper.hpp + rep.hpp + req.hpp + router.hpp + scatter.hpp + secure_allocator.hpp + select.hpp + server.hpp + session_base.hpp + signaler.hpp + socket_base.hpp + socket_poller.hpp + socks.hpp + socks_connecter.hpp + stdint.hpp + stream.hpp + stream_engine_base.hpp + stream_connecter_base.hpp + stream_connecter_base.cpp + stream_listener_base.hpp + stream_listener_base.cpp + sub.hpp + tcp.hpp + tcp_address.hpp + tcp_connecter.hpp + tcp_listener.hpp + thread.hpp + timers.hpp + tipc_address.hpp + tipc_connecter.hpp + tipc_listener.hpp + trie.hpp + udp_address.hpp + udp_engine.hpp + v1_decoder.hpp + v1_encoder.hpp + v2_decoder.hpp + v2_encoder.hpp + v3_1_encoder.hpp + v2_protocol.hpp + vmci.hpp + vmci_address.hpp + vmci_connecter.hpp + vmci_listener.hpp + windows.hpp + wire.hpp + xpub.hpp + xsub.hpp + ypipe.hpp + ypipe_base.hpp + ypipe_conflate.hpp + yqueue.hpp + zap_client.hpp + zmtp_engine.hpp) + +if(MINGW) + # Generate the right type when using -m32 or -m64 + macro(set_rc_arch rc_target) + set(CMAKE_RC_COMPILER_INIT windres) + enable_language(RC) + set(CMAKE_RC_COMPILE_OBJECT + " -O coff --target=${rc_target} -i -o ") + endmacro() + + if(NOT CMAKE_SYSTEM_PROCESSOR) + set(CMAKE_SYSTEM_PROCESSOR ${CMAKE_HOST_SYSTEM_PROCESSOR}) + endif() + + # Also happens on x86_64 systems...what a worthless variable + if(CMAKE_SYSTEM_PROCESSOR MATCHES "i386" + OR CMAKE_SYSTEM_PROCESSOR MATCHES "i486" + OR CMAKE_SYSTEM_PROCESSOR MATCHES "i586" + OR CMAKE_SYSTEM_PROCESSOR MATCHES "i686" + OR CMAKE_SYSTEM_PROCESSOR MATCHES "x86" + OR CMAKE_SYSTEM_PROCESSOR MATCHES "x86_64" + OR CMAKE_SYSTEM_PROCESSOR MATCHES "amd64") + + if(CMAKE_SIZEOF_VOID_P EQUAL 8) + set_rc_arch("pe-x86-64") + else() + set_rc_arch("pe-i386") + endif() + endif() +endif() + +set(public_headers include/zmq.h include/zmq_utils.h) + +set(readme-docs AUTHORS COPYING COPYING.LESSER NEWS) + +# ----------------------------------------------------------------------------- +# optional modules + +if(WITH_OPENPGM) + add_definitions(-DZMQ_HAVE_OPENPGM) + include_directories(${OPENPGM_INCLUDE_DIRS}) + link_directories(${OPENPGM_LIBRARY_DIRS}) + set(OPTIONAL_LIBRARIES ${OPENPGM_LIBRARIES}) +endif() + +if(WITH_NORM) + find_package(norm) + if(norm_FOUND) + message(STATUS "Building with NORM") + set(ZMQ_HAVE_NORM 1) + else() + message(FATAL_ERROR "NORM not found") + endif() +endif() + +if(WITH_VMCI) + add_definitions(-DZMQ_HAVE_VMCI) + include_directories(${VMCI_INCLUDE_DIRS}) + list(APPEND cxx-sources vmci_address.cpp vmci_connecter.cpp vmci_listener.cpp vmci.cpp) +endif() + +if(ZMQ_HAVE_TIPC) + list(APPEND cxx-sources tipc_address.cpp tipc_connecter.cpp tipc_listener.cpp) +endif() + +# ----------------------------------------------------------------------------- +# source generators + +foreach(source ${cxx-sources}) + list(APPEND sources ${CMAKE_CURRENT_SOURCE_DIR}/src/${source}) +endforeach() + +configure_file(${CMAKE_CURRENT_SOURCE_DIR}/src/version.rc.in ${CMAKE_CURRENT_BINARY_DIR}/version.rc) + +# Delete any src/platform.hpp left by configure +file(REMOVE ${CMAKE_CURRENT_SOURCE_DIR}/src/platform.hpp) + +configure_file(${CMAKE_CURRENT_SOURCE_DIR}/builds/cmake/platform.hpp.in ${CMAKE_CURRENT_BINARY_DIR}/platform.hpp) +list(APPEND sources ${CMAKE_CURRENT_BINARY_DIR}/platform.hpp) + +set(prefix ${CMAKE_INSTALL_PREFIX}) +set(exec_prefix ${prefix}) +set(libdir ${prefix}/lib) +set(includedir ${prefix}/include) +set(VERSION ${ZMQ_VERSION_MAJOR}.${ZMQ_VERSION_MINOR}.${ZMQ_VERSION_PATCH}) +configure_file(${CMAKE_CURRENT_SOURCE_DIR}/src/libzmq.pc.in ${CMAKE_CURRENT_BINARY_DIR}/libzmq.pc @ONLY) +set(zmq-pkgconfig ${CMAKE_CURRENT_BINARY_DIR}/libzmq.pc) + +if(NOT ZMQ_BUILD_FRAMEWORK) + install(FILES ${CMAKE_CURRENT_BINARY_DIR}/libzmq.pc DESTINATION ${CMAKE_INSTALL_LIBDIR}/pkgconfig) +endif() + +if(MSVC) + if(CMAKE_CL_64) + set(nsis-template ${CMAKE_CURRENT_SOURCE_DIR}/builds/cmake/NSIS.template64.in) + else() + set(nsis-template ${CMAKE_CURRENT_SOURCE_DIR}/builds/cmake/NSIS.template32.in) + endif() + + add_custom_command( + OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/NSIS.template.in + COMMAND ${CMAKE_COMMAND} ARGS -E copy ${nsis-template} ${CMAKE_CURRENT_BINARY_DIR}/NSIS.template.in + DEPENDS ${nsis-template}) +endif() + +option(WITH_DOCS "Build html docs" ON) +if(WITH_DOCS) + file(MAKE_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/doc) + file( + GLOB docs + RELATIVE ${CMAKE_CURRENT_BINARY_DIR}/ + "${CMAKE_CURRENT_SOURCE_DIR}/doc/*.txt") + set(html-docs) + foreach(txt ${docs}) + string(REGEX REPLACE ".*/(.*)\\.txt" "\\1.html" html ${txt}) + set(src ${txt}) + set(dst doc/${html}) + if(WITH_DOC) + add_custom_command( + OUTPUT ${dst} + COMMAND ${ASCIIDOC_EXECUTABLE} -d manpage -b xhtml11 -f ${CMAKE_CURRENT_SOURCE_DIR}/doc/asciidoc.conf + -azmq_version=${ZMQ_VERSION} -o ${dst} ${src} + DEPENDS ${CMAKE_CURRENT_BINARY_DIR}/${src} + WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR} + COMMENT "Generating ${html}") + list(APPEND html-docs ${CMAKE_CURRENT_BINARY_DIR}/${dst}) + endif() + endforeach() +endif() + +if(ZMQ_BUILD_FRAMEWORK) + add_custom_command( + TARGET libzmq + POST_BUILD + COMMAND ${CMAKE_COMMAND} ARGS -E make_directory + "${CMAKE_LIBRARY_OUTPUT_PATH}/ZeroMQ.framework/Versions/${ZMQ_VERSION}/MacOS" + COMMENT "Perf tools") +endif() + +option(ENABLE_PRECOMPILED "Enable precompiled headers, if possible" ON) +if(MSVC AND ENABLE_PRECOMPILED) + # default for all sources is to use precompiled headers + foreach(source ${sources}) + # C and C++ can not use the same precompiled header + if(${source} MATCHES ".cpp$" AND NOT ${source} STREQUAL "${CMAKE_CURRENT_SOURCE_DIR}/src/precompiled.cpp") + set_source_files_properties(${source} PROPERTIES COMPILE_FLAGS "/Yuprecompiled.hpp" OBJECT_DEPENDS + precompiled.hpp) + endif() + endforeach() + # create precompiled header + set_source_files_properties(${CMAKE_CURRENT_SOURCE_DIR}/src/precompiled.cpp + PROPERTIES COMPILE_FLAGS "/Ycprecompiled.hpp" OBJECT_OUTPUTS precompiled.hpp) +endif() + +# ----------------------------------------------------------------------------- +# output +option(BUILD_SHARED "Whether or not to build the shared object" ON) +option(BUILD_STATIC "Whether or not to build the static archive" ON) + +if(MSVC) + # Suppress linker warnings caused by #ifdef omission of file content. + set(CMAKE_STATIC_LINKER_FLAGS "${CMAKE_STATIC_LINKER_FLAGS} /ignore:4221") + set(PDB_OUTPUT_DIRECTORY "${CMAKE_CURRENT_BINARY_DIR}/bin") + set(PDB_NAME + "lib${ZMQ_OUTPUT_BASENAME}${MSVC_TOOLSET}-mt-gd-${ZMQ_VERSION_MAJOR}_${ZMQ_VERSION_MINOR}_${ZMQ_VERSION_PATCH}") + function(enable_vs_guideline_checker target) + set_target_properties( + ${target} PROPERTIES VS_GLOBAL_EnableCppCoreCheck true VS_GLOBAL_CodeAnalysisRuleSet CppCoreCheckRules.ruleset + VS_GLOBAL_RunCodeAnalysis true) + endfunction() + if(BUILD_SHARED) + add_library(libzmq SHARED ${sources} ${public_headers} ${html-docs} ${readme-docs} + ${CMAKE_CURRENT_BINARY_DIR}/NSIS.template.in ${CMAKE_CURRENT_BINARY_DIR}/version.rc) + if(ENABLE_ANALYSIS) + enable_vs_guideline_checker(libzmq) + endif() + set_target_properties( + libzmq + PROPERTIES PUBLIC_HEADER "${public_headers}" + RELEASE_POSTFIX "${MSVC_TOOLSET}-mt-${ZMQ_VERSION_MAJOR}_${ZMQ_VERSION_MINOR}_${ZMQ_VERSION_PATCH}" + RELWITHDEBINFO_POSTFIX + "${MSVC_TOOLSET}-mt-${ZMQ_VERSION_MAJOR}_${ZMQ_VERSION_MINOR}_${ZMQ_VERSION_PATCH}" + MINSIZEREL_POSTFIX "${MSVC_TOOLSET}-mt-${ZMQ_VERSION_MAJOR}_${ZMQ_VERSION_MINOR}_${ZMQ_VERSION_PATCH}" + DEBUG_POSTFIX "${MSVC_TOOLSET}-mt-gd-${ZMQ_VERSION_MAJOR}_${ZMQ_VERSION_MINOR}_${ZMQ_VERSION_PATCH}" + RUNTIME_OUTPUT_DIRECTORY "${CMAKE_RUNTIME_OUTPUT_DIRECTORY}" + COMPILE_DEFINITIONS "DLL_EXPORT" + OUTPUT_NAME "lib${ZMQ_OUTPUT_BASENAME}") + if(ZMQ_HAVE_WINDOWS_UWP) + set_target_properties(libzmq PROPERTIES LINK_FLAGS_DEBUG "/OPT:NOICF /OPT:NOREF") + endif() + endif() + + if(BUILD_STATIC) + add_library(libzmq-static STATIC ${sources} ${CMAKE_CURRENT_BINARY_DIR}/version.rc) + set_target_properties( + libzmq-static + PROPERTIES PUBLIC_HEADER "${public_headers}" + RELEASE_POSTFIX "${MSVC_TOOLSET}-mt-s-${ZMQ_VERSION_MAJOR}_${ZMQ_VERSION_MINOR}_${ZMQ_VERSION_PATCH}" + RELWITHDEBINFO_POSTFIX + "${MSVC_TOOLSET}-mt-s-${ZMQ_VERSION_MAJOR}_${ZMQ_VERSION_MINOR}_${ZMQ_VERSION_PATCH}" + MINSIZEREL_POSTFIX + "${MSVC_TOOLSET}-mt-s-${ZMQ_VERSION_MAJOR}_${ZMQ_VERSION_MINOR}_${ZMQ_VERSION_PATCH}" + DEBUG_POSTFIX "${MSVC_TOOLSET}-mt-sgd-${ZMQ_VERSION_MAJOR}_${ZMQ_VERSION_MINOR}_${ZMQ_VERSION_PATCH}" + COMPILE_FLAGS "/DZMQ_STATIC" + OUTPUT_NAME "lib${ZMQ_OUTPUT_BASENAME}") + endif() +else() + # avoid building everything twice for shared + static only on *nix, as Windows needs different preprocessor defines in + # static builds + if(NOT MINGW) + add_library(objects OBJECT ${sources}) + set_property(TARGET objects PROPERTY POSITION_INDEPENDENT_CODE ON) + target_include_directories( + objects PUBLIC $ + $ $) + endif() + + if(BUILD_SHARED) + if(MINGW) + add_library(libzmq SHARED ${sources} ${public_headers} ${html-docs} ${readme-docs} ${zmq-pkgconfig} + ${CMAKE_CURRENT_BINARY_DIR}/version.rc) + else() + if (CMAKE_GENERATOR STREQUAL "Xcode") + add_library(libzmq SHARED ${sources} ${public_headers} ${html-docs} ${readme-docs} + ${zmq-pkgconfig} ${CMAKE_CURRENT_BINARY_DIR}/version.rc) + else() + add_library(libzmq SHARED $ ${public_headers} ${html-docs} ${readme-docs} + ${zmq-pkgconfig} ${CMAKE_CURRENT_BINARY_DIR}/version.rc) + endif() + + endif() + # NOTE: the SOVERSION and VERSION MUST be the same as the one generated by libtool! It is NOT the same as the + # version of the package. + set_target_properties( + libzmq PROPERTIES COMPILE_DEFINITIONS "DLL_EXPORT" PUBLIC_HEADER "${public_headers}" VERSION "5.2.5" + SOVERSION "5" OUTPUT_NAME "${ZMQ_OUTPUT_BASENAME}" PREFIX "lib") + if(ZMQ_BUILD_FRAMEWORK) + set_target_properties( + libzmq + PROPERTIES FRAMEWORK TRUE MACOSX_FRAMEWORK_IDENTIFIER "org.zeromq.libzmq" MACOSX_FRAMEWORK_SHORT_VERSION_STRING + ${ZMQ_VERSION} + MACOSX_FRAMEWORK_BUNDLE_VERSION ${ZMQ_VERSION}) + set_source_files_properties(${html-docs} PROPERTIES MACOSX_PACKAGE_LOCATION doc) + set_source_files_properties(${readme-docs} PROPERTIES MACOSX_PACKAGE_LOCATION etc) + set_source_files_properties(${zmq-pkgconfig} PROPERTIES MACOSX_PACKAGE_LOCATION lib/pkgconfig) + endif() + endif() + + if(BUILD_STATIC) + if(MINGW) + add_library(libzmq-static STATIC ${sources} ${public_headers} ${html-docs} ${readme-docs} ${zmq-pkgconfig} + ${CMAKE_CURRENT_BINARY_DIR}/version.rc) + else() + if (CMAKE_GENERATOR STREQUAL "Xcode") + add_library(libzmq-static STATIC ${sources} ${public_headers} ${html-docs} ${readme-docs} + ${zmq-pkgconfig} ${CMAKE_CURRENT_BINARY_DIR}/version.rc) + else() + add_library(libzmq-static STATIC $ ${public_headers} ${html-docs} ${readme-docs} + ${zmq-pkgconfig} ${CMAKE_CURRENT_BINARY_DIR}/version.rc) + endif() + endif() + if(CMAKE_SYSTEM_NAME MATCHES "QNX") + target_link_libraries(libzmq-static m) + endif() + set_target_properties( + libzmq-static PROPERTIES PUBLIC_HEADER "${public_headers}" OUTPUT_NAME "${ZMQ_OUTPUT_BASENAME}" PREFIX "lib") + endif() +endif() + +if(BUILD_STATIC) + target_compile_definitions(libzmq-static PUBLIC ZMQ_STATIC) +endif() + +list(APPEND target_outputs "") + +if(BUILD_SHARED) + list(APPEND target_outputs "libzmq") +endif() + +if(BUILD_STATIC) + list(APPEND target_outputs "libzmq-static") +endif() + +foreach(target ${target_outputs}) + target_include_directories( + ${target} PUBLIC $ + $ $) +endforeach() + +if(BUILD_SHARED) + target_link_libraries(libzmq ${CMAKE_THREAD_LIBS_INIT}) + if(GNUTLS_FOUND) + target_link_libraries(libzmq ${GNUTLS_LIBRARIES}) + endif() + + if(NSS3_FOUND) + target_link_libraries(libzmq ${NSS3_LIBRARIES}) + endif() + + if(LIBBSD_FOUND) + target_link_libraries(libzmq ${LIBBSD_LIBRARIES}) + endif() + + if(SODIUM_FOUND) + target_link_libraries(libzmq ${SODIUM_LIBRARIES}) + # On Solaris, libsodium depends on libssp + if(${CMAKE_SYSTEM_NAME} MATCHES "SunOS") + target_link_libraries(libzmq ssp) + endif() + endif() + + if(HAVE_WS2_32) + target_link_libraries(libzmq ws2_32) + elseif(HAVE_WS2) + target_link_libraries(libzmq ws2) + endif() + + if(HAVE_RPCRT4) + target_link_libraries(libzmq rpcrt4) + endif() + + if(HAVE_IPHLAPI) + target_link_libraries(libzmq iphlpapi) + endif() + + if(RT_LIBRARY) + target_link_libraries(libzmq -lrt) + endif() + + if(norm_FOUND) + target_link_libraries(libzmq norm::norm) + endif() +endif() + +if(BUILD_STATIC) + target_link_libraries(libzmq-static ${CMAKE_THREAD_LIBS_INIT}) + if(GNUTLS_FOUND) + target_link_libraries(libzmq-static ${GNUTLS_LIBRARIES}) + endif() + + if(LIBBSD_FOUND) + target_link_libraries(libzmq-static ${LIBBSD_LIBRARIES}) + endif() + + if(NSS3_FOUND) + target_link_libraries(libzmq-static ${NSS3_LIBRARIES}) + endif() + + if(SODIUM_FOUND) + target_link_libraries(libzmq-static ${SODIUM_LIBRARIES}) + # On Solaris, libsodium depends on libssp + if(${CMAKE_SYSTEM_NAME} MATCHES "SunOS") + target_link_libraries(libzmq-static ssp) + endif() + endif() + + if(HAVE_WS2_32) + target_link_libraries(libzmq-static ws2_32) + elseif(HAVE_WS2) + target_link_libraries(libzmq-static ws2) + endif() + + if(HAVE_RPCRT4) + target_link_libraries(libzmq-static rpcrt4) + endif() + + if(HAVE_IPHLAPI) + target_link_libraries(libzmq-static iphlpapi) + endif() + + if(RT_LIBRARY) + target_link_libraries(libzmq-static -lrt) + endif() + + if(CMAKE_SYSTEM_NAME MATCHES "QNX") + add_definitions(-DUNITY_EXCLUDE_MATH_H) + endif() + + if(norm_FOUND) + target_link_libraries(libzmq-static norm::norm) + endif() +endif() + +if(BUILD_SHARED) + set(perf-tools + local_lat + remote_lat + local_thr + remote_thr + inproc_lat + inproc_thr + proxy_thr) + + if(NOT CMAKE_BUILD_TYPE STREQUAL "Debug") # Why? + option(WITH_PERF_TOOL "Build with perf-tools" ON) + else() + option(WITH_PERF_TOOL "Build with perf-tools" OFF) + endif() + + if(WITH_PERF_TOOL) + foreach(perf-tool ${perf-tools}) + add_executable(${perf-tool} perf/${perf-tool}.cpp) + target_link_libraries(${perf-tool} libzmq) + + if(GNUTLS_FOUND) + target_link_libraries(${perf-tool} ${GNUTLS_LIBRARIES}) + endif() + + if(LIBBSD_FOUND) + target_link_libraries(${perf-tool} ${LIBBSD_LIBRARIES}) + endif() + + if(NSS3_FOUND) + target_link_libraries(${perf-tool} ${NSS3_LIBRARIES}) + endif() + + if(SODIUM_FOUND) + target_link_libraries(${perf-tool} ${SODIUM_LIBRARIES}) + endif() + + if(ZMQ_BUILD_FRAMEWORK) + # Copy perf-tools binaries into Framework + add_custom_command( + TARGET libzmq + ${perf-tool} POST_BUILD + COMMAND ${CMAKE_COMMAND} ARGS -E copy "$" + "${LIBRARY_OUTPUT_PATH}/ZeroMQ.framework/Versions/${ZMQ_VERSION_STRING}/MacOS/${perf-tool}" + VERBATIM + COMMENT "Perf tools") + else() + install(TARGETS ${perf-tool} RUNTIME DESTINATION bin COMPONENT PerfTools) + endif() + if(ZMQ_HAVE_WINDOWS_UWP) + set_target_properties(${perf-tool} PROPERTIES LINK_FLAGS_DEBUG "/OPT:NOICF /OPT:NOREF") + endif() + endforeach() + + if(BUILD_STATIC) + add_executable(benchmark_radix_tree perf/benchmark_radix_tree.cpp) + target_link_libraries(benchmark_radix_tree libzmq-static) + target_include_directories(benchmark_radix_tree PUBLIC "${CMAKE_CURRENT_LIST_DIR}/src") + if(ZMQ_HAVE_WINDOWS_UWP) + set_target_properties(benchmark_radix_tree PROPERTIES LINK_FLAGS_DEBUG "/OPT:NOICF /OPT:NOREF") + endif() + endif() + elseif(WITH_PERF_TOOL) + message(FATAL_ERROR "Shared library disabled - perf-tools unavailable.") + endif() +endif() + +# ----------------------------------------------------------------------------- +# tests + +option(BUILD_TESTS "Whether or not to build the tests" ON) + +set(ZMQ_BUILD_TESTS + ${BUILD_TESTS} + CACHE BOOL "Build the tests for ZeroMQ") + +if(ZMQ_BUILD_TESTS) + enable_testing() # Enable testing only works in root scope + add_subdirectory(tests) + if(BUILD_STATIC) + add_subdirectory(unittests) + else() + message(WARNING "Not building unit tests, since BUILD_STATIC is not enabled") + endif() +endif() + +# ----------------------------------------------------------------------------- +# installer + +if(MSVC AND (BUILD_SHARED OR BUILD_STATIC)) + install( + TARGETS ${target_outputs} + EXPORT ${PROJECT_NAME}-targets + ARCHIVE DESTINATION ${CMAKE_INSTALL_LIBDIR} + LIBRARY DESTINATION ${CMAKE_INSTALL_LIBDIR} + RUNTIME DESTINATION ${CMAKE_INSTALL_BINDIR} + PUBLIC_HEADER DESTINATION ${CMAKE_INSTALL_INCLUDEDIR} COMPONENT SDK) + if(MSVC_IDE) + install( + FILES ${PDB_OUTPUT_DIRECTORY}/\${CMAKE_INSTALL_CONFIG_NAME}/${PDB_NAME}.pdb + DESTINATION ${CMAKE_INSTALL_BINDIR} + COMPONENT SDK + OPTIONAL) + else() + install( + FILES ${PDB_OUTPUT_DIRECTORY}/${PDB_NAME}.pdb + DESTINATION ${CMAKE_INSTALL_BINDIR} + COMPONENT SDK + OPTIONAL) + endif() + if(BUILD_SHARED) + install( + TARGETS libzmq + RUNTIME DESTINATION ${CMAKE_INSTALL_BINDIR} + PUBLIC_HEADER DESTINATION ${CMAKE_INSTALL_INCLUDEDIR} COMPONENT Runtime) + endif() +elseif(BUILD_SHARED OR BUILD_STATIC) + install( + TARGETS ${target_outputs} + EXPORT ${PROJECT_NAME}-targets + RUNTIME DESTINATION ${CMAKE_INSTALL_BINDIR} + ARCHIVE DESTINATION ${CMAKE_INSTALL_LIBDIR} + LIBRARY DESTINATION ${CMAKE_INSTALL_LIBDIR} + FRAMEWORK DESTINATION "Library/Frameworks" + PUBLIC_HEADER DESTINATION ${CMAKE_INSTALL_INCLUDEDIR}) +endif() + +foreach(readme ${readme-docs}) + configure_file(${CMAKE_CURRENT_SOURCE_DIR}/${readme} ${CMAKE_CURRENT_BINARY_DIR}/${readme}.txt) + + if(NOT ZMQ_BUILD_FRAMEWORK) + install(FILES ${CMAKE_CURRENT_BINARY_DIR}/${readme}.txt DESTINATION share/zmq) + endif() +endforeach() + +if(WITH_DOC) + if(NOT ZMQ_BUILD_FRAMEWORK) + install( + FILES ${html-docs} + DESTINATION doc/zmq + COMPONENT RefGuide) + endif() +endif() + +if(WIN32) + set(ZEROMQ_CMAKECONFIG_INSTALL_DIR + "CMake" + CACHE STRING "install path for ZeroMQConfig.cmake") +else() + # CMake search path wants either "share" (AKA GNUInstallDirs DATAROOTDIR) for arch-independent, or LIBDIR for arch- + # dependent, plus "cmake" as prefix + set(ZEROMQ_CMAKECONFIG_INSTALL_DIR + "${CMAKE_INSTALL_LIBDIR}/cmake/${PROJECT_NAME}" + CACHE STRING "install path for ZeroMQConfig.cmake") +endif() + +if((NOT CMAKE_VERSION VERSION_LESS 3.0) AND (BUILD_SHARED OR BUILD_STATIC)) + export(EXPORT ${PROJECT_NAME}-targets FILE "${CMAKE_CURRENT_BINARY_DIR}/${PROJECT_NAME}Targets.cmake") +endif() +configure_package_config_file( + builds/cmake/${PROJECT_NAME}Config.cmake.in "${CMAKE_CURRENT_BINARY_DIR}/${PROJECT_NAME}Config.cmake" + INSTALL_DESTINATION ${ZEROMQ_CMAKECONFIG_INSTALL_DIR}) +write_basic_package_version_file( + ${CMAKE_CURRENT_BINARY_DIR}/${PROJECT_NAME}ConfigVersion.cmake + VERSION ${ZMQ_VERSION_MAJOR}.${ZMQ_VERSION_MINOR}.${ZMQ_VERSION_PATCH} + COMPATIBILITY AnyNewerVersion) +if(BUILD_SHARED OR BUILD_STATIC) + install( + EXPORT ${PROJECT_NAME}-targets + FILE ${PROJECT_NAME}Targets.cmake + DESTINATION ${ZEROMQ_CMAKECONFIG_INSTALL_DIR}) + install(FILES ${CMAKE_CURRENT_BINARY_DIR}/${PROJECT_NAME}Config.cmake + ${CMAKE_CURRENT_BINARY_DIR}/${PROJECT_NAME}ConfigVersion.cmake + DESTINATION ${ZEROMQ_CMAKECONFIG_INSTALL_DIR}) +endif() + +option(ENABLE_CPACK "Enables cpack rules" ON) +if(MSVC AND ENABLE_CPACK) + if(${CMAKE_BUILD_TYPE} MATCHES "Debug") + set(CMAKE_INSTALL_DEBUG_LIBRARIES_ONLY TRUE) + set(CMAKE_INSTALL_DEBUG_LIBRARIES TRUE) + set(CMAKE_INSTALL_UCRT_LIBRARIES TRUE) + endif() + include(InstallRequiredSystemLibraries) + + if(CMAKE_CL_64) + set(arch_name "x64") + else() + set(arch_name "x86") + endif() + + set(CPACK_NSIS_DISPLAY_NAME "ZeroMQ ${ZMQ_VERSION_MAJOR}.${ZMQ_VERSION_MINOR}.${ZMQ_VERSION_PATCH}(${arch_name})") + set(CPACK_PACKAGE_FILE_NAME "ZeroMQ-${ZMQ_VERSION_MAJOR}.${ZMQ_VERSION_MINOR}.${ZMQ_VERSION_PATCH}-${arch_name}") + + # TODO: I think this part was intended to be used when running cpack separately from cmake but I don't know how that + # works. + # + # macro(add_crt_version version) set(rel_dir + # "${CMAKE_CURRENT_BINARY_DIR}/build/${arch_name}/${version};ZeroMQ;ALL;/") + # set(debug_dir + # "${CMAKE_CURRENT_BINARY_DIR}/debug/${arch_name}/${version};ZeroMQ;ALL;/") + # if(EXISTS ${rel_dir}) list(APPEND CPACK_INSTALL_CMAKE_PROJECTS ${rel_dir}) endif() + + # if(EXISTS ${debug_dir}) list(APPEND CPACK_INSTALL_CMAKE_PROJECTS ${rel_dir}) endmacro() endmacro() + + # add_crt_version(v110) add_crt_version(v100) add_crt_version(v90) + + list(APPEND CMAKE_MODULE_PATH ${CMAKE_CURRENT_BINARY_DIR}) + set(CPACK_GENERATOR "NSIS") + set(CPACK_PACKAGE_NAME "ZeroMQ") + set(CPACK_PACKAGE_DESCRIPTION_SUMMARY "ZeroMQ lightweight messaging kernel") + set(CPACK_PACKAGE_VENDOR "Miru") + set(CPACK_NSIS_CONTACT "Steven McCoy ") + set(CPACK_RESOURCE_FILE_LICENSE "${CMAKE_CURRENT_BINARY_DIR}\\\\COPYING.txt") + # set(CPACK_RESOURCE_FILE_README "${CMAKE_CURRENT_BINARY_DIR}\\\\README.txt") set(CPACK_RESOURCE_FILE_WELCOME + # "${CMAKE_CURRENT_BINARY_DIR}\\\\WELCOME.txt") There is a bug in NSI that does not handle full unix paths properly. + # Make sure there is at least one set of four(4) backslashes. + set(CPACK_NSIS_MUI_ICON "${CMAKE_CURRENT_SOURCE_DIR}\\\\installer.ico") + set(CPACK_NSIS_MUI_UNIICON "${CMAKE_CURRENT_SOURCE_DIR}\\\\installer.ico") + + set(CPACK_PACKAGE_ICON "${CMAKE_CURRENT_SOURCE_DIR}\\\\branding.bmp") + set(CPACK_NSIS_COMPRESSOR "/SOLID lzma") + set(CPACK_PACKAGE_VERSION ${ZMQ_VERSION}) + set(CPACK_PACKAGE_VERSION_MAJOR ${ZMQ_VERSION_MAJOR}) + set(CPACK_PACKAGE_VERSION_MINOR ${ZMQ_VERSION_MINOR}) + set(CPACK_PACKAGE_VERSION_PATCH ${ZMQ_VERSION_PATCH}) + # set(CPACK_PACKAGE_INSTALL_DIRECTORY "ZMQ Install Directory") set(CPACK_TEMPORARY_DIRECTORY "ZMQ Temporary CPack + # Directory") + + include(CPack) + + cpack_add_component_group(Development DISPLAY_NAME "ZeroMQ software development kit" EXPANDED) + cpack_add_component(PerfTools DISPLAY_NAME "ZeroMQ performance tools" INSTALL_TYPES FullInstall DevInstall) + cpack_add_component(SourceCode DISPLAY_NAME "ZeroMQ source code" DISABLED INSTALL_TYPES FullInstall) + cpack_add_component( + SDK + DISPLAY_NAME + "ZeroMQ headers and libraries" + INSTALL_TYPES + FullInstall + DevInstall + GROUP + Development) + if(WITH_DOC) + cpack_add_component( + RefGuide + DISPLAY_NAME + "ZeroMQ reference guide" + INSTALL_TYPES + FullInstall + DevInstall + GROUP + Development) + endif() + cpack_add_component( + Runtime + DISPLAY_NAME + "ZeroMQ runtime files" + REQUIRED + INSTALL_TYPES + FullInstall + DevInstall + MinInstall) + cpack_add_install_type(FullInstall DISPLAY_NAME "Full install, including source code") + cpack_add_install_type(DevInstall DISPLAY_NAME "Developer install, headers and libraries") + cpack_add_install_type(MinInstall DISPLAY_NAME "Minimal install, runtime only") +endif() + +# Export this for library to help build this as a sub-project +set(ZEROMQ_LIBRARY + libzmq + CACHE STRING "ZeroMQ library") + +# Workaround for MSVS10 to avoid the Dialog Hell FIXME: This could be removed with future version of CMake. +if(MSVC_VERSION EQUAL 1600) + set(ZMQ_SLN_FILENAME "${CMAKE_CURRENT_BINARY_DIR}/ZeroMQ.sln") + if(EXISTS "${ZMQ_SLN_FILENAME}") + file(APPEND "${ZMQ_SLN_FILENAME}" "\n# This should be regenerated!\n") + endif() +endif() + +# this cannot be moved, as it does not only contain function/macro definitions +option(ENABLE_CLANG "Include Clang" ON) +if (ENABLE_CLANG) + include(ClangFormat) +endif() + +# fixes https://github.com/zeromq/libzmq/issues/3776 The problem is, both libzmq-static libzmq try to use/generate +# precompiled.pch at the same time Add a dependency, so they run in order and so they dont get in each others way TODO +# still generates warning "build\x64-Debug\ninja : warning : multiple rules generate precompiled.hpp. builds involving +# this target will not be correct; continuing anyway [-w dupbuild=warn]" +if(MSVC + AND ENABLE_PRECOMPILED + AND BUILD_SHARED + AND BUILD_STATIC) + add_dependencies(libzmq-static libzmq) +endif() diff --git a/vendor/ZMQ/COPYING b/vendor/ZMQ/COPYING new file mode 100644 index 00000000..b6f3fd5d --- /dev/null +++ b/vendor/ZMQ/COPYING @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/vendor/ZMQ/COPYING.LESSER b/vendor/ZMQ/COPYING.LESSER new file mode 100644 index 00000000..02e943c4 --- /dev/null +++ b/vendor/ZMQ/COPYING.LESSER @@ -0,0 +1,181 @@ + GNU LESSER GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + + This version of the GNU Lesser General Public License incorporates +the terms and conditions of version 3 of the GNU General Public +License, supplemented by the additional permissions listed below. + + 0. Additional Definitions. + + As used herein, "this License" refers to version 3 of the GNU Lesser +General Public License, and the "GNU GPL" refers to version 3 of the GNU +General Public License. + + "The Library" refers to a covered work governed by this License, +other than an Application or a Combined Work as defined below. + + An "Application" is any work that makes use of an interface provided +by the Library, but which is not otherwise based on the Library. +Defining a subclass of a class defined by the Library is deemed a mode +of using an interface provided by the Library. + + A "Combined Work" is a work produced by combining or linking an +Application with the Library. The particular version of the Library +with which the Combined Work was made is also called the "Linked +Version". + + The "Minimal Corresponding Source" for a Combined Work means the +Corresponding Source for the Combined Work, excluding any source code +for portions of the Combined Work that, considered in isolation, are +based on the Application, and not on the Linked Version. + + The "Corresponding Application Code" for a Combined Work means the +object code and/or source code for the Application, including any data +and utility programs needed for reproducing the Combined Work from the +Application, but excluding the System Libraries of the Combined Work. + + 1. Exception to Section 3 of the GNU GPL. + + You may convey a covered work under sections 3 and 4 of this License +without being bound by section 3 of the GNU GPL. + + 2. Conveying Modified Versions. + + If you modify a copy of the Library, and, in your modifications, a +facility refers to a function or data to be supplied by an Application +that uses the facility (other than as an argument passed when the +facility is invoked), then you may convey a copy of the modified +version: + + a) under this License, provided that you make a good faith effort to + ensure that, in the event an Application does not supply the + function or data, the facility still operates, and performs + whatever part of its purpose remains meaningful, or + + b) under the GNU GPL, with none of the additional permissions of + this License applicable to that copy. + + 3. Object Code Incorporating Material from Library Header Files. + + The object code form of an Application may incorporate material from +a header file that is part of the Library. You may convey such object +code under terms of your choice, provided that, if the incorporated +material is not limited to numerical parameters, data structure +layouts and accessors, or small macros, inline functions and templates +(ten or fewer lines in length), you do both of the following: + + a) Give prominent notice with each copy of the object code that the + Library is used in it and that the Library and its use are + covered by this License. + + b) Accompany the object code with a copy of the GNU GPL and this license + document. + + 4. Combined Works. + + You may convey a Combined Work under terms of your choice that, +taken together, effectively do not restrict modification of the +portions of the Library contained in the Combined Work and reverse +engineering for debugging such modifications, if you also do each of +the following: + + a) Give prominent notice with each copy of the Combined Work that + the Library is used in it and that the Library and its use are + covered by this License. + + b) Accompany the Combined Work with a copy of the GNU GPL and this license + document. + + c) For a Combined Work that displays copyright notices during + execution, include the copyright notice for the Library among + these notices, as well as a reference directing the user to the + copies of the GNU GPL and this license document. + + d) Do one of the following: + + 0) Convey the Minimal Corresponding Source under the terms of this + License, and the Corresponding Application Code in a form + suitable for, and under terms that permit, the user to + recombine or relink the Application with a modified version of + the Linked Version to produce a modified Combined Work, in the + manner specified by section 6 of the GNU GPL for conveying + Corresponding Source. + + 1) Use a suitable shared library mechanism for linking with the + Library. A suitable mechanism is one that (a) uses at run time + a copy of the Library already present on the user's computer + system, and (b) will operate properly with a modified version + of the Library that is interface-compatible with the Linked + Version. + + e) Provide Installation Information, but only if you would otherwise + be required to provide such information under section 6 of the + GNU GPL, and only to the extent that such information is + necessary to install and execute a modified version of the + Combined Work produced by recombining or relinking the + Application with a modified version of the Linked Version. (If + you use option 4d0, the Installation Information must accompany + the Minimal Corresponding Source and Corresponding Application + Code. If you use option 4d1, you must provide the Installation + Information in the manner specified by section 6 of the GNU GPL + for conveying Corresponding Source.) + + 5. Combined Libraries. + + You may place library facilities that are a work based on the +Library side by side in a single library together with other library +facilities that are not Applications and are not covered by this +License, and convey such a combined library under terms of your +choice, if you do both of the following: + + a) Accompany the combined library with a copy of the same work based + on the Library, uncombined with any other library facilities, + conveyed under the terms of this License. + + b) Give prominent notice with the combined library that part of it + is a work based on the Library, and explaining where to find the + accompanying uncombined form of the same work. + + 6. Revised Versions of the GNU Lesser General Public License. + + The Free Software Foundation may publish revised and/or new versions +of the GNU Lesser General Public License from time to time. Such new +versions will be similar in spirit to the present version, but may +differ in detail to address new problems or concerns. + + Each version is given a distinguishing version number. If the +Library as you received it specifies that a certain numbered version +of the GNU Lesser General Public License "or any later version" +applies to it, you have the option of following the terms and +conditions either of that published version or of any later version +published by the Free Software Foundation. If the Library as you +received it does not specify a version number of the GNU Lesser +General Public License, you may choose any version of the GNU Lesser +General Public License ever published by the Free Software Foundation. + + If the Library as you received it specifies that a proxy can decide +whether future versions of the GNU Lesser General Public License shall +apply, that proxy's public statement of acceptance of any version is +permanent authorization for you to choose that version for the +Library. + +-------------------------------------------------------------------------------- + + SPECIAL EXCEPTION GRANTED BY COPYRIGHT HOLDERS + +As a special exception, copyright holders give you permission to link this +library with independent modules to produce an executable, regardless of +the license terms of these independent modules, and to copy and distribute +the resulting executable under terms of your choice, provided that you also +meet, for each linked independent module, the terms and conditions of +the license of that module. An independent module is a module which is not +derived from or based on this library. If you modify this library, you must +extend this exception to your version of the library. + +Note: this exception relieves you of any obligations under sections 4 and 5 +of this license, and section 6 of the GNU General Public License. diff --git a/vendor/ZMQ/Dockerfile b/vendor/ZMQ/Dockerfile new file mode 100644 index 00000000..6b8c0c63 --- /dev/null +++ b/vendor/ZMQ/Dockerfile @@ -0,0 +1,32 @@ +FROM debian:buster-slim AS builder +LABEL maintainer="ZeroMQ Project " +ARG DEBIAN_FRONTEND=noninteractive +RUN apt-get update -qq \ + && apt-get install -qq --yes --no-install-recommends \ + autoconf \ + automake \ + build-essential \ + git \ + libkrb5-dev \ + libsodium-dev \ + libtool \ + pkg-config \ + && rm -rf /var/lib/apt/lists/* +WORKDIR /opt/libzmq +COPY . . +RUN ./autogen.sh \ + && ./configure --prefix=/usr/local --with-libsodium --with-libgssapi_krb5 \ + && make \ + && make check \ + && make install + +FROM debian:buster-slim +LABEL maintainer="ZeroMQ Project " +ARG DEBIAN_FRONTEND=noninteractive +RUN apt-get update -qq \ + && apt-get install -qq --yes --no-install-recommends \ + libkrb5-dev \ + libsodium23 \ + && rm -rf /var/lib/apt/lists/* +COPY --from=builder /usr/local /usr/local +RUN ldconfig && ldconfig -p | grep libzmq diff --git a/vendor/ZMQ/Doxygen.cfg b/vendor/ZMQ/Doxygen.cfg new file mode 100644 index 00000000..370f19b9 --- /dev/null +++ b/vendor/ZMQ/Doxygen.cfg @@ -0,0 +1,2320 @@ +# Doxyfile 1.8.11 + +# This file describes the settings to be used by the documentation system +# doxygen (www.doxygen.org) for a project. +# +# All text after a double hash (##) is considered a comment and is placed in +# front of the TAG it is preceding. +# +# All text after a single hash (#) is considered a comment and will be ignored. +# The format is: +# TAG = value [value, ...] +# For lists, items can also be appended using: +# TAG += value [value, ...] +# Values that contain spaces should be placed between quotes (\" \"). + +#--------------------------------------------------------------------------- +# Project related configuration options +#--------------------------------------------------------------------------- + +# This tag specifies the encoding used for all characters in the config file +# that follow. The default is UTF-8 which is also the encoding used for all text +# before the first occurrence of this tag. Doxygen uses libiconv (or the iconv +# built into libc) for the transcoding. See http://www.gnu.org/software/libiconv +# for the list of possible encodings. +# The default value is: UTF-8. + +DOXYFILE_ENCODING = UTF-8 + +# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by +# double-quotes, unless you are using Doxywizard) that should identify the +# project for which the documentation is generated. This name is used in the +# title of most generated pages and in a few other places. +# The default value is: My Project. + +PROJECT_NAME = libzmq + +# The PROJECT_NUMBER tag can be used to enter a project or revision number. This +# could be handy for archiving the generated documentation or if some version +# control system is used. + +PROJECT_NUMBER = master + +# Using the PROJECT_BRIEF tag one can provide an optional one line description +# for a project that appears at the top of each page and should give viewer a +# quick idea about the purpose of the project. Keep the description short. + +PROJECT_BRIEF = "ZeroMQ C++ Core Engine (LIBZMQ)" + +PROJECT_LOGO = branding.bmp + +# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path +# into which the generated documentation will be written. If a relative path is +# entered, it will be relative to the location where doxygen was started. If +# left blank the current directory will be used. + +OUTPUT_DIRECTORY = doxygen + +# If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub- +# directories (in 2 levels) under the output directory of each output format and +# will distribute the generated files over these directories. Enabling this +# option can be useful when feeding doxygen a huge amount of source files, where +# putting all generated files in the same directory would otherwise causes +# performance problems for the file system. +# The default value is: NO. + +CREATE_SUBDIRS = YES + +# If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII +# characters to appear in the names of generated files. If set to NO, non-ASCII +# characters will be escaped, for example _xE3_x81_x84 will be used for Unicode +# U+3044. +# The default value is: NO. + +ALLOW_UNICODE_NAMES = NO + +# The OUTPUT_LANGUAGE tag is used to specify the language in which all +# documentation generated by doxygen is written. Doxygen will use this +# information to generate all constant output in the proper language. +# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese, +# Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States), +# Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian, +# Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages), +# Korean, Korean-en (Korean with English messages), Latvian, Lithuanian, +# Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian, +# Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish, +# Ukrainian and Vietnamese. +# The default value is: English. + +OUTPUT_LANGUAGE = English + +# If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member +# descriptions after the members that are listed in the file and class +# documentation (similar to Javadoc). Set to NO to disable this. +# The default value is: YES. + +BRIEF_MEMBER_DESC = YES + +# If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief +# description of a member or function before the detailed description +# +# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the +# brief descriptions will be completely suppressed. +# The default value is: YES. + +REPEAT_BRIEF = YES + +# This tag implements a quasi-intelligent brief description abbreviator that is +# used to form the text in various listings. Each string in this list, if found +# as the leading text of the brief description, will be stripped from the text +# and the result, after processing the whole list, is used as the annotated +# text. Otherwise, the brief description is used as-is. If left blank, the +# following values are used ($name is automatically replaced with the name of +# the entity):The $name class, The $name widget, The $name file, is, provides, +# specifies, contains, represents, a, an and the. + +ABBREVIATE_BRIEF = + +# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then +# doxygen will generate a detailed section even if there is only a brief +# description. +# The default value is: NO. + +ALWAYS_DETAILED_SEC = NO + +# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all +# inherited members of a class in the documentation of that class as if those +# members were ordinary class members. Constructors, destructors and assignment +# operators of the base classes will not be shown. +# The default value is: NO. + +INLINE_INHERITED_MEMB = NO + +# If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path +# before files name in the file list and in the header files. If set to NO the +# shortest path that makes the file name unique will be used +# The default value is: YES. + +FULL_PATH_NAMES = NO + +# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path. +# Stripping is only done if one of the specified strings matches the left-hand +# part of the path. The tag can be used to show relative paths in the file list. +# If left blank the directory from which doxygen is run is used as the path to +# strip. +# +# Note that you can specify absolute paths here, but also relative paths, which +# will be relative from the directory where doxygen is started. +# This tag requires that the tag FULL_PATH_NAMES is set to YES. + +STRIP_FROM_PATH = ../.. + +# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the +# path mentioned in the documentation of a class, which tells the reader which +# header file to include in order to use a class. If left blank only the name of +# the header file containing the class definition is used. Otherwise one should +# specify the list of include paths that are normally passed to the compiler +# using the -I flag. + +STRIP_FROM_INC_PATH = + +# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but +# less readable) file names. This can be useful is your file systems doesn't +# support long names like on DOS, Mac, or CD-ROM. +# The default value is: NO. + +SHORT_NAMES = NO +JAVADOC_AUTOBRIEF = NO +QT_AUTOBRIEF = NO + +# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a +# multi-line C++ special comment block (i.e. a block of //! or /// comments) as +# a brief description. This used to be the default behavior. The new default is +# to treat a multi-line C++ comment block as a detailed description. Set this +# tag to YES if you prefer the old behavior instead. +# +# Note that setting this tag to YES also means that rational rose comments are +# not recognized any more. +# The default value is: NO. + +MULTILINE_CPP_IS_BRIEF = NO + +# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the +# documentation from any documented member that it re-implements. +# The default value is: YES. + +INHERIT_DOCS = YES + +# If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new +# page for each member. If set to NO, the documentation of a member will be part +# of the file/class/namespace that contains it. +# The default value is: NO. + +SEPARATE_MEMBER_PAGES = NO + +# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen +# uses this value to replace tabs by spaces in code fragments. +# Minimum value: 1, maximum value: 16, default value: 4. + +TAB_SIZE = 4 + +# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources +# only. Doxygen will then generate output that is more tailored for C. For +# instance, some of the names that are used will be different. The list of all +# members will be omitted, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_FOR_C = NO + +OPTIMIZE_OUTPUT_JAVA = NO + +OPTIMIZE_FOR_FORTRAN = NO + +OPTIMIZE_OUTPUT_VHDL = NO + +# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments +# according to the Markdown format, which allows for more readable +# documentation. See http://daringfireball.net/projects/markdown/ for details. +# The output of markdown processing is further processed by doxygen, so you can +# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in +# case of backward compatibilities issues. +# The default value is: YES. + +MARKDOWN_SUPPORT = YES + +# When enabled doxygen tries to link words that correspond to documented +# classes, or namespaces to their corresponding documentation. Such a link can +# be prevented in individual cases by putting a % sign in front of the word or +# globally by setting AUTOLINK_SUPPORT to NO. +# The default value is: YES. + +AUTOLINK_SUPPORT = YES + +# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want +# to include (a tag file for) the STL sources as input, then you should set this +# tag to YES in order to let doxygen match functions declarations and +# definitions whose arguments contain STL classes (e.g. func(std::string); +# versus func(std::string) {}). This also make the inheritance and collaboration +# diagrams that involve STL classes more complete and accurate. +# The default value is: NO. + +BUILTIN_STL_SUPPORT = YES + +# If you use Microsoft's C++/CLI language, you should set this option to YES to +# enable parsing support. +# The default value is: NO. + +CPP_CLI_SUPPORT = NO + +# For Microsoft's IDL there are propget and propput attributes to indicate +# getter and setter methods for a property. Setting this option to YES will make +# doxygen to replace the get and set methods by a property in the documentation. +# This will only work if the methods are indeed getting or setting a simple +# type. If this is not the case, or you want to show the methods anyway, you +# should set this option to NO. +# The default value is: YES. + +IDL_PROPERTY_SUPPORT = YES + +# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC +# tag is set to YES then doxygen will reuse the documentation of the first +# member in the group (if any) for the other members of the group. By default +# all members of a group must be documented explicitly. +# The default value is: NO. + +DISTRIBUTE_GROUP_DOC = NO + +# If one adds a struct or class to a group and this option is enabled, then also +# any nested class or struct is added to the same group. By default this option +# is disabled and one has to add nested compounds explicitly via \ingroup. +# The default value is: NO. + +GROUP_NESTED_COMPOUNDS = NO + +# Set the SUBGROUPING tag to YES to allow class member groups of the same type +# (for instance a group of public functions) to be put as a subgroup of that +# type (e.g. under the Public Functions section). Set it to NO to prevent +# subgrouping. Alternatively, this can be done per class using the +# \nosubgrouping command. +# The default value is: YES. + +SUBGROUPING = YES + +# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions +# are shown inside the group in which they are included (e.g. using \ingroup) +# instead of on a separate page (for HTML and Man pages) or section (for LaTeX +# and RTF). +# +# Note that this feature does not work in combination with +# SEPARATE_MEMBER_PAGES. +# The default value is: NO. + +INLINE_GROUPED_CLASSES = NO + +# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions +# with only public data fields or simple typedef fields will be shown inline in +# the documentation of the scope in which they are defined (i.e. file, +# namespace, or group documentation), provided this scope is documented. If set +# to NO, structs, classes, and unions are shown on a separate page (for HTML and +# Man pages) or section (for LaTeX and RTF). +# The default value is: NO. + +INLINE_SIMPLE_STRUCTS = NO + +# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or +# enum is documented as struct, union, or enum with the name of the typedef. So +# typedef struct TypeS {} TypeT, will appear in the documentation as a struct +# with name TypeT. When disabled the typedef will appear as a member of a file, +# namespace, or class. And the struct will be named TypeS. This can typically be +# useful for C code in case the coding convention dictates that all compound +# types are typedef'ed and only the typedef is referenced, never the tag name. +# The default value is: NO. + +TYPEDEF_HIDES_STRUCT = NO + +# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This +# cache is used to resolve symbols given their name and scope. Since this can be +# an expensive process and often the same symbol appears multiple times in the +# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small +# doxygen will become slower. If the cache is too large, memory is wasted. The +# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range +# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 +# symbols. At the end of a run doxygen will report the cache usage and suggest +# the optimal cache size from a speed point of view. +# Minimum value: 0, maximum value: 9, default value: 0. + +LOOKUP_CACHE_SIZE = 0 + +#--------------------------------------------------------------------------- +# Build related configuration options +#--------------------------------------------------------------------------- + +# If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in +# documentation are documented, even if no documentation was available. Private +# class members and static file members will be hidden unless the +# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. +# Note: This will also disable the warnings about undocumented members that are +# normally produced when WARNINGS is set to YES. +# The default value is: NO. + +EXTRACT_ALL = YES + +# If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will +# be included in the documentation. +# The default value is: NO. + +EXTRACT_PRIVATE = YES + +# If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal +# scope will be included in the documentation. +# The default value is: NO. + +EXTRACT_PACKAGE = NO + +# If the EXTRACT_STATIC tag is set to YES, all static members of a file will be +# included in the documentation. +# The default value is: NO. + +EXTRACT_STATIC = YES + +# If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined +# locally in source files will be included in the documentation. If set to NO, +# only classes defined in header files are included. Does not have any effect +# for Java sources. +# The default value is: YES. + +EXTRACT_LOCAL_CLASSES = YES + +# If this flag is set to YES, the members of anonymous namespaces will be +# extracted and appear in the documentation as a namespace called +# 'anonymous_namespace{file}', where file will be replaced with the base name of +# the file that contains the anonymous namespace. By default anonymous namespace +# are hidden. +# The default value is: NO. + +EXTRACT_ANON_NSPACES = YES + +# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all +# undocumented members inside documented classes or files. If set to NO these +# members will be included in the various overviews, but no documentation +# section is generated. This option has no effect if EXTRACT_ALL is enabled. +# The default value is: NO. + +HIDE_UNDOC_MEMBERS = NO + +# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all +# undocumented classes that are normally visible in the class hierarchy. If set +# to NO, these classes will be included in the various overviews. This option +# has no effect if EXTRACT_ALL is enabled. +# The default value is: NO. + +HIDE_UNDOC_CLASSES = NO + +# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend +# (class|struct|union) declarations. If set to NO, these declarations will be +# included in the documentation. +# The default value is: NO. + +HIDE_FRIEND_COMPOUNDS = NO + +# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any +# documentation blocks found inside the body of a function. If set to NO, these +# blocks will be appended to the function's detailed documentation block. +# The default value is: NO. + +HIDE_IN_BODY_DOCS = NO + +# The INTERNAL_DOCS tag determines if documentation that is typed after a +# \internal command is included. If the tag is set to NO then the documentation +# will be excluded. Set it to YES to include the internal documentation. +# The default value is: NO. + +INTERNAL_DOCS = NO + +# If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file +# names in lower-case letters. If set to YES, upper-case letters are also +# allowed. This is useful if you have classes or files whose names only differ +# in case and if your file system supports case sensitive file names. Windows +# and Mac users are advised to set this option to NO. +# The default value is: system dependent. + +CASE_SENSE_NAMES = YES + +# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with +# their full class and namespace scopes in the documentation. If set to YES, the +# scope will be hidden. +# The default value is: NO. + +HIDE_SCOPE_NAMES = NO + +# If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will +# append additional text to a page's title, such as Class Reference. If set to +# YES the compound reference will be hidden. +# The default value is: NO. + +HIDE_COMPOUND_REFERENCE= NO + +# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of +# the files that are included by a file in the documentation of that file. +# The default value is: YES. + +SHOW_INCLUDE_FILES = YES + +# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each +# grouped member an include statement to the documentation, telling the reader +# which file to include in order to use the member. +# The default value is: NO. + +SHOW_GROUPED_MEMB_INC = NO + +# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include +# files with double quotes in the documentation rather than with sharp brackets. +# The default value is: NO. + +FORCE_LOCAL_INCLUDES = NO + +# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the +# documentation for inline members. +# The default value is: YES. + +INLINE_INFO = YES + +# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the +# (detailed) documentation of file and class members alphabetically by member +# name. If set to NO, the members will appear in declaration order. +# The default value is: YES. + +SORT_MEMBER_DOCS = YES + +# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief +# descriptions of file, namespace and class members alphabetically by member +# name. If set to NO, the members will appear in declaration order. Note that +# this will also influence the order of the classes in the class list. +# The default value is: NO. + +SORT_BRIEF_DOCS = YES + +# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the +# (brief and detailed) documentation of class members so that constructors and +# destructors are listed first. If set to NO the constructors will appear in the +# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. +# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief +# member documentation. +# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting +# detailed member documentation. +# The default value is: NO. + +SORT_MEMBERS_CTORS_1ST = YES + +# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy +# of group names into alphabetical order. If set to NO the group names will +# appear in their defined order. +# The default value is: NO. + +SORT_GROUP_NAMES = NO + +# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by +# fully-qualified names, including namespaces. If set to NO, the class list will +# be sorted only by class name, not including the namespace part. +# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. +# Note: This option applies only to the class list, not to the alphabetical +# list. +# The default value is: NO. + +SORT_BY_SCOPE_NAME = NO + +# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper +# type resolution of all parameters of a function it will reject a match between +# the prototype and the implementation of a member function even if there is +# only one candidate or it is obvious which candidate to choose by doing a +# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still +# accept a match between prototype and implementation in such cases. +# The default value is: NO. + +STRICT_PROTO_MATCHING = NO + +# The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo +# list. This list is created by putting \todo commands in the documentation. +# The default value is: YES. + +GENERATE_TODOLIST = YES + +# The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test +# list. This list is created by putting \test commands in the documentation. +# The default value is: YES. + +GENERATE_TESTLIST = YES + +# The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug +# list. This list is created by putting \bug commands in the documentation. +# The default value is: YES. + +GENERATE_BUGLIST = YES + +# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO) +# the deprecated list. This list is created by putting \deprecated commands in +# the documentation. +# The default value is: YES. + +GENERATE_DEPRECATEDLIST= YES + +# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the +# initial value of a variable or macro / define can have for it to appear in the +# documentation. If the initializer consists of more lines than specified here +# it will be hidden. Use a value of 0 to hide initializers completely. The +# appearance of the value of individual variables and macros / defines can be +# controlled using \showinitializer or \hideinitializer command in the +# documentation regardless of this setting. +# Minimum value: 0, maximum value: 10000, default value: 30. + +MAX_INITIALIZER_LINES = 30 + +# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at +# the bottom of the documentation of classes and structs. If set to YES, the +# list will mention the files that were used to generate the documentation. +# The default value is: YES. + +SHOW_USED_FILES = NO + +# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This +# will remove the Files entry from the Quick Index and from the Folder Tree View +# (if specified). +# The default value is: YES. + +SHOW_FILES = YES + +# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces +# page. This will remove the Namespaces entry from the Quick Index and from the +# Folder Tree View (if specified). +# The default value is: YES. + +SHOW_NAMESPACES = NO + +# The FILE_VERSION_FILTER tag can be used to specify a program or script that +# doxygen should invoke to get the current version for each file (typically from +# the version control system). Doxygen will invoke the program by executing (via +# popen()) the command command input-file, where command is the value of the +# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided +# by doxygen. Whatever the program writes to standard output is used as the file +# version. For an example see the documentation. + +FILE_VERSION_FILTER = + +# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed +# by doxygen. The layout file controls the global structure of the generated +# output files in an output format independent way. To create the layout file +# that represents doxygen's defaults, run doxygen with the -l option. You can +# optionally specify a file name after the option, if omitted DoxygenLayout.xml +# will be used as the name of the layout file. +# +# Note that if you run doxygen from a directory containing a file called +# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE +# tag is left empty. + +LAYOUT_FILE = + +# The CITE_BIB_FILES tag can be used to specify one or more bib files containing +# the reference definitions. This must be a list of .bib files. The .bib +# extension is automatically appended if omitted. This requires the bibtex tool +# to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info. +# For LaTeX the style of the bibliography can be controlled using +# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the +# search path. See also \cite for info how to create references. + +CITE_BIB_FILES = + +#--------------------------------------------------------------------------- +# Configuration options related to warning and progress messages +#--------------------------------------------------------------------------- + +# The QUIET tag can be used to turn on/off the messages that are generated to +# standard output by doxygen. If QUIET is set to YES this implies that the +# messages are off. +# The default value is: NO. + +QUIET = NO + +# The WARNINGS tag can be used to turn on/off the warning messages that are +# generated to standard error (stderr) by doxygen. If WARNINGS is set to YES +# this implies that the warnings are on. +# +# Tip: Turn warnings on while writing the documentation. +# The default value is: YES. + +WARNINGS = YES + +# If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate +# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag +# will automatically be disabled. +# The default value is: YES. + +WARN_IF_UNDOCUMENTED = NO + +# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for +# potential errors in the documentation, such as not documenting some parameters +# in a documented function, or documenting parameters that don't exist or using +# markup commands wrongly. +# The default value is: YES. + +WARN_IF_DOC_ERROR = YES + +# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that +# are documented, but have no documentation for their parameters or return +# value. If set to NO, doxygen will only warn about wrong or incomplete +# parameter documentation, but not about the absence of documentation. +# The default value is: NO. + +WARN_NO_PARAMDOC = NO + +# If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when +# a warning is encountered. +# The default value is: NO. + +WARN_AS_ERROR = NO + +# The WARN_FORMAT tag determines the format of the warning messages that doxygen +# can produce. The string should contain the $file, $line, and $text tags, which +# will be replaced by the file and line number from which the warning originated +# and the warning text. Optionally the format may contain $version, which will +# be replaced by the version of the file (if it could be obtained via +# FILE_VERSION_FILTER) +# The default value is: $file:$line: $text. + +WARN_FORMAT = + +# The WARN_LOGFILE tag can be used to specify a file to which warning and error +# messages should be written. If left blank the output is written to standard +# error (stderr). + +WARN_LOGFILE = + +#--------------------------------------------------------------------------- +# Configuration options related to the input files +#--------------------------------------------------------------------------- + +# The INPUT tag is used to specify the files and/or directories that contain +# documented source files. You may enter file names like myfile.cpp or +# directories like /usr/src/myproject. Separate the files or directories with +# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING +# Note: If this tag is empty the current directory is searched. + +INPUT = include \ + src \ + tests \ + perf \ + README.doxygen.md + +# This tag can be used to specify the character encoding of the source files +# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses +# libiconv (or the iconv built into libc) for the transcoding. See the libiconv +# documentation (see: http://www.gnu.org/software/libiconv) for the list of +# possible encodings. +# The default value is: UTF-8. + +INPUT_ENCODING = UTF-8 + +# If the value of the INPUT tag contains directories, you can use the +# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and +# *.h) to filter out the source-files in the directories. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# read by doxygen. +# +# If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp, +# *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, +# *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, +# *.m, *.markdown, *.md, *.mm, *.dox, *.py, *.pyw, *.f90, *.f, *.for, *.tcl, +# *.vhd, *.vhdl, *.ucf, *.qsf, *.as and *.js. + +FILE_PATTERNS = *.c \ + *.cpp \ + *.h \ + *.hpp + +# The RECURSIVE tag can be used to specify whether or not subdirectories should +# be searched for input files as well. +# The default value is: NO. + +RECURSIVE = YES + +# The EXCLUDE tag can be used to specify files and/or directories that should be +# excluded from the INPUT source files. This way you can easily exclude a +# subdirectory from a directory tree whose root is specified with the INPUT tag. +# +# Note that relative paths are relative to the directory from which doxygen is +# run. + +EXCLUDE = + +# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or +# directories that are symbolic links (a Unix file system feature) are excluded +# from the input. +# The default value is: NO. + +EXCLUDE_SYMLINKS = NO + +# If the value of the INPUT tag contains directories, you can use the +# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude +# certain files from those directories. +# +# Note that the wildcards are matched against the file with absolute path, so to +# exclude all test directories for example use the pattern */test/* + +EXCLUDE_PATTERNS = + +# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names +# (namespaces, classes, functions, etc.) that should be excluded from the +# output. The symbol name can be a fully qualified name, a word, or if the +# wildcard * is used, a substring. Examples: ANamespace, AClass, +# AClass::ANamespace, ANamespace::*Test +# +# Note that the wildcards are matched against the file with absolute path, so to +# exclude all test directories use the pattern */test/* + +EXCLUDE_SYMBOLS = + +# The EXAMPLE_PATH tag can be used to specify one or more files or directories +# that contain example code fragments that are included (see the \include +# command). + +EXAMPLE_PATH = tests perf + +# If the value of the EXAMPLE_PATH tag contains directories, you can use the +# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and +# *.h) to filter out the source-files in the directories. If left blank all +# files are included. + +EXAMPLE_PATTERNS = + +# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be +# searched for input files to be used with the \include or \dontinclude commands +# irrespective of the value of the RECURSIVE tag. +# The default value is: NO. + +EXAMPLE_RECURSIVE = YES + +# The IMAGE_PATH tag can be used to specify one or more files or directories +# that contain images that are to be included in the documentation (see the +# \image command). + +IMAGE_PATH = + +# The INPUT_FILTER tag can be used to specify a program that doxygen should +# invoke to filter for each input file. Doxygen will invoke the filter program +# by executing (via popen()) the command: +# +# +# +# where is the value of the INPUT_FILTER tag, and is the +# name of an input file. Doxygen will then use the output that the filter +# program writes to standard output. If FILTER_PATTERNS is specified, this tag +# will be ignored. +# +# Note that the filter must not add or remove lines; it is applied before the +# code is scanned, but not when the output code is generated. If lines are added +# or removed, the anchors will not be placed correctly. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# properly processed by doxygen. + +INPUT_FILTER = + +# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern +# basis. Doxygen will compare the file name with each pattern and apply the +# filter if there is a match. The filters are a list of the form: pattern=filter +# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how +# filters are used. If the FILTER_PATTERNS tag is empty or if none of the +# patterns match the file name, INPUT_FILTER is applied. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# properly processed by doxygen. + +FILTER_PATTERNS = + +# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using +# INPUT_FILTER) will also be used to filter the input files that are used for +# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). +# The default value is: NO. + +FILTER_SOURCE_FILES = NO + +# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file +# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and +# it is also possible to disable source filtering for a specific pattern using +# *.ext= (so without naming a filter). +# This tag requires that the tag FILTER_SOURCE_FILES is set to YES. + +FILTER_SOURCE_PATTERNS = + +# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that +# is part of the input, its contents will be placed on the main page +# (index.html). This can be useful if you have a project on for instance GitHub +# and want to reuse the introduction page also for the doxygen output. + +USE_MDFILE_AS_MAINPAGE = README.doxygen.md + +#--------------------------------------------------------------------------- +# Configuration options related to source browsing +#--------------------------------------------------------------------------- + +# If the SOURCE_BROWSER tag is set to YES then a list of source files will be +# generated. Documented entities will be cross-referenced with these sources. +# +# Note: To get rid of all source code in the generated output, make sure that +# also VERBATIM_HEADERS is set to NO. +# The default value is: NO. + +SOURCE_BROWSER = YES + +# Setting the INLINE_SOURCES tag to YES will include the body of functions, +# classes and enums directly into the documentation. +# The default value is: NO. + +INLINE_SOURCES = NO + +# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any +# special comment blocks from generated source code fragments. Normal C, C++ and +# Fortran comments will always remain visible. +# The default value is: YES. + +STRIP_CODE_COMMENTS = NO + +# If the REFERENCED_BY_RELATION tag is set to YES then for each documented +# function all documented functions referencing it will be listed. +# The default value is: NO. + +REFERENCED_BY_RELATION = YES + +# If the REFERENCES_RELATION tag is set to YES then for each documented function +# all documented entities called/used by that function will be listed. +# The default value is: NO. + +REFERENCES_RELATION = YES + +# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set +# to YES then the hyperlinks from functions in REFERENCES_RELATION and +# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will +# link to the documentation. +# The default value is: YES. + +REFERENCES_LINK_SOURCE = YES + +# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the +# source code will show a tooltip with additional information such as prototype, +# brief description and links to the definition and documentation. Since this +# will make the HTML file larger and loading of large files a bit slower, you +# can opt to disable this feature. +# The default value is: YES. +# This tag requires that the tag SOURCE_BROWSER is set to YES. + +SOURCE_TOOLTIPS = YES + +# If the USE_HTAGS tag is set to YES then the references to source code will +# point to the HTML generated by the htags(1) tool instead of doxygen built-in +# source browser. The htags tool is part of GNU's global source tagging system +# (see http://www.gnu.org/software/global/global.html). You will need version +# 4.8.6 or higher. +# +# To use it do the following: +# - Install the latest version of global +# - Enable SOURCE_BROWSER and USE_HTAGS in the config file +# - Make sure the INPUT points to the root of the source tree +# - Run doxygen as normal +# +# Doxygen will invoke htags (and that will in turn invoke gtags), so these +# tools must be available from the command line (i.e. in the search path). +# +# The result: instead of the source browser generated by doxygen, the links to +# source code will now point to the output of htags. +# The default value is: NO. +# This tag requires that the tag SOURCE_BROWSER is set to YES. + +USE_HTAGS = NO + +# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a +# verbatim copy of the header file for each class for which an include is +# specified. Set to NO to disable this. +# See also: Section \class. +# The default value is: YES. + +VERBATIM_HEADERS = YES + +#--------------------------------------------------------------------------- +# Configuration options related to the alphabetical class index +#--------------------------------------------------------------------------- + +# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all +# compounds will be generated. Enable this if the project contains a lot of +# classes, structs, unions or interfaces. +# The default value is: YES. + +ALPHABETICAL_INDEX = YES + +# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in +# which the alphabetical index list will be split. +# Minimum value: 1, maximum value: 20, default value: 5. +# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. + +COLS_IN_ALPHA_INDEX = 4 + +# In case all classes in a project start with a common prefix, all classes will +# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag +# can be used to specify a prefix (or a list of prefixes) that should be ignored +# while generating the index headers. +# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. + +IGNORE_PREFIX = + +#--------------------------------------------------------------------------- +# Configuration options related to the HTML output +#--------------------------------------------------------------------------- + +# If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output +# The default value is: YES. + +GENERATE_HTML = YES + +# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a +# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of +# it. +# The default directory is: html. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_OUTPUT = html + +# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each +# generated HTML page (for example: .htm, .php, .asp). +# The default value is: .html. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FILE_EXTENSION = .html + +# The HTML_HEADER tag can be used to specify a user-defined HTML header file for +# each generated HTML page. If the tag is left blank doxygen will generate a +# standard header. +# +# To get valid HTML the header file that includes any scripts and style sheets +# that doxygen needs, which is dependent on the configuration options used (e.g. +# the setting GENERATE_TREEVIEW). It is highly recommended to start with a +# default header using +# doxygen -w html new_header.html new_footer.html new_stylesheet.css +# YourConfigFile +# and then modify the file new_header.html. See also section "Doxygen usage" +# for information on how to generate the default header that doxygen normally +# uses. +# Note: The header is subject to change so you typically have to regenerate the +# default header when upgrading to a newer version of doxygen. For a description +# of the possible markers and block names see the documentation. +# This tag requires that the tag GENERATE_HTML is set to YES. + +# HTML_HEADER = doxygen.header + +# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each +# generated HTML page. If the tag is left blank doxygen will generate a standard +# footer. See HTML_HEADER for more information on how to generate a default +# footer and what special commands can be used inside the footer. See also +# section "Doxygen usage" for information on how to generate the default footer +# that doxygen normally uses. +# This tag requires that the tag GENERATE_HTML is set to YES. + +# HTML_FOOTER = doxygen.footer + +# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style +# sheet that is used by each HTML page. It can be used to fine-tune the look of +# the HTML output. If left blank doxygen will generate a default style sheet. +# See also section "Doxygen usage" for information on how to generate the style +# sheet that doxygen normally uses. +# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as +# it is more robust and this tag (HTML_STYLESHEET) will in the future become +# obsolete. +# This tag requires that the tag GENERATE_HTML is set to YES. + +# HTML_STYLESHEET = doxygen.css + +# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined +# cascading style sheets that are included after the standard style sheets +# created by doxygen. Using this option one can overrule certain style aspects. +# This is preferred over using HTML_STYLESHEET since it does not replace the +# standard style sheet and is therefore more robust against future updates. +# Doxygen will copy the style sheet files to the output directory. +# Note: The order of the extra style sheet files is of importance (e.g. the last +# style sheet in the list overrules the setting of the previous ones in the +# list). For an example see the documentation. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_EXTRA_STYLESHEET = + +# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or +# other source files which should be copied to the HTML output directory. Note +# that these files will be copied to the base HTML output directory. Use the +# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these +# files. In the HTML_STYLESHEET file, use the file name only. Also note that the +# files will be copied as-is; there are no commands or markers available. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_EXTRA_FILES = + +# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen +# will adjust the colors in the style sheet and background images according to +# this color. Hue is specified as an angle on a colorwheel, see +# http://en.wikipedia.org/wiki/Hue for more information. For instance the value +# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 +# purple, and 360 is red again. +# Minimum value: 0, maximum value: 359, default value: 220. +# This tag requires that the tag GENERATE_HTML is set to YES. + +# HTML_COLORSTYLE_HUE = 240 + +# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors +# in the HTML output. For a value of 0 the output will use grayscales only. A +# value of 255 will produce the most vivid colors. +# Minimum value: 0, maximum value: 255, default value: 100. +# This tag requires that the tag GENERATE_HTML is set to YES. + +#HTML_COLORSTYLE_SAT = 100 + +# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the +# luminance component of the colors in the HTML output. Values below 100 +# gradually make the output lighter, whereas values above 100 make the output +# darker. The value divided by 100 is the actual gamma applied, so 80 represents +# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not +# change the gamma. +# Minimum value: 40, maximum value: 240, default value: 80. +# This tag requires that the tag GENERATE_HTML is set to YES. + +#HTML_COLORSTYLE_GAMMA = 80 + +# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML +# page will contain the date and time when the page was generated. Setting this +# to YES can help to show when doxygen was last run and thus if the +# documentation is up to date. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_TIMESTAMP = NO + +# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML +# documentation will contain sections that can be hidden and shown after the +# page has loaded. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_DYNAMIC_SECTIONS = NO + +# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries +# shown in the various tree structured indices initially; the user can expand +# and collapse entries dynamically later on. Doxygen will expand the tree to +# such a level that at most the specified number of entries are visible (unless +# a fully collapsed tree already exceeds this amount). So setting the number of +# entries 1 will produce a full collapsed tree by default. 0 is a special value +# representing an infinite number of entries and will result in a full expanded +# tree by default. +# Minimum value: 0, maximum value: 9999, default value: 100. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_INDEX_NUM_ENTRIES = 100 + +# If the GENERATE_DOCSET tag is set to YES, additional index files will be +# generated that can be used as input for Apple's Xcode 3 integrated development +# environment (see: http://developer.apple.com/tools/xcode/), introduced with +# OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a +# Makefile in the HTML output directory. Running make will produce the docset in +# that directory and running make install will install the docset in +# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at +# startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html +# for more information. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_DOCSET = NO + +# This tag determines the name of the docset feed. A documentation feed provides +# an umbrella under which multiple documentation sets from a single provider +# (such as a company or product suite) can be grouped. +# The default value is: Doxygen generated docs. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_FEEDNAME = "Doxygen generated docs" + +# This tag specifies a string that should uniquely identify the documentation +# set bundle. This should be a reverse domain-name style string, e.g. +# com.mycompany.MyDocSet. Doxygen will append .docset to the name. +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_BUNDLE_ID = org.doxygen.Project + +# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify +# the documentation publisher. This should be a reverse domain-name style +# string, e.g. com.mycompany.MyDocSet.documentation. +# The default value is: org.doxygen.Publisher. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_PUBLISHER_ID = org.doxygen.Publisher + +# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. +# The default value is: Publisher. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_PUBLISHER_NAME = Publisher + +# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three +# additional HTML index files: index.hhp, index.hhc, and index.hhk. The +# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop +# (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on +# Windows. +# +# The HTML Help Workshop contains a compiler that can convert all HTML output +# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML +# files are now used as the Windows 98 help format, and will replace the old +# Windows help format (.hlp) on all Windows platforms in the future. Compressed +# HTML files also contain an index, a table of contents, and you can search for +# words in the documentation. The HTML workshop also contains a viewer for +# compressed HTML files. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_HTMLHELP = NO + +# The CHM_FILE tag can be used to specify the file name of the resulting .chm +# file. You can add a path in front of the file if the result should not be +# written to the html output directory. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +CHM_FILE = + +# The HHC_LOCATION tag can be used to specify the location (absolute path +# including file name) of the HTML help compiler (hhc.exe). If non-empty, +# doxygen will try to run the HTML help compiler on the generated index.hhp. +# The file has to be specified with full path. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +HHC_LOCATION = + +# The GENERATE_CHI flag controls if a separate .chi index file is generated +# (YES) or that it should be included in the master .chm file (NO). +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +GENERATE_CHI = NO + +# The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc) +# and project file content. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +CHM_INDEX_ENCODING = + +# The BINARY_TOC flag controls whether a binary table of contents is generated +# (YES) or a normal table of contents (NO) in the .chm file. Furthermore it +# enables the Previous and Next buttons. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +BINARY_TOC = NO + +# The TOC_EXPAND flag can be set to YES to add extra items for group members to +# the table of contents of the HTML help documentation and to the tree view. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +TOC_EXPAND = NO + +# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and +# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that +# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help +# (.qch) of the generated HTML documentation. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_QHP = NO + +# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify +# the file name of the resulting .qch file. The path specified is relative to +# the HTML output folder. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QCH_FILE = + +# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help +# Project output. For more information please see Qt Help Project / Namespace +# (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace). +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_NAMESPACE = org.doxygen.Project + +# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt +# Help Project output. For more information please see Qt Help Project / Virtual +# Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual- +# folders). +# The default value is: doc. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_VIRTUAL_FOLDER = doc + +# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom +# filter to add. For more information please see Qt Help Project / Custom +# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- +# filters). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_CUST_FILTER_NAME = + +# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the +# custom filter to add. For more information please see Qt Help Project / Custom +# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- +# filters). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_CUST_FILTER_ATTRS = + +# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this +# project's filter section matches. Qt Help Project / Filter Attributes (see: +# http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_SECT_FILTER_ATTRS = + +# The QHG_LOCATION tag can be used to specify the location of Qt's +# qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the +# generated .qhp file. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHG_LOCATION = + +# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be +# generated, together with the HTML files, they form an Eclipse help plugin. To +# install this plugin and make it available under the help contents menu in +# Eclipse, the contents of the directory containing the HTML and XML files needs +# to be copied into the plugins directory of eclipse. The name of the directory +# within the plugins directory should be the same as the ECLIPSE_DOC_ID value. +# After copying Eclipse needs to be restarted before the help appears. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_ECLIPSEHELP = NO + +# A unique identifier for the Eclipse help plugin. When installing the plugin +# the directory name containing the HTML and XML files should also have this +# name. Each documentation set should have its own identifier. +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES. + +ECLIPSE_DOC_ID = org.doxygen.Project + +# If you want full control over the layout of the generated HTML pages it might +# be necessary to disable the index and replace it with your own. The +# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top +# of each HTML page. A value of NO enables the index and the value YES disables +# it. Since the tabs in the index contain the same information as the navigation +# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +DISABLE_INDEX = NO + +# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index +# structure should be generated to display hierarchical information. If the tag +# value is set to YES, a side panel will be generated containing a tree-like +# index structure (just like the one that is generated for HTML Help). For this +# to work a browser that supports JavaScript, DHTML, CSS and frames is required +# (i.e. any modern browser). Windows users are probably better off using the +# HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can +# further fine-tune the look of the index. As an example, the default style +# sheet generated by doxygen has an example that shows how to put an image at +# the root of the tree instead of the PROJECT_NAME. Since the tree basically has +# the same information as the tab index, you could consider setting +# DISABLE_INDEX to YES when enabling this option. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_TREEVIEW = YES + +# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that +# doxygen will group on one line in the generated HTML documentation. +# +# Note that a value of 0 will completely suppress the enum values from appearing +# in the overview section. +# Minimum value: 0, maximum value: 20, default value: 4. +# This tag requires that the tag GENERATE_HTML is set to YES. + +ENUM_VALUES_PER_LINE = 4 + +# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used +# to set the initial width (in pixels) of the frame in which the tree is shown. +# Minimum value: 0, maximum value: 1500, default value: 250. +# This tag requires that the tag GENERATE_HTML is set to YES. + +TREEVIEW_WIDTH = 200 + +# If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to +# external symbols imported via tag files in a separate window. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +EXT_LINKS_IN_WINDOW = NO + +# Use this tag to change the font size of LaTeX formulas included as images in +# the HTML documentation. When you change the font size after a successful +# doxygen run you need to manually remove any form_*.png images from the HTML +# output directory to force them to be regenerated. +# Minimum value: 8, maximum value: 50, default value: 10. +# This tag requires that the tag GENERATE_HTML is set to YES. + +FORMULA_FONTSIZE = 10 + +# Use the FORMULA_TRANPARENT tag to determine whether or not the images +# generated for formulas are transparent PNGs. Transparent PNGs are not +# supported properly for IE 6.0, but are supported on all modern browsers. +# +# Note that when changing this option you need to delete any form_*.png files in +# the HTML output directory before the changes have effect. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +FORMULA_TRANSPARENT = YES + +# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see +# http://www.mathjax.org) which uses client side Javascript for the rendering +# instead of using pre-rendered bitmaps. Use this if you do not have LaTeX +# installed or if you want to formulas look prettier in the HTML output. When +# enabled you may also need to install MathJax separately and configure the path +# to it using the MATHJAX_RELPATH option. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +USE_MATHJAX = NO + +# When MathJax is enabled you can set the default output format to be used for +# the MathJax output. See the MathJax site (see: +# http://docs.mathjax.org/en/latest/output.html) for more details. +# Possible values are: HTML-CSS (which is slower, but has the best +# compatibility), NativeMML (i.e. MathML) and SVG. +# The default value is: HTML-CSS. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_FORMAT = HTML-CSS + +# When MathJax is enabled you need to specify the location relative to the HTML +# output directory using the MATHJAX_RELPATH option. The destination directory +# should contain the MathJax.js script. For instance, if the mathjax directory +# is located at the same level as the HTML output directory, then +# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax +# Content Delivery Network so you can quickly see the result without installing +# MathJax. However, it is strongly recommended to install a local copy of +# MathJax from http://www.mathjax.org before deployment. +# The default value is: http://cdn.mathjax.org/mathjax/latest. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest + +# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax +# extension names that should be enabled during MathJax rendering. For example +# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_EXTENSIONS = + +# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces +# of code that will be used on startup of the MathJax code. See the MathJax site +# (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an +# example see the documentation. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_CODEFILE = + +# When the SEARCHENGINE tag is enabled doxygen will generate a search box for +# the HTML output. The underlying search engine uses javascript and DHTML and +# should work on any modern browser. Note that when using HTML help +# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) +# there is already a search function so this one should typically be disabled. +# For large projects the javascript based search engine can be slow, then +# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to +# search using the keyboard; to jump to the search box use + S +# (what the is depends on the OS and browser, but it is typically +# , /