listener/AnsiColorLogger.php
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
- Author
- Hans Lellelid
(Phing) - Author
- Magesh Umasankar (Ant)
- Package
- phing.listener
- Version
- $Id$
\AnsiColorLogger
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 < \StreamRequiredBuildLogger < \BuildLogger < \BuildListener
- Author
- Hans Lellelid
(Phing) - Author
- Magesh Umasankar (Ant)
- Copyright
- 2001,2002 THYRELL. All rights reserved
- Version
- $Id$
Constants

LEFT_COLUMN_SIZE
= 12
Size of the left column in output. The default char width is 12.
Inherited from: \DefaultLogger::LEFT_COLUMN_SIZE@var int
- Inherited_from
- \DefaultLogger::LEFT_COLUMN_SIZE
Properties


\OutputStream
$err= ''
- Type
- \OutputStream
- Inherited_from
- \DefaultLogger::$$err


$msgOutputLevel= 'Project::MSG_ERR'
The message output level that should be used. The default is <code>Project::MSG_VERBOSE</code>.
Inherited from: \DefaultLogger::$$msgOutputLevel@var int
Project::MSG_ERR
Details- Type
- n/a
- Inherited_from
- \DefaultLogger::$$msgOutputLevel


\OutputStream
$out= ''
- Type
- \OutputStream
- Inherited_from
- \DefaultLogger::$$out
Methods


__construct(
)
:
void
Construct new AnsiColorLogger Perform initializations that cannot be done in var declarations.


buildFinished(
$event
)
:
void
Prints whether the build succeeded or failed, and any errors that occured during the build. Also outputs the total build-time.
Inherited from: \DefaultLogger::buildFinished()@param object The BuildEvent
Name | Type | Description |
---|---|---|
$event |


buildStarted(
$event
)
:
void
Sets the start-time when the build started. Used for calculating the build-time.
Inherited from: \DefaultLogger::buildStarted()@param object The BuildEvent
Name | Type | Description |
---|---|---|
$event |
- Access
- public


formatTime(
$micros
)
:
void
Formats a time micro integer to human readable format.
Inherited from: \DefaultLogger::formatTime()@param integer The time stamp
Name | Type | Description |
---|---|---|
$micros |
- Access
- private


getBuildFailedMessage(
)
:
string
Get the message to return when a build failed.
Inherited from: \DefaultLogger::getBuildFailedMessage()Type | Description |
---|---|
string | The classic "BUILD FAILED" |


getBuildSuccessfulMessage(
)
:
string
Get the message to return when a build succeeded.
Inherited from: \DefaultLogger::getBuildSuccessfulMessage()Type | Description |
---|---|
string | The classic "BUILD FINISHED" |


messageLogged(
$event
)
:
void
@param object The BuildEvent
Name | Type | Description |
---|---|---|
$event |
- Access
- public
- See
- \BuildEvent::getMessage()


printMessage(
string $message, \OutputStream $stream, int $priority
)
:
void
Prints a message to console.
Name | Type | Description |
---|---|---|
$message | string | |
$stream | \OutputStream | |
$priority | int |
- See
- \DefaultLogger#printMessage


setColors(
)
:
void
Set the colors to use from a property file specified by the special ant property ant.logger.defaults


setErrorStream(
\OutputStream $err
)
:
void
Name | Type | Description |
---|---|---|
$err | \OutputStream |
- See
- \BuildLogger#setErrorStream()


setMessageOutputLevel(
int $level
)
:
void
Set the msgOutputLevel this logger is to respond to.
Inherited from: \DefaultLogger::setMessageOutputLevel()Only messages with a message level lower than or equal to the given level are output to the log.
<
p> Constants for the message levels are in Project.php. The order of the levels, from least to most verbose, is:
- Project::MSG_ERR
- Project::MSG_WARN
- Project::MSG_INFO
- Project::MSG_VERBOSE
- Project::MSG_DEBUG
The default message level for DefaultLogger is Project::MSG_ERR.
Name | Type | Description |
---|---|---|
$level | int | The logging level for the logger. |
- See
- \BuildLogger#setMessageOutputLevel()


setOutputStream(
\OutputStream $output
)
:
void
Name | Type | Description |
---|---|---|
$output | \OutputStream |
- See
- \BuildLogger#setOutputStream()


targetFinished(
$event
)
:
void
Fired when a target has finished. We don't need specific action on this event. So the methods are empty.
Inherited from: \DefaultLogger::targetFinished()@param object The BuildEvent
Name | Type | Description |
---|---|---|
$event |


targetStarted(
$event
)
:
void
@param object The BuildEvent
Name | Type | Description |
---|---|---|
$event |
- Access
- public
- See
- \BuildEvent::getTarget()


taskFinished(
$event
)
:
void
Fired when a task has finished. We don't need specific action on this event. So the methods are empty.
Inherited from: \DefaultLogger::taskFinished()@param object The BuildEvent
Name | Type | Description |
---|---|---|
$event |
- Access
- public
- See
- \BuildEvent::getException()


taskStarted(
$event
)
:
void
Fired when a task is started. We don't need specific action on this event. So the methods are empty.
Inherited from: \DefaultLogger::taskStarted()@param object The BuildEvent
Name | Type | Description |
---|---|---|
$event |
- Access
- public
- See
- \BuildEvent::getTask()