ansi.h File Reference

ANSI Colours. More...

#include <stdbool.h>
#include "attr.h"

Include dependency graph for ansi.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	AnsiColor
	An ANSI escape sequence. More...

Functions
int	ansi_color_parse (const char *str, struct AnsiColor *ansi, struct AttrColorList *acl, bool dry_run)
	Parse a string of ANSI escape sequence.

Detailed Description

ANSI Colours.

Authors

• Richard Russon

Copyright

This program 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 2 of the License, or (at your option) any later version.

This program 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 http://www.gnu.org/licenses/.

Definition in file ansi.h.

Function Documentation

ansi_color_parse()

int ansi_color_parse	(	const char *	str,
		struct AnsiColor *	ansi,
		struct AttrColorList *	acl,
		bool	dry_run
	)

Parse a string of ANSI escape sequence.

Parameters

str	String to parse
ansi	AnsiColor for the result
acl	List to store the unique colours
dry_run	If true, parse but don't save the sequence

Return values

num	Total length of the escape sequences

Parse (multiple) ANSI sequence(s) into ansi. If the colour hasn't been seen before, store the it in acl.

Definition at line 118 of file ansi.c.

{
  int seq_len = 0;
  int total_len = 0;
 
  while ((seq_len = ansi_color_parse_single(str + total_len, ansi, dry_run)) != 0)
  {
    total_len += seq_len;
  }
 
  ansi_color_list_add(acl, ansi);
 
  return total_len;
}

Here is the call graph for this function:

Here is the caller graph for this function: