file.h

/*
 *  Copyright (c) 2003    National Research Council
 *
 *  All rights reserved.
 *
 *  This material is confidential and proprietary information of
 *  National Research Council Canada ("Confidential Information").
 *  This Confidential Information may only be used and reproduced
 *  in accordance with the terms of the license agreement.
 *
 */

#ifndef __INCLUDED_SCOPIRA_TOOL_FILE_H__
#define __INCLUDED_SCOPIRA_TOOL_FILE_H__

#include <sys/stat.h>

#include <string>

#include <scopira/tool/export.h>

namespace scopira
{
  namespace tool
  {
    class file;

    const char dir_seperator_c = '/';

    const char * get_username(void);
    const char * get_homedir(void);
  }
}

class scopira::tool::file
{
  public:
    typedef ::off_t offset_t;
  private:
    //const std::string m_filename;   // dont need this?
    bool dm_error;       // was there an error on stat? if so, reading from m_stat is useless
    struct stat dm_stat;

  public:
    SCOPIRA_EXPORT file(void);

    SCOPIRA_EXPORT file(const std::string &fname);

    SCOPIRA_EXPORT void set(const std::string &fname);

    SCOPIRA_EXPORT bool exists(void) const;

    SCOPIRA_EXPORT bool is_file(void) const;

    SCOPIRA_EXPORT bool is_dir(void) const;

    SCOPIRA_EXPORT offset_t size(void) const;

    SCOPIRA_EXPORT static bool check_path(const std::string& path);

    SCOPIRA_EXPORT static bool has_ext(const std::string &fname, const std::string &ext);
    
    SCOPIRA_EXPORT static void expand_homedir(std::string &path);
    
    SCOPIRA_EXPORT static void expand_envvar(std::string &path);
    
    SCOPIRA_EXPORT static void split_ext(const std::string &fullname, std::string &sansext, std::string &ext);
    
    SCOPIRA_EXPORT static void split_path(const std::string &fullname, std::string &path, std::string &name);

    SCOPIRA_EXPORT static std::string realpath(const std::string &name);
    
    SCOPIRA_EXPORT static void create_directory(const std::string &dirname);
};

#endif