drawbar 0.4.0

//! The Electro 5 panel as a document: the sections the instrument itself is divided
//! into, holding the controls that instrument would be showing.

use eframe::egui;
use nord_format::fields::Field;

use super::controls::{self, Ctx, Sets};
use crate::drawbar_widget;
use crate::fields::Control;
use crate::strings::{self, Section};
use crate::visibility::{self, Bars, Organ, Registration};

/// A program or a live slot: the same body, so the same panel.
pub fn program(
    ui: &mut egui::Ui,
    ctx: &Ctx,
    fields: &[Field],
    piano: &mut PianoLookup,
    sets: &mut Sets,
) {
    let organ = visibility::organ(fields);
    for section in strings::PROGRAM_SECTIONS {
        if !visibility::shown(section, fields) {
            continue;
        }
        let mut rows = gather(fields, section, organ.as_ref());
        if visibility::switches_first(section) {
            reading_order(ctx, &mut rows);
        }
        let organ_here = (section == Section::Organ)
            .then_some(organ.as_ref())
            .flatten();
        if rows.is_empty() && organ_here.is_none() {
            continue;
        }
        controls::section(ui, section.title(), |ui| {
            if section == Section::Piano {
                piano.ui(ui);
            }
            match organ_here {
                Some(organ) => organ_section(ui, ctx, fields, organ, &rows, sets),
                None => controls::strip(ui, |ui| {
                    // The transpose pair leads its section, because it is the control the
                    // panel's own button is: two fields written as one.
                    if section == Section::Keyboard {
                        transpose(ui, fields, sets);
                    }
                    for field in &rows {
                        if section == Section::Piano
                            && field.path == "piano_panel.piano_model"
                            && piano.model_cell(ui, field, sets)
                        {
                            continue;
                        }
                        controls::cell(ui, ctx, field, sets);
                    }
                }),
            }
        });
    }
}

/// The settings body, in the order the instrument's own menus run.
pub fn settings(ui: &mut egui::Ui, ctx: &Ctx, fields: &[Field], sets: &mut Sets) {
    for section in strings::SETTINGS_SECTIONS {
        let rows = gather(fields, section, None);
        if rows.is_empty() {
            continue;
        }
        controls::section(ui, section.title(), |ui| {
            controls::strip(ui, |ui| {
                for field in &rows {
                    controls::cell(ui, ctx, field, sets);
                }
            });
        });
    }
}

/// How many fields a body may hold before its sections start folded away.
///
/// ⚠️ The instrument's own panel does not fold, and neither does the Electro 5 document.
/// A Stage program declares hundreds, and one strip of those is a page nobody reads to
/// the end of — so above this the sections are what the reader opens, one at a time.
const FOLD_ABOVE: usize = 200;

/// How many fields a section may hold before it is divided again on each field's own
/// leading word.
const SPLIT_ABOVE: usize = 128;

/// Any other registry-backed body: its own path prefixes as sections, because nothing
/// here knows how that instrument's panel is divided but the registry does say which
/// fields belong together.
pub fn plain(ui: &mut egui::Ui, ctx: &Ctx, fields: &[Field], sets: &mut Sets) {
    let folded = fields.len() > FOLD_ABOVE;
    ui.label(
        egui::RichText::new(match folded {
            true => "Every field this format declares, under the section of its name. Open one to see it.",
            false => "Every field this format declares.",
        })
        .small()
        .weak(),
    );
    for group in sections(fields) {
        match folded {
            true => {
                egui::CollapsingHeader::new(&group.title)
                    .id_salt(&group.key)
                    .show(ui, |ui| cells(ui, ctx, &group.rows, sets));
            }
            false => controls::section(ui, &group.title, |ui| cells(ui, ctx, &group.rows, sets)),
        }
    }
}

fn cells(ui: &mut egui::Ui, ctx: &Ctx, rows: &[&Field], sets: &mut Sets) {
    controls::strip(ui, |ui| {
        for field in rows {
            controls::cell(ui, ctx, field, sets);
        }
    });
}

/// One titled run of a field list.
struct Group<'a> {
    /// What these fields share — the fold's id, which their titles are not unique enough
    /// to be.
    key: String,
    title: String,
    rows: Vec<&'a Field>,
}

