field_navigation_interaction_map.h

#ifndef FIELD_NAVIGATION_INTERACTION_MAP_H
#define FIELD_NAVIGATION_INTERACTION_MAP_H
#include <vector>
#include "interaction_result.h"

/** Defines what a user intends a field completion keystroke (which implies navigation between input elements) should to do next.
 *  This is in the context of navigation within and between user data input fields and subsequent fields, or even the whole form (aka page), or even the running program itself.
 *  We could move to the next field, the next block etc.  Might also generate returning from a menu_action.
 */
struct FieldNavInteractionIntentRow {
  InteractionCategory	      category 		  {InteractionCategory::na};         /// Type of interaction (action_) we are engaging in, prior to completing it and returning from it or taking other action.
  Lib_tty::InteractionIntentNav field_nav		  {Lib_tty::InteractionIntentNav::na}; /// Type of user keystroke recieved within the above context.
  Lib_tty::InteractionIntentNav        interaction_nav {Lib_tty::InteractionIntentNav::na};	     /// Expected upcoming action which is returned by the interaction that has just been executed. Historical note: This began as what the menu system sees, but was extended to include moving between fields during data entry on a row, and then further.
};

/** This vector<> defines a table of mapping of which actions (InteractionResultNav) are taken on receipt of a
 *  Hot_key_row.InteractionIntentNav in various types of user form interaction.  Different situations are differentiated by InteractionCategory.
 */
class FieldNavInteractionIntentTable {
public:
  std::vector< FieldNavInteractionIntentRow > rows;
  bool verify() const;                                  /// run once by the only function that uses this data structure.
};

