mayhem-firmware/firmware/application/ui/ui_receiver.hpp

/*
 * Copyright (C) 2014 Jared Boone, ShareBrained Technology, Inc.
 *
 * This file is part of PortaPack.
 *
 * 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 2, 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; see the file COPYING.  If not, write to
 * the Free Software Foundation, Inc., 51 Franklin Street,
 * Boston, MA 02110-1301, USA.
 */

#ifndef __UI_RECEIVER_H__
#define __UI_RECEIVER_H__

#include "ui.hpp"
#include "ui_navigation.hpp"
#include "ui_painter.hpp"
#include "ui_widget.hpp"

#include "rf_path.hpp"

#include <cstddef>
#include <cstdint>
#include <algorithm>
#include <functional>

namespace ui {

class FrequencyField : public Widget {
public:
	std::function<void(rf::Frequency)> on_change { };
	std::function<void(void)> on_edit { };
	std::function<void(void)> on_show_options { };

	using range_t = rf::FrequencyRange;

	FrequencyField(const Point parent_pos);

	rf::Frequency value() const;

	void set_value(rf::Frequency new_value);
	void set_step(rf::Frequency new_value);

	void paint(Painter& painter) override;

	bool on_key(const ui::KeyEvent event) override;
	bool on_encoder(const EncoderEvent delta) override;
	bool on_touch(const TouchEvent event) override;
	void on_focus() override;

private:
	const size_t length_;
	const range_t range;
	rf::Frequency value_ { 0 };
	rf::Frequency step { 25000 };
	uint64_t last_ms_ { 0 };

	rf::Frequency clamp_value(rf::Frequency value);
};

template<size_t N>
class FieldString {
public:
	enum Justify {
		Right,
		Left,
	};

	constexpr FieldString(
		Justify justify
	) : justify { justify }
	{
	}

	uint32_t as_int() const {
		uint32_t value = 0;
		for(const auto c : s) {
			const uint_fast8_t digit = (c == ' ') ? 0 : c - '0';
			value = (value * 10) + digit;
		}
		return value;
	}

	void set(uint32_t value) {
		std::generate(s.rbegin(), s.rend(), [&value]() {
			const char digit = (value % 10) + '0';
			value /= 10;
			return digit;
		});
	}

	void clear() {
		s.fill(' ');
	}

	void add_digit(const char c) {
		insert_right(c);
	}

	void delete_digit() {
		if( justify == Justify::Right ) {
			shift_right();
			s.front() = ' ';
		} else {
			auto first_digit = std::find_if(s.rbegin(), s.rend(), [](const char& a) {
				return a != ' ';
			});
			if( first_digit != s.rend() ) {
				*first_digit = ' ';
			}
		}
	}

	std::string as_string() const {
		return { s.data(), s.size() };
	}

	void remove_leading_zeros() {
		remove_zeros(s.begin(), s.end());
	}

	void remove_trailing_zeros() {
		remove_zeros(s.rbegin(), s.rend());
	}

private:
	using array_type = std::array<char, N>;

	array_type s { };
	Justify justify { Justify::Left };

	template<typename Iterator>
	void remove_zeros(Iterator begin, Iterator end) {
		const auto first_significant_digit =
			std::find_if(begin, end, [](const char& a) {
				return a != '0';
			});
		std::fill(begin, first_significant_digit, ' ');
	}

	void insert_right(const char c) {
		auto insert_point = s.end() - 1;

		if( justify == Justify::Left ) {
			insert_point = std::find_if(s.begin(), s.end(), [](const char& a) {
				return a == ' ';
			});
		}

		if( *insert_point != ' ' ) {
			insert_point = shift_left();
		}

		*insert_point = c;
	}

	typename array_type::iterator shift_left() {
		return std::move(s.begin() + 1, s.end(), s.begin());
	}

	typename array_type::iterator shift_right() {
		return std::move_backward(s.begin(), s.end() - 1, s.end());
	}
};

class FrequencyKeypadView : public View {
public:
	std::function<void(rf::Frequency)> on_changed { };

	FrequencyKeypadView(
		NavigationView& nav,
		const rf::Frequency value
	);

	void focus() override;

	rf::Frequency value() const;
	void set_value(const rf::Frequency new_value);
	bool on_encoder(const EncoderEvent delta) override;

private:
	int16_t focused_button = 0;
	static constexpr int button_w = 240 / 3;
	static constexpr int button_h = 48;

