brlapi_param.h

Go to the documentation of this file.

/*
 * libbrlapi - A library providing access to braille terminals for applications.
 *
 * Copyright (C) 2002-2024 by
 *   Samuel Thibault <Samuel.Thibault@ens-lyon.org>
 *   Sébastien Hinderer <Sebastien.Hinderer@ens-lyon.org>
 *
 * libbrlapi comes with ABSOLUTELY NO WARRANTY.
 *
 * This is free software, placed under the terms of the
 * GNU Lesser General Public License, as published by the Free Software
 * Foundation; either version 2.1 of the License, or (at your option) any
 * later version. Please see the file LICENSE-LGPL for details.
 *
 * Web Page: http://brltty.app/
 *
 * This software is maintained by Dave Mielke <dave@mielke.cc>.
 */
 
#ifndef BRLAPI_INCLUDED_PARAM
#define BRLAPI_INCLUDED_PARAM
 
#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */
 
#include "brlapi_keycodes.h"
 
typedef enum {
//Connection Parameters
  BRLAPI_PARAM_SERVER_VERSION = 0,              
  BRLAPI_PARAM_CLIENT_PRIORITY = 1,             
//Device Parameters
  BRLAPI_PARAM_DRIVER_NAME = 2,                 
  BRLAPI_PARAM_DRIVER_CODE = 3,                 
  BRLAPI_PARAM_DRIVER_VERSION = 4,              
  BRLAPI_PARAM_DEVICE_MODEL = 5,                
  BRLAPI_PARAM_DEVICE_CELL_SIZE = 31,           
  BRLAPI_PARAM_DISPLAY_SIZE = 6,                
  BRLAPI_PARAM_DEVICE_IDENTIFIER = 7,           
  BRLAPI_PARAM_DEVICE_SPEED = 8,                
  BRLAPI_PARAM_DEVICE_ONLINE = 9,               
/* TODO: status area */
 
//Input Parameters
  BRLAPI_PARAM_RETAIN_DOTS = 10,                
//Braille Rendering Parameters
  BRLAPI_PARAM_COMPUTER_BRAILLE_CELL_SIZE = 11, 
  BRLAPI_PARAM_LITERARY_BRAILLE = 12,           
  BRLAPI_PARAM_CURSOR_DOTS = 13,                
  BRLAPI_PARAM_CURSOR_BLINK_PERIOD = 14,        
  BRLAPI_PARAM_CURSOR_BLINK_PERCENTAGE = 15,    
  BRLAPI_PARAM_RENDERED_CELLS = 16,             
//Navigation Parameters
  BRLAPI_PARAM_SKIP_IDENTICAL_LINES = 17,       
  BRLAPI_PARAM_AUDIBLE_ALERTS = 18,             
//Clipboard Parameters
  BRLAPI_PARAM_CLIPBOARD_CONTENT = 19,          
//TTY Mode Parameters
  BRLAPI_PARAM_BOUND_COMMAND_KEYCODES = 20,     
  BRLAPI_PARAM_COMMAND_KEYCODE_NAME = 21,       
  BRLAPI_PARAM_COMMAND_KEYCODE_SUMMARY = 22,    
  BRLAPI_PARAM_DEFINED_DRIVER_KEYCODES = 23,    
  BRLAPI_PARAM_DRIVER_KEYCODE_NAME = 24,        
  BRLAPI_PARAM_DRIVER_KEYCODE_SUMMARY = 25,     
//Braille Translation Parameters
  BRLAPI_PARAM_COMPUTER_BRAILLE_ROWS_MASK = 26, 
  BRLAPI_PARAM_COMPUTER_BRAILLE_ROW_CELLS = 27, 
  BRLAPI_PARAM_COMPUTER_BRAILLE_TABLE = 28,     
  BRLAPI_PARAM_LITERARY_BRAILLE_TABLE = 29,     
  BRLAPI_PARAM_MESSAGE_LOCALE = 30,             
/* TODO: dot-to-unicode as well */
 
//Driver-speciic Parameters
  BRLAPI_PARAM_DRIVER_PROPERTY_VALUE = 32,      
 /* TODO: help strings */
 
  BRLAPI_PARAM_COUNT = 33 
} brlapi_param_t;
 
/* brlapi_param_subparam_t */
typedef uint64_t brlapi_param_subparam_t;
 
/* brlapi_param_bool_t */
typedef uint8_t brlapi_param_bool_t;
 
/* brlapi_param_serverVersion_t */
typedef uint32_t brlapi_param_serverVersion_t;
 
/* brlapi_param_clientPriority_t */
typedef uint32_t brlapi_param_clientPriority_t;
 
/* BRLAPI_PARAM_CLIENT_PRIORITY_DEFAULT */
#define BRLAPI_PARAM_CLIENT_PRIORITY_DEFAULT 50
 
/* BRLAPI_PARAM_CLIENT_PRIORITY_DISABLE */
#define BRLAPI_PARAM_CLIENT_PRIORITY_DISABLE 0
 
/* brlapi_param_driverName_t */
typedef char *brlapi_param_driverName_t;
 
/* brlapi_param_driverCode_t */
typedef char *brlapi_param_driverCode_t;
 
/* brlapi_param_driverVersion_t */
typedef char *brlapi_param_driverVersion_t;
 
/* brlapi_param_deviceModel_t */
typedef char *brlapi_param_deviceModel_t;
 
/* brlapi_param_deviceCellSize_t */
typedef uint8_t brlapi_param_deviceCellSize_t;
 
/* brlapi_param_displaySize_t */
typedef struct {
  uint32_t columns;
  uint32_t rows;
} brlapi_param_displaySize_t;
 
/* brlapi_param_deviceIdentifier_t */
typedef char *brlapi_param_deviceIdentifier_t;
 
