tnameitem.cpp

/***************************************************************************
 *   Copyright (C) 2017-2021 by Tomasz Bojczuk                             *
 *   seelook@gmail.com                                                     *
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 3 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 *   This program is distributed in the hope that it will be useful,       *
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
 *   GNU General Public License for more details.                          *
 *                                                                         *
 *  You should have received a copy of the GNU General Public License      *
 *  along with this program.  If not, see <http://www.gnu.org/licenses/>.  *
 ***************************************************************************/

#include "tnameitem.h"
#include <tcolor.h>
#include <tglobals.h>

#include <QtCore/qtimer.h>
#include <QtGui/qguiapplication.h>
#include <QtGui/qpalette.h>

#include <QtCore/qdebug.h>

TnameItem *TnameItem::m_instance = nullptr;

TnameItem::TnameItem(QQuickItem *parent)
    : QQuickItem(parent)
    , m_nameStyle(Tnote::e_english_Bb)
    , m_buttonNameStyle(Tnote::e_english_Bb)
    , m_outlineColor(Qt::transparent)
{
    if (m_instance) {
        qDebug() << "TnameItem instance already exists!";
        return;
    }

    m_instance = this;
    m_note.setOctave(-4);
    m_bgColor = qApp->palette().base().color();
    m_bgColor.setAlpha(175);
    connect(GLOB, &Tglobals::showEnharmNotesChanged, this, &TnameItem::nameTextChanged);
    connect(GLOB, &Tglobals::noteNameStyleChanged, this, &TnameItem::nameTextChanged);
    connect(GLOB, &Tglobals::seventhIsBChanged, this, &TnameItem::nameTextChanged);
    qApp->installEventFilter(this);
}

TnameItem::~TnameItem()
{
    m_instance = nullptr;
}

void TnameItem::setNote(const Tnote &n)
{
    if (!m_note.compareNotes(n)) {
        auto nn = n;
        if (!n.isValid())
            nn.setOctave(GLOB->instrument().isGuitar() && !GLOB->instrument().bassGuitar() ? 0 : 1);
        bool stepCh = nn.note() != m_note.note();
        bool octaveCh = nn.octave() != m_note.octave();
        bool alterCh = nn.alter() != m_note.alter();
        m_note = nn;
        if (stepCh)
            emit stepChanged();
        if (octaveCh)
            emit octaveChanged();
        if (alterCh)
            emit alterChanged();
        emit nameTextChanged();
        if (!nn.isValid()) {
            if (m_questionAsked) {
                m_questionAsked = false;
                emit questionChanged();
            }
            if (m_bgColor != qApp->palette().base().color())
                changeNameBgColor(qApp->palette().base().color());
        }
    }
}

void TnameItem::setStep(int st)
{
    char stepChar = static_cast<char>(st);
    if (stepChar != m_note.note()) {
        if (m_note.octave() == -4) // initial octave value is fake, revert it
            setOctave(GLOB->instrument().isGuitar() && !GLOB->instrument().bassGuitar() ? 0 : 1);
        m_note.setNote(stepChar);
        emit stepChanged();
        emit nameTextChanged();
        emit noteChanged();
    }
}

/**
 * Set alter button but do not change name text if note is invalid (not set)
 */
void TnameItem::setAlter(int alt)
{
    char alterChar = static_cast<char>(alt);
    if (alterChar != m_note.alter()) {
        m_note.setAlter(alterChar);
        emit alterChanged();
        if (m_note.isValid()) {
            emit nameTextChanged();
            emit noteChanged();
        }
    }
}

/**
 * Set octave button but do not change name text if note is invalid (not set)
 */
void TnameItem::setOctave(int oct)
{
    char octaveChar = static_cast<char>(oct);
    if (octaveChar != m_note.octave()) {
        m_note.setOctave(octaveChar);
        emit octaveChanged();
        if (m_note.isValid()) {
            emit nameTextChanged();
            emit noteChanged();
        }
    }
}

void TnameItem::setNameStyle(Tnote::EnameStyle style)
{
    if (m_nameStyle != style) {
        m_nameStyle = style;
        Tnote::defaultStyle = style;
        emit nameStyleChanged();
        emit nameTextChanged();
    }
}

void TnameItem::setButtonNameStyle(Tnote::EnameStyle style)
{
    if (style != m_buttonNameStyle) {
        m_buttonNameStyle = style;
        emit buttonNameStyleChanged();
    }
}

void TnameItem::setDisabled(bool dis)
{
    if (dis != m_disabled) {
        m_disabled = dis;
        emit disabledChanged();
    }
}

