mshcolorfunctions | Channel 9

Summary: MSH Color Functions

Shown below are two functions that allow you to control the console's colors from scripts or the command line.

As for using the functions... personally, I just dumped them into my profile.msh, but you're welcome to stick them where you please.

Also, I've included a cool example of a custom prompt at the bottom that uses these color functions.

Enjoy.

		 #
		 # MSH Color Functions
		 #
		 # Author:  Daniel Keep
		 # Email:   $("nobots.daniel.keep@gmail.com").substring(7)
		 # Version: 1.0
		 # License: BSD
		 #
		 # This script contains two functions which can be used
		 # to easily set the console foreground and background
		 # colors.  The error-handling is rudimentary AT BEST.
		 #
		 # A nice addition would be a "color echo" function that
		 # allows you to use ANSI escape sequences (or something
		 # comparable).
		 #
		 #
		 # Copyright (c) 2005, Daniel Keep
		 # All rights reserved.
		 # 
		 # Redistribution and use in source and binary forms, with
		 # or without modification, are permitted provided that the
		 # following conditions are met:
		 # 
		 #     * Redistributions of source code must retain the
		 #       above copyright notice, this list of conditions and
		 #       the following disclaimer.
		 #     * Redistributions in binary form must reproduce the
		 #       above copyright notice, this list of conditions and
		 #       the following disclaimer in the documentation and/or
		 #       other materials provided with the distribution.
		 #     * Neither the name of the copyright holder nor the
		 #       names of any contributors may be used to endorse or
		 #       promote products derived from this software without
		 #       specific prior written permission.
		 # 
		 # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
		 # CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED
		 # WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
		 # WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
		 # PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
		 # OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
		 # INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
		 # (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
		 # GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
		 # BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
		 # LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
		 # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
		 # OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
		 # POSSIBILITY OF SUCH DAMAGE.
		 #

		 #
		 # set-foreground [ bright | dark ] COLOR
		 # 
		 # Sets the console's foreground color to the specified color.
		 # 
		 # The "bright" and "dark" arguments specify if the color should
		 # be intense (bright) or not (dark).  If omitted, "dark" is
		 #  assumed.
		 # 
		 # Valid colors are: black, blue, green, aqua, red, purple,
		 #                   yellow and white.
		 #

		 function set-foreground
		 {
		     $local:color = $Args[0].ToLower()
		     $local:offset = 0
		     $local:value = 0

		     if( $local:color -ieq "bright" )
		     {
		         $local:color = $args[1].ToLower()
		         $local:offset = 8
		     }
		     elseif( $local:color -ieq "dark" )
		     {
		         $local:color = $args[1].tolower()
		         $local:offset = 0
		     }

		     if( $local:color -eq -1 )
		     {
		         echo "Usage: set-foreground [ dark | bright ] COLOR"
		         echo "  Valid colors are: black, blue, green, aqua,"
		         echo "                    red, purple, yellow and white."
		     }

		     switch( $local:color )
		     {
		         black { $local:value = 0 }
		         blue { $local:value = 1 }
		         green { $local:value = 2 }
		         aqua { $local:value = 3 }
		         red { $local:value = 4 }
		         purple { $local:value = 5 }
		         yellow { $local:value = 6 }
		         white { $local:value = 7 }
		     }

		     [$MshHost.ui.rawui.foregroundColor] = $local:value + $local:offset
		 }

		 #
		 # set-background [ bright | dark ] COLOR
		 # 
		 # Sets the console's background color to the specified color.
		 # 
		 # The "bright" and "dark" arguments specify if the color should
		 # be intense (bright) or not (dark).  If omitted, "dark" is
		 #  assumed.
		 # 
		 # Valid colors are: black, blue, green, aqua, red, purple,
		 #                   yellow and white.
		 #

		 function set-background
		 {
		     $local:color = $Args[0].ToLower()
		     $local:offset = 0
		     $local:value = 0

		     if( $local:color -ieq "bright" )
		     {
		         $local:color = $args[1].ToLower()
		         $local:offset = 8
		     }
		     elseif( $local:color -ieq "dark" )
		     {
		         $local:color = $args[1].tolower()
		         $local:offset = 0
		     }

		     if( $local:color -eq -1 )
		     {
		         echo "Usage: set-background [ dark | bright ] COLOR"
		         echo "  Valid colors are: black, blue, green, aqua,"
		         echo "                    red, purple, yellow and white."
		     }

		     switch( $local:color )
		     {
		         black { $local:value = 0 }
		         blue { $local:value = 1 }
		         green { $local:value = 2 }
		         aqua { $local:value = 3 }
		         red { $local:value = 4 }
		         purple { $local:value = 5 }
		         yellow { $local:value = 6 }
		         white { $local:value = 7 }
		     }

		     [$MshHost.ui.rawui.backgroundColor] = $local:value + $local:offset
		 }

		 #
		 # Here is an example of what you can do with this.  This replicates
		 # the cool prompt that comes with the default installation of
		 # Cygwin (http://www.cygwin.com/) in full color!
		 # 
		 # To use it, just copy both the above color functions, and the below
		 # prompt function into your profile.msh (just paste it in at the end),
		 # and then uncomment the prompt function below.
		 #

		 #function prompt
		 #{
		 #    $user = $env:username
		 #    $host = $(get-hostname).hostname
		 #    $loc = get-location
		 #    
		 #    # Since write-object doesn't allow us to supress the
		 #    # trailing newline (at least, the help doesn't SAY it
		 #    # does), we'll cheat a bit and use write-host for the
		 #    # first line, then write-object for the last.
		 #    #
		 #    # Just FYI, if you don't write an object into the
		 #    # pipeline at some point, MSH seems to output it's
		 #    # default prompt automatically.
		 #    
		 #    set-foreground green
		 #    write-host -n "`n$user@$host "
		 #    set-foreground yellow
		 #    write-host -n "$loc`n"
		 #    set-foreground white
		 #    write-object "`$ "
		 #}

