Fretboard.h

/*
 * Copyright (C) 2026, Robert Patterson
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */
#pragma once
 
#include <optional>
#include <vector>
 
#include "musx/dom/Details.h"
#include "musx/dom/Others.h"
 
namespace musx::util {
 
enum class UnplayedStringDisplay {
    None, 
    Blank, 
    Muted 
};
 
struct FretboardDisplayData
{
    struct Cell
    {
        int string{}; 
        int fret{}; 
        dom::details::FretboardDiagram::Shape shape{}; 
        int finger{}; 
    };
 
    struct Barre
    {
        int fret{}; 
        int startString{}; 
        int endString{}; 
    };
 
    int stringCount{}; 
    int fretCount{}; 
    int fretboardNumber{}; 
    bool showFretboardNumber{}; 
    UnplayedStringDisplay unplayedStringDisplay{UnplayedStringDisplay::None}; 
    std::vector<Cell> cells; 
    std::vector<Barre> barres; 
};
 
[[nodiscard]] std::optional<FretboardDisplayData> calcFretboardDisplayData(
    const dom::MusxInstance<dom::details::ChordAssign>& chord,
    const dom::MusxInstance<dom::KeySignature>& keySignature,
    dom::KeySignature::KeyContext keyContext);
 
} // namespace musx::util