fbuffer.h

Go to the documentation of this file.

 //------------------------------------------------------------------------
// Project     : SDK Base
// Version     : 1.0
//
// Category    : Helpers
// Filename    : base/source/fbuffer.h
// Created by  : Steinberg, 2008
// Description : 
//
//-----------------------------------------------------------------------------
// LICENSE
// (c) 2023, Steinberg Media Technologies GmbH, All Rights Reserved
//-----------------------------------------------------------------------------
// Redistribution and use in source and binary forms, with or without modification,
// are permitted provided that the following conditions are met:
// 
//   * Redistributions of source code must retain the above copyright notice, 
//     this list of conditions and the following disclaimer.
//   * Redistributions in binary form must reproduce the above copyright notice,
//     this list of conditions and the following disclaimer in the documentation 
//     and/or other materials provided with the distribution.
//   * Neither the name of the Steinberg Media Technologies nor the names of its
//     contributors may be used to endorse or promote products derived from this 
//     software without specific prior written permission.
// 
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
// ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED 
// WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 
// IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, 
// INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, 
// BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF 
// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE 
// OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE  OF THIS SOFTWARE, EVEN IF ADVISED
// OF THE POSSIBILITY OF SUCH DAMAGE.
//-----------------------------------------------------------------------------
 
#pragma once
 
#include "pluginterfaces/base/ftypes.h"
#include <cstring> 
 
namespace Steinberg {
class String;
 
//------------------------------------------------------------------------
//------------------------------------------------------------------------
class Buffer
{
public:
//---------------------------------------------------------------------
    
    Buffer ();
 
    Buffer (const void* b, uint32 size);
 
    Buffer (uint32 size, uint8 initVal);
 
    Buffer (uint32 size);
 
    Buffer (const Buffer& buff);
 
    virtual ~Buffer ();
    
    void operator = (const Buffer& buff);
    
    bool operator == (const Buffer& buff)const;
 
    uint32 getSize () const {return memSize;}       
 
    bool setSize (uint32 newSize);
 
    bool grow (uint32 memSize);
    bool setMaxSize (uint32 size) {return grow (size);} 
 
    void fillup (uint8 initVal = 0);                
    uint32 getFillSize ()const {return fillSize;}   
    bool setFillSize (uint32 c);                    
    inline void flush () {setFillSize (0);}         
    bool truncateToFillSize ();                     
 
    bool isFull () const { return (fillSize == memSize); }  
    uint32 getFree () const { return (memSize - fillSize); }
 
    inline void shiftStart (int32 amount) {return shiftAt (0, amount);} 
    void shiftAt (uint32 position, int32 amount);                       
    void move (int32 amount, uint8 initVal = 0);                        
 
    bool copy (uint32 from, uint32 to, uint32 bytes);   
    uint32 get (void* b, uint32 size);                  
 
    void setDelta (uint32 d) {delta = d;}               
 
    bool put (uint8);                           
    bool put (char16 c);                        
    bool put (char c);                          
    bool put (const void* , uint32 size);       
    bool put (void* , uint32 size);             
    bool put (uint8* , uint32 size);            
    bool put (char8* , uint32 size);            
    bool put (const uint8* , uint32 size);      
    bool put (const char8* , uint32 size);      
    bool put (const String&);                   
 
    void set (uint8 value);     
    
    // strings ----------------
    bool appendString (const tchar* s);
    bool appendString (tchar* s);
    bool appendString (tchar c)                   { return put (c); }
 
    bool appendString8 (const char8* s);    
    bool appendString16 (const char16* s);
 
    bool appendString8 (char8* s)                 { return appendString8 ((const char8*)s); }
    bool appendString8 (unsigned char* s)         { return appendString8 ((const char8*)s); }         
    bool appendString8 (const unsigned char* s)   { return appendString8 ((const char8*)s); }
 
    bool appendString8 (char8 c)                  { return put ((uint8)c); }
    bool appendString8 (unsigned char c)          { return put (c); }
    bool appendString16 (char16 c)                { return put (c); }
    bool appendString16 (char16* s)               { return appendString16 ((const char16*)s); }
 
    bool prependString (const tchar* s);   
    bool prependString (tchar* s);   
    bool prependString (tchar c);                
 
    bool prependString8 (const char8* s);           
    bool prependString16 (const char16* s);
 
