ppg_token.h

Go to the documentation of this file.

/* 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_TOKEN_H
#define PPG_TOKEN_H

#include "ppg_action.h"
#include "ppg_action_flags.h"
#include "ppg_settings.h"

enum {
   PPG_Token_Flags_Pedantic = 1 << 1 
                                    // In pedantic mode, a token only matches when all 
                                    // inputs have been disabled after having been 
                                    // enabled in a way that is required by the token 
                                    // to match in standard mode
};

typedef void * PPG_Token;

PPG_Token ppg_token_set_action(
                           PPG_Token token,
                           PPG_Action action);

PPG_Action ppg_token_get_action(PPG_Token token);

PPG_Token ppg_token_set_action_flags(
                           PPG_Token token,
                           PPG_Action_Flags_Type action_flags);

PPG_Action_Flags_Type ppg_token_get_action_flags(PPG_Token token);

PPG_Token ppg_token_set_flags(
                           PPG_Token token,
                           PPG_Count flags);

PPG_Count ppg_token_get_flags(PPG_Token token);

void ppg_token_list_all_active(void);

#define PPG_TOKENS(...) \
   sizeof((PPG_Token[]) { __VA_ARGS__ })/sizeof(PPG_Token), \
   (PPG_Token[]) { __VA_ARGS__ }

#endif