win32console 1.0.8-i386-mswin32

data/Console_ANSI.rdoc

@@ -0,0 +1,302 @@
+#  
+#  = NAME
+#  
+#  Win32::Console::ANSI - Ruby extension to emulate ANSI console on Win32 system.
+#  
+#  = SYNOPSIS
+#  
+#    require "Win32::Console::ANSI"
+#  
+#    puts "\e[1;34mThis text is bold blue.\e[0m"
+#    puts "This text is normal.""
+#    puts "\e[33;45;1mBold yellow on magenta.\e[0m"
+#    puts "This text is normal."
+#  
+#  With the Term::ANSIColor module one increases the readability:
+#  
+#    require "Win32::Console::ANSI"
+#    require "Term::ANSIColor"
+#  
+#    puts color 'bold blue'
+#    puts "This text is bold blue."
+#    puts color 'reset'
+#    puts "This text is normal."
+#    puts colored ("Bold yellow on magenta.", 'bold yellow on_magenta')
+#    puts "This text is normal."
+#  
+#  And even more with Term::ANSIScreen:
+#  
+#    require "Win32::Console::ANSI;
+#    require "Term::ANSIScreen qw/:color :cursor :screen/;
+#  
+#    locate 1, 1; puts "@ This is (1,1)", savepos;
+#    puts locate(24,60), "@ This is (24,60)"; loadpos;
+#    puts down(2), clline, "@ This is (3,16)";
+#    setscroll 1, 20;
+#    color 'black on white'; clline;
+#    puts "This line is black on white.";
+#    puts color 'reset'; puts "This text is normal.";
+#    puts colored ("This text is bold blue.", 'bold blue');
+#    puts "This text is normal.";
+#    puts colored ['bold blue'], "This text is bold blue.";
+#    puts "This text is normal.";
+#  
+#  = DESCRIPTION
+#  
+#  Windows NT/2000/XP does not support ANSI escape sequences in Win32 Console
+#  applications. This module emulates an ANSI console for the script which
+#  uses it.
+#  
+#  
+#  == Escape sequences for Cursor Movement
+#  
+#     * \e[#A
+#  
+#       CUU: CUrsor Up: Moves the cursor up by the specified number of lines without
+#       changing columns. If the cursor is already on the top line, this sequence
+#       is ignored. \e[A is equivalent to \e[1A.
+#  
+#     * \e[#B
+#  
+#       CUD: CUrsor Down: Moves the cursor down by the specified number of lines
+#       without changing columns. If the cursor is already on the bottom line,
+#       this sequence is ignored. \e[B is equivalent to \e[1B.
+#  
+#     * \e[#C
+#  
+#       CUF: CUrsor Forward: Moves the cursor forward by the specified number of
+#       columns without changing lines. If the cursor is already in the
+#       rightmost column, this sequence is ignored. \e[C is equivalent to \e[1C.
+#  
+#     * \e[#D
+#  
+#        CUB: CUrsor Backward: Moves the cursor back by the specified number of
+#        columns without changing lines. If the cursor is already in the leftmost
+#        column, this sequence is ignored. \e[D is equivalent to \e[1D.
+#  
+#     * \e[#E
+#  
+#        CNL: Cursor Next Line: Moves the cursor down the indicated # of rows, to
+#        column 1. \e[E is equivalent to \e[1E.
+#  
+#     * \e[#F
+#  
+#        CPL: Cursor Preceding Line: Moves the cursor up the indicated # of rows,
+#        to column 1. \e[F is equivalent to \e[1F.
+#  
+#     * \e[#G
+#  
+#        CHA: Cursor Horizontal Absolute: Moves the cursor to indicated column in
+#        current row. \e[G is equivalent to \e[1G.
+#  
+#     * \e[#;#H
+#  
+#        CUP: CUrsor Position: Moves the cursor to the specified position. The first #
+#        specifies the line number, the second # specifies the column.
+#        If you do not specify a position, the cursor moves to the
+#        home position: the upper-left corner of the screen (line 1, column 1).
+#  
+#     * \e[#;#f
+#  
+#        HVP: Horizontal and Vertical Position.
+#        Works the same way as the preceding escape sequence.
+#  
+#     * \e[s
+#  
+#        SCP: Save Cursor Position: Saves the current cursor position. You can move
+#        the cursor to the saved cursor position by using the Restore Cursor
+#        Position sequence.
+#  
+#     * \e[u
+#  
+#        RCP: Restore Cursor Position: Returns the cursor to the position stored
+#        by the Save Cursor Position sequence.
+#  
+#  == Escape sequences for Display Edition
+#  
+#     * \e[#J
+#  
+#        ED: Erase Display:
+#  
+#           * \e[0J
+#  
+#              Clears the screen from cursor to end of display. The cursor position is unchanged.
+#  
+#           * \e[1J
+#  
+#              Clears the screen from start to cursor. The cursor position is unchanged.
+#  
+#            * \e[2J
+#  
+#              Clears the screen and moves the cursor to the home position (line 1, column 1).
+#  
+#         \e[J is equivalent to \e[0J. (Some terminal/emulators respond to \e[J as if
+#         it were \e[2J. Here, the default is 0; it's the norm)
+#  
+#     * \e[#K
+#  
+#        EL: Erase Line:
+#  
+#     * \e[0K
+#  
+#        Clears all characters from the cursor position to the end of the line
+#        (including the character at the cursor position).
+#        The cursor position is unchanged.
+#  
+#     * \e[1K
+#  
+#        Clears all characters from start of line to the cursor position.
+#        (including the character at the cursor position).
+#        The cursor position is unchanged.
+#  
+#     * \e[2K
+#  
+#        Clears all characters of the whole line.
+#        The cursor position is unchanged.
+#  
+#        \e[K is equivalent to \e[0K.
+#  
+#     * \e[#L
+#  
+#        IL: Insert Lines: The cursor line and all lines below it move down # lines,
+#        leaving blank space. The cursor position is unchanged. The bottommost #
+#        lines are lost. \e[L is equivalent to \e[1L.
+#  
+#     * \e[#M
+#  
+#        DL: Delete Line: The block of # lines at and below the cursor are  deleted;
+#        all  lines below  them  move up # lines to fill in the gap, leaving # blank
+#        lines at the bottom of the screen.  The cursor position is unchanged.
+#        \e[M is equivalent to \e[1M.
+#  
+#     * \e#\@
+#  
+#        ICH: Insert CHaracter: The cursor character and all characters to the right
+#        of it move right # columns, leaving behind blank space.
+#        The cursor position is unchanged. The rightmost # characters on the line are lost.
+#  
+#     * \e[#P
+#  
+#        DCH: Delete CHaracter: The block of # characters at and to the right of the
+#        cursor are deleted; all characters to the right of it move left # columns,
+#        leaving behind blank space. The cursor position is unchanged.
+#        \e[P is equivalent to \e[1P.
+#  
+#  
+#  == Escape sequences for Set Graphics Rendition
+#  
+#     * \e[#;...;#m
+#  
+#        SGM: Set Graphics Mode: Calls the graphics functions specified by the
+#        following values. These specified functions remain active until the next
+#        occurrence of this escape sequence. Graphics mode changes the colors and
+#        attributes of text (such as bold and underline) displayed on the
+#        screen.
+#  
+#        * Text attributes
+#  
+#         0    All attributes off
+#         1    Bold on
+#         4    Underscore on
+#         7    Reverse video on
+#         8    Concealed on
+#  
+#         21   Bold off
+#         24   Underscore off
+#         27   Reverse video off
+#         28   Concealed off
+#  
+#        * Foreground colors
+#  
+#         30    Black
+#         31    Red
+#         32    Green
+#         33    Yellow
+#         34    Blue
+#         35    Magenta
+#         36    Cyan
+#         37    White
+#  
+#        * Background colors
+#  
+#         40    Black
+#         41    Red
+#         42    Green
+#         43    Yellow
+#         44    Blue
+#         45    Magenta
+#         46    Cyan
+#         47    White
+#  
+#       \e[m is equivalent to \e0m.
+#  
+#  == Escape sequences for Select Character Set
+#  
+#     * \e(U
+#  
+#        Select null mapping - straight to character from the codepage of the console.
+#  
+#     * \e(K
+#  
+#        Select Windows to DOS mapping, if the corresponding map exist; no effect
+#        otherwise. This is the default mapping (if the map exist, of course). It's
+#        useful becarequire "one types the script with a Windows-based editor (using a
+#        Windows codepage) and the script prints its messages on the console using
+#        another codepage: without translation, the characters with a code greatest
+#        than 127 are different and the printed messages may be not readable.
+#  
+#        The conversion is done by the module Encode if it is installed (it's a
+#        standard module with Perl5.8, not Ruby yet). Otherwise, the conversion is limited to the
+#        following couples:
+#  
+#           WinLatin1 (cp1252)  to DOSLatin1  (cp850)
+#           WinLatin1 (cp1252)  to DOSLatinUS (cp437)
+#           WinLatin2 (cp1250)  to DOSLatin2  (cp852)
+#           WinCyrillic(cp1251) to DOSCyrillic (cp855)
+#  
+#     * \e(#X
+#  
+#        This escape sequence is I<not> standard! It's an experimental one, just for
+#        fun :-)
+#  
+#        If <i>and only if</i> the console uses an Unicode police, it is possible to
+#        change its codepage with this escape sequence. No effect with an ordinary
+#        "Raster Font". (For Windows NT/2000/XP the currently available Unicode
+#        console font is the Lucida Console TrueType font.)
+#        # is the number of the codepage needed, 855 for cp855 for instance.
+#  
+#  
+#  = LIMITATIONS
+#  
+#     * Due to DOS-console limitations, the blink mode (text attributes 5 and 25) is not implemented.
+#  
+#  = SEE ALSO
+#  
+#  <b>Win32::Console</b>, <b>Term::ANSIColor</b>, <b>Term::ANSIScreen</b>.
+#  
+#  = AUTHOR
+#  
+#  J-L Morel jl_morel@bribes.org
+#  
+#  Home page: http://www.bribes.org/perl/wANSIConsole.html
+#
+#  Gonzalo Garramu�o GGarramuno@aol.com   Ruby port
+#  
+#  = CREDITS
+#  
+#  Render unto C�sar the things which are C�sar's...
+#  
+#  This module requires the module Win32::Console. Thanks to Aldo Calpini.
+#  
+#  The method used to overload the print function is due to Matt Sergeant
+#  (see his module Win32::ASP).
+#  
+#  = COPYRIGHT
+#  
+#  Copyright (c) 2004 Gonzalo Garramu�o. All rights reserved.
+#  Copyright (c) 2003 J-L Morel. All rights reserved.
+#  
+#  This program is free software; you can redistribute it and/or modify it under
+#  the terms of the Artistic License.
+#  
+#  