    bool prependString8 (char8 c);
    bool prependString8 (unsigned char c)         { return prependString8 ((char8)c); }
    bool prependString8 (char8* s)                { return prependString8 ((const char8*)s); }
    bool prependString8 (unsigned char* s)        { return prependString8((const char8*)s); }           
    bool prependString8 (const unsigned char* s)  { return prependString8 ((const char8*)s); } 
    bool prependString16 (char16 c);
    bool prependString16 (char16* s)              { return prependString16 ((const char16*)s); }
 
    bool operator+= (const char* s)               { return appendString8 (s); }
    bool operator+= (char c)                      { return appendString8 (c); }
    bool operator+= (const char16* s)             { return appendString16 (s); }
    bool operator+= (char16 c)                    { return appendString16 (c); }
 
    bool operator= (const char* s)                { flush (); return appendString8 (s); }
    bool operator= (const char16* s)              { flush (); return appendString16 (s); }
    bool operator= (char8 c)                      { flush (); return appendString8 (c); }
    bool operator= (char16 c)                     { flush (); return appendString16 (c); }
 
    void endString () {put (tchar (0));}
    void endString8 () {put (char8 (0));}
    void endString16 () {put (char16 (0));}
 
    bool makeHexString (String& result);
    bool fromHexString (const char8* string);
 
    // conversion
    operator void* () const { return (void*)buffer; }               
    inline tchar*   str ()   const {return (tchar*)buffer;}         
    inline char8*   str8 ()   const {return (char8*)buffer;}        
    inline char16*  str16 ()   const {return (char16*)buffer;}      
    inline int8*   int8Ptr ()   const {return (int8*)buffer;}       
    inline uint8*  uint8Ptr ()  const {return (uint8*)buffer; }     
    inline int16*  int16Ptr ()  const {return (int16*)buffer; }     
    inline uint16* uint16Ptr () const {return (uint16*)buffer; }    
    inline int32*  int32Ptr ()  const {return (int32*)buffer; }     
    inline uint32* uint32Ptr () const {return (uint32*)buffer; }    
    inline float*  floatPtr ()  const {return (float*)buffer; }     
    inline double* doublePtr () const {return (double*)buffer; }    
    inline char16*  wcharPtr ()  const {return (char16*)buffer;}    
 
    int8* operator + (uint32 i);    
    
    int32 operator ! ()  { return buffer == nullptr; }
    
    enum swapSize 
    {
        kSwap16 = 2,
        kSwap32 = 4,
        kSwap64 = 8
    };
    bool swap (int16 swapSize);                                         
    static bool swap (void* buffer, uint32 bufferSize, int16 swapSize); 
 
    void take (Buffer& from);   
    int8* pass ();              
 
    virtual bool toWideString (int32 sourceCodePage); // Buffer contains char8 of given encoding -> utf16
 
    virtual bool toMultibyteString (int32 destCodePage); // Buffer contains utf16 -> char8 of given encoding
 
//------------------------------------------------------------------------
protected:
    static const uint32 defaultDelta = 0x1000; // 0x1000
    
    int8* buffer;
    uint32 memSize;
    uint32 fillSize;
    uint32 delta;
};
 
inline bool Buffer::put (void* p, uint32 count)     { return put ((const void*)p , count ); }
inline bool Buffer::put (uint8 * p, uint32 count)   { return put ((const void*)p , count ); }
inline bool Buffer::put (char8* p, uint32 count)    { return put ((const void*)p , count ); }
inline bool Buffer::put (const uint8* p, uint32 count) { return put ((const void*)p , count ); }
inline bool Buffer::put (const char8* p, uint32 count) { return put ((const void*)p , count ); }
 
//------------------------------------------------------------------------
inline bool Buffer::appendString (const tchar* s)
{
#ifdef UNICODE
    return appendString16 (s);
#else
    return appendString8 (s);
#endif
}
 
//------------------------------------------------------------------------
inline bool Buffer::appendString (tchar* s)
{
#ifdef UNICODE
    return appendString16 (s);
#else
    return appendString8 (s);
#endif
}
 
//------------------------------------------------------------------------
inline bool Buffer::prependString (const tchar* s)
{
#ifdef UNICODE
    return prependString16 (s);
#else
    return prependString8 (s);
#endif
}
 
//------------------------------------------------------------------------
inline bool Buffer::prependString (tchar* s)
{
#ifdef UNICODE
    return prependString16 (s);
#else
    return prependString8 (s);
#endif
}
 
//------------------------------------------------------------------------
inline bool Buffer::prependString (tchar c)
{
#ifdef UNICODE
    return prependString16 (c);
#else
    return prependString8 (c);
#endif
}
 
//------------------------------------------------------------------------
} // namespace Steinberg