Perl x Open Food Facts Hackathon: Paris, France - May 24-25 Learn more

SGOELDNER / DBD-ADO-2.99 / lib / DBD / ADO / Const.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

              
package DBD::ADO::Const;
use strict;
use warnings;
use Win32::OLE();
use Win32::OLE::TypeInfo();
use Win32::OLE::Variant();
$DBD::ADO::Const::VERSION = '0.07';
$DBD::ADO::Const::VT_I4_BYREF = Win32::OLE::Variant::VT_I4()
                              | Win32::OLE::Variant::VT_BYREF()
                              ;
my $ProgId  = 'ADODB.Connection';
my $VarSkip = Win32::OLE::TypeInfo::VARFLAG_FHIDDEN()
            | Win32::OLE::TypeInfo::VARFLAG_FRESTRICTED()
            | Win32::OLE::TypeInfo::VARFLAG_FNONBROWSABLE()
            ;
my $Enums;
# -----------------------------------------------------------------------------
sub Enums
# -----------------------------------------------------------------------------
{
  my $class = shift;
  return $Enums if $Enums;
  my $TypeLib = Win32::OLE->new( $ProgId )->GetTypeInfo->GetContainingTypeLib;
  return $Enums = $TypeLib->Enums if defined &Win32::OLE::TypeLib::Enums;
  for my $i ( 0 .. $TypeLib->_GetTypeInfoCount - 1 )
  {
    my $TypeInfo = $TypeLib->_GetTypeInfo( $i );
    my $TypeAttr = $TypeInfo->_GetTypeAttr;
    next unless $TypeAttr->{typekind} == Win32::OLE::TypeInfo::TKIND_ENUM();
    my $Enum = $Enums->{$TypeInfo->_GetDocumentation->{Name}} = {};
    for my $i ( 0 .. $TypeAttr->{cVars} - 1 )
    {
      my $VarDesc = $TypeInfo->_GetVarDesc( $i );
      next if $VarDesc->{wVarFlags} & $VarSkip;
      my $Documentation = $TypeInfo->_GetDocumentation( $VarDesc->{memid} );
      $Enum->{$Documentation->{Name}} = $VarDesc->{varValue};
    }
  }
  return $Enums;
}
# -----------------------------------------------------------------------------
1;
=head1 NAME
DBD::ADO::Const - ADO Constants
=head1 SYNOPSIS
  use DBD::ADO::Const();
  $\ = "\n";
  my $Enums = DBD::ADO::Const->Enums;
  for my $Enum ( sort keys %$Enums )
  {
    print $Enum;
    for my $Const ( sort keys %{$Enums->{$Enum}} )
    {
      printf "  %-35s 0x%X\n", $Const, $Enums->{$Enum}{$Const};
    }
  }
=head1 DESCRIPTION
In the OLE type library, many constants are defined as members of enums.
It's easy to lookup DBD::ADO constants by name, e.g.:
  $ado_consts->{adChar} == 129
Unfortunately, Win32::OLE::Const does not preserve the namespace of the enums.
It's a matter of taste, but I think
  $ado_consts->{DataTypeEnum}{adChar} == 129
makes the code more self-documenting.
Furthermore, many DBD::ADO methods return numeric codes. Transforming these
codes into human readable strings requires an inverse lookup by value.
Building the reverse hash for e.g. all datatypes requires that datatype
constants can be distinguished from other constants, i.e. we need the
namespace preserved.
The Enums() method of this package return a hash of hashes for exactly this
purpose.
=head1 BENCHMARK
The drawback of the Enums() method is its poor performance, as the following
benchmark shows:
  require DBD::ADO::Const;     # 0.50 CPU
  DBD::ADO::Const->Enums;      # 0.30 CPU
                               # 0.80 CPU
However, the previous alternative didn't perform better:
  require Win32::OLE::Const;   # 0.89 CPU
  Win32::OLE::Const->Load(...) # 0.03 CPU
                               # 0.92 CPU
It seems that all available type libraries are checked (for whatever reason).
In a networking environment, the performance may be unacceptable.
A more general version (parameterized by TypeLib), implemented in XS
(similar to Win32::OLE::Const::_Constants), looks promising:
  require Win32::OLE;          # 0.24 CPU
  $TypeLib->Enums;             # 0.04 CPU
                               # 0.28 CPU
where
  $TypeLib = Win32::OLE->new('ADODB.Connection')
               ->GetTypeInfo->GetContainingTypeLib;
Hopefully, this implementation (see ex/Enums.patch) finds its way
into Win32::OLE some day ...
=head1 AUTHOR
Steffen Goeldner (sgoeldner@cpan.org)
=head1 COPYRIGHT
Copyright (c) 2002-2005 Steffen Goeldner. All rights reserved.
This program is free software; you can redistribute it and/or
modify it under the same terms as Perl itself.
=cut