StringRef.h

Go to the documentation of this file.

/*
  ==============================================================================
 
   This file is part of the Water library.
   Copyright (c) 2016 ROLI Ltd.
   Copyright (C) 2017-2022 Filipe Coelho <falktx@falktx.com>
 
   Permission is granted to use this software under the terms of the ISC license
   http://www.isc.org/downloads/software-support-policy/isc-license/
 
   Permission to use, copy, modify, and/or distribute this software for any
   purpose with or without fee is hereby granted, provided that the above
   copyright notice and this permission notice appear in all copies.
 
   THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH REGARD
   TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND
   FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT,
   OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF
   USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
   TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
   OF THIS SOFTWARE.
 
  ==============================================================================
*/
 
#ifndef WATER_STRINGREF_H_INCLUDED
#define WATER_STRINGREF_H_INCLUDED
 
#include "String.h"
 
namespace water {
 
//==============================================================================
class StringRef
{
public:
    StringRef (const char* stringLiteral) noexcept;

    StringRef (CharPointer_UTF8 stringLiteral) noexcept;

    StringRef (const String& string) noexcept;

    StringRef() noexcept;
 
    //==============================================================================
    operator const char*() const noexcept      { return text.getAddress(); }
    operator CharPointer_UTF8() const noexcept { return text; }

    bool isEmpty() const noexcept                                       { return text.isEmpty(); }
    bool isNotEmpty() const noexcept                                    { return ! text.isEmpty(); }
    int length() const noexcept                                         { return (int) text.length(); }

    char operator[] (int index) const noexcept                          { return text[index]; }

    bool operator== (const String& s) const noexcept                    { return text.compare (s.getCharPointer()) == 0; }
    bool operator!= (const String& s) const noexcept                    { return text.compare (s.getCharPointer()) != 0; }

    bool operator== (StringRef s) const noexcept                        { return text.compare (s.text) == 0; }
    bool operator!= (StringRef s) const noexcept                        { return text.compare (s.text) != 0; }
 
    //==============================================================================
    CharPointer_UTF8 text;
};
 
//==============================================================================
bool operator== (const String& string1, StringRef string2) noexcept;
bool operator!= (const String& string1, StringRef string2) noexcept;
 
inline String operator+ (String s1, StringRef s2)           { return s1 += String (s2.text); }
inline String operator+ (StringRef s1, const String& s2)    { return String (s1.text) + s2; }
inline String operator+ (const char* s1, StringRef s2)      { return String (s1) + String (s2.text); }
inline String operator+ (StringRef s1, const char* s2)      { return String (s1.text) + String (s2); }
 
}
 
#endif // WATER_STRINGREF_H_INCLUDED