listener/AnsiColorLogger.php

Show: inherited
Table of Contents

\AnsiColorLogger

Package: phing\listener

Uses ANSI Color Code Sequences to colorize messages sent to the console.

If used with the -logfile option, the output file will contain all the necessary escape codes to display the text in colorized mode when displayed in the console using applications like cat, more, etc.

This is designed to work on terminals that support ANSI color codes. It works on XTerm, ETerm, Mindterm, etc. It also works on Win9x (with ANSI.SYS loaded.)

NOTE: It doesn't work on WinNT's COMMAND.COM even with ANSI.SYS loaded.

The default colors used for differentiating the message levels can be changed by editing the phing/listener/defaults.properties file.

This file contains 5 key/value pairs: AnsiColorLogger.ERROR_COLOR=2;31 AnsiColorLogger.WARNING_COLOR=2;35 AnsiColorLogger.INFO_COLOR=2;36 AnsiColorLogger.VERBOSE_COLOR=2;32 AnsiColorLogger.DEBUG_COLOR=2;34

Another option is to pass a system variable named ant.logger.defaults, with value set to the path of the file that contains user defined Ansi Color Codes, to the java command using -D option.

To change these colors use the following chart:

 <B>ANSI COLOR LOGGER CONFIGURATION</B>

Format for AnsiColorLogger.*= Attribute;Foreground;Background

Attribute is one of the following: 0 -> Reset All Attributes (return to normal mode) 1 -> Bright (Usually turns on BOLD) 2 -> Dim 3 -> Underline 5 -> link 7 -> Reverse 8 -> Hidden

Foreground is one of the following: 30 -> Black 31 -> Red 32 -> Green 33 -> Yellow 34 -> Blue 35 -> Magenta 36 -> Cyan 37 -> White

Background is one of the following: 40 -> Black 41 -> Red 42 -> Green 43 -> Yellow 44 -> Blue 45 -> Magenta 46 -> Cyan 47 -> White

Parent(s)
\DefaultLogger
Author
Hans Lellelid (Phing)  
Author
Magesh Umasankar (Ant)  
Version
$Revision: 526 $  

Constants

Constant  ATTR_NORMAL = 0
Constant  ATTR_BRIGHT = 1
Constant  ATTR_DIM = 2
Constant  ATTR_UNDERLINE = 3
Constant  ATTR_BLINK = 5
Constant  ATTR_REVERSE = 7
Constant  ATTR_HIDDEN = 8
Constant  FG_BLACK = 30
Constant  FG_RED = 31
Constant  FG_GREEN = 32
Constant  FG_YELLOW = 33
Constant  FG_BLUE = 34
Constant  FG_MAGENTA = 35
Constant  FG_CYAN = 36
Constant  FG_WHITE = 37
Constant  BG_BLACK = 40
Constant  BG_RED = 41
Constant  BG_GREEN = 42
Constant  BG_YELLOW = 44
Constant  BG_BLUE = 44
Constant  BG_MAGENTA = 45
Constant  BG_CYAN = 46
Constant  BG_WHITE = 47
Constant  PREFIX = "\x1b["
Constant  SUFFIX = "m"
Constant  SEPARATOR = ';'
Constant  END_COLOR = "\x1b[m"

Properties

Propertyprivate  $colorsSet= 'false'
Default valuefalseDetails
Type
n/a
Propertyprivate  $debugColor= ''
Details
Type
n/a
Propertyprivate  $errColor= ''
Details
Type
n/a
Propertyprivate  $infoColor= ''
Details
Type
n/a
Propertyprivate  $verboseColor= ''
Details
Type
n/a
Propertyprivate  $warnColor= ''
Details
Type
n/a

Methods

methodpublic__construct( ) : void

Construct new AnsiColorLogger Perform initializations that cannot be done in var declarations.

methodpublicbuildFinished( ) : void

methodpublicbuildStarted( ) : void

methodpublicformatTime( ) : void
static

methodprotectedgetBuildFailedMessage( ) : void

methodprotectedgetBuildSuccessfulMessage( ) : void

methodpublicmessageLogged( ) : void

methodprotectedprintMessage( string $message, \OutputStream $stream, int $priority ) : void
final

Parameters
Name Type Description
$message string
$stream \OutputStream
$priority int
Details
See
\DefaultLogger#printMessage  
methodprivatesetColors( ) : void
final

Set the colors to use from a property file specified by the special ant property ant.logger.defaults

methodpublicsetErrorStream( ) : void

methodpublicsetMessageOutputLevel( ) : void

methodpublicsetOutputStream( ) : void

methodpublictargetFinished( ) : void

methodpublictargetStarted( ) : void

methodpublictaskFinished( ) : void

methodpublictaskStarted( ) : void

Documentation was generated by DocBlox 0.17.1.