This class has a set of file tools. More...

#include "../include/FileTool.h"

Static Public Member Functions
static bool	isFullPath (const char *filename)

static int	addPath (const char path, const char file, String &filename)

static int	checkPath (const char path, const char file)

static int	addOutPath (const char path, const char file, String &filename)

static int	numPath (const char *path)

static int	getPath (const char *path, int ind, String &spath)

static int	addPathDelim (String &path)

static int	addUserPath (const char *file, String &filename)

static bool	exist (const char *file)

static bool	isStdio (const char *file)

static bool	isDir (const char *file)

static bool	isFile (const char *file)

static bool	isFifo (const char *file)

static bool	isDevice (const char *file)

static int	getSize (const char *file)

static int	getModTime (const char *file)

static int	remove (const char *file)

static int	makeDir (const char *dir, int flag)

Detailed Description

This class has a set of file tools.

Author: Dan Vietor

Member Function Documentation

◆ addOutPath()

int FileTool::addOutPath	(	const char *	path,
		const char *	file,
		String &	filename
	)

static

Adds a path to the output filename. Won't add path if full path already or special file. File not assumed to exist.

Parameters

path	Path to add
file	Filename

Return values

filename Output filename

References addPathDelim(), WXP::String::append(), WXP::String::copy(), exist(), WXP::String::get(), getPath(), isFullPath(), isStdio(), numPath(), and WXP::StrLib::valid().

Referenced by WXP::RawPlot::draw(), WXP::GridCont::getDomain(), and WXP::GridVect::getDomain().

◆ addPath()

int FileTool::addPath	(	const char *	path,
		const char *	file,
		String &	filename
	)

static

Adds a path to the filename. Won't add path if full path already or special file. Checks directory list for available file.

Parameters

path	Path to add
file	Filename

Return values

filename Output filename

Returns: 1 if file exists

References addPathDelim(), WXP::String::append(), WXP::String::copy(), exist(), WXP::String::get(), getPath(), isFullPath(), isStdio(), numPath(), and WXP::StrLib::valid().

Referenced by WXP::MapPlot::draw(), WXP::ProfPlot::draw(), WXP::RedbookPlot::draw(), WXP::UpaXSectCont::draw(), WXP::UpaXSectPlot::draw(), WXP::Region::get(), WXP::ModelName::get(), WXP::CityTool::getFilename(), WXP::Graph::open(), WXP::VarFile::open(), WXP::BufrFile::open(), WXP::WmoIngest::printLog(), WXP::ColorFile::read(), WXP::Unit::readFile(), WXP::WmoIngest::readProdFile(), WXP::VarName::searchFile(), WXP::ModelSpec::set(), WXP::NameConv::set(), WXP::CityPlot::setFilename(), WXP::Graph::setFont(), WXP::Graph::setSymbol(), WXP::RcmDecode::setup(), WXP::UpaRawinHash::setup(), WXP::CityHash::setup(), and WXP::License::valid().

◆ addPathDelim()

int FileTool::addPathDelim ( String & path )

static

Adds operating system specific path delimiter (/, )

Return values

path	Path to add delimiter to, appends to end of path

References WXP::String::append(), WXP::String::get(), WXP::String::getChar(), and WXP::String::length().

Referenced by addOutPath(), addPath(), checkPath(), and WXP::ResrcFile::open().

◆ addUserPath()

int FileTool::addUserPath	(	const char *	file,
		String &	filename
	)

static

Adds user path (~user). Check filename to see if user name specified and add user's home directory to path

Parameters

file	Input filename to check

Return values

filename Output filename with user name replaced

References WXP::String::append(), and WXP::String::copy().

Referenced by exist(), getModTime(), getSize(), isDevice(), isDir(), isFifo(), isFile(), WXP::File::open(), and remove().

◆ checkPath()

int FileTool::checkPath	(	const char *	path,
		const char *	file
	)

static

Checks path to the filename. Adds path and checks for existence.

Parameters

path	Path to add
file	Filename

Returns: 1 if file exists

References addPathDelim(), WXP::String::append(), WXP::String::copy(), exist(), WXP::String::get(), getPath(), isFullPath(), isStdio(), numPath(), and WXP::StrLib::valid().

Referenced by WXP::RadPlot::init(), WXP::RcmPlot::init(), and WXP::SatPlot::init().

◆ exist()

bool FileTool::exist ( const char * file )

static

Checks to see if file exists

Parameters

file	Filename to check

Returns: True if exists

References addUserPath(), isStdio(), and WXP::Wxp::outDebug().

Referenced by addOutPath(), addPath(), checkPath(), WXP::NameConv::encode(), WXP::Filename::listFile(), WXP::ResrcFile::open(), WXP::Filename::set(), WXP::NameConv::set(), WXP::Filename::setFile(), and WXP::NameConv::setLatest().

◆ getModTime()

int FileTool::getModTime ( const char * file )

static

Returns the modification time

Parameters

file	Filename to query

References addUserPath().

Referenced by WXP::RedbookFile::open().

◆ getPath()

int FileTool::getPath	(	const char *	path,
		int	ind,
		String &	spath
	)

static

Gets a path from a path list (path:path:...)

Parameters

path	Path list
ind	Index of path to get

Return values

spath Output path

References WXP::String::clear(), WXP::String::copy(), WXP::StrLib::equal(), and WXP::StrLib::index().

Referenced by addOutPath(), addPath(), checkPath(), WXP::NameConv::encode(), WXP::Filename::listFile(), and WXP::License::valid().

◆ getSize()

int FileTool::getSize ( const char * file )

static

Returns the size in bytes of a file

Parameters

file	Filename to query

References addUserPath(), and WXP::Wxp::outDebug().

Referenced by WXP::SfcWxpFile::checkType(), WXP::CityFile::open(), WXP::SfcWxpFile::open(), WXP::NameConv::setFile(), and WXP::NameConv::setLatest().

◆ isDevice()

bool FileTool::isDevice ( const char * file )

static

Checks to see if file is a device

Parameters

file	Filename to check

References addUserPath(), and WXP::StrLib::iequal().

◆ isDir()

bool FileTool::isDir ( const char * file )

static

Checks to see if file is a directory

Parameters

file	Filename to check

References addUserPath().

Referenced by WXP::ResrcFile::open().

◆ isFifo()

bool FileTool::isFifo ( const char * file )

static

Checks to see if the file is a FIFO/queue

Parameters

file	Filename to check

References addUserPath().

◆ isFile()

bool FileTool::isFile ( const char * file )

static

Checks to see if filename a regular file

Parameters

file	Filename to check

References addUserPath().

◆ isFullPath()

bool FileTool::isFullPath ( const char * filename )

static

Returns if filename a full path

Returns: 0=relative path, 1=full path

Referenced by addOutPath(), addPath(), WXP::Filename::checkFile(), and checkPath().

◆ isStdio()

bool FileTool::isStdio ( const char * file )

static

Checks to see if file is standard IO file "-"

Parameters

file	Filename to check

References WXP::StrLib::iequal().

Referenced by addOutPath(), addPath(), WXP::Filename::checkFile(), checkPath(), WXP::GridFile::checkType(), exist(), WXP::GridCont::getDomain(), WXP::GridPlot::getDomain(), and WXP::File::open().

◆ makeDir()

int FileTool::makeDir	(	const char *	dir,
		int	flag
	)

static

Create a directory and its subdirectories (recursive create)

Parameters

dir	Directory to create.
flag	Number to create (0=create all subdirectories)

References WXP::StrLib::copy(), WXP::StrLib::length(), and WXP::StrLib::replace().

Referenced by WXP::File::open().

◆ numPath()

int FileTool::numPath ( const char * path )

static

Finds the number of valid paths in a multipath string

Parameters

path	Path to check

References WXP::StrLib::equal(), and WXP::StrLib::index().

Referenced by addOutPath(), addPath(), checkPath(), WXP::NameConv::encode(), WXP::Filename::listFile(), and WXP::License::valid().

◆ remove()

int FileTool::remove ( const char * file )

static

Deletes the specified file

Parameters

file	Filename to delete

References addUserPath(), and WXP::String::get().

The documentation for this class was generated from the following files:

FileTool.h
FileTool.cc

Static Public Member Functions

Detailed Description

Member Function Documentation

◆ addOutPath()

◆ addPath()

◆ addPathDelim()

◆ addUserPath()

◆ checkPath()

◆ exist()

◆ getModTime()

◆ getPath()

◆ getSize()

◆ isDevice()

◆ isDir()

◆ isFifo()

◆ isFile()

◆ isFullPath()

◆ isStdio()

◆ makeDir()

◆ numPath()

◆ remove()