From Code to Community: Sponsoring The Perl and Raku Conference 2025 Learn more

SZABGAB / Padre-1.02 / lib / Padre / Util / Win32.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

              
package Padre::Util::Win32;
=pod
=head1 NAME
Padre::Util::Win32 - Padre Win32 API Functions
=head1 DESCRIPTION
The C<Padre::Util::Win32> package provides an XS wrapper for Win32
API functions
All functions are exportable and documented for maintenance purposes,
but except for in the L<Padre> core distribution you are discouraged in the
strongest possible terms from using these functions, as they may be
moved, removed or changed at any time without notice.
=head1 FUNCTIONS
=cut
use 5.008;
use strict;
use warnings;
use Padre::Constant ();
our $VERSION = '1.02';
# This module may be loaded by others, so don't crash on Linux when just being loaded:
if (Padre::Constant::WIN32) {
        require Win32;
        require XSLoader;
        XSLoader::load( 'Padre::Util::Win32', $VERSION );
} else {
        require Padre::Logger;
        Padre::Logger::TRACE("WARN: Inefficiently loading Padre::Util::Win32 when not on Win32");
}
=head2 C<GetLongPathName>
  Padre::Util::Win32::GetLongPathName($path);
Converts the specified path C<$path> to its long form.
Returns C<undef> for failure, or the long form of the specified path
=cut
# Is this still needed?
sub GetLongPathName {
        die "Win32 function called!" unless Padre::Constant::WIN32;
        my $path = shift;
        return Win32::GetLongPathName($path);
}
=head2 C<Recycle>
  Padre::Util::Win32::Recycle($file_to_recycle);
Move C<$file_to_recycle> to recycle bin
Returns C<undef> (failed), zero (aborted) or one (success)
=cut
sub Recycle {
        die "Win32 function called!" unless Padre::Constant::WIN32;
        my $file_to_recycle = shift;
        return _recycle_file($file_to_recycle);
}
=head2 C<AllowSetForegroundWindow>
  Padre::Util::Win32::AllowSetForegroundWindow($pid);
Enables the specified process C<$pid> to set the foreground window
via C<SetForegroundWindow>
L<http://msdn.microsoft.com/en-us/library/ms633539(VS.85).aspx>
=cut
#
# Enables the specified process to set the foreground window
# via SetForegroundWindow
#
sub AllowSetForegroundWindow {
        die "Win32 function called!" unless Padre::Constant::WIN32;
        my $pid = shift;
        return _allow_set_foreground_window($pid);
}
=head2 C<ExecuteProcessAndWait>
  Padre::Util::Win32::ExecuteProcessAndWait(
      directory  => $directory,
      file       => $file,
      parameters => $parameters,
      show       => $show,
  )
Execute a background process named "C<$file> C<$parameters>" with the current
directory set to C<$directory> and wait for it to end. If you set C<$show> to 0,
then you have an invisible command line window on win32!
=cut
sub ExecuteProcessAndWait {
        die "Win32 function called!" unless Padre::Constant::WIN32;
        my %params     = @_;
        my $directory  = $params{directory} || '.';
        my $show       = ( $params{show} ) ? 1 : 0;
        my $parameters = $params{parameters} || '';
        return _execute_process_and_wait( $params{file}, $parameters, $directory, $show );
}
=head2 C<GetCurrentProcessMemorySize>
  Padre::Util::Win32::GetCurrentProcessMemorySize;
Returns the current process memory size in bytes
=cut
sub GetCurrentProcessMemorySize {
        die "Win32 function called!" unless Padre::Constant::WIN32;
        return _get_current_process_memory_size();
}
=head2 C<GetLastErrorString>
  Padre::Util::Win32::GetLastError;
Returns the error code of the last Win32 API call.
The list of error codes could be found at
L<http://msdn.microsoft.com/en-us/library/ms681381(VS.85).aspx>.
=cut
sub GetLastError {
        die "Win32 function called!" unless Padre::Constant::WIN32;
        return Win32::GetLastError();
}
=head2 C<GetLastErrorString>
  Padre::Util::Win32::GetLastErrorString;
Returns the string representation for the error code of the last
Win32 API call.
=cut
sub GetLastErrorString {
        die "Win32 function called!" unless Padre::Constant::WIN32;
        return Win32::FormatMessage( Win32::GetLastError() );
}
1;
__END__
=pod
=head1 COPYRIGHT
Copyright 2008-2016 The Padre development team as listed in Padre.pm.
This program is free software; you can redistribute
it and/or modify it under the same terms as Perl itself.
The full text of the license can be found in the
LICENSE file included with this module.
=cut
# Copyright 2008-2016 The Padre development team as listed in Padre.pm.
# LICENSE
# This program is free software; you can redistribute it and/or
# modify it under the same terms as Perl 5 itself.