/// The sections a field list falls into.
///
/// A nested body's fields are contiguous and share a dotted prefix, which is the division
/// the registry itself makes. A prefix too long to read in one run is divided again on
/// the leading word of each field's own name — the Stage bodies spell their sections
/// there (`slot_a.organ_preset_1_drawbar_1`) — and a word that recurs later joins the
/// division it opened rather than starting a second one.
fn sections(fields: &[Field]) -> Vec<Group<'_>> {
    let mut out: Vec<Group> = Vec::new();
    for field in fields {
        let prefix = field.path.rsplit_once('.').map_or("", |(head, _)| head);
        match out.last_mut() {
            Some(group) if group.key == prefix => group.rows.push(field),
            _ => out.push(Group {
                key: prefix.to_string(),
                title: match prefix.is_empty() {
                    true => "General".to_string(),
                    false => strings::title(prefix),
                },
                rows: vec![field],
            }),
        }
    }
    out.into_iter().flat_map(divide).collect()
}

fn divide(group: Group<'_>) -> Vec<Group<'_>> {
    if group.rows.len() <= SPLIT_ABOVE {
        return vec![group];
    }
    let mut out: Vec<Group> = Vec::new();
    for field in group.rows {
        let leaf = field.path.rsplit('.').next().unwrap_or(&field.path);
        let word = leaf.split('_').next().unwrap_or(leaf);
        let key = format!("{}.{word}", group.key);
        match out.iter().position(|part| part.key == key) {
            Some(at) => out[at].rows.push(field),
            None => out.push(Group {
                title: match group.key.is_empty() {
                    true => strings::title(word),
                    false => format!("{} — {word}", group.title),
                },
                key,
                rows: vec![field],
            }),
        }
    }
    out
}

/// What is known about the piano a program plays, and the way to ask for the rest.
///
/// ⚠️ The file stores an **id** for the piano and, separately, the panel's category and
/// Model dial position. The id is the identity; the dial position is a coordinate whose
/// meaning lives in the instrument's own library. Only the id can be resolved to a name,
/// and only the instrument can resolve it — so a name shown here always came off the
/// wire, never out of the file.
pub struct PianoLookup {
    /// The id the file names, or `None` where it references no piano at all.
    pub id: Option<u32>,
    /// What the instrument called that id, once it has been asked.
    pub name: Option<String>,
    /// Whether asking is possible: an attached instrument, and a slot to ask about.
    pub can_ask: bool,
    /// Set when the operator asks. The document turns it into one `DEPENDENCIES` read.
    pub asked: bool,
    /// The Pianos folder's names for the current category, by Model dial position.
    /// Empty when the scan cannot answer, and the Model dial stays numeric.
    pub models: Vec<(u32, String)>,
    /// The scan's name for the current position, where it disagrees with the
    /// instrument's dependency reply — the signal that the position mapping is wrong.
    pub scan_disagrees: Option<String>,
}

impl PianoLookup {
    /// The Model dial as a list of the instrument's own pianos, where the Pianos folder
    /// scan can supply them. `false` where it cannot, and the numeric control stands.
    fn model_cell(&self, ui: &mut egui::Ui, field: &Field, sets: &mut Sets) -> bool {
        if self.models.is_empty() {
            return false;
        }
        let current: Option<u32> = field.value.trim().parse().ok();
        let shown = current
            .and_then(|n| self.models.iter().find(|(position, _)| *position == n))
            .map(|(position, name)| format!("{position} — {name}"))
            // A dial position past the scanned list is shown as the number it is,
            // not silently snapped to a piano it does not name.
            .unwrap_or_else(|| field.value.clone());
        controls::named_cell(ui, &field.path, 230.0, |ui| {
            egui::ComboBox::from_id_salt("piano-model-names")
                .selected_text(shown)
                .width(214.0)
                .show_ui(ui, |ui| {
                    for (position, name) in &self.models {
                        let row = format!("{position} — {name}");
                        if ui
                            .selectable_label(current == Some(*position), row)
                            .clicked()
                        {
                            sets.push((field.path.clone(), position.to_string()));
                        }
                    }
                });
        });
        true
    }

    fn ui(&mut self, ui: &mut egui::Ui) {
        if let Some(scanned) = &self.scan_disagrees {
            ui.colored_label(
                crate::app::warn(ui.visuals()),
                format!(
                    "the model list calls this position {scanned:?}, but the instrument's \
                     dependency reply names the piano below — trust the instrument",
                ),
            );
        }
        let Some(id) = self.id else {
            return;
        };
        ui.horizontal_wrapped(|ui| {
            ui.label(egui::RichText::new("currently").small().weak());
            match &self.name {
                Some(name) => {
                    ui.label(egui::RichText::new(name).strong());
                    ui.label(
                        egui::RichText::new("— named by the instrument")
                            .small()
                            .weak(),
                    );
                    if self.can_ask {
                        self.asked |= ui
                            .small_button("Ask again")
                            .on_hover_text("read this program's dependencies again")
                            .clicked();
                    }
                }
                None => {
                    ui.label(egui::RichText::new(format!("piano {id:#010x}")).monospace());
                    match self.can_ask {
                        true => {
                            self.asked |= ui
                                .small_button("Ask the instrument")
                                .on_hover_text("read this program's dependencies for the name")
                                .clicked();
                        }
                        false => {
                            ui.label(
                                egui::RichText::new(
                                    "— the file stores the id; only the instrument knows the name",
                                )
                                .small()
                                .weak(),
                            );
                        }
                    }
                }
            }
        });
    }
}

/// The fields a section shows: its own, minus what another control speaks for.
fn gather<'a>(fields: &'a [Field], section: Section, organ: Option<&Organ>) -> Vec<&'a Field> {
    fields
        .iter()
        .filter(|field| strings::section(&field.path) == section)
        .filter(|field| !visibility::engineering_only(&field.path))
        .filter(|field| !organ.is_some_and(|organ| organ.covers(&field.path)))
        .collect()
}

