# encoding: ascii
# api: powershell
# title: Highlight-Syntax
# description: The Get-Command cmdlet reveals all that you need to know about PowerShell.
# version: 1.0
# type: script
# author: Jeff Hillman
# license: CC0
# function: Highlight-Other
# x-poshcode-id: 703
# x-archived: 2009-01-06T12:24:02
#
# By Jeffery Hicks
# A terrific PowerShell feature is its ability to reveal its capabilities to you through help files and cmdlets like Get-Member. There is another cmdlet you’ll want to explore that can also reveal a lot about PowerShell, called Get-Command. If you run Get-Command at a PowerShell prompt, by default it will display all of the cmdlets available in your current PowerShell session.
# But Get-Command can do much more. It can also display other “executables” like applications and scripts. Try this in your PowerShell session:
# PS C:\> Get-command -commandtype application
# The command might run for a while, but it will display all non-PowerShell programs including .exe, .dll and .txt files that are in your environment path.
# Want to see all the functions currently defined? You can use Get-Command:
# PS C:\> Get-command -commandtype function
# The other command type you might be interested in is “externalscript”:
# PS C:\> Get-command -commandtype externalscript
# This will list all PowerShell scripts that exist in any directory in your path. But wait…there’s more.
# You should be familiar with the cmdlets Verb-Noun naming convention. Curious about all the cmdlets that start with the verb “Get”?
# PS C:\> get-command -verb get
# Or perhaps you want to see all the cmdlets related to processes:
# PS C:\> get-command -noun process
# Here’s a nifty trick to get a list of all the verbs and nouns. Try these commands to see for yourself:
# PS C:\> get-command | select verb -unique
# PS C:\> get-command | select noun -unique
# You should get a list of verbs and a list of nouns.
# Finally, try a command like this:
# PS C:\> get-command get-process | select *
# You should get all the information about Get-Process that Get-Command can tell you. One of the properties you’ll notice is PSSnapin. You can use Get-Command to discover what cmdlets belong to a particular snapin. One way you can accomplish this is to use the -pssnapin parameter:
# PS C:\> get-command -pssnapin Microsoft.PowerShell.Utility
# Or use Get-Command to build a report for all your snapins:
# PS C:\> get-command | sort pssnapin | format-table -groupby pssnapin Name
# So the next time you’re trying to figure out what cmdlets you have or what they can do, take command with Get-Command.
#
# Highlight-Syntax.ps1
# version 1.0
# by Jeff Hillman
#
# this script uses regular expressions to highlight PowerShell
# syntax with HTML.
param( [string] $code, [switch] $LineNumbers )
if ( Test-Path $code -ErrorAction SilentlyContinue )
{
$code = Get-Content $code | Out-String
}
$backgroundColor = "#DDDDDD"
$foregroundColor = "#000000"
$stringColor = "#800000"
$commentColor = "#008000"
$operatorColor = "#C86400"
$numberColor = "#800000"
$keywordColor = "#C86400"
$typeColor = "#404040"
$variableColor = "#000080"
$cmdletColor = "#C86400"
$lineNumberColor = "#404040"
filter Html-Encode( [switch] $Regex )
{
# some regular expressions operate on strings that have already
# been through this filter, so the patterns need to be updated
# to look for the encoded characters instead of the literal ones.
# we do it with this filter instead of directly in the regular
# expression so the expressions can be a bit more readable (ha!)
$_ = $_ -replace "&", "&"
if ( $Regex )
{
$_ = $_ -replace "(?<!\(\?)<", "<"
$_ = $_ -replace "(?<!\(\?)>", ">"
}
else
{
$_ = $_ -replace "\t", " "
$_ = $_ -replace " ", " "
$_ = $_ -replace "<", "<"
$_ = $_ -replace ">", ">"
}
$_
}
# regular expressions
$operatorRegex = @"
((?x:
(?# assignment operators)
=|\+=|-=|\*=|/=|%=|
(?# arithmatic operators)
(?<!\de)
(\+|-|\*|/|%)(?![a-z])|
(?# unary operators)
\+\+|\-\-|
(?# logical operators)
(-and|-or|-not)\b|!|
(?# bitwise operators)
(-band|-bor)\b|
(?# redirection and pipeline operators)
2>>|>>|2>&1|1>&2|2>|>|<|\||
(?# comparison operators)
(
-[ci]? (?# case and case-insensitive variants)
(eq|ne|ge|gt|lt|le|like|notlike|match|notmatch|replace|contains|notcontains)\b
)|
(?# type operators)
(-is|-isnot|-as)\b|
(?# range and miscellaneous operators)
\.\.|(?<!\d)\.(?!\d)|&|::|:|,|``|
(?# string formatting operator)
-f\b
))
"@ | Html-Encode -Regex
$numberRegex = @"
((?x:
(
(?# hexadecimal numbers)
(\b0x[0-9a-f]+)|
(?# regular numbers)
(?<!&)
((\b[0-9]+(\.(?!\.))?[0-9]*)|((?<!\.)\.[0-9]+))
(?!(>>|>&[12]|>))
(?# scientific notation)
(e(\+|-)?[0-9]+)?
)
(
(?# type specifiers)
(l|ul|u|f|ll|ull)?
(?# size shorthand)
(b|kb|mb|gb)?
\b
)?
))
"@ | Html-Encode -Regex
$keyWordRegex = @"
((?x:
\b(
(?# don't match anything that looks like a variable or a parameter)
(?<![-$])
(
(?# condition keywords)
if|else|elseif|(?<!\[)switch(?!\])|
(?# loop keywords)
for|(?<!\|</span> )foreach(?!-object)|in|do|while|until|default|break|continue|
(?# scope keywords)
global|script|local|private|
(?# block keywords)
begin|process|end|
(?# other keywords)
function|filter|param|throw|trap|return
)
)\b
))
"@
$typeRegex = @"
((?x:
\[
(
(?# primitive types and arrays of those types)
((int|long|string|char|bool|byte|double|decimal|float|single)(\[\])?)|
(?# other types)
regex|array|xml|scriptblock|switch|hashtable|type|ref|psobject|wmi|wmisearcher|wmiclass
)
\]
))
"@
$cmdletNames = Get-Command -Type Cmdlet | Foreach-Object { $_.Name }
function Highlight-Other( [string] $code )
{
$highlightedCode = $code | Html-Encode
# operators
$highlightedCode = $highlightedCode -replace
$operatorRegex, "<span style='color: $operatorColor'>`$1</span>"
# numbers
$highlightedCode = $highlightedCode -replace
$numberRegex, "<span style='color: $numberColor'>`$1</span>"
# keywords
$highlightedCode = $highlightedCode -replace
$keyWordRegex, "<span style='color: $keywordColor'>`$1</span>"
# types
$highlightedCode = $highlightedCode -replace
$typeRegex, "<span style='color: $typeColor'>`$1</span>"
# Cmdlets
$cmdletNames | Foreach-Object {
$highlightedCode = $highlightedCode -replace
"\b($_)\b", "<span style='color: $cmdletColor'>`$1</span>"
}
$highlightedCode
}
$RegexOptions = [System.Text.RegularExpressions.RegexOptions]
$highlightedCode = ""
# we treat variables, strings, and comments differently because we don't
# want anything inside them to be highlighted. we combine the regular
# expressions so they are mutually exclusive
$variableRegex = '(\$(\w+|{[^}`]*(`.[^}`]*)*}))'
$stringRegex = @"
(?x:
(?# here strings)
@[`"'](.|\n)*?^[`"']@|
(?# double-quoted strings)
`"[^`"``]*(``.[^`"``]*)*`"|
(?# single-quoted strings)
'[^'``]*(``.[^'``]*)*'
)
"@
$commentRegex = "#[^\r\n]*"
[regex]::Matches( $code,
"(?<before>(.|\n)*?)" +
"((?<variable>$variableRegex)|" +
"(?<string>$stringRegex)|" +
"(?<comment>$commentRegex))",
$RegexOptions::MultiLine ) | Foreach-Object {
# highlight everything before the variable, string, or comment
$highlightedCode += Highlight-Other $_.Groups[ "before" ].Value
if ( $_.Groups[ "variable" ].Value )
{
$highlightedCode +=
"<span style='color: $variableColor'>" +
( $_.Groups[ 'variable' ].Value | Html-Encode ) +
"</span>"
}
elseif ( $_.Groups[ "string" ].Value )
{
$string = $_.Groups[ 'string' ].Value | Html-Encode
$string = "<span style='color: $stringColor'>$string</span>"
# we have to highlight each piece of multi-line strings
if ( $string -match "\r\n" )
{
# highlight any line continuation characters as operators
$string = $string -replace
"(``)(?=\r\n)", "<span style='color: $operatorColor'>``</span>"
$string = $string -replace
"\r\n", "</span>`r`n<span style='color: $stringColor'>"
}
$highlightedCode += $string
}
else
{
$highlightedCode +=
"<span style='color: $commentColor'>" +
$( $_.Groups[ 'comment' ].Value | Html-Encode ) +
"</span>"
}
# we need to keep track of the last position of a variable, string,
# or comment, so we can highlight everything after it
$lastMatch = $_
}
if ( $lastMatch )
{
# highlight everything after the last variable, string, or comment
$highlightedCode += Highlight-Other $code.SubString( $lastMatch.Index + $lastMatch.Length )
}
else
{
$highlightedCode = Highlight-Other $code
}
# add line breaks
$highlightedCode =
[regex]::Replace( $highlightedCode, '(?=\r\n)', '<br />', $RegexOptions::MultiLine )
# put the highlighted code in the pipeline
"<div style='width: 100%; " +
"/*height: 100%;*/ " +
"overflow: auto; " +
"font-family: Consolas, `"Courier New`", Courier, mono; " +
"font-size: 12px; " +
"background-color: $backgroundColor; " +
"color: $foregroundColor; " +
"padding: 2px 2px 2px 2px; white-space: nowrap'>"
if ( $LineNumbers )
{
$digitCount =
( [regex]::Matches( $highlightedCode, "^", $RegexOptions::MultiLine ) ).Count.ToString().Length
$highlightedCode = [regex]::Replace( $highlightedCode, "^",
"<li style='color: $lineNumberColor; padding-left: 5px'><span style='color: $foregroundColor'>",
$RegexOptions::MultiLine )
$highlightedCode = [regex]::Replace( $highlightedCode, "<br />", "</span><br />",
$RegexOptions::MultiLine )
"<ol start='1' style='border-left: " +
"solid 1px $lineNumberColor; " +
"margin-left: $( ( $digitCount * 10 ) + 15 )px; " +
"padding: 0px;'>"
}
$highlightedCode
if ( $LineNumbers )
{
"</ol>"
}
"</div>"