beautifying README
[smdp.git] / include / viewer.h
1 #if !defined( VIEWER_H )
2 #define VIEWER_H
3
4 /*
5  * Functions necessary to display a deck of slides in different color modes
6  * using ncurses. Only white, red, and blue are supported, as they can be
7  * faded in 256 color mode.
8  * Copyright (C) 2014 Michael Goehler
9  *
10  * This file is part of mdp.
11  *
12  * This program is free software: you can redistribute it and/or modify
13  * it under the terms of the GNU General Public License as published by
14  * the Free Software Foundation, either version 3 of the License, or
15  * (at your option) any later version.
16  *
17  * This program is distributed in the hope that it will be useful,
18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20  * GNU General Public License for more details.
21  *
22  * You should have received a copy of the GNU General Public License
23  * along with this program. If not, see <http://www.gnu.org/licenses/>.
24  *
25  *
26  * function: ncurses_display initializes ncurses, defines colors, calculates
27  *           window geometry and handles key strokes
28  * function: add_line detects inline markdown formating and prints line char
29  *           by char
30  * function: fade_in, fade_out implementing color fading in 256 color mode
31  * function: int_length to calculate decimal length of slide count
32  *
33  */
34
35 #if defined( WIN32 )
36 #include <curses.h>
37 #else
38 #include <ncurses.h>
39 #endif
40
41 #include "common.h"
42 #include "parser.h"
43 #include "cstack.h"
44
45 #define CP_WHITE  1 // 255
46 #define CP_BLUE   2 // 123
47 #define CP_RED    3 // 213
48 #define CP_YELLOW 4 // 208
49 #define CP_BLACK  5 // CP_WHITE with foreground and background swapped
50
51 #define FADE_DELAY 15000 // micro seconds
52
53 int ncurses_display(deck_t *deck, int notrans, int nofade, int invert);
54 void add_line(WINDOW *window, int y, int x, line_t *line, int max_cols, int colors);
55 void inline_display(WINDOW *window, const char *c, const int colors);
56 void fade_out(WINDOW *window, int trans, int colors, int invert);
57 void fade_in(WINDOW *window, int trans, int colors, int invert);
58 int int_length (int val);
59
60 #endif // !defined( VIEWER_H )