/// One effect at a time, and within an effect what it *is* before how much of it there
/// is — the order the panel's own labelling reads in.
fn reading_order(ctx: &Ctx, rows: &mut [&Field]) {
    let group = |path: &str| -> String {
        let leaf = path.rsplit('.').next().unwrap_or(path);
        leaf.split_once('_')
            .map_or(leaf, |(head, _)| head)
            .to_string()
    };
    let mut order: Vec<String> = Vec::new();
    for field in rows.iter() {
        let key = group(&field.path);
        if !order.contains(&key) {
            order.push(key);
        }
    }
    rows.sort_by_key(|field| {
        let at = order
            .iter()
            .position(|key| *key == group(&field.path))
            .unwrap_or(usize::MAX);
        let knob = !matches!(ctx.control(field), Control::Toggle | Control::Choice);
        (at, knob)
    });
}

fn find<'a>(fields: &'a [Field], path: &str) -> Option<&'a Field> {
    fields.iter().find(|field| field.path == path)
}

fn organ_section(
    ui: &mut egui::Ui,
    ctx: &Ctx,
    fields: &[Field],
    organ: &Organ,
    rows: &[&Field],
    sets: &mut Sets,
) {
    // Model and shared organ settings remain visible regardless of the active registration.
    controls::strip(ui, |ui| {
        if let Some(field) = find(fields, "center_panel.organ_type") {
            controls::cell(ui, ctx, field, sets);
        }
        for path in organ.vib_type.iter().chain(
            organ
                .perc
                .iter()
                .flat_map(|(third, speed)| [third, speed].into_iter()),
        ) {
            if let Some(field) = find(fields, path) {
                controls::cell(ui, ctx, field, sets);
            }
        }
    });
    if !organ.known {
        ui.label(
            egui::RichText::new(
                "This program has an organ selection this app does not recognise, so it \
                 cannot say which registration the instrument is playing. Everything the \
                 file stores is below.",
            )
            .small()
            .color(crate::app::warn(ui.visuals())),
        );
    }

    for registration in &organ.registrations {
        preset(ui, fields, organ, registration, sets);
    }

    // Whatever else this section holds: an unrecognised selection's whole panel, or a
    // field the library has grown since.
    controls::strip(ui, |ui| {
        for field in rows {
            if field.path == "center_panel.organ_type" {
                continue;
            }
            controls::cell(ui, ctx, field, sets);
        }
    });
}

fn preset(
    ui: &mut egui::Ui,
    fields: &[Field],
    organ: &Organ,
    registration: &Registration,
    sets: &mut Sets,
) {
    egui::Frame::group(ui.style()).show(ui, |ui| {
        ui.set_width(ui.available_width());
        ui.horizontal(|ui| {
            let title = match &registration.bars {
                Bars::Bass(..) => format!("Preset {} — bass manual", registration.preset),
                _ => format!("Preset {}", registration.preset),
            };
            let picked = ui
                .selectable_label(registration.live, egui::RichText::new(title).strong())
                .on_hover_text("the preset the instrument plays");
            if picked.clicked() && !registration.live {
                if let Some(path) = organ.preset_field {
                    sets.push((path.to_string(), (registration.preset == 2).to_string()));
                }
            }
            if registration.live {
                let good = crate::app::good(ui.visuals());
                ui.label(egui::RichText::new("playing").small().color(good));
            }
        });

        match &registration.bars {
            Bars::Nine(path) => nine(ui, fields, path, sets),
            Bars::Tabs(path) => {
                nine(ui, fields, path, sets);
                ui.label(
                    egui::RichText::new("The instrument reads a register at 5 or more as on.")
                        .small()
                        .weak(),
                );
            }
            Bars::Bass(first, second) => bass(ui, fields, first, second, sets),
        }

        ui.horizontal_wrapped(|ui| {
            controls::switch(
                ui,
                registration.vib.and_then(|p| find(fields, p)),
                "vibrato",
                sets,
            );
            controls::switch(
                ui,
                registration.perc.and_then(|p| find(fields, p)),
                "percussion",
                sets,
            );
        });
    });
}

