]> git.sesse.net Git - casparcg/blobdiff - protocol/osc/oscpack/OscOutboundPacketStream.h
set svn:eol-style native on .h and .cpp files
[casparcg] / protocol / osc / oscpack / OscOutboundPacketStream.h
index a542445ca0023621728a9c8d6d02a5965b27861a..5faefb901d353344f6740a83d4d4d3161a87fc00 100644 (file)
-/*\r
-       oscpack -- Open Sound Control packet manipulation library\r
-       http://www.audiomulch.com/~rossb/oscpack\r
-\r
-       Copyright (c) 2004-2005 Ross Bencina <rossb@audiomulch.com>\r
-\r
-       Permission is hereby granted, free of charge, to any person obtaining\r
-       a copy of this software and associated documentation files\r
-       (the "Software"), to deal in the Software without restriction,\r
-       including without limitation the rights to use, copy, modify, merge,\r
-       publish, distribute, sublicense, and/or sell copies of the Software,\r
-       and to permit persons to whom the Software is furnished to do so,\r
-       subject to the following conditions:\r
-\r
-       The above copyright notice and this permission notice shall be\r
-       included in all copies or substantial portions of the Software.\r
-\r
-       Any person wishing to distribute modifications to the Software is\r
-       requested to send the modifications to the original developer so that\r
-       they can be incorporated into the canonical version.\r
-\r
-       THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,\r
-       EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF\r
-       MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.\r
-       IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR\r
-       ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF\r
-       CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION\r
-       WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\r
-*/\r
-#ifndef INCLUDED_OSCOUTBOUNDPACKET_H\r
-#define INCLUDED_OSCOUTBOUNDPACKET_H\r
-\r
-#include "OscTypes.h"\r
-#include "OscException.h"\r
-\r
-\r
-namespace osc{\r
-\r
-class OutOfBufferMemoryException : public Exception{\r
-public:\r
-    OutOfBufferMemoryException( const char *w="out of buffer memory" )\r
-        : Exception( w ) {}\r
-};\r
-\r
-class BundleNotInProgressException : public Exception{\r
-public:\r
-    BundleNotInProgressException(\r
-            const char *w="call to EndBundle when bundle is not in progress" )\r
-        : Exception( w ) {}\r
-};\r
-\r
-class MessageInProgressException : public Exception{\r
-public:\r
-    MessageInProgressException(\r
-            const char *w="opening or closing bundle or message while message is in progress" )\r
-        : Exception( w ) {}\r
-};\r
-\r
-class MessageNotInProgressException : public Exception{\r
-public:\r
-    MessageNotInProgressException(\r
-            const char *w="call to EndMessage when message is not in progress" )\r
-        : Exception( w ) {}\r
-};\r
-\r
-\r
-class OutboundPacketStream{\r
-public:\r
-       OutboundPacketStream( char *buffer, unsigned long capacity );\r
-       ~OutboundPacketStream();\r
-\r
-    void Clear();\r
-\r
-    unsigned int Capacity() const;\r
-\r
-    // invariant: size() is valid even while building a message.\r
-    unsigned int Size() const;\r
-\r
-    const char *Data() const;\r
-\r
-    // indicates that all messages have been closed with a matching EndMessage\r
-    // and all bundles have been closed with a matching EndBundle\r
-    bool IsReady() const;\r
-\r
-    bool IsMessageInProgress() const;\r
-    bool IsBundleInProgress() const;\r
-\r
-    OutboundPacketStream& operator<<( const BundleInitiator& rhs );\r
-    OutboundPacketStream& operator<<( const BundleTerminator& rhs );\r
-    \r
-    OutboundPacketStream& operator<<( const BeginMessage& rhs );\r
-    OutboundPacketStream& operator<<( const MessageTerminator& rhs );\r
-\r
-    OutboundPacketStream& operator<<( bool rhs );\r
-    OutboundPacketStream& operator<<( const NilType& rhs );\r
-    OutboundPacketStream& operator<<( const InfinitumType& rhs );\r
-    OutboundPacketStream& operator<<( int32 rhs );\r
-\r
-//#ifndef __x86_64__\r
-//    OutboundPacketStream& operator<<( int rhs )\r
-//            { *this << (int32)rhs; return *this; }\r
-//#endif\r
-\r
-    OutboundPacketStream& operator<<( float rhs );\r
-    OutboundPacketStream& operator<<( char rhs );\r
-    OutboundPacketStream& operator<<( const RgbaColor& rhs );\r
-    OutboundPacketStream& operator<<( const MidiMessage& rhs );\r
-    OutboundPacketStream& operator<<( int64 rhs );\r
-    OutboundPacketStream& operator<<( const TimeTag& rhs );\r
-    OutboundPacketStream& operator<<( double rhs );\r
-    OutboundPacketStream& operator<<( const char* rhs );\r
-    OutboundPacketStream& operator<<( const Symbol& rhs );\r
-    OutboundPacketStream& operator<<( const Blob& rhs );\r
-\r
-private:\r
-\r
-    char *BeginElement( char *beginPtr );\r
-    void EndElement( char *endPtr );\r
-\r
-    bool ElementSizeSlotRequired() const;\r
-    void CheckForAvailableBundleSpace();\r
-    void CheckForAvailableMessageSpace( const char *addressPattern );\r
-    void CheckForAvailableArgumentSpace( long argumentLength );\r
-\r
-    char *data_;\r
-    char *end_;\r
-\r
-    char *typeTagsCurrent_; // stored in reverse order\r
-    char *messageCursor_;\r
-    char *argumentCurrent_;\r
-\r
-    // elementSizePtr_ has two special values: 0 indicates that a bundle\r
-    // isn't open, and elementSizePtr_==data_ indicates that a bundle is\r
-    // open but that it doesn't have a size slot (ie the outermost bundle)\r
-    uint32 *elementSizePtr_;\r
-\r
-    bool messageIsInProgress_;\r
-};\r
-\r
-} // namespace osc\r
-\r
-#endif /* INCLUDED_OSC_OUTBOUND_PACKET_H */\r
+/*
+       oscpack -- Open Sound Control packet manipulation library
+       http://www.audiomulch.com/~rossb/oscpack
+
+       Copyright (c) 2004-2005 Ross Bencina <rossb@audiomulch.com>
+
+       Permission is hereby granted, free of charge, to any person obtaining
+       a copy of this software and associated documentation files
+       (the "Software"), to deal in the Software without restriction,
+       including without limitation the rights to use, copy, modify, merge,
+       publish, distribute, sublicense, and/or sell copies of the Software,
+       and to permit persons to whom the Software is furnished to do so,
+       subject to the following conditions:
+
+       The above copyright notice and this permission notice shall be
+       included in all copies or substantial portions of the Software.
+
+       Any person wishing to distribute modifications to the Software is
+       requested to send the modifications to the original developer so that
+       they can be incorporated into the canonical version.
+
+       THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+       EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+       MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+       IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR
+       ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
+       CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+       WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+*/
+#ifndef INCLUDED_OSCOUTBOUNDPACKET_H
+#define INCLUDED_OSCOUTBOUNDPACKET_H
+
+#include "OscTypes.h"
+#include "OscException.h"
+
+
+namespace osc{
+
+class OutOfBufferMemoryException : public Exception{
+public:
+    OutOfBufferMemoryException( const char *w="out of buffer memory" )
+        : Exception( w ) {}
+};
+
+class BundleNotInProgressException : public Exception{
+public:
+    BundleNotInProgressException(
+            const char *w="call to EndBundle when bundle is not in progress" )
+        : Exception( w ) {}
+};
+
+class MessageInProgressException : public Exception{
+public:
+    MessageInProgressException(
+            const char *w="opening or closing bundle or message while message is in progress" )
+        : Exception( w ) {}
+};
+
+class MessageNotInProgressException : public Exception{
+public:
+    MessageNotInProgressException(
+            const char *w="call to EndMessage when message is not in progress" )
+        : Exception( w ) {}
+};
+
+
+class OutboundPacketStream{
+public:
+       OutboundPacketStream( char *buffer, unsigned long capacity );
+       ~OutboundPacketStream();
+
+    void Clear();
+
+    unsigned int Capacity() const;
+
+    // invariant: size() is valid even while building a message.
+    unsigned int Size() const;
+
+    const char *Data() const;
+
+    // indicates that all messages have been closed with a matching EndMessage
+    // and all bundles have been closed with a matching EndBundle
+    bool IsReady() const;
+
+    bool IsMessageInProgress() const;
+    bool IsBundleInProgress() const;
+
+    OutboundPacketStream& operator<<( const BundleInitiator& rhs );
+    OutboundPacketStream& operator<<( const BundleTerminator& rhs );
+    
+    OutboundPacketStream& operator<<( const BeginMessage& rhs );
+    OutboundPacketStream& operator<<( const MessageTerminator& rhs );
+
+    OutboundPacketStream& operator<<( bool rhs );
+    OutboundPacketStream& operator<<( const NilType& rhs );
+    OutboundPacketStream& operator<<( const InfinitumType& rhs );
+    OutboundPacketStream& operator<<( int32 rhs );
+
+//#ifndef __x86_64__
+//    OutboundPacketStream& operator<<( int rhs )
+//            { *this << (int32)rhs; return *this; }
+//#endif
+
+    OutboundPacketStream& operator<<( float rhs );
+    OutboundPacketStream& operator<<( char rhs );
+    OutboundPacketStream& operator<<( const RgbaColor& rhs );
+    OutboundPacketStream& operator<<( const MidiMessage& rhs );
+    OutboundPacketStream& operator<<( int64 rhs );
+    OutboundPacketStream& operator<<( const TimeTag& rhs );
+    OutboundPacketStream& operator<<( double rhs );
+    OutboundPacketStream& operator<<( const char* rhs );
+    OutboundPacketStream& operator<<( const Symbol& rhs );
+    OutboundPacketStream& operator<<( const Blob& rhs );
+
+private:
+
+    char *BeginElement( char *beginPtr );
+    void EndElement( char *endPtr );
+
+    bool ElementSizeSlotRequired() const;
+    void CheckForAvailableBundleSpace();
+    void CheckForAvailableMessageSpace( const char *addressPattern );
+    void CheckForAvailableArgumentSpace( long argumentLength );
+
+    char *data_;
+    char *end_;
+
+    char *typeTagsCurrent_; // stored in reverse order
+    char *messageCursor_;
+    char *argumentCurrent_;
+
+    // elementSizePtr_ has two special values: 0 indicates that a bundle
+    // isn't open, and elementSizePtr_==data_ indicates that a bundle is
+    // open but that it doesn't have a size slot (ie the outermost bundle)
+    uint32 *elementSizePtr_;
+
+    bool messageIsInProgress_;
+};
+
+} // namespace osc
+
+#endif /* INCLUDED_OSC_OUTBOUND_PACKET_H */