X-Git-Url: https://pintos-os.org/cgi-bin/gitweb.cgi?a=blobdiff_plain;f=perl-module%2Flib%2FPSPP.pm;h=e5599908b683f7b6e6bde716fbfa9f74d3460338;hb=231ebe7e6d5c8c8eba47560793b5fa53c013b87f;hp=201e99c0576014ee58497d2e1dfdacd27cb84ced;hpb=e4f0ca7496fbdc377a211693df853245981c46b5;p=pspp-builds.git diff --git a/perl-module/lib/PSPP.pm b/perl-module/lib/PSPP.pm index 201e99c0..e5599908 100644 --- a/perl-module/lib/PSPP.pm +++ b/perl-module/lib/PSPP.pm @@ -21,7 +21,7 @@ None by default. =cut BEGIN { - do 'pspp-vers.pl' || die "No version set"; + $PSPP::VERSION='0.7.2'; require XSLoader; XSLoader::load('PSPP', $PSPP::VERSION); } @@ -87,9 +87,15 @@ sub new =pod -=head3 get_var +=head3 get_var_cnt () -Returns a variable from a dictionary +Returns the number of variables in the dictionary. + +=head3 get_var ($idx) + +Returns the Cth variable from the dictionary. +Returns undef if C is greater than or equal to the number +of variables in the dictionary. =cut @@ -106,6 +112,28 @@ sub get_var return $var; } +=pod + +=head3 get_var_by_name ($name) + +Returns the variable from the dictionary whose name is C. +If there is no such variable, a null reference will be returned. + +=cut + +sub get_var_by_name +{ + my $dict = shift; + my $name = shift; + my $var = pxs_get_var_by_name ($dict, $name); + + if ( ref $var ) + { + bless ($var, "PSPP::Var"); + } + return $var; +} + package PSPP::Fmt; @@ -221,7 +249,7 @@ An integer denoting the number of decimal places for the format. =item width -An integer denoting the number of width of the format. +An integer denoting the width of the format. =back @@ -254,6 +282,16 @@ sub set_print_format =pod + +=head3 get_write_format () + +Returns a reference to a hash containing the write format for the variable. + + +=head3 get_print_format () + +Returns a reference to a hash containing the print format for the variable. + =head3 set_output_format (%fmt) Sets the write and print formats to C. This is the same as @@ -333,8 +371,26 @@ sub set_value_labels Sets the missing values for the variable. No more than three missing values may be specified. -=cut +=head3 get_attributes() + +Returns a reference to a hash of the custom variable attributes. +Each value of the hash is a reference to an array containing the +attribute values. + +=head3 get_name () + +Returns the name of the variable. + +=head3 get_label () +Returns the label of the variable or undef if there is no label. + +=head3 get_value_labels () + +Returns a reference to a hash containing the value labels for the variable. +The hash is keyed by data values which correpond to the labels. + +=cut package PSPP::Sysfile; @@ -395,6 +451,12 @@ The system file will be automatically closed when it goes out of scope. package PSPP::Reader; +=pod + +=head2 PSPP::Reader + +=cut + sub open { my $class = shift; @@ -409,6 +471,17 @@ sub open return $self; } +=pod + +=head3 open ($filename) + +Opens a system file for reading. + +Open is used to read data from an existing system file. +It creates and returns a PSPP::Reader object which can be used to read +data and dictionary information from C. + +=cut sub get_dict { @@ -421,7 +494,43 @@ sub get_dict return $dict; } +=pod + +=head3 get_dict () + +Returns the dictionary associated with the reader. + +=head3 get_next_case () + +Retrieves the next case from the reader. +This method returns an array of scalars, each of which are the values of +the data in the system file. +The first call to C after C has been called retrieves +the first case in the system file. Each subsequent call retrieves the next +case. If there are no more cases to be read, the function returns an empty +list. + +If the case contains system missing values, these values are set to the +empty string. + +=head2 Miscellaneous subroutines +The following subroutines provide (hopefully) useful information about the +values retrieved from a reader. + +=head3 PSPP::format_value ($value, $variable) + +Returns a scalar containing a string representing C formatted according +to the print format of C. +In the most common ussage, C should be a value of C. + + +=head3 PSPP::value_is_missing ($value, $variable) + +Returns non-zero if C is either system missing, or if it matches the +user missing criteria for C. + +=cut 1; __END__ @@ -433,21 +542,19 @@ John Darrington, Ejohn@darrington.wattle.id.auE =head1 COPYRIGHT AND LICENSE -Copyright (C) 2007 by Free Software Foundation +Copyright (C) 2007, 2008, 2009 by Free Software Foundation - This program is free software; you can redistribute it and/or - modify it under the terms of the GNU General Public License as - published by the Free Software Foundation; either version 2 of the - License, or (at your option) any later version. +This program is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version. - This program is distributed in the hope that it will be useful, but - WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU - General Public License for more details. +This program is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +GNU General Public License for more details. - You should have received a copy of the GNU General Public License - along with this program; if not, write to the Free Software - Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA - 02110-1301, USA. +You should have received a copy of the GNU General Public License +along with this program. If not, see . =cut