tig.h

   1 /* Copyright (c) 2006-2010 Jonas Fonseca <fonseca@diku.dk>
   2  *
   3  * This program is free software; you can redistribute it and/or
   4  * modify it under the terms of the GNU General Public License as
   5  * published by the Free Software Foundation; either version 2 of
   6  * the License, or (at your option) any later version.
   7  *
   8  * This program is distributed in the hope that it will be useful,
   9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  11  * GNU General Public License for more details.
  12  */
  13
  14 #ifndef TIG_H
  15 #define TIG_H
  16
  17 #ifdef HAVE_CONFIG_H
  18 #include "config.h"
  19 #endif
  20
  21 #ifndef TIG_VERSION
  22 #define TIG_VERSION "unknown-version"
  23 #endif
  24
  25 #ifndef DEBUG
  26 #define NDEBUG
  27 #endif
  28
  29 /* necessary on Snow Leopard to use WINDOW struct */
  30 #ifdef NCURSES_OPAQUE
  31 #undef NCURSES_OPAQUE
  32 #endif
  33 #define NCURSES_OPAQUE 0
  34
  35
  36 #include <assert.h>
  37 #include <errno.h>
  38 #include <ctype.h>
  39 #include <signal.h>
  40 #include <stdarg.h>
  41 #include <stdio.h>
  42 #include <stdlib.h>
  43 #include <string.h>
  44 #include <sys/types.h>
  45 #include <sys/wait.h>
  46 #include <sys/stat.h>
  47 #include <sys/select.h>
  48 #include <unistd.h>
  49 #include <sys/time.h>
  50 #include <time.h>
  51 #include <fcntl.h>
  52
  53 #include <regex.h>
  54
  55 #include <locale.h>
  56 #include <langinfo.h>
  57 #include <iconv.h>
  58
  59 /* ncurses(3): Must be defined to have extended wide-character functions. */
  60 #define _XOPEN_SOURCE_EXTENDED
  61
  62 #ifdef HAVE_NCURSESW_H
  63 #include <ncursesw/ncurses.h>
  64 #else
  65 #include <ncurses.h>
  66 #endif
  67
  68 #if __GNUC__ >= 3
  69 #define __NORETURN __attribute__((__noreturn__))
  70 #else
  71 #define __NORETURN
  72 #endif
  73
  74 #define ABS(x)          ((x) >= 0  ? (x) : -(x))
  75 #define MIN(x, y)       ((x) < (y) ? (x) :  (y))
  76 #define MAX(x, y)       ((x) > (y) ? (x) :  (y))
  77
  78 #define ARRAY_SIZE(x)   (sizeof(x) / sizeof(x[0]))
  79 #define STRING_SIZE(x)  (sizeof(x) - 1)
  80
  81 #define SIZEOF_STR      1024    /* Default string size. */
  82 #define SIZEOF_REF      256     /* Size of symbolic or SHA1 ID. */
  83 #define SIZEOF_REV      41      /* Holds a SHA-1 and an ending NUL. */
  84 #define SIZEOF_ARG      32      /* Default argument array size. */
  85
  86 /* This color name can be used to refer to the default term colors. */
  87 #define COLOR_DEFAULT   (-1)
  88
  89 #define ENCODING_UTF8   "UTF-8"
  90 #define ENCODING_SEP    ": encoding: "
  91 #define ENCODING_ARG    "--encoding=" ENCODING_UTF8
  92
  93 #define ICONV_NONE      ((iconv_t) -1)
  94 #ifndef ICONV_CONST
  95 #define ICONV_CONST     /* nothing */
  96 #endif
  97 #define ICONV_TRANSLIT  "//TRANSLIT"
  98
  99 /* The format and size of the date column in the main view. */
 100 #define DATE_FORMAT     "%Y-%m-%d %H:%M"
 101 #define DATE_COLS       STRING_SIZE("2006-04-29 14:21 ")
 102 #define DATE_SHORT_COLS STRING_SIZE("2006-04-29 ")
 103
 104 #define ID_COLS         8
 105 #define AUTHOR_COLS     19
 106 #define FILENAME_COLS   19
 107
 108 #define MIN_VIEW_HEIGHT 4
 109
 110 #define NULL_ID         "0000000000000000000000000000000000000000"
 111
 112 #define S_ISGITLINK(mode) (((mode) & S_IFMT) == 0160000)
 113
 114 /* Some ASCII-shorthands fitted into the ncurses namespace. */
 115 #define KEY_CTL(x)      ((x) & 0x1f) /* KEY_CTL(A) == ^A == \1 */
 116 #define KEY_TAB         '\t'
 117 #define KEY_RETURN      '\r'
 118 #define KEY_ESC         27
 119
 120 /*
 121  * Allocation helpers ... Entering macro hell to never be seen again.
 122  */
 123
 124 #define DEFINE_ALLOCATOR(name, type, chunk_size)                                \
 125 static type *                                                                   \
 126 name(type **mem, size_t size, size_t increase)                                  \
 127 {                                                                               \
 128         size_t num_chunks = (size + chunk_size - 1) / chunk_size;               \
 129         size_t num_chunks_new = (size + increase + chunk_size - 1) / chunk_size;\
 130         type *tmp = *mem;                                                       \
 131                                                                                 \
 132         if (mem == NULL || num_chunks != num_chunks_new) {                      \
 133                 tmp = realloc(tmp, num_chunks_new * chunk_size * sizeof(type)); \
 134                 if (tmp)                                                        \
 135                         *mem = tmp;                                             \
 136         }                                                                       \
 137                                                                                 \
 138         return tmp;                                                             \
 139 }
 140
 141 /*
 142  * Strings.
 143  */
 144
 145 #define prefixcmp(str1, str2) \
 146         strncmp(str1, str2, STRING_SIZE(str2))
 147
 148 static inline bool
 149 string_isnumber(const char *str)
 150 {
 151         int pos;
 152
 153         for (pos = 0; str[pos]; pos++) {
 154                 if (!isdigit(str[pos]))
 155                         return FALSE;
 156         }
 157
 158         return pos > 0;
 159 }
 160
 161 static inline bool
 162 iscommit(char *str)
 163 {
 164         int pos;
 165
 166         for (pos = 0; str[pos]; pos++) {
 167                 if (!isxdigit(str[pos]))
 168                         return FALSE;
 169         }
 170
 171         return 7 <= pos && pos < SIZEOF_REV;
 172 }
 173
 174 static inline int
 175 ascii_toupper(int c)
 176 {
 177         if (c >= 'a' && c <= 'z')
 178                 c &= ~0x20;
 179         return c;
 180 }
 181
 182 static inline int
 183 ascii_tolower(int c)
 184 {
 185         if (c >= 'A' && c <= 'Z')
 186                 c |= 0x20;
 187         return c;
 188 }
 189
 190 static inline int
 191 suffixcmp(const char *str, int slen, const char *suffix)
 192 {
 193         size_t len = slen >= 0 ? slen : strlen(str);
 194         size_t suffixlen = strlen(suffix);
 195
 196         return suffixlen < len ? strcmp(str + len - suffixlen, suffix) : -1;
 197 }
 198
 199 static inline void
 200 string_ncopy_do(char *dst, size_t dstlen, const char *src, size_t srclen)
 201 {
 202         if (srclen > dstlen - 1)
 203                 srclen = dstlen - 1;
 204
 205         strncpy(dst, src, srclen);
 206         dst[srclen] = 0;
 207 }
 208
 209 /* Shorthands for safely copying into a fixed buffer. */
 210
 211 #define FORMAT_BUFFER(buf, bufsize, fmt, retval, allow_truncate) \
 212         do { \
 213                 va_list args; \
 214                 va_start(args, fmt); \
 215                 retval = vsnprintf(buf, bufsize, fmt, args); \
 216                 va_end(args); \
 217                 if (retval >= (bufsize) && allow_truncate) { \
 218                         (buf)[(bufsize) - 1] = 0; \
 219                         (buf)[(bufsize) - 2] = '.'; \
 220                         (buf)[(bufsize) - 3] = '.'; \
 221                         (buf)[(bufsize) - 4] = '.'; \
 222                         retval = (bufsize) - 1; \
 223                 } else if (retval < 0 || retval >= (bufsize)) { \
 224                         retval = -1; \
 225                 } \
 226         } while (0)
 227
 228 #define string_copy(dst, src) \
 229         string_ncopy_do(dst, sizeof(dst), src, sizeof(src))
 230
 231 #define string_ncopy(dst, src, srclen) \
 232         string_ncopy_do(dst, sizeof(dst), src, srclen)
 233
 234 #define string_copy_rev(dst, src) \
 235         string_ncopy_do(dst, SIZEOF_REV, src, SIZEOF_REV - 1)
 236
 237 #define string_add(dst, from, src) \
 238         string_ncopy_do(dst + (from), sizeof(dst) - (from), src, sizeof(src))
 239
 240 static inline size_t
 241 string_expand(char *dst, size_t dstlen, const char *src, int tabsize)
 242 {
 243         size_t size, pos;
 244
 245         for (size = pos = 0; size < dstlen - 1 && src[pos]; pos++) {
 246                 if (src[pos] == '\t') {
 247                         size_t expanded = tabsize - (size % tabsize);
 248
 249                         if (expanded + size >= dstlen - 1)
 250                                 expanded = dstlen - size - 1;
 251                         memcpy(dst + size, "        ", expanded);
 252                         size += expanded;
 253                 } else {
 254                         dst[size++] = src[pos];
 255                 }
 256         }
 257
 258         dst[size] = 0;
 259         return pos;
 260 }
 261
 262 static inline char *
 263 chomp_string(char *name)
 264 {
 265         int namelen;
 266
 267         while (isspace(*name))
 268                 name++;
 269
 270         namelen = strlen(name) - 1;
 271         while (namelen > 0 && isspace(name[namelen]))
 272                 name[namelen--] = 0;
 273
 274         return name;
 275 }
 276
 277 static inline bool
 278 string_nformat(char *buf, size_t bufsize, size_t *bufpos, const char *fmt, ...)
 279 {
 280         size_t pos = bufpos ? *bufpos : 0;
 281         int retval;
 282
 283         FORMAT_BUFFER(buf + pos, bufsize - pos, fmt, retval, FALSE);
 284         if (bufpos && retval > 0)
 285                 *bufpos = pos + retval;
 286
 287         return pos >= bufsize ? FALSE : TRUE;
 288 }
 289
 290 #define string_format(buf, fmt, args...) \
 291         string_nformat(buf, sizeof(buf), NULL, fmt, args)
 292
 293 #define string_format_from(buf, from, fmt, args...) \
 294         string_nformat(buf, sizeof(buf), from, fmt, args)
 295
 296 static inline int
 297 strcmp_null(const char *s1, const char *s2)
 298 {
 299         if (!s1 || !s2) {
 300                 return (!!s1) - (!!s2);
 301         }
 302
 303         return strcmp(s1, s2);
 304 }
 305
 306 /*
 307  * Enumerations
 308  */
 309
 310 struct enum_map {
 311         const char *name;
 312         int namelen;
 313         int value;
 314 };
 315
 316 #define ENUM_MAP(name, value) { name, STRING_SIZE(name), value }
 317
 318 #define ENUM_SYM_MACRO(prefix, name)    prefix##_##name
 319 #define ENUM_MAP_MACRO(prefix, name)    ENUM_MAP(#name, ENUM_SYM_MACRO(prefix, name))
 320
 321 #define DEFINE_ENUM(name, info) \
 322         enum name { info(ENUM_SYM_MACRO) }; \
 323         static const struct enum_map name##_map[] = { info(ENUM_MAP_MACRO) }
 324
 325 static inline int
 326 string_enum_compare(const char *str1, const char *str2, int len)
 327 {
 328         size_t i;
 329
 330 #define string_enum_sep(x) ((x) == '-' || (x) == '_' || (x) == '.')
 331
 332         /* Diff-Header == DIFF_HEADER */
 333         for (i = 0; i < len; i++) {
 334                 if (ascii_toupper(str1[i]) == ascii_toupper(str2[i]))
 335                         continue;
 336
 337                 if (string_enum_sep(str1[i]) &&
 338                     string_enum_sep(str2[i]))
 339                         continue;
 340
 341                 return str1[i] - str2[i];
 342         }
 343
 344         return 0;
 345 }
 346
 347 #define enum_equals(entry, str, len) \
 348         ((entry).namelen == (len) && !string_enum_compare((entry).name, str, len))
 349
 350 static inline char *
 351 enum_map_name(const char *name, size_t namelen)
 352 {
 353         static char buf[SIZEOF_STR];
 354         int bufpos;
 355
 356         for (bufpos = 0; bufpos <= namelen; bufpos++) {
 357                 buf[bufpos] = ascii_tolower(name[bufpos]);
 358                 if (buf[bufpos] == '_')
 359                         buf[bufpos] = '-';
 360         }
 361
 362         buf[bufpos] = 0;
 363         return buf;
 364 }
 365
 366 #define enum_name(entry) enum_map_name((entry).name, (entry).namelen)
 367
 368 static inline bool
 369 map_enum_do(const struct enum_map *map, size_t map_size, int *value, const char *name)
 370 {
 371         size_t namelen = strlen(name);
 372         int i;
 373
 374         for (i = 0; i < map_size; i++)
 375                 if (enum_equals(map[i], name, namelen)) {
 376                         *value = map[i].value;
 377                         return TRUE;
 378                 }
 379
 380         return FALSE;
 381 }
 382
 383 #define map_enum(attr, map, name) \
 384         map_enum_do(map, ARRAY_SIZE(map), attr, name)
 385
 386 /*
 387  * Unicode / UTF-8 handling
 388  *
 389  * NOTE: Much of the following code for dealing with Unicode is derived from
 390  * ELinks' UTF-8 code developed by Scrool <scroolik@gmail.com>. Origin file is
 391  * src/intl/charset.c from the UTF-8 branch commit elinks-0.11.0-g31f2c28.
 392  */
 393
 394 static inline int
 395 unicode_width(unsigned long c, int tab_size)
 396 {
 397         if (c >= 0x1100 &&
 398            (c <= 0x115f                         /* Hangul Jamo */
 399             || c == 0x2329
 400             || c == 0x232a
 401             || (c >= 0x2e80  && c <= 0xa4cf && c != 0x303f)
 402                                                 /* CJK ... Yi */
 403             || (c >= 0xac00  && c <= 0xd7a3)    /* Hangul Syllables */
 404             || (c >= 0xf900  && c <= 0xfaff)    /* CJK Compatibility Ideographs */
 405             || (c >= 0xfe30  && c <= 0xfe6f)    /* CJK Compatibility Forms */
 406             || (c >= 0xff00  && c <= 0xff60)    /* Fullwidth Forms */
 407             || (c >= 0xffe0  && c <= 0xffe6)
 408             || (c >= 0x20000 && c <= 0x2fffd)
 409             || (c >= 0x30000 && c <= 0x3fffd)))
 410                 return 2;
 411
 412         if (c == '\t')
 413                 return tab_size;
 414
 415         return 1;
 416 }
 417
 418 /* Number of bytes used for encoding a UTF-8 character indexed by first byte.
 419  * Illegal bytes are set one. */
 420 static const unsigned char utf8_bytes[256] = {
 421         1,1,1,1,1,1,1,1, 1,1,1,1,1,1,1,1, 1,1,1,1,1,1,1,1, 1,1,1,1,1,1,1,1,
 422         1,1,1,1,1,1,1,1, 1,1,1,1,1,1,1,1, 1,1,1,1,1,1,1,1, 1,1,1,1,1,1,1,1,
 423         1,1,1,1,1,1,1,1, 1,1,1,1,1,1,1,1, 1,1,1,1,1,1,1,1, 1,1,1,1,1,1,1,1,
 424         1,1,1,1,1,1,1,1, 1,1,1,1,1,1,1,1, 1,1,1,1,1,1,1,1, 1,1,1,1,1,1,1,1,
 425         1,1,1,1,1,1,1,1, 1,1,1,1,1,1,1,1, 1,1,1,1,1,1,1,1, 1,1,1,1,1,1,1,1,
 426         1,1,1,1,1,1,1,1, 1,1,1,1,1,1,1,1, 1,1,1,1,1,1,1,1, 1,1,1,1,1,1,1,1,
 427         2,2,2,2,2,2,2,2, 2,2,2,2,2,2,2,2, 2,2,2,2,2,2,2,2, 2,2,2,2,2,2,2,2,
 428         3,3,3,3,3,3,3,3, 3,3,3,3,3,3,3,3, 4,4,4,4,4,4,4,4, 5,5,5,5,6,6,1,1,
 429 };
 430
 431 static inline unsigned char
 432 utf8_char_length(const char *string, const char *end)
 433 {
 434         int c = *(unsigned char *) string;
 435
 436         return utf8_bytes[c];
 437 }
 438
 439 /* Decode UTF-8 multi-byte representation into a Unicode character. */
 440 static inline unsigned long
 441 utf8_to_unicode(const char *string, size_t length)
 442 {
 443         unsigned long unicode;
 444
 445         switch (length) {
 446         case 1:
 447                 unicode  =   string[0];
 448                 break;
 449         case 2:
 450                 unicode  =  (string[0] & 0x1f) << 6;
 451                 unicode +=  (string[1] & 0x3f);
 452                 break;
 453         case 3:
 454                 unicode  =  (string[0] & 0x0f) << 12;
 455                 unicode += ((string[1] & 0x3f) << 6);
 456                 unicode +=  (string[2] & 0x3f);
 457                 break;
 458         case 4:
 459                 unicode  =  (string[0] & 0x0f) << 18;
 460                 unicode += ((string[1] & 0x3f) << 12);
 461                 unicode += ((string[2] & 0x3f) << 6);
 462                 unicode +=  (string[3] & 0x3f);
 463                 break;
 464         case 5:
 465                 unicode  =  (string[0] & 0x0f) << 24;
 466                 unicode += ((string[1] & 0x3f) << 18);
 467                 unicode += ((string[2] & 0x3f) << 12);
 468                 unicode += ((string[3] & 0x3f) << 6);
 469                 unicode +=  (string[4] & 0x3f);
 470                 break;
 471         case 6:
 472                 unicode  =  (string[0] & 0x01) << 30;
 473                 unicode += ((string[1] & 0x3f) << 24);
 474                 unicode += ((string[2] & 0x3f) << 18);
 475                 unicode += ((string[3] & 0x3f) << 12);
 476                 unicode += ((string[4] & 0x3f) << 6);
 477                 unicode +=  (string[5] & 0x3f);
 478                 break;
 479         default:
 480                 return 0;
 481         }
 482
 483         /* Invalid characters could return the special 0xfffd value but NUL
 484          * should be just as good. */
 485         return unicode > 0xffff ? 0 : unicode;
 486 }
 487
 488 /* Calculates how much of string can be shown within the given maximum width
 489  * and sets trimmed parameter to non-zero value if all of string could not be
 490  * shown. If the reserve flag is TRUE, it will reserve at least one
 491  * trailing character, which can be useful when drawing a delimiter.
 492  *
 493  * Returns the number of bytes to output from string to satisfy max_width. */
 494 static inline size_t
 495 utf8_length(const char **start, size_t skip, int *width, size_t max_width, int *trimmed, bool reserve, int tab_size)
 496 {
 497         const char *string = *start;
 498         const char *end = strchr(string, '\0');
 499         unsigned char last_bytes = 0;
 500         size_t last_ucwidth = 0;
 501
 502         *width = 0;
 503         *trimmed = 0;
 504
 505         while (string < end) {
 506                 unsigned char bytes = utf8_char_length(string, end);
 507                 size_t ucwidth;
 508                 unsigned long unicode;
 509
 510                 if (string + bytes > end)
 511                         break;
 512
 513                 /* Change representation to figure out whether
 514                  * it is a single- or double-width character. */
 515
 516                 unicode = utf8_to_unicode(string, bytes);
 517                 /* FIXME: Graceful handling of invalid Unicode character. */
 518                 if (!unicode)
 519                         break;
 520
 521                 ucwidth = unicode_width(unicode, tab_size);
 522                 if (skip > 0) {
 523                         skip -= ucwidth <= skip ? ucwidth : skip;
 524                         *start += bytes;
 525                 }
 526                 *width  += ucwidth;
 527                 if (*width > max_width) {
 528                         *trimmed = 1;
 529                         *width -= ucwidth;
 530                         if (reserve && *width == max_width) {
 531                                 string -= last_bytes;
 532                                 *width -= last_ucwidth;
 533                         }
 534                         break;
 535                 }
 536
 537                 string  += bytes;
 538                 last_bytes = ucwidth ? bytes : 0;
 539                 last_ucwidth = ucwidth;
 540         }
 541
 542         return string - *start;
 543 }
 544
 545 #endif