privatefilelib.h

/*
 * File: privatefilelib.h
 * ----------------------
 * This file exports a standardized set of tools for working with
 * files.  The library offers at least some portability across the
 * file systems used in the three supported platforms: Mac OSX,
 * Windows, and Linux.  Directory and search paths are allowed to
 * contain separators in any of the supported styles, which usually
 * makes it possible to use the same code on different platforms.
 * This functionality is considered "private" and not to be used by students.
 *
 * @version 2021/04/09
 * - moved to private SGL namespace
 * @version 2021/04/03
 * - removed dependency on custom collections
 * @version 2018/10/23
 * - added getAbsolutePath
 * @version 2018/09/25
 * - added doc comments for new documentation generation
 * @version 2016/11/12
 * - added fileSize, readEntireStream
 * @version 2015/04/12
 * - added promptUserForFile overload without stream parameter
 * @version 2014/10/19
 * - alphabetized function declarations
 * - converted many funcs to take const string& rather than string for efficiency
 * - added listDirectory overload that returns a Vector
 */


#ifndef _private_filelib_h
#define _private_filelib_h

#include <iostream>
#include <fstream>
#include <string>
#include <vector>

namespace sgl {
namespace priv {
namespace filelib {

bool fileExists(const string& filename);

string getAbsolutePath(const string& path);

string getDirectoryPathSeparator();

string getExtension(const string& filename);

string getHead(const string& filename);

string getTempDirectory();

bool isDirectory(const string& filename);

std::vector<string> listDirectory(const string& path);

void readEntireFile(std::istream& is, std::vector<string>& lines);

string readEntireFile(const string& filename);

string readEntireStream(std::istream& input);

bool writeEntireFile(const string& filename,
                     const string& text,
                     bool append = false);

namespace platform {
    void filelib_createDirectory(const string& path);
    void filelib_deleteFile(const string& path);
    string filelib_expandPathname(const string& filename);
    bool filelib_fileExists(const string& filename);
    string filelib_getAbsolutePath(const string& path);
    string filelib_getCurrentDirectory();
    string filelib_getDirectoryPathSeparator();
    string filelib_getSearchPathSeparator();
    string filelib_getTempDirectory();
    bool filelib_isDirectory(const string& filename);
    bool filelib_isFile(const string& filename);
    bool filelib_isSymbolicLink(const string& filename);
    void filelib_listDirectory(const string& path, std::vector<string>& list);
    void filelib_setCurrentDirectory(const string& path);
} // namespace platform

} // namespace filelib
} // namespace priv
} // namespace sgl

#endif // _private_filelib_h