string.h File Reference

Defines a String class for dynamically sized strings with various operations. More...

#include <cstdint>
#include <common/vector.h>
#include <stdarg.h>

Go to the source code of this file.

Classes
class	MaxOS::String
	Dynamically sized string with various operations. More...
class	MaxOS::StringBuilder
	Creates a string using a using a combination of parts with the '<<' operator. Simmilar to the logger. More...

Typedefs
typedef class MaxOS::String	MaxOS::string
	Typedef for String.

Functions
int	strlen (const char *str)
	Gets the length of a string.
char *	itoa (int base, int64_t number)
	Converts integer to string.
char *	htoa (uint64_t number)
	Converts hex to string.
bool	strcmp (char const *str1, char const *str2)
	Checks if one string pointer is equal to another string pointer.
bool	strcmp (char const *str1, MaxOS::String const &str2)
	Checks if one string pointer is equal to a String.
bool	strcmp (MaxOS::String const &str1, char const *str2)
	Checks if one String is equal to a string pointer.
bool	strcmp (MaxOS::String const &str1, MaxOS::String const &str2)
	Checks if one String is equal to another String (better use is of "==")
bool	strncmp (char const *str1, char const *str2, int length)
	Checks if one string pointer is equal to another string pointer up to a specified length (each must be >= this length)
bool	strncmp (char const *str1, MaxOS::String const &str2, int length)
	Checks if one string pointer is equal to another String up to a specified length (each must be >= this length)
bool	strncmp (MaxOS::String const &str1, char const *str2, int length)
	Checks if one String is equal to another string pointer up to a specified length (each must be >= this length)
bool	strncmp (MaxOS::String const &str1, MaxOS::String const &str2, int length)
	Checks if one String is equal to another String up to a specified length (each must be >= this length)

Variables
constexpr int	MaxOS::MAX_STRING_SMALL_STORAGE = 0x99
	How many characters can be stored in the small string optimization array.

Detailed Description

Defines a String class for dynamically sized strings with various operations.

Date

12th April 2023

Author

Max Tyson

Definition in file string.h.

Function Documentation

htoa()

char * htoa

(

uint64_t

number

)

Converts hex to string.

Parameters

number

The number to convert

Returns

The converted string

Definition at line 738 of file string.cpp.

                            {
    // If there is no buffer use a default buffer
    static char buffer[50] = { 0 };
    int i = 49;
 
    // Null terminate the string
    buffer[i] = '\0';
    --i;
 
    if (number == 0) {
        buffer[i] = '0';
        return &buffer[i];
    }
 
    for (; number && i; --i, number /= 16)
        buffer[i] = "0123456789ABCDEF"[number % 16];
 
    return &buffer[i + 1];
}

Referenced by MaxOS::String::String(), and MaxOS::common::OutputStream::write_hex().

itoa()

char * itoa	(	int	base,
		int64_t	number
	)

Converts integer to string.

Parameters

base	The base of the number (10 for decimal, 16 for hex)
number	The number to convert

Returns

The converted string

Definition at line 703 of file string.cpp.

                                     {
 
    // If there is no buffer use a default buffer
    static char buffer[50] = { 0 };
 
    int i = 49;
    bool is_negative = number < 0;
 
    // Null terminate the string
    buffer[i] = '\0';
    --i;
 
    if (number == 0) {
        buffer[i] = '0';
        return &buffer[i];
    }
 
 
    for (; number && i; --i, number /= base)
        buffer[i] = "0123456789ABCDEF"[number % base];
 
    if (is_negative) {
        buffer[i] = '-';
        return &buffer[i];
    }
 
    return &buffer[i + 1];
}

Referenced by MaxOS::String::String(), and MaxOS::common::OutputStream::write_int().

strcmp() [1/4]

bool strcmp	(	char const *	str1,
		char const *	str2
	)

Checks if one string pointer is equal to another string pointer.

Parameters

str1	The first string
str2	The second string

Returns

True if the strings are equal, false otherwise

Definition at line 765 of file string.cpp.

                                                {
 
    // Check if the strings are equal
    for (int i = 0; str1[i] != '\0' || str2[i] != '\0'; i++)
        if (str1[i] != str2[i])
            return false;
 
    // The strings are equal
    return true;
 
}

