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.

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.

A hash reference which contains:

LSN

the Logical sector number (an integer)

size

the total size of the file in bytes

sec_size

the number of sectors allocated

filename

the file name of the statbuf entry

XA

if the file has XA attributes; 0 if not

is_dir

1 if a directory; '' if a not.

tm

A POSIX time structure as often return in unis "localtime()" or "gmtime()". However we adjust the year to be "normal", e.g. we use 2017 instead of 117 and months start at 1 (for January), not 0. Fields in "tm" are:

    sec   # Seconds (0-60)
    min   # Minutes (0-59)
    hour  # Hours (0-23)
    mday  # Day of the month (1-31)
    mon   # Month (1-12)
    year  # Year, e.g. 2017
    wday  # Day of the week (0-6, Sunday = 0)
    yday  # Day in the year (0-365, 1 Jan = 0) */
    isdst # Daylight saving time */
    

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.