IUTF8String.h

Go to the documentation of this file.

#ifndef __IUTF8String_h__
#define __IUTF8String_h__ 1

// =================================================================================================
// Copyright 2014 Adobe Systems Incorporated
// All Rights Reserved.
//
// NOTICE:  Adobe permits you to use, modify, and distribute this file in accordance with the terms
// of the Adobe license agreement accompanying it.
// =================================================================================================

#include "XMPCommon/Interfaces/BaseInterfaces/ISharedObject.h"
#include "XMPCommon/Interfaces/BaseInterfaces/IVersionable.h"

namespace AdobeXMPCommon {
        using AdobeXMPCommon::npos;

        class XMP_PUBLIC IUTF8String_v1
                : public virtual ISharedObject
                , public virtual IVersionable
        {
        public:
                virtual spIUTF8String APICALL append( const char * buf, sizet count ) = 0;

                virtual spIUTF8String APICALL append( const spcIUTF8String & src, sizet srcPos = 0, sizet count = npos ) = 0;

                virtual spIUTF8String APICALL assign( const char * buf, sizet count ) = 0;

                virtual spIUTF8String APICALL assign( const spcIUTF8String & src, sizet srcPos = 0, sizet count = npos ) = 0;

                virtual spIUTF8String APICALL insert( sizet pos, const char * buf, sizet count ) = 0;

                virtual spIUTF8String APICALL insert( sizet pos, const spcIUTF8String & src, sizet srcPos = 0, sizet count = npos ) = 0;

                virtual spIUTF8String APICALL erase( sizet pos = 0, sizet count = npos ) = 0;

                virtual void APICALL resize( sizet n ) = 0 ;

                virtual spIUTF8String APICALL replace( sizet pos, sizet count, const char * buf, sizet srcCount ) = 0;

                virtual spIUTF8String APICALL replace( sizet pos, sizet count, const spcIUTF8String & src, sizet srcPos = 0, sizet srcCount = npos ) = 0;

                virtual sizet APICALL copy( char * buf, sizet len, sizet pos = 0 ) const = 0;

                sizet find( const char * buf, sizet pos = 0 ) const {
                        return find( buf, pos, npos );
                }

                virtual sizet APICALL find( const char * buf, sizet pos, sizet count ) const = 0;


                //
                virtual sizet APICALL find( const spcIUTF8String & src, sizet pos = 0, sizet count = npos ) const = 0;

                // @{
                sizet rfind( const char * buf, sizet pos = npos ) const {
                        return rfind( buf, pos, npos );
                }
                virtual sizet APICALL rfind( const char * buf, sizet pos, sizet count ) const = 0;

                virtual sizet APICALL rfind( const spcIUTF8String & src, sizet pos = npos, sizet count = npos ) const = 0;

                int32 compare( const char * buf ) const {
                        return compare( 0, size(), buf, npos );
                }
                int32 compare( sizet pos, sizet len, const char * buf ) const {
                        return compare( pos, len, buf, npos );
                }
                virtual int32 APICALL compare( sizet pos, sizet len, const char * buf, sizet count ) const = 0;
                

                int32 compare( const spcIUTF8String & str ) const {
                        return compare( 0, size(), str, 0, str->size() );
                }
                virtual int32 APICALL compare( sizet pos, sizet len, const spcIUTF8String & str, sizet strPos = 0, sizet strLen = npos ) const = 0;

                virtual spIUTF8String APICALL substr( sizet pos = 0, sizet count = npos ) const = 0;

                virtual bool APICALL empty() const = 0;

                virtual const char * APICALL c_str() const __NOTHROW__ = 0;

                virtual void APICALL clear() __NOTHROW__ = 0;

                virtual sizet APICALL size() const __NOTHROW__ = 0;

                virtual pIUTF8String APICALL GetActualIUTF8String() __NOTHROW__ = 0;
                XMP_PRIVATE pcIUTF8String GetActualIUTF8String() const __NOTHROW__ {
                        return const_cast< IUTF8String_v1 * >( this )->GetActualIUTF8String();
                }

                XMP_PRIVATE static spIUTF8String MakeShared( pIUTF8String_base ptr );
                XMP_PRIVATE static spcIUTF8String MakeShared( pcIUTF8String_base ptr ) {
                        return MakeShared( const_cast< pIUTF8String_base >( ptr ) );
                }

                XMP_PRIVATE static uint64 GetInterfaceID() { return kIUTF8StringID; }

                XMP_PRIVATE static uint32 GetInterfaceVersion() { return 1; }

                // static factory functions

                XMP_PRIVATE static spIUTF8String CreateUTF8String( pIObjectFactory objFactory );

                XMP_PRIVATE static spIUTF8String CreateUTF8String( pIObjectFactory objFactory, const char * buf, sizet count );

        protected:
                virtual ~IUTF8String_v1() __NOTHROW__ {}

                virtual pIUTF8String_base APICALL assign( const char * buffer, sizet count, pcIError_base & error ) __NOTHROW__ = 0;
                virtual pIUTF8String_base APICALL assign( pcIUTF8String_base str, sizet srcPos, sizet count, pcIError_base & error ) __NOTHROW__ = 0;
                virtual pIUTF8String_base APICALL append( const char * buffer, sizet count, pcIError_base & error ) __NOTHROW__ = 0;
                virtual pIUTF8String_base APICALL append( pcIUTF8String_base str, sizet srcPos, sizet count, pcIError_base & error ) __NOTHROW__ = 0;
                virtual pIUTF8String_base APICALL insert( sizet pos, const char * buf, sizet count, pcIError_base & error ) __NOTHROW__ = 0;
                virtual pIUTF8String_base APICALL insert( sizet pos, pcIUTF8String_base src, sizet srcPos, sizet count, pcIError_base & error ) __NOTHROW__ = 0;
                virtual pIUTF8String_base APICALL erase( sizet pos, sizet count, pcIError_base & error ) __NOTHROW__ = 0;
                virtual void APICALL resize( sizet n, pcIError_base & error ) __NOTHROW__ = 0;
                virtual pIUTF8String_base APICALL replace( sizet pos, sizet count, const char * buf, sizet srcCount, pcIError_base & error ) __NOTHROW__ = 0;
                virtual pIUTF8String_base APICALL replace( sizet pos, sizet count, pcIUTF8String_base src, sizet srcPos, sizet srcCount, pcIError_base & error ) __NOTHROW__ = 0;
                virtual sizet APICALL copy( char * buf, sizet len, sizet pos, pcIError_base & error ) const __NOTHROW__ = 0;
                virtual sizet APICALL find( const char * buf, sizet pos, sizet count, pcIError_base & error ) const __NOTHROW__ = 0;
                virtual sizet APICALL find( pcIUTF8String_base src, sizet pos, sizet count, pcIError_base & error ) const __NOTHROW__ = 0;
                virtual sizet APICALL rfind( const char * buf, sizet pos, sizet count, pcIError_base & error ) const __NOTHROW__ = 0;
                virtual sizet APICALL rfind( pcIUTF8String_base src, sizet pos, sizet count, pcIError_base & error ) const __NOTHROW__ = 0;
                virtual int32 APICALL compare( sizet pos, sizet len, const char * buf, sizet count, pcIError_base & error ) const __NOTHROW__ = 0;
                virtual int32 APICALL compare( sizet pos, sizet len, pcIUTF8String_base str, sizet strPos, sizet strLen, pcIError_base & error ) const __NOTHROW__ = 0;
                virtual pIUTF8String_base APICALL substr( sizet pos, sizet count, pcIError_base & error ) const __NOTHROW__ = 0;
                virtual uint32 APICALL empty( pcIError_base & error ) const __NOTHROW__ = 0;
        
                #ifdef FRIEND_CLASS_DECLARATION
                        FRIEND_CLASS_DECLARATION();
                #endif
                REQ_FRIEND_CLASS_DECLARATION();
        };
}

#endif  // __IUTF8String_h__