commands.ps1
|
<# .SYNOPSIS Retrieves the border symbols for a specified border type. .DESCRIPTION The Get-BorderSymbol function returns a hashtable containing the symbols used for the top-left, top-right, bottom-left, bottom-right corners, as well as the spacers for the top, bottom, left, and right sides of a border. The border type is specified using the BorderType enum. .PARAMETER BorderType Specifies the type of border for which to retrieve the symbols. The parameter is mandatory and must be a valid value from the BorderType enum. .OUTPUTS System.Collections.Hashtable A hashtable containing the border symbols. .EXAMPLE PS C:\> Get-BorderSymbol -BorderType Box Returns the border symbols for the "Box" border type. .EXAMPLE PS C:\> Get-BorderSymbol -BorderType Asterisk Returns the border symbols for the "Asterisk" border type. .EXAMPLE PS C:\> Get-BorderSymbol -BorderType DoubleBox Returns the border symbols for the "DoubleBox" border type. .NOTES The function uses the BorderType enum for input validation, ensuring only valid border types are accepted. #> function Get-BorderSymbol { [CmdletBinding()] [OutputType([System.Collections.Hashtable])] param ( [Parameter(Mandatory = $true)] [BorderType] # Use the enum for validation $BorderType ) switch ($BorderType) { 'Asterisk' { return @{ TopLeft = "*"; TopRight = "*"; BottomLeft = "*"; BottomRight = "*"; TopSpacer = "*"; BottomSpacer = "*"; LeftSpacer = "*"; RightSpacer = "*" } } 'Hash' { return @{ TopLeft = "#"; TopRight = "#"; BottomLeft = "#"; BottomRight = "#"; TopSpacer = "#"; BottomSpacer = "#"; LeftSpacer = "#"; RightSpacer = "#" } } 'Plus' { return @{ TopLeft = "+"; TopRight = "+"; BottomLeft = "+"; BottomRight = "+"; TopSpacer = "+"; BottomSpacer = "+"; LeftSpacer = "+"; RightSpacer = "+" } } 'Box' { return @{ TopLeft = "┌"; TopRight = "┐"; BottomLeft = "└"; BottomRight = "┘"; TopSpacer = "─"; BottomSpacer = "─"; LeftSpacer = "│"; RightSpacer = "│" } } 'TwoLinesFrame' { return @{ TopLeft = "/"; TopRight = "\"; BottomLeft = "\"; BottomRight = "/"; TopSpacer = "="; BottomSpacer = "="; LeftSpacer = "||"; RightSpacer = "||" } } 'DoubleBox' { return @{ TopLeft = "╔"; TopRight = "╗"; BottomLeft = "╚"; BottomRight = "╝"; TopSpacer = "═"; BottomSpacer = "═"; LeftSpacer = "║"; RightSpacer = "║" } } 'DoubleCorners' { return @{ TopLeft = "╔"; TopRight = "╗"; BottomLeft = "╚"; BottomRight = "╝"; TopSpacer = "─"; BottomSpacer = "─"; LeftSpacer = "│"; RightSpacer = "│" } } 'BubbleBorder' { return @{ TopLeft = "(_)"; TopRight = "(_)"; BottomLeft = "(_)"; BottomRight = "(_)"; TopSpacer = "(_)"; BottomSpacer = "(_)"; LeftSpacer = "(_)"; RightSpacer = "(_)" } } 'BoxBorder' { return @{ TopLeft = "|_|"; TopRight = "|_|"; BottomLeft = "|_|"; BottomRight = "|_|"; TopSpacer = "|_|"; BottomSpacer = "|_|"; LeftSpacer = "|_|"; RightSpacer = "|_|" } } 'Dots' { return @{ TopLeft = "."; TopRight = "."; BottomLeft = ":"; BottomRight = ":"; TopSpacer = "."; BottomSpacer = "."; LeftSpacer = ":"; RightSpacer = ":" } } 'None' { return @{ TopLeft = ""; TopRight = ""; BottomLeft = ""; BottomRight = ""; TopSpacer = ""; BottomSpacer = ""; LeftSpacer = ""; RightSpacer = "" } } } } <# .SYNOPSIS Converts a given text to ASCII art using a specified font and optional border style. .DESCRIPTION The Convert-FSCPSTextToAscii function takes a string input and converts it into ASCII art using the specified font. Optionally, a border style can be applied around the ASCII art, such as asterisks, hashes, or other symbols. .PARAMETER Text The text to be converted into ASCII art. This parameter is mandatory. .PARAMETER Font The font to be used for generating the ASCII art. This parameter is mandatory. .PARAMETER BorderType The type of border to apply around the ASCII art. This parameter is optional and defaults to 'None'. Supported values include 'Asterisk', 'Hash', and 'Plus'. .EXAMPLE PS C:\> Convert-FSCPSTextToAscii -Text "Hello" -Font "Standard" -BorderType Asterisk Converts the text "Hello" into ASCII art using the "Standard" font and surrounds it with an asterisk border. .EXAMPLE PS C:\> Convert-FSCPSTextToAscii -Text "World" -Font "Slant" Converts the text "World" into ASCII art using the "Slant" font without any border. .NOTES Tags: Configuration, Azure, Storage Author: Oleksandr Nikolaiev (@onikolaiev) #> function Convert-FSCPSTextToAscii { [CmdletBinding()] [OutputType()] param( [Parameter(Mandatory=$true)] [string]$Text, [Parameter(Mandatory=$true)] [FontType]$Font, [Parameter(Mandatory=$false)] [BorderType]$BorderType = [BorderType]::None ) $border = Get-BorderSymbol -BorderType $BorderType $fontDirectory = "$ModuleRoot\internal\misc\Fonts" $fontFilePath = Join-Path $fontDirectory "$Font.flf" # Load .flf file lines $flfLines = (Get-Content -Path $fontFilePath -Raw -ErrorAction Stop -Encoding UTF8) -split "`r?`n" # Parse metadata from the first line # e.g. header: "flf2a$ 6 5 20 15 11 0 24463 229" $headerParts = $flfLines[0].Split(' ') $charHeight = [int]$headerParts[1] $commentLines= [int]$headerParts[5] # Skip header + comment lines $startIndex = 1 + $commentLines # Build a dictionary of ASCII art for each printable character $charMap = @{} $asciiCode = 32 # Start from space (ASCII 32) $linePos = $startIndex while ($linePos -lt $flfLines.Count) { $charLines = @() for ($i = 0; $i -lt $charHeight; $i++) { if ($linePos -ge $flfLines.Count) { break } $charLines += $flfLines[$linePos] $linePos++ } $charMap[$asciiCode] = $charLines $asciiCode++ # Stop if we've passed typical ASCII printable range if ($asciiCode -gt 126) { break } } # Generate ASCII art lines for input text $outputLines = New-Object System.Collections.Generic.List[string] for ($row = 0; $row -lt $charHeight; $row++) { $rowBuilder = " " foreach ($c in $Text.ToCharArray()) { $charCode = [int][char]$c if ($charMap.ContainsKey($charCode)) { $rowText = $charMap[$charCode][$row] # Logic to handle '@' replacements if ($rowText -eq "@") { # Replace single '@' with a space if the string contains only '@' $rowText = " " } elseif ($rowText.EndsWith("@")) { # Remove trailing '@' if the string ends with '@' $rowText = $rowText.TrimEnd("@") } # Logic to handle '$' replacements if ($rowText -eq "$") { # Replace single '$' with a space if the string contains only '$' $rowText = " " } elseif ($rowText.EndsWith("$")) { # Remove trailing '$' if the string ends with '$' $rowText = $rowText.TrimEnd("$") } $rowBuilder += $rowText } else { $rowBuilder += "?" # fallback if not in font map } } $rowBuilder += " " $outputLines.Add($rowBuilder) } if($outputLines[-1].Replace(" ", "").Length -eq 0) { $outputLines.RemoveAt($outputLines.Count - 1) # Remove last line of whitespace } # Determine max line length $maxLen = ($outputLines | ForEach-Object { $_.Length } | Measure-Object -Maximum).Maximum # Calculate the total width of the content including side borders $totalWidth = $maxLen if($BorderType -ne [BorderType]::None) { # Repeat spacer patterns to match the required total width $topBorder = $border.TopSpacer * ([math]::Ceiling($totalWidth / $border.TopSpacer.Length)) $topBorder = $topBorder.Substring(0, $topBorder.Length) # Trim to exact length $bottomBorder = $border.BottomSpacer * [math]::Ceiling($totalWidth / $border.BottomSpacer.Length) $bottomBorder = $bottomBorder.Substring(0, $bottomBorder.Length) # Trim to exact length # Draw top border $topBorderLine = $border.TopLeft + $topBorder + $border.TopRight Write-PSFMessage -Level Important -Message ($topBorderLine) # Draw lines, padding each to the max length foreach ($line in $outputLines) { $curLineLenght = $line.Length + $border.LeftSpacer.Length + $border.RightSpacer.Length $curAdvDifference = ($topBorderLine.Length - ($curLineLenght)) $padded = $line.PadRight($maxLen + $curAdvDifference) Write-PSFMessage -Level Important -Message ("$($border.LeftSpacer)$padded$($border.RightSpacer)") } # Draw bottom border Write-PSFMessage -Level Important -Message ($border.BottomLeft + $bottomBorder + $border.BottomRight) } else { # Draw lines without borders foreach ($line in $outputLines) { Write-PSFMessage -Level Important -Message ($line) } } } |