QString TnameItem::nameText() const
{
    QString enharmText;
    if (GLOB->showEnharmNotes() && m_note.isValid()) {
        TnotesList enharmList = m_note.getTheSameNotes(GLOB->enableDoubleAccids());
        TnotesList::iterator it = enharmList.begin();
        ++it;
        if (it != enharmList.end()) {
            auto n1 = *(it);
            enharmText += QString(" <font color=\"%1\" size=\"1\">(").arg(GLOB->getEnharmNoteColor().name()) + n1.styledName();
        }
        ++it;
        if (it != enharmList.end()) {
            auto n2 = *(it);
            enharmText += QLatin1String("  ") + n2.styledName();
        }
        if (!enharmText.isEmpty())
            enharmText += QLatin1String(")</font>");
    }
    if (m_note.isValid())
        return QString("<font color=\"%1\">").arg(qApp->palette().text().color().name()) + m_note.styledName() + QLatin1String("</font>") + enharmText;
    else
        return QString();
}

QString TnameItem::octaveName(int oNr) const
{
    return Tnote::shortOctaveName(oNr);
}

QString TnameItem::octavesLink() const
{
    QString l = octavesLinkStatus();
    l = l.mid(l.indexOf("\"") + 1);
    l.chop(1);
    return l;
}

QString TnameItem::octavesLinkStatus() const
{
    return tr("Click to see what <i>octaves</i> are at \"http://en.wikipedia.org/wiki/Octave\"",
              "You can change this link to article in your language, but please KEEP QUOTATION MARKS AROUND THAT ADDRESS!");
}

/**
 * Text on name buttons depends on style
 * but @p fakeIs7b is only to re-invoke this from QML when 7th note is changed from settings
 */
QString TnameItem::noteButtonText(int noteNr, int nStyle, bool fakeIs7b)
{
    Q_UNUSED(fakeIs7b)
    return Tnote(static_cast<char>(noteNr), 0, 0).toText(static_cast<Tnote::EnameStyle>(nStyle), false);
}

QString TnameItem::octaveStatusTip(int oNr) const
{
    return oNr > -4 && oNr < 5 ? Tnote::fullOctaveName(oNr) + QLatin1String("<br>") + tr("The octave <b>%n</b> in International Pitch Notation", "", oNr + 3)
                               : QString();
}

void TnameItem::askQuestion(const Tnote &note, Tnote::EnameStyle questStyle)
{
    changeNameBgColor(Tcolor::merge(Tcolor::alpha(GLOB->EquestionColor, 40), qApp->palette().base().color()));
    setNameStyle(questStyle);
    setNote(note);
    m_questionAsked = true;
    emit questionChanged();
}

/**
 * To keep note name text unchanged we silently (without emitting any signal) are changing name style.
 * To unset note button we tricky set note to 0 and emitting only @p stepChanged() signal.
 */
void TnameItem::prepareAnswer(Tnote::EnameStyle answStyle)
{
    changeNameBgColor(Tcolor::merge(Tcolor::alpha(GLOB->EanswerColor, 40), qApp->palette().base().color()));
    m_nameStyle = answStyle;
    Tnote::defaultStyle = answStyle;
    setDisabled(false);
    m_note.setNote(0);
    emit stepChanged();
}

void TnameItem::forceAccidental(char accid)
{
    m_note.setAlter(accid);
    emit alterChanged();
}

void TnameItem::setMarkColor(const QColor &outColor)
{
    if (m_outlineColor != outColor) {
        m_outlineColor = outColor;
        emit markColorChanged();
    }
}

void TnameItem::correct(const Tnote &okNote)
{
    m_okNote = okNote;
    emit correctName();
}

void TnameItem::applyCorrect()
{
    if (m_okNote.isValid()) {
        m_note = m_okNote;
        setMarkColor(GLOB->correctColor());
        emit nameTextChanged();
        m_okNote.setNote(0);
    }
}

void TnameItem::finishCorrectAnim()
{
    emit correctionFinished();
}

#if !defined(Q_OS_ANDROID)
bool TnameItem::eventFilter(QObject *obj, QEvent *event)
{
    if (obj == qApp && event->type() == QEvent::ApplicationPaletteChange) {
        if (!m_questionAsked) // update color only when question is not asked
            changeNameBgColor(qApp->palette().base().color());
    }
    return QObject::eventFilter(obj, event);
}
#endif

void TnameItem::changeNameBgColor(const QColor &c)
{
    m_bgColor = c;
    m_bgColor.setAlpha(175);
    emit bgColorChanged();
}