NAME¶
Device::Cdio::ISO9660 - Module for ISO 9660 handling
SYNOPSIS¶
This encapsulates IS9660 filesystem handling. This library however needs to be
used in conjunction with Device::Cdio, Device::Cdio::ISO9660::IFS and
Device::Cdio::ISO9660::FS.
use Device::Cdio::ISO9660;
$name = Device::Cdio::ISO9660::name_translate('COPYING.;1');
$bool = Device::Cdio::ISO9660::is_achar('A');
DESCRIPTION¶
This is an Object-Oriented Perl interface to the GNU CD Input and Control
library's ISO 9660 library, "libiso9660".
Encapsulation is done in two parts. The lower-level Perl interface is called
perliso9660 and is generated by SWIG.
The more object-oriented package Device::Cdio::ISO9660 and uses
"perliso9660". Actually, there are no objects in
Device::Cdio::ISO9660, but there are in its sub packages
Device::Cdio::ISO9660::IFS, Device::Cdio::ISO9660::FS (and in the future
Device::Cdio::ISO9660::PVD).
Although "perliso9660" is perfectly usable on its own, it is expected
that these module and classes are what most people will use. As perliso9660
more closely models the C interface, it is conceivable (if unlikely) that
die-hard "libiso9660" C users who are very familiar with that
interface could prefer that.
CALLING ROUTINES¶
Routines accept named parameters as well as positional parameters. For named
parameters, each argument name is preceded by a dash. For example:
Device::Cdio::ISO9660::is_achar(-achar=>'M')
Each argument name is preceded by a dash. Neither case nor order matters in the
argument list. -achar, -AChar, and -ACHAR are all acceptable. In fact, only
the first argument needs to begin with a dash. If a dash is present in the
first argument, we assume dashes for the subsequent parameters.
In the documentation below and elsewhere in this package the parameter name that
can be used in this style of call is given in the parameter list. For example,
for "name_translate" the documentation below reads:
name_translate(name, joliet_level=0) -> $str
So the parameter names are "name" and "joliet_level". Only
the "name" parameter is required. If "joliet_level" is not
specified, a value of 0 will be used. The return value is a string.
The older, more traditional style of positional parameters is also supported
which is shown in the synopsis above.
Finally, since no parameter name can be confused with a an integer, negative
values will not get confused as a named parameter.
SUBROUTINES¶
dirname_valid_p¶
dirname_valid_p(path)->bool
Check that path is a valid ISO-9660 directory name.
A valid directory name should not start out with a slash (/), dot (.) or null
byte, should be less than 37 characters long, have no more than 8 characters
in a directory component which is separated by a /, and consist of only
DCHARs.
True is returned if path is valid.
is_achar¶
is_dchar(achar)->bool
Return 1 if $achar is an ACHAR. $achar should either be a string of length one
or the
ord() of a string of length 1.
These are the DCHAR's plus some ASCII symbols including the space symbol.
is_dchar¶
is_dchar(dchar)->bool
Return 1 if $dchar is a DCHAR - a character that can appear in an an ISO-9600
level 1 directory name. These are the ASCII capital letters A-Z, the digits
0-9 and an underscore.
$dchar should either be a string of length one or the
ord() of a string
of length 1.
pathname_valid_p¶
pathname_valid_p(path)->bool
Check that path is a valid ISO-9660 pathname.
A valid pathname contains a valid directory name, if one appears and the
filename portion should be no more than 8 characters for the file prefix and 3
characters in the extension (or portion after a dot). There should be exactly
one dot somewhere in the filename portion and the filename should be composed
of only DCHARs.
1 is returned if path is valid.
name_translate¶
name_translate(name, joliet_level=0)->$str
Convert an ISO-9660 file name of the kind that is that stored in a ISO 9660
directory entry into what's usually listed as the file name in a listing.
Lowercase name if no Joliet Extension interpretation. Remove trailing ;1's or
.;1's and turn the other ;'s into version numbers.
If joliet_level is not given it is 0 which means use no Joliet Extensions.
Otherwise use the specified the Joliet level.
The translated string is returned and it will be larger than the input filename.
stat_array_to_href¶
stat_array_to_href(values)->href
Convert a ISO 9660 array to an hash reference of the values.
Used internally in convert from C code.
Note, we modify the input parameter.
strncpy_pad¶
strncpy_pad(name, len, check='nocheck')->str
Pad string
name with spaces to size len and return this. If len is less
than the length of
name, the return value will be truncated to the
first
len characters of
name.
name can also be scanned to see if it contains only ACHARs, DCHARs, or
7-bit ASCII chars, and this is specified via the
check parameter. If
the
check parameter is given it must be one of the 'nocheck', '7bit',
'achars' or 'dchars'. Case is not significant.
SEE ALSO¶
Device::Cdio::ISO9660::IFS is the ISO 96600 filesystem image interface.
Device::Cdio::ISO9660::FS is the ISO 96600 CD-image interface. Device::Cdio
has general information on the CD Input and Control Library.
Device::Cdio::Device is for device objects and Device::Cdio::Track is for
track objects.
perliso9660 is the lower-level interface to libcdio.
<
http://www.gnu.org/software/libcdio> has documentation on libcdio
including the a manual and the API via doxygen.
AUTHORS¶
Rocky Bernstein "<rocky at cpan.org>".
COPYRIGHT¶
Copyright (C) 2006, 2011 Rocky Bernstein <rocky@cpan.org>
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.
You should have received a copy of the GNU General Public License along with
this program. If not, see <
http://www.gnu.org/licenses/>.