Skip to content

add option --color and do not show colors when the output is not a tty #106

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed

add option --color and do not show colors when the output is not a tty #106

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions man/tldr.1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,9 @@ select platform, supported are \fIlinux\fR / \fIosx\fR / \fIsunos\fR / \fIwindow
.TP
.BR \-r ", " \-\-render=\fIPATH\fR
render a local page for testing purposes
.TP
.BR \-C ", " \-\-color
force color display even if the output is not a tty
.SH EXIT STATUS
0 on success, any other positive value otherwise
.SH SEE ALSO
Expand Down
40 changes: 21 additions & 19 deletions src/parser.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,8 +59,9 @@ construct_path(char *buf, size_t buflen, char const *home, char const *input,
}

int
parse_tldrpage(char const *input)
parse_tldrpage(char const *input, int print_color)
{
#define WHEN_COLOR if (print_color)
char c;
int i, len;
int start = -1;
Expand All @@ -74,40 +75,40 @@ parse_tldrpage(char const *input)
switch (c) {
case '>':
start = i;
fprintf(stdout, "%s", ANSI_COLOR_EXPLANATION_FG);
WHEN_COLOR fprintf(stdout, "%s", ANSI_COLOR_EXPLANATION_FG);
continue;

case '-':
start = i;
fprintf(stdout, "%s", ANSI_COLOR_COMMENT_FG);
WHEN_COLOR fprintf(stdout, "%s", ANSI_COLOR_COMMENT_FG);
continue;

case '`':
start = i;
fprintf(stdout, "%s", ANSI_COLOR_CODE_FG);
WHEN_COLOR fprintf(stdout, "%s", ANSI_COLOR_CODE_FG);
fprintf(stdout, " ");
continue;

case '#':
start = i;
fprintf(stdout, "%s", ANSI_BOLD_ON);
fprintf(stdout, "%s", ANSI_COLOR_TITLE_FG);
WHEN_COLOR fprintf(stdout, "%s", ANSI_BOLD_ON);
WHEN_COLOR fprintf(stdout, "%s", ANSI_COLOR_TITLE_FG);
continue;
}
} else if (start > -1) {
if (input[i] == '{' && input[i + 1] == '{') {
fprintf(stdout, "%.*s", i - (start + 1), input + (start + 1));
fprintf(stdout, "%s", ANSI_BOLD_OFF);
fprintf(stdout, "%s", ANSI_COLOR_RESET_FG);
fprintf(stdout, "%s", ANSI_COLOR_CODE_PLACEHOLDER_FG);
WHEN_COLOR fprintf(stdout, "%s", ANSI_BOLD_OFF);
WHEN_COLOR fprintf(stdout, "%s", ANSI_COLOR_RESET_FG);
WHEN_COLOR fprintf(stdout, "%s", ANSI_COLOR_CODE_PLACEHOLDER_FG);

start = i;
for (i = i + 1; i < len; i++) {
if (input[i] == '}' && input[i + 1] == '}') {
fprintf(stdout, "%.*s", i - (start + 2),
input + (start + 2));
fprintf(stdout, "%s", ANSI_COLOR_RESET_FG);
fprintf(stdout, "%s", ANSI_COLOR_CODE_FG);
WHEN_COLOR fprintf(stdout, "%s", ANSI_COLOR_RESET_FG);
WHEN_COLOR fprintf(stdout, "%s", ANSI_COLOR_CODE_FG);
start = i + 1;
break;
}
Expand All @@ -128,19 +129,20 @@ parse_tldrpage(char const *input)
fprintf(stdout, "%.*s\n", i - (start + 2), input + (start + 2));
}

fprintf(stdout, "%s", ANSI_BOLD_OFF);
fprintf(stdout, "%s", ANSI_COLOR_RESET_FG);
WHEN_COLOR fprintf(stdout, "%s", ANSI_BOLD_OFF);
WHEN_COLOR fprintf(stdout, "%s", ANSI_COLOR_RESET_FG);
fprintf(stdout, "\n");
start = -1;
}
}

fprintf(stdout, "\n");
return 0;
#undef WHEN_COLOR
}

