forked from cosimo/perl5-win32-api
-
Notifications
You must be signed in to change notification settings - Fork 3
/
API.pm
1474 lines (1182 loc) · 50.4 KB
/
API.pm
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
# See the bottom of this file for the POD documentation. Search for the
# string '=head'.
#######################################################################
#
# Win32::API - Perl Win32 API Import Facility
#
# Author: Aldo Calpini <[email protected]>
# Maintainer: Cosimo Streppone <[email protected]>
#
# Changes for gcc/cygwin: Daniel Risacher <[email protected]>
# ported from 0.41 based on Daniel's patch by Reini Urban <[email protected]>
#
#######################################################################
package Win32::API;
use strict;
use warnings;
BEGIN {
require Exporter; # to export the constants to the main:: space
sub ISCYG ();
if($^O eq 'cygwin') {
BEGIN{warnings->unimport('uninitialized')}
die "Win32::API on Cygwin requires the cygpath tool on PATH"
if index(`cygpath --help`,'Usage: cygpath') == -1;
require File::Basename;
eval "sub ISCYG () { 1 }";
} else {
eval "sub ISCYG () { 0 }";
}
use vars qw( $DEBUG $sentinal @ISA @EXPORT_OK $VERSION );
@ISA = qw( Exporter );
@EXPORT_OK = qw( ReadMemory IsBadReadPtr MoveMemory
WriteMemory SafeReadWideCString ); # symbols to export on request
use Scalar::Util qw( looks_like_number weaken);
sub ERROR_NOACCESS () { 998 }
sub ERROR_NOT_ENOUGH_MEMORY () { 8 }
sub ERROR_INVALID_PARAMETER () { 87 }
sub APICONTROL_CC_STD () { 0 }
sub APICONTROL_CC_C () { 1 }
sub APICONTROL_CC_mask () { 0x7 }
sub APICONTROL_UseMI64 () { 0x8 }
sub APICONTROL_is_more () { 0x10 }
sub APICONTROL_has_proto() { 0x20 }
eval ' *Win32::API::Type::PTRSIZE = *Win32::API::More::PTRSIZE = *PTRSIZE = sub () { '.length(pack('p', undef)).' };'.
#Win64 added in 5.7.3
' *Win32::API::Type::IVSIZE = *Win32::API::More::IVSIZE = *IVSIZE = sub () { '.length(pack($] >= 5.007003 ? 'J' : 'I' ,0)).' };'.
' *Win32::API::Type::DEBUGCONST = *Win32::API::Struct::DEBUGCONST = *DEBUGCONST = sub () { '.(!!$DEBUG+0).' };'
}
sub DEBUG {
#checking flag redundant now, but keep in case of an accidental unprotected call
if ($Win32::API::DEBUG) {
printf @_ if @_ or return 1;
}
else {
return 0;
}
}
use Win32::API::Type ();
use Win32::API::Struct ();
#######################################################################
# STATIC OBJECT PROPERTIES
#
#### some package-global hash to
#### keep track of the imported
#### libraries and procedures
my %Libraries = ();
my %Procedures = ();
#######################################################################
# dynamically load in the API extension module.
# BEGIN required for constant subs in BOOT:
BEGIN {
$VERSION = '0.85';
require XSLoader;
XSLoader::load 'Win32::API', $VERSION;
}
#######################################################################
# PUBLIC METHODS
#
sub new {
die "Win32::API/More::new/Import is a class method that takes 2 to 6 parameters, see POD"
if @_ < 3 || @_ > 7;
my ($class, $dll, $hproc, $ccnum, $outnum) = (shift, shift);
if(! defined $dll){
$hproc = shift;
}
my ($proc, $in, $out, $callconvention) = @_;
my ($hdll, $freedll, $proto, $stackunwind) = (0, 0, 0, 0);
my $self = {};
if(! defined $hproc){
if (ISCYG() and $dll ne File::Basename::basename($dll)) {
# need to convert $dll to win32 path
# isn't there an API for this?
my $newdll = `cygpath -w "$dll"`;
chomp $newdll;
DEBUG "(PM)new: converted '$dll' to\n '$newdll'\n" if DEBUGCONST;
$dll = $newdll;
}
#### avoid loading a library more than once
if (exists($Libraries{$dll})) {
DEBUG "Win32::API::new: Library '$dll' already loaded, handle=$Libraries{$dll}\n" if DEBUGCONST;
$hdll = $Libraries{$dll};
}
else {
DEBUG "Win32::API::new: Loading library '$dll'\n" if DEBUGCONST;
$hdll = Win32::API::LoadLibrary($dll);
$freedll = 1;
# $Libraries{$dll} = $hdll;
}
#### if the dll can't be loaded, set $! to Win32's GetLastError()
if (!$hdll) {
$! = Win32::GetLastError();
DEBUG "FAILED Loading library '$dll': $^E\n" if DEBUGCONST;
return undef;
}
}
else{
if(!looks_like_number($hproc) || IsBadReadPtr($hproc, 4)){
Win32::SetLastError(ERROR_NOACCESS);
DEBUG "FAILED Function pointer '$hproc' is not a valid memory location\n" if DEBUGCONST;
return undef;
}
}
#### determine if we have a prototype or not, outtype is for future use in XS
if ((not defined $in) and (not defined $out)) {
($proc, $self->{in}, $self->{intypes}, $outnum, $self->{outtype},
$ccnum) = parse_prototype($class, $proc);
if( ! $proc ){
Win32::API::FreeLibrary($hdll) if $freedll;
Win32::SetLastError(ERROR_INVALID_PARAMETER);
return undef;
}
$proto = 1;
}
else {
$self->{in} = [];
my $self_in = $self->{in}; #avoid hash derefing
if (ref($in) eq 'ARRAY') {
foreach (@$in) {
push(@{$self_in}, $class->type_to_num($_));
}
}
else {
my @in = split '', $in;
foreach (@in) {
push(@{$self_in}, $class->type_to_num($_));
}
}#'V' must be one and ONLY letter for "in"
foreach(@{$self_in}){
if($_ == 0){
if(@{$self_in} != 1){
Win32::API::FreeLibrary($hdll) if $freedll;
die "Win32::API 'V' for in prototype must be the only parameter";
} else {undef(@{$self_in});} #empty arr, as if in param was ""
}
}
$outnum = $class->type_to_num($out, 1);
$ccnum = calltype_to_num($callconvention);
}
if(!$hproc){ #if not non DLL func
#### first try to import the function of given name...
$hproc = Win32::API::GetProcAddress($hdll, $proc);
#### ...then try appending either A or W (for ASCII or Unicode)
if (!$hproc) {
my $tproc = $proc;
$tproc .= (IsUnicode() ? "W" : "A");
# print "Win32::API::new: procedure not found, trying '$tproc'...\n";
$hproc = Win32::API::GetProcAddress($hdll, $tproc);
}
#### ...if all that fails, give up, $! setting is back compat, $! is deprecated
if (!$hproc) {
my $err = $! = Win32::GetLastError();
DEBUG "FAILED GetProcAddress for Proc '$proc': $^E\n" if DEBUGCONST;
Win32::API::FreeLibrary($hdll) if $freedll;
Win32::SetLastError($err);
return undef;
}
DEBUG "GetProcAddress('$proc') = '$hproc'\n" if DEBUGCONST;
}
else {
DEBUG "Using non-DLL function pointer '$hproc' for '$proc'\n" if DEBUGCONST;
}
if(PTRSIZE == 4 && $ccnum == APICONTROL_CC_C) {#fold out on WIN64
#calculate add to ESP amount, in units of 4, will be *4ed later
$stackunwind += $_ == T_QUAD || $_ == T_DOUBLE ? 2 : 1 for(@{$self->{in}});
if($stackunwind > 0xFFFF) {
goto too_many_in_params;
}
}
# if a prototype has 8 byte types on 32bit, $stackunwind will be higher than
# length of {in} letter array, so 2 different checks need to be done
if($#{$self->{in}} > 0xFFFF) {
too_many_in_params:
DEBUG "FAILED This function has too many parameters (> ~65535) \n" if DEBUGCONST;
Win32::API::FreeLibrary($hdll) if $freedll;
Win32::SetLastError(ERROR_NOT_ENOUGH_MEMORY);
return undef;
}
#### ok, let's stuff the object
$self->{procname} = $proc;
$self->{dll} = $hdll;
$self->{dllname} = $dll;
$outnum &= ~T_FLAG_NUMERIC;
my $control;
$self->{weakapi} = \$control;
weaken($self->{weakapi});
$control = pack( 'L'
.'L'
.(PTRSIZE == 8 ? 'Q' : 'L')
.(PTRSIZE == 8 ? 'Q' : 'L')
.(PTRSIZE == 8 ? 'Q' : 'L')
.(PTRSIZE == 8 ? '' : 'L')
,($class eq "Win32::API::More" ? APICONTROL_is_more : 0)
| ($proto ? APICONTROL_has_proto : 0)
| $ccnum
| (PTRSIZE == 8 ? 0 : $stackunwind << 8)
| $outnum << 24
, scalar(@{$self->{in}}) * PTRSIZE #in param count, in SV * units
, $hproc
, \($self->{weakapi})+0 #weak api obj ref
, (exists $self->{intypes} ? ($self->{intypes})+0 : 0)
, 0); #padding to align to 8 bytes on 32 bit only
#align to 16 bytes
$control .= "\x00" x ((((length($control)+ 15) >> 4) << 4)-length($control));
#make a APIPARAM template array
my ($i, $arr_end) = (0, scalar(@{$self->{in}}));
for(; $i< $arr_end; $i++) {
my $tin = $self->{in}[$i];
#unsigned meaningless no sign vs zero extends are done bc uv/iv is
#the biggest native integer on the cpu, big to small is truncation
#numeric is implemented as T_NUMCHAR for in, keeps asm jumptable clean
$tin &= ~(T_FLAG_UNSIGNED|T_FLAG_NUMERIC);
$tin--; #T_VOID doesn't exist as in param in XS
#put index of param array slice in unused space for croaks, why not?
$control .= "\x00" x 8 . pack('CCSSS', $tin, 0, 0, $i, $i+1);
}
_Align($control, 16); #align the whole PVX to 16 bytes for SSE moves
#### keep track of the imported function
if(defined $dll){
$Libraries{$dll} = $hdll;
$Procedures{$dll}++;
}
DEBUG "Object blessed!\n" if DEBUGCONST;
my $ref = bless(\$control, $class);
SetMagicSV($ref, $self);
return $ref;
}
sub Import {
my $closure = shift->new(@_)
or return undef;
my $procname = ${Win32::API::GetMagicSV($closure)}{procname};
#dont allow "sub main:: {0;}"
Win32::SetLastError(ERROR_INVALID_PARAMETER), return undef if $procname eq '';
_ImportXS($closure, (caller)[0].'::'.$procname);
return $closure;
}
#######################################################################
# PRIVATE METHODS
#
sub DESTROY {
my ($self) = GetMagicSV($_[0]);
return if ! defined $self->{dllname};
#### decrease this library's procedures reference count
$Procedures{$self->{dllname}}--;
#### once it reaches 0, free it
if ($Procedures{$self->{dllname}} == 0) {
DEBUG "Win32::API::DESTROY: Freeing library '$self->{dllname}'\n" if DEBUGCONST;
Win32::API::FreeLibrary($Libraries{$self->{dllname}});
delete($Libraries{$self->{dllname}});
}
}
# Convert calling convention string (_cdecl|__stdcall)
# to a C const. Unknown counts as __stdcall
#
sub calltype_to_num {
my $type = shift;
if (!$type || $type eq "__stdcall" || $type eq "WINAPI" || $type eq "NTAPI"
|| $type eq "CALLBACK" ) {
return APICONTROL_CC_STD;
}
elsif ($type eq "_cdecl" || $type eq "__cdecl" || $type eq "WINAPIV") {
return APICONTROL_CC_C;
}
else {
warn "unknown calling convention: '$type'";
return APICONTROL_CC_STD;
}
}
sub type_to_num {
die "wrong class" if shift ne "Win32::API";
my $type = shift;
my $out = shift;
my ($num, $numeric);
if(index($type, 'num', 0) == 0){
substr($type, 0, length('num'), '');
$numeric = 1;
}
else{
$numeric = 0;
}
if ( $type eq 'N'
or $type eq 'n'
or $type eq 'l'
or $type eq 'L'
or ( PTRSIZE == 8 and $type eq 'Q' || $type eq 'q'))
{
$num = T_NUMBER;
}
elsif ($type eq 'P'
or $type eq 'p')
{
$num = T_POINTER;
}
elsif ($type eq 'I'
or $type eq 'i')
{
$num = T_INTEGER;
}
elsif ($type eq 'f'
or $type eq 'F')
{
$num = T_FLOAT;
}
elsif ($type eq 'D'
or $type eq 'd')
{
$num = T_DOUBLE;
}
elsif ($type eq 'c'
or $type eq 'C')
{
$num = $numeric ? T_NUMCHAR : T_CHAR;
}
elsif (PTRSIZE == 4 and $type eq 'q' || $type eq 'Q')
{
$num = T_QUAD;
}
elsif($type eq '>'){
die "Win32::API does not support pass by copy structs as function arguments";
}
else {
$num = T_VOID; #'V' takes this branch, which is T_VOID in C
}#not valid return types of the C func
if(defined $out) {#b/B remains private/undocumented
die "Win32::API invalid return type, structs and ".
"callbacks as return types not supported"
if($type =~ m/^s|S|t|T|b|B|k|K$/);
}
else {#in type
if ($type eq 's' or $type eq 'S' or $type eq 't' or $type eq 'T')
{
$num = T_STRUCTURE;
}
elsif ($type eq 'b'
or $type eq 'B')
{
$num = T_POINTERPOINTER;
}
elsif ($type eq 'k'
or $type eq 'K')
{
$num = T_CODE;
}
}
$num |= T_FLAG_NUMERIC if $numeric;
return $num;
}
package Win32::API::More;
use vars qw( @ISA );
@ISA = qw ( Win32::API );
sub type_to_num {
die "wrong class" if shift ne "Win32::API::More";
my $type = shift;
my $out = shift;
my ($num, $numeric);
if(index($type, 'num', 0) == 0){
substr($type, 0, length('num'), '');
$numeric = 1;
}
else{
$numeric = 0;
}
if ( $type eq 'N'
or $type eq 'n'
or $type eq 'l'
or $type eq 'L'
or ( PTRSIZE == 8 and $type eq 'Q' || $type eq 'q')
or (! $out and # in XS short 'in's are interger/numbers code
$type eq 'S'
|| $type eq 's'))
{
$num = Win32::API::T_NUMBER;
if(defined $out && ($type eq 'N' || $type eq 'L'
|| $type eq 'S' || $type eq 'Q')){
$num |= Win32::API::T_FLAG_UNSIGNED;
}
}
elsif ($type eq 'P'
or $type eq 'p')
{
$num = Win32::API::T_POINTER;
}
elsif ($type eq 'I'
or $type eq 'i')
{
$num = Win32::API::T_INTEGER;
if(defined $out && $type eq 'I'){
$num |= Win32::API::T_FLAG_UNSIGNED;
}
}
elsif ($type eq 'f'
or $type eq 'F')
{
$num = Win32::API::T_FLOAT;
}
elsif ($type eq 'D'
or $type eq 'd')
{
$num = Win32::API::T_DOUBLE;
}
elsif ($type eq 'c'
or $type eq 'C')
{
$num = $numeric ? Win32::API::T_NUMCHAR : Win32::API::T_CHAR;
if(defined $out && $type eq 'C'){
$num |= Win32::API::T_FLAG_UNSIGNED;
}
}
elsif (PTRSIZE == 4 and $type eq 'q' || $type eq 'Q')
{
$num = Win32::API::T_QUAD;
if(defined $out && $type eq 'Q'){
$num |= Win32::API::T_FLAG_UNSIGNED;
}
}
elsif ($type eq 's') #4 is only used for out params
{
$num = Win32::API::T_SHORT;
}
elsif ($type eq 'S')
{
$num = Win32::API::T_SHORT | Win32::API::T_FLAG_UNSIGNED;
}
elsif($type eq '>'){
die "Win32::API does not support pass by copy structs as function arguments";
}
else {
$num = Win32::API::T_VOID; #'V' takes this branch, which is T_VOID in C
} #not valid return types of the C func
if(defined $out) {#b/B remains private/undocumented
die "Win32::API invalid return type, structs and ".
"callbacks as return types not supported"
if($type =~ m/^t|T|b|B|k|K$/);
}
else {#in type
if ( $type eq 't'
or $type eq 'T')
{
$num = Win32::API::T_STRUCTURE;
}
elsif ($type eq 'b'
or $type eq 'B')
{
$num = Win32::API::T_POINTERPOINTER;
}
elsif ($type eq 'k'
or $type eq 'K')
{
$num = Win32::API::T_CODE;
}
}
$num |= Win32::API::T_FLAG_NUMERIC if $numeric;
return $num;
}
package Win32::API;
sub parse_prototype {
my ($class, $proto) = @_;
my @in_params = ();
my @in_types = (); #one day create a BNF-ish formal grammer parser here
if ($proto =~ /^\s*((?:(?:un|)signed\s+|) #optional signedness
\S+)(?:\s*(\*)\s*|\s+) #type and maybe a *
(?:(\w+)\s+)? # maybe a calling convention
(\S+)\s* #func name
\(([^\)]*)\) #param list
/x) {
my $ret = $1.(defined($2)?$2:'');
my $callconvention = $3;
my $proc = $4;
my $params = $5;
$params =~ s/^\s+//;
$params =~ s/\s+$//;
DEBUG "(PM)parse_prototype: got PROC '%s'\n", $proc if DEBUGCONST;
DEBUG "(PM)parse_prototype: got PARAMS '%s'\n", $params if DEBUGCONST;
foreach my $param (split(/\s*,\s*/, $params)) {
my ($type, $name);
#match "in_t* _var" "in_t * _var" "in_t *_var" "in_t _var" "in_t*_var" supported
#unsigned or signed or nothing as prefix supported
# "in_t ** _var" and "const in_t* var" not supported
if ($param =~ /((?:(?:un|)signed\s+|)\w+)(?:\s*(\*)\s*|\s+)(\w+)/) {
($type, $name) = ($1.(defined($2)? $2:''), $3);
}
{
BEGIN{warnings->unimport('uninitialized')}
if($type eq '') {goto BADPROTO;} #something very wrong, bail out
}
my $packing = Win32::API::Type::packing($type);
if (defined $packing && $packing ne '>') {
if (Win32::API::Type::is_pointer($type)) {
DEBUG "(PM)parse_prototype: IN='%s' PACKING='%s' API_TYPE=%d\n",
$type,
$packing,
$class->type_to_num('P') if DEBUGCONST;
push(@in_params, $class->type_to_num('P'));
}
else {
DEBUG "(PM)parse_prototype: IN='%s' PACKING='%s' API_TYPE=%d\n",
$type,
$packing,
$class->type_to_num(Win32::API::Type->packing($type, undef, 1)) if DEBUGCONST;
push(@in_params, $class->type_to_num(Win32::API::Type->packing($type, undef, 1)));
}
}
elsif (Win32::API::Struct::is_known($type)) {
DEBUG "(PM)parse_prototype: IN='%s' PACKING='%s' API_TYPE=%d\n",
$type, 'T', Win32::API::More->type_to_num('T') if DEBUGCONST;
push(@in_params, Win32::API::More->type_to_num('T'));
}
else {
warn
"Win32::API::parse_prototype: WARNING unknown parameter type '$type'";
push(@in_params, $class->type_to_num('I'));
}
push(@in_types, $type);
}
DEBUG "parse_prototype: IN=[ @in_params ]\n" if DEBUGCONST;
if (Win32::API::Type::is_known($ret)) {
if (Win32::API::Type::is_pointer($ret)) {
DEBUG "parse_prototype: OUT='%s' PACKING='%s' API_TYPE=%d\n",
$ret,
Win32::API::Type->packing($ret),
$class->type_to_num('P') if DEBUGCONST;
return ($proc, \@in_params, \@in_types, $class->type_to_num('P', 1),
$ret, calltype_to_num($callconvention));
}
else {
DEBUG "parse_prototype: OUT='%s' PACKING='%s' API_TYPE=%d\n",
$ret,
Win32::API::Type->packing($ret),
$class->type_to_num(Win32::API::Type->packing($ret, undef, 1), 1) if DEBUGCONST;
return (
$proc, \@in_params, \@in_types,
$class->type_to_num(Win32::API::Type->packing($ret, undef, 1), 1),
$ret, calltype_to_num($callconvention)
);
}
}
else {
warn
"Win32::API::parse_prototype: WARNING unknown output parameter type '$ret'";
return ($proc, \@in_params, \@in_types, $class->type_to_num('I', 1),
$ret, calltype_to_num($callconvention));
}
}
else {
BADPROTO:
warn "Win32::API::parse_prototype: bad prototype '$proto'";
return undef;
}
}
#
# XXX hack, see the proper implementation in TODO
# The point here is don't let fork children free the parent's DLLs.
# CLONE runs on ::API and ::More, that's bad and causes a DLL leak, make sure
# CLONE dups the DLL handles only once per CLONE
# GetModuleHandleEx was not used since that is a WinXP and newer function, not Win2K.
# GetModuleFileName was used to get full DLL pathname incase SxS/multiple DLLs
# with same file name exist in the process. Even if the dll was loaded as a
# relative path initially, later SxS can load a DLL with a different full path
# yet same file name, and then LoadLibrary'ing the original relative path
# might increase the refcount on the wrong DLL or return a different HMODULE
sub CLONE {
return if $_[0] ne "Win32::API";
_my_cxt_clone();
foreach( keys %Libraries){
if($Libraries{$_} != Win32::API::LoadLibrary(Win32::API::GetModuleFileName($Libraries{$_}))){
die "Win32::API::CLONE unable to clone DLL \"$Libraries{$_}\" Unicode Problem??";
}
}
}
1;
__END__
#######################################################################
# DOCUMENTATION
#
=head1 NAME
Win32::API - Perl Win32 API Import Facility
=head1 SYNOPSIS
#### Method 1: with prototype
use Win32::API;
$function = Win32::API::More->new(
'mydll', 'int sum_integers(int a, int b)'
);
#### $^E is non-Cygwin only
die "Error: $^E" if ! $function;
#### or on Cygwin and non-Cygwin
die "Error: ".(Win32::FormatMessage(Win32::GetLastError())) if ! $function;
####
$return = $function->Call(3, 2);
#### Method 2: with prototype and your function pointer
use Win32::API;
$function = Win32::API::More->new(
undef, 38123456, 'int name_ignored(int a, int b)'
);
die "Error: $^E" if ! $function; #$^E is non-Cygwin only
$return = $function->Call(3, 2);
#### Method 3: with parameter list
use Win32::API;
$function = Win32::API::More->new(
'mydll', 'sum_integers', 'II', 'I'
);
die "Error: $^E" if ! $function; #$^E is non-Cygwin only
$return = $function->Call(3, 2);
#### Method 4: with parameter list and your function pointer
use Win32::API;
$function = Win32::API::More->new(
undef, 38123456, 'name_ignored', 'II', 'I'
);
die "Error: $^E" if ! $function; #$^E is non-Cygwin only
$return = $function->Call(3, 2);
#### Method 5: with Import (slightly faster than ->Call)
use Win32::API;
$function = Win32::API::More->Import(
'mydll', 'int sum_integers(int a, int b)'
);
die "Error: $^E" if ! $function; #$^E is non-Cygwin only
$return = sum_integers(3, 2);
=for LATER-UNIMPLEMENTED
#### or
use Win32::API mydll => 'int sum_integers(int a, int b)';
$return = sum_integers(3, 2);
=head1 ABSTRACT
With this module you can import and call arbitrary functions
from Win32's Dynamic Link Libraries (DLL) or arbitrary functions for
which you have a pointer (MS COM, etc), without having
to write an XS extension. Note, however, that this module
can't do everything. In fact, parameters input and output is
limited to simpler cases.
A regular B<XS> extension is always safer and faster anyway.
The current version of Win32::API is always available at your
nearest CPAN mirror:
http://search.cpan.org/dist/Win32-API/
A short example of how you can use this module (it just gets the PID of
the current process, eg. same as Perl's internal C<$$>):
use Win32::API;
Win32::API::More->Import("kernel32", "int GetCurrentProcessId()");
$PID = GetCurrentProcessId();
Starting with 0.69. Win32::API initiated objects are deprecated due to numerous
bugs and improvements, use Win32::API::More now. The use statement remains
as C<use Win32::API;>.
The possibilities are nearly infinite (but not all are good :-).
Enjoy it.
=head1 DESCRIPTION
To use this module put the following line at the beginning of your script:
use Win32::API;
You can now use the C<new()> function of the Win32::API module to create a
new Win32::API::More object (see L<IMPORTING A FUNCTION>) and then invoke the
C<Call()> method on this object to perform a call to the imported API
(see L<CALLING AN IMPORTED FUNCTION>).
Starting from version 0.40, you can also avoid creating a Win32::API::More object
and instead automatically define a Perl sub with the same name of the API
function you're importing. This 2nd way using C<Import> to create a sub instead
of an object is slightly faster than doing C<-E<gt>Call()>. The details of the
API definitions are the same, just the method name is different:
my $GetCurrentProcessId = Win32::API::More->new(
"kernel32", "int GetCurrentProcessId()"
);
die "Failed to import GetCurrentProcessId" if !$GetCurrentProcessId;
$GetCurrentProcessId->UseMI64(1);
my $PID = $GetCurrentProcessId->Call();
#### vs.
my $UnusedGCPI = Win32::API::More->Import("kernel32", "int GetCurrentProcessId()");
die "Failed to import GetCurrentProcessId" if !$UnusedGCPI;
$UnusedGCPI->UseMI64(1);
$PID = GetCurrentProcessId();
Note that C<Import> returns the Win32::API obj on success and false on failure
(in which case you can check the content of C<$^E>). This allows some settings
to be set through method calls that can't be specified as a parameter to Import,
yet still have the convience of not writing C<-E<gt>Call()>. The Win32::API obj
does not need to be assigned to a scalar. C<unless(Win32::API::More-E<gt>Import>
is fine. Prior to v0.76_02, C<Import> returned returned 1 on success and 0 on
failure.
=head2 IMPORTING A FUNCTION
You can import a function from a 32 bit Dynamic Link Library (DLL) file with
the C<new()> function or, starting in 0.69, supply your own function pointer.
This will create a Perl object that contains the reference to that function,
which you can later C<Call()>.
What you need to know is the prototype of the function you're going to import
(eg. the definition of the function expressed in C syntax).
Starting from version 0.40, there are 2 different approaches for this step:
(the preferred) one uses the prototype directly, while the other (now deprecated)
one uses Win32::API's internal representation for parameters.
=head2 IMPORTING A FUNCTION BY PROTOTYPE
You need to pass 2 or 3 parameters:
=over 4
=item 1.
The name of the library from which you want to import the function. If the
name is undef, you are requesting a object created from a function pointer,
and must supply item 2.
=item 2.
This parameter is optional, most people should skip it, skip does not mean
supplying undef. Supply a function pointer in the format of number 1234, not
string "\x01\x02\x03\x04". Undef will be returned if the pointer is not
readable, L<Win32::GetLastError|Win32/Win32::GetLastError()>/L<perlvar/"$^E">
will be C<ERROR_NOACCESS>.
=item 3.
The C prototype of the function. If you are using a function pointer, the name
of the function should be something "friendly" to you and no attempt is made
to retrieve such a name from any DLL's export table. This name for a function
pointer is also used for Import().
=back
When calling a function imported with a prototype, if you pass an
undefined Perl scalar to one of its arguments, it will be
automatically turned into a C C<NULL> value.
See L<Win32::API::Type> for a list of the known parameter types and
L<Win32::API::Struct> for information on how to define a structure.
If a prototype type is exactly C<signed char> or C<unsigned char> for an
"in" parameter or the return parameter, and for "in" parameters only
C<signed char *> or C<unsigned char *> the parameters will be treated as a
number, C<0x01>, not C<"\x01">. "UCHAR" is not "unsigned char". Change the
C prototype if you want numeric handling for your chars.
=head2 IMPORTING A FUNCTION WITH A PARAMETER LIST
You need to pass at minimum 4 parameters.
=over 4
=item 1.
The name of the library from which you want to import the function.
=item 2.
This parameter is optional, most people should skip it, skip does not mean
supplying undef. Supply a function pointer in the format of number C<1234>,
not string C<"\x01\x02\x03\x04">. Undef will be returned if the pointer is not
readable, L<Win32::GetLastError|Win32/Win32::GetLastError()>/L<perlvar/"$^E">
will be C<ERROR_NOACCESS>.
=item 3.
The name of the function (as exported by the library) or for function pointers
a name that is "friendly" to you. This name for a function pointer is also used
for Import(). No attempt is made to retrieve such a name from any DLL's export
table in the 2nd case.
=item 4.
The number and types of the arguments the function expects as input.
=item 5.
The type of the value returned by the function.
=item 6.
And optionally you can specify the calling convention, this defaults to
'__stdcall', alternatively you can specify '_cdecl' or '__cdecl' (API > v0.68)
or (API > v0.70_02) 'WINAPI', 'NTAPI', 'CALLBACK' (__stdcall), 'WINAPIV' (__cdecl) .
False is __stdcall. Vararg functions are always cdecl. MS DLLs are typically
stdcall. Non-MS DLLs are typically cdecl. If API > v0.75, mixing up the calling
convention on 32 bits is detected and Perl will C<croak> an error message and
C<die>.
=back
To better explain their meaning, let's suppose that we
want to import and call the Win32 API C<GetTempPath()>.
This function is defined in C as:
DWORD WINAPI GetTempPathA( DWORD nBufferLength, LPSTR lpBuffer );
This is documented in the B<Win32 SDK Reference>; you can look
for it on the Microsoft's WWW site, or in your C compiler's
documentation, if you own one.
=over 4
=item B<1.>
The first parameter is the name of the library file that
exports this function; our function resides in the F<KERNEL32.DLL>
system file.
When specifying this name as parameter, the F<.DLL> extension
is implicit, and if no path is given, the file is searched through
a couple of directories, including:
=over 4
=item 1. The directory from which the application loaded.
=item 2. The current directory.
=item 3. The Windows system directory (eg. c:\windows\system or system32).
=item 4. The Windows directory (eg. c:\windows).
=item 5. The directories that are listed in the PATH environment variable.
=back
You may, but don't have to write F<C:\windows\system\kernel32.dll>; or
F<kernel32.dll>, only F<kernel32> is enough:
$GetTempPath = new Win32::API::More('kernel32', ...
=item B<2.>
Since this function is from a DLL, skip the 2nd parameter. Skip does not
mean supplying undef.
=item B<3.>
Now for the real second parameter: the name of the function.
It must be written exactly as it is exported
by the library (case is significant here).
If you are using Windows 95 or NT 4.0, you can use the B<Quick View>
command on the DLL file to see the function it exports.
Remember that you can only import functions from 32 or 64 bit DLLs:
in Quick View, the file's characteristics should report
somewhere "32 bit word machine"; as a rule of thumb,
when you see that all the exported functions are in upper case,
the DLL is a 16 bit one and you can't use it. You also can not load a 32 bit
DLL into a 64 bit Perl, or vice versa. If you try, C<new>/C<Import> will fail
and C<$^E> will be C<ERROR_BAD_EXE_FORMAT>.
If their capitalization looks correct, then it's probably a 32 bit
DLL. If you have Platform SDK or Visual Studio, you can use the Dumpbin
tool. Call it as C<dumpbin /exports name_of_dll.dll> on the command line.
If you have Mingw GCC, use objdump as
C<objdump -x name_of_dll.dll E<gt> dlldump.txt> and search for the word exports
in the very long output.
Also note that many Win32 APIs are exported twice, with the addition of
a final B<A> or B<W> to their name, for - respectively - the ASCII
and the Unicode version.
When a function name is not found, Win32::API will actually append
an B<A> to the name and try again; if the extension is built on a
Unicode system, then it will try with the B<W> instead.
So our function name will be:
$GetTempPath = new Win32::API::More('kernel32', 'GetTempPath', ...
In our case C<GetTempPath> is really loaded as C<GetTempPathA>.
=item B<4.>
The third parameter, the input parameter list, specifies how many
arguments the function wants, and their types. It can be passed as
a single string, in which each character represents one parameter,
or as a list reference. The following forms are valid:
"abcd"
[a, b, c, d]
\@LIST
But those are not:
(a, b, c, d)
@LIST
The number of characters, or elements in the list, specifies the number
of parameters, and each character or element specifies the type of an
argument; allowed types are:
=over 4
=item C<I>:
value is an unsigned integer (unsigned int)
=item C<i>:
value is an signed integer (signed int or int)
=item C<N>:
value is a unsigned pointer sized number (unsigned long)
=item C<n>:
value is a signed pointer sized number (signed long or long)
=item C<Q>:
value is a unsigned 64 bit integer number (unsigned long long, unsigned __int64)
See next item for details.
=item C<q>:
value is a signed 64 bit integer number (long long, __int64)
If your perl has 'Q'/'q' quads support for L<perlfunc/pack> then Win32::API's 'q'
is a normal perl numeric scalar. All 64 bit Perls have quad support. Almost no
32 bit Perls have quad support. On 32 bit Perls, without quad support,
Win32::API's 'q'/'Q' letter is a packed 8 byte string. So C<0x8000000050000000>
from a perl with native Quad support would be written as
C<"\x00\x00\x00\x50\x00\x00\x00\x80"> on a 32 bit Perl without Quad support.
To improve the use of 64 bit integers with Win32::API on a 32 bit Perl without
Quad support, there is a per Win32::API::* object setting called L</UseMI64>
that causes all quads to be accepted as, and returned as L<Math::Int64> objects.
For "in" params in Win32::API and Win32::API::More and "out" in
Win32::API::Callback only, if the argument is a reference, it will automatically
be treated as a Math::Int64 object without having to previously call