File Coverage

blib/lib/Win32/Scanner/EZTWAIN.pm

Criterion	Covered	Total	%
statement	13	15	86.6
branch			n/a
condition			n/a
subroutine	5	5	100.0
pod			n/a
total	18	20	90.0

package Win32::Scanner::EZTWAIN;

use warnings;
use strict;
use Carp;

require 5;

require Exporter;

use vars qw( @ISA $VERSION );

our @ISA = qw(Exporter);
our @EXPORT = qw(TWAIN_BW TWAIN_GRAY TWAIN_RGB TWAIN_PALETTE TWAIN_ANYTYPE TWAIN_ACQUIRE_SUCCESS TWAIN_ACQUIRE_FAILED TWAIN_ACQUIRE_ERROPENFILE TWAIN_ACQUIRE_WEIRD TWAIN_ACQUIRE_ERRWRITEFILE);
our $VERSION = "0.01";

use Win32::API;

###########################################################################
###
### Define variables for this module
###
###########################################################################

my $twain_select_image_source;
my $twain_acquire_to_file;
my $twain_acquire_to_clipboard;
my $twain_is_available;
my $twain_easy_version;


###########################################################################
###
### Define constants for this module, functions are exported.
###
###########################################################################

sub TWAIN_BW { 1; }
sub TWAIN_GRAY { 2; }
sub TWAIN_RGB { 4; }
sub TWAIN_PALETTE { 8; }
sub TWAIN_ANYTYPE { 0; }

# Pixel types, from the well documented C header file eztwain.h
#
# 1  1-bit per pixel, B&W.
# 2  1,4, or 8-bit grayscale.
# 4  24-bit RGB color.
# 8  1,4, or 8-bit palette.
# 0  Any of the above (recommend).

sub TWAIN_ACQUIRE_SUCCESS { 0; }
sub TWAIN_ACQUIRE_FAILED { -1; }
sub TWAIN_ACQUIRE_ERROPENFILE { -2; }
sub TWAIN_ACQUIRE_WEIRD { -3; }
sub TWAIN_ACQUIRE_ERRWRITEFILE { -4; }

#  Return values, from the well documented C header file eztwain.h
#
#  0 Success.
# -1 Acquire failed OR user cancelled File Save dialog.
# -2 File open error (invalid path or name, or access denied).
# -3 (weird) Unable to lock DIB - probably an invalid handle.
# -4 Writing BMP data failed, possibly output device is full.


###########################################################################
###
### Construct our object, and import API calls.
###
###########################################################################

sub new {
 my $class = shift;
 my %parms = @_;
 my $self;
 my $path_to_dll = "";

 if(defined $parms{-dll}) { $path_to_dll = $parms{-dll}; }

 $twain_select_image_source = new Win32::API("${path_to_dll}eztw32.dll", "TWAIN_SelectImageSource", ['N'], 'N') || croak "Importing API call TWAIN_SelectImageSource failed";
 $twain_acquire_to_file = new Win32::API("${path_to_dll}eztw32.dll", "TWAIN_AcquireToFilename", ['N', 'P'], 'N') || croak "Importing API call TWAIN_AcquireToFilename failed";
 $twain_acquire_to_clipboard = new Win32::API("${path_to_dll}eztw32.dll", "TWAIN_AcquireToClipboard", ['N', 'I'], 'N') || croak "Importing API call TWAIN_AcquireToClipboard failed";
 $twain_is_available = new Win32::API("${path_to_dll}eztw32.dll", "TWAIN_IsAvailable", undef, 'N') || croak "Importing API call TWAIN_IsAvailable failed";
 $twain_easy_version = new Win32::API("${path_to_dll}eztw32.dll", "TWAIN_EasyVersion", undef, 'N') || croak "Importing API call TWAIN_EasyVersion failed";

 %{$self} = %parms;
 bless $self, $class;
 return $self;
}


###########################################################################
###
### Methods.
###
###########################################################################

# select_image_source, acquire_to_file and acquire_to_clipboard don't need
# a windows handle. TWAIN wants to defocus and disable the application
# window that called him. According to the documented source file of
# eztw32.dll you may omit the handle. If you omit the handle, eztw32.dll
# will create an invisible proxy window. But what ever you do, don't pass
# the handle of your console window, if you do this anyway, it can really
# screw things up.

sub select_image_source
{
 my $self = shift; my $hwnd = 0;
 if(defined $self->{-hwnd}) { $hwnd = $self->{-hwnd}; }
 return $twain_select_image_source->Call($hwnd);
}

sub acquire_to_file
{
 my ($self, $file) = @_; my $hwnd = 0;
 if(defined $self->{-hwnd}) { $hwnd = $self->{-hwnd}; }
 if(!defined $file) { $file = ""; }
 return $twain_acquire_to_file->Call($hwnd, $file);
}

sub acquire_to_clipboard
{
 my($self, $pixtype)  = @_; my $hwnd = 0;
 if(defined $self->{-hwnd}) { $hwnd = $self->{-hwnd}; }
 if(!defined $pixtype) { $pixtype = TWAIN_ANYTYPE; }
 return $twain_acquire_to_clipboard->Call($hwnd, $pixtype);
}

sub is_available { return $twain_is_available->Call(); }
sub easy_version { return sprintf("%.2f", ($twain_easy_version->Call() / 100)); }

1;

__END__