Summary%3a MSH Color Functions
 
Shown below are two functions that allow you to control the console%27s colors from scripts or the command line.
 
As for using the functions... personally%2c I just dumped them into my profile.msh%2c but you%27re welcome to stick them where you please.
 
Also%2c I%27ve included a cool example of a custom prompt at the bottom that uses these color functions.
 
Enjoy.
 
----
 
%7b%7b
 %23
 %23 MSH Color Functions
 %23
 %23 Author%3a  Daniel Keep
 %23 Email%3a   %24%28%22nobots.daniel.keep@gmail.com%22%29.substring%287%29
 %23 Version%3a 1.0
 %23 License%3a BSD
 %23
 %23 This script contains two functions which can be used
 %23 to easily set the console foreground and background
 %23 colors.  The error-handling is rudimentary AT BEST.
 %23
 %23 A nice addition would be a %22color echo%22 function that
 %23 allows you to use ANSI escape sequences %28or something
 %23 comparable%29.
 %23
 %23
 %23 Copyright %28c%29 2005%2c Daniel Keep
 %23 All rights reserved.
 %23 
 %23 Redistribution and use in source and binary forms%2c with
 %23 or without modification%2c are permitted provided that the
 %23 following conditions are met%3a
 %23 
 %23     * Redistributions of source code must retain the
 %23       above copyright notice%2c this list of conditions and
 %23       the following disclaimer.
 %23     * Redistributions in binary form must reproduce the
 %23       above copyright notice%2c this list of conditions and
 %23       the following disclaimer in the documentation and/or
 %23       other materials provided with the distribution.
 %23     * Neither the name of the copyright holder nor the
 %23       names of any contributors may be used to endorse or
 %23       promote products derived from this software without
 %23       specific prior written permission.
 %23 
 %23 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
 %23 CONTRIBUTORS %22AS IS%22 AND ANY EXPRESS OR IMPLIED
 %23 WARRANTIES%2c INCLUDING%2c BUT NOT LIMITED TO%2c THE IMPLIED
 %23 WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 %23 PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 %23 OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT%2c INDIRECT%2c
 %23 INCIDENTAL%2c SPECIAL%2c EXEMPLARY%2c OR CONSEQUENTIAL DAMAGES
 %23 %28INCLUDING%2c BUT NOT LIMITED TO%2c PROCUREMENT OF SUBSTITUTE
 %23 GOODS OR SERVICES%3b LOSS OF USE%2c DATA%2c OR PROFITS%3b OR
 %23 BUSINESS INTERRUPTION%29 HOWEVER CAUSED AND ON ANY THEORY OF
 %23 LIABILITY%2c WHETHER IN CONTRACT%2c STRICT LIABILITY%2c OR TORT
 %23 %28INCLUDING NEGLIGENCE OR OTHERWISE%29 ARISING IN ANY WAY OUT
 %23 OF THE USE OF THIS SOFTWARE%2c EVEN IF ADVISED OF THE
 %23 POSSIBILITY OF SUCH DAMAGE.
 %23
%7d%7d
 
%7b%7b
 %23
 %23 set-foreground %5b bright %7c dark %5d COLOR
 %23 
 %23 Sets the console%27s foreground color to the specified color.
 %23 
 %23 The %22bright%22 and %22dark%22 arguments specify if the color should
 %23 be intense %28bright%29 or not %28dark%29.  If omitted%2c %22dark%22 is
 %23  assumed.
 %23 
 %23 Valid colors are%3a black%2c blue%2c green%2c aqua%2c red%2c purple%2c
 %23                   yellow and white.
 %23
%7d%7d
 
%7b%7b
 function set-foreground
 %7b
     %24local%3acolor %3d %24Args%5b0%5d.ToLower%28%29
     %24local%3aoffset %3d 0
     %24local%3avalue %3d 0
%7d%7d
     
%7b%7b
     if%28 %24local%3acolor -ieq %22bright%22 %29
     %7b
         %24local%3acolor %3d %24args%5b1%5d.ToLower%28%29
         %24local%3aoffset %3d 8
     %7d
     elseif%28 %24local%3acolor -ieq %22dark%22 %29
     %7b
         %24local%3acolor %3d %24args%5b1%5d.tolower%28%29
         %24local%3aoffset %3d 0
     %7d
