cab_options.h

Go to the documentation of this file.

/******************************************************************************
 * cab Produkttechnik GmbH & Co KG
 * Entwicklung Etikettendrucker
 *
 * cab CUPS Linux Driver, cab_options.h
 * - Defines and cab specific structure
 *
 * Copyright (c) 2004-2020 cab Produkttechnik GmbH, Germany
 *
 * Licensed under Apache License v2.0.  See the file "LICENSE" for more
 * information.
 *
 */

/*****************************************************************************/

#ifndef CAB_OPTIONS_H_
#define CAB_OPTIONS_H_

#include <cups/cups.h>
#include <cups/raster.h>
#include <cups/ppd.h>

/* Printing parameters */
#define OPT_CAB_HEAD               "Heat"

#define OPT_CAB_PRN_METHOD         "PrintMethod"

#define OPT_CAB_SPEED              "Speed"

/* Media setup */
#define OPT_CAB_LABEL_SENSOR       "LabelSensor"

#define OPT_CAB_LABEL_GAP_VK       "LabelGapVK"

#define OPT_CAB_LABEL_GAP_NK       "LabelGapNK"

#define OPT_CAB_LABEL_MIRRORED     "LabelMirrored"

#define OPT_CAB_LABEL_ROTATE       "LabelRotate"

#define OPT_CAB_IGNORE_PAPEREND    "IgnorePaperend"


#define OPT_CAB_PRN_HEAD_OFF_X_VK  "PrnHeadOffsetXVK"

#define OPT_CAB_PRN_HEAD_OFF_X_NK  "PrnHeadOffsetXNK"


#define OPT_CAB_PRN_HEAD_OFF_Y_DIR "PrnHeadOffsetYDir"

#define OPT_CAB_PRN_HEAD_OFF_Y_VK  "PrnHeadOffsetYVK"

#define OPT_CAB_PRN_HEAD_OFF_Y_NK  "PrnHeadOffsetYNK"

#define OPT_CAB_GLBL_OBJ_OFF_X_DIR "GlobalObjOffsetXDir"

#define OPT_CAB_GLBL_OBJ_OFF_X_VK  "GlobalObjOffsetXVK"

#define OPT_CAB_GLBL_OBJ_OFF_X_NK  "GlobalObjOffsetXNK"

#define OPT_CAB_GLBL_OBJ_OFF_Y_DIR "GlobalObjOffsetYDir"

#define OPT_CAB_GLBL_OBJ_OFF_Y_VK  "GlobalObjOffsetYVK"

#define OPT_CAB_GLBL_OBJ_OFF_Y_NK  "GlobalObjOffsetYNK"


/* Peripherie Einstellungen */
#define OPT_CAB_TEAR_OFF_MODE      "TearOffMode"


#define OPT_CAB_CUTTER             "Cutter"

#define OPT_CAB_CUTTER_MODE        "cCutterMode"

#define OPT_CAB_CUTTER_INTERVAL    "cCutterInterval"

#define OPT_CAB_CUTTER_OFFS_1DIR   "cCutterOffset1Dir"

#define OPT_CAB_CUTTER_OFFS_1VK    "cCutterOffset1VK"

#define OPT_CAB_CUTTER_OFFS_1NK    "cCutterOffset1NK"


/* Pre-Printing options */
#define OPT_CAB_PRE_PRINT_MODE "cPrePrintOption"

#define OPT_CAB_PRE_PRINT_DIR_OFFSET  "cPrePrintOffsetDir"

#define OPT_CAB_PRE_PRINT_VK_OFFSET  "cPrePrintOffsetVK"

#define OPT_CAB_PRE_PRINT_NK_OFFSET  "cPrePrintOffsetNK"


/* Perforation settings */
#define OPT_CAB_PERFORATION_ENABLE "cPerforate"

#define OPT_CAB_PERFO_DIR_OFFSET   "cPerfoPrintOffsetDir"

#define OPT_CAB_PERFO_VK_OFFSET    "cPerfoPrintOffsetVK"

#define OPT_CAB_PERFO_NK_OFFSET    "cPerfoPrintOffsetNK"

#define OPT_CAB_PERFO_VK_DEPTH     "cPerfoDepthOffsetVK"

#define OPT_CAB_PERFO_NK_DEPTH     "cPerfoDepthOffsetNK"

#define OPT_CAB_RIBBON_SAVER "RibbonSaver"


/* Peel Off Settings */
#define OPT_CAB_PEEL_OFF           "PeelOff"

#define OPT_CAB_PEEL_OFF_DIR       "cPeelOffDir"

#define OPT_CAB_PEEL_OFF_VKV       "cPeelOffVKVersatz"

#define OPT_CAB_PEEL_OFF_NKV       "cPeelOffNKVersatz"


/* Advance setup parameters */
#define OPT_CAB_BACKFEED_MODE      "BackFeed"

