str_view.h

Go to the documentation of this file.

 
#ifndef SV_STR_VIEW
#define SV_STR_VIEW
 
/* SV_ATTRIB_PURE has no side effects when given the same arguments with the
   same data, producing the same return value. A SV_Str_view points to char
   const * data which may change in between SV_Str_view calls. SV_ATTRIB_CONST
   applies only where no pointers are accessed or dereferenced. Other
   attributes provide more string safety and opportunities to optimize.
   Credit Harith on Code Review Stack Exchange. */
#if defined(__GNUC__) || defined(__clang__) || defined(__INTEL_LLVM_COMPILER)
#    ifdef __has_attribute
#        if __has_attribute(pure)
#            define SV_ATTRIB_PURE __attribute__((pure))
#        else
#            define SV_ATTRIB_PURE 
#        endif
#        if __has_attribute(pure)
#            define SV_ATTRIB_CONST __attribute__((const))
#        else
#            define SV_ATTRIB_CONST 
#        endif
#        if __has_attribute(null_terminated_string_arg)
#            define SV_ATTRIB_NULLTERM(...)                                    \
                __attribute__((null_terminated_string_arg(__VA_ARGS__)))
#        else
#            define SV_ATTRIB_NULLTERM(...) 
#        endif
#    else
#        define SV_ATTRIB_PURE          
#        define SV_ATTRIB_CONST         
#        define SV_ATTRIB_NULLTERM(...) 
#    endif
#    define SV_STR_LITERAL(str_literal) "" str_literal ""
#else
#    define SV_ATTRIB_PURE          
#    define SV_ATTRIB_CONST         
#    define SV_ATTRIB_NULLTERM(...) 
#    define SV_STR_LITERAL(str_literal) str_literal
#endif /* __GNUC__ || __clang__ || __INTEL_LLVM_COMPILER */
 
#if defined(_MSVC_VER) || defined(_WIN32) || defined(_WIN64)
#    if defined(SV_BUILD_DLL)
#        define SV_API __declspec(dllexport)
#    elif defined(SV_CONSUME_DLL)
#        define SV_API __declspec(dllimport)
#    else
#        define SV_API 
#    endif
#else
#    define SV_API 
#endif             /* _MSVC_VER */
 
#include <stdbool.h>
#include <stddef.h>
 
typedef struct
{
    char const *str;
    size_t len;
} SV_Str_view;
 
typedef enum
{
    SV_ORDER_LESSER = -1,
    SV_ORDER_EQUAL,
    SV_ORDER_GREATER,
    SV_ORDER_ERROR,
} SV_Order;
 
#define SV_from(str_literal)                                                   \
    ((SV_Str_view){SV_STR_LITERAL(str_literal), sizeof(str_literal) - 1})
 
SV_API SV_Str_view SV_from_terminated(char const *str)
    SV_ATTRIB_NULLTERM(1) SV_ATTRIB_PURE;
 
SV_API SV_Str_view SV_from_view(size_t n, char const *str)
    SV_ATTRIB_NULLTERM(2) SV_ATTRIB_PURE;
 
SV_API SV_Str_view SV_from_delimiter(char const *str, char const *delim)
    SV_ATTRIB_NULLTERM(1) SV_ATTRIB_NULLTERM(2) SV_ATTRIB_PURE;
 
SV_API SV_Str_view SV_substr(SV_Str_view sv, size_t pos,
                             size_t count) SV_ATTRIB_PURE;
 
SV_API size_t SV_str_bytes(char const *str)
    SV_ATTRIB_NULLTERM(1) SV_ATTRIB_PURE;
 
SV_API SV_Str_view SV_copy(size_t str_bytes, char const *src_str)
    SV_ATTRIB_NULLTERM(2) SV_ATTRIB_PURE;
 
SV_API size_t SV_fill(size_t dest_bytes, char *dest_buf, SV_Str_view src);
 
SV_API SV_Str_view SV_extend(SV_Str_view sv) SV_ATTRIB_PURE;
 
SV_API SV_Order SV_compare(SV_Str_view lhs, SV_Str_view rhs) SV_ATTRIB_PURE;
 
SV_API SV_Order SV_terminated_compare(SV_Str_view lhs, char const *rhs)
    SV_ATTRIB_NULLTERM(2) SV_ATTRIB_PURE;
 
SV_API SV_Order SV_view_compare(SV_Str_view lhs, char const *rhs, size_t n)
    SV_ATTRIB_NULLTERM(2) SV_ATTRIB_PURE;
 
