nhyatt/putty-source
1
0
Fork 0
mirror of https://git.tartarus.org/simon/putty.git synced 2025-07-05 21:42:47 -05:00
Code Issues Projects Releases Wiki Activity

Remove the 'Frontend' type and replace it with a vtable.

Browse Source 
After the recent Seat and LogContext revamps, _nearly_ all the
remaining uses of the type 'Frontend' were in terminal.c, which needs
all sorts of interactions with the GUI window the terminal lives in,
from the obvious (actually drawing text on the window, reading and
writing the clipboard) to the obscure (minimising, maximising and
moving the window in response to particular escape sequences).

All of those functions are now provided by an abstraction called
TermWin. The few remaining uses of Frontend after _that_ are internal
to a particular platform directory, so as to spread the implementation
of that particular kind of Frontend between multiple source files; so
I've renamed all of those so that they take a more specifically named
type that refers to the particular implementation rather than the
general abstraction.

So now the name 'Frontend' no longer exists in the code base at all,
and everywhere one used to be used, it's completely clear whether it
was operating in one of Frontend's three abstract roles (and if so,
which), or whether it was specific to a particular implementation.

Another type that's disappeared is 'Context', which used to be a
typedef defined to something different on each platform, describing
whatever short-lived resources were necessary to draw on the terminal
window: the front end would provide a ready-made one when calling
term_paint, and the terminal could request one with get_ctx/free_ctx
if it wanted to do proactive window updates. Now that drawing context
lives inside the TermWin itself, because there was never any need to
have two of those contexts live at the same time.

(Another minor API change is that the window-title functions - both
reading and writing - have had a missing 'const' added to their char *
parameters / return values.)

I don't expect this change to enable any particularly interesting new
functionality (in particular, I have no plans that need more than one
implementation of TermWin in the same application). But it completes
the tidying-up that began with the Seat and LogContext rework.
This commit is contained in:
Simon Tatham
2018-10-25 18:44:04 +01:00
parent 291c1b07f2
commit 64f8f68a34
12 changed files with 839 additions and 568 deletions
Download Patch File Download Diff File Expand all files Collapse all files

105
fuzzterm.c
View File

