ppg_leader_sequences.h

/* Copyright 2017 noseglasses <shinynoseglasses@gmail.com>
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, 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 Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

#ifndef PPG_LEADER_SEQUENCES_H
#define PPG_LEADER_SEQUENCES_H

#include "ppg_action.h"
#include "ppg_input.h"
#include "ppg_token.h"

#include <stdint.h>

#define PPG_MAX_SEQUENCE_LENGTH 16

typedef void (*PPG_Leader_String_Retreival_Callback)(
                              uint8_t sequence_id,
                              char *buffer, 
                              uint8_t max_chars);

typedef PPG_Action (*PPG_Leader_Action_Retreival_Callback)(
                                       uint8_t sequence_id);

typedef PPG_Input_Id (*PPG_Leader_Character_To_Input_Callback)(char c);

typedef struct {
   PPG_Leader_String_Retreival_Callback retreive_string;
   
   PPG_Leader_Action_Retreival_Callback retreive_action;
   
   PPG_Leader_Character_To_Input_Callback input_from_char;
   
} PPG_Leader_Functions;

void ppg_alphabetic_leader_sequences(
            PPG_Layer layer,
            PPG_Token leader_token,
            uint8_t n_sequences,
            PPG_Leader_Functions functions,
            bool allow_fallback);

#endif