/// only need one of these
static const FieldNavInteractionIntentTable fieldNavInteractionIntentTable {
    // TODO: get rid of global if possible, perhaps adding to the "statu" data structure.
    // ALSO: figure out if this level of detail, or any of this is necessary. Seemed like a good idea at the time. LOL
    std::vector< FieldNavInteractionIntentRow > {
                                              { InteractionCategory::menu, 	    Lib_tty::InteractionIntentNav::esc, 				Lib_tty::InteractionIntentNav::prior_menu_discard_value }, // for example, esc on menu, should take you back one.
        { InteractionCategory::menu, 	    Lib_tty::InteractionIntentNav::exit_fn_immediately, 	Lib_tty::InteractionIntentNav::exit_pgm_immediately },
        { InteractionCategory::menu, 	    Lib_tty::InteractionIntentNav::interrupt_signal, 	Lib_tty::InteractionIntentNav::exit_pgm_immediately },
        { InteractionCategory::menu, 	    Lib_tty::InteractionIntentNav::quit_signal,		Lib_tty::InteractionIntentNav::exit_pgm_immediately },
        { InteractionCategory::menu, 	    Lib_tty::InteractionIntentNav::kill_signal,		Lib_tty::InteractionIntentNav::exit_pgm_immediately },
        { InteractionCategory::menu, 	    Lib_tty::InteractionIntentNav::exit_fn_with_prompts, Lib_tty::InteractionIntentNav::exit_pgm_with_prompts },
        { InteractionCategory::menu, 	    Lib_tty::InteractionIntentNav::eof, 				Lib_tty::InteractionIntentNav::exit_pgm_immediately },
    //{ InteractionCategory::menu, 	    Lib_tty::InteractionIntentNav::help, 				InteractionResultNav::retain_menu }, // ::help - is similar to field, because it it probably called during field entry, so we just use ::field // TODO: complete this: OK so what if help is called from a menu or wizard?  Well then we can do ::field_help, ::menu_help ...
        { InteractionCategory::menu, 		Lib_tty::InteractionIntentNav::browse_up,         Lib_tty::InteractionIntentNav::na },

        { InteractionCategory::menu, 	    Lib_tty::InteractionIntentNav::browse_down, 		Lib_tty::InteractionIntentNav::retain_menu },  // normal response to menu selection prompt.
        { InteractionCategory::menu, 		Lib_tty::InteractionIntentNav::up_one_field, 		Lib_tty::InteractionIntentNav::na },
        { InteractionCategory::menu, 	    Lib_tty::InteractionIntentNav::down_one_field, 	Lib_tty::InteractionIntentNav::retain_menu },  // normal response to menu selection prompt.
        { InteractionCategory::menu, 	    Lib_tty::InteractionIntentNav::page_up, 			Lib_tty::InteractionIntentNav::na },
        { InteractionCategory::menu, 	    Lib_tty::InteractionIntentNav::page_down,		 	Lib_tty::InteractionIntentNav::na },
        { InteractionCategory::menu, 	    Lib_tty::InteractionIntentNav::save_form_as_is,	Lib_tty::InteractionIntentNav::na },
        { InteractionCategory::menu, 	    Lib_tty::InteractionIntentNav::skip_to_end_of_fields, Lib_tty::InteractionIntentNav::na },
        { InteractionCategory::menu, 	    Lib_tty::InteractionIntentNav::skip_one_field, 	Lib_tty::InteractionIntentNav::na },
        { InteractionCategory::menu, 	    Lib_tty::InteractionIntentNav::no_result, 		Lib_tty::InteractionIntentNav::no_result },
        { InteractionCategory::menu, 	    Lib_tty::InteractionIntentNav::na, 				Lib_tty::InteractionIntentNav::na },

        { InteractionCategory::dialog, 	    Lib_tty::InteractionIntentNav::esc, 				Lib_tty::InteractionIntentNav::prior_menu },  // for example, if when <Return> to continue, then stop listing the items.
        { InteractionCategory::dialog, 	    Lib_tty::InteractionIntentNav::exit_fn_immediately, 	Lib_tty::InteractionIntentNav::exit_pgm_immediately },
        { InteractionCategory::dialog, 	    Lib_tty::InteractionIntentNav::interrupt_signal, 	Lib_tty::InteractionIntentNav::exit_pgm_immediately },
        { InteractionCategory::dialog, 	    Lib_tty::InteractionIntentNav::quit_signal,		Lib_tty::InteractionIntentNav::exit_pgm_immediately },
        { InteractionCategory::dialog, 	    Lib_tty::InteractionIntentNav::kill_signal,		Lib_tty::InteractionIntentNav::exit_pgm_immediately },
        { InteractionCategory::dialog, 	    Lib_tty::InteractionIntentNav::exit_fn_with_prompts, Lib_tty::InteractionIntentNav::exit_pgm_with_prompts },
        { InteractionCategory::dialog, 	    Lib_tty::InteractionIntentNav::eof, 				Lib_tty::InteractionIntentNav::exit_pgm_immediately },
    //{ InteractionCategory::dialog, 	    Lib_tty::InteractionIntentNav::help, 			InteractionResultNav::na },
        { InteractionCategory::dialog, 		Lib_tty::InteractionIntentNav::browse_up, 		Lib_tty::InteractionIntentNav::na },
        { InteractionCategory::dialog, 	    Lib_tty::InteractionIntentNav::browse_down, 		Lib_tty::InteractionIntentNav::na },
        { InteractionCategory::dialog, 		Lib_tty::InteractionIntentNav::up_one_field, 		Lib_tty::InteractionIntentNav::retain_menu },
        { InteractionCategory::dialog, 	    Lib_tty::InteractionIntentNav::down_one_field, 	Lib_tty::InteractionIntentNav::retain_menu },
        { InteractionCategory::dialog, 	    Lib_tty::InteractionIntentNav::page_up, 			Lib_tty::InteractionIntentNav::retain_menu },
        { InteractionCategory::dialog, 	    Lib_tty::InteractionIntentNav::page_down,		 	Lib_tty::InteractionIntentNav::retain_menu },
        { InteractionCategory::dialog, 	    Lib_tty::InteractionIntentNav::save_form_as_is,	Lib_tty::InteractionIntentNav::retain_menu },
        { InteractionCategory::dialog, 	    Lib_tty::InteractionIntentNav::skip_to_end_of_fields, Lib_tty::InteractionIntentNav::retain_menu },
        { InteractionCategory::dialog, 	    Lib_tty::InteractionIntentNav::skip_one_field, 	Lib_tty::InteractionIntentNav::na },
        { InteractionCategory::dialog, 	    Lib_tty::InteractionIntentNav::no_result, 		Lib_tty::InteractionIntentNav::no_result },
        { InteractionCategory::dialog, 	    Lib_tty::InteractionIntentNav::na, 				Lib_tty::InteractionIntentNav::na },

        { InteractionCategory::dialogn, 	    Lib_tty::InteractionIntentNav::esc, 				Lib_tty::InteractionIntentNav::prior_menu },  // for example, if when <Return> to continue, then stop listing the items.
        { InteractionCategory::dialogn, 	    Lib_tty::InteractionIntentNav::exit_fn_immediately, 	Lib_tty::InteractionIntentNav::exit_pgm_immediately },
        { InteractionCategory::dialogn, 	    Lib_tty::InteractionIntentNav::interrupt_signal, 	Lib_tty::InteractionIntentNav::exit_pgm_immediately },
        { InteractionCategory::dialogn, 	    Lib_tty::InteractionIntentNav::quit_signal,		Lib_tty::InteractionIntentNav::exit_pgm_immediately },
        { InteractionCategory::dialogn, 	    Lib_tty::InteractionIntentNav::kill_signal,		Lib_tty::InteractionIntentNav::exit_pgm_immediately },
        { InteractionCategory::dialogn, 	    Lib_tty::InteractionIntentNav::exit_fn_with_prompts, Lib_tty::InteractionIntentNav::exit_pgm_with_prompts },
        { InteractionCategory::dialogn, 	    Lib_tty::InteractionIntentNav::eof, 				Lib_tty::InteractionIntentNav::exit_pgm_immediately },
    //{ InteractionCategory::dialog, 	    Lib_tty::InteractionIntentNav::help, 				InteractionResultNav::na },
        { InteractionCategory::dialogn, 		Lib_tty::InteractionIntentNav::browse_up, 		Lib_tty::InteractionIntentNav::na },
        { InteractionCategory::dialogn, 	    Lib_tty::InteractionIntentNav::browse_down, 		Lib_tty::InteractionIntentNav::na },
        { InteractionCategory::dialogn, 		Lib_tty::InteractionIntentNav::up_one_field, 		Lib_tty::InteractionIntentNav::retain_menu },
        { InteractionCategory::dialogn, 	    Lib_tty::InteractionIntentNav::down_one_field, 	Lib_tty::InteractionIntentNav::retain_menu },
        { InteractionCategory::dialogn, 	    Lib_tty::InteractionIntentNav::page_up, 			Lib_tty::InteractionIntentNav::retain_menu },
        { InteractionCategory::dialogn, 	    Lib_tty::InteractionIntentNav::page_down,		 	Lib_tty::InteractionIntentNav::retain_menu },
        { InteractionCategory::dialogn, 	    Lib_tty::InteractionIntentNav::save_form_as_is,	Lib_tty::InteractionIntentNav::retain_menu },
        { InteractionCategory::dialogn, 	    Lib_tty::InteractionIntentNav::skip_to_end_of_fields, Lib_tty::InteractionIntentNav::retain_menu },
        { InteractionCategory::dialogn, 	    Lib_tty::InteractionIntentNav::skip_one_field, 	Lib_tty::InteractionIntentNav::na },
        { InteractionCategory::dialogn, 	    Lib_tty::InteractionIntentNav::no_result, 		Lib_tty::InteractionIntentNav::no_result },
        { InteractionCategory::dialogn, 	    Lib_tty::InteractionIntentNav::na, 				Lib_tty::InteractionIntentNav::na },

        { InteractionCategory::field, 	    Lib_tty::InteractionIntentNav::esc, 				Lib_tty::InteractionIntentNav::prior_menu },  // for example, if when <Return> to continue, then stop listing the items.
        { InteractionCategory::field, 	    Lib_tty::InteractionIntentNav::exit_fn_immediately, 	Lib_tty::InteractionIntentNav::exit_pgm_immediately },
        { InteractionCategory::field, 	    Lib_tty::InteractionIntentNav::interrupt_signal, 	Lib_tty::InteractionIntentNav::exit_pgm_immediately },
        { InteractionCategory::field, 	    Lib_tty::InteractionIntentNav::quit_signal,		Lib_tty::InteractionIntentNav::exit_pgm_immediately },
        { InteractionCategory::field, 	    Lib_tty::InteractionIntentNav::kill_signal,		Lib_tty::InteractionIntentNav::exit_pgm_immediately },
        { InteractionCategory::field, 	    Lib_tty::InteractionIntentNav::exit_fn_with_prompts, Lib_tty::InteractionIntentNav::exit_pgm_with_prompts },
        { InteractionCategory::field, 	    Lib_tty::InteractionIntentNav::eof, 				Lib_tty::InteractionIntentNav::exit_pgm_immediately },
    //{ InteractionCategory::field, 	    Lib_tty::InteractionIntentNav::help, 			InteractionResultNav::na },						// help is handled prior to this decision point.
        { InteractionCategory::field, 		Lib_tty::InteractionIntentNav::browse_up, 		Lib_tty::InteractionIntentNav::up_one_field },  // NOTE: browse_up is also used to navigate between valid_values.
        { InteractionCategory::field, 	    Lib_tty::InteractionIntentNav::browse_down, 		Lib_tty::InteractionIntentNav::down_one_field },  // NOTE: browse_down is also used to navigate between valid_values.
        { InteractionCategory::field, 		Lib_tty::InteractionIntentNav::up_one_field, 		Lib_tty::InteractionIntentNav::up_one_field },
        { InteractionCategory::field, 	    Lib_tty::InteractionIntentNav::down_one_field, 	Lib_tty::InteractionIntentNav::down_one_field },
        { InteractionCategory::field, 	    Lib_tty::InteractionIntentNav::page_up, 			Lib_tty::InteractionIntentNav::up_one_block },
        { InteractionCategory::field, 	    Lib_tty::InteractionIntentNav::page_down,		 	Lib_tty::InteractionIntentNav::down_one_block },
        { InteractionCategory::field, 	    Lib_tty::InteractionIntentNav::save_form_as_is,	Lib_tty::InteractionIntentNav::save_form_as_is },
        { InteractionCategory::field, 	    Lib_tty::InteractionIntentNav::skip_to_end_of_fields, Lib_tty::InteractionIntentNav::skip_to_end_of_fields },
        { InteractionCategory::field, 	    Lib_tty::InteractionIntentNav::skip_one_field, 	Lib_tty::InteractionIntentNav::skip_one_field },
        { InteractionCategory::field, 	    Lib_tty::InteractionIntentNav::no_result, 		Lib_tty::InteractionIntentNav::no_result },
        { InteractionCategory::field, 	    Lib_tty::InteractionIntentNav::na, 				Lib_tty::InteractionIntentNav::na },

        { InteractionCategory::detail_row, 	Lib_tty::InteractionIntentNav::esc, 				Lib_tty::InteractionIntentNav::prior_menu },  // for example, if when <Return> to continue, then stop listing the items.
        { InteractionCategory::detail_row, 	Lib_tty::InteractionIntentNav::exit_fn_immediately, 	Lib_tty::InteractionIntentNav::exit_pgm_immediately },
        { InteractionCategory::detail_row, 	Lib_tty::InteractionIntentNav::interrupt_signal, 	Lib_tty::InteractionIntentNav::exit_pgm_immediately },
        { InteractionCategory::detail_row, 	Lib_tty::InteractionIntentNav::quit_signal,		Lib_tty::InteractionIntentNav::exit_pgm_immediately },
        { InteractionCategory::detail_row, 	Lib_tty::InteractionIntentNav::kill_signal,		Lib_tty::InteractionIntentNav::exit_pgm_immediately },
        { InteractionCategory::detail_row, 	Lib_tty::InteractionIntentNav::exit_fn_with_prompts, Lib_tty::InteractionIntentNav::exit_pgm_with_prompts },
        { InteractionCategory::detail_row, 	Lib_tty::InteractionIntentNav::eof, 				Lib_tty::InteractionIntentNav::exit_pgm_immediately },
    //{ InteractionCategory::detail_row, 	Lib_tty::InteractionIntentNav::help, 			InteractionResultNav::na },
        { InteractionCategory::detail_row, 	Lib_tty::InteractionIntentNav::browse_up, 		Lib_tty::InteractionIntentNav::prior_row },
        { InteractionCategory::detail_row, 	Lib_tty::InteractionIntentNav::browse_down, 		Lib_tty::InteractionIntentNav::next_row },
        { InteractionCategory::detail_row, 	Lib_tty::InteractionIntentNav::up_one_field, 		Lib_tty::InteractionIntentNav::prior_row },
        { InteractionCategory::detail_row, 	Lib_tty::InteractionIntentNav::down_one_field, 	Lib_tty::InteractionIntentNav::next_row },
        { InteractionCategory::detail_row, 	Lib_tty::InteractionIntentNav::page_up, 			Lib_tty::InteractionIntentNav::up_one_block },
        { InteractionCategory::detail_row, 	Lib_tty::InteractionIntentNav::page_down,		 	Lib_tty::InteractionIntentNav::down_one_block },
        { InteractionCategory::detail_row, 	Lib_tty::InteractionIntentNav::save_form_as_is,	Lib_tty::InteractionIntentNav::prior_menu },
        { InteractionCategory::detail_row, 	Lib_tty::InteractionIntentNav::skip_to_end_of_fields, Lib_tty::InteractionIntentNav::last_row },
        { InteractionCategory::detail_row, 	Lib_tty::InteractionIntentNav::skip_one_field, 	Lib_tty::InteractionIntentNav::next_row },
        { InteractionCategory::detail_row, 	Lib_tty::InteractionIntentNav::no_result, 		Lib_tty::InteractionIntentNav::no_result },
        { InteractionCategory::detail_row, 	Lib_tty::InteractionIntentNav::na, 				Lib_tty::InteractionIntentNav::na }
}
};

#endif // FIELD_NAVIGATION_INTERACTION_MAP_H