ConsoleProgressBar.cs :  » Network-Clients » SharpSSH » Tamir » SharpSsh » jsch » examples » C# / CSharp Open Source

/*
 * Based on: http://www.dotnet247.com/247reference/msgs/45/225703.aspx
 * 20/9/2005
 * */
using System;
using System.Text;
using System.Threading;
using System.Runtime.InteropServices;

namespace Tamir.SharpSsh.jsch.examples{
  /// <summary>
  /// Summary description for ClearConsole.
  /// </summary><BR/>
  public class ConsoleProgressBar
  {
    private const int STD_OUTPUT_HANDLE = -11;
    private int mHConsoleHandle;
    COORD barCoord;

    [StructLayout(LayoutKind.Sequential)]
      public struct COORD
    {
      public short X;
      public short Y;
      public COORD(short x, short y)
      {
        X = x;
        Y = y;
      }
    }

    [StructLayout(LayoutKind.Sequential)]
      struct SMALL_RECT
    {
      public short Left;
      public short Top;
      public short Right;
      public short Bottom;
    }

    [StructLayout(LayoutKind.Sequential)]
      struct CONSOLE_SCREEN_BUFFER_INFO
    {
      public COORD dwSize;
      public COORD dwCursorPosition;
      public int wAttributes;
      public SMALL_RECT srWindow;
      public COORD dwMaximumWindowSize;
    }

    [DllImport("kernel32.dll", EntryPoint="GetStdHandle", SetLastError=true, CharSet=CharSet.Auto, CallingConvention=CallingConvention.StdCall)]
    private static extern int GetStdHandle(int nStdHandle);

    [DllImport("kernel32.dll", EntryPoint="GetConsoleScreenBufferInfo", SetLastError=true, CharSet=CharSet.Auto, CallingConvention=CallingConvention.StdCall)]
    private static extern int GetConsoleScreenBufferInfo(int hConsoleOutput, out CONSOLE_SCREEN_BUFFER_INFO lpConsoleScreenBufferInfo);

    [DllImport("kernel32.dll", EntryPoint="SetConsoleCursorPosition", SetLastError=true, CharSet=CharSet.Auto, CallingConvention=CallingConvention.StdCall)]
    private static extern int SetConsoleCursorPosition(int hConsoleOutput, COORD dwCursorPosition);

    /// <summary>Cosntructor</summary>
    public ConsoleProgressBar()
    {
      //
      // TODO: Add constructor logic here.
      //
      mHConsoleHandle = GetStdHandle(STD_OUTPUT_HANDLE);
      
      barCoord = this.GetCursorPos();
      Console.WriteLine();
      Console.WriteLine();
      Console.WriteLine();
    }

    public void SetCursorPos(short x, short y)
    {
      SetConsoleCursorPosition(mHConsoleHandle, new COORD(x, y));
    }

    public COORD GetCursorPos()
    {
      CONSOLE_SCREEN_BUFFER_INFO res;
      GetConsoleScreenBufferInfo(mHConsoleHandle, out res);
      return res.dwCursorPosition;
    }
    
    StringBuilder progressBar = new StringBuilder();
    /// <summary>
    /// Updates this ProgressBar with the task's progress
    /// </summary>
    /// <param name="transferredBytes">The bytes already copied</param>
    /// <param name="totalBytes">The total bytes to be copied</param>
    /// <param name="message">A progress message</param>
    public void Update(int transferredBytes, int totalBytes, string message)
    {
      COORD cur = this.GetCursorPos();
      this.SetCursorPos(barCoord.X, barCoord.Y);
      
      int progress;
      if(totalBytes!=0)
        progress = (int)(transferredBytes*100.0/totalBytes);
      else
        progress = 0;

      progressBar.Length=0;
      progressBar.Append( progress );
      progressBar.Append( "% [" );

      for(double i=0; i<50; i++)
      {
        if (i*2<progress) progressBar.Append( "#" );
        else progressBar.Append( "-" );
      }

      progressBar.Append( "] ");
      
      if(totalBytes!=0)
      {
        int transferredKB = (int)(transferredBytes/1000.0);
        int totalKB = (int)(totalBytes/1000.0);
        progressBar.Append( (comma(transferredKB)+"K/"+comma(totalKB)+"K\n") );
      }
      else
      {
        progressBar.Append( "0.0K\n" );
      }
      progressBar.Append( message );
      progressBar.Append( "                        \n");

      Console.Write(progressBar);
      this.SetCursorPos(cur.X, cur.Y);
    }

    /// <summary>
    /// Return a string representation of the given n. The string will be comma seperated (e.g. 19,500,200)
    /// </summary>
    private string comma(int n)
    {
      string s = n.ToString();
      for(int i=s.Length-3; i>0; i=i-3)
      {
        s = s.Insert(i, ",");
      }
      return s;
    }
  }
}