states.h

Go to the documentation of this file.

/****************************************************************************
   ----------------------------------------------------------------------
    Copyright (C) Alexander Hoffman, 2019
 
    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 3 of the License, or
    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.  If not, see <http://www.gnu.org/licenses/>.
   ----------------------------------------------------------------------
 ****************************************************************************/
 
#ifndef STATES_H_
#define STATES_H_
 
unsigned char uStatesInit(void);
 
unsigned char uStatesRun(void);
 
int xStatesAdd(void (*probe)(void), void (*enter)(void),
               void (*run)(void), void (*exit)(void), int ID,
               char *name);
 
void vStatesSetCallback(void (*callback)(void));
 
void vStatesSetData(void *data);
 
void vStatesSetInput(unsigned char input);
 
unsigned char uStatesSetState(unsigned int state_id);
 
void *pStatesGetData(void);
 
char *pStatesGetStateName(void);
 
unsigned char uStatesGetInput(void);
 
int xStatesGetStateID(void);
 
int xStatesGetStateCount(void);
 
int xStatesIncrementState(void);
 
int xStatesDecrementState(void);
 
void vStatesClearInput(void);
 
#endif /* STATES_H_ */