/* brlapi_param_deviceSpeed_t */
typedef uint32_t brlapi_param_deviceSpeed_t;
 
/* brlapi_param_deviceOnline_t */
typedef brlapi_param_bool_t brlapi_param_deviceOnline_t;
 
/* brlapi_param_retainDots_t */
typedef brlapi_param_bool_t brlapi_param_retainDots_t;
 
/* brlapi_param_computerBrailleCellSize_t */
typedef uint8_t brlapi_param_computerBrailleCellSize_t;
 
/* brlapi_param_literaryBraille_t */
typedef brlapi_param_bool_t brlapi_param_literaryBraille_t;
 
/* brlapi_param_cursorDots_t */
typedef uint8_t brlapi_param_cursorDots_t;
 
/* brlapi_param_cursorBlinkPeriod_t */
typedef uint32_t brlapi_param_cursorBlinkPeriod_t;
 
/* brlapi_param_cursorBlinkPercentage_t */
typedef uint8_t brlapi_param_cursorBlinkPercentage_t;
 
/* brlapi_param_renderedCells_t */
typedef uint8_t *brlapi_param_renderedCells_t;
 
/* brlapi_param_skipIdenticalLines_t */
typedef brlapi_param_bool_t brlapi_param_skipIdenticalLines_t;
 
/* brlapi_param_audibleAlerts_t */
typedef brlapi_param_bool_t brlapi_param_audibleAlerts_t;
 
/* brlapi_param_clipboardContent_t */
typedef char *brlapi_param_clipboardContent_t;
 
/* brlapi_param_commandKeycode_t */
typedef brlapi_keyCode_t brlapi_param_commandKeycode_t;
 
/* brlapi_param_commandKeycodeName_t */
typedef char *brlapi_param_commandKeycodeName_t;
 
/* brlapi_param_commandKeycodeSummary_t */
typedef char *brlapi_param_commandKeycodeSummary_t;
 
/* brlapi_param_driverKeycode_t */
typedef brlapi_keyCode_t brlapi_param_driverKeycode_t;
 
/* brlapi_param_driverKeycodeName_t */
typedef char *brlapi_param_driverKeycodeName_t;
 
/* brlapi_param_driverKeycodeSummary_t */
typedef char *brlapi_param_driverKeycodeSummary_t;
 
/* brlapi_param_computerBrailleRowsMask_t */
typedef uint8_t brlapi_param_computerBrailleRowsMask_t[544];
 
/* brlapi_param_computerBrailleRowCells_t */
typedef struct {
  uint8_t cells[0X100];
  uint8_t defined[0X100 / 8];
} brlapi_param_computerBrailleRowCells_t;
 
/* brlapi_param_computerBrailleTable_t */
typedef char *brlapi_param_computerBrailleTable_t;
 
/* brlapi_param_literaryBrailleTable_t */
typedef char *brlapi_param_literaryBrailleTable_t;
 
/* brlapi_param_messageLocale_t */
typedef char *brlapi_param_messageLocale_t;
 
/* brlapi_param_driverPropertyValue_t */
typedef uint64_t brlapi_param_driverPropertyValue_t;
 
#define BRLAPI_PARAM_BOUND_COMMAND_CODES BRLAPI_PARAM_BOUND_COMMAND_KEYCODES
typedef brlapi_param_commandKeycode_t brlapi_param_commandCode_t;
 
#define BRLAPI_PARAM_COMMAND_SHORT_NAME BRLAPI_PARAM_COMMAND_KEYCODE_NAME
typedef brlapi_param_commandKeycodeName_t brlapi_param_commandShortName_t;
 
#define BRLAPI_PARAM_COMMAND_LONG_NAME BRLAPI_PARAM_COMMAND_KEYCODE_SUMMARY
typedef brlapi_param_commandKeycodeSummary_t brlapi_param_commandLongName_t;
 
#define BRLAPI_PARAM_DEVICE_KEY_CODES BRLAPI_PARAM_DEFINED_DRIVER_KEYCODES
typedef brlapi_param_driverKeycode_t brlapi_param_keyCode_t;
 
#define BRLAPI_PARAM_KEY_SHORT_NAME BRLAPI_PARAM_DRIVER_KEYCODE_NAME
typedef brlapi_param_driverKeycodeName_t brlapi_param_keyShortName_t;
 
#define BRLAPI_PARAM_KEY_LONG_NAME BRLAPI_PARAM_DRIVER_KEYCODE_SUMMARY
typedef brlapi_param_driverKeycodeSummary_t brlapi_param_keyLongName_t;
 
typedef enum {
  BRLAPI_PARAM_TYPE_STRING,     
  BRLAPI_PARAM_TYPE_BOOLEAN,    
  BRLAPI_PARAM_TYPE_UINT8,      
  BRLAPI_PARAM_TYPE_UINT16,     
  BRLAPI_PARAM_TYPE_UINT32,     
  BRLAPI_PARAM_TYPE_UINT64,     
  BRLAPI_PARAM_TYPE_KEYCODE = BRLAPI_PARAM_TYPE_UINT64, 
} brlapi_param_type_t;
 
typedef struct {
  brlapi_param_type_t type;     
  uint16_t arraySize;           
  uint16_t isArray:1;           
  uint16_t canRead:1;           
  uint16_t canWrite:1;          
  uint16_t canWatch:1;          
  uint16_t abiPadding1:4;
  uint16_t hasSubparam:1;       
} brlapi_param_properties_t;
 
/* brlapi_getParameterProperties */
extern const brlapi_param_properties_t *brlapi_getParameterProperties(brlapi_param_t parameter);
 
#ifdef __cplusplus
}
#endif /* __cplusplus */
 
#endif /* BRLAPI_INCLUDED_PARAM */