summaryrefslogtreecommitdiff
path: root/include/ghostty/vt/paste.h
blob: d90f303d43ebf980f2ce3d44a7ce881653f1f558 (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
/**
 * @file paste.h
 *
 * Paste utilities - validate and encode paste data for terminal input.
 */

#ifndef GHOSTTY_VT_PASTE_H
#define GHOSTTY_VT_PASTE_H

/** @defgroup paste Paste Utilities
 *
 * Utilities for validating paste data safety.
 *
 * ## Basic Usage
 *
 * Use ghostty_paste_is_safe() to check if paste data contains potentially
 * dangerous sequences before sending it to the terminal.
 *
 * ## Example
 *
 * @code{.c}
 * #include <stdio.h>
 * #include <string.h>
 * #include <ghostty/vt.h>
 * 
 * int main() {
 *   const char* safe_data = "hello world";
 *   const char* unsafe_data = "rm -rf /\n";
 * 
 *   if (ghostty_paste_is_safe(safe_data, strlen(safe_data))) {
 *     printf("Safe to paste\n");
 *   }
 * 
 *   if (!ghostty_paste_is_safe(unsafe_data, strlen(unsafe_data))) {
 *     printf("Unsafe! Contains newline\n");
 *   }
 * 
 *   return 0;
 * }
 * @endcode
 *
 * @{
 */

#include <stdbool.h>
#include <stddef.h>

#ifdef __cplusplus
extern "C" {
#endif

/**
 * Check if paste data is safe to paste into the terminal.
 *
 * Data is considered unsafe if it contains:
 * - Newlines (`\n`) which can inject commands
 * - The bracketed paste end sequence (`\x1b[201~`) which can be used
 *   to exit bracketed paste mode and inject commands
 *
 * This check is conservative and considers data unsafe regardless of
 * current terminal state.
 *
 * @param data The paste data to check (must not be NULL)
 * @param len The length of the data in bytes
 * @return true if the data is safe to paste, false otherwise
 */
bool ghostty_paste_is_safe(const char* data, size_t len);

#ifdef __cplusplus
}
#endif

/** @} */

#endif /* GHOSTTY_VT_PASTE_H */