fn nine(ui: &mut egui::Ui, fields: &[Field], path: &str, sets: &mut Sets) {
    let Some(field) = find(fields, path) else {
        return;
    };
    if let Some(value) = controls::register(ui, field, true) {
        sets.push((field.path.clone(), value));
    }
}

/// The bass manual: two drawbars, each its own field, written together so a pull moves
/// the registration rather than half of it.
fn bass(ui: &mut egui::Ui, fields: &[Field], first: &str, second: &str, sets: &mut Sets) {
    let read = |path: &str| -> u8 {
        find(fields, path)
            .and_then(|field| field.value.parse().ok())
            .unwrap_or(0)
    };
    let mut positions = [0u8; drawbar_widget::BARS];
    positions[0] = read(first);
    positions[1] = read(second);
    if let Some(moved) = controls::bars(ui, positions, true, &drawbar_widget::BASS_RANKS) {
        sets.push((first.to_string(), moved[0].to_string()));
        sets.push((second.to_string(), moved[1].to_string()));
    }
}

/// The transpose control: a lamp and a number, written together the way the panel's own
/// button writes them — two cells, because that is how the panel prints it.
///
/// The instrument ignores the amount while the lamp is dark, and moving the amount is
/// what lights it.
pub fn transpose(ui: &mut egui::Ui, fields: &[Field], sets: &mut Sets) {
    /// The panel's own travel, either side of nothing.
    const SEMITONES: i64 = 6;

    let Some((on, semitones)) = visibility::transpose(fields) else {
        return;
    };
    let mut switched = None;
    controls::named_cell(ui, "center_panel.transpose_enabled", 78.0, |ui| {
        switched = crate::led::ui(ui, on, "");
    })
    .on_hover_text("the transpose light on the panel");

    let mut moved = None;
    controls::named_cell(ui, "center_panel.transpose", 78.0, |ui| {
        moved = crate::knob::ui(
            ui,
            "center_panel.transpose",
            semitones,
            -SEMITONES,
            SEMITONES,
        );
    });

    match (switched, moved) {
        (_, Some(want)) => {
            // Moving the semitones turns the light on, which is what the panel does.
            sets.extend(visibility::set_transpose(true, want));
        }
        (Some(want_on), None) => sets.extend(visibility::set_transpose(want_on, semitones)),
        (None, None) => {}
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::fields::{apply, blank};

    fn titles(bytes: Vec<u8>) -> Vec<String> {
        let (fields, _) = apply(&bytes, &[]).unwrap();
        let groups = sections(&fields);
        assert_eq!(
            fields.len(),
            groups.iter().map(|group| group.rows.len()).sum::<usize>(),
            "every field lands in exactly one section",
        );
        let mut keys: Vec<&str> = groups.iter().map(|group| group.key.as_str()).collect();
        keys.sort_unstable();
        let count = keys.len();
        keys.dedup();
        assert_eq!(keys.len(), count, "every fold answers to an id of its own");
        groups.into_iter().map(|group| group.title).collect()
    }

    /// The generic view's sections are the registry's own divisions: the prefix a nested
    /// body's fields share, and the body's own fields under one heading before them.
    #[test]
    fn a_body_falls_into_the_sections_its_paths_name() {
        let titles = titles(blank::stage4_program());
        assert_eq!(titles.first().map(String::as_str), Some("General"));
        assert!(titles.contains(&"Organ a".to_string()), "{titles:?}");
        assert!(titles.contains(&"Synth a fx".to_string()), "{titles:?}");
    }

    /// A prefix longer than a page divides again on the leading word of each field's own
    /// name, which is where the Stage 2 spells what part of the slot a field belongs to.
    #[test]
    fn a_section_too_long_to_read_divides_on_its_fields_own_words() {
        let titles = titles(blank::stage2_program());
        assert!(titles.contains(&"Slot a — organ".to_string()), "{titles:?}");
        assert!(titles.contains(&"Slot b — piano".to_string()), "{titles:?}");
    }

    /// A body small enough to read whole keeps one section per prefix.
    #[test]
    fn a_short_body_is_not_divided() {
        assert_eq!(titles(blank::stage3_synth()), ["General"]);
    }
}