UT_IdnaName.h

Go to the documentation of this file.

/*
 * PROPRIETARY INFORMATION.  This software is proprietary to
 * Side Effects Software Inc., and is not to be reproduced,
 * transmitted, or disclosed in any way without written permission.
 *
 * NAME:        UT_IdnaName.h
 *
 * COMMENTS:
 *
 */

#ifndef __UT_IDNANAME_H__
#define __UT_IDNANAME_H__

#include "UT_API.h"

#include <UT/UT_ErrorCode.h>
#include <UT/UT_StringHolder.h>

class UT_API UT_IdnaName
{
public:
    UT_IdnaName() = default;

    static bool machineName(UT_IdnaName& name, UT_ErrorCode& ec);
    static bool create(
            const UT_StringRef& name_utf8,
            UT_IdnaName& out,
            UT_ErrorCode& ec);

    const UT_StringHolder& name() const noexcept { return myALabel; }
    const UT_StringHolder& display() const { return ulabel(); }

    const UT_StringHolder& alabel() const noexcept { return name(); }
    const UT_StringHolder& ulabel() const
    {
        ensureULabel_();
        return myULabelCache;
    }

    bool setName(const UT_StringRef& utf8, UT_ErrorCode* ec = nullptr);

    bool isEmpty() const noexcept { return myALabel.isEmpty(); }

    UT_StringHolder full() const
    {
        ensureULabel_();
        // If the value is already ascii then its just going to be the same
        // value displayed twice
        if (myULabelCache == myALabel)
            return myALabel;

        UT_StringHolder str;
        str.format("{} ({})", myULabelCache, myALabel);
        return str;
    }

    bool operator==(const UT_IdnaName& other) const noexcept
    {
        return myALabel.equal(other.myALabel, true);
    }
    bool operator!=(const UT_IdnaName& other) const noexcept
    {
        return !(*this == other);
    }

    struct Hasher
    {
        size_t operator()(const UT_IdnaName& h) const noexcept
        {
            return h.alabel().toLower().hash();
        }
    };

private:
    void ensureULabel_() const;

    UT_StringHolder myALabel;
    mutable UT_StringHolder myULabelCache;
    mutable bool myULabelCached = false;
};

namespace std
{
template <>
struct hash<UT_IdnaName>
{
    size_t operator()(const UT_IdnaName& h) const noexcept
    {
        return UT_IdnaName::Hasher{}(h);
    }
};
} // namespace std

#endif // __UT_IDNANAME_H__