fish-shell/src/output.h

// Generic output functions.
//
// Constants for various character classifications. Each character of a command string can be
// classified as one of the following types.
#ifndef FISH_OUTPUT_H
#define FISH_OUTPUT_H

#include <stddef.h>

#include <vector>

#include "color.h"
#include "fallback.h"  // IWYU pragma: keep

class env_var_t;

void set_color(rgb_color_t c, rgb_color_t c2);

void writembs_check(const char *mbs, const char *mbs_name, bool critical, const char *file, long line);
#define writembs(mbs) writembs_check((mbs), #mbs, true, __FILE__, __LINE__)
#define writembs_nofail(mbs) writembs_check((mbs), #mbs, false, __FILE__, __LINE__)

int writech(wint_t ch);

void writestr(const wchar_t *str);

rgb_color_t parse_color(const env_var_t &val, bool is_background);

int writeb(tputs_arg_t b);

void output_set_writer(int (*writer)(char));

int (*output_get_writer())(char);

/// Sets what colors are supported.
enum { color_support_term256 = 1 << 0, color_support_term24bit = 1 << 1 };
typedef unsigned int color_support_t;
color_support_t output_get_color_support();
void output_set_color_support(color_support_t support);

rgb_color_t best_color(const std::vector<rgb_color_t> &colors, color_support_t support);

bool write_color(rgb_color_t color, bool is_fg);
unsigned char index_for_color(rgb_color_t c);

#endif
restyle output module to match project style Reduces lint errors from 34 to 31 (-9%). Line count from 712 to 535 (-25%). Another step in resolving issue #2902. 2016-05-02 05:29:21 +00:00			`// Generic output functions.`
			`//`
			`// Constants for various character classifications. Each character of a command string can be`
			`// classified as one of the following types.`
Add header guards to the header files. darcs-hash:20051004151139-35ec8-7af69b9d7647d145dc621f7eaea726e729cff554.gz 2005-10-04 15:11:39 +00:00			`#ifndef FISH_OUTPUT_H`
			`#define FISH_OUTPUT_H`

restyle output module to match project style Reduces lint errors from 34 to 31 (-9%). Line count from 712 to 535 (-25%). Another step in resolving issue #2902. 2016-05-02 05:29:21 +00:00			`#include <stddef.h>`
implement our own `assert()` function I recently upgraded the software on my macOS server and was dismayed to see that cppcheck reported a huge number of format string errors due to mismatches between the format string and its arguments from calls to `assert()`. It turns out they are due to the macOS header using `%lu` for the line number which is obviously wrong since it is using the C preprocessor `__LINE__` symbol which evaluates to a signed int. I also noticed that the macOS implementation writes to stdout, rather than stderr. It also uses `printf()` which can be a problem on some platforms if the stream is already in wide mode which is the normal case for fish. So implement our own `assert()` implementation. This also eliminates double-negative warnings that we get from some of our calls to `assert()` on some platforms by oclint. Also reimplement the `DIE()` macro in terms of our internal implementation. Rewrite `assert(0 && msg)` statements to `DIE(msg)` for clarity and to eliminate oclint warnings about constant expressions. Fixes #3276, albeit not in the fashion I originally envisioned. 2017-02-14 04:37:27 +00:00
restyle output module to match project style Reduces lint errors from 34 to 31 (-9%). Line count from 712 to 535 (-25%). Another step in resolving issue #2902. 2016-05-02 05:29:21 +00:00			`#include <vector>`
add better support for IWYU and fix things Remove the "make iwyu" build target. Move the functionality into the recently introduced lint.fish script. Fix a lot, but not all, of the include-what-you-use errors. Specifically, it fixes all of the IWYU errors on my OS X server but only removes some of them on my Ubuntu 14.04 server. Fixes #2957 2016-04-21 06:00:54 +00:00
restyle output module to match project style Reduces lint errors from 34 to 31 (-9%). Line count from 712 to 535 (-25%). Another step in resolving issue #2902. 2016-05-02 05:29:21 +00:00			`#include "color.h"`
add better support for IWYU and fix things Remove the "make iwyu" build target. Move the functionality into the recently introduced lint.fish script. Fix a lot, but not all, of the include-what-you-use errors. Specifically, it fixes all of the IWYU errors on my OS X server but only removes some of them on my Ubuntu 14.04 server. Fixes #2957 2016-04-21 06:00:54 +00:00			`#include "fallback.h" // IWYU pragma: keep`
Add header guards to the header files. darcs-hash:20051004151139-35ec8-7af69b9d7647d145dc621f7eaea726e729cff554.gz 2005-10-04 15:11:39 +00:00
change env_var_t to a vector of strings Internally fish should store vars as a vector of elements. The current flat string representation is a holdover from when the code was written in C. Fixes #4200 2017-08-05 22:08:39 +00:00			`class env_var_t;`

