Patch from Alejandro Sedeno, somewhat modified by me, which
[u/mdw/putty] / unix / unix.h
CommitLineData
f7f27309 1#ifndef PUTTY_UNIX_H
2#define PUTTY_UNIX_H
3
76d3a838 4#ifdef HAVE_CONFIG_H
5# include "uxconfig.h" /* Space to hide it from mkfiles.pl */
6#endif
7
9a30e26b 8#include <stdio.h> /* for FILENAME_MAX */
b3d375b2 9#include <stdint.h> /* C99 int types */
10#ifndef NO_LIBDL
11#include <dlfcn.h> /* Dynamic library loading */
12#endif /* NO_LIBDL */
2dc6356a 13#include "charset.h"
14
9a30e26b 15struct Filename {
16 char path[FILENAME_MAX];
17};
c6940f12 18FILE *f_open(struct Filename, char const *, int);
9a30e26b 19
20struct FontSpec {
21 char name[256];
22};
23
f7f27309 24typedef void *Context; /* FIXME: probably needs changing */
25
f7f9fb5c 26typedef int OSSocket;
27#define OSSOCKET_DEFINED /* stop network.h using its default */
28
1709795f 29extern Backend pty_backend;
30
b3d375b2 31typedef uint32_t uint32; /* C99: uint32_t defined in stdint.h */
32#define PUTTY_UINT32_DEFINED
33
e6346999 34/*
35 * Under GTK, we send MA_CLICK _and_ MA_2CLK, or MA_CLICK _and_
36 * MA_3CLK, when a button is pressed for the second or third time.
37 */
38#define MULTICLICK_ONLY_EVENT 0
39
40/*
d9b15094 41 * Under GTK, there is no context help available.
42 */
43#define HELPCTX(x) P(NULL)
44#define FILTER_KEY_FILES NULL /* FIXME */
45
46/*
e6346999 47 * Under X, selection data must not be NUL-terminated.
48 */
49#define SELECTION_NUL_TERMINATED 0
50
0f351587 51/*
52 * Under X, copying to the clipboard terminates lines with just LF.
53 */
54#define SEL_NL { 10 }
55
f7f27309 56/* Simple wraparound timer function */
57unsigned long getticks(void); /* based on gettimeofday(2) */
58#define GETTICKCOUNT getticks
39934deb 59#define TICKSPERSEC 1000 /* we choose to use milliseconds */
60#define CURSORBLINK 450 /* no standard way to set this */
2ac3322e 61/* getticks() works using gettimeofday(), so it's vulnerable to system clock
62 * changes causing chaos. Therefore, we provide a compensation mechanism. */
63#define TIMING_SYNC
64#define TIMING_SYNC_ANOW
65extern long tickcount_offset;
f7f27309 66
67#define WCHAR wchar_t
68#define BYTE unsigned char
69
f7397dc6 70/*
71 * Unix-specific global flag
72 *
73 * FLAG_STDERR_TTY indicates that standard error might be a terminal and
74 * might get its configuration munged, so anything trying to output plain
75 * text (i.e. with newlines in it) will need to put it back into cooked
76 * mode first. Applications setting this flag should also call
77 * stderr_tty_init() before messing with any terminal modes, and can call
78 * premsg() before outputting text to stderr and postmsg() afterwards.
79 */
80#define FLAG_STDERR_TTY 0x1000
81
e9aef757 82/* Things pty.c needs from pterm.c */
a8327734 83char *get_x_display(void *frontend);
84int font_dimension(void *frontend, int which);/* 0 for width, 1 for height */
7af753e6 85long get_windowid(void *frontend);
755a6d84 86
5bf9955d 87/* Things gtkdlg.c needs from pterm.c */
88void *get_window(void *frontend); /* void * to avoid depending on gtk.h */
89
3f935d5b 90/* Things pterm.c needs from gtkdlg.c */
f89c3294 91int do_config_box(const char *title, Config *cfg,
92 int midsession, int protcfginfo);
3f935d5b 93void fatal_message_box(void *window, char *msg);
7718480a 94void about_box(void *window);
8eed910d 95void *eventlogstuff_new(void);
96void showeventlog(void *estuff, void *parentwin);
cbe2d68f 97void logevent_dlg(void *estuff, const char *string);
abb6895f 98int reallyclose(void *frontend);
3f935d5b 99
10705014 100/* Things pterm.c needs from {ptermm,uxputty}.c */
101char *make_default_wintitle(char *hostname);
df7c7e52 102int process_nonoption_arg(char *arg, Config *cfg, int *allow_launch);
10705014 103
f5dd8adb 104/* pterm.c needs this special function in xkeysym.c */
105int keysym_to_unicode(int keysym);
106
faec60ed 107/* Things uxstore.c needs from pterm.c */
c85623f9 108char *x_get_default(const char *key);
faec60ed 109
0ac15bdc 110/* Things uxstore.c provides to pterm.c */
111void provide_xrm_string(char *string);
112
f7397dc6 113/* Things provided by uxcons.c */
114struct termios;
115void stderr_tty_init(void);
116void premsg(struct termios *);
117void postmsg(struct termios *);
118
0ff9ea38 119/* The interface used by uxsel.c */
120void uxsel_init(void);
121typedef int (*uxsel_callback_fn)(int fd, int event);
122void uxsel_set(int fd, int rwx, uxsel_callback_fn callback);
123void uxsel_del(int fd);
c5e438ec 124int select_result(int fd, int event);
0ff9ea38 125int first_fd(int *state, int *rwx);
126int next_fd(int *state, int *rwx);
74aca06d 127/* The following are expected to be provided _to_ uxsel.c by the frontend */
128int uxsel_input_add(int fd, int rwx); /* returns an id */
129void uxsel_input_remove(int id);
c5e438ec 130
1d0d4a3b 131/* uxcfg.c */
132struct controlbox;
8a7f1392 133void unix_setup_config_box(struct controlbox *b, int midsession, int protocol);
1d0d4a3b 134
8d68f26a 135/* gtkcfg.c */
136void gtk_setup_config_box(struct controlbox *b, int midsession, void *window);
137
2dc6356a 138/*
139 * In the Unix Unicode layer, DEFAULT_CODEPAGE is a special value
140 * which causes mb_to_wc and wc_to_mb to call _libc_ rather than
141 * libcharset. That way, we can interface the various charsets
142 * supported by libcharset with the one supported by mbstowcs and
143 * wcstombs (which will be the character set in which stuff read
144 * from the command line or config files is assumed to be encoded).
145 */
146#define DEFAULT_CODEPAGE 0xFFFF
147#define CP_UTF8 CS_UTF8 /* from libcharset */
f7f27309 148
68a49acb 149#define strnicmp strncasecmp
150#define stricmp strcasecmp
151
15b5d988 152/* BSD-semantics version of signal(), and another helpful function */
0f33f9d1 153void (*putty_signal(int sig, void (*func)(int)))(int);
15b5d988 154void block_signal(int sig, int block_it);
0f33f9d1 155
db9b7dce 156/* uxmisc.c */
157int cloexec(int);
158
facd762c 159/*
160 * Exports from unicode.c.
161 */
21d2b241 162struct unicode_data;
6ac7f054 163int init_ucs(struct unicode_data *ucsdata, char *line_codepage,
164 int utf8_override, int font_charset, int vtmode);
facd762c 165
2f92b717 166/*
167 * Spare function exported directly from uxnet.c.
168 */
0a4022a1 169void *sk_getxdmdata(void *sock, int *lenp);
2f92b717 170
b51259f6 171/*
172 * General helpful Unix stuff: more helpful version of the FD_SET
173 * macro, which also handles maxfd.
174 */
175#define FD_SET_MAX(fd, max, set) do { \
176 FD_SET(fd, &set); \
177 if (max < fd + 1) max = fd + 1; \
178} while (0)
179
aef05b78 180/*
181 * Exports from winser.c.
182 */
183extern Backend serial_backend;
184
f7f27309 185#endif