/*

 * Copyright (C) 2009 Google Inc. All rights reserved.

 *

 * Redistribution and use in source and binary forms, with or without

 * modification, are permitted provided that the following conditions are

 * met:

 *

 *     * Redistributions of source code must retain the above copyright

 * notice, this list of conditions and the following disclaimer.

 *     * Redistributions in binary form must reproduce the above

 * copyright notice, this list of conditions and the following disclaimer

 * in the documentation and/or other materials provided with the

 * distribution.

 *     * Neither the name of Google Inc. nor the names of its

 * contributors may be used to endorse or promote products derived from

 * this software without specific prior written permission.

 *

 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS

 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT

 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR

 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT

 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,

 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT

 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,

 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY

 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT

 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE

 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

 */

#ifndef WebString_h

#define WebString_h

#include "WebCommon.h"

#if WEBKIT_IMPLEMENTATION

namespace WebCore {

class String;

class AtomicString;

}

#else

#include <base/nullable_string16.h>

#include <base/string16.h>

#endif

namespace WebKit {

class WebCString;

class WebStringPrivate;

// A UTF-16 string container.  It is inexpensive to copy a WebString

// object.

//

// WARNING: It is not safe to pass a WebString across threads!!!

//

class WebString {

public:

    ~WebString() { reset(); }

    WebString() : m_private(0) { }

    WebString(const WebUChar* data, size_t len) : m_private(0)

    {

        assign(data, len);

    }

    WebString(const WebString& s) : m_private(0) { assign(s); }

    WebString& operator=(const WebString& s)

    {

        assign(s);

        return *this;

    }

    WEBKIT_API void reset();

    WEBKIT_API void assign(const WebString&);

    WEBKIT_API void assign(const WebUChar* data, size_t len);

    WEBKIT_API bool equals(const WebString& s) const;

    WEBKIT_API size_t length() const;

    WEBKIT_API const WebUChar* data() const;

    bool isEmpty() const { return !length(); }

    bool isNull() const { return !m_private; }

    WEBKIT_API WebCString utf8() const;

    WEBKIT_API static WebString fromUTF8(const char* data, size_t length);

    WEBKIT_API static WebString fromUTF8(const char* data);

    template <int N> WebString(const char (&data)[N])

        : m_private(0)

    {

        assign(fromUTF8(data, N - 1));

    }

    template <int N> WebString& operator=(const char (&data)[N])

    {

        assign(fromUTF8(data, N - 1));

        return *this;

    }

#if WEBKIT_IMPLEMENTATION

    WebString(const WebCore::String&);

    WebString& operator=(const WebCore::String&);

    operator WebCore::String() const;

    WebString(const WebCore::AtomicString&);

    WebString& operator=(const WebCore::AtomicString&);

    operator WebCore::AtomicString() const;

#else

    WebString(const string16& s) : m_private(0)

    {

        assign(s.data(), s.length());

    }

    WebString& operator=(const string16& s)

    {

        assign(s.data(), s.length());

        return *this;

    }

    operator string16() const

    {

        size_t len = length();

        return len ? string16(data(), len) : string16();

    }

    WebString(const NullableString16& s) : m_private(0)

    {

        if (s.is_null())

            reset();

        else

            assign(s.string().data(), s.string().length());

    }

    WebString& operator=(const NullableString16& s)

    {

        if (s.is_null())

            reset();

        else

            assign(s.string().data(), s.string().length());

        return *this;

    }

    operator NullableString16() const

    {

        if (!m_private)

            return NullableString16(string16(), true);

        size_t len = length();

        return NullableString16(len ? string16(data(), len) : string16(), false);

    }

    template <class UTF8String>

    static WebString fromUTF8(const UTF8String& s)

    {

        return fromUTF8(s.data(), s.length());

    }

#endif

private:

    void assign(WebStringPrivate*);

    WebStringPrivate* m_private;

};

inline bool operator==(const WebString& a, const WebString& b)

{

    return a.equals(b);

}

inline bool operator!=(const WebString& a, const WebString& b)

{

    return !(a == b);

}

} // namespace WebKit

#endif