ExternalString.hpp

Go to the documentation of this file.

// ======================================================================
// @file   ExternalString.hpp
// @author Robert Bocchino
// @brief  A string backed by an external buffer
// ======================================================================
 
#ifndef FW_EXTERNAL_STRING_HPP
#define FW_EXTERNAL_STRING_HPP
 
#include <FpConfig.hpp>
 
#include "Fw/Types/StringBase.hpp"
 
namespace Fw {
 
class ExternalString final : public Fw::StringBase {
  public:
    // ----------------------------------------------------------------------
    // Construction and destruction
    // ----------------------------------------------------------------------
 
    ExternalString(const ExternalString&) = delete;
 
    ExternalString() : StringBase(), m_bufferPtr(nullptr), m_bufferSize(0) {}
 
    ExternalString(char* bufferPtr,                 
                   StringBase::SizeType bufferSize  
                   )
        : StringBase(), m_bufferPtr(bufferPtr), m_bufferSize(bufferSize) {
        *this = "";
    }
 
    ExternalString(char* bufferPtr,                  
                   StringBase::SizeType bufferSize,  
                   const StringBase& sb              
                   )
        : StringBase(), m_bufferPtr(bufferPtr), m_bufferSize(bufferSize) {
        *this = sb;
    }
 
    ExternalString(char* bufferPtr,                  
                   StringBase::SizeType bufferSize,  
                   const char* str                   
                   )
        : StringBase(), m_bufferPtr(bufferPtr), m_bufferSize(bufferSize) {
        *this = str;
    }
 
    ~ExternalString() {}
 
  public:
    // ----------------------------------------------------------------------
    // StringBase interface
    // ----------------------------------------------------------------------
 
    const char* toChar() const { return this->m_bufferPtr; }
 
    StringBase::SizeType getCapacity() const { return this->m_bufferSize; }
 
  public:
    // ----------------------------------------------------------------------
    // Public interface
    // ----------------------------------------------------------------------
 
    void setBuffer(char* bufferPtr,                 
                   StringBase::SizeType bufferSize  
    ) {
        this->m_bufferPtr = bufferPtr;
        this->m_bufferSize = bufferSize;
        *this = "";
    }
 
  public:
    // ----------------------------------------------------------------------
    // Operators
    // ----------------------------------------------------------------------
 
    // Operator= (const ExternalString&)
    ExternalString& operator=(const ExternalString& src) {
        (void)StringBase::operator=(src);
        return *this;
    }
 
    // Operator= (const StringBase&)
    ExternalString& operator=(const StringBase& src) {
        (void)StringBase::operator=(src);
        return *this;
    }
 
    // const char* assignment operator
    ExternalString& operator=(const char* src) {
        (void)StringBase::operator=(src);
        return *this;
    }
 
  private:
    // ----------------------------------------------------------------------
    // Data members
    // ----------------------------------------------------------------------
 
    char* m_bufferPtr;
 
    StringBase::SizeType m_bufferSize;
};
}  // namespace Fw
 
#endif