#define OPT_CAB_FORMFEED_MODE      "FormFeed"

#define OPT_CAB_PAUSE_MODE         "Pause"

#define OPT_CAB_IMAGE_OPTIMIZATION      "ImageOpt"

#define OPT_CAB_REPLACE "Replace"

#define OPT_CAB_JSCRIPT_PARAM1          "JScriptParam1"

#define OPT_CAB_JSCRIPT_PARAM2          "JScriptParam2"

#define OPT_CAB_JSCRIPT_PARAM3          "JScriptParam3"

#define OPT_CAB_JSCRIPT_PARAM4          "JScriptParam4"

#define CUSTOM_JSCRIPT_PARAM_MAX        80

enum cutter_mode {
   CAB_CUTTER_MODE_ERR  = 0,     
   CAB_CUTTER_INTERVAL  = 1,     
   CAB_CUTTER_END_JOB   = 2,     
   CAB_CUTTER_START_JOB = 3,     
   CAB_CUTTER_MODE_MAX  = 4      
};



typedef struct {
   char heat[4];        
   char speed[4];       
   char type[2];        
   int  ribbon_saver;
} h_options_t;


typedef struct {
   int  mirrored;        
   int  rotate;          
   int  tear_off;        
   char backfeed[2];     
   int  ignore_paperend; 
   int  image_optimization;
   int  replace;
} o_options_t;



typedef struct {
   int installed;       
   char disp[5];        
} p_options_t;

typedef struct {
   char dispx[5];        
   char dispy[5];        
} d_options_t;


typedef struct {
   char formfeed[2];     
   char pause[2];        
} immediate_commands_t;


typedef struct {
        char param1[CUSTOM_JSCRIPT_PARAM_MAX];
        char param2[CUSTOM_JSCRIPT_PARAM_MAX];
        char param3[CUSTOM_JSCRIPT_PARAM_MAX];
        char param4[CUSTOM_JSCRIPT_PARAM_MAX];
} custom_jscript_t;


/* ******************************************************************* */
/* Import: This command must be placed after the label size is defined */
/*         (S-Command)                                                 */
/* ******************************************************************* */

#define CAB_CUTTER_MODE_EOJ_CHOICE "CMOD2E"

#define CAB_CUTTER_MODE_EXL_CHOICE "CMOD1I"

typedef struct {
   int  installed;      
   int  mode;           
   char amount[5];      
   char disp1[5];       
   char disp2[5];       
} c_options_t;



/* J-Script Optionen für den Etikettensensor */
#define CAB_LABEL_SENSOR_ENDLESS "e"
#define CAB_LABEL_SENSOR_REFLEX  "l2"
#define CAB_LABEL_SENSOR_GAP     "l1"
#define CAB_LABEL_SENSOR_ERROR   "ERR"

typedef struct {
   char ptype[4];        
   double x0;            
   double y0;            
   double gap;           
} s_options_t;



typedef struct {
   int  installed;      
   char depth[5];       
   char disp[5];        
} perfo_options_t;


/* \def CAB_PREPRINT_MODE_OFF_CHOICE Pre-Printing action is disabled */
#define CAB_PREPRINT_MODE_OFF_CHOICE   "PREPOPT0"
/* \def CAB_PREPRINT_MODE_CUT_CHOICE Pre-Printing Mode - Cut label */
#define CAB_PREPRINT_MODE_CUT_CHOICE   "PREPOPT1"
/* \def CAB_PREPRINT_MODE_PERFO_CHOICE Pre-Printing Mode - Perforate label */
#define CAB_PREPRINT_MODE_PERFO_CHOICE "PREPOPT2"


enum preprinting_mode {
   CAB_PREPRINT_MODE_OFF       = 0,  
   CAB_PREPRINT_MODE_CUT       = 1,  
   CAB_PREPRINT_MODE_PERFORATE = 2,  
   CAB_PREPRINT_MODE_MAX       = 3   
};


typedef struct {
   int mode;           
   char disp[5];       
} preprint_options_t;

void handleMarkedPPDOptions(ppd_file_t  *ppd);

int get_option_image_optimization();
int get_option_replace();

int get_custom_jscript1_cmd(char *command, int page);
int get_custom_jscript3_cmd(char *command);

void get_s_option_cmd(char *command, cups_page_header2_t *header, double printwidth);
int get_c_option_cmd(char *command);
int get_p_option_cmd(char *command);
void get_h_option_cmd(char *command);
int get_o_option_cmd(char *command);
int get_d_option_cmd(char *command);

int isPerfoCutterInstalled();
int isPrePrintPerforate();
int isRibbonSaveSelected();
void get_perfo_depth(char *command);
void get_perfo_offset(char *command);
int get_preprint_opt(char *command);

int get_immediate_cmd(char *command, const char* type, const char value);

#endif /* _CAB_OPTIONS_H_ */