make alignment respect pandoc urls, #63
[smdp.git] / src / viewer.c
1 /*
2  * Functions necessary to display a deck of slides in different color modes
3  * using ncurses. Only white, red, and blue are supported, as they can be
4  * faded in 256 color mode.
5  * Copyright (C) 2014 Michael Goehler
6  *
7  * This file is part of mdp.
8  *
9  * This program is free software: you can redistribute it and/or modify
10  * it under the terms of the GNU General Public License as published by
11  * the Free Software Foundation, either version 3 of the License, or
12  * (at your option) any later version.
13  *
14  * This program is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17  * GNU General Public License for more details.
18  *
19  * You should have received a copy of the GNU General Public License
20  * along with this program. If not, see <http://www.gnu.org/licenses/>.
21  *
22  */
23
24 #include <ctype.h>  // isalnum
25 #include <locale.h> // setlocale
26 #include <string.h> // strchr
27 #include <unistd.h> // usleep
28
29 #include "viewer.h"
30
31 // color ramp for fading from black to color
32 static short white_ramp[24] = { 16, 232, 233, 234, 235, 236,
33                                237, 238, 239, 240, 241, 242,
34                                244, 245, 246, 247, 248, 249,
35                                250, 251, 252, 253, 254, 255 };
36
37 static short blue_ramp[24]  = { 16,  17,  17,  18,  18,  19,
38                                 19,  20,  20,  21,  27,  33,
39                                 32,  39,  38,  45,  44,  44,
40                                 81,  81,  51,  51, 123, 123 };
41
42 static short red_ramp[24]   = { 16,  52,  52,  53,  53,  89,
43                                 89,  90,  90, 126, 127, 127,
44                                163, 163, 164, 164, 200, 200,
45                                201, 201, 207, 207, 213, 213 };
46
47 // color ramp for fading from white to color
48 static short white_ramp_invert[24] = { 15, 255, 254, 254, 252, 251,
49                                       250, 249, 248, 247, 246, 245,
50                                       243, 242, 241, 240, 239, 238,
51                                       237, 236, 235, 234, 233, 232};
52
53 static short blue_ramp_invert[24]  = { 15, 231, 231, 195, 195, 159,
54                                       159, 123, 123,  87,  51,  44,
55                                        45,  38,  39,  32,  33,  33,
56                                        26,  26,  27,  27,  21,  21};
57
58 static short red_ramp_invert[24]   = { 15, 231, 231, 224, 224, 225,
59                                       225, 218, 218, 219, 212, 213,
60                                       206, 207, 201, 200, 199, 199,
61                                       198, 198, 197, 197, 196, 196};
62
63 int ncurses_display(deck_t *deck, int notrans, int nofade, int invert) {
64
65     int c = 0;          // char
66     int i = 0;          // iterate
67     int l = 0;          // line number
68     int lc = 0;         // line count
69     int sc = 1;         // slide count
70     int colors = 0;     // amount of colors supported
71     int fade = 0;       // disable color fading by default
72     int trans = -1;     // enable transparency if term supports it
73     int max_lines = 0;  // max lines per slide
74     int max_cols = 0;   // max columns per line
75     int offset;         // text offset
76
77     // header line 1 is displayed at the top
78     int bar_top = (deck->headers > 0) ? 1 : 0;
79     // header line 2 is displayed at the bottom
80     // anyway we display the slide number at the bottom
81     int bar_bottom = 1;
82
83     slide_t *slide = deck->slide;
84     line_t *line;
85
86     // set locale to display UTF-8 correctly in ncurses
87     setlocale(LC_CTYPE, "");
88
89     // init ncurses
90     initscr();
91
92     while(slide) {
93         lc = 0;
94         line = slide->line;
95
96         while(line) {
97
98             if (line && line->text && line->text->text)
99                 lc += url_count_inline(line->text->text);
100
101             if (line && line->text && line->text->text)
102                 line->length -= url_len_inline(line->text->text);
103
104             if(line->length > COLS) {
105                 i = line->length;
106                 offset = 0;
107                 while(i > COLS) {
108
109                     i = prev_blank(line->text, offset + COLS) - offset;
110
111                     // single word is > COLS
112                     if(!i) {
113                         // calculate min_width
114                         i = next_blank(line->text, offset + COLS) - offset;
115
116                         // disable ncurses
117                         endwin();
118
119                         // print error
120                         fprintf(stderr, "Error: Terminal width (%i columns) too small. Need at least %i columns.\n", COLS, i);
121                         fprintf(stderr, "You may need to shorten some lines by inserting line breaks.\n");
122
123                         return 1;
124                     }
125
126                     // set max_cols
127                     max_cols = MAX(i, max_cols);
128
129                     // iterate to next line
130                     offset = prev_blank(line->text, offset + COLS);
131                     i = line->length - offset;
132                     lc++;
133                 }
134                 // set max_cols one last time
135                 max_cols = MAX(i, max_cols);
136             } else {
137                 // set max_cols
138                 max_cols = MAX(line->length, max_cols);
139             }
140             lc++;
141             line = line->next;
142         }
143
144         max_lines = MAX(lc, max_lines);
145
146         slide = slide->next;
147     }
148
149     // not enough lines
150     if(max_lines + bar_top + bar_bottom > LINES) {
151
152         // disable ncurses
153         endwin();
154
155         // print error
156         fprintf(stderr, "Error: Terminal height (%i lines) too small. Need at least %i lines.\n", LINES, max_lines + bar_top + bar_bottom);
157         fprintf(stderr, "You may need to add additional horizontal rules ('***') to split your file in shorter slides.\n");
158
159         return 1;
160     }
161
162     // disable cursor
163     curs_set(0);
164
165     // disable output of keyboard typing
166     noecho();
167
168     // make getch() process one char at a time
169     cbreak();
170
171     // enable arrow keys
172     keypad(stdscr,TRUE);
173
174     // set colors
175     if(has_colors() == TRUE) {
176         start_color();
177         use_default_colors();
178
179         // 256 color mode
180         if(COLORS == 256) {
181
182             if(notrans) {
183                 if(invert) {
184                     trans = 15; // white in 256 color mode
185                 } else {
186                     trans = 16; // black in 256 color mode
187                 }
188             }
189
190             if(invert) {
191                 init_pair(CP_WHITE, 232, trans);
192                 init_pair(CP_BLUE, 21, trans);
193                 init_pair(CP_RED, 196, trans);
194                 init_pair(CP_BLACK, 15, 232);
195             } else {
196                 init_pair(CP_WHITE, 255, trans);
197                 init_pair(CP_BLUE, 123, trans);
198                 init_pair(CP_RED, 213, trans);
199                 init_pair(CP_BLACK, 16, 255);
200             }
201             init_pair(CP_YELLOW, 208, trans);
202
203             // enable color fading
204             if(!nofade)
205                 fade = true;
206
207         // 8 color mode
208         } else {
209
210             if(notrans) {
211                 if(invert) {
212                     trans = 7; // white in 8 color mode
213                 } else {
214                     trans = 0; // black in 8 color mode
215                 }
216             }
217
218             if(invert) {
219                 init_pair(CP_WHITE, 0, trans);
220                 init_pair(CP_BLACK, 7, 0);
221             } else {
222                 init_pair(CP_WHITE, 7, trans);
223                 init_pair(CP_BLACK, 0, 7);
224             }
225             init_pair(CP_BLUE, 4, trans);
226             init_pair(CP_RED, 1, trans);
227             init_pair(CP_YELLOW, 3, trans);
228         }
229
230         colors = 1;
231     }
232
233     // set background color of main window
234     if(colors)
235         wbkgd(stdscr, COLOR_PAIR(CP_YELLOW));
236
237     // setup main window
238     WINDOW *content = newwin(LINES - bar_top - bar_bottom, COLS, 0 + bar_top, 0);
239     if(colors)
240         wbkgd(content, COLOR_PAIR(CP_WHITE));
241
242     slide = deck->slide;
243     while(slide) {
244
245         url_init();
246
247         // clear windows
248         werase(content);
249         werase(stdscr);
250
251         // always resize window in case terminal geometry has changed
252         wresize(content, LINES - bar_top - bar_bottom, COLS);
253
254         // setup header
255         if(bar_top) {
256             line = deck->header;
257             offset = next_blank(line->text, 0) + 1;
258             // add text to header
259             mvwprintw(stdscr,
260                       0, (COLS - line->length + offset) / 2,
261                       "%s", &line->text->text[offset]);
262         }
263
264         // setup footer
265         if(deck->headers > 1) {
266             line = deck->header->next;
267             offset = next_blank(line->text, 0) + 1;
268             // add text to left footer
269             mvwprintw(stdscr,
270                       LINES - 1, 3,
271                       "%s", &line->text->text[offset]);
272         }
273         // add slide number to right footer
274         mvwprintw(stdscr,
275                   LINES - 1, COLS - int_length(deck->slides) - int_length(sc) - 6,
276                   "%d / %d", sc, deck->slides);
277
278         // make header + fooder visible
279         wrefresh(content);
280         wrefresh(stdscr);
281
282         line = slide->line;
283         l = 0;
284
285         // print lines
286         while(line) {
287             add_line(content, l, (COLS - max_cols) / 2, line, max_cols, colors);
288             l += (line->length / COLS) + 1;
289             line = line->next;
290         }
291
292         int i, ymax;
293         getmaxyx( content, ymax, i );
294         for (i = 0; i < url_get_amount(); i++) {
295             mvwprintw(content, ymax - url_get_amount() - 1 + i, 3,
296                       "[%d] %s", i, url_get_target(i));
297         }
298
299         // make content visible
300         wrefresh(content);
301
302         // fade in
303         if(fade)
304             fade_in(content, trans, colors, invert);
305
306         // re-enable fading after any undefined key press
307         if(COLORS == 256 && !nofade)
308             fade = true;
309
310         // wait for user input
311         c = getch();
312
313         // evaluate user input
314         i = 0;
315         switch(c) {
316
317             // show previous slide
318             case KEY_UP:
319             case KEY_LEFT:
320             case KEY_PPAGE:
321             case 8:   // BACKSPACE (ascii)
322             case 127: // BACKSPACE (xterm)
323             case 263: // BACKSPACE (getty)
324             case 'h':
325             case 'k':
326                 if(slide->prev) {
327                     slide = slide->prev;
328                     sc--;
329                 } else {
330                     fade = false;
331                 }
332                 break;
333
334             // show next slide
335             case KEY_DOWN:
336             case KEY_RIGHT:
337             case KEY_NPAGE:
338             case '\n': // ENTER
339             case ' ':  // SPACE
340             case 'j':
341             case 'l':
342                 if(slide->next) {
343                     slide = slide->next;
344                     sc++;
345                 } else {
346                     fade = false;
347                 }
348                 break;
349
350             // show slide n
351             case '9': i++;
352             case '8': i++;
353             case '7': i++;
354             case '6': i++;
355             case '5': i++;
356             case '4': i++;
357             case '3': i++;
358             case '2': i++;
359             case '1': i++;
360                 if(i <= deck->slides) {
361                     while(sc != i) {
362                         // search forward
363                         if(sc < i) {
364                             if(slide->next) {
365                                 slide = slide->next;
366                                 sc++;
367                             }
368                         // search backward
369                         } else {
370                             if(slide->prev) {
371                                 slide = slide->prev;
372                                 sc--;
373                             }
374                         }
375                     }
376                 } else {
377                     // disable fading if slide n doesn't exist
378                     fade = false;
379                 }
380                 break;
381
382             // show first slide
383             case KEY_HOME:
384                 slide = deck->slide;
385                 sc = 1;
386                 break;
387
388             // show last slide
389             case KEY_END:
390                 for(i = sc; i <= deck->slides; i++) {
391                     if(slide->next) {
392                             slide = slide->next;
393                             sc++;
394                     }
395                 }
396                 break;
397
398             // quit
399             case 'q':
400                 // do not fade out on exit
401                 fade = false;
402                 slide = NULL;
403                 break;
404
405             default:
406                 // disable fading on undefined key press
407                 fade = false;
408                 break;
409         }
410
411         // fade out
412         if(fade)
413             fade_out(content, trans, colors, invert);
414
415         url_purge();
416     }
417
418     endwin();
419
420     return 0;
421 }
422
423 void add_line(WINDOW *window, int y, int x, line_t *line, int max_cols, int colors) {
424
425     if(!line->text->text) {
426         return;
427     }
428
429     int i; // increment
430     int offset = 0; // text offset
431
432     // move the cursor in position
433     wmove(window, y, x);
434
435     // IS_UNORDERED_LIST_3
436     if(CHECK_BIT(line->bits, IS_UNORDERED_LIST_3)) {
437         offset = next_nonblank(line->text, 0);
438         char prompt[13];
439         strcpy(&prompt[0], CHECK_BIT(line->bits, IS_UNORDERED_LIST_1)? " |  " : "    ");
440         strcpy(&prompt[4], CHECK_BIT(line->bits, IS_UNORDERED_LIST_2)? " |  " : "    ");
441
442         if(CHECK_BIT(line->bits, IS_UNORDERED_LIST_EXT)) {
443             strcpy(&prompt[8], line->next && CHECK_BIT(line->next->bits, IS_UNORDERED_LIST_3)? " |  " : "    ");
444         } else {
445             strcpy(&prompt[8], " +- ");
446             offset += 2;
447         }
448
449         wprintw(window,
450                 "%s", prompt);
451
452         if(!CHECK_BIT(line->bits, IS_CODE))
453             inline_display(window, &line->text->text[offset], colors);
454
455     // IS_UNORDERED_LIST_2
456     } else if(CHECK_BIT(line->bits, IS_UNORDERED_LIST_2)) {
457         offset = next_nonblank(line->text, 0);
458         char prompt[9];
459         strcpy(&prompt[0], CHECK_BIT(line->bits, IS_UNORDERED_LIST_1)? " |  " : "    ");
460
461         if(CHECK_BIT(line->bits, IS_UNORDERED_LIST_EXT)) {
462             strcpy(&prompt[4], line->next && CHECK_BIT(line->next->bits, IS_UNORDERED_LIST_2)? " |  " : "    ");
463         } else {
464             strcpy(&prompt[4], " +- ");
465             offset += 2;
466         }
467
468         wprintw(window,
469                 "%s", prompt);
470
471         if(!CHECK_BIT(line->bits, IS_CODE))
472             inline_display(window, &line->text->text[offset], colors);
473
474     // IS_UNORDERED_LIST_1
475     } else if(CHECK_BIT(line->bits, IS_UNORDERED_LIST_1)) {
476         offset = next_nonblank(line->text, 0);
477         char prompt[5];
478
479         if(CHECK_BIT(line->bits, IS_UNORDERED_LIST_EXT)) {
480             strcpy(&prompt[0], line->next && CHECK_BIT(line->next->bits, IS_UNORDERED_LIST_1)? " |  " : "    ");
481         } else {
482             strcpy(&prompt[0], " +- ");
483             offset += 2;
484         }
485
486         wprintw(window,
487                 "%s", prompt);
488
489         if(!CHECK_BIT(line->bits, IS_CODE))
490             inline_display(window, &line->text->text[offset], colors);
491     }
492
493     // IS_CODE
494     if(CHECK_BIT(line->bits, IS_CODE)) {
495
496         // set static offset for code
497         offset = CODE_INDENT;
498
499         // reverse color for code blocks
500         if(colors)
501             wattron(window, COLOR_PAIR(CP_BLACK));
502
503         // print whole lines
504         wprintw(window,
505                 "%s", &line->text->text[offset]);
506     }
507
508     if(!CHECK_BIT(line->bits, IS_UNORDERED_LIST_1) &&
509        !CHECK_BIT(line->bits, IS_UNORDERED_LIST_2) &&
510        !CHECK_BIT(line->bits, IS_UNORDERED_LIST_3) &&
511        !CHECK_BIT(line->bits, IS_CODE)) {
512
513         // IS_QUOTE
514         if(CHECK_BIT(line->bits, IS_QUOTE)) {
515             while(line->text->text[offset] == '>') {
516                 // print a reverse color block
517                 if(colors) {
518                     wattron(window, COLOR_PAIR(CP_BLACK));
519                     wprintw(window, "%s", " ");
520                     wattron(window, COLOR_PAIR(CP_WHITE));
521                     wprintw(window, "%s", " ");
522                 } else {
523                     wprintw(window, "%s", ">");
524                 }
525
526                 // find next quote or break
527                 offset++;
528                 if(line->text->text[offset] == ' ')
529                     offset = next_word(line->text, offset);
530             }
531
532             inline_display(window, &line->text->text[offset], colors);
533         } else {
534
535             // IS_CENTER
536             if(CHECK_BIT(line->bits, IS_CENTER)) {
537                 if(line->length < max_cols) {
538                     wmove(window, y, x + ((max_cols - line->length) / 2));
539                 }
540             }
541
542             // IS_H1 || IS_H2
543             if(CHECK_BIT(line->bits, IS_H1) || CHECK_BIT(line->bits, IS_H2)) {
544
545                 // set headline color
546                 if(colors)
547                     wattron(window, COLOR_PAIR(CP_BLUE));
548
549                 // enable underline for H1
550                 if(CHECK_BIT(line->bits, IS_H1))
551                     wattron(window, A_UNDERLINE);
552
553                 // skip hashes
554                 while(line->text->text[offset] == '#')
555                     offset = next_word(line->text, offset);
556
557                 // print whole lines
558                 wprintw(window,
559                         "%s", &line->text->text[offset]);
560
561                 wattroff(window, A_UNDERLINE);
562
563             // no line-wide markdown
564             } else {
565
566                 inline_display(window, &line->text->text[offset], colors);
567             }
568         }
569     }
570
571     // fill rest off line with spaces
572     for(i = getcurx(window) - x; i < max_cols; i++)
573         wprintw(window, "%s", " ");
574
575     // reset to default color
576     if(colors)
577         wattron(window, COLOR_PAIR(CP_WHITE));
578     wattroff(window, A_UNDERLINE);
579 }
580
581 void inline_display(WINDOW *window, const char *c, const int colors) {
582     const static char *special = "\\*_`!["; // list of interpreted chars
583     const char *i = c; // iterator
584     const char *start_link_name, *start_url;
585     int length_link_name, url_num;
586     cstack_t *stack = cstack_init();
587
588
589     // for each char in line
590     for(; *i; i++) {
591
592         // if char is in special char list
593         if(strchr(special, *i)) {
594
595             // closing special char (or second backslash)
596             // only if not followed by :alnum:
597             if((stack->top)(stack, *i) &&
598                (!isalnum((int)i[1]) || *(i + 1) == '\0' || *i == '\\')) {
599
600                 switch(*i) {
601                     // print escaped backslash
602                     case '\\':
603                         wprintw(window, "%c", *i);
604                         break;
605                     // disable highlight
606                     case '*':
607                         if(colors)
608                             wattron(window, COLOR_PAIR(CP_WHITE));
609                         break;
610                     // disable underline
611                     case '_':
612                         wattroff(window, A_UNDERLINE);
613                         break;
614                     // disable inline code
615                     case '`':
616                         if(colors)
617                             wattron(window, COLOR_PAIR(CP_WHITE));
618                         break;
619                 }
620
621                 // remove top special char from stack
622                 (stack->pop)(stack);
623
624             // treat special as regular char
625             } else if((stack->top)(stack, '\\')) {
626                 wprintw(window, "%c", *i);
627
628                 // remove backslash from stack
629                 (stack->pop)(stack);
630
631             // opening special char
632             } else {
633
634                 // emphasis or code span can start after new-line or space only
635                 // and of cause after another emphasis markup
636                 //TODO this condition looks ugly
637                 if(i == c ||
638                    *(i - 1) == ' ' ||
639                    ((*(i - 1) == '_' || *(i - 1) == '*') && ((i - 1) == c || *(i - 2) == ' ')) ||
640                    *i == '\\') {
641
642                     // url in pandoc style
643                     if ((*i == '[' && strchr(i, ']')) ||
644                         (*i == '!' && *(i + 1) == '[' && strchr(i, ']'))) {
645
646                         if (*i == '!') i++;
647
648                         if (strchr(i, ']')[1] == '(') {
649                             i++;
650
651                             // turn higlighting and underlining on
652                             if (colors)
653                                 wattron(window, COLOR_PAIR(CP_BLUE));
654                             wattron(window, A_UNDERLINE);
655
656                             start_link_name = i;
657
658                             // print the content of the label
659                             // the label is printed as is
660                             do {
661                                 wprintw(window, "%c", *i);
662                                 i++;
663                             } while (*i != ']');
664
665                             length_link_name = i - 1 - start_link_name;
666
667                             i++;
668                             i++;
669
670                             start_url = i;
671
672                             while (*i != ')') i++;
673
674                             url_num = url_add(start_link_name, length_link_name, start_url, i - start_url, 0,0);
675
676                             wprintw(window, " [%d]", url_num);
677
678                             // turn highlighting and underlining off
679                             wattroff(window, A_UNDERLINE);
680                             wattron(window, COLOR_PAIR(CP_WHITE));
681
682                         } else {
683                             wprintw(window, "[");
684                         }
685
686                     } else switch(*i) {
687                         // enable highlight
688                         case '*':
689                             if(colors)
690                                 wattron(window, COLOR_PAIR(CP_RED));
691                             break;
692                         // enable underline
693                         case '_':
694                             wattron(window, A_UNDERLINE);
695                             break;
696                         // enable inline code
697                         case '`':
698                             if(colors)
699                                 wattron(window, COLOR_PAIR(CP_BLACK));
700                             break;
701                         // do nothing for backslashes
702                     }
703
704                     // push special char to stack
705                     (stack->push)(stack, *i);
706
707                 } else {
708                     wprintw(window, "%c", *i);
709                 }
710             }
711
712         } else {
713             // remove backslash from stack
714             if((stack->top)(stack, '\\'))
715                 (stack->pop)(stack);
716
717             // print regular char
718             wprintw(window, "%c", *i);
719         }
720     }
721
722     // pop stack until empty to prevent formated trailing spaces
723     while(!(stack->empty)(stack)) {
724         switch((stack->pop)(stack)) {
725             // disable highlight
726             case '*':
727                 if(colors)
728                     wattron(window, COLOR_PAIR(CP_WHITE));
729                 break;
730             // disable underline
731             case '_':
732                 wattroff(window, A_UNDERLINE);
733                 break;
734             // disable inline code
735             case '`':
736                 if(colors)
737                     wattron(window, COLOR_PAIR(CP_WHITE));
738                 break;
739             // do nothing for backslashes
740         }
741     }
742
743     (stack->delete)(stack);
744 }
745
746 void fade_out(WINDOW *window, int trans, int colors, int invert) {
747     int i; // increment
748     if(colors && COLORS == 256) {
749         for(i = 22; i >= 0; i--) {
750
751             // dim color pairs
752             if(invert) {
753                 init_pair(CP_WHITE, white_ramp_invert[i], trans);
754                 init_pair(CP_BLUE, blue_ramp_invert[i], trans);
755                 init_pair(CP_RED, red_ramp_invert[i], trans);
756                 init_pair(CP_BLACK, 15, white_ramp_invert[i]);
757             } else {
758                 init_pair(CP_WHITE, white_ramp[i], trans);
759                 init_pair(CP_BLUE, blue_ramp[i], trans);
760                 init_pair(CP_RED, red_ramp[i], trans);
761                 init_pair(CP_BLACK, 16, white_ramp[i]);
762             }
763
764             // refresh window with new color
765             wrefresh(window);
766
767             // delay for our eyes to recognize the change
768             usleep(FADE_DELAY);
769         }
770     }
771 }
772
773 void fade_in(WINDOW *window, int trans, int colors, int invert) {
774     int i; // increment
775     if(colors && COLORS == 256) {
776         for(i = 0; i <= 23; i++) {
777
778             // brighten color pairs
779             if(invert) {
780                 init_pair(CP_WHITE, white_ramp_invert[i], trans);
781                 init_pair(CP_BLUE, blue_ramp_invert[i], trans);
782                 init_pair(CP_RED, red_ramp_invert[i], trans);
783                 init_pair(CP_BLACK, 15, white_ramp_invert[i]);
784             } else {
785                 init_pair(CP_WHITE, white_ramp[i], trans);
786                 init_pair(CP_BLUE, blue_ramp[i], trans);
787                 init_pair(CP_RED, red_ramp[i], trans);
788                 init_pair(CP_BLACK, 16, white_ramp[i]);
789             }
790
791             // refresh window with new color
792             wrefresh(window);
793
794             // delay for our eyes to recognize the change
795             usleep(FADE_DELAY);
796         }
797     }
798 }
799
800 int int_length (int val) {
801     int l = 1;
802     while(val > 9) {
803         l++;
804         val /= 10;
805     }
806     return l;
807 }