@ -9,6 +9,8 @@
/* For Unix in particular, but harmless if this main() is reused elsewhere */
const int buildinfo_gtk_relevant = FALSE;
static const TermWinVtable fuzz_termwin_vt;
int main(int argc, char **argv)
{
char blk[512];
@ -16,6 +18,9 @@ int main(int argc, char **argv)
Terminal *term;
Conf *conf;
struct unicode_data ucsdata;
TermWin termwin;
termwin.vt = &fuzz_termwin_vt;
conf = conf_new();
do_defaults(NULL, conf);
@ -23,7 +28,7 @@ int main(int argc, char **argv)
conf_get_int(conf, CONF_utf8_override),
CS_NONE, conf_get_int(conf, CONF_vtmode));
term = term_init(conf, &ucsdata, NULL);
term = term_init(conf, &ucsdata, &termwin);
term_size(term, 24, 80, 10000);
term->ldisc = NULL;
/* Tell american fuzzy lop that this is a good place to fork. */
@ -39,10 +44,10 @@ int main(int argc, char **argv)
}
/* functions required by terminal.c */
void request_resize(Frontend *frontend, int x, int y) { }
void do_text(Context ctx, int x, int y, wchar_t * text, int len,
unsigned long attr, int lattr, truecolour tc)
static int fuzz_setup_draw_ctx(TermWin *tw) { return TRUE; }
static void fuzz_draw_text(
TermWin *tw, int x, int y, wchar_t *text, int len,
unsigned long attr, int lattr, truecolour tc)
{
int i;
@ -52,8 +57,9 @@ void do_text(Context ctx, int x, int y, wchar_t * text, int len,
}
printf("\n");
}
void do_cursor(Context ctx, int x, int y, wchar_t * text, int len,
unsigned long attr, int lattr, truecolour tc)
static void fuzz_draw_cursor(
TermWin *tw, int x, int y, wchar_t *text, int len,
unsigned long attr, int lattr, truecolour tc)
{
int i;
@ -63,38 +69,69 @@ void do_cursor(Context ctx, int x, int y, wchar_t * text, int len,
}
printf("\n");
}
int char_width(Context ctx, int uc) { return 1; }
void set_title(Frontend *frontend, char *t) { }
void set_icon(Frontend *frontend, char *t) { }
void set_sbar(Frontend *frontend, int a, int b, int c) { }
static int fuzz_char_width(TermWin *tw, int uc) { return 1; }
static void fuzz_free_draw_ctx(TermWin *tw) {}
static void fuzz_set_cursor_pos(TermWin *tw, int x, int y) {}
static void fuzz_set_raw_mouse_mode(TermWin *tw, int enable) {}
static void fuzz_set_scrollbar(TermWin *tw, int total, int start, int page) {}
static void fuzz_bell(TermWin *tw, int mode) {}
static void fuzz_clip_write(
TermWin *tw, int clipboard, wchar_t *text, int *attrs,
truecolour *colours, int len, int must_deselect) {}
static void fuzz_clip_request_paste(TermWin *tw, int clipboard) {}
static void fuzz_refresh(TermWin *tw) {}
static void fuzz_request_resize(TermWin *tw, int w, int h) {}
static void fuzz_set_title(TermWin *tw, const char *title) {}
static void fuzz_set_icon_title(TermWin *tw, const char *icontitle) {}
static void fuzz_set_minimised(TermWin *tw, int minimised) {}
static int fuzz_is_minimised(TermWin *tw) { return FALSE; }
static void fuzz_set_maximised(TermWin *tw, int maximised) {}
static void fuzz_move(TermWin *tw, int x, int y) {}
static void fuzz_set_zorder(TermWin *tw, int top) {}
static int fuzz_palette_get(TermWin *tw, int n, int *r, int *g, int *b)
{ return FALSE; }
static void fuzz_palette_set(TermWin *tw, int n, int r, int g, int b) {}
static void fuzz_palette_reset(TermWin *tw) {}
static void fuzz_get_pos(TermWin *tw, int *x, int *y) { *x = *y = 0; }
static void fuzz_get_pixels(TermWin *tw, int *x, int *y) { *x = *y = 0; }
static const char *fuzz_get_title(TermWin *tw, int icon) { return "moo"; }
static int fuzz_is_utf8(TermWin *tw) { return TRUE; }
static const TermWinVtable fuzz_termwin_vt = {
fuzz_setup_draw_ctx,
fuzz_draw_text,
fuzz_draw_cursor,
fuzz_char_width,
fuzz_free_draw_ctx,
fuzz_set_cursor_pos,
fuzz_set_raw_mouse_mode,
fuzz_set_scrollbar,
fuzz_bell,
fuzz_clip_write,
fuzz_clip_request_paste,
fuzz_refresh,
fuzz_request_resize,
fuzz_set_title,
fuzz_set_icon_title,
fuzz_set_minimised,
fuzz_is_minimised,
fuzz_set_maximised,
fuzz_move,
fuzz_set_zorder,
fuzz_palette_get,
fuzz_palette_set,
fuzz_palette_reset,
fuzz_get_pos,
fuzz_get_pixels,
fuzz_get_title,
fuzz_is_utf8,
};
void ldisc_send(Ldisc *ldisc, const void *buf, int len, int interactive) {}
void ldisc_echoedit_update(Ldisc *ldisc) {}
Context get_ctx(Frontend *frontend) { return NULL; }
void free_ctx(Context ctx) { }
void palette_set(Frontend *frontend, int a, int b, int c, int d) { }
void palette_reset(Frontend *frontend) { }
int palette_get(Frontend *frontend, int n, int *r, int *g, int *b) {return FALSE;}
void write_clip(Frontend *frontend, int clipboard,
wchar_t *a, int *b, truecolour *c, int d, int e) { }
void set_raw_mouse_mode(Frontend *frontend, int m) { }
void frontend_request_paste(Frontend *frontend, int clipboard) { }
void do_beep(Frontend *frontend, int a) { }
void sys_cursor(Frontend *frontend, int x, int y) { }
void modalfatalbox(const char *fmt, ...) { exit(0); }
void nonfatal(const char *fmt, ...) { }
void set_iconic(Frontend *frontend, int iconic) { }
void move_window(Frontend *frontend, int x, int y) { }
void set_zorder(Frontend *frontend, int top) { }
void refresh_window(Frontend *frontend) { }
void set_zoomed(Frontend *frontend, int zoomed) { }
int is_iconic(Frontend *frontend) { return 0; }
void get_window_pos(Frontend *frontend, int *x, int *y) { *x = 0; *y = 0; }
void get_window_pixels(Frontend *frontend, int *x, int *y) { *x = 0; *y = 0; }
char *get_window_title(Frontend *frontend, int icon) { return "moo"; }
int frontend_is_utf8(Frontend *frontend) { return TRUE; }
/* needed by timing.c */
void timer_change_notify(unsigned long next) { }
@ -173,5 +210,3 @@ char *x_get_default(const char *key)
{
return NULL; /* this is a stub */
}