Referenced by MaxOS::drivers::console::VESABootConsole::put_character(), strcmp(), strcmp(), and strcmp().

strcmp() [2/4]

bool strcmp	(	char const *	str1,
		String const &	str2
	)

Checks if one string pointer is equal to a String.

Parameters

str1	The first string
str2	The second string

Returns

True if the strings are equal, false otherwise

Definition at line 784 of file string.cpp.

                                                  {
 
    // Use the other strcmp function
    return strcmp(str1, str2.c_str());
 
}

References MaxOS::String::c_str(), and strcmp().

strcmp() [3/4]

bool strcmp	(	String const &	str1,
		char const *	str2
	)

Checks if one String is equal to a string pointer.

Parameters

str1	The first string
str2	The second string

Returns

True if the strings are equal, false otherwise

Definition at line 798 of file string.cpp.

                                                  {
 
    // Use the other strcmp function
    return strcmp(str1.c_str(), str2);
}

References MaxOS::String::c_str(), and strcmp().

strcmp() [4/4]

bool strcmp	(	String const &	str1,
		String const &	str2
	)

Checks if one String is equal to another String (better use is of "==")

Parameters

str1	The first string
str2	The second string

Returns

True if the strings are equal, false otherwise

Definition at line 811 of file string.cpp.

                                                    {
 
    // Use the other strcmp function
    return strcmp(str1.c_str(), str2.c_str());
 
}

References MaxOS::String::c_str(), and strcmp().

strlen()

int strlen

(

const char *

str

)

Gets the length of a string.

Parameters

str	The string to get the length of

Returns

The length of the string

Definition at line 689 of file string.cpp.

                            {
    int len = 0;
    for (; str[len] != '\0'; len++);
    return len;
}

Referenced by MaxOS::String::String(), and MaxOS::String::String().

strncmp() [1/4]

bool strncmp	(	char const *	str1,
		char const *	str2,
		int	length
	)

Checks if one string pointer is equal to another string pointer up to a specified length (each must be >= this length)

Parameters

str1	The first string
str2	The second string
length	The length of the string to compare

Returns

True if the strings are equal, false otherwise

Definition at line 826 of file string.cpp.

                                                             {
 
    // Check if the strings are equal
    for (int i = 0; i < length; i++)
        if (str1[i] != str2[i])
            return false;
 
    // Strings are equal
    return true;
 
}

Referenced by MaxOS::hardwarecommunication::AdvancedConfigurationAndPowerInterface::find(), strncmp(), strncmp(), and strncmp().

strncmp() [2/4]

bool strncmp	(	char const *	str1,
		String const &	str2,
		int	length
	)

Checks if one string pointer is equal to another String up to a specified length (each must be >= this length)

Parameters

str1	The first string
str2	The second string
length	The length of the string to compare

Returns

True if the strings are equal, false otherwise

Definition at line 846 of file string.cpp.

                                                               {
 
    // Use the other strncmp function
    return strncmp(str1, str2.c_str(), length);
 
}

References MaxOS::String::c_str(), and strncmp().

strncmp() [3/4]

bool strncmp	(	String const &	str1,
		char const *	str2,
		int	length
	)

Checks if one String is equal to another string pointer up to a specified length (each must be >= this length)

Parameters

str1	The first string
str2	The second string
length	The length of the string to compare

Returns

True if the strings are equal, false otherwise

Definition at line 861 of file string.cpp.

                                                               {
 
    // Use the other strncmp function
    return strncmp(str1.c_str(), str2, length);
 
}

References MaxOS::String::c_str(), and strncmp().

strncmp() [4/4]

bool strncmp	(	String const &	str1,
		String const &	str2,
		int	length
	)

Checks if one String is equal to another String up to a specified length (each must be >= this length)

Parameters

str1	The first string
str2	The second string
length	The length of the string to compare

Returns

True if the strings are equal, false otherwise

Definition at line 876 of file string.cpp.

                                                                 {
 
    // Use the other strncmp function
    return strncmp(str1.c_str(), str2.c_str(), length);
}

References MaxOS::String::c_str(), and strncmp().

Variable Documentation

MAX_STRING_SMALL_STORAGE

constexpr int MaxOS::MAX_STRING_SMALL_STORAGE = 0x99

constexpr

How many characters can be stored in the small string optimization array.

Definition at line 20 of file string.h.