PoshCode Archive  Artifact [106aaa3e45]

Artifact 106aaa3e450a5af99d6f4b4d3b0019462b2fe66327950bd693f314458e9e1ebb:

  • File Import-BufferBox.ps1 — part of check-in [72078cba88] at 2018-06-10 12:56:25 on branch trunk — A bunch of script functions for creating a simple in-console split-view with output above and an input line below. It allows scripts to sort-of simulate accepting input while they output text. It’s still pretty fragile and occasionally does weird things while you’re typing, because it’s not really multi-threaded and the $Host doesn’t have a “LineAvailable” method … and if you pause a script, you can’t see output from typing, so the whole things is well and truly a hack. But it works! (user: Joel Bennett size: 6077)

# encoding: utf-8
# api: powershell
# title: Import-BufferBox
# description: A bunch of script functions for creating a simple in-console split-view with output above and an input line below. It allows scripts to sort-of simulate accepting input while they output text. It’s still pretty fragile and occasionally does weird things while you’re typing, because it’s not really multi-threaded and the $Host doesn’t have a “LineAvailable” method … and if you pause a script, you can’t see output from typing, so the whole things is well and truly a hack. But it works!
# version: 0.1
# type: script
# author: Joel Bennett
# license: CC0
# function: Test-BufferBox
# x-poshcode-id: 110
# x-archived: 2015-12-13T00:06:15
# x-published: 2008-01-13T16:45:00
#
# NOTE: there’s a demo script you can call by passing “DEMO” when you invoke this file
#
###################################################################################################
##### BUFFER UTILITIES SCRIPT FUNCTIONS AND SETUP
###################################################################################################
## A bunch of script functions for creating a simple in-console split-view with output above and an
## input line below. It allows scripts to sort-of simulate accepting input while they output text. 
## It's still pretty fragile and occasionally does weird things while you're typing, because it's 
## not really multi-threaded and the $Host doesn't have a "LineAvailable" method ... and if you 
## pause a script, you can't see output from typing, so the whole things is well and truly a hack. 
## But it works!
##
## NOTE: there's a demo script you can call by passing "DEMO" when you invoke this file
## USAGE NOTE: When you execute this script file, all functions become global
###################################################################################################

$global:_RECTANGLE_  = "system.management.automation.host.rectangle"
$global:_BLANKCELL_ = new-object System.Management.Automation.Host.BufferCell(' ','Black','Black','complete')

Function global:New-BufferBox ($Height, $Width, $Title="") {
   $box = &{"¯¯$Title$('¯'*($Width-($Title.Length+2)))";
            1..($Height - 2) | % {(' ' * $Width)}; 
            ('_' * $Width);
            1..2 | % {(' ' * $Width)}; 
            }
   $boxBuffer = $Host.UI.RawUI.NewBufferCellArray($box,'Green','Black')
   ,$boxBuffer
}

Function global:Move-BufferBox ($Origin,$Width,$Height,$Scroll=-1){
   $re = new-object $_RECTANGLE_ $origin.x, $origin.y, ($origin.x + $width-2), ($origin.y + $height)
   $origin.Y += $Scroll
   $Host.UI.RawUI.ScrollBufferContents($re, $origin, $re, $_BLANKCELL_)
}

Function global:Write-Message ($Message,$Foreground = 'White',$Background = 'Black',[switch]$noscroll) {
   if ( -not $NoScroll) {
      Move-BufferBox $ContentPos ($WindowSize.Width -2) ($WindowSize.Height -5)
   }
  
   # "{0},{1} {2},{3} -{4}" -f $script:pos.X, $script:pos.Y, $MessagePos.X, $MessagePos.Y, $message 
   $host.ui.rawui.SetBufferContents(
      $MessagePos,
      $Host.UI.RawUI.NewBufferCellArray( 
         @($message.PadRight($WindowSize.Width)),
         $Foreground,
         $Background)
   )
}

Function global:Clear-PromptBox {
   $Host.UI.RawUI.SetBufferContents( $PromptPos, $prompt )
}

Function global:Initialize-BufferBox($Title) {
   ###################################################################################################
   ##### Initialize a lot of settings
   ###################################################################################################
   $script:WindowSize = $Host.UI.RawUI.WindowSize;
   "`n" * $WindowSize.Height
   $script:ContentPos = $Host.UI.RawUI.WindowPosition;

   $Host.UI.RawUI.SetBufferContents($ContentPos, (New-BufferBox ($WindowSize.Height - 2) $WindowSize.Width $title))

   $ContentPos.X += 2 # 2 cell left padding on output
   $ContentPos.Y += 1 # leave the top row with the title in it
   # The Message is written into the very last line of the ContentBox
   $script:MessagePos = $ContentPos
   $MessagePos.Y += ($WindowSize.Height - 5)
   
   $script:PromptPos = $ContentPos
   $PromptPos.X = 0
   $PromptPos.Y += $WindowSize.Height - 3
   $script:prompt = $Host.UI.RawUI.NewBufferCellArray( @(&{" " * $WindowSize.Width;" " * $WindowSize.Width}), "Yellow", "Black")
}


Function Test-BufferBox {
   $fore = $Host.UI.RawUI.ForegroundColor
   $back = $Host.UI.RawUI.BackgroundColor 

   $Host.UI.RawUI.ForegroundColor = "Yellow"
   $Host.UI.RawUI.BackgroundColor = "Black"
   
   Initialize-BufferBox "Testing BufferBox"

   Write-Message 'Welcome to the BufferBox script by Joel "Jaykul" Bennett'
   Write-Message "With great inspiration from /\/\o\/\/ http://ThePowerShellGuy.com"
   Write-Message "You're about to see text fly by up here in the top of the window"
   Write-Message "But while it's flying, you can still type down in the bottom!"
   Write-Message "Try it out. Press any key to start."
   $Host.UI.RawUI.ReadKey( "IncludeKeyDown" ) | out-null
   [string]$line=""
   Get-Content $MyInvocation.ScriptName |  foreach {
      Write-Message $_
      while($Host.UI.RawUI.KeyAvailable) {
         $k = $Host.UI.RawUI.ReadKey( "IncludeKeyUp" )
         if($k.VirtualKeyCode -eq 13 )
         {
            Write-Message $line -fore red -back yellow
            $line=""
            Clear-PromptBox
         }
         elseif($k.VirtualKeyCode -eq 8 )
         {
            $line = $line.SubString(0,$($line.Length-2))
         }
         elseif($k.Character -ne 0) 
         {
            $line += $k.Character
         }
      }
      1..10 | % {[System.Threading.Thread]::Sleep(20)}
   }
   Write-Message "Thanks for playing..."
   [System.Threading.Thread]::Sleep(1000)
  
   $Host.UI.RawUI.ForegroundColor = $fore
   $Host.UI.RawUI.BackgroundColor = $back
   $Host.UI.RawUI.FlushInputBuffer()
}

if($args.Count -gt 0) { Test-BufferBox }