scriptel-easyscript.h

Go to the documentation of this file.

/*******************************************************************************
 * scriptel-easyscript.h - Copyright 2014 - Scriptel Corporation
 * ----
 * This header contains the definitions for all of the public structures and
 * functions for this library.
 ******************************************************************************/
 
//This set of defines is for the Visual C compiler to define exports/imports for
//the shared library.
#ifndef SCRIPTEL_EASYSCRIPT_H
#define SCRIPTEL_EASYSCRIPT_H
 
#ifdef _MSC_VER
    #define SCRIPTEL_SYMBOL_EXPORT __declspec(dllexport)
    //Check to see if we're producing or consuming the library.
    #ifdef SCRIPTEL_EXPORT_DLL
        #define SCRIPTEL_SYMBOL_LINKAGE __declspec(dllexport)
    #else
        #define SCRIPTEL_SYMBOL_LINKAGE __declspec(dllimport)
    #endif
#else
    #define SCRIPTEL_SYMBOL_EXPORT extern
    #define SCRIPTEL_SYMBOL_LINKAGE extern
#endif
 
#include <time.h>
 
typedef enum {
    SCRIPTEL_RETR_ERROR,
    SCRIPTEL_RETR_SUCCESS
} scriptel_return_status;
 
typedef enum {
    AMERICAN_EXPRESS,
    DINERS_CLUB,
    CARTE_BLANCHE,
    DISCOVER,
    ENROUTE,
    JCB,
    MASTERCARD,
    VISA,
    UNKNOWN
} scriptel_financial_card_vendor;
 
typedef struct {
    const char* protocol_name;
    char start_stream;
    char end_stream;
    char cancel;
    char pen_up;
    const char* sentinel;
    int width;
    int height;
    const char value_table[2][2][23];
} scriptel_signature_protocol;
 
typedef struct {
    char* protocol_name;
    char start_stream;
    char end_stream;
    char* sentinel;
} scriptel_cardswipe_protocol;
 
typedef struct {
    char* account_number;
    char* first_name;
    char* last_name;
    time_t expiration;
    char* service_code;
    char* discretionary_data;
} scriptel_financial_track_one;
 
typedef struct {
    char* account_number;
    time_t expiration;
    char* service_code;
    char* discretionary_data;
} scriptel_financial_track_two;
 
typedef struct {
    scriptel_financial_track_one* track_one;        
    scriptel_financial_track_two* track_two;        
    scriptel_financial_card_vendor card_issuer;     
    char number_valid;                              
} scriptel_financial_card;
 
typedef struct {
    char* state;
    char* city;
    char* last_name;
    char* first_name;
    char* middle_name;
    char* address;
    char* discretionary_data;
} scriptel_identification_track_one;
 
typedef struct {
    char* issuer_number;
    char* id_number;
    time_t expiration;
    time_t birth_date;
} scriptel_identification_track_two;
 
typedef struct {
    int cds_version;
    int jurisdiction_version;
    char* zip_code;
    char* license_class;
    char* restrictions;
    char* endorsements;
    char* sex;
    char* height;
    char* weight;
    char* hair_color;
    char* eye_color;
} scriptel_identification_track_three;
 
typedef struct {
    scriptel_identification_track_one* track_one;       
    scriptel_identification_track_two* track_two;       
    scriptel_identification_track_three* track_three;   
} scriptel_identification_card;
 
typedef enum {
    CBT_NEWSTROKE,          
    CBT_COORDINATE,         
    CBT_METADATA,           
    CBT_CANCEL,             
    CBT_END_OF_SIGNATURE,   
    CBT_CARD_DATA           
} callback_type;
 
typedef struct {
    callback_type type; 
    double x;                   
    double y;                   
} scriptel_coordinate;
 
typedef struct {
    callback_type type; 
    char *protocol_version;     
    char *model;                
    char *version;              
} signature_meta_data;
 
typedef struct {
    callback_type type;                                 
    char* protocol_version;                             
    char* card_data;                                    
    scriptel_financial_card* financial_card;            
    scriptel_identification_card* identification_card;  
} scriptel_cardswipe;
 
typedef union {
    callback_type type;             
    signature_meta_data meta_data;  
    scriptel_coordinate coordinate; 
    scriptel_cardswipe card_swipe;  
} streaming_event_data;
 
