Krolyxon
Commit f288efc

Branches

Refs →

nsxivnsxiv.h

457 lines · 8.0 KB · Objective-C

1/* Copyright 2011-2020 Bert Muennich
2 * Copyright 2021-2023 nsxiv contributors
3 *
4 * This file is a part of nsxiv.
5 *
6 * nsxiv is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published
8 * by the Free Software Foundation; either version 2 of the License,
9 * or (at your option) any later version.
10 *
11 * nsxiv is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
15 *
16 * You should have received a copy of the GNU General Public License
17 * along with nsxiv. If not, see <http://www.gnu.org/licenses/>.
18 */
19
20#ifndef NSXIV_H
21#define NSXIV_H
22
23#include <stdbool.h>
24#include <stddef.h>
25
26#include <Imlib2.h>
27#include <X11/Xlib.h>
28
29/*
30 * Annotation for functions called in cleanup().
31 * These functions are not allowed to call error(!0, ...) or exit().
32 */
33#define CLEANUP
34
35#define MIN(a,b) ((a) < (b) ? (a) : (b))
36#define MAX(a,b) ((a) > (b) ? (a) : (b))
37#define ABS(a) ((a) > 0 ? (a) : -(a))
38
39#define ARRLEN(a) (sizeof(a) / sizeof((a)[0]))
40#define STREQ(s1,s2) (strcmp((s1), (s2)) == 0)
41
42typedef enum {
43 MODE_ALL,
44 MODE_IMAGE,
45 MODE_THUMB
46} appmode_t;
47
48typedef enum {
49 DIR_LEFT = 1,
50 DIR_RIGHT = 2,
51 DIR_UP = 4,
52 DIR_DOWN = 8
53} direction_t;
54
55typedef enum {
56 DEGREE_90 = 1,
57 DEGREE_180 = 2,
58 DEGREE_270 = 3
59} degree_t;
60
61typedef enum {
62 FLIP_HORIZONTAL = 1,
63 FLIP_VERTICAL = 2
64} flipdir_t;
65
66typedef enum {
67 SCALE_DOWN,
68 SCALE_FIT,
69 SCALE_FILL,
70 SCALE_WIDTH,
71 SCALE_HEIGHT,
72 SCALE_ZOOM
73} scalemode_t;
74
75typedef enum {
76 DRAG_RELATIVE,
77 DRAG_ABSOLUTE
78} dragmode_t;
79
80typedef enum {
81 CURSOR_ARROW,
82 CURSOR_DRAG_ABSOLUTE,
83 CURSOR_DRAG_RELATIVE,
84 CURSOR_WATCH,
85 CURSOR_LEFT,
86 CURSOR_RIGHT,
87 CURSOR_NONE,
88
89 CURSOR_COUNT
90} cursor_t;
91
92typedef enum {
93 FF_WARN = 1,
94 FF_MARK = 2,
95 FF_TN_INIT = 4
96} fileflags_t;
97
98typedef struct {
99 const char *name; /* as given by user */
100 const char *path; /* always absolute */
101 fileflags_t flags;
102} fileinfo_t;
103
104/* timeouts in milliseconds: */
105enum {
106 TO_REDRAW_RESIZE = 75,
107 TO_REDRAW_THUMBS = 200,
108 TO_CURSOR_HIDE = 1200,
109 TO_DOUBLE_CLICK = 300
110};
111
112typedef void (*timeout_f)(void);
113
114typedef struct arl arl_t;
115typedef struct img img_t;
116typedef struct opt opt_t;
117typedef struct tns tns_t;
118typedef struct win win_t;
119
120
121/* autoreload.c */
122
123struct arl {
124 int fd;
125 int wd_dir;
126 int wd_file;
127 const char *filename;
128};
129
130void arl_init(arl_t*);
131void arl_cleanup(arl_t*);
132void arl_add(arl_t*, const char* /* result of realpath(3) */);
133bool arl_handle(arl_t*);
134
135
136/* commands.c */
137
138typedef int arg_t;
139typedef bool (*cmd_f)(arg_t);
140
141typedef struct {
142 cmd_f func;
143 appmode_t mode;
144} cmd_t;
145
146typedef struct {
147 unsigned int mask;
148 KeySym ksym_or_button;
149 cmd_t cmd;
150 arg_t arg;
151} keymap_t;
152
153typedef keymap_t button_t;
154
155
156/* image.c */
157
158typedef struct {
159 Imlib_Image im;
160 unsigned int delay;
161} img_frame_t;
162
163typedef struct {
164 img_frame_t *frames;
165 unsigned int cap;
166 unsigned int cnt;
167 unsigned int sel;
168 bool animate;
169 unsigned int framedelay;
170 int length;
171} multi_img_t;
172
173struct img {
174 Imlib_Image im;
175 int w;
176 int h;
177
178 win_t *win;
179 float x;
180 float y;
181
182 Imlib_Color_Modifier cmod;
183 int gamma;
184 int brightness;
185 int contrast;
186
187 scalemode_t scalemode;
188 float zoom;
189
190 bool checkpan;
191 bool dirty;
192 bool anti_alias;
193 bool alpha_layer;
194
195 struct {
196 bool on;
197 int delay;
198 } ss;
199
200 multi_img_t multi;
201};
202
203void img_init(img_t*, win_t*);
204bool img_load(img_t*, const fileinfo_t*);
205CLEANUP void img_close(img_t*, bool);
206void img_render(img_t*);
207bool img_fit_win(img_t*, scalemode_t);
208bool img_zoom(img_t*, int);
209bool img_zoom_to(img_t*, float);
210bool img_pos(img_t*, float, float);
211bool img_pan(img_t*, direction_t, int);
212bool img_pan_center(img_t*);
213bool img_pan_edge(img_t*, direction_t);
214void img_rotate(img_t*, degree_t);
215void img_flip(img_t*, flipdir_t);
216void img_toggle_antialias(img_t*);
217void img_update_color_modifiers(img_t*);
218bool img_change_color_modifier(img_t*, int, int*);
219bool img_frame_navigate(img_t*, int);
220bool img_frame_animate(img_t*);
221Imlib_Image img_open(const fileinfo_t*);
222#if HAVE_LIBEXIF
223void exif_auto_orientate(const fileinfo_t*);
224#endif
225
226
227/* options.c */
228
229struct opt {
230 /* file list: */
231 char **filenames;
232 bool from_stdin;
233 bool to_stdout;
234 bool using_null;
235 bool recursive;
236 int filecnt;
237 int startnum;
238
239 /* image: */
240 scalemode_t scalemode;
241 float zoom;
242 bool animate;
243 bool anti_alias;
244 bool alpha_layer;
245 int gamma;
246 unsigned int slideshow;
247 int framerate;
248
249 /* window: */
250 bool fullscreen;
251 bool hide_bar;
252 Window embed; /* unsigned long */
253 char *geometry;
254 char *res_name;
255
256 /* misc flags: */
257 bool quiet;
258 bool thumb_mode;
259 bool clean_cache;
260 bool private_mode;
261};
262
263extern const opt_t *options;
264
265void print_usage(void);
266void parse_options(int, char**);
267
268
269/* thumbs.c */
270
271typedef struct {
272 Imlib_Image im;
273 int w;
274 int h;
275 int x;
276 int y;
277} thumb_t;
278
279struct tns {
280 fileinfo_t *files;
281 thumb_t *thumbs;
282 const int *cnt;
283 int *sel;
284 int initnext;
285 int loadnext;
286 int first, end;
287 int r_first, r_end;
288
289 win_t *win;
290 int x;
291 int y;
292 int cols;
293 int rows;
294 int zl;
295 int bw;
296 int dim;
297
298 bool dirty;
299};
300
301void tns_clean_cache(void);
302void tns_init(tns_t*, fileinfo_t*, const int*, int*, win_t*);
303CLEANUP void tns_free(tns_t*);
304bool tns_load(tns_t*, int, bool, bool);
305void tns_unload(tns_t*, int);
306void tns_render(tns_t*);
307void tns_mark(tns_t*, int, bool);
308void tns_highlight(tns_t*, int, bool);
309bool tns_move_selection(tns_t*, direction_t, int);
310bool tns_scroll(tns_t*, direction_t, bool);
311bool tns_zoom(tns_t*, int);
312int tns_translate(tns_t*, int, int);
313
314
315/* util.c */
316
317#include <dirent.h>
318
319typedef struct {
320 DIR *dir;
321 char *name;
322 int d;
323 bool recursive;
324
325 char **stack;
326 int stcap;
327 int stlen;
328} r_dir_t;
329
330extern const char *progname;
331
332void* emalloc(size_t);
333void* ecalloc(size_t, size_t);
334void* erealloc(void*, size_t);
335char* estrdup(const char*);
336void error(int, int, const char*, ...);
337int r_opendir(r_dir_t*, const char*, bool);
338int r_closedir(r_dir_t*);
339char* r_readdir(r_dir_t*, bool);
340int r_mkdir(char*);
341void construct_argv(char**, unsigned int, ...);
342pid_t spawn(int*, int*, char *const []);
343
344
345/* window.c */
346
347#include <X11/Xutil.h>
348#if HAVE_LIBFONTS
349#include <X11/Xft/Xft.h>
350#endif
351
352enum {
353 ATOM_WM_DELETE_WINDOW,
354 ATOM__NET_WM_NAME,
355 ATOM__NET_WM_ICON_NAME,
356 ATOM__NET_WM_ICON,
357 ATOM__NET_WM_STATE,
358 ATOM__NET_WM_PID,
359 ATOM__NET_WM_STATE_FULLSCREEN,
360 ATOM_UTF8_STRING,
361 ATOM_WM_NAME,
362 ATOM_WM_ICON_NAME,
363 ATOM_COUNT
364};
365
366typedef struct {
367 Display *dpy;
368 int scr;
369 int scrw, scrh;
370 Visual *vis;
371 Colormap cmap;
372 int depth;
373} win_env_t;
374
375typedef struct {
376 size_t size;
377 char *p;
378 char *buf;
379} win_bar_t;
380
381struct win {
382 Window xwin;
383 win_env_t env;
384
385 XColor win_bg;
386 XColor win_fg;
387 XColor mrk_fg;
388#if HAVE_LIBFONTS
389 XftColor bar_bg;
390 XftColor bar_fg;
391#endif
392
393 int x;
394 int y;
395 unsigned int w;
396 unsigned int h; /* = win height - bar height */
397 unsigned int bw;
398
399 struct {
400 unsigned int w;
401 unsigned int h;
402 Pixmap pm;
403 } buf;
404
405 struct {
406 unsigned int h;
407 bool top;
408 win_bar_t l;
409 win_bar_t r;
410 } bar;
411};
412
413extern Atom atoms[ATOM_COUNT];
414
415void win_init(win_t*);
416void win_open(win_t*);
417CLEANUP void win_close(win_t*);
418bool win_configure(win_t*, XConfigureEvent*);
419void win_toggle_fullscreen(win_t*);
420void win_toggle_bar(win_t*);
421void win_clear(win_t*);
422void win_draw(win_t*);
423void win_draw_rect(win_t*, int, int, int, int, bool, int, unsigned long);
424void win_set_title(win_t*, const char*, size_t);
425void win_set_cursor(win_t*, cursor_t);
426void win_cursor_pos(win_t*, int*, int*);
427
428/* main.c */
429
430/* timeout handler functions: */
431void redraw(void);
432void reset_cursor(void);
433void animate(void);
434void slideshow(void);
435void clear_resize(void);
436
437void remove_file(int, bool);
438void set_timeout(timeout_f, int, bool);
439void reset_timeout(timeout_f);
440void close_info(void);
441void open_info(void);
442void load_image(int);
443bool mark_image(int, bool);
444int nav_button(void);
445void handle_key_handler(bool);
446
447extern appmode_t mode;
448extern const XButtonEvent *xbutton_ev;
449extern fileinfo_t *files;
450extern int filecnt, fileidx;
451extern int alternate;
452extern int markcnt;
453extern int markidx;
454extern int prefix;
455extern bool title_dirty;
456
457#endif /* NSXIV_H */