%7d%7d
     
%7b%7b
     if%28 %24local%3acolor -eq -1 %29
     %7b
         echo %22Usage%3a set-foreground %5b dark %7c bright %5d COLOR%22
         echo %22  Valid colors are%3a black%2c blue%2c green%2c aqua%2c%22
         echo %22                    red%2c purple%2c yellow and white.%22
     %7d
%7d%7d
     
%7b%7b
     switch%28 %24local%3acolor %29
     %7b
         black %7b %24local%3avalue %3d 0 %7d
         blue %7b %24local%3avalue %3d 1 %7d
         green %7b %24local%3avalue %3d 2 %7d
         aqua %7b %24local%3avalue %3d 3 %7d
         red %7b %24local%3avalue %3d 4 %7d
         purple %7b %24local%3avalue %3d 5 %7d
         yellow %7b %24local%3avalue %3d 6 %7d
         white %7b %24local%3avalue %3d 7 %7d
     %7d
%7d%7d
     
%7b%7b
     %5b%24MshHost.ui.rawui.foregroundColor%5d %3d %24local%3avalue %2b %24local%3aoffset
 %7d
%7d%7d
 
%7b%7b
 %23
 %23 set-background %5b bright %7c dark %5d COLOR
 %23 
 %23 Sets the console%27s background color to the specified color.
 %23 
 %23 The %22bright%22 and %22dark%22 arguments specify if the color should
 %23 be intense %28bright%29 or not %28dark%29.  If omitted%2c %22dark%22 is
 %23  assumed.
 %23 
 %23 Valid colors are%3a black%2c blue%2c green%2c aqua%2c red%2c purple%2c
 %23                   yellow and white.
 %23
%7d%7d
 
%7b%7b
 function set-background
 %7b
     %24local%3acolor %3d %24Args%5b0%5d.ToLower%28%29
     %24local%3aoffset %3d 0
     %24local%3avalue %3d 0
%7d%7d
     
%7b%7b
     if%28 %24local%3acolor -ieq %22bright%22 %29
     %7b
         %24local%3acolor %3d %24args%5b1%5d.ToLower%28%29
         %24local%3aoffset %3d 8
     %7d
     elseif%28 %24local%3acolor -ieq %22dark%22 %29
     %7b
         %24local%3acolor %3d %24args%5b1%5d.tolower%28%29
         %24local%3aoffset %3d 0
     %7d
%7d%7d
     
%7b%7b
     if%28 %24local%3acolor -eq -1 %29
     %7b
         echo %22Usage%3a set-background %5b dark %7c bright %5d COLOR%22
         echo %22  Valid colors are%3a black%2c blue%2c green%2c aqua%2c%22
         echo %22                    red%2c purple%2c yellow and white.%22
     %7d
%7d%7d
     
%7b%7b
     switch%28 %24local%3acolor %29
     %7b
         black %7b %24local%3avalue %3d 0 %7d
         blue %7b %24local%3avalue %3d 1 %7d
         green %7b %24local%3avalue %3d 2 %7d
         aqua %7b %24local%3avalue %3d 3 %7d
         red %7b %24local%3avalue %3d 4 %7d
         purple %7b %24local%3avalue %3d 5 %7d
         yellow %7b %24local%3avalue %3d 6 %7d
         white %7b %24local%3avalue %3d 7 %7d
     %7d
%7d%7d
     
%7b%7b
     %5b%24MshHost.ui.rawui.backgroundColor%5d %3d %24local%3avalue %2b %24local%3aoffset
 %7d
%7d%7d
 
%7b%7b
 %23
 %23 Here is an example of what you can do with this.  This replicates
 %23 the cool prompt that comes with the default installation of
 %23 Cygwin %28http%3a//www.cygwin.com/%29 in full color%21
 %23 
 %23 To use it%2c just copy both the above color functions%2c and the below
 %23 prompt function into your profile.msh %28just paste it in at the end%29%2c
 %23 and then uncomment the prompt function below.
 %23
%7d%7d
 
%7b%7b
 %23function prompt
 %23%7b
 %23    %24user %3d %24env%3ausername
 %23    %24host %3d %24%28get-hostname%29.hostname
 %23    %24loc %3d get-location
 %23    
 %23    %23 Since write-object doesn%27t allow us to supress the
 %23    %23 trailing newline %28at least%2c the help doesn%27t SAY it
 %23    %23 does%29%2c we%27ll cheat a bit and use write-host for the
 %23    %23 first line%2c then write-object for the last.
 %23    %23
 %23    %23 Just FYI%2c if you don%27t write an object into the
 %23    %23 pipeline at some point%2c MSH seems to output it%27s
 %23    %23 default prompt automatically.
 %23    
 %23    set-foreground green
 %23    write-host -n %22%60n%24user@%24host %22
 %23    set-foreground yellow
 %23    write-host -n %22%24loc%60n%22
 %23    set-foreground white
 %23    write-object %22%60%24 %22
 %23%7d
%7d%7d