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 mpd.
   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 <locale.h> // setlocale
  25 #include <ncurses.h>
  26 #include <stdlib.h>
  27 #include <string.h> // strchr
  28 #include <unistd.h>
  29
  30 #include "include/viewer.h"
  31
  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,  32,
  39                                 33,  38,  39,  44,  45,  45,
  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 int ncurses_display(deck_t *deck, int notrans, int nofade) {
  48
  49     int c = 0;          // char
  50     int i = 0;          // iterate
  51     int l = 0;          // line number
  52     int sc = 1;         // slide count
  53     int colors = 0;     // amount of colors supported
  54     int fade = 0;       // disable color fading by default
  55     int trans = -1;     // enable transparency if term supports it
  56     int max_lines = 0;  // max lines per slide
  57     int max_cols = 0;   // max columns per line
  58     int offset;         // text offset
  59
  60     // header line 1 is displayed at the top
  61     int bar_top = (deck->headers > 0) ? 1 : 0;
  62     // header line 2 is displayed at the bottom
  63     // anyway we display the slide number at the bottom
  64     int bar_bottom = 1;
  65
  66     slide_t *slide = deck->slide;
  67     line_t *line;
  68
  69     while(slide) {
  70         // set max_lines if line count exceeded
  71         max_lines = (slide->lines > max_lines) ? slide->lines : max_lines;
  72         line = slide->line;
  73         while(line) {
  74             // set max_cols if length exceeded
  75             max_cols = (line->length > max_cols) ? line->length : max_cols;
  76             line = line->next;
  77         }
  78         slide = slide->next;
  79     }
  80
  81     // set locale to display UTF-8 correctly in ncurses
  82     setlocale(LC_CTYPE, "");
  83
  84     // replace stdin with current tty if markdown input was piped
  85     freopen("/dev/tty", "rw", stdin);
  86
  87     // init ncurses
  88     initscr();
  89
  90     if((max_cols > COLS) ||
  91        (max_lines + bar_top + bar_bottom + 2 > LINES)) {
  92
  93         fprintf(stderr, "Error: Terminal size %ix%i to small. Need at least %ix%i.\n",
  94             COLS, LINES, max_cols, max_lines + bar_top + bar_bottom + 2);
  95         endwin();
  96         return(1);
  97     }
  98
  99     // replace stdin with current tty if markdown input was piped
 100     freopen("/dev/tty", "rw", stdin);
 101
 102     // disable cursor
 103     curs_set(0);
 104
 105     // disable output of keyboard typing
 106     noecho();
 107
 108     // make getch() process one char at a time
 109     cbreak();
 110
 111     // enable arrow keys
 112     keypad(stdscr,TRUE);
 113
 114     // set colors
 115     if(has_colors() == TRUE) {
 116         start_color();
 117         use_default_colors();
 118
 119         if(notrans) trans = 0; // 0 is black
 120
 121         if(COLORS == 256) {
 122             // 256 color mode
 123             init_pair(CP_WHITE, 255, trans);
 124             init_pair(CP_BLUE, 123, trans);
 125             init_pair(CP_RED, 213, trans);
 126             init_pair(CP_YELLOW, 208, trans);
 127
 128             // enable color fading
 129             if(!nofade) fade = 1;
 130         } else {
 131
 132             // 8 color mode
 133             init_pair(CP_WHITE, 7, trans);
 134             init_pair(CP_BLUE, 4, trans);
 135             init_pair(CP_RED, 1, trans);
 136             init_pair(CP_YELLOW, 3, trans);
 137         }
 138
 139         colors = 1;
 140     }
 141
 142     // set background color of main window
 143     if(colors)
 144         wbkgd(stdscr, COLOR_PAIR(CP_YELLOW));
 145
 146     // setup main window
 147     WINDOW *content = newwin(LINES - bar_top - bar_bottom, COLS, 0 + bar_top, 0);
 148     if(colors)
 149         wbkgd(content, COLOR_PAIR(CP_WHITE));
 150
 151     slide = deck->slide;
 152     while(slide) {
 153         // clear windows
 154         werase(content);
 155         werase(stdscr);
 156
 157         // setup header
 158         if(bar_top) {
 159             line = deck->header;
 160             offset = next_blank(line->text, 0) + 1;
 161             // add text to header
 162             mvwprintw(stdscr,
 163                       0, (COLS - line->length + offset) / 2,
 164                       "%s", &line->text->text[offset]);
 165         }
 166
 167         // setup footer
 168         line = deck->header->next;
 169         offset = next_blank(line->text, 0) + 1;
 170         // add text to left footer
 171         mvwprintw(stdscr,
 172                   LINES - 1, 3,
 173                   "%s", &line->text->text[offset]);
 174         // add slide number to right footer
 175         mvwprintw(stdscr,
 176                   LINES - 1, COLS - int_length(deck->slides) - int_length(sc) - 6,
 177                   "%d / %d", sc, deck->slides);
 178
 179         // make header + fooder visible
 180         wrefresh(stdscr);
 181
 182         line = slide->line;
 183         l = 0;
 184
 185         // print lines
 186         while(line) {
 187             add_line(content, l, (COLS - max_cols) / 2, line, max_cols);
 188             line = line->next;
 189             l++;
 190         }
 191
 192         // make content visible
 193         wrefresh(content);
 194
 195         // fade in
 196         if(fade)
 197             fade_in(content, trans, colors);
 198
 199         // re-enable fading after any undefined key press
 200         if(COLORS == 256 && !nofade) fade = 1;
 201
 202         // wait for user input
 203         c = getch();
 204
 205         // evaluate user input
 206         i = 0;
 207         switch(c) {
 208
 209             // show previous slide
 210             case KEY_UP:
 211             case KEY_LEFT:
 212             case 8:   // BACKSPACE (ascii)
 213             case 127: // BACKSPACE (xterm)
 214             case 263: // BACKSPACE (getty)
 215             case 'h':
 216             case 'k':
 217                 if(slide->prev) {
 218                     slide = slide->prev;
 219                     sc--;
 220                 }
 221                 break;
 222
 223             // show next slide
 224             case KEY_DOWN:
 225             case KEY_RIGHT:
 226             case '\n': // ENTER
 227             case ' ':  // SPACE
 228             case 'j':
 229             case 'l':
 230                 if(slide->next) {
 231                     slide = slide->next;
 232                     sc++;
 233                 }
 234                 break;
 235
 236             // show slide n
 237             case '9': i++;
 238             case '8': i++;
 239             case '7': i++;
 240             case '6': i++;
 241             case '5': i++;
 242             case '4': i++;
 243             case '3': i++;
 244             case '2': i++;
 245             case '1': i++;
 246                 if(i <= deck->slides) {
 247                     while(sc != i) {
 248                         // search forward
 249                         if(sc < i) {
 250                             if(slide->next) {
 251                                 slide = slide->next;
 252                                 sc++;
 253                             }
 254                         // search backward
 255                         } else {
 256                             if(slide->prev) {
 257                                 slide = slide->prev;
 258                                 sc--;
 259                             }
 260                         }
 261                     }
 262                 } else {
 263                     // disable fading if slide n doesn't exist
 264                     fade = 0;
 265                 }
 266                 break;
 267
 268             // show first slide
 269             case KEY_HOME:
 270                 slide = deck->slide;
 271                 sc = 1;
 272                 break;
 273
 274             // show last slide
 275             case KEY_END:
 276                 for(i = sc; i <= deck->slides; i++) {
 277                     if(slide->next) {
 278                             slide = slide->next;
 279                             sc++;
 280                     }
 281                 }
 282                 break;
 283
 284             // quit
 285             case 'q':
 286                 // do not fade out on exit
 287                 fade = 0;
 288                 slide = (void*)0;
 289                 break;
 290
 291             default:
 292                 // disable fading on undefined key press
 293                 fade = 0;
 294                 break;
 295         }
 296
 297         // fade out
 298         if(fade)
 299             fade_out(content, trans, colors);
 300     }
 301
 302     endwin();
 303
 304     return(0);
 305 }
 306
 307 void add_line(WINDOW *window, int y, int x, line_t *line, int max_cols) {
 308     int i = 0; // increment
 309     char *c; // char pointer for iteration
 310     char *special = "\\*_"; // list of interpreted chars
 311     cstack_t *stack = cstack_init();
 312
 313     if(line->text->text) {
 314         int offset = 0; // text offset
 315         offset = next_nonblank(line->text, 0);
 316
 317         // IS_CODE
 318         if(CHECK_BIT(line->bits, IS_CODE)) {
 319
 320             // set static offset for code
 321             offset = CODE_INDENT;
 322
 323             // reverse color for code blocks
 324             wattron(window, A_REVERSE);
 325
 326             // print whole lines
 327             mvwprintw(window,
 328                       y, x,
 329                       "%s", &line->text->text[offset]);
 330
 331         } else {
 332
 333             // IS_H1 || IS_H2
 334             if(CHECK_BIT(line->bits, IS_H1) || CHECK_BIT(line->bits, IS_H2)) {
 335
 336                 // set headline color
 337                 wattron(window, COLOR_PAIR(CP_BLUE));
 338
 339                 // enable underline for H1
 340                 if(CHECK_BIT(line->bits, IS_H1))
 341                     wattron(window, A_UNDERLINE);
 342
 343                 // skip hashes
 344                 while(line->text->text[offset] == '#')
 345                     offset = next_word(line->text, offset);
 346
 347                 // print whole lines
 348                 mvwprintw(window,
 349                       y, x,
 350                       "%s", &line->text->text[offset]);
 351
 352                 wattroff(window, A_UNDERLINE);
 353
 354             } else {
 355                 // move the cursor in position
 356                 wmove(window, y, x);
 357
 358                 // IS_QUOTE
 359                 if(CHECK_BIT(line->bits, IS_QUOTE)) {
 360                     while(line->text->text[offset] == '>') {
 361                         // print a reverse color block
 362                         wattron(window, A_REVERSE);
 363                         wprintw(window, "%s", " ");
 364                         wattroff(window, A_REVERSE);
 365                         wprintw(window, "%s", " ");
 366                         // find next quote or break
 367                         offset++;
 368                         if(line->text->text[offset] == ' ')
 369                             offset = next_word(line->text, offset);
 370                     }
 371                 }
 372
 373                 // for each char in line
 374                 c = &line->text->text[offset];
 375                 while(*c) {
 376
 377                     // if char is in special char list
 378                     if(strchr(special, *c)) {
 379
 380                         // closing special char (or second backslash)
 381                         if((stack->top)(stack, *c)) {
 382
 383                             switch(*c) {
 384                                 // print escaped backslash
 385                                 case '\\':
 386                                     wprintw(window, "%c", *c);
 387                                     break;
 388                                 // disable highlight
 389                                 case '*':
 390                                     wattron(window, COLOR_PAIR(CP_WHITE));
 391                                     break;
 392                                 // disable underline
 393                                 case '_':
 394                                     wattroff(window, A_UNDERLINE);
 395                                     break;
 396                             }
 397
 398                             // remove top special char from stack
 399                             (stack->pop)(stack);
 400
 401                         // treat special as regular char
 402                         } else if((stack->top)(stack, '\\')) {
 403                             wprintw(window, "%c", *c);
 404
 405                             // remove backslash from stack
 406                             (stack->pop)(stack);
 407
 408                         // opening special char
 409                         } else {
 410                             switch(*c) {
 411                                 // enable highlight
 412                                 case '*':
 413                                     wattron(window, COLOR_PAIR(CP_RED));
 414                                     break;
 415                                 // enable underline
 416                                 case '_':
 417                                     wattron(window, A_UNDERLINE);
 418                                     break;
 419                                 // do nothing for backslashes
 420                             }
 421
 422                             // push special char to stack
 423                             (stack->push)(stack, *c);
 424                         }
 425
 426                     } else {
 427                         // print regular char
 428                         wprintw(window, "%c", *c);
 429                     }
 430
 431                     c++;
 432                 }
 433
 434                 // pop stack until empty to prevent formated trailing spaces
 435                 while(!(stack->empty)(stack)) {
 436                     switch((stack->pop)(stack)) {
 437                         case '\\':
 438                             wprintw(window, "%c", '\\');
 439                             break;
 440                         // disable highlight
 441                         case '*':
 442                             wattron(window, COLOR_PAIR(CP_WHITE));
 443                             break;
 444                         // disable underline
 445                         case '_':
 446                             wattroff(window, A_UNDERLINE);
 447                             break;
 448                     }
 449                 }
 450             }
 451         }
 452
 453         // fill rest off line with spaces
 454         for(i = getcurx(window) - x; i < max_cols; i++)
 455             wprintw(window, "%s", " ");
 456
 457         // reset to default color
 458         wattron(window, COLOR_PAIR(CP_WHITE));
 459         wattroff(window, A_UNDERLINE);
 460         wattroff(window, A_REVERSE);
 461     }
 462
 463     (stack->delete)(stack);
 464 }
 465
 466 void fade_out(WINDOW *window, int trans, int colors) {
 467     int i; // increment
 468     if(colors) {
 469         for(i = 22; i >= 0; i--) {
 470             // darken color pairs
 471             init_pair(CP_WHITE, white_ramp[i], trans);
 472             init_pair(CP_BLUE, blue_ramp[i], trans);
 473             init_pair(CP_RED, red_ramp[i], trans);
 474             // refresh window with new color
 475             wrefresh(window);
 476             // delay for our eyes to recognize the change
 477             usleep(FADE_DELAY);
 478         }
 479     }
 480 }
 481
 482 void fade_in(WINDOW *window, int trans, int colors) {
 483     int i; // increment
 484     if(colors) {
 485         for(i = 0; i <= 23; i++) {
 486             // lighten color pairs
 487             init_pair(CP_WHITE, white_ramp[i], trans);
 488             init_pair(CP_BLUE, blue_ramp[i], trans);
 489             init_pair(CP_RED, red_ramp[i], trans);
 490             // refresh window with new color
 491             wrefresh(window);
 492             // delay for our eyes to recognize the change
 493             usleep(FADE_DELAY);
 494         }
 495     }
 496 }
 497
 498 int int_length (int val) {
 499     int l = 1;
 500     while(val > 9) {
 501         l++;
 502         val /= 10;
 503     }
 504     return l;
 505 }