int
print_tldrpage(char const *input, char const *poverride)
print_tldrpage(char const *input, char const *poverride, int color)
{
char *output;
char url[URLBUFSIZ];
Expand Down Expand Up @@ -178,15 +180,15 @@ print_tldrpage(char const *input, char const *poverride)
construct_path(url, URLBUFSIZ, homedir, input, platform);
if (stat(url, &sb) == 0 && S_ISREG(sb.st_mode)) {
if (!get_file_content(url, &output, 0)) {
parse_tldrpage(output);
parse_tldrpage(output, color);
free(output);
return 0;
}
} else {
construct_path(url, URLBUFSIZ, homedir, input, "common");
if (stat(url, &sb) == 0 && S_ISREG(sb.st_mode)) {
if (!get_file_content(url, &output, 0)) {
parse_tldrpage(output);
parse_tldrpage(output, color);
free(output);
return 0;
}
Expand All @@ -209,7 +211,7 @@ print_tldrpage(char const *input, char const *poverride)
return 1;
}

parse_tldrpage(output);
parse_tldrpage(output, color);

free(output);

Expand Down Expand Up @@ -293,11 +295,11 @@ parse_tldrlist(char const *path, char const *platform)
}

int
print_localpage(char const *path)
print_localpage(char const *path, int color)
{
char *output = NULL;
if (!get_file_content(path, &output, 0)) {
parse_tldrpage(output);
parse_tldrpage(output, color);
free(output);
return 0;
}
Expand Down
17 changes: 14 additions & 3 deletions src/tldr.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ static int clear_flag;
static int platform_flag;
static int list_flag;
static int render_flag;
static int color_flag;
static char pbuf[STRBUFSIZ];
static struct option long_options[] = {
{ "help", no_argument, &help_flag, 1 },
Expand All @@ -46,7 +47,8 @@ static struct option long_options[] = {
{ "osx", no_argument, 0, 'p' },
{ "sunos", no_argument, 0, 'p' },
{ "list", no_argument, &list_flag, 'l'},
{ "render", required_argument, 0, 'r'}, {0, 0, 0, 0 }
{ "render", required_argument, 0, 'r'},
{ "color", no_argument, &color_flag, 'C' }, {0, 0, 0, 0 }
};

int
Expand All @@ -61,6 +63,9 @@ main(int argc, char **argv)
return EXIT_FAILURE;
}

/* show colors when the output is a tty */
color_flag = isatty(fileno(stdout));

while (1) {
option_index = 0;
c = getopt_long_only(argc, argv, "v", long_options, &option_index);
Expand Down Expand Up @@ -108,6 +113,10 @@ main(int argc, char **argv)
render_flag = 1;
} break;

case 'C': {
color_flag = 1;
} break;

default:
abort();
}
Expand Down Expand Up @@ -150,7 +159,7 @@ main(int argc, char **argv)
return EXIT_SUCCESS;
}
if (render_flag) {
if (print_localpage(pbuf))
if (print_localpage(pbuf, 1))
return EXIT_FAILURE;
return EXIT_SUCCESS;
}
Expand All @@ -174,7 +183,7 @@ main(int argc, char **argv)

if (!has_localdb())
update_localdb(verbose_flag);
if (print_tldrpage(buf, pbuf[0] != 0 ? pbuf : NULL)) {
if (print_tldrpage(buf, pbuf[0] != 0 ? pbuf : NULL, color_flag)) {
fprintf(stdout, "This page doesn't exist yet!\n");
fprintf(stdout, "Submit new pages here: https://github.com/tldr-pages/tldr\n");
if (getenv(PREVENT_UPDATE_ENV_VARIABLE)) {
Expand Down Expand Up @@ -222,6 +231,8 @@ print_usage(char const *arg)
fprintf(stdout, " %-20s %-30s\n", "--sunos", "show command page for SunOS");
fprintf(stdout, " %-20s %-30s\n", "-r, --render=PATH",
"render a local page for testing purposes");
fprintf(stdout, " %-20s %-30s\n", "-C, --color",
"force color display");
/* *INDENT-ON* */
}

6 changes: 3 additions & 3 deletions src/tldr.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,11 +71,11 @@ int construct_url (char *buf, size_t buflen,
char const *platform);
int construct_path (char *buf, size_t buflen, char const *home,
char const *input, char const *platform);
int parse_tldrpage (char const *input);
int print_tldrpage (char const *input, char const *platform);
int parse_tldrpage (char const *input, int color);
int print_tldrpage (char const *input, char const *platform, int color);
int print_tldrlist (char const *platform);
int parse_tldrlist (char const *path, char const *platform);
int print_localpage (char const *path);
int print_localpage (char const *path, int color);

/* utils.c */
#define RMOPT_IGNORE_NOFILE (0x1)
Expand Down