blob: 633ebeb2aedd45b1590d616eaa367e77007e3ea5 (
plain)
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
|
//===-- FifoFiles.h ---------------------------------------------*- C++ -*-===//
//
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
// See https://llvm.org/LICENSE.txt for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
//
//===----------------------------------------------------------------------===//
#ifndef LLDB_TOOLS_LLDB_DAP_FIFOFILES_H
#define LLDB_TOOLS_LLDB_DAP_FIFOFILES_H
#include "llvm/Support/Error.h"
#include "llvm/Support/JSON.h"
#include <chrono>
namespace lldb_dap {
/// Struct that controls the life of a fifo file in the filesystem.
///
/// The file is destroyed when the destructor is invoked.
struct FifoFile {
FifoFile(llvm::StringRef path);
~FifoFile();
std::string m_path;
};
/// Create a fifo file in the filesystem.
///
/// \param[in] path
/// The path for the fifo file.
///
/// \return
/// A \a std::shared_ptr<FifoFile> if the file could be created, or an
/// \a llvm::Error in case of failures.
llvm::Expected<std::shared_ptr<FifoFile>> CreateFifoFile(llvm::StringRef path);
class FifoFileIO {
public:
/// \param[in] fifo_file
/// The path to an input fifo file that exists in the file system.
///
/// \param[in] other_endpoint_name
/// A human readable name for the other endpoint that will communicate
/// using this file. This is used for error messages.
FifoFileIO(llvm::StringRef fifo_file, llvm::StringRef other_endpoint_name);
/// Read the next JSON object from the underlying input fifo file.
///
/// The JSON object is expected to be a single line delimited with \a
/// std::endl.
///
/// \return
/// An \a llvm::Error object indicating the success or failure of this
/// operation. Failures arise if the timeout is hit, the next line of text
/// from the fifo file is not a valid JSON object, or is it impossible to
/// read from the file.
llvm::Expected<llvm::json::Value> ReadJSON(std::chrono::milliseconds timeout);
/// Serialize a JSON object and write it to the underlying output fifo file.
///
/// \param[in] json
/// The JSON object to send. It will be printed as a single line delimited
/// with \a std::endl.
///
/// \param[in] timeout
/// A timeout for how long we should until for the data to be consumed.
///
/// \return
/// An \a llvm::Error object indicating whether the data was consumed by
/// a reader or not.
llvm::Error SendJSON(
const llvm::json::Value &json,
std::chrono::milliseconds timeout = std::chrono::milliseconds(20000));
private:
std::string m_fifo_file;
std::string m_other_endpoint_name;
};
} // namespace lldb_dap
#endif // LLDB_TOOLS_LLDB_DAP_FIFOFILES_H
|