SV_API SV_Str_view SV_token_begin(SV_Str_view src,
                                  SV_Str_view delim) SV_ATTRIB_PURE;
 
SV_API bool SV_token_end(SV_Str_view src, SV_Str_view token) SV_ATTRIB_PURE;
 
SV_API SV_Str_view SV_token_next(SV_Str_view src, SV_Str_view token,
                                 SV_Str_view delim) SV_ATTRIB_PURE;
 
SV_API SV_Str_view SV_token_reverse_begin(SV_Str_view src,
                                          SV_Str_view delim) SV_ATTRIB_PURE;
 
SV_API bool SV_token_reverse_end(SV_Str_view src,
                                 SV_Str_view token) SV_ATTRIB_PURE;
 
SV_API SV_Str_view SV_token_reverse_next(SV_Str_view src, SV_Str_view token,
                                         SV_Str_view delim) SV_ATTRIB_PURE;
 
SV_API char const *SV_begin(SV_Str_view sv) SV_ATTRIB_PURE;
 
SV_API char const *SV_reverse_begin(SV_Str_view sv) SV_ATTRIB_PURE;
 
SV_API char const *SV_next(char const *c) SV_ATTRIB_NULLTERM(1) SV_ATTRIB_PURE;
 
SV_API char const *SV_reverse_next(char const *c) SV_ATTRIB_PURE;
 
SV_API char const *SV_end(SV_Str_view sv) SV_ATTRIB_PURE;
 
SV_API char const *SV_reverse_end(SV_Str_view sv) SV_ATTRIB_PURE;
 
SV_API size_t SV_find(SV_Str_view haystack, size_t pos,
                      SV_Str_view needle) SV_ATTRIB_PURE;
 
SV_API size_t SV_reverse_find(SV_Str_view haystack, size_t pos,
                              SV_Str_view needle) SV_ATTRIB_PURE;
 
SV_API bool SV_contains(SV_Str_view haystack,
                        SV_Str_view needle) SV_ATTRIB_PURE;
 
SV_API SV_Str_view SV_match(SV_Str_view haystack,
                            SV_Str_view needle) SV_ATTRIB_PURE;
 
SV_API SV_Str_view SV_reverse_match(SV_Str_view haystack,
                                    SV_Str_view needle) SV_ATTRIB_PURE;
 
SV_API bool SV_starts_with(SV_Str_view sv, SV_Str_view prefix) SV_ATTRIB_PURE;
 
SV_API SV_Str_view SV_remove_prefix(SV_Str_view sv, size_t n) SV_ATTRIB_PURE;
 
SV_API bool SV_ends_with(SV_Str_view sv, SV_Str_view suffix) SV_ATTRIB_PURE;
 
SV_API SV_Str_view SV_remove_suffix(SV_Str_view sv, size_t n) SV_ATTRIB_PURE;
 
SV_API size_t SV_find_first_of(SV_Str_view haystack,
                               SV_Str_view set) SV_ATTRIB_PURE;
 
SV_API size_t SV_find_first_not_of(SV_Str_view haystack,
                                   SV_Str_view set) SV_ATTRIB_PURE;
 
SV_API size_t SV_find_last_of(SV_Str_view haystack,
                              SV_Str_view set) SV_ATTRIB_PURE;
 
SV_API size_t SV_find_last_not_of(SV_Str_view haystack,
                                  SV_Str_view set) SV_ATTRIB_PURE;
 
SV_API size_t SV_min_len(char const *str, size_t n)
    SV_ATTRIB_NULLTERM(1) SV_ATTRIB_PURE;
 
SV_API char const *SV_null(void) SV_ATTRIB_PURE;
 
SV_API size_t SV_npos(SV_Str_view sv) SV_ATTRIB_CONST;
 
SV_API bool SV_is_empty(SV_Str_view sv) SV_ATTRIB_CONST;
 
SV_API size_t SV_len(SV_Str_view sv) SV_ATTRIB_CONST;
 
SV_API size_t SV_bytes(SV_Str_view sv) SV_ATTRIB_CONST;
 
SV_API char const *SV_pointer(SV_Str_view sv, size_t i) SV_ATTRIB_PURE;
 
SV_API char SV_at(SV_Str_view sv, size_t i) SV_ATTRIB_PURE;
 
SV_API char SV_front(SV_Str_view sv) SV_ATTRIB_PURE;
 
SV_API char SV_back(SV_Str_view sv) SV_ATTRIB_PURE;
 
#endif /* SV_STR_VIEW */