common/src/hcf_string.c

/*
* Copyright (C) 2021 Huawei Device Co., Ltd.
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
*    http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

#include <string.h>
#include "hcf_string.h"

const uint32_t STRING_ALLOC_SIZE = 10;
const uint32_t STRING_END_CHAR_LENGTH = 1;
const char STRING_END_CHAR = '\0';
#define MAX_INT 0x7FFFFFFF
#define MAX_UINT 0xFFFFFFFF

/*
* Append string pointer
* Notice: It will add '\0' automatically.
* @param self: self pointer.
* @param str: string pointer.
* @return true (ok), false (error)
*/
bool StringAppendPointer(HcString *self, const char *str)
{
    if (self != NULL && str != NULL) {
        // remove '\0'
        ParcelPopBack(&self->parcel, STRING_END_CHAR_LENGTH);
        // append string (include '\0')
        return ParcelWrite(&self->parcel, (void *)str, strlen(str) + 1);
    }

    return false;
}

/*
* Assign a value to the HcString
* Notice: It will add '\0' automatically.
* @param self: self pointer.
* @param str: assign value of string pointer.
* @return true (ok), false (error)
*/
bool StringSetPointer(HcString *self, const char *str)
{
    if (self != NULL) {
        DeleteParcel(&self->parcel);
        return StringAppendPointer(self, str);
    }

    return false;
}

/*
* Assign a value to the HcString with fixed length
* Notice: It will add '\0' automatically.
* @param self: self pointer.
* @param str: assign value of string pointer.
* @param len: the length of string.
* @return true (ok), false (error)
*/
bool StringSetPointerWithLength(HcString* self, const char *str, uint32_t len)
{
    if (self == NULL || str == NULL) {
        return false;
    }
    uint32_t strLen = strlen(str);
    if (strLen < len) {
        return false;
    }
    DeleteParcel(&self->parcel);
    if (len > 0) {
        if (false == ParcelWrite(&self->parcel, str, len)) {
            return false;
        }
    }
    return ParcelWriteInt8(&self->parcel, (uint32_t)STRING_END_CHAR);
}

/*
* Get the string pointer data
* @param self: self pointer.
* @return the pointer data of the string
*/
const char *StringGet(const HcString *self)
{
    if (self == NULL) {
        return NULL;
    }

    return GetParcelData(&self->parcel);
}

/*
* Get the length of the string
* @param self: self pointer.
* @return the length of the string
*/
uint32_t StringLength(const HcString *self)
{
    if (self == NULL) {
        return 0;
    } else {
        uint32_t length = GetParcelDataSize(&self->parcel);
        if (length > 0) {
            return length - STRING_END_CHAR_LENGTH;
        } else {
            return 0;
        }
    }
}

/*
* Find a char from string
* @param self: self pointer.
* @param c: the char you want find
* @param begin: the position find from
* @return the position of the char
*/
int StringFind(const HcString *self, char c, uint32_t begin)
{
    if (self == NULL) {
        return -1;
    }
    uint32_t p = begin;
    // because the return value is int
    // so the string length cannot bigger than MAX_INT
    uint32_t strLen = StringLength(self);
    if (strLen >= MAX_INT) {
        return -1;
    }

    const char* curChar = StringGet(self);
    if (curChar == NULL) {
        return -1;
    }

    while (p < strLen) {
        if (*(curChar + p) == c) {
            return p;
        }
        ++p;
    }
    return -1;
}

/*
* Get sub string from a string.
* @param self: self pointer.
* @param begin: the begin position of the sub string.
* @param len: the length of the sub string.
* @param dst: the string pointer which saved the sub string content.
* @return the operation result.
*/
bool StringSubString(const HcString *self, uint32_t begin, uint32_t len, HcString* dst)
{
    if (self == NULL || dst == NULL) {
        return false;
    }
    if (MAX_UINT - len <= begin) {
        return false;
    }
    const char* beingPointer = StringGet(self) + begin;
    return StringSetPointerWithLength(dst, beingPointer, len);
}

/*
* Compare the string with another string.
* @param self: self pointer.
* @param dst: the pointer of another string.
* @return the compare result.
*  -1: self is smaller than dst
*   0: self is equal with dst
*   1: self is bigger than dst
*/
int StringCompare(const HcString *self, const char* dst)
{
    if (self == NULL || dst == NULL) {
        return 0;
    }

    const char* src = StringGet(self);
    if (src == NULL) {
        return -1;
    }

    do {
        if ((*src) > (*dst)) {
            return 1;
        } else if ((*src) < (*dst)) {
            return -1;
        } else {
            if ((*src) == '\0') {
                return 0;
            }
            ++src;
            ++dst;
        }
    } while (1);
    // should never be here
    return 0;
}

/*
* Create a string.
* Notice: You should delete_string when you don't need the string anymore.
* @return return the created string.
*/
HcString CreateString(void)
{
    HcString str;
    str.parcel = CreateParcel(0, STRING_ALLOC_SIZE);
    ParcelWriteInt8(&str.parcel, STRING_END_CHAR);
    return str;
}

/*
* Delete a string. In fact it will not destroy the string,
* but only free the allocate memory of the string and reset the member's value
* of the string.
* You can continue to use the string if you want.
* Notice: You should delete the string when you don't need it any more to avoid memory leak.
* @param str: The string you want to delete.
*/
void DeleteString(HcString *str)
{
    if (str != NULL) {
        DeleteParcel(&str->parcel);
    }
}