summaryrefslogtreecommitdiff
path: root/src/layer.h
blob: 4284fba7c2ef0432623cb1919d4a86a0373a8343 (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
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
/* Copyright (c) 2008, 2009
 *      Juergen Weigert (jnweiger@immd4.informatik.uni-erlangen.de)
 *      Michael Schroeder (mlschroe@immd4.informatik.uni-erlangen.de)
 *      Micah Cowan (micah@cowan.name)
 *      Sadrul Habib Chowdhury (sadrul@users.sourceforge.net)
 * Copyright (c) 1993-2002, 2003, 2005, 2006, 2007
 *      Juergen Weigert (jnweiger@immd4.informatik.uni-erlangen.de)
 *      Michael Schroeder (mlschroe@immd4.informatik.uni-erlangen.de)
 * Copyright (c) 1987 Oliver Laumann
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 3, or (at your option)
 * any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program (see the file COPYING); if not, see
 * https://www.gnu.org/licenses/, or contact Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA  02111-1301  USA
 *
 ****************************************************************
 * $Id$ GNU
 */

#ifndef SCREEN_LAYER_H
#define SCREEN_LAYER_H

#include <stdbool.h>
#include <stdlib.h>

/*
 * This is the overlay structure. It is used to create a seperate
 * layer over the current windows.
 */

/* forward declarations */
struct mchar;
struct mline;
typedef struct Canvas Canvas;

struct LayFuncs {
	void	(*lf_LayProcess) (char **, size_t *);
	void	(*lf_LayAbort) (void);
	void	(*lf_LayRedisplayLine) (int, int, int, int);
	void	(*lf_LayClearLine) (int, int, int, int);
	int	(*lf_LayResize) (int, int);
	void	(*lf_LayRestore) (void);
	void	(*lf_LayFree) (void *);		/* Should only free any data kept in
						   flayer->l_data (but not flayer->l_data itself). */
};

typedef struct Layer Layer;
struct Layer {
	Canvas *l_cvlist;	/* list of canvases displaying layer */
	int	l_width;
	int	l_height;
	int	l_x;		/* cursor position */
	int	l_y;
	int	l_encoding;
	const struct LayFuncs *l_layfn;
	void	*l_data;

	Layer	*l_next;	/* layer stack, should be in data? */
	Layer	*l_bottom;	/* bottom element of layer stack */
	int	 l_blocking;
	int	 l_mode;	/* non-zero == edit mode */

	struct {
		unsigned char buffer[3];	/* [0]: the button
						   [1]: x
						   [2]: y
						*/
		size_t len;
		bool start;
	} l_mouseevent;

	struct {
		bool d;		/* Is the output for the layer blocked? */

		/* After unpausing, what region should we refresh? */
		int *left, *right;
		int top, bottom;
		int lines;
	} l_pause;
};

#define LayProcess		(*flayer->l_layfn->lf_LayProcess)
#define LayAbort		(*flayer->l_layfn->lf_LayAbort)
#define LayRedisplayLine	(*flayer->l_layfn->lf_LayRedisplayLine)
#define LayClearLine		(*flayer->l_layfn->lf_LayClearLine)
#define LayResize		(*flayer->l_layfn->lf_LayResize)
#define LayRestore		(*flayer->l_layfn->lf_LayRestore)
#define LayFree		(*flayer->l_layfn->lf_LayFree)

#define LaySetCursor()	LGotoPos(flayer, flayer->l_x, flayer->l_y)
#define LayCanResize(l)	(l->l_layfn->LayResize != DefResize)

/* XXX: AArgh! think again! */

#define LAY_CALL_UP(fn) do				\
	{ 						\
	  Layer *oldlay = flayer; 		\
	  Canvas *oldcvlist, *cv;		\
	  flayer = flayer->l_next;			\
	  oldcvlist = flayer->l_cvlist;			\
	  flayer->l_cvlist = oldlay->l_cvlist;		\
	  for (cv = flayer->l_cvlist; cv; cv = cv->c_lnext)	\
		cv->c_layer = flayer;			\
	  fn;						\
	  flayer = oldlay;				\
	  for (cv = flayer->l_cvlist; cv; cv = cv->c_lnext)	\
		cv->c_layer = flayer;			\
	  flayer->l_next->l_cvlist = oldcvlist;		\
	} while(0)

#define LAY_DISPLAYS(l, fn) do				\
	{ 						\
	  Display *olddisplay = display;		\
	  Canvas *cv;				\
	  for (display = displays; display; display = display->d_next) \
	    {						\
	      for (cv = D_cvlist; cv; cv = cv->c_next)	\
		if (cv->c_layer == l)			\
		  break;				\
	      if (cv == NULL)				\
		continue;				\
	      fn;					\
	    }						\
	  display = olddisplay;				\
	} while(0)


/**
 * (Un)Pauses a layer.
 *
 * @param layer The layer that should be (un)paused.
 * @param pause Should we pause the layer?
 */
void LayPause (Layer *layer, bool pause);

/**
 * Update the region to refresh after a layer is unpaused.
 *
 * @param layer The layer.
 * @param xs	The left-end of the region.
 * @param xe	The right-end of the region.
 * @param ys	The top-end of the region.
 * @param ye	The bottom-end of the region.
 */
void LayPauseUpdateRegion (Layer *layer, int xs, int xe, int ys, int ye);

/**
 * Free any internal memory for the layer.
 *
 * @param layer The layer.
 */
void LayerCleanupMemory (Layer *layer);

void  LGotoPos (Layer *, int, int);
void  LPutChar (Layer *, struct mchar *, int, int);
void  LInsChar (Layer *, struct mchar *, int, int, struct mline *);
void  LPutStr (Layer *, char *, int, struct mchar *, int, int);
void  LPutWinMsg (Layer *, char *, int, struct mchar *, int, int);
void  LScrollH (Layer *, int, int, int, int, int, struct mline *);
void  LScrollV (Layer *, int, int, int, int);
void  LClearAll (Layer *, int);
void  LClearArea (Layer *, int, int, int, int, int, int);
void  LClearLine (Layer *, int, int, int, int, struct mline *);
void  LRefreshAll (Layer *, int);
void  LCDisplayLine (Layer *, struct mline *, int, int, int, int);
void  LCDisplayLineWrap (Layer *, struct mline *, int, int, int, int);
void  LSetRendition (Layer *, struct mchar *);
void  LWrapChar  (Layer *, struct mchar *, int, int, int, bool);
void  LCursorVisibility (Layer *, int);
void  LSetFlow (Layer *, bool);
void  LKeypadMode (Layer *, int);
void  LCursorkeysMode (Layer *, int);
void  LMouseMode (Layer *, int);
void  LExtMouseMode (Layer *, int);
void  LBracketedPasteMode (Layer *, bool);
void  LCursorStyle (Layer *, int);
void  LMsg (int, const char *, ...) __attribute__((format(printf, 2, 3)));
void  KillLayerChain (Layer *);
int   InitOverlayPage (int, const struct LayFuncs *, int);
void  ExitOverlayPage (void);
int   LayProcessMouse (Layer *, unsigned char);
void  LayProcessMouseSwitch (Layer *, bool);

#endif /* SCREEN_LAYER_H */