StringBase.hpp

Go to the documentation of this file.

#ifndef FW_STRING_BASE_HPP
#define FW_STRING_BASE_HPP
#include <Fw/FPrimeBasicTypes.hpp>
#include <Fw/Types/Serializable.hpp>
#include <Fw/Types/format.hpp>
#include <cstdarg>
#ifdef BUILD_UT
#include <iostream>
#endif

namespace Fw {

class StringBase : public Serializable {
  public:
    using SizeType = FwSizeType;
    virtual const CHAR* toChar() const = 0;    //<! Convert to a C-style char*
    virtual SizeType getCapacity() const = 0;  
    SizeType length() const;                   

    SizeType maxLength() const;
    static constexpr SizeType STATIC_SERIALIZED_SIZE(SizeType maxLength  
    ) {
        return static_cast<SizeType>(sizeof(FwSizeStoreType)) + maxLength;
    }

    static constexpr SizeType BUFFER_SIZE(SizeType maxLength  
    ) {
        // Reserve one byte for each character plus one for the null terminator
        return maxLength + 1;
    }

    SizeType serializedSize() const;

    SizeType serializedTruncatedSize(FwSizeType maxLength  
    ) const;

    const CHAR* operator+=(const CHAR* src);              
    const StringBase& operator+=(const StringBase& src);  
    bool operator==(const StringBase& other) const;       
    bool operator==(const CHAR* other) const;             
    bool operator!=(const StringBase& other) const;       
    bool operator!=(const CHAR* other) const;             
    StringBase& operator=(const CHAR* src);               
    StringBase& operator=(const StringBase& src);         

    FormatStatus format(const CHAR* formatString, ...);            
    FormatStatus vformat(const CHAR* formatString, va_list args);  

    SerializeStatus serializeTo(SerializeBufferBase& buffer) const override;
    virtual SerializeStatus serializeTo(SerializeBufferBase& buffer, SizeType maxLen) const;
    SerializeStatus deserializeFrom(SerializeBufferBase& buffer) override;

    DEPRECATED(SerializeStatus serialize(SerializeBufferBase& buffer) const,
               "Use serializeTo(SerializeBufferBase& buffer) instead") {
        return this->serializeTo(buffer);
    }

    DEPRECATED(SerializeStatus serialize(SerializeBufferBase& buffer, SizeType maxLen) const,
               "Use serializeTo(SerializeBufferBase& buffer, SizeType maxLen) instead") {
        return this->serializeTo(buffer, maxLen);
    }

#ifdef BUILD_UT
    // to support GoogleTest framework in unit tests
    friend std::ostream& operator<<(std::ostream& os, const StringBase& str);
#endif
#if FW_SERIALIZABLE_TO_STRING || BUILD_UT
    void toString(StringBase& text) const override;  
#endif

  protected:
    StringBase();
    virtual ~StringBase();

    void appendBuff(const CHAR* buff, SizeType size);

  private:
    StringBase(const StringBase& src) = delete;  
};

}  // namespace Fw

#endif