data/HISTORY.txt

@@ -0,0 +1,7 @@
+v1.0 - Added .dup to _printString function to avoid mangling outside
+       string references.  Removed the other (later) .dup call.
+       Turned of some exceptions that were conflicting with using
+       the module with pipes or redirections.
+v0.8 - Fixed bugs in reading routines, added ruby docs, and 
+       sample test suite.
+v0.5 - First public release.

data/INSTALL.txt

@@ -0,0 +1,18 @@
+
+To compile and install:
+
+
+Open a windows console.
+> vcvars32.bat    # to set up microsoft's compiling environment
+                  # this is located in the bin/ directory of the MSVC compiler
+> ruby extconf.rb # to create a Makefile
+> nmake           # to compile
+> nmake install   # to install
+
+
+To test:
+
+> cd test
+> dir              # to see available samples
+> ruby [anysample]
+

data/README.txt

@@ -0,0 +1,26 @@
+
+This file implements a port of Perl's Win32::Console
+and Win32::Console::ANSI modules.
+
+Win32::Console allows controling the windows command line terminal
+thru an OO-interface.  This allows you to query the terminal (find
+its size, characters, attributes, etc).  The interface and functionality
+should be identical to Perl's.
+
+Win32::Console consists of a Ruby .rb interface.
+For best performance, this library has been also ported to C.  
+If you lack a C compiler, you can still use the class thru the ruby
+interface.  If you can compile it, then the ruby interface is not
+used and the C functions are called instead.
+
+Win32::Console::ANSI is a class derived from IO that seamlessly
+translates ANSI Esc control character codes into Windows' command.exe 
+or cmd.exe equivalents.
+
+These modules allow you to develop command-line tools that can take 
+advantage of the unix terminal functions while still being portable.
+One of the most common uses for this is to allow to color your
+output.
+The modules are disted with Term/ansicolor.rb, too, as it is a nice
+thing to verify it is working properly.
+