	static constexpr int mhz_digits = 4;
	static constexpr int submhz_digits = 4;

	static constexpr int mhz_mod = pow(10, mhz_digits);
	static constexpr int submhz_base = pow(10, 6 - submhz_digits);
	static constexpr int text_digits = mhz_digits + 1 + submhz_digits;

	Text text_value {
		{ 0, 4, 240, 16 }
	};

	std::array<Button, 12> buttons { };

	Button button_save {
		{ 0, button_h * 5, 60, button_h },
		"Save"
	};
	Button button_load {
		{ 60, button_h * 5, 60, button_h },
		"Load"
	};
	Button button_close {
		{ 128, button_h * 5, 112, button_h },
		"Done"
	};

	/* TODO: Template arg required in enum?! */
	FieldString<mhz_digits> mhz { FieldString<4>::Justify::Right };
	FieldString<submhz_digits> submhz { FieldString<4>::Justify::Left };

	enum State {
		DigitMHz,
		DigitSubMHz
	};

	State state { DigitMHz };
	bool clear_field_if_digits_entered { true };

	void on_button(Button& button);

	void digit_add(const char c);
	void digit_delete();

	void field_toggle();
	void update_text();
};

class FrequencyStepView : public OptionsField {
public:
	FrequencyStepView(
		Point parent_pos
	) : OptionsField {
			parent_pos,
			5,
			{
				{ " Auto",        0 },  /* Faster == larger step. */
				{ "   10",       10 },  /* Fine tuning SSB voice pitch,in HF and QO-100 sat #669 */
				{ "   50",       50 },	/* added 50Hz/10Hz,but we do not increase GUI digit decimal */
				{ "  100",      100 },
				{ "  1k ",     1000 },
				{ "  3k ",     3000 },	/* Approximate SSB bandwidth */
				{ "  5k ",     5000 },
				{ "  6k3",     6250 },
				{ "  9k ",     9000 },	/* channel spacing for LF, MF in some regions */
				{ " 10k ",    10000 },
				{ " 12k5",    12500 },
				{ " 25k ",    25000 },
				{ "100k ",   100000 },
				{ "  1M ",  1000000 },
				{ " 10M ", 10000000 },
			}
		}
	{
	}
};

class FrequencyOptionsView : public View {
public:
	std::function<void(rf::Frequency)> on_change_step { };
	std::function<void(int32_t)> on_change_reference_ppm_correction { };

	FrequencyOptionsView(const Rect parent_rect, const Style* const style);

	void set_step(rf::Frequency f);
	void set_reference_ppm_correction(int32_t v);

private:
	Text text_step {
		{ 0 * 8, 0 * 16, 4 * 8, 1 * 16 },
		"Step"
	};

	FrequencyStepView field_step {
		{ 5 * 8, 0 * 16 },
	};

	void on_step_changed(rf::Frequency v);
	void on_reference_ppm_correction_changed(int32_t v);

	NumberField field_ppm {
		{ 23 * 8, 0 * 16 },
		3,
		{ -99, 99 },
		1,
		'0',
	};
	Text text_ext {
		{ 23 * 8, 0 * 16, 3 * 8, 1 * 16 },
		"EXT",
	};
	Text text_ppm {
		{ 27 * 8, 0 * 16, 3 * 8, 16 },
		"PPM",
	};
};

class RFAmpField : public NumberField {
public:
	RFAmpField(Point parent_pos);
};

class RadioGainOptionsView : public View {
public:
	RadioGainOptionsView(const Rect parent_rect, const Style* const style);

private:
	Text label_rf_amp {
		{ 0 * 8, 0 * 16, 3 * 8, 1 * 16 },
		"Amp"
	};

	RFAmpField field_rf_amp {
		{ 4 * 8, 0 * 16},
	};
};

class LNAGainField : public NumberField {
public:
	std::function<void(void)> on_show_options { };

	LNAGainField(Point parent_pos);

	void on_focus() override;
};

class VGAGainField : public NumberField {
public:
	std::function<void(void)> on_show_options { };

	VGAGainField(Point parent_pos);

	void on_focus() override;
};

} /* namespace ui */

#endif/*__UI_RECEIVER_H__*/