File: report.h

package info (click to toggle)
brltty 6.8-4
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 35,776 kB
  • sloc: ansic: 150,447; java: 13,484; sh: 9,667; xml: 5,702; tcl: 2,634; makefile: 2,328; awk: 713; lisp: 366; python: 321; ml: 301
file content (86 lines) | stat: -rw-r--r-- 2,169 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
/*
 * BRLTTY - A background process providing access to the console screen (when in
 *          text mode) for a blind person using a refreshable braille display.
 *
 * Copyright (C) 1995-2025 by The BRLTTY Developers.
 *
 * BRLTTY 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 BRLTTY_INCLUDED_REPORT
#define BRLTTY_INCLUDED_REPORT

#include "brlapi_param.h"

#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */

typedef enum {
  REPORT_BRAILLE_DEVICE_ONLINE,
  REPORT_BRAILLE_DEVICE_OFFLINE,
  REPORT_BRAILLE_WINDOW_MOVED,
  REPORT_BRAILLE_WINDOW_UPDATED,
  REPORT_BRAILLE_KEY_EVENT,
  REPORT_API_PARAMETER_UPDATED,
} ReportIdentifier;

extern void report (ReportIdentifier identiier, const void *data);

extern void reportParameterUpdated (
  brlapi_param_t parameter, brlapi_param_subparam_t subparam
);

typedef struct {
  ReportIdentifier reportIdentifier;
  const void *reportData;
  void *listenerData;
} ReportListenerParameters;

#define REPORT_LISTENER(name) void name (const ReportListenerParameters *parameters)
typedef REPORT_LISTENER(ReportListener);
typedef struct ReportListenerInstanceStruct ReportListenerInstance;

extern ReportListenerInstance *registerReportListener (
  ReportIdentifier identifier,
  ReportListener *listener,
  void *data
);

extern void unregisterReportListener (ReportListenerInstance *rli);

typedef struct {
  struct {
    unsigned int column;
    unsigned int row;
  } screen;

  struct {
    unsigned int count;
  } text;
} BrailleWindowMovedReport;

typedef struct {
  const unsigned char *cells;
  unsigned int count;
} BrailleWindowUpdatedReport;

typedef struct {
  brlapi_param_t parameter;
  brlapi_param_subparam_t subparam;
} ApiParameterUpdatedReport;

#ifdef __cplusplus
}
#endif /* __cplusplus */

#endif /* BRLTTY_INCLUDED_REPORT */