summaryrefslogtreecommitdiffhomepage
path: root/include/ptycon/ptycon.h
blob: 6309f27168367e795787f33bd28d714969b40230 (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
#ifndef PTYCON_H
#define PTYCON_H

#include <stdint.h>

#include "ptycon_api.h"

#ifdef __cplusplus
extern "C" {
#endif

/* pre-alpha */
#ifndef PTYC_APP
#ifndef PTYC_PRE_ALPHA
#error  libptycon: pre-alpha: ABI is not final!
#error  to use the library, please pass -DPTYC_PRE_ALPHA to the compiler.
#endif
#endif

/* status codes */
#define PTYC_OK				0x00
#define PTYC_USAGE			0x01
#define PTYC_BAD_OPT			0x02
#define PTYC_BAD_OPT_VAL		0x03
#define PTYC_IO_ERROR			0xA0
#define PTYC_MAP_ERROR			0xA1

/* driver flags */
#define PTYC_DRIVER_VERBOSITY_NONE	0x0000
#define PTYC_DRIVER_VERBOSITY_ERRORS	0x0001
#define PTYC_DRIVER_VERBOSITY_STATUS	0x0002
#define PTYC_DRIVER_VERBOSITY_USAGE	0x0004
#define PTYC_DRIVER_CLONE_VECTOR	0x0008

#define PTYC_DRIVER_VERSION		0x0010
#define PTYC_DRIVER_DRY_RUN		0x0020
#define PTYC_DRIVER_DBG_OVEN		0x0040
#define PTYC_DRIVER_DBG_RAW		0x0080

struct ptyc_source_version {
	int		major;
	int		minor;
	int		revision;
	const char *	commit;
};

struct ptyc_common_ctx {
	uint64_t			drvflags;
	uint64_t			actflags;
	uint64_t			fmtflags;
	nt_pty *			hpts;
	nt_pty *			hptm;
};

struct ptyc_driver_ctx {
	const char **			units;
	const char *			program;
	const char *			module;
	const struct ptyc_common_ctx *	cctx;
	void *				any;
	int				status;
	int				nerrors;
};

/* package info */
ptyc_api				const struct ptyc_source_version * ptyc_source_version(void);

/* driver api */
ptyc_api int  ptyc_get_driver_ctx	(char ** argv, char ** envp, uint32_t flags, struct ptyc_driver_ctx **);
ptyc_api int  ptyc_create_driver_ctx	(const struct ptyc_common_ctx *, struct ptyc_driver_ctx **);
ptyc_api void ptyc_free_driver_ctx	(struct ptyc_driver_ctx *);

/* pty api */
ptyc_api int  ptyc_alloc_pty		(struct ptyc_driver_ctx *);
ptyc_api void ptyc_free_pty		(struct ptyc_driver_ctx *);

/* utility api */
ptyc_api int  ptyc_main			(int, char **, char **);

#ifdef __cplusplus
}
#endif

#endif