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
|
// Copyright 2013 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifndef CHROME_BROWSER_EXTENSIONS_API_BRAILLE_DISPLAY_PRIVATE_BRLAPI_CONNECTION_H_
#define CHROME_BROWSER_EXTENSIONS_API_BRAILLE_DISPLAY_PRIVATE_BRLAPI_CONNECTION_H_
#include <stddef.h>
#include <memory>
#include <vector>
#include "base/functional/callback_forward.h"
#include "library_loaders/libbrlapi.h"
namespace extensions::api::braille_display_private {
// A connection to the brlapi server. See brlapi.h for more information
// about the semantics of the methods in this class.
class BrlapiConnection {
public:
using OnDataReadyCallback = base::RepeatingClosure;
enum ConnectResult {
CONNECT_ERROR_RETRY,
CONNECT_ERROR_NO_RETRY,
CONNECT_SUCCESS,
};
static std::unique_ptr<BrlapiConnection> Create(LibBrlapiLoader* loader);
BrlapiConnection(const BrlapiConnection&) = delete;
BrlapiConnection& operator=(const BrlapiConnection&) = delete;
virtual ~BrlapiConnection() = default;
virtual ConnectResult Connect(OnDataReadyCallback onDataReady) = 0;
virtual void Disconnect() = 0;
virtual bool Connected() = 0;
// Gets the last brlapi error on this thread.
// This works similar to errno in C. There's one thread-local error
// value, meaning that this method should be called after any
// other method of this class that can return an error without calling
// another method in between. This class is not thread safe.
virtual brlapi_error_t* BrlapiError() = 0;
// Gets a description of the last brlapi error for this thread, useful
// for logging.
virtual std::string BrlapiStrError() = 0;
// Gets the row and column size of the display. Row x columns might be 0
// if no display is present, returning true on success. Note that this is
// cached in the brlapi client so it is cheap.
virtual bool GetDisplaySize(unsigned int* columns, unsigned int* rows) = 0;
// Sends the specified cells to the display. The array size must
// be equal to what GetDisplaySize() last returned for this connection,
// that is, cells must have a size of rows x columns.
virtual bool WriteDots(const std::vector<unsigned char>& cells) = 0;
// Reads the next keyboard command, returning true on success.
// Returns < 0 on error, 0 if no more keys are pending and > 0
// on success, in which case keyCode will be set to the key command
// value.
virtual int ReadKey(brlapi_keyCode_t* keyCode) = 0;
// Gets the number of dots in a braille cell.
virtual bool GetCellSize(unsigned int* cell_size) = 0;
protected:
BrlapiConnection() = default;
};
} // namespace extensions::api::braille_display_private
#endif // CHROME_BROWSER_EXTENSIONS_API_BRAILLE_DISPLAY_PRIVATE_BRLAPI_CONNECTION_H_
|
