/*
 * Copyright (c) 2022, RPTU Kaiserslautern-Landau
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are
 * met:
 *
 * 1. Redistributions of source code must retain the above copyright notice,
 *    this list of conditions and the following disclaimer.
 *
 * 2. 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.
 *
 * 3. Neither the name of the copyright holder 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 HOLDER
 * 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.
 *
 * Authors:
 *    Iron Prando da Silva
 */

#pragma once

#include "QStringComparator.h"
#include <map>

class StringMapper
{
public:
    enum Identifier
    {
        None,
        CMD_BUS,
        RAS_BUS,
        CAS_BUS,
        NAW,
        FAW,
        _32AW,
        FAW_LOGICAL,
        FAW_PHYSICAL,
        REFAB,
        PREAB,
        PDEP,
        PDXP,
        SREFEN,
        SREFEX,
        PDEA,
        PDXA,
        SRPDEN,
        SRPDEX,
        ACT,
        RD,
        WR,
        PREPB,
        RDA,
        WRA,
        REFPB,
        REFP2B,
        PRESB,
        RFMAB,
        REFSB,
        RFMSB
    };

public:
    StringMapper() = default;
    StringMapper(const QString& id);
    StringMapper(const char* str) : StringMapper(std::forward<QString>(str)) {}
    ~StringMapper() = default;

    Identifier getIDEnum() const { return mIDEnum; }
    const QString getIDStr() const { return mIDStr; }

    bool isPool() const { return mIsPool; }

    static QString getIDStr(Identifier);
    static Identifier getIDEnum(const QString&);

    bool operator==(const StringMapper&) const;
    bool operator!=(const StringMapper&) const;
    bool operator<(const StringMapper&) const;

    bool operator==(const Identifier&) const;
    bool operator!=(const Identifier&) const;

    static bool compare(const StringMapper&, const StringMapper&);

protected:
    Identifier mIDEnum = None;
    QString mIDStr = "";
    bool mIsPool = false;

protected:
    static bool mAuxIsPool(Identifier);
};