Color work 2012-02-12 01:07:56 +00:00			`void set_color(rgb_color_t c, rgb_color_t c2);`
Initial revision darcs-hash:20050920132639-ac50b-fa3b476891e1f5f67207cf4cc7bf623834cc5edc.gz 2005-09-20 13:26:39 +00:00
Make a few methods const This helps on netbsd, because enter_standout_mode et al are const there. These methods don't alter their argument, so they should have been const to begin with. 2018-12-12 10:39:37 +00:00			`void writembs_check(const char mbs, const char mbs_name, bool critical, const char *file, long line);`
Prevent fish from crashing if non-essential terminfo strings not found On systems where the terminfo for TERM does not contain a string for attributes such as enter_underline_mode, etc. fish was crashing with a fatal error message and a note to email the developers. These are non-essential text attribute changes and should not trigger such a failure. 2018-06-18 01:59:34 +00:00			`#define writembs(mbs) writembs_check((mbs), #mbs, true, __FILE__, __LINE__)`
			`#define writembs_nofail(mbs) writembs_check((mbs), #mbs, false, __FILE__, __LINE__)`
Initial revision darcs-hash:20050920132639-ac50b-fa3b476891e1f5f67207cf4cc7bf623834cc5edc.gz 2005-09-20 13:26:39 +00:00
Apply new indentation, brace, and whitespace style 2012-11-19 00:30:30 +00:00			`int writech(wint_t ch);`
Initial revision darcs-hash:20050920132639-ac50b-fa3b476891e1f5f67207cf4cc7bf623834cc5edc.gz 2005-09-20 13:26:39 +00:00
Apply new indentation, brace, and whitespace style 2012-11-19 00:30:30 +00:00			`void writestr(const wchar_t *str);`
Initial revision darcs-hash:20050920132639-ac50b-fa3b476891e1f5f67207cf4cc7bf623834cc5edc.gz 2005-09-20 13:26:39 +00:00
make `tokenize_variable_array()` private Another step towards implementing issue #4200 is to make the `tokenize_variable_array()` function private to the env.cpp module. 2017-08-06 04:40:27 +00:00			`rgb_color_t parse_color(const env_var_t &val, bool is_background);`
Initial revision darcs-hash:20050920132639-ac50b-fa3b476891e1f5f67207cf4cc7bf623834cc5edc.gz 2005-09-20 13:26:39 +00:00
Apply new indentation, brace, and whitespace style 2012-11-19 00:30:30 +00:00			`int writeb(tputs_arg_t b);`
Move the move_cursor and writeb functions to output.c, and make the output function used by output.c configurable darcs-hash:20060216134025-ac50b-360d4816ee2c3f2ffdc8e5660502cb97b31d699e.gz 2006-02-16 13:40:25 +00:00
Apply new indentation, brace, and whitespace style 2012-11-19 00:30:30 +00:00			`void output_set_writer(int (*writer)(char));`
Move the move_cursor and writeb functions to output.c, and make the output function used by output.c configurable darcs-hash:20060216134025-ac50b-360d4816ee2c3f2ffdc8e5660502cb97b31d699e.gz 2006-02-16 13:40:25 +00:00
restyle output module to match project style Reduces lint errors from 34 to 31 (-9%). Line count from 712 to 535 (-25%). Another step in resolving issue #2902. 2016-05-02 05:29:21 +00:00			`int (*output_get_writer())(char);`
First stab at multiline editing darcs-hash:20061001160258-ac50b-1a760913e64b96e30ff321d7fbe4069ca161cdfe.gz 2006-10-01 16:02:58 +00:00
restyle output module to match project style Reduces lint errors from 34 to 31 (-9%). Line count from 712 to 535 (-25%). Another step in resolving issue #2902. 2016-05-02 05:29:21 +00:00			`/// Sets what colors are supported.`
			`enum { color_support_term256 = 1 << 0, color_support_term24bit = 1 << 1 };`
Initial work to support for term-24bit ("true color") 2014-09-19 22:37:31 +00:00			`typedef unsigned int color_support_t;`
			`color_support_t output_get_color_support();`
			`void output_set_color_support(color_support_t support);`
Support for setting both RGB and named colors on the same line, so the same config can work for multiple term types 2012-02-13 17:52:17 +00:00
Make set_color take multiple colors, and choose the best supported one As suggested in #1323 2014-11-10 00:42:35 +00:00			`rgb_color_t best_color(const std::vector<rgb_color_t> &colors, color_support_t support);`

Stop swallowing the cartesian product This should work: > env TERM=vt100 ./fish -c 'echo (set_color red)"hi"' We do a ::reset() if setting the color doesn't happen. Fixes #2951 2016-07-23 20:40:01 +00:00			`bool write_color(rgb_color_t color, bool is_fg);`
First stab at builtin set_color. Moved set_color.cpp to builtin_set_color.cpp and taught fish about it. 2013-02-14 23:50:24 +00:00			`unsigned char index_for_color(rgb_color_t c);`

Add header guards to the header files. darcs-hash:20051004151139-35ec8-7af69b9d7647d145dc621f7eaea726e729cff554.gz 2005-10-04 15:11:39 +00:00			`#endif`