Krolyxon
Commit becf1cc

Branches

Refs →

nsxivnsxiv.h

463 lines · 8.0 KB · Objective-C

1/* Copyright 2011-2020 Bert Muennich
2 * Copyright 2021-2022 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
185 scalemode_t scalemode;
186 float zoom;
187
188 bool checkpan;
189 bool dirty;
190 bool aa;
191 bool alpha;
192
193 struct {
194 bool on;
195 int delay;
196 } ss;
197
198 multi_img_t multi;
199};
200
201void img_init(img_t*, win_t*);
202bool img_load(img_t*, const fileinfo_t*);
203CLEANUP void img_close(img_t*, bool);
204void img_render(img_t*);
205bool img_fit_win(img_t*, scalemode_t);
206bool img_zoom(img_t*, int);
207bool img_zoom_to(img_t*, float);
208bool img_pos(img_t*, float, float);
209bool img_pan(img_t*, direction_t, int);
210bool img_pan_center(img_t*);
211bool img_pan_edge(img_t*, direction_t);
212void img_rotate(img_t*, degree_t);
213void img_flip(img_t*, flipdir_t);
214void img_toggle_antialias(img_t*);
215bool img_change_gamma(img_t*, int);
216bool img_frame_navigate(img_t*, int);
217bool img_frame_animate(img_t*);
218Imlib_Image img_open(const fileinfo_t*);
219#if HAVE_LIBEXIF
220void exif_auto_orientate(const fileinfo_t*);
221#endif
222
223
224/* options.c */
225
226struct opt {
227 /* file list: */
228 char **filenames;
229 bool from_stdin;
230 bool to_stdout;
231 bool using_null;
232 bool recursive;
233 int filecnt;
234 int startnum;
235
236 /* image: */
237 scalemode_t scalemode;
238 float zoom;
239 bool animate;
240 int gamma;
241 int slideshow;
242 int framerate;
243
244 /* window: */
245 bool fullscreen;
246 bool hide_bar;
247 Window embed; /* unsigned long */
248 char *geometry;
249 char *res_name;
250
251 /* misc flags: */
252 bool quiet;
253 bool thumb_mode;
254 bool clean_cache;
255 bool private_mode;
256};
257
258extern const opt_t *options;
259
260void print_usage(void);
261void parse_options(int, char**);
262
263
264/* thumbs.c */
265
266typedef struct {
267 Imlib_Image im;
268 int w;
269 int h;
270 int x;
271 int y;
272} thumb_t;
273
274struct tns {
275 fileinfo_t *files;
276 thumb_t *thumbs;
277 const int *cnt;
278 int *sel;
279 int initnext;
280 int loadnext;
281 int first, end;
282 int r_first, r_end;
283
284 win_t *win;
285 int x;
286 int y;
287 int cols;
288 int rows;
289 int zl;
290 int bw;
291 int dim;
292
293 bool dirty;
294};
295
296void tns_clean_cache(void);
297void tns_init(tns_t*, fileinfo_t*, const int*, int*, win_t*);
298CLEANUP void tns_free(tns_t*);
299bool tns_load(tns_t*, int, bool, bool);
300void tns_unload(tns_t*, int);
301void tns_render(tns_t*);
302void tns_mark(tns_t*, int, bool);
303void tns_highlight(tns_t*, int, bool);
304bool tns_move_selection(tns_t*, direction_t, int);
305bool tns_scroll(tns_t*, direction_t, bool);
306bool tns_zoom(tns_t*, int);
307int tns_translate(tns_t*, int, int);
308
309
310/* util.c */
311
312#include <dirent.h>
313
314typedef struct {
315 DIR *dir;
316 char *name;
317 int d;
318 bool recursive;
319
320 char **stack;
321 int stcap;
322 int stlen;
323} r_dir_t;
324
325typedef struct {
326 int readfd;
327 int writefd;
328 pid_t pid;
329} spawn_t;
330
331enum {
332 X_READ = (1 << 0),
333 X_WRITE = (1 << 1)
334};
335
336extern const char *progname;
337
338void* emalloc(size_t);
339void* ecalloc(size_t, size_t);
340void* erealloc(void*, size_t);
341char* estrdup(const char*);
342void error(int, int, const char*, ...);
343int r_opendir(r_dir_t*, const char*, bool);
344int r_closedir(r_dir_t*);
345char* r_readdir(r_dir_t*, bool);
346int r_mkdir(char*);
347void construct_argv(char**, unsigned int, ...);
348spawn_t spawn(const char*, char *const [], unsigned int);
349
350
351/* window.c */
352
353#include <X11/Xutil.h>
354#if HAVE_LIBFONTS
355#include <X11/Xft/Xft.h>
356#endif
357
358enum {
359 ATOM_WM_DELETE_WINDOW,
360 ATOM__NET_WM_NAME,
361 ATOM__NET_WM_ICON_NAME,
362 ATOM__NET_WM_ICON,
363 ATOM__NET_WM_STATE,
364 ATOM__NET_WM_PID,
365 ATOM__NET_WM_STATE_FULLSCREEN,
366 ATOM_UTF8_STRING,
367 ATOM_WM_NAME,
368 ATOM_WM_ICON_NAME,
369 ATOM_COUNT
370};
371
372typedef struct {
373 Display *dpy;
374 int scr;
375 int scrw, scrh;
376 Visual *vis;
377 Colormap cmap;
378 int depth;
379} win_env_t;
380
381typedef struct {
382 size_t size;
383 char *p;
384 char *buf;
385} win_bar_t;
386
387struct win {
388 Window xwin;
389 win_env_t env;
390
391 XColor win_bg;
392 XColor win_fg;
393 XColor mrk_fg;
394#if HAVE_LIBFONTS
395 XftColor bar_bg;
396 XftColor bar_fg;
397#endif
398
399 int x;
400 int y;
401 unsigned int w;
402 unsigned int h; /* = win height - bar height */
403 unsigned int bw;
404
405 struct {
406 unsigned int w;
407 unsigned int h;
408 Pixmap pm;
409 } buf;
410
411 struct {
412 unsigned int h;
413 bool top;
414 win_bar_t l;
415 win_bar_t r;
416 } bar;
417};
418
419extern Atom atoms[ATOM_COUNT];
420
421void win_init(win_t*);
422void win_open(win_t*);
423CLEANUP void win_close(win_t*);
424bool win_configure(win_t*, XConfigureEvent*);
425void win_toggle_fullscreen(win_t*);
426void win_toggle_bar(win_t*);
427void win_clear(win_t*);
428void win_draw(win_t*);
429void win_draw_rect(win_t*, int, int, int, int, bool, int, unsigned long);
430void win_set_title(win_t*, const char*, size_t);
431void win_set_cursor(win_t*, cursor_t);
432void win_cursor_pos(win_t*, int*, int*);
433
434/* main.c */
435
436/* timeout handler functions: */
437void redraw(void);
438void reset_cursor(void);
439void animate(void);
440void slideshow(void);
441void clear_resize(void);
442
443void remove_file(int, bool);
444void set_timeout(timeout_f, int, bool);
445void reset_timeout(timeout_f);
446void close_info(void);
447void open_info(void);
448void load_image(int);
449bool mark_image(int, bool);
450int nav_button(void);
451void handle_key_handler(bool);
452
453extern appmode_t mode;
454extern const XButtonEvent *xbutton_ev;
455extern fileinfo_t *files;
456extern int filecnt, fileidx;
457extern int alternate;
458extern int markcnt;
459extern int markidx;
460extern int prefix;
461extern bool title_dirty;
462
463#endif /* NSXIV_H */