tig.h

   1 /* Copyright (c) 2006-2012 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                 size_t newsize = num_chunks_new * chunk_size * sizeof(type);    \
 134                                                                                 \
 135                 tmp = realloc(tmp, newsize);                                    \
 136                 if (tmp) {                                                      \
 137                         *mem = tmp;                                             \
 138                         if (num_chunks_new > num_chunks) {                      \
 139                                 size_t offset = num_chunks * chunk_size;        \
 140                                 size_t oldsize = offset * sizeof(type);         \
 141                                                                                 \
 142                                 memset(tmp + offset, 0, newsize - oldsize);     \
 143                         }                                                       \
 144                 }                                                               \
 145         }                                                                       \
 146                                                                                 \
 147         return tmp;                                                             \
 148 }
 149
 150 /*
 151  * Strings.
 152  */
 153
 154 #define prefixcmp(str1, str2) \
 155         strncmp(str1, str2, STRING_SIZE(str2))
 156
 157 static inline bool
 158 string_isnumber(const char *str)
 159 {
 160         int pos;
 161
 162         for (pos = 0; str[pos]; pos++) {
 163                 if (!isdigit(str[pos]))
 164                         return FALSE;
 165         }
 166
 167         return pos > 0;
 168 }
 169
 170 static inline bool
 171 iscommit(char *str)
 172 {
 173         int pos;
 174
 175         for (pos = 0; str[pos]; pos++) {
 176                 if (!isxdigit(str[pos]))
 177                         return FALSE;
 178         }
 179
 180         return 7 <= pos && pos < SIZEOF_REV;
 181 }
 182
 183 static inline int
 184 ascii_toupper(int c)
 185 {
 186         if (c >= 'a' && c <= 'z')
 187                 c &= ~0x20;
 188         return c;
 189 }
 190
 191 static inline int
 192 ascii_tolower(int c)
 193 {
 194         if (c >= 'A' && c <= 'Z')
 195                 c |= 0x20;
 196         return c;
 197 }
 198
 199 static inline int
 200 suffixcmp(const char *str, int slen, const char *suffix)
 201 {
 202         size_t len = slen >= 0 ? slen : strlen(str);
 203         size_t suffixlen = strlen(suffix);
 204
 205         return suffixlen < len ? strcmp(str + len - suffixlen, suffix) : -1;
 206 }
 207
 208 static inline void
 209 string_ncopy_do(char *dst, size_t dstlen, const char *src, size_t srclen)
 210 {
 211         if (srclen > dstlen - 1)
 212                 srclen = dstlen - 1;
 213
 214         strncpy(dst, src, srclen);
 215         dst[srclen] = 0;
 216 }
 217
 218 /* Shorthands for safely copying into a fixed buffer. */
 219
 220 #define FORMAT_BUFFER(buf, bufsize, fmt, retval, allow_truncate) \
 221         do { \
 222                 va_list args; \
 223                 va_start(args, fmt); \
 224                 retval = vsnprintf(buf, bufsize, fmt, args); \
 225                 va_end(args); \
 226                 if (retval >= (bufsize) && allow_truncate) { \
 227                         (buf)[(bufsize) - 1] = 0; \
 228                         (buf)[(bufsize) - 2] = '.'; \
 229                         (buf)[(bufsize) - 3] = '.'; \
 230                         (buf)[(bufsize) - 4] = '.'; \
 231                         retval = (bufsize) - 1; \
 232                 } else if (retval < 0 || retval >= (bufsize)) { \
 233                         retval = -1; \
 234                 } \
 235         } while (0)
 236
 237 #define string_copy(dst, src) \
 238         string_ncopy_do(dst, sizeof(dst), src, sizeof(src))
 239
 240 #define string_ncopy(dst, src, srclen) \
 241         string_ncopy_do(dst, sizeof(dst), src, srclen)
 242
 243 static inline void
 244 string_copy_rev(char *dst, const char *src)
 245 {
 246         size_t srclen;
 247
 248         for (srclen = 0; srclen < SIZEOF_REV; srclen++)
 249                 if (isspace(src[srclen]))
 250                         break;
 251
 252         string_ncopy_do(dst, SIZEOF_REV, src, srclen);
 253 }
 254
 255 #define string_add(dst, from, src) \
 256         string_ncopy_do(dst + (from), sizeof(dst) - (from), src, sizeof(src))
 257
 258 static inline size_t
 259 string_expand(char *dst, size_t dstlen, const char *src, int tabsize)
 260 {
 261         size_t size, pos;
 262
 263         for (size = pos = 0; size < dstlen - 1 && src[pos]; pos++) {
 264                 if (src[pos] == '\t') {
 265                         size_t expanded = tabsize - (size % tabsize);
 266
 267                         if (expanded + size >= dstlen - 1)
 268                                 expanded = dstlen - size - 1;
 269                         memcpy(dst + size, "        ", expanded);
 270                         size += expanded;
 271                 } else {
 272                         dst[size++] = src[pos];
 273                 }
 274         }
 275
 276         dst[size] = 0;
 277         return pos;
 278 }
 279
 280 static inline char *
 281 chomp_string(char *name)
 282 {
 283         int namelen;
 284
 285         while (isspace(*name))
 286                 name++;
 287
 288         namelen = strlen(name) - 1;
 289         while (namelen > 0 && isspace(name[namelen]))
 290                 name[namelen--] = 0;
 291
 292         return name;
 293 }
 294
 295 static inline bool
 296 string_nformat(char *buf, size_t bufsize, size_t *bufpos, const char *fmt, ...)
 297 {
 298         size_t pos = bufpos ? *bufpos : 0;
 299         int retval;
 300
 301         FORMAT_BUFFER(buf + pos, bufsize - pos, fmt, retval, FALSE);
 302         if (bufpos && retval > 0)
 303                 *bufpos = pos + retval;
 304
 305         return pos >= bufsize ? FALSE : TRUE;
 306 }
 307
 308 #define string_format(buf, fmt, args...) \
 309         string_nformat(buf, sizeof(buf), NULL, fmt, args)
 310
 311 #define string_format_from(buf, from, fmt, args...) \
 312         string_nformat(buf, sizeof(buf), from, fmt, args)
 313
 314 static inline int
 315 strcmp_null(const char *s1, const char *s2)
 316 {
 317         if (!s1 || !s2) {
 318                 return (!!s1) - (!!s2);
 319         }
 320
 321         return strcmp(s1, s2);
 322 }
 323
 324 /*
 325  * Enumerations
 326  */
 327
 328 struct enum_map {
 329         const char *name;
 330         int namelen;
 331         int value;
 332 };
 333
 334 #define ENUM_MAP(name, value) { name, STRING_SIZE(name), value }
 335
 336 #define ENUM_SYM_MACRO(prefix, name)    prefix##_##name
 337 #define ENUM_MAP_MACRO(prefix, name)    ENUM_MAP(#name, ENUM_SYM_MACRO(prefix, name))
 338
 339 #define DEFINE_ENUM(name, info) \
 340         enum name { info(ENUM_SYM_MACRO) }; \
 341         static const struct enum_map name##_map[] = { info(ENUM_MAP_MACRO) }
 342
 343 static inline int
 344 string_enum_compare(const char *str1, const char *str2, int len)
 345 {
 346         size_t i;
 347
 348 #define string_enum_sep(x) ((x) == '-' || (x) == '_' || (x) == '.')
 349
 350         /* Diff-Header == DIFF_HEADER */
 351         for (i = 0; i < len; i++) {
 352                 if (ascii_toupper(str1[i]) == ascii_toupper(str2[i]))
 353                         continue;
 354
 355                 if (string_enum_sep(str1[i]) &&
 356                     string_enum_sep(str2[i]))
 357                         continue;
 358
 359                 return str1[i] - str2[i];
 360         }
 361
 362         return 0;
 363 }
 364
 365 #define enum_equals(entry, str, len) \
 366         ((entry).namelen == (len) && !string_enum_compare((entry).name, str, len))
 367
 368 static inline char *
 369 enum_map_name(const char *name, size_t namelen)
 370 {
 371         static char buf[SIZEOF_STR];
 372         int bufpos;
 373
 374         for (bufpos = 0; bufpos <= namelen; bufpos++) {
 375                 buf[bufpos] = ascii_tolower(name[bufpos]);
 376                 if (buf[bufpos] == '_')
 377                         buf[bufpos] = '-';
 378         }
 379
 380         buf[bufpos] = 0;
 381         return buf;
 382 }
 383
 384 #define enum_name(entry) enum_map_name((entry).name, (entry).namelen)
 385
 386 static inline bool
 387 map_enum_do(const struct enum_map *map, size_t map_size, int *value, const char *name)
 388 {
 389         size_t namelen = strlen(name);
 390         int i;
 391
 392         for (i = 0; i < map_size; i++)
 393                 if (enum_equals(map[i], name, namelen)) {
 394                         *value = map[i].value;
 395                         return TRUE;
 396                 }
 397
 398         return FALSE;
 399 }
 400
 401 #define map_enum(attr, map, name) \
 402         map_enum_do(map, ARRAY_SIZE(map), attr, name)
 403
 404 /*
 405  * Unicode / UTF-8 handling
 406  *
 407  * NOTE: Much of the following code for dealing with Unicode is derived from
 408  * ELinks' UTF-8 code developed by Scrool <scroolik@gmail.com>. Origin file is
 409  * src/intl/charset.c from the UTF-8 branch commit elinks-0.11.0-g31f2c28.
 410  */
 411
 412 static inline int
 413 unicode_width(unsigned long c, int tab_size)
 414 {
 415         if (c >= 0x1100 &&
 416            (c <= 0x115f                         /* Hangul Jamo */
 417             || c == 0x2329
 418             || c == 0x232a
 419             || (c >= 0x2e80  && c <= 0xa4cf && c != 0x303f)
 420                                                 /* CJK ... Yi */
 421             || (c >= 0xac00  && c <= 0xd7a3)    /* Hangul Syllables */
 422             || (c >= 0xf900  && c <= 0xfaff)    /* CJK Compatibility Ideographs */
 423             || (c >= 0xfe30  && c <= 0xfe6f)    /* CJK Compatibility Forms */
 424             || (c >= 0xff00  && c <= 0xff60)    /* Fullwidth Forms */
 425             || (c >= 0xffe0  && c <= 0xffe6)
 426             || (c >= 0x20000 && c <= 0x2fffd)
 427             || (c >= 0x30000 && c <= 0x3fffd)))
 428                 return 2;
 429
 430         if (c == '\t')
 431                 return tab_size;
 432
 433         return 1;
 434 }
 435
 436 /* Number of bytes used for encoding a UTF-8 character indexed by first byte.
 437  * Illegal bytes are set one. */
 438 static const unsigned char utf8_bytes[256] = {
 439         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,
 440         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,
 441         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,
 442         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,
 443         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,
 444         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,
 445         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,
 446         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,
 447 };
 448
 449 static inline unsigned char
 450 utf8_char_length(const char *string, const char *end)
 451 {
 452         int c = *(unsigned char *) string;
 453
 454         return utf8_bytes[c];
 455 }
 456
 457 /* Decode UTF-8 multi-byte representation into a Unicode character. */
 458 static inline unsigned long
 459 utf8_to_unicode(const char *string, size_t length)
 460 {
 461         unsigned long unicode;
 462
 463         switch (length) {
 464         case 1:
 465                 unicode  =   string[0];
 466                 break;
 467         case 2:
 468                 unicode  =  (string[0] & 0x1f) << 6;
 469                 unicode +=  (string[1] & 0x3f);
 470                 break;
 471         case 3:
 472                 unicode  =  (string[0] & 0x0f) << 12;
 473                 unicode += ((string[1] & 0x3f) << 6);
 474                 unicode +=  (string[2] & 0x3f);
 475                 break;
 476         case 4:
 477                 unicode  =  (string[0] & 0x0f) << 18;
 478                 unicode += ((string[1] & 0x3f) << 12);
 479                 unicode += ((string[2] & 0x3f) << 6);
 480                 unicode +=  (string[3] & 0x3f);
 481                 break;
 482         case 5:
 483                 unicode  =  (string[0] & 0x0f) << 24;
 484                 unicode += ((string[1] & 0x3f) << 18);
 485                 unicode += ((string[2] & 0x3f) << 12);
 486                 unicode += ((string[3] & 0x3f) << 6);
 487                 unicode +=  (string[4] & 0x3f);
 488                 break;
 489         case 6:
 490                 unicode  =  (string[0] & 0x01) << 30;
 491                 unicode += ((string[1] & 0x3f) << 24);
 492                 unicode += ((string[2] & 0x3f) << 18);
 493                 unicode += ((string[3] & 0x3f) << 12);
 494                 unicode += ((string[4] & 0x3f) << 6);
 495                 unicode +=  (string[5] & 0x3f);
 496                 break;
 497         default:
 498                 return 0;
 499         }
 500
 501         /* Invalid characters could return the special 0xfffd value but NUL
 502          * should be just as good. */
 503         return unicode > 0xffff ? 0 : unicode;
 504 }
 505
 506 /* Calculates how much of string can be shown within the given maximum width
 507  * and sets trimmed parameter to non-zero value if all of string could not be
 508  * shown. If the reserve flag is TRUE, it will reserve at least one
 509  * trailing character, which can be useful when drawing a delimiter.
 510  *
 511  * Returns the number of bytes to output from string to satisfy max_width. */
 512 static inline size_t
 513 utf8_length(const char **start, size_t skip, int *width, size_t max_width, int *trimmed, bool reserve, int tab_size)
 514 {
 515         const char *string = *start;
 516         const char *end = strchr(string, '\0');
 517         unsigned char last_bytes = 0;
 518         size_t last_ucwidth = 0;
 519
 520         *width = 0;
 521         *trimmed = 0;
 522
 523         while (string < end) {
 524                 unsigned char bytes = utf8_char_length(string, end);
 525                 size_t ucwidth;
 526                 unsigned long unicode;
 527
 528                 if (string + bytes > end)
 529                         break;
 530
 531                 /* Change representation to figure out whether
 532                  * it is a single- or double-width character. */
 533
 534                 unicode = utf8_to_unicode(string, bytes);
 535                 /* FIXME: Graceful handling of invalid Unicode character. */
 536                 if (!unicode)
 537                         break;
 538
 539                 ucwidth = unicode_width(unicode, tab_size);
 540                 if (skip > 0) {
 541                         skip -= ucwidth <= skip ? ucwidth : skip;
 542                         *start += bytes;
 543                 }
 544                 *width  += ucwidth;
 545                 if (*width > max_width) {
 546                         *trimmed = 1;
 547                         *width -= ucwidth;
 548                         if (reserve && *width == max_width) {
 549                                 string -= last_bytes;
 550                                 *width -= last_ucwidth;
 551                         }
 552                         break;
 553                 }
 554
 555                 string  += bytes;
 556                 last_bytes = ucwidth ? bytes : 0;
 557                 last_ucwidth = ucwidth;
 558         }
 559
 560         return string - *start;
 561 }
 562
 563 #endif