unix/unix.h

   1 #ifndef PUTTY_UNIX_H
   2 #define PUTTY_UNIX_H
   3
   4 #ifdef HAVE_CONFIG_H
   5 # include "uxconfig.h" /* Space to hide it from mkfiles.pl */
   6 #endif
   7
   8 #include <stdio.h>                     /* for FILENAME_MAX */
   9 #include <stdint.h>                    /* C99 int types */
  10 #ifndef NO_LIBDL
  11 #include <dlfcn.h>                     /* Dynamic library loading */
  12 #endif /*  NO_LIBDL */
  13 #include "charset.h"
  14 #include <sys/types.h>         /* for mode_t */
  15
  16 #ifdef OSX_GTK
  17 /*
  18  * Assorted tweaks to various parts of the GTK front end which all
  19  * need to be enabled when compiling on OS X. Because I might need the
  20  * same tweaks on other systems in future, I don't want to
  21  * conditionalise all of them on OSX_GTK directly, so instead, each
  22  * one has its own name and we enable them all centrally here if
  23  * OSX_GTK is defined at configure time.
  24  */
  25 #define NOT_X_WINDOWS /* of course, all the X11 stuff should be disabled */
  26 #define NO_PTY_PRE_INIT /* OS X gets very huffy if we try to set[ug]id */
  27 #define SET_NONBLOCK_VIA_OPENPT /* work around missing fcntl functionality */
  28 #define OSX_META_KEY_CONFIG /* two possible Meta keys to choose from */
  29 /* this potential one of the Meta keys needs manual handling */
  30 #define META_MANUAL_MASK (GDK_MOD1_MASK)
  31 #define JUST_USE_GTK_CLIPBOARD_UTF8 /* low-level gdk_selection_* fails */
  32 #define DEFAULT_CLIPBOARD GDK_SELECTION_CLIPBOARD /* OS X has no PRIMARY */
  33
  34 #define BUILDINFO_PLATFORM "OS X (GTK)"
  35 #define BUILDINFO_GTK
  36
  37 #elif defined NOT_X_WINDOWS
  38
  39 #define BUILDINFO_PLATFORM "Unix (pure GTK)"
  40 #define BUILDINFO_GTK
  41
  42 #else
  43
  44 #define BUILDINFO_PLATFORM "Unix (GTK + X11)"
  45 #define BUILDINFO_GTK
  46
  47 #endif
  48
  49 char *buildinfo_gtk_version(void);
  50
  51 struct Filename {
  52     char *path;
  53 };
  54 FILE *f_open(const struct Filename *, char const *, int);
  55
  56 struct FontSpec {
  57     char *name;    /* may be "" to indicate no selected font at all */
  58 };
  59 struct FontSpec *fontspec_new(const char *name);
  60
  61 typedef void *Context;                 /* FIXME: probably needs changing */
  62
  63 extern Backend pty_backend;
  64
  65 #define BROKEN_PIPE_ERROR_CODE EPIPE   /* used in sshshare.c */
  66
  67 typedef uint32_t uint32; /* C99: uint32_t defined in stdint.h */
  68 #define PUTTY_UINT32_DEFINED
  69
  70 /*
  71  * Under GTK, we send MA_CLICK _and_ MA_2CLK, or MA_CLICK _and_
  72  * MA_3CLK, when a button is pressed for the second or third time.
  73  */
  74 #define MULTICLICK_ONLY_EVENT 0
  75
  76 /*
  77  * Under GTK, there is no context help available.
  78  */
  79 #define HELPCTX(x) P(NULL)
  80 #define FILTER_KEY_FILES NULL          /* FIXME */
  81 #define FILTER_DYNLIB_FILES NULL       /* FIXME */
  82
  83 /*
  84  * Under X, selection data must not be NUL-terminated.
  85  */
  86 #define SELECTION_NUL_TERMINATED 0
  87
  88 /*
  89  * Under X, copying to the clipboard terminates lines with just LF.
  90  */
  91 #define SEL_NL { 10 }
  92
  93 /* Simple wraparound timer function */
  94 unsigned long getticks(void);
  95 #define GETTICKCOUNT getticks
  96 #define TICKSPERSEC    1000            /* we choose to use milliseconds */
  97 #define CURSORBLINK     450            /* no standard way to set this */
  98
  99 #define WCHAR wchar_t
 100 #define BYTE unsigned char
 101
 102 /*
 103  * Unix-specific global flag
 104  *
 105  * FLAG_STDERR_TTY indicates that standard error might be a terminal and
 106  * might get its configuration munged, so anything trying to output plain
 107  * text (i.e. with newlines in it) will need to put it back into cooked
 108  * mode first.  Applications setting this flag should also call
 109  * stderr_tty_init() before messing with any terminal modes, and can call
 110  * premsg() before outputting text to stderr and postmsg() afterwards.
 111  */
 112 #define FLAG_STDERR_TTY 0x1000
 113
 114 /* The per-session frontend structure managed by gtkwin.c */
 115 struct gui_data;
 116 struct gui_data *new_session_window(Conf *conf, const char *geometry_string);
 117
 118 /* Defined in gtkmain.c */
 119 void launch_duplicate_session(Conf *conf);
 120 void launch_new_session(void);
 121 void launch_saved_session(const char *str);
 122 #ifdef MAY_REFER_TO_GTK_IN_HEADERS
 123 GtkWidget *make_gtk_toplevel_window(void *frontend);
 124 #endif
 125
 126 /* Defined in gtkcomm.c */
 127 void gtkcomm_setup(void);
 128
 129 /* Things pty.c needs from pterm.c */
 130 const char *get_x_display(void *frontend);
 131 int font_dimension(void *frontend, int which);/* 0 for width, 1 for height */
 132 long get_windowid(void *frontend);
 133
 134 /* Things gtkdlg.c needs from pterm.c */
 135 void *get_window(void *frontend);      /* void * to avoid depending on gtk.h */
 136 void post_main(void);     /* called after any subsidiary gtk_main() */
 137
 138 /* Things pterm.c needs from gtkdlg.c */
 139 int do_config_box(const char *title, Conf *conf,
 140                   int midsession, int protcfginfo);
 141 void fatal_message_box(void *window, const char *msg);
 142 void nonfatal_message_box(void *window, const char *msg);
 143 void about_box(void *window);
 144 void *eventlogstuff_new(void);
 145 void showeventlog(void *estuff, void *parentwin);
 146 void logevent_dlg(void *estuff, const char *string);
 147 int reallyclose(void *frontend);
 148 #ifdef MAY_REFER_TO_GTK_IN_HEADERS
 149 int messagebox(GtkWidget *parentwin, const char *title,
 150                const char *msg, int minwid, int selectable, ...);
 151 #endif
 152
 153 /* Things pterm.c needs from {ptermm,uxputty}.c */
 154 char *make_default_wintitle(char *hostname);
 155 int process_nonoption_arg(const char *arg, Conf *conf, int *allow_launch);
 156
 157 /* pterm.c needs this special function in xkeysym.c */
 158 int keysym_to_unicode(int keysym);
 159
 160 /* Things uxstore.c needs from pterm.c */
 161 char *x_get_default(const char *key);
 162
 163 /* Things uxstore.c provides to pterm.c */
 164 void provide_xrm_string(char *string);
 165
 166 /* Things provided by uxcons.c */
 167 struct termios;
 168 void stderr_tty_init(void);
 169 void premsg(struct termios *);
 170 void postmsg(struct termios *);
 171
 172 /* The interface used by uxsel.c */
 173 typedef struct uxsel_id uxsel_id;
 174 void uxsel_init(void);
 175 typedef int (*uxsel_callback_fn)(int fd, int event);
 176 void uxsel_set(int fd, int rwx, uxsel_callback_fn callback);
 177 void uxsel_del(int fd);
 178 int select_result(int fd, int event);
 179 int first_fd(int *state, int *rwx);
 180 int next_fd(int *state, int *rwx);
 181 /* The following are expected to be provided _to_ uxsel.c by the frontend */
 182 uxsel_id *uxsel_input_add(int fd, int rwx);  /* returns an id */
 183 void uxsel_input_remove(uxsel_id *id);
 184
 185 /* uxcfg.c */
 186 struct controlbox;
 187 void unix_setup_config_box(struct controlbox *b, int midsession, int protocol);
 188
 189 /* gtkcfg.c */
 190 void gtk_setup_config_box(struct controlbox *b, int midsession, void *window);
 191
 192 /*
 193  * In the Unix Unicode layer, DEFAULT_CODEPAGE is a special value
 194  * which causes mb_to_wc and wc_to_mb to call _libc_ rather than
 195  * libcharset. That way, we can interface the various charsets
 196  * supported by libcharset with the one supported by mbstowcs and
 197  * wcstombs (which will be the character set in which stuff read
 198  * from the command line or config files is assumed to be encoded).
 199  */
 200 #define DEFAULT_CODEPAGE 0xFFFF
 201 #define CP_UTF8 CS_UTF8                /* from libcharset */
 202
 203 #define strnicmp strncasecmp
 204 #define stricmp strcasecmp
 205
 206 /* BSD-semantics version of signal(), and another helpful function */
 207 void (*putty_signal(int sig, void (*func)(int)))(int);
 208 void block_signal(int sig, int block_it);
 209
 210 /* uxmisc.c */
 211 void cloexec(int);
 212 void noncloexec(int);
 213 int nonblock(int);
 214 int no_nonblock(int);
 215 char *make_dir_and_check_ours(const char *dirname);
 216 char *make_dir_path(const char *path, mode_t mode);
 217
 218 /*
 219  * Exports from unicode.c.
 220  */
 221 struct unicode_data;
 222 int init_ucs(struct unicode_data *ucsdata, char *line_codepage,
 223              int utf8_override, int font_charset, int vtmode);
 224
 225 /*
 226  * Spare function exported directly from uxnet.c.
 227  */
 228 void *sk_getxdmdata(void *sock, int *lenp);
 229
 230 /*
 231  * General helpful Unix stuff: more helpful version of the FD_SET
 232  * macro, which also handles maxfd.
 233  */
 234 #define FD_SET_MAX(fd, max, set) do { \
 235     FD_SET(fd, &set); \
 236     if (max < fd + 1) max = fd + 1; \
 237 } while (0)
 238
 239 /*
 240  * Exports from winser.c.
 241  */
 242 extern Backend serial_backend;
 243
 244 /*
 245  * uxpeer.c, wrapping getsockopt(SO_PEERCRED).
 246  */
 247 int so_peercred(int fd, int *pid, int *uid, int *gid);
 248
 249 /*
 250  * Default font setting, which can vary depending on NOT_X_WINDOWS.
 251  */
 252 #ifdef NOT_X_WINDOWS
 253 #define DEFAULT_GTK_FONT "client:Monospace 12"
 254 #else
 255 #define DEFAULT_GTK_FONT "server:fixed"
 256 #endif
 257
 258 #endif