/*
 * SPDX-License-Identifier: GPL-3.0-only
 * MuseScore-CLA-applies
 *
 * MuseScore
 * Music Composition & Notation
 *
 * Copyright (C) 2021 MuseScore BVBA and others
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 3 as
 * published by the Free Software Foundation.
 *
 * 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 <https://www.gnu.org/licenses/>.
 */

#ifndef __AMBITUS_H__
#define __AMBITUS_H__

#include "element.h"
#include "note.h"
#include "accidental.h"

namespace Ms {
//---------------------------------------------------------
//   @@ Ambitus
//---------------------------------------------------------

class Ambitus final : public Element
{
    NoteHead::Group _noteHeadGroup;
    NoteHead::Type _noteHeadType;
    MScore::DirectionH _dir;
    bool _hasLine;
    Spatium _lineWidth;
    Accidental _topAccid, _bottomAccid;
    int _topPitch, _bottomPitch;
    int _topTpc, _bottomTpc;

    // internally managed, to optimize layout / drawing
    mu::PointF _topPos;       // position of top note symbol
    mu::PointF _bottomPos;    // position of bottom note symbol
    mu::LineF _line;          // the drawn line

    void normalize();

public:
    Ambitus(Score* s);

    ElementType type() const override { return ElementType::AMBITUS; }
    Ambitus* clone() const override { return new Ambitus(*this); }

    // Score Tree functions
    ScoreElement* treeParent() const override;
    ScoreElement* treeChild(int idx) const override;
    int treeChildCount() const override;

    qreal mag() const override;

    void initFrom(Ambitus* a);

    // getters and setters
    NoteHead::Group noteHeadGroup() const { return _noteHeadGroup; }
    NoteHead::Type noteHeadType() const { return _noteHeadType; }
    MScore::DirectionH direction() const { return _dir; }
    bool hasLine() const { return _hasLine; }
    Spatium lineWidth() const { return _lineWidth; }
    int topOctave() const { return (_topPitch / 12) - 1; }
    int bottomOctave() const { return (_bottomPitch / 12) - 1; }
    int topPitch() const { return _topPitch; }
    int bottomPitch() const { return _bottomPitch; }
    int topTpc() const { return _topTpc; }
    int bottomTpc() const { return _bottomTpc; }

    void setNoteHeadGroup(NoteHead::Group val) { _noteHeadGroup = val; }
    void setNoteHeadType(NoteHead::Type val) { _noteHeadType  = val; }
    void setDirection(MScore::DirectionH val) { _dir = val; }
    void setHasLine(bool val) { _hasLine = val; }
    void setLineWidth(Spatium val) { _lineWidth = val; }
    void setTopPitch(int val);
    void setBottomPitch(int val);
    void setTopTpc(int val);
    void setBottomTpc(int val);

    // some utility functions
    Segment* segment() const { return (Segment*)parent(); }
    SymId noteHead() const;
    qreal headWidth() const;

    // re-implemented virtual functions
    void      draw(mu::draw::Painter* painter) const override;
    void      layout() override;
    mu::PointF pagePos() const override;        ///< position in page coordinates
    void      read(XmlReader&) override;
    void      scanElements(void* data, void (* func)(void*, Element*), bool all=true) override;
    void      setTrack(int val) override;
    void      write(XmlWriter&) const override;
    bool      readProperties(XmlReader&) override;
    QString   accessibleInfo() const override;

    // properties
    QVariant getProperty(Pid) const override;
    bool setProperty(Pid propertyId, const QVariant&) override;
    QVariant propertyDefault(Pid id) const override;

    Element* nextSegmentElement() override;
    Element* prevSegmentElement() override;

private:

    struct Ranges {
        int topTpc = Tpc::TPC_INVALID;
        int bottomTpc = Tpc::TPC_INVALID;
        int topPitch = INVALID_PITCH;
        int bottomPitch = INVALID_PITCH;
    };

    Ranges estimateRanges() const;                // scan staff up to next section break and update range pitches
};
}     // namespace Ms
#endif