typedef struct {
    int length;
    scriptel_coordinate* coordinates;
} scriptel_stroke;
 
typedef struct {
    char* protocol_version;     
    char* model;                
    char* version;              
    int length;                 
    scriptel_stroke* strokes;   
    int width;                  
    int height;                 
} scriptel_signature;
 
static const scriptel_signature_protocol STN_SIGNATURE_PROTOCOL = {
    "Standard EasyScript Protocol",
    '~',
    '`',
    '/',
    ' ',
    "STSIGN",
    240,
    64,
    {
        {
            {0x41,0x43,0x45,0x47,0x49,0x4b,0x4d,0x4f,0x51,0x53,0x55,0x57,0x59,0x21,0x23,0x25,0x26,0x28,0x2b,0x7d,0x22,0x3c,0x00},
            {0x42,0x44,0x46,0x48,0x4a,0x4c,0x4e,0x50,0x52,0x54,0x56,0x58,0x5a,0x40,0x24,0x5e,0x2a,0x29,0x5f,0x7b,0x7c,0x3a,0x3e}
        }, {
            {0x61,0x63,0x65,0x67,0x69,0x6b,0x6d,0x6f,0x71,0x73,0x75,0x77,0x79,0x31,0x33,0x35,0x37,0x39,0x3d,0x5d,0x27,0x2c,0x00},
            {0x62,0x64,0x66,0x68,0x6a,0x6c,0x6e,0x70,0x72,0x74,0x76,0x78,0x7a,0x32,0x34,0x36,0x38,0x30,0x2d,0x5b,0x5c,0x3b,0x2e}
        }
    }
};
 
 
 
static const scriptel_cardswipe_protocol STN_CARDSWIPE_PROTOCOL = {
    "Standard EasyScript Card Swipe Protocol",
    '!',
    '\r',
    "STCARD"
};
 
#define SCRIPTEL_ERROR_MAX_LEN 512
 
 
#define SCRIPTEL_EASYSCRIPT_LIBRARY_VERSION = "3.5.29";
 
#define SCRIPTEL_EASYSCRIPT_BUILD_DATE = "2022-08-30 17:12:23-0400";
 
SCRIPTEL_SYMBOL_LINKAGE scriptel_return_status scriptel_keyboard_parse_signature(scriptel_signature_protocol* sig_protocol, scriptel_signature* signature, char* buffer, int len);
 
SCRIPTEL_SYMBOL_LINKAGE scriptel_return_status scriptel_keyboard_parse_cardswipe(const scriptel_cardswipe_protocol* swipe_protocol, scriptel_cardswipe* swipe, char* buffer, int len);
 
SCRIPTEL_SYMBOL_LINKAGE scriptel_return_status scriptel_keyboard_parse_char(const scriptel_signature_protocol* sig_protocol, char chr);
 
SCRIPTEL_SYMBOL_LINKAGE scriptel_return_status scriptel_keyboard_parse_keycode(const scriptel_signature_protocol* sig_protocol, int code, int shift);
 
SCRIPTEL_SYMBOL_LINKAGE const char* scriptel_get_card_issuer_name(scriptel_financial_card_vendor vendor);
 
SCRIPTEL_SYMBOL_LINKAGE char* scriptel_get_last_error();
 
SCRIPTEL_SYMBOL_LINKAGE void scriptel_print_signature(scriptel_signature* signature);
 
SCRIPTEL_SYMBOL_LINKAGE void scriptel_free_signature(scriptel_signature* signature);
 
SCRIPTEL_SYMBOL_LINKAGE void scriptel_free_cardswipe(scriptel_cardswipe* swipe);
 
SCRIPTEL_SYMBOL_LINKAGE void scriptel_print_cardswipe(scriptel_cardswipe* swipe);
 
SCRIPTEL_SYMBOL_LINKAGE void scriptel_add_event_listener(void(*event_listener)(streaming_event_data *sd));
 
SCRIPTEL_SYMBOL_LINKAGE void scriptel_remove_event_listener(void(*event_listener)(streaming_event_data *sd));
 
SCRIPTEL_SYMBOL_LINKAGE void scriptel_remove_all_event_listeners();
SCRIPTEL_SYMBOL_LINKAGE char * scriptel_get_last_error();
 
SCRIPTEL_SYMBOL_LINKAGE void scriptel_free_memory();
 
#endif