home *** CD-ROM | disk | FTP | other *** search
/ Chip 2000 May / Chip_2000-05_cd1.bin / zkuste / Perl / ActivePerl-5.6.0.613.msi / 䆊䌷䈹䈙䏵-䞅䞆䞀㡆䞃䄦䠥 / _ba2877f9383a0d36af8811bbb571ad23 < prev    next >
Encoding:
Text File  |  2000-03-15  |  38.9 KB  |  1,484 lines
  1. package Win32::Console;
  2. #######################################################################
  3. #
  4. # Win32::Console - Perl Module for Windows Clipboard Interaction
  5. # ^^^^^^^^^^^^^^
  6. # Version: 0.03  (07 Apr 1997)
  7. # Version: 0.031 (24 Sep 1999) - fixed typo in GenerateCtrlEvent()
  8. #
  9. #######################################################################
  10.  
  11. require Exporter;       # to export the constants to the main:: space
  12. require DynaLoader;     # to dynuhlode the module.
  13.  
  14. @ISA= qw( Exporter DynaLoader );
  15. @EXPORT = qw(
  16.     BACKGROUND_BLUE
  17.     BACKGROUND_GREEN
  18.     BACKGROUND_INTENSITY
  19.     BACKGROUND_RED
  20.     CAPSLOCK_ON
  21.     CONSOLE_TEXTMODE_BUFFER
  22.     CTRL_BREAK_EVENT    
  23.     CTRL_C_EVENT
  24.     ENABLE_ECHO_INPUT
  25.     ENABLE_LINE_INPUT
  26.     ENABLE_MOUSE_INPUT
  27.     ENABLE_PROCESSED_INPUT
  28.     ENABLE_PROCESSED_OUTPUT
  29.     ENABLE_WINDOW_INPUT
  30.     ENABLE_WRAP_AT_EOL_OUTPUT
  31.     ENHANCED_KEY
  32.     FILE_SHARE_READ
  33.     FILE_SHARE_WRITE
  34.     FOREGROUND_BLUE
  35.     FOREGROUND_GREEN
  36.     FOREGROUND_INTENSITY
  37.     FOREGROUND_RED
  38.     LEFT_ALT_PRESSED
  39.     LEFT_CTRL_PRESSED
  40.     NUMLOCK_ON
  41.     GENERIC_READ
  42.     GENERIC_WRITE
  43.     RIGHT_ALT_PRESSED
  44.     RIGHT_CTRL_PRESSED
  45.     SCROLLLOCK_ON
  46.     SHIFT_PRESSED
  47.     STD_INPUT_HANDLE
  48.     STD_OUTPUT_HANDLE
  49.     STD_ERROR_HANDLE
  50. );
  51.  
  52.  
  53. #######################################################################
  54. # This AUTOLOAD is used to 'autoload' constants from the constant()
  55. # XS function.  If a constant is not found then control is passed
  56. # to the AUTOLOAD in AutoLoader.
  57. #
  58.  
  59. sub AUTOLOAD {
  60.     my($constname);
  61.     ($constname = $AUTOLOAD) =~ s/.*:://;
  62.     #reset $! to zero to reset any current errors.
  63.     $!=0;
  64.     my $val = constant($constname, @_ ? $_[0] : 0);
  65.     if ($! != 0) {
  66. #    if ($! =~ /Invalid/) {
  67. #        $AutoLoader::AUTOLOAD = $AUTOLOAD;
  68. #        goto &AutoLoader::AUTOLOAD;
  69. #    } else {
  70.         ($pack, $file, $line) = caller; undef $pack;
  71.         die "Symbol Win32::Console::$constname not defined, used at $file line $line.";
  72. #    }
  73.     }
  74.     eval "sub $AUTOLOAD { $val }";
  75.     goto &$AUTOLOAD;
  76. }
  77.  
  78.  
  79. #######################################################################
  80. # STATIC OBJECT PROPERTIES
  81. #
  82. $VERSION = "0.031";
  83.  
  84. # %HandlerRoutineStack = ();
  85. # $HandlerRoutineRegistered = 0;
  86.  
  87. #######################################################################
  88. # PUBLIC METHODS
  89. #
  90.  
  91. #======== (MAIN CONSTRUCTOR)
  92. sub new {
  93. #========
  94.     my($class, $param1, $param2) = @_;
  95.  
  96.     my $self = {};
  97.  
  98.     if(defined($param1) 
  99.     and ($param1 == constant("STD_INPUT_HANDLE",  0)
  100.     or   $param1 == constant("STD_OUTPUT_HANDLE", 0)
  101.     or   $param1 == constant("STD_ERROR_HANDLE",  0))) {
  102.  
  103.         $self->{'handle'} = _GetStdHandle($param1);
  104.  
  105.     } else {
  106.  
  107.         $param1 = constant("GENERIC_READ", 0)    | constant("GENERIC_WRITE", 0) unless $param1;
  108.         $param2 = constant("FILE_SHARE_READ", 0) | constant("FILE_SHARE_WRITE", 0) unless $param2;
  109.         $self->{'handle'} = _CreateConsoleScreenBuffer($param1, $param2, 
  110.                                                        constant("CONSOLE_TEXTMODE_BUFFER", 0));
  111.     }
  112.     bless $self, $class;
  113.     return $self;
  114. }
  115.  
  116.  
  117. #============
  118. sub Display {
  119. #============
  120.     my($self)=@_;
  121.     return undef unless ref($self);
  122.  
  123.     return _SetConsoleActiveScreenBuffer($self->{'handle'});
  124. }
  125.  
  126. #===========
  127. sub Select {
  128. #===========
  129.     ($self, $type) = @_;
  130.     return undef unless ref($self);
  131.  
  132.     return _SetStdHandle($type, $self->{'handle'});
  133. }
  134.  
  135.  
  136. #==========
  137. sub Title {
  138. #==========
  139.     my($self, $title) = @_;
  140.  
  141.     $title = $self unless ref($self);
  142.  
  143.     if(defined($title)) {
  144.       return _SetConsoleTitle($title);
  145.     } else {
  146.       return _GetConsoleTitle();
  147.     }
  148. }
  149.  
  150. #==============
  151. sub WriteChar {
  152. #==============
  153.     my($self, $text, $col, $row) = @_;
  154.     return undef unless ref($self);
  155.  
  156.     return _WriteConsoleOutputCharacter($self->{'handle'},$text,$col,$row);
  157. }
  158.  
  159. #=============
  160. sub ReadChar {
  161. #=============
  162.     my($self, $size, $col, $row) = @_;
  163.     return undef unless ref($self);
  164.   
  165.     my $buffer = (" " x $size);  
  166.     if(_ReadConsoleOutputCharacter($self->{'handle'}, $buffer, $size, $col, $row)) {
  167.         return $buffer;
  168.     } else {
  169.         return undef;
  170.     }
  171. }
  172.  
  173.  
  174.  
  175. #==============
  176. sub WriteAttr {
  177. #==============
  178.     my($self, $attr, $col, $row) = @_;
  179.     return undef unless ref($self);
  180.     return _WriteConsoleOutputAttribute($self->{'handle'}, $attr, $col, $row);
  181. }
  182.  
  183. #=============
  184. sub ReadAttr {
  185. #=============
  186.     my($self, $size, $col, $row) = @_;
  187.     return undef unless ref($self);
  188.   
  189.     return _ReadConsoleOutputAttribute($self->{'handle'}, $size, $col, $row);
  190. }
  191.  
  192.  
  193. #==========
  194. sub Write {
  195. #==========
  196.     my($self,$string) = @_;
  197.     return undef unless ref($self);
  198.     return _WriteConsole($self->{'handle'}, $string);
  199. }
  200.  
  201.  
  202. #=============
  203. sub ReadRect {
  204. #=============
  205.     my($self, $left, $top, $right, $bottom) = @_;
  206.     return undef unless ref($self);
  207.     
  208.     my $col = $right  - $left + 1;
  209.     my $row = $bottom - $top  + 1;
  210.  
  211.     my $buffer = (" " x ($col*$row*4));
  212.     if(_ReadConsoleOutput($self->{'handle'},   $buffer,
  213.                           $col,  $row, 0,      0,
  214.                           $left, $top, $right, $bottom)) {
  215.         return $buffer;
  216.     } else {
  217.         return undef;
  218.     }
  219. }
  220.  
  221.  
  222. #==============
  223. sub WriteRect {
  224. #==============
  225.     my($self, $buffer, $left, $top, $right, $bottom) = @_;
  226.     return undef unless ref($self);
  227.  
  228.     my $col = $right  - $left + 1;
  229.     my $row = $bottom - $top  + 1;
  230.  
  231.     return _WriteConsoleOutput($self->{'handle'},   $buffer,
  232.                                $col,  $row, 0,  0,
  233.                                $left, $top, $right, $bottom);
  234. }
  235.  
  236.  
  237.  
  238. #===========
  239. sub Scroll {
  240. #===========
  241.     my($self, $left1, $top1, $right1, $bottom1,
  242.               $col,   $row,  $char,   $attr,
  243.               $left2, $top2, $right2, $bottom2) = @_;
  244.     return undef unless ref($self);
  245.   
  246.     return _ScrollConsoleScreenBuffer($self->{'handle'},
  247.                                       $left1, $top1, $right1, $bottom1,
  248.                                       $col,   $row,  $char,   $attr,
  249.                                       $left2, $top2, $right2, $bottom2);
  250. }
  251.  
  252.  
  253. #==============
  254. sub MaxWindow {
  255. #==============
  256.     my($self, $flag) = @_;
  257.     return undef unless ref($self);
  258.   
  259.     if(not defined($flag)) {
  260.         my @info = _GetConsoleScreenBufferInfo($self->{'handle'});
  261.         return $info[9], $info[10];
  262.     } else {
  263.         return _GetLargestConsoleWindowSize($self->{'handle'});
  264.     }
  265. }
  266.  
  267. #=========
  268. sub Info {
  269. #=========
  270.     my($self) = @_;
  271.     return undef unless ref($self);
  272.   
  273.     return _GetConsoleScreenBufferInfo($self->{'handle'});
  274. }
  275.  
  276.  
  277. #===========
  278. sub Window {
  279. #===========
  280.     my($self, $flag, $left, $top, $right, $bottom) = @_;
  281.     return undef unless ref($self);
  282.   
  283.     if(not defined($flag)) {
  284.         my @info = _GetConsoleScreenBufferInfo($self->{'handle'});
  285.         return $info[5], $info[6], $info[7], $info[8];
  286.     } else {
  287.         return _SetConsoleWindowInfo($self->{'handle'}, $flag, $left, $top, $right, $bottom);
  288.     }
  289. }
  290.  
  291. #==============
  292. sub GetEvents {
  293. #==============
  294.     my $self="";
  295.     ($self)=@_;
  296.     return undef unless ref($self);
  297.   
  298.     return _GetNumberOfConsoleInputEvents($self->{'handle'});
  299. }
  300.  
  301.  
  302. #==========
  303. sub Flush {
  304. #==========
  305.     my($self) = @_;
  306.     return undef unless ref($self);
  307.  
  308.     return _FlushConsoleInputBuffer($self->{'handle'});
  309. }
  310.  
  311. #==============
  312. sub InputChar {
  313. #==============
  314.     my($self, $number) = @_;
  315.     return undef unless ref($self);
  316.     
  317.     $number = 1 unless defined($number);
  318.   
  319.     my $buffer = (" " x $number);
  320.     if(_ReadConsole($self->{'handle'}, $buffer, $number) == $number) {
  321.         return $buffer;
  322.     } else {
  323.         return undef;
  324.     }
  325. }
  326.  
  327. #==========
  328. sub Input {
  329. #==========
  330.     my($self) = @_;
  331.     return undef unless ref($self);
  332.   
  333.     return _ReadConsoleInput($self->{'handle'});
  334. }
  335.  
  336. #==============
  337. sub PeekInput {
  338. #==============
  339.     my($self) = @_;
  340.     return undef unless ref($self);
  341.   
  342.     return _PeekConsoleInput($self->{'handle'});
  343. }
  344.  
  345.  
  346. #===============
  347. sub WriteInput {
  348. #===============
  349.     my($self) = shift;
  350.     return undef unless ref($self);
  351.   
  352.     return _WriteConsoleInput($self->{'handle'}, @_);
  353. }
  354.  
  355.  
  356. #=========
  357. sub Mode {
  358. #=========
  359.     my($self, $mode) = @_;
  360.     return undef unless ref($self);
  361.   
  362.     if(defined($mode)) {
  363.         return _SetConsoleMode($self->{'handle'}, $mode);
  364.     } else {
  365.         return _GetConsoleMode($self->{'handle'});
  366.     }
  367. }
  368.  
  369. #========
  370. sub Cls {
  371. #========
  372.     my($self, $attr) = @_;
  373.     return undef unless ref($self);
  374.  
  375.     $attr = $main::ATTR_NORMAL unless defined($attr);
  376.     
  377.     my ($x, $y) = $self->Size();
  378.     my($left, $top, $right ,$bottom) = $self->Window();
  379.     my $vx = $right  - $left;
  380.     my $vy = $bottom - $top;
  381.     $self->FillChar(" ", $x*$y, 0, 0);
  382.     $self->FillAttr($attr, $x*$y, 0, 0);
  383.     $self->Cursor(0, 0);
  384.     $self->Window(1, 0, 0, $vx, $vy);
  385. }
  386.  
  387.  
  388. #=========
  389. sub Attr {
  390. #=========
  391.     my($self, $attr) = @_;
  392.     return undef unless ref($self);
  393.   
  394.     if(not defined($attr)) {
  395.         return (_GetConsoleScreenBufferInfo($self->{'handle'}))[4];
  396.     } else {
  397.         return _SetConsoleTextAttribute($self->{'handle'}, $attr);
  398.     }
  399. }
  400.  
  401. #===========
  402. sub Cursor {
  403. #===========
  404.     my($self, $col, $row, $size, $visi) = @_;
  405.     return undef unless ref($self);
  406.  
  407.     my $curr_row  = 0;
  408.     my $curr_col  = 0;
  409.     my $curr_size = 0;
  410.     my $curr_visi = 0;
  411.     my $return    = 0;
  412.     my $discard   = 0;
  413.  
  414.   
  415.     if(defined($col)) {
  416.         $row = -1 if not defined($row);
  417.         if($col == -1 or $row == -1) {
  418.             ($discard, $discard, $curr_col, $curr_row) = _GetConsoleScreenBufferInfo($self->{'handle'});
  419.             $col=$curr_col if $col==-1;
  420.             $row=$curr_row if $row==-1;
  421.         }
  422.         $return += _SetConsoleCursorPosition($self->{'handle'}, $col, $row);
  423.         if(defined($size) and defined($visi)) {
  424.             if($size == -1 or $visi == -1) {
  425.                 ($curr_size, $curr_visi) = _GetConsoleCursorInfo($self->{'handle'});
  426.                 $size = $curr_size if $size == -1;
  427.                 $visi = $curr_visi if $visi == -1;
  428.             }
  429.             $size = 1 if $size < 1;
  430.             $size = 99 if $size > 99;
  431.             $return += _SetConsoleCursorInfo($self->{'handle'}, $size, $visi);
  432.         }
  433.         return $return;
  434.     } else {
  435.         ($discard, $discard, $curr_col, $curr_row) = _GetConsoleScreenBufferInfo($self->{'handle'});
  436.         ($curr_size, $curr_visi) = _GetConsoleCursorInfo($self->{'handle'});
  437.         return ($curr_col, $curr_row, $curr_size, $curr_visi);
  438.     }
  439. }
  440.   
  441. #=========
  442. sub Size {
  443. #=========
  444.     my($self, $col, $row) = @_;
  445.     return undef unless ref($self);
  446.     if(not defined($col)) {
  447.         ($col, $row) = _GetConsoleScreenBufferInfo($self->{'handle'});
  448.         return ($col, $row);
  449.     } else {
  450.         $row = -1 if not defined($row);
  451.         if($col == -1 or $row == -1) {
  452.             ($curr_col, $curr_row) = _GetConsoleScreenBufferInfo($self->{'handle'});
  453.             $col=$curr_col if $col==-1;
  454.             $row=$curr_row if $row==-1;
  455.         }
  456.         return _SetConsoleScreenBufferSize($self->{'handle'}, $col, $row);
  457.     }
  458. }
  459.  
  460. #=============
  461. sub FillAttr {
  462. #=============
  463.     my($self, $attr, $number, $col, $row) = @_;
  464.     return undef unless ref($self);
  465.  
  466.     $number = 1 unless $number;
  467.  
  468.     if(!defined($col) or !defined($row) or $col == -1 or $row == -1) {
  469.         ($discard,  $discard, 
  470.          $curr_col, $curr_row) = _GetConsoleScreenBufferInfo($self->{'handle'});
  471.         $col = $curr_col if !defined($col) or $col == -1;
  472.         $row = $curr_row if !defined($row) or $row == -1;
  473.     }
  474.     return _FillConsoleOutputAttribute($self->{'handle'}, $attr, $number, $col, $row);
  475. }
  476.  
  477. #=============
  478. sub FillChar {
  479. #=============
  480.     my($self, $char, $number, $col, $row) = @_;
  481.     return undef unless ref($self);
  482.  
  483.     if(!defined($col) or !defined($row) or $col == -1 or $row == -1) {
  484.         ($discard,  $discard,
  485.          $curr_col, $curr_row) = _GetConsoleScreenBufferInfo($self->{'handle'});
  486.         $col = $curr_col if !defined($col) or $col == -1;
  487.         $row = $curr_row if !defined($row) or $row == -1;
  488.     }
  489.     return _FillConsoleOutputCharacter($self->{'handle'}, $char, $number, $col, $row);
  490. }
  491.  
  492. #============
  493. sub InputCP {
  494. #============
  495.     my($self, $codepage) = @_;
  496.     $codepage = $self if (defined($self) and ref($self) ne "Win32::Console");
  497.     if(defined($codepage)) {
  498.         return _SetConsoleCP($codepage);
  499.     } else {
  500.         return _GetConsoleCP();
  501.     }
  502. }
  503.  
  504. #=============
  505. sub OutputCP {
  506. #=============
  507.     my($self, $codepage) = @_;
  508.     $codepage = $self if (defined($self) and ref($self) ne "Win32::Console");
  509.     if(defined($codepage)) {
  510.         return _SetConsoleOutputCP($codepage);
  511.     } else {
  512.         return _GetConsoleOutputCP();
  513.     }
  514. }
  515.  
  516. #======================
  517. sub GenerateCtrlEvent {
  518. #======================
  519.     my($self, $type, $pid) = @_;
  520.     $type = constant("CTRL_C_EVENT", 0) unless defined($type);
  521.     $pid = 0 unless defined($pid);
  522.     return _GenerateConsoleCtrlEvent($type, $pid);
  523. }
  524.  
  525. #===================
  526. #sub SetCtrlHandler {
  527. #===================
  528. #    my($name, $add) = @_;
  529. #    $add = 1 unless defined($add);
  530. #    my @nor = keys(%HandlerRoutineStack);
  531. #    if($add == 0) {
  532. #        foreach $key (@nor) {
  533. #            delete $HandlerRoutineStack{$key}, last if $HandlerRoutineStack{$key}==$name;
  534. #        }
  535. #        $HandlerRoutineRegistered--;
  536. #    } else {
  537. #        if($#nor == -1) {
  538. #            my $r = _SetConsoleCtrlHandler();
  539. #            if(!$r) {
  540. #                print "WARNING: SetConsoleCtrlHandler failed...\n";
  541. #            }
  542. #        }
  543. #        $HandlerRoutineRegistered++;
  544. #        $HandlerRoutineStack{$HandlerRoutineRegistered} = $name;
  545. #    }
  546. #}
  547.  
  548.  
  549. ########################################################################
  550. # PRIVATE METHODS
  551. #
  552.  
  553. #================
  554. #sub CtrlHandler {
  555. #================
  556. #    my($ctrltype) = @_;
  557. #    my $routine;
  558. #    my $result = 0;
  559. #    CALLEM: foreach $routine (sort { $b <=> $a } keys %HandlerRoutineStack) {
  560. #        #print "CtrlHandler: calling $HandlerRoutineStack{$routine}($ctrltype)\n";
  561. #        $result = &{"main::".$HandlerRoutineStack{$routine}}($ctrltype);
  562. #        last CALLEM if $result;
  563. #    }
  564. #    return $result;
  565. #}
  566.  
  567. #============  (MAIN DESTRUCTOR)
  568. sub DESTROY {
  569. #============
  570.     my($self) = @_;
  571.     _CloseHandle($self->{'handle'});
  572. }
  573.  
  574.  
  575.  
  576. #######################################################################
  577. # dynamically load in the Console.pll module.
  578. #
  579.  
  580. bootstrap Win32::Console;
  581.  
  582. #######################################################################
  583. # ADDITIONAL CONSTANTS EXPORTED IN THE MAIN NAMESPACE
  584. #
  585.  
  586. $main::FG_BLACK        = 0;
  587. $main::FG_BLUE         = constant("FOREGROUND_BLUE",0);
  588. $main::FG_LIGHTBLUE    = constant("FOREGROUND_BLUE",0)|
  589.                          constant("FOREGROUND_INTENSITY",0);
  590. $main::FG_RED          = constant("FOREGROUND_RED",0);
  591. $main::FG_LIGHTRED     = constant("FOREGROUND_RED",0)|
  592.                          constant("FOREGROUND_INTENSITY",0);
  593. $main::FG_GREEN        = constant("FOREGROUND_GREEN",0);
  594. $main::FG_LIGHTGREEN   = constant("FOREGROUND_GREEN",0)|
  595.                          constant("FOREGROUND_INTENSITY",0);
  596. $main::FG_MAGENTA      = constant("FOREGROUND_RED",0)|
  597.                          constant("FOREGROUND_BLUE",0);
  598. $main::FG_LIGHTMAGENTA = constant("FOREGROUND_RED",0)|
  599.                          constant("FOREGROUND_BLUE",0)|
  600.                          constant("FOREGROUND_INTENSITY",0);
  601. $main::FG_CYAN         = constant("FOREGROUND_GREEN",0)|
  602.                          constant("FOREGROUND_BLUE",0);
  603. $main::FG_LIGHTCYAN    = constant("FOREGROUND_GREEN",0)|
  604.                          constant("FOREGROUND_BLUE",0)|
  605.                          constant("FOREGROUND_INTENSITY",0);
  606. $main::FG_BROWN        = constant("FOREGROUND_RED",0)|
  607.                          constant("FOREGROUND_GREEN",0);
  608. $main::FG_YELLOW       = constant("FOREGROUND_RED",0)|
  609.                          constant("FOREGROUND_GREEN",0)|
  610.                          constant("FOREGROUND_INTENSITY",0);
  611. $main::FG_GRAY         = constant("FOREGROUND_RED",0)|
  612.                          constant("FOREGROUND_GREEN",0)|
  613.                          constant("FOREGROUND_BLUE",0);
  614. $main::FG_WHITE        = constant("FOREGROUND_RED",0)|
  615.                          constant("FOREGROUND_GREEN",0)|
  616.                          constant("FOREGROUND_BLUE",0)|
  617.                          constant("FOREGROUND_INTENSITY",0);
  618.  
  619. $main::BG_BLACK        = 0;
  620. $main::BG_BLUE         = constant("BACKGROUND_BLUE",0);
  621. $main::BG_LIGHTBLUE    = constant("BACKGROUND_BLUE",0)|
  622.                          constant("BACKGROUND_INTENSITY",0);
  623. $main::BG_RED          = constant("BACKGROUND_RED",0);
  624. $main::BG_LIGHTRED     = constant("BACKGROUND_RED",0)|
  625.                          constant("BACKGROUND_INTENSITY",0);
  626. $main::BG_GREEN        = constant("BACKGROUND_GREEN",0);
  627. $main::BG_LIGHTGREEN   = constant("BACKGROUND_GREEN",0)|
  628.                          constant("BACKGROUND_INTENSITY",0);
  629. $main::BG_MAGENTA      = constant("BACKGROUND_RED",0)|
  630.                          constant("BACKGROUND_BLUE",0);
  631. $main::BG_LIGHTMAGENTA = constant("BACKGROUND_RED",0)|
  632.                          constant("BACKGROUND_BLUE",0)|
  633.                          constant("BACKGROUND_INTENSITY",0);
  634. $main::BG_CYAN         = constant("BACKGROUND_GREEN",0)|
  635.                          constant("BACKGROUND_BLUE",0);
  636. $main::BG_LIGHTCYAN    = constant("BACKGROUND_GREEN",0)|
  637.                          constant("BACKGROUND_BLUE",0)|
  638.                          constant("BACKGROUND_INTENSITY",0);
  639. $main::BG_BROWN        = constant("BACKGROUND_RED",0)|
  640.                          constant("BACKGROUND_GREEN",0);
  641. $main::BG_YELLOW       = constant("BACKGROUND_RED",0)|
  642.                          constant("BACKGROUND_GREEN",0)|
  643.                          constant("BACKGROUND_INTENSITY",0);
  644. $main::BG_GRAY         = constant("BACKGROUND_RED",0)|
  645.                          constant("BACKGROUND_GREEN",0)|
  646.                          constant("BACKGROUND_BLUE",0);
  647. $main::BG_WHITE        = constant("BACKGROUND_RED",0)|
  648.                          constant("BACKGROUND_GREEN",0)|
  649.                          constant("BACKGROUND_BLUE",0)|
  650.                          constant("BACKGROUND_INTENSITY",0);
  651.  
  652. $main::ATTR_NORMAL = $main::FG_GRAY|$main::BG_BLACK;
  653. $main::ATTR_INVERSE = $main::FG_BLACK|$main::BG_GRAY;
  654.  
  655. undef unless $main::ATTR_NORMAL;
  656. undef unless $main::ATTR_INVERSE;
  657. undef unless $VERSION;
  658.  
  659. @main::CONSOLE_COLORS = ();
  660.  
  661. foreach $fg ($main::FG_BLACK, $main::FG_BLUE, $main::FG_GREEN, $main::FG_CYAN, 
  662.              $main::FG_RED, $main::FG_MAGENTA, $main::FG_BROWN, $main::FG_GRAY,
  663.              $main::FG_LIGHTBLUE, $main::FG_LIGHTGREEN, $main::FG_LIGHTCYAN,
  664.              $main::FG_LIGHTRED, $main::FG_LIGHTMAGENTA, $main::FG_YELLOW, 
  665.              $main::FG_WHITE) {
  666.  
  667.     foreach $bg ($main::BG_BLACK, $main::BG_BLUE, $main::BG_GREEN, $main::BG_CYAN, 
  668.                  $main::BG_RED, $main::BG_MAGENTA, $main::BG_BROWN, $main::BG_GRAY,
  669.                  $main::BG_LIGHTBLUE, $main::BG_LIGHTGREEN, $main::BG_LIGHTCYAN,
  670.                  $main::BG_LIGHTRED, $main::BG_LIGHTMAGENTA, $main::BG_YELLOW, 
  671.                  $main::BG_WHITE) {
  672.         push(@main::CONSOLE_COLORS, $fg|$bg);
  673.     }
  674. }
  675.  
  676. undef $fg;
  677. undef $bg;
  678.  
  679. # Preloaded methods go here.
  680.  
  681. #Currently Autoloading is not implemented in Perl for win32
  682. # Autoload methods go after __END__, and are processed by the autosplit program.
  683.  
  684. 1;
  685.  
  686. __END__
  687.  
  688. =head1 NAME
  689.  
  690. Win32::Console - Win32 Console and Character Mode Functions
  691.  
  692.  
  693. =head1 DESCRIPTION
  694.  
  695. This module implements the Win32 console and character mode
  696. functions.  They give you full control on the console input and output,
  697. including: support of off-screen console buffers (eg. multiple screen
  698. pages)
  699.  
  700. =over
  701.  
  702. =item *
  703.  
  704. reading and writing of characters, attributes and whole portions of
  705. the screen
  706.  
  707. =item *
  708.  
  709. complete processing of keyboard and mouse events
  710.  
  711. =item *
  712.  
  713. some very funny additional features :)
  714.  
  715. =back
  716.  
  717. Those functions should also make possible a port of the Unix's curses
  718. library; if there is anyone interested (and/or willing to contribute)
  719. to this project, e-mail me.  Thank you.
  720.  
  721.  
  722. =head1 REFERENCE
  723.  
  724.  
  725. =head2 Methods
  726.  
  727. =over
  728.  
  729. =item Alloc
  730.  
  731. Allocates a new console for the process.  Returns C<undef> on errors, a
  732. nonzero value on success.  A process cannot be associated with more
  733. than one console, so this method will fail if there is already an
  734. allocated console.  Use Free to detach the process from the console,
  735. and then call Alloc to create a new console.  See also: C<Free>
  736.  
  737. Example:
  738.  
  739.     $CONSOLE->Alloc();
  740.  
  741. =item Attr [attr]
  742.  
  743. Gets or sets the current console attribute.  This attribute is used by
  744. the Write method.
  745.  
  746. Example:
  747.  
  748.     $attr = $CONSOLE->Attr();
  749.     $CONSOLE->Attr($FG_YELLOW | $BG_BLUE);
  750.  
  751. =item Close
  752.  
  753. Closes a shortcut object.  Note that it is not "strictly" required to
  754. close the objects you created, since the Win32::Shortcut objects are
  755. automatically closed when the program ends (or when you elsehow
  756. destroy such an object).
  757.  
  758. Example:
  759.  
  760.     $LINK->Close();
  761.  
  762. =item Cls [attr]
  763.  
  764. Clear the console, with the specified I<attr> if given, or using
  765. ATTR_NORMAL otherwise.
  766.  
  767. Example:
  768.  
  769.     $CONSOLE->Cls();
  770.     $CONSOLE->Cls($FG_WHITE | $BG_GREEN);
  771.  
  772. =item Cursor [x, y, size, visible]
  773.  
  774. Gets or sets cursor position and appearance.  Returns C<undef> on
  775. errors, or a 4-element list containing: I<x>, I<y>, I<size>,
  776. I<visible>.  I<x> and I<y> are the current cursor position; ...
  777.  
  778. Example:
  779.  
  780.     ($x, $y, $size, $visible) = $CONSOLE->Cursor();
  781.  
  782.     # Get position only
  783.     ($x, $y) = $CONSOLE->Cursor();
  784.  
  785.     $CONSOLE->Cursor(40, 13, 50, 1);
  786.  
  787.     # Set position only
  788.     $CONSOLE->Cursor(40, 13);
  789.  
  790.     # Set size and visibility without affecting position
  791.     $CONSOLE->Cursor(-1, -1, 50, 1);
  792.  
  793. =item Display
  794.  
  795. Displays the specified console on the screen.  Returns C<undef> on errors,
  796. a nonzero value on success.
  797.  
  798. Example:
  799.  
  800.     $CONSOLE->Display();
  801.  
  802. =item FillAttr [attribute, number, col, row]
  803.  
  804. Fills the specified number of consecutive attributes, beginning at
  805. I<col>, I<row>, with the value specified in I<attribute>.  Returns the
  806. number of attributes filled, or C<undef> on errors.  See also:
  807. C<FillChar>.
  808.  
  809. Example:
  810.  
  811.     $CONSOLE->FillAttr($FG_BLACK | $BG_BLACK, 80*25, 0, 0);
  812.  
  813. =item FillChar char, number, col, row
  814.  
  815. Fills the specified number of consecutive characters, beginning at
  816. I<col>, I<row>, with the character specified in I<char>.  Returns the
  817. number of characters filled, or C<undef> on errors.  See also:
  818. C<FillAttr>.
  819.  
  820. Example:
  821.  
  822.     $CONSOLE->FillChar("X", 80*25, 0, 0);
  823.  
  824. =item Flush
  825.  
  826. Flushes the console input buffer.  All the events in the buffer are
  827. discarded.  Returns C<undef> on errors, a nonzero value on success.
  828.  
  829. Example:
  830.  
  831.     $CONSOLE->Flush();
  832.  
  833. =item Free
  834.  
  835. Detaches the process from the console.  Returns C<undef> on errors, a
  836. nonzero value on success.  See also: C<Alloc>.
  837.  
  838. Example:
  839.  
  840.     $CONSOLE->Free();
  841.  
  842. =item GenerateCtrlEvent [type, processgroup]
  843.  
  844. Sends a break signal of the specified I<type> to the specified
  845. I<processgroup>.  I<type> can be one of the following constants:
  846.  
  847.     CTRL_BREAK_EVENT
  848.     CTRL_C_EVENT
  849.  
  850. they signal, respectively, the pressing of Control + Break and of
  851. Control + C; if not specified, it defaults to CTRL_C_EVENT.
  852. I<processgroup> is the pid of a process sharing the same console.  If
  853. omitted, it defaults to 0 (the current process), which is also the
  854. only meaningful value that you can pass to this function.  Returns
  855. C<undef> on errors, a nonzero value on success.
  856.  
  857. Example:
  858.  
  859.     # break this script now
  860.     $CONSOLE->GenerateCtrlEvent();
  861.  
  862. =item GetEvents
  863.  
  864. Returns the number of unread input events in the console's input
  865. buffer, or C<undef> on errors.  See also: C<Input>, C<InputChar>,
  866. C<PeekInput>, C<WriteInput>.
  867.  
  868. Example:
  869.  
  870.     $events = $CONSOLE->GetEvents();
  871.  
  872. =item Info
  873.  
  874. Returns an array of informations about the console (or C<undef> on
  875. errors), which contains:
  876.  
  877. =over
  878.  
  879. =item *
  880.  
  881. columns (X size) of the console buffer.
  882.  
  883. =item *
  884.  
  885. rows (Y size) of the console buffer.
  886.  
  887. =item *
  888.  
  889. current column (X position) of the cursor.
  890.  
  891. =item *
  892.  
  893. current row (Y position) of the cursor.
  894.  
  895. =item *
  896.  
  897. current attribute used for C<Write>.
  898.  
  899. =item *
  900.  
  901. left column (X of the starting point) of the current console window.
  902.  
  903. =item *
  904.  
  905. top row (Y of the starting point) of the current console window.
  906.  
  907. =item *
  908.  
  909. right column (X of the final point) of the current console window.
  910.  
  911. =item *
  912.  
  913. bottom row (Y of the final point) of the current console window.
  914.  
  915. =item *
  916.  
  917. maximum number of columns for the console window, given the current
  918. buffer size, font and the screen size.
  919.  
  920. =item *
  921.  
  922. maximum number of rows for the console window, given the current
  923. buffer size, font and the screen size.
  924.  
  925. =back
  926.  
  927. See also: C<Attr>, C<Cursor>, C<Size>, C<Window>, C<MaxWindow>.
  928.  
  929. Example:
  930.  
  931.     @info = $CONSOLE->Info();
  932.     print "Cursor at $info[3], $info[4].\n";
  933.  
  934. =item Input
  935.  
  936. Reads an event from the input buffer.  Returns a list of values, which
  937. depending on the event's nature are:
  938.  
  939. =over
  940.  
  941. =item keyboard event
  942.  
  943. The list will contain:
  944.  
  945. =over
  946.  
  947. =item *
  948.  
  949. event type: 1 for keyboard
  950.  
  951. =item *
  952.  
  953. key down: TRUE if the key is being pressed, FALSE if the key is being released
  954.  
  955. =item *
  956.  
  957. repeat count: the number of times the key is being held down
  958.  
  959. =item *
  960.  
  961. virtual keycode: the virtual key code of the key
  962.  
  963. =item *
  964.  
  965. virtual scancode: the virtual scan code of the key
  966.  
  967. =item *
  968.  
  969. char: the ASCII code of the character (if the key is a character key, 0 otherwise)
  970.  
  971. =item *
  972.  
  973. control key state: the state of the control keys (SHIFTs, CTRLs, ALTs, etc.)
  974.  
  975. =back
  976.  
  977. =item mouse event
  978.  
  979. The list will contain:
  980.  
  981. =over
  982.  
  983. =item *
  984.  
  985. event type: 2 for mouse
  986.  
  987. =item *
  988.  
  989. mouse pos. X: X coordinate (column) of the mouse location
  990.  
  991. =item *
  992.  
  993. mouse pos. Y: Y coordinate (row) of the mouse location
  994.  
  995. =item *
  996.  
  997. button state: the mouse button(s) which are pressed
  998.  
  999. =item *
  1000.  
  1001. control key state: the state of the control keys (SHIFTs, CTRLs, ALTs, etc.)
  1002.  
  1003. =item *
  1004.  
  1005. event flags: the type of the mouse event
  1006.  
  1007. =back
  1008.  
  1009. =back
  1010.  
  1011. This method will return C<undef> on errors.  Note that the events
  1012. returned are depending on the input C<Mode> of the console; for example,
  1013. mouse events are not intercepted unless ENABLE_MOUSE_INPUT is
  1014. specified.  See also: C<GetEvents>, C<InputChar>, C<Mode>,
  1015. C<PeekInput>, C<WriteInput>.
  1016.  
  1017. Example:
  1018.  
  1019.     @event = $CONSOLE->Input();
  1020.  
  1021. =item InputChar number
  1022.  
  1023. Reads and returns I<number> characters from the console input buffer,
  1024. or C<undef> on errors.  See also: C<Input>, C<Mode>.
  1025.  
  1026. Example:
  1027.  
  1028.     $key = $CONSOLE->InputChar(1);
  1029.  
  1030. =item InputCP [codepage]
  1031.  
  1032. Gets or sets the input code page used by the console.  Note that this
  1033. doesn't apply to a console object, but to the standard input
  1034. console.  This attribute is used by the Write method.  See also:
  1035. C<OutputCP>.
  1036.  
  1037. Example:
  1038.  
  1039.     $codepage = $CONSOLE->InputCP();
  1040.     $CONSOLE->InputCP(437);
  1041.  
  1042.     # you may want to use the non-instanciated form to avoid confuzion :)
  1043.     $codepage = Win32::Console::InputCP();
  1044.     Win32::Console::InputCP(437);
  1045.  
  1046. =item MaxWindow
  1047.  
  1048. Returns the size of the largest possible console window, based on the
  1049. current font and the size of the display.  The result is C<undef> on
  1050. errors, otherwise a 2-element list containing col, row.
  1051.  
  1052. Example:
  1053.  
  1054.     ($maxCol, $maxRow) = $CONSOLE->MaxWindow();
  1055.  
  1056. =item Mode [flags]
  1057.  
  1058. Gets or sets the input or output mode of a console.  I<flags> can be a
  1059. combination of the following constants:
  1060.  
  1061.     ENABLE_LINE_INPUT
  1062.     ENABLE_ECHO_INPUT
  1063.     ENABLE_PROCESSED_INPUT
  1064.     ENABLE_WINDOW_INPUT
  1065.     ENABLE_MOUSE_INPUT
  1066.     ENABLE_PROCESSED_OUTPUT
  1067.     ENABLE_WRAP_AT_EOL_OUTPUT
  1068.  
  1069. For more informations on the meaning of those flags, please refer to
  1070. the L<"Microsoft's Documentation">.
  1071.  
  1072. Example:
  1073.  
  1074.     $mode = $CONSOLE->Mode();
  1075.     $CONSOLE->Mode(ENABLE_MOUSE_INPUT | ENABLE_PROCESSED_INPUT);
  1076.  
  1077. =item MouseButtons
  1078.  
  1079. Returns the number of the buttons on your mouse, or C<undef> on errors.
  1080.  
  1081. Example:
  1082.  
  1083.     print "Your mouse has ", $CONSOLE->MouseButtons(), " buttons.\n";
  1084.  
  1085. =item new Win32::Console standard_handle
  1086.  
  1087. =item new Win32::Console [accessmode, sharemode]
  1088.  
  1089. Creates a new console object.  The first form creates a handle to a
  1090. standard channel, I<standard_handle> can be one of the following:
  1091.  
  1092.     STD_OUTPUT_HANDLE
  1093.     STD_ERROR_HANDLE
  1094.     STD_INPUT_HANDLE
  1095.  
  1096. The second form, instead, creates a console screen buffer in memory,
  1097. which you can access for reading and writing as a normal console, and
  1098. then redirect on the standard output (the screen) with C<Display>.  In
  1099. this case, you can specify one or both of the following values for
  1100. I<accessmode>:
  1101.  
  1102.     GENERIC_READ
  1103.     GENERIC_WRITE
  1104.  
  1105. which are the permissions you will have on the created buffer, and one
  1106. or both of the following values for I<sharemode>:
  1107.  
  1108.     FILE_SHARE_READ
  1109.     FILE_SHARE_WRITE
  1110.  
  1111. which affect the way the console can be shared.  If you don't specify
  1112. any of those parameters, all 4 flags will be used.
  1113.  
  1114. Example:
  1115.  
  1116.     $STDOUT = new Win32::Console(STD_OUTPUT_HANDLE);
  1117.     $STDERR = new Win32::Console(STD_ERROR_HANDLE);
  1118.     $STDIN  = new Win32::Console(STD_INPUT_HANDLE);
  1119.  
  1120.     $BUFFER = new Win32::Console();
  1121.     $BUFFER = new Win32::Console(GENERIC_READ | GENERIC_WRITE);
  1122.  
  1123. =item OutputCP [codepage]
  1124.  
  1125. Gets or sets the output code page used by the console.  Note that this
  1126. doesn't apply to a console object, but to the standard output console.
  1127. See also: C<InputCP>.
  1128.  
  1129. Example:
  1130.  
  1131.     $codepage = $CONSOLE->OutputCP();
  1132.     $CONSOLE->OutputCP(437);
  1133.  
  1134.     # you may want to use the non-instanciated form to avoid confuzion :)
  1135.     $codepage = Win32::Console::OutputCP();
  1136.     Win32::Console::OutputCP(437);
  1137.  
  1138. =item PeekInput
  1139.  
  1140. Does exactly the same as C<Input>, except that the event read is not
  1141. removed from the input buffer.  See also: C<GetEvents>, C<Input>,
  1142. C<InputChar>, C<Mode>, C<WriteInput>.
  1143.  
  1144. Example:
  1145.  
  1146.     @event = $CONSOLE->PeekInput();
  1147.  
  1148. =item ReadAttr [number, col, row]
  1149.  
  1150. Reads the specified I<number> of consecutive attributes, beginning at
  1151. I<col>, I<row>, from the console.  Returns the attributes read (a
  1152. variable containing one character for each attribute), or C<undef> on
  1153. errors.  You can then pass the returned variable to C<WriteAttr> to
  1154. restore the saved attributes on screen.  See also: C<ReadChar>,
  1155. C<ReadRect>.
  1156.  
  1157. Example:
  1158.  
  1159.     $colors = $CONSOLE->ReadAttr(80*25, 0, 0);
  1160.  
  1161. =item ReadChar [number, col, row]
  1162.  
  1163. Reads the specified I<number> of consecutive characters, beginning at
  1164. I<col>, I<row>, from the console.  Returns a string containing the
  1165. characters read, or C<undef> on errors.  You can then pass the
  1166. returned variable to C<WriteChar> to restore the saved characters on
  1167. screen.  See also: C<ReadAttr>, C<ReadRect>.
  1168.  
  1169. Example:
  1170.  
  1171.     $chars = $CONSOLE->ReadChar(80*25, 0, 0);
  1172.  
  1173. =item ReadRect left, top, right, bottom
  1174.  
  1175. Reads the content (characters and attributes) of the rectangle
  1176. specified by I<left>, I<top>, I<right>, I<bottom> from the console.
  1177. Returns a string containing the rectangle read, or C<undef> on errors.
  1178. You can then pass the returned variable to C<WriteRect> to restore the
  1179. saved rectangle on screen (or on another console).  See also:
  1180. C<ReadAttr>, C<ReadChar>.
  1181.  
  1182. Example:
  1183.  
  1184.      $rect = $CONSOLE->ReadRect(0, 0, 80, 25);
  1185.  
  1186. =item Scroll left, top, right, bottom, col, row, char, attr,
  1187.              [cleft, ctop, cright, cbottom]
  1188.  
  1189. Moves a block of data in a console buffer; the block is identified by
  1190. I<left>, I<top>, I<right>, I<bottom>, while I<row>, I<col> identify
  1191. the new location of the block.  The cells left empty as a result of
  1192. the move are filled with the character I<char> and attribute I<attr>.
  1193. Optionally you can specify a clipping region with I<cleft>, I<ctop>,
  1194. I<cright>, I<cbottom>, so that the content of the console outside this
  1195. rectangle are unchanged.  Returns C<undef> on errors, a nonzero value
  1196. on success.
  1197.  
  1198. Example:
  1199.  
  1200.     # scrolls the screen 10 lines down, filling with black spaces
  1201.     $CONSOLE->Scroll(0, 0, 80, 25, 0, 10, " ", $FG_BLACK | $BG_BLACK);
  1202.  
  1203. =item Select standard_handle
  1204.  
  1205. Redirects a standard handle to the specified console.
  1206. I<standard_handle> can have one of the following values:
  1207.  
  1208.     STD_INPUT_HANDLE
  1209.     STD_OUTPUT_HANDLE
  1210.     STD_ERROR_HANDLE
  1211.  
  1212. Returns C<undef> on errors, a nonzero value on success.
  1213.  
  1214. Example:
  1215.  
  1216.     $CONSOLE->Select(STD_OUTPUT_HANDLE);
  1217.  
  1218. =item Size [col, row]
  1219.  
  1220. Gets or sets the console buffer size.
  1221.  
  1222. Example:
  1223.  
  1224.     ($x, $y) = $CONSOLE->Size();
  1225.     $CONSOLE->Size(80, 25);
  1226.  
  1227. =item Title [title]
  1228.  
  1229. Gets or sets the title bar the string of the current console window.
  1230.  
  1231. Example:
  1232.  
  1233.     $title = $CONSOLE->Title();
  1234.     $CONSOLE->Title("This is a title");
  1235.  
  1236. =item Window [flag, left, top, right, bottom]
  1237.  
  1238. Gets or sets the current console window size.  If called without
  1239. arguments, returns a 4-element list containing the current window
  1240. coordinates in the form of I<left>, I<top>, I<right>, I<bottom>.  To
  1241. set the window size, you have to specify an additional I<flag>
  1242. parameter: if it is 0 (zero), coordinates are considered relative to
  1243. the current coordinates; if it is non-zero, coordinates are absolute.
  1244.  
  1245. Example:
  1246.  
  1247.     ($left, $top, $right, $bottom) = $CONSOLE->Window();
  1248.     $CONSOLE->Window(1, 0, 0, 80, 50);
  1249.  
  1250. =item Write string
  1251.  
  1252. Writes I<string> on the console, using the current attribute, that you
  1253. can set with C<Attr>, and advancing the cursor as needed.  This isn't
  1254. so different from Perl's "print" statement.  Returns the number of
  1255. characters written or C<undef> on errors.  See also: C<WriteAttr>,
  1256. C<WriteChar>, C<WriteRect>.
  1257.  
  1258. Example:
  1259.  
  1260.     $CONSOLE->Write("Hello, world!");
  1261.  
  1262. =item WriteAttr attrs, col, row
  1263.  
  1264. Writes the attributes in the string I<attrs>, beginning at I<col>,
  1265. I<row>, without affecting the characters that are on screen.  The
  1266. string attrs can be the result of a C<ReadAttr> function, or you can
  1267. build your own attribute string; in this case, keep in mind that every
  1268. attribute is treated as a character, not a number (see example).
  1269. Returns the number of attributes written or C<undef> on errors.  See
  1270. also: C<Write>, C<WriteChar>, C<WriteRect>.
  1271.  
  1272. Example:
  1273.  
  1274.     $CONSOLE->WriteAttr($attrs, 0, 0);
  1275.  
  1276.     # note the use of chr()...
  1277.     $attrs = chr($FG_BLACK | $BG_WHITE) x 80;
  1278.     $CONSOLE->WriteAttr($attrs, 0, 0);
  1279.  
  1280. =item WriteChar chars, col, row
  1281.  
  1282. Writes the characters in the string I<attr>, beginning at I<col>, I<row>,
  1283. without affecting the attributes that are on screen.  The string I<chars>
  1284. can be the result of a C<ReadChar> function, or a normal string.  Returns
  1285. the number of characters written or C<undef> on errors.  See also:
  1286. C<Write>, C<WriteAttr>, C<WriteRect>.
  1287.  
  1288. Example:
  1289.  
  1290.     $CONSOLE->WriteChar("Hello, worlds!", 0, 0);
  1291.  
  1292. =item WriteInput (event)
  1293.  
  1294. Pushes data in the console input buffer.  I<(event)> is a list of values,
  1295. for more information see C<Input>.  The string chars can be the result of
  1296. a C<ReadChar> function, or a normal string.  Returns the number of
  1297. characters written or C<undef> on errors.  See also: C<Write>,
  1298. C<WriteAttr>, C<WriteRect>.
  1299.  
  1300. Example:
  1301.  
  1302.     $CONSOLE->WriteInput(@event);
  1303.  
  1304. =item WriteRect rect, left, top, right, bottom
  1305.  
  1306. Writes a rectangle of characters and attributes (contained in I<rect>)
  1307. on the console at the coordinates specified by I<left>, I<top>,
  1308. I<right>, I<bottom>.  I<rect> can be the result of a C<ReadRect>
  1309. function.  Returns C<undef> on errors, otherwise a 4-element list
  1310. containing the coordinates of the affected rectangle, in the format
  1311. I<left>, I<top>, I<right>, I<bottom>.  See also: C<Write>,
  1312. C<WriteAttr>, C<WriteChar>.
  1313.  
  1314. Example:
  1315.  
  1316.     $CONSOLE->WriteRect($rect, 0, 0, 80, 25);
  1317.  
  1318. =back
  1319.  
  1320.  
  1321. =head2 Constants
  1322.  
  1323. The following constants are exported in the main namespace of your
  1324. script using Win32::Console:
  1325.  
  1326.     BACKGROUND_BLUE
  1327.     BACKGROUND_GREEN
  1328.     BACKGROUND_INTENSITY
  1329.     BACKGROUND_RED
  1330.     CAPSLOCK_ON
  1331.     CONSOLE_TEXTMODE_BUFFER
  1332.     ENABLE_ECHO_INPUT
  1333.     ENABLE_LINE_INPUT
  1334.     ENABLE_MOUSE_INPUT
  1335.     ENABLE_PROCESSED_INPUT
  1336.     ENABLE_PROCESSED_OUTPUT
  1337.     ENABLE_WINDOW_INPUT
  1338.     ENABLE_WRAP_AT_EOL_OUTPUT
  1339.     ENHANCED_KEY
  1340.     FILE_SHARE_READ
  1341.     FILE_SHARE_WRITE
  1342.     FOREGROUND_BLUE
  1343.     FOREGROUND_GREEN
  1344.     FOREGROUND_INTENSITY
  1345.     FOREGROUND_RED
  1346.     LEFT_ALT_PRESSED
  1347.     LEFT_CTRL_PRESSED
  1348.     NUMLOCK_ON
  1349.     GENERIC_READ
  1350.     GENERIC_WRITE
  1351.     RIGHT_ALT_PRESSED
  1352.     RIGHT_CTRL_PRESSED
  1353.     SCROLLLOCK_ON
  1354.     SHIFT_PRESSED
  1355.     STD_INPUT_HANDLE
  1356.     STD_OUTPUT_HANDLE
  1357.     STD_ERROR_HANDLE
  1358.  
  1359. Additionally, the following variables can be used:
  1360.  
  1361.     $FG_BLACK
  1362.     $FG_BLUE
  1363.     $FG_LIGHTBLUE
  1364.     $FG_RED
  1365.     $FG_LIGHTRED
  1366.     $FG_GREEN
  1367.     $FG_LIGHTGREEN
  1368.     $FG_MAGENTA
  1369.     $FG_LIGHTMAGENTA
  1370.     $FG_CYAN
  1371.     $FG_LIGHTCYAN
  1372.     $FG_BROWN
  1373.     $FG_YELLOW
  1374.     $FG_GRAY
  1375.     $FG_WHITE
  1376.  
  1377.     $BG_BLACK
  1378.     $BG_BLUE
  1379.     $BG_LIGHTBLUE
  1380.     $BG_RED
  1381.     $BG_LIGHTRED
  1382.     $BG_GREEN
  1383.     $BG_LIGHTGREEN
  1384.     $BG_MAGENTA
  1385.     $BG_LIGHTMAGENTA
  1386.     $BG_CYAN
  1387.     $BG_LIGHTCYAN
  1388.     $BG_BROWN
  1389.     $BG_YELLOW
  1390.     $BG_GRAY
  1391.     $BG_WHITE
  1392.  
  1393.     $ATTR_NORMAL
  1394.     $ATTR_INVERSE
  1395.  
  1396. ATTR_NORMAL is set to gray foreground on black background (DOS's
  1397. standard colors).
  1398.  
  1399.  
  1400. =head2 Microsoft's Documentation
  1401.  
  1402. Documentation for the Win32 Console and Character mode Functions can
  1403. be found on Microsoft's site at this URL:
  1404.  
  1405. http://www.microsoft.com/msdn/sdk/platforms/doc/sdk/win32/sys/src/conchar.htm
  1406.  
  1407. A reference of the available functions is at:
  1408.  
  1409. http://www.microsoft.com/msdn/sdk/platforms/doc/sdk/win32/sys/src/conchar_34.htm
  1410.  
  1411.  
  1412. =head1 VERSION HISTORY
  1413.  
  1414. =over
  1415.  
  1416. =item * 0.031 (24 Sep 1999)
  1417.  
  1418. =over
  1419.  
  1420. =item *
  1421.  
  1422. Fixed typo in GenerateCtrlEvent().
  1423.  
  1424. =item *
  1425.  
  1426. Converted and added pod documentation (from Jan Dubois <jand@activestate.com>).
  1427.  
  1428. =back
  1429.  
  1430. =item * 0.03 (07 Apr 1997)
  1431.  
  1432. =over
  1433.  
  1434. =item *
  1435.  
  1436. Added "GenerateCtrlEvent" method.
  1437.  
  1438. =item *
  1439.  
  1440. The PLL file now comes in 2 versions, one for Perl version 5.001
  1441. (build 110) and one for Perl version 5.003 (build 300 and higher,
  1442. EXCEPT 304).
  1443.  
  1444. =item *
  1445.  
  1446. added an installation program that will automatically copy the right
  1447. version in the right place.
  1448.  
  1449. =back
  1450.  
  1451. =item * 0.01 (09 Feb 1997)
  1452.  
  1453. =over
  1454.  
  1455. =item *
  1456.  
  1457. First public release.
  1458.  
  1459. =back
  1460.  
  1461. =back
  1462.  
  1463.  
  1464. =head1 AUTHOR
  1465.  
  1466. Aldo Calpini <a.calpini@romagiubileo.it>
  1467.  
  1468.  
  1469. =head1 CREDITS
  1470.  
  1471. Thanks to: Jesse Dougherty, Dave Roth, ActiveWare, and the
  1472. Perl-Win32-Users community.
  1473.  
  1474.  
  1475. =head1 DISCLAIMER
  1476.  
  1477. This program is FREE; you can redistribute, modify, disassemble, or
  1478. even reverse engineer this software at your will.  Keep in mind,
  1479. however, that NOTHING IS GUARANTEED to work and everything you do is
  1480. AT YOUR OWN RISK - I will not take responsibility for any damage, loss
  1481. of money and/or health that may arise from the use of this program!
  1482.  
  1483. This is distributed under the terms of Larry Wall's Artistic License.
  1484.