data/Rakefile

@@ -0,0 +1,38 @@
+require 'rubygems'
+Gem::manage_gems
+require 'rake/gempackagetask'
+
+spec = Gem::Specification.new do |s|
+	s.name = "win32console"
+	s.summary = "A library giving the Win32 console ANSI escape sequence support."
+	s.version = "1.0.8"
+	s.author = "Original Library by Gonzalo Garramuno, Gem by Justin Bailey"
+	s.email = "ggarra @nospam@ advancedsl.com.ar, jgbailey @nospan@ gmail.com"
+	s.homepage = "http://rubyforge.org/projects/winconsole"
+	s.rubyforge_project = "http://rubyforge.org/projects/winconsole"
+	s.description = <<EOS
+This gem packages Gonzalo Garramuno's Win32::Console project, and includes a compiled binary for speed. The Win32::Console project's home can be found at:
+
+http://rubyforge.org/projects/win32console
+
+The gem project can be found at
+
+http://rubyforge.org/projects/winconsole
+EOS
+
+	s.platform = Gem::Platform::CURRENT
+	s.files = FileList["lib/**/*", "test/*", "doc/**/*", "Console*", "*.txt", "Rakefile"].to_a
+
+	s.require_path = "lib"
+	s.autorequire = "win32console"
+
+	s.has_rdoc = true
+	s.extra_rdoc_files = ["lib/README_GEM.txt"]
+	s.rdoc_options << '--title' << 'Win32Console Gem -- Gem for Win32::Console Project' <<
+                       '--main' << 'lib/README_GEM.txt' <<
+                       '--line-numbers'
+end
+
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.need_tar = true
+end

data/doc/classes/Win32.html

@@ -0,0 +1,115 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html 
+     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+     "DTD/xhtml1-transitional.dtd">
+
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+	<title>Module: Win32</title>
+	<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+	<meta http-equiv="Content-Script-Type" content="text/javascript" />
+	<link rel="stylesheet" href=".././rdoc-style.css" type="text/css" media="screen" />
+	<script type="text/javascript">
+	// <![CDATA[
+
+	function popupCode( url ) {
+		window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
+	}
+
+	function toggleCode( id ) {
+		if ( document.getElementById )
+			elem = document.getElementById( id );
+		else if ( document.all )
+			elem = eval( "document.all." + id );
+		else
+			return false;
+
+		elemStyle = elem.style;
+		
+		if ( elemStyle.display != "block" ) {
+			elemStyle.display = "block"
+		} else {
+			elemStyle.display = "none"
+		}
+
+		return true;
+	}
+	
+	// Make codeblocks hidden by default
+	document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
+	
+	// ]]>
+	</script>
+
+</head>
+<body>
+
+
+
+    <div id="classHeader">
+        <h1>Win32 <sup class="type-note">(Module)</sup></h1>
+        <table class="header-table">
+        <tr class="top-aligned-row">
+            <td><strong>In:</strong></td>
+            <td>
+                <a href="../files/lib\Win32/Console/ANSI_rb.html">
+                lib\Win32/Console/ANSI.rb
+                </a>
+				<br />
+                <a href="../files/lib\Win32/Console_rb.html">
+                lib\Win32/Console.rb
+                </a>
+				<br />
+                <a href="../files/Console_cpp.html">
+                Console.cpp
+                </a>
+				<br />
+            </td>
+        </tr>
+
+        </table>
+    </div>
+  <!-- banner header -->
+
+	<div id="bodyContent">
+
+
+	<div id="contextContent">
+
+
+
+
+
+
+
+			
+		<div id="class-list">
+			<h2 class="section-bar">Classes and Modules</h2>
+
+			Class <a href="Win32/Console.html" class="link">Win32::Console</a><br />
+&nbsp;&nbsp;::Module <a href="Win32/Console/ANSI.html" class="link">Win32::Console::ANSI</a><br />
+&nbsp;&nbsp;::&nbsp;&nbsp;::Class <a href="Win32/Console/ANSI/IO.html" class="link">Win32::Console::ANSI::IO</a><br />
+&nbsp;&nbsp;::Module <a href="Win32/Console/Constants.html" class="link">Win32::Console::Constants</a><br />
+&nbsp;&nbsp;::Class <a href="Win32/Console/API.html" class="link">Win32::Console::API</a><br />
+
+		</div>
+
+	</div>
+
+
+
+		<!-- if includes -->
+
+
+		<!-- if method_list -->
+
+
+	</div>
+
+
+<div id="validator-badges">
+  <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
+</div>
+
+</body>
+</html>