fprime/Fw/Types/StringType.cpp

/**
 * \file
 * \author T. Canham
 * \brief Implements ISF string base class
 *
 * \copyright
 * Copyright 2009-2016, by the California Institute of Technology.
 * ALL RIGHTS RESERVED.  United States Government Sponsorship
 * acknowledged.
 *
 */

#include <Fw/Types/StringType.hpp>
#include <Fw/Types/Assert.hpp>
#include <Fw/Types/StringUtils.hpp>
#include <cstring>
#include <cstdio>
#include <cstdarg>

namespace Fw {

    StringBase::StringBase() {
    }

    StringBase::~StringBase() {
    }

    const CHAR* StringBase::operator+=(const CHAR* src) {
        this->appendBuff(src, StringUtils::string_length(src, this->getCapacity()));
        return this->toChar();
    }

    const StringBase& StringBase::operator+=(const StringBase& src) {
        this->appendBuff(src.toChar(), src.length());
        return *this;
    }

    bool StringBase::operator==(const StringBase& other) const {
        NATIVE_UINT_TYPE len = this->length();
        if (len != other.length()) {
            return false;
        } else {
            return this->operator==(other.toChar());
        }
    }

    bool StringBase::operator==(const CHAR* other) const {

        const CHAR *const us = this->toChar();
        if ((us == nullptr) or (other == nullptr)) {
            return false;
        }

        const NATIVE_UINT_TYPE capacity = this->getCapacity();
        const size_t result = strncmp(us, other, capacity);
        return (result == 0);

    }

    void StringBase::format(const CHAR* formatString, ...) {
        CHAR* us = const_cast<CHAR*>(this->toChar());
        NATIVE_UINT_TYPE cap = this->getCapacity();
        FW_ASSERT(us);
        va_list args;
        va_start(args, formatString);
        (void) vsnprintf(us, cap, formatString, args);
        va_end(args);
        // null terminate
        us[cap - 1] = 0;
    }

    bool StringBase::operator!=(const StringBase& other) const {
        return !operator==(other);
    }

    bool StringBase::operator!=(const CHAR* other) const {
        return !operator==(other);
    }

#if FW_SERIALIZABLE_TO_STRING || BUILD_UT
    void StringBase::toString(StringBase& text) const {
        text = *this;
    }
#endif

#ifdef BUILD_UT
    std::ostream& operator<<(std::ostream& os, const StringBase& str)
    {
        os << str.toChar();
        return os;
    }
#endif

    StringBase& StringBase::operator=(const StringBase& other) {
        if(this == &other) {
            return *this;
        }

        (void) Fw::StringUtils::string_copy(const_cast<char *>(this->toChar()), other.toChar(), this->getCapacity());
        return *this;
    }

    // Copy constructor doesn't make sense in this virtual class as there is nothing to copy. Derived classes should
    // call the empty constructor and then call their own copy function
    StringBase& StringBase::operator=(const CHAR* other) { // lgtm[cpp/rule-of-two]
        (void) Fw::StringUtils::string_copy(const_cast<char *>(this->toChar()), other, this->getCapacity());
        return *this;
    }

    void StringBase::appendBuff(const CHAR* buff, NATIVE_UINT_TYPE size) {
        const U32 capacity = this->getCapacity();
        const U32 length = this->length();
        FW_ASSERT(capacity > length, capacity, length);
        // Subtract 1 to leave space for null terminator
        U32 remaining = capacity - length - 1;
        if(size < remaining) {
            remaining = size;
        }
        FW_ASSERT(remaining < capacity, remaining, capacity);
        (void) strncat(const_cast<CHAR*>(this->toChar()), buff, remaining);
    }

    NATIVE_UINT_TYPE StringBase::length() const {
        return static_cast<NATIVE_UINT_TYPE>(StringUtils::string_length(this->toChar(),this->getCapacity()));
    }

    SerializeStatus StringBase::serialize(SerializeBufferBase& buffer) const {
        return buffer.serialize(reinterpret_cast<const U8*>(this->toChar()),this->length());
    }

    SerializeStatus StringBase::serialize(SerializeBufferBase& buffer, NATIVE_UINT_TYPE maxLength) const {
        NATIVE_INT_TYPE len = FW_MIN(maxLength,this->length());
        return buffer.serialize(reinterpret_cast<const U8*>(this->toChar()), len);
    }

    SerializeStatus StringBase::deserialize(SerializeBufferBase& buffer) {
        NATIVE_UINT_TYPE maxSize = this->getCapacity() - 1;
        CHAR* raw = const_cast<CHAR*>(this->toChar());
        SerializeStatus stat = buffer.deserialize(reinterpret_cast<U8*>(raw),maxSize);
        // Null terminate deserialized string
        raw[maxSize] = 0;
        return stat;
    }
}