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