// -*- C++ -*- /* Copyright (C) 1989-2014 Free Software Foundation, Inc. Written by James Clark (jjc@jclark.com) This file is part of groff. groff is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. groff is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program. If not, see . */ #include "driver.h" #include "device.h" #include "ptable.h" typedef signed char schar; declare_ptable(schar) implement_ptable(schar) extern "C" const char *Version_string; #define putstring(s) fputs(s, stdout) #ifndef SHRT_MIN #define SHRT_MIN (-32768) #endif #ifndef SHRT_MAX #define SHRT_MAX 32767 #endif #define TAB_WIDTH 8 // A character of the output device fits in a 32-bit word. typedef unsigned int output_character; static int horizontal_tab_flag = 0; static int form_feed_flag = 0; static int bold_flag_option = 1; static int bold_flag; static int underline_flag_option = 1; static int underline_flag; static int overstrike_flag = 1; static int draw_flag = 1; static int italic_flag_option = 0; static int italic_flag; static int reverse_flag_option = 0; static int reverse_flag; static int old_drawing_scheme = 0; static void update_options(); static void usage(FILE *stream); static int hline_char = '-'; static int vline_char = '|'; enum { UNDERLINE_MODE = 0x01, BOLD_MODE = 0x02, VDRAW_MODE = 0x04, HDRAW_MODE = 0x08, CU_MODE = 0x10, COLOR_CHANGE = 0x20, START_LINE = 0x40, END_LINE = 0x80 }; // Mode to use for bold-underlining. static unsigned char bold_underline_mode_option = BOLD_MODE|UNDERLINE_MODE; static unsigned char bold_underline_mode; #ifndef IS_EBCDIC_HOST #define CSI "\033[" #else #define CSI "\047[" #endif // SGR handling (ISO 6429) #define SGR_BOLD CSI "1m" #define SGR_NO_BOLD CSI "22m" #define SGR_ITALIC CSI "3m" #define SGR_NO_ITALIC CSI "23m" #define SGR_UNDERLINE CSI "4m" #define SGR_NO_UNDERLINE CSI "24m" #define SGR_REVERSE CSI "7m" #define SGR_NO_REVERSE CSI "27m" // many terminals can't handle `CSI 39 m' and `CSI 49 m' to reset // the foreground and background color, respectively; we thus use // `CSI 0 m' exclusively #define SGR_DEFAULT CSI "0m" #define DEFAULT_COLOR_IDX -1 class tty_font : public font { tty_font(const char *); unsigned char mode; public: ~tty_font(); unsigned char get_mode() { return mode; } #if 0 void handle_x_command(int argc, const char **argv); #endif static tty_font *load_tty_font(const char *); }; tty_font *tty_font::load_tty_font(const char *s) { tty_font *f = new tty_font(s); if (!f->load()) { delete f; return 0; } const char *num = f->get_internal_name(); long n; if (num != 0 && (n = strtol(num, 0, 0)) != 0) f->mode = (unsigned char)(n & (BOLD_MODE|UNDERLINE_MODE)); if (!underline_flag) f->mode &= ~UNDERLINE_MODE; if (!bold_flag) f->mode &= ~BOLD_MODE; if ((f->mode & (BOLD_MODE|UNDERLINE_MODE)) == (BOLD_MODE|UNDERLINE_MODE)) f->mode = (unsigned char)((f->mode & ~(BOLD_MODE|UNDERLINE_MODE)) | bold_underline_mode); return f; } tty_font::tty_font(const char *nm) : font(nm), mode(0) { } tty_font::~tty_font() { } #if 0 void tty_font::handle_x_command(int argc, const char **argv) { if (argc >= 1 && strcmp(argv[0], "bold") == 0) mode |= BOLD_MODE; else if (argc >= 1 && strcmp(argv[0], "underline") == 0) mode |= UNDERLINE_MODE; } #endif class tty_glyph { static tty_glyph *free_list; public: tty_glyph *next; int w; int hpos; unsigned int code; unsigned char mode; schar back_color_idx; schar fore_color_idx; void *operator new(size_t); void operator delete(void *); inline int draw_mode() { return mode & (VDRAW_MODE|HDRAW_MODE); } inline int order() { return mode & (VDRAW_MODE|HDRAW_MODE|CU_MODE|COLOR_CHANGE); } }; tty_glyph *tty_glyph::free_list = 0; void *tty_glyph::operator new(size_t) { if (!free_list) { const int BLOCK = 1024; free_list = (tty_glyph *)new char[sizeof(tty_glyph) * BLOCK]; for (int i = 0; i < BLOCK - 1; i++) free_list[i].next = free_list + i + 1; free_list[BLOCK - 1].next = 0; } tty_glyph *p = free_list; free_list = free_list->next; p->next = 0; return p; } void tty_glyph::operator delete(void *p) { if (p) { ((tty_glyph *)p)->next = free_list; free_list = (tty_glyph *)p; } } class tty_printer : public printer { tty_glyph **lines; int nlines; int cached_v; int cached_vpos; schar curr_fore_idx; schar curr_back_idx; int is_underline; int is_bold; int cu_flag; PTABLE(schar) tty_colors; void make_underline(int); void make_bold(output_character, int); schar color_to_idx(color *); void add_char(output_character, int, int, int, color *, color *, unsigned char); char *make_rgb_string(unsigned int, unsigned int, unsigned int); int tty_color(unsigned int, unsigned int, unsigned int, schar *, schar = DEFAULT_COLOR_IDX); void line(int, int, int, int, color *, color *); void draw_line(int *, int, const environment *); void draw_polygon(int *, int, const environment *); public: tty_printer(); ~tty_printer(); void set_char(glyph *, font *, const environment *, int, const char *); void draw(int, int *, int, const environment *); void special(char *, const environment *, char); void change_color(const environment * const); void change_fill_color(const environment * const); void put_char(output_character); void put_color(schar, int); void begin_page(int) { } void end_page(int); font *make_font(const char *); }; char *tty_printer::make_rgb_string(unsigned int r, unsigned int g, unsigned int b) { char *s = new char[8]; s[0] = char(r >> 8); s[1] = char(r & 0xff); s[2] = char(g >> 8); s[3] = char(g & 0xff); s[4] = char(b >> 8); s[5] = char(b & 0xff); s[6] = char(0x80); s[7] = 0; // avoid null-bytes in string for (int i = 0; i < 6; i++) if (!s[i]) { s[i] = 1; s[6] |= 1 << i; } return s; } int tty_printer::tty_color(unsigned int r, unsigned int g, unsigned int b, schar *idx, schar value) { int unknown_color = 0; char *s = make_rgb_string(r, g, b); schar *i = tty_colors.lookup(s); if (!i) { unknown_color = 1; i = new schar[1]; *i = value; tty_colors.define(s, i); } *idx = *i; a_delete s; return unknown_color; } tty_printer::tty_printer() : cached_v(0) { if (font::is_unicode) { hline_char = 0x2500; vline_char = 0x2502; } schar dummy; // black, white (void)tty_color(0, 0, 0, &dummy, 0); (void)tty_color(color::MAX_COLOR_VAL, color::MAX_COLOR_VAL, color::MAX_COLOR_VAL, &dummy, 7); // red, green, blue (void)tty_color(color::MAX_COLOR_VAL, 0, 0, &dummy, 1); (void)tty_color(0, color::MAX_COLOR_VAL, 0, &dummy, 2); (void)tty_color(0, 0, color::MAX_COLOR_VAL, &dummy, 4); // yellow, magenta, cyan (void)tty_color(color::MAX_COLOR_VAL, color::MAX_COLOR_VAL, 0, &dummy, 3); (void)tty_color(color::MAX_COLOR_VAL, 0, color::MAX_COLOR_VAL, &dummy, 5); (void)tty_color(0, color::MAX_COLOR_VAL, color::MAX_COLOR_VAL, &dummy, 6); nlines = 66; lines = new tty_glyph *[nlines]; for (int i = 0; i < nlines; i++) lines[i] = 0; cu_flag = 0; } tty_printer::~tty_printer() { a_delete lines; } void tty_printer::make_underline(int w) { if (old_drawing_scheme) { if (!w) warning("can't underline zero-width character"); else { putchar('_'); putchar('\b'); } } else { if (!is_underline) { if (italic_flag) putstring(SGR_ITALIC); else if (reverse_flag) putstring(SGR_REVERSE); else putstring(SGR_UNDERLINE); } is_underline = 1; } } void tty_printer::make_bold(output_character c, int w) { if (old_drawing_scheme) { if (!w) warning("can't print zero-width character in bold"); else { put_char(c); putchar('\b'); } } else { if (!is_bold) putstring(SGR_BOLD); is_bold = 1; } } schar tty_printer::color_to_idx(color *col) { if (col->is_default()) return DEFAULT_COLOR_IDX; unsigned int r, g, b; col->get_rgb(&r, &g, &b); schar idx; if (tty_color(r, g, b, &idx)) { char *s = col->print_color(); error("Unknown color (%1) mapped to default", s); a_delete s; } return idx; } void tty_printer::set_char(glyph *g, font *f, const environment *env, int w, const char *) { if (w % font::hor != 0) fatal("width of character not a multiple of horizontal resolution"); add_char(f->get_code(g), w, env->hpos, env->vpos, env->col, env->fill, ((tty_font *)f)->get_mode()); } void tty_printer::add_char(output_character c, int w, int h, int v, color *fore, color *back, unsigned char mode) { #if 0 // This is too expensive. if (h % font::hor != 0) fatal("horizontal position not a multiple of horizontal resolution"); #endif int hpos = h / font::hor; if (hpos < SHRT_MIN || hpos > SHRT_MAX) { error("character with ridiculous horizontal position discarded"); return; } int vpos; if (v == cached_v && cached_v != 0) vpos = cached_vpos; else { if (v % font::vert != 0) fatal("vertical position not a multiple of vertical resolution"); vpos = v / font::vert; if (vpos > nlines) { tty_glyph **old_lines = lines; lines = new tty_glyph *[vpos + 1]; memcpy(lines, old_lines, nlines * sizeof(tty_glyph *)); for (int i = nlines; i <= vpos; i++) lines[i] = 0; a_delete old_lines; nlines = vpos + 1; } // Note that the first output line corresponds to groff // position font::vert. if (vpos <= 0) { error("character above first line discarded"); return; } cached_v = v; cached_vpos = vpos; } tty_glyph *g = new tty_glyph; g->w = w; g->hpos = hpos; g->code = c; g->fore_color_idx = color_to_idx(fore); g->back_color_idx = color_to_idx(back); g->mode = mode; // The list will be reversed later. After reversal, it must be in // increasing order of hpos, with COLOR_CHANGE and CU specials before // HDRAW characters before VDRAW characters before normal characters // at each hpos, and otherwise in order of occurrence. tty_glyph **pp; for (pp = lines + (vpos - 1); *pp; pp = &(*pp)->next) if ((*pp)->hpos < hpos || ((*pp)->hpos == hpos && (*pp)->order() >= g->order())) break; g->next = *pp; *pp = g; } void tty_printer::special(char *arg, const environment *env, char type) { if (type == 'u') { add_char(*arg - '0', 0, env->hpos, env->vpos, env->col, env->fill, CU_MODE); return; } if (type != 'p') return; char *p; for (p = arg; *p == ' ' || *p == '\n'; p++) ; char *tag = p; for (; *p != '\0' && *p != ':' && *p != ' ' && *p != '\n'; p++) ; if (*p == '\0' || strncmp(tag, "tty", p - tag) != 0) { error("X command without `tty:' tag ignored"); return; } p++; for (; *p == ' ' || *p == '\n'; p++) ; char *command = p; for (; *p != '\0' && *p != ' ' && *p != '\n'; p++) ; if (*command == '\0') { error("empty X command ignored"); return; } if (strncmp(command, "sgr", p - command) == 0) { for (; *p == ' ' || *p == '\n'; p++) ; int n; if (*p != '\0' && sscanf(p, "%d", &n) == 1 && n == 0) old_drawing_scheme = 1; else old_drawing_scheme = 0; update_options(); } } void tty_printer::change_color(const environment * const env) { add_char(0, 0, env->hpos, env->vpos, env->col, env->fill, COLOR_CHANGE); } void tty_printer::change_fill_color(const environment * const env) { add_char(0, 0, env->hpos, env->vpos, env->col, env->fill, COLOR_CHANGE); } void tty_printer::draw(int code, int *p, int np, const environment *env) { if (!draw_flag) return; if (code == 'l') draw_line(p, np, env); if (code == 'p') draw_polygon(p, np, env); } void tty_printer::draw_polygon(int *p, int np, const environment *env) { if (np & 1) { error("even number of arguments required for polygon"); return; } if (np == 0) { error("no arguments for polygon"); return; } // We only draw polygons which consist entirely of horizontal and // vertical lines. int hpos = 0; int vpos = 0; for (int i = 0; i < np; i += 2) { if (!(p[i] == 0 || p[i + 1] == 0)) return; hpos += p[i]; vpos += p[i + 1]; } if (!(hpos == 0 || vpos == 0)) return; int start_hpos = env->hpos; int start_vpos = env->vpos; hpos = start_hpos; vpos = start_vpos; for (int i = 0; i < np; i += 2) { line(hpos, vpos, p[i], p[i + 1], env->col, env->fill); hpos += p[i]; vpos += p[i + 1]; } line(hpos, vpos, start_hpos - hpos, start_vpos - vpos, env->col, env->fill); } void tty_printer::draw_line(int *p, int np, const environment *env) { if (np != 2) { error("2 arguments required for line"); return; } line(env->hpos, env->vpos, p[0], p[1], env->col, env->fill); } void tty_printer::line(int hpos, int vpos, int dx, int dy, color *col, color *fill) { if (dx == 0) { // vertical line int v = vpos; int len = dy; if (len < 0) { v += len; len = -len; } if (len == 0) add_char(vline_char, font::hor, hpos, v, col, fill, VDRAW_MODE|START_LINE|END_LINE); else { add_char(vline_char, font::hor, hpos, v, col, fill, VDRAW_MODE|START_LINE); len -= font::vert; v += font::vert; while (len > 0) { add_char(vline_char, font::hor, hpos, v, col, fill, VDRAW_MODE|START_LINE|END_LINE); len -= font::vert; v += font::vert; } add_char(vline_char, font::hor, hpos, v, col, fill, VDRAW_MODE|END_LINE); } } if (dy == 0) { // horizontal line int h = hpos; int len = dx; if (len < 0) { h += len; len = -len; } if (len == 0) add_char(hline_char, font::hor, h, vpos, col, fill, HDRAW_MODE|START_LINE|END_LINE); else { add_char(hline_char, font::hor, h, vpos, col, fill, HDRAW_MODE|START_LINE); len -= font::hor; h += font::hor; while (len > 0) { add_char(hline_char, font::hor, h, vpos, col, fill, HDRAW_MODE|START_LINE|END_LINE); len -= font::hor; h += font::hor; } add_char(hline_char, font::hor, h, vpos, col, fill, HDRAW_MODE|END_LINE); } } } void tty_printer::put_char(output_character wc) { if (font::is_unicode && wc >= 0x80) { char buf[6 + 1]; int count; char *p = buf; if (wc < 0x800) count = 1, *p = (unsigned char)((wc >> 6) | 0xc0); else if (wc < 0x10000) count = 2, *p = (unsigned char)((wc >> 12) | 0xe0); else if (wc < 0x200000) count = 3, *p = (unsigned char)((wc >> 18) | 0xf0); else if (wc < 0x4000000) count = 4, *p = (unsigned char)((wc >> 24) | 0xf8); else if (wc <= 0x7fffffff) count = 5, *p = (unsigned char)((wc >> 30) | 0xfC); else return; do *++p = (unsigned char)(((wc >> (6 * --count)) & 0x3f) | 0x80); while (count > 0); *++p = '\0'; putstring(buf); } else putchar(wc); } void tty_printer::put_color(schar color_index, int back) { if (color_index == DEFAULT_COLOR_IDX) { putstring(SGR_DEFAULT); // set bold and underline again if (is_bold) putstring(SGR_BOLD); if (is_underline) { if (italic_flag) putstring(SGR_ITALIC); else if (reverse_flag) putstring(SGR_REVERSE); else putstring(SGR_UNDERLINE); } // set other color again back = !back; color_index = back ? curr_back_idx : curr_fore_idx; } if (color_index != DEFAULT_COLOR_IDX) { putstring(CSI); if (back) putchar('4'); else putchar('3'); putchar(color_index + '0'); putchar('m'); } } // The possible Unicode combinations for crossing characters. // // ` ' = 0, ` -' = 4, `- ' = 8, `--' = 12, // // ` ' = 0, ` ' = 1, `|' = 2, `|' = 3 // | | static output_character crossings[4*4] = { 0x0000, 0x2577, 0x2575, 0x2502, 0x2576, 0x250C, 0x2514, 0x251C, 0x2574, 0x2510, 0x2518, 0x2524, 0x2500, 0x252C, 0x2534, 0x253C }; void tty_printer::end_page(int page_length) { if (page_length % font::vert != 0) error("vertical position at end of page not multiple of vertical resolution"); int lines_per_page = page_length / font::vert; int last_line; for (last_line = nlines; last_line > 0; last_line--) if (lines[last_line - 1]) break; #if 0 if (last_line > lines_per_page) { error("characters past last line discarded"); do { --last_line; while (lines[last_line]) { tty_glyph *tem = lines[last_line]; lines[last_line] = tem->next; delete tem; } } while (last_line > lines_per_page); } #endif for (int i = 0; i < last_line; i++) { tty_glyph *p = lines[i]; lines[i] = 0; tty_glyph *g = 0; while (p) { tty_glyph *tem = p->next; p->next = g; g = p; p = tem; } int hpos = 0; tty_glyph *nextp; curr_fore_idx = DEFAULT_COLOR_IDX; curr_back_idx = DEFAULT_COLOR_IDX; is_underline = 0; is_bold = 0; for (p = g; p; delete p, p = nextp) { nextp = p->next; if (p->mode & CU_MODE) { cu_flag = (p->code != 0); continue; } if (nextp && p->hpos == nextp->hpos) { if (p->draw_mode() == HDRAW_MODE && nextp->draw_mode() == VDRAW_MODE) { if (font::is_unicode) nextp->code = crossings[((p->mode & (START_LINE|END_LINE)) >> 4) + ((nextp->mode & (START_LINE|END_LINE)) >> 6)]; else nextp->code = '+'; continue; } if (p->draw_mode() != 0 && p->draw_mode() == nextp->draw_mode()) { nextp->code = p->code; continue; } if (!overstrike_flag) continue; } if (hpos > p->hpos) { do { putchar('\b'); hpos--; } while (hpos > p->hpos); } else { if (horizontal_tab_flag) { for (;;) { int next_tab_pos = ((hpos + TAB_WIDTH) / TAB_WIDTH) * TAB_WIDTH; if (next_tab_pos > p->hpos) break; if (cu_flag) make_underline(p->w); else if (!old_drawing_scheme && is_underline) { if (italic_flag) putstring(SGR_NO_ITALIC); else if (reverse_flag) putstring(SGR_NO_REVERSE); else putstring(SGR_NO_UNDERLINE); is_underline = 0; } putchar('\t'); hpos = next_tab_pos; } } for (; hpos < p->hpos; hpos++) { if (cu_flag) make_underline(p->w); else if (!old_drawing_scheme && is_underline) { if (italic_flag) putstring(SGR_NO_ITALIC); else if (reverse_flag) putstring(SGR_NO_REVERSE); else putstring(SGR_NO_UNDERLINE); is_underline = 0; } putchar(' '); } } assert(hpos == p->hpos); if (p->mode & COLOR_CHANGE) { if (!old_drawing_scheme) { if (p->fore_color_idx != curr_fore_idx) { put_color(p->fore_color_idx, 0); curr_fore_idx = p->fore_color_idx; } if (p->back_color_idx != curr_back_idx) { put_color(p->back_color_idx, 1); curr_back_idx = p->back_color_idx; } } continue; } if (p->mode & UNDERLINE_MODE) make_underline(p->w); else if (!old_drawing_scheme && is_underline) { if (italic_flag) putstring(SGR_NO_ITALIC); else if (reverse_flag) putstring(SGR_NO_REVERSE); else putstring(SGR_NO_UNDERLINE); is_underline = 0; } if (p->mode & BOLD_MODE) make_bold(p->code, p->w); else if (!old_drawing_scheme && is_bold) { putstring(SGR_NO_BOLD); is_bold = 0; } if (!old_drawing_scheme) { if (p->fore_color_idx != curr_fore_idx) { put_color(p->fore_color_idx, 0); curr_fore_idx = p->fore_color_idx; } if (p->back_color_idx != curr_back_idx) { put_color(p->back_color_idx, 1); curr_back_idx = p->back_color_idx; } } put_char(p->code); hpos += p->w / font::hor; } if (!old_drawing_scheme && (is_bold || is_underline || curr_fore_idx != DEFAULT_COLOR_IDX || curr_back_idx != DEFAULT_COLOR_IDX)) putstring(SGR_DEFAULT); putchar('\n'); } if (form_feed_flag) { if (last_line < lines_per_page) putchar('\f'); } else { for (; last_line < lines_per_page; last_line++) putchar('\n'); } } font *tty_printer::make_font(const char *nm) { return tty_font::load_tty_font(nm); } printer *make_printer() { return new tty_printer(); } static void update_options() { if (old_drawing_scheme) { italic_flag = 0; reverse_flag = 0; bold_underline_mode = bold_underline_mode_option; bold_flag = bold_flag_option; underline_flag = underline_flag_option; } else { italic_flag = italic_flag_option; reverse_flag = reverse_flag_option; bold_underline_mode = BOLD_MODE|UNDERLINE_MODE; bold_flag = 1; underline_flag = 1; } } int main(int argc, char **argv) { program_name = argv[0]; static char stderr_buf[BUFSIZ]; if (getenv("GROFF_NO_SGR")) old_drawing_scheme = 1; setbuf(stderr, stderr_buf); setlocale(LC_CTYPE, ""); int c; static const struct option long_options[] = { { "help", no_argument, 0, CHAR_MAX + 1 }, { "version", no_argument, 0, 'v' }, { NULL, 0, 0, 0 } }; while ((c = getopt_long(argc, argv, "bBcdfF:hiI:oruUv", long_options, NULL)) != EOF) switch(c) { case 'v': printf("GNU grotty (groff) version %s\n", Version_string); exit(0); break; case 'i': // Use italic font instead of underlining. italic_flag_option = 1; break; case 'I': // ignore include search path break; case 'b': // Do not embolden by overstriking. bold_flag_option = 0; break; case 'c': // Use old scheme for emboldening and underline. old_drawing_scheme = 1; break; case 'u': // Do not underline. underline_flag_option = 0; break; case 'o': // Do not overstrike (other than emboldening and underlining). overstrike_flag = 0; break; case 'r': // Use reverse mode instead of underlining. reverse_flag_option = 1; break; case 'B': // Do bold-underlining as bold. bold_underline_mode_option = BOLD_MODE; break; case 'U': // Do bold-underlining as underlining. bold_underline_mode_option = UNDERLINE_MODE; break; case 'h': // Use horizontal tabs. horizontal_tab_flag = 1; break; case 'f': form_feed_flag = 1; break; case 'F': font::command_line_font_dir(optarg); break; case 'd': // Ignore \D commands. draw_flag = 0; break; case CHAR_MAX + 1: // --help usage(stdout); exit(0); break; case '?': usage(stderr); exit(1); break; default: assert(0); } update_options(); if (optind >= argc) do_file("-"); else { for (int i = optind; i < argc; i++) do_file(argv[i]); } return 0; } static void usage(FILE *stream) { fprintf(stream, "usage: %s [-bBcdfhioruUv] [-F dir] [files ...]\n", program_name); }