Home Documentation Download Services About

NAME

FileUtil

SYNOPSIS

use FileUtil;

use FileUtil qw(:all);

DESCRIPTION

FileUtil module provides the following functions:

CheckFileType, ConvertCygwinPath, ExpandFileNames, FileModificationTimeAndDate , FileSize, FormatFileSize, FormattedFileModificationTimeAndDate , GetMayaChemToolsLibDirName, GetUsageFromPod, ParseFileName

FUNCTIONS

CheckFileType

$Status = CheckFileType($FileName, $FileExts);

Based on FileExts, decides type of FileName and return 1 or 0

ConvertCygwinPath

$NewPath = ConvertCygwinPath($Path);

Check to see whether Path contains any Cygwin drive specification and convert it into Windows path

ExpandFileNames

@FilesList = ExpandFileNames(\@Files, $FileExts);

For each directory name in Files, generate all file names which correspond to extensions in FileExts and return an array FileList containing these file names

FormattedFileModificationTimeAndDate

($TimeString, $DateString) = FormattedFileModificationTimeAndDate($FileName);

Returns a formatted time and date string corresponding to FileName modification time

FileModificationTimeAndDate

($Hours, $Mins, $Secs, $DayName, $MonthName, $Month, $Year) = FileModificationTimeAndDate($FileName);

Returns file modification time and date values for specified FileName

FormatFileSize

$FormattedSize= FormatFileSize($Size, [$Precision]);

Formats the file size in bytes to human readable value and returns a formatted file size string

FileSize

$Size= FileSize($FileName);

Returns size of FileName in bytes

GetUsageFromPod

$ScriptUsage = GetUsageFromPod($AbsoluteScriptPath);

Generates a ScriptUsage string from pod documentation in the script file using pod2text or perdoc.bat Perl utitities

ParseFileName

($FileDir, $FileName, $FileExt) = ParseFileName($FullFileName);

Splits FullFileName into directory name, file name, and extension. FileDir is set to NULL for absent directory name in FullFileName

AUTHOR

Manish Sud

SEE ALSO

TextUtil.pm

COPYRIGHT

Copyright (C) 2004-2008 Manish Sud. All rights reserved.

This file is part of MayaChemTools.

MayaChemTools is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version.