Files.hh

Go to the documentation of this file.

/*  Files

PIRL CVS ID: $Id: Files.hh,v 1.11 2012/07/20 00:25:53 castalia Exp $

Copyright (C) 2006-2010 Arizona Board of Regents on behalf of the
Planetary Image Research Laboratory, Lunar and Planetary Laboratory at
the University of Arizona.

This program is free software; you can redistribute it and/or modify it
under the terms of the GNU General Public License, version 2, as
published by the Free Software Foundation.

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.,
59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
*/
#ifndef _Files_
#define _Files_

#include    <string>
#include    <sys/types.h>   //  For off_t.

namespace PIRL
{
/*==============================================================================
    Constants
*/
extern const char
    *Files_ID;
    
extern const char
    FILE_PATHNAME_DELIMITER;

extern const char
    FILE_EXTENSION_DELIMITER;

/*==============================================================================
    Functions
*/
bool file_exists (const std::string& pathname);

bool file_is_readable (const std::string& pathname);

bool file_is_writeable (const std::string& pathname);

bool file_is_normal (const std::string& pathname);

bool file_is_directory (const std::string& pathname);

bool file_is_link (const std::string& pathname);

off_t file_size (const std::string& pathname);

bool file_is_absolute (const std::string& pathname);

std::string& clean_pathname (std::string& pathname);

std::string file_pathname (const std::string& filename);

std::string file_pathname
    (const std::string& directory, const std::string& filename);

std::string CWD ();

std::string file_directory (const std::string& pathname);

std::string file_directory_pathname (const std::string& pathname);

std::string file_name (const std::string& pathname);

std::string file_basename (const std::string& pathname);

std::string file_extension (const std::string& pathname);

std::string home_directory_pathname ();

std::string username ();

unsigned int UID ();

unsigned int GID ();

std::string hostname ();

}   //  PIRL namespace
#endif