os.h

Go to the documentation of this file.

/*
 * Copyright (c) 2014 Jonathan Anderson
 * All rights reserved.
 *
 * This software was developed by SRI International and the University of
 * Cambridge Computer Laboratory under DARPA/AFRL contract (FA8750-10-C-0237)
 * ("CTSRD"), as part of the DARPA CRASH research programme.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 */

#ifndef POSIX_H
#define POSIX_H

#include <functional>
#include <string>
#include <vector>

namespace fabrique {

//
// File- and path-related predicates:
//

bool FileIsExecutable(std::string path);

bool FileIsSharedLibrary(std::string path);

bool PathIsAbsolute(const std::string&);

bool PathIsDirectory(std::string);

bool PathIsFile(std::string);


//
// Other file- and path-related functions that might be used as arguments:
//

typedef std::function<std::string (std::string, const std::vector<std::string>&)>
    MissingFileReporter;

MissingFileReporter DefaultFilename(std::string name = "");

std::string FileNotFound(std::string name, const std::vector<std::string>& searchPaths);


//
// Filename and path manipulation:
//

std::string AbsoluteDirectory(std::string name, bool createIfMissing = true);

std::string AbsolutePath(std::string path);

std::string BaseName(std::string path);

std::string CreateDirCommand(std::string directory);

std::string DirectoryOf(std::string filename, bool absolute = false);

std::string FileExtension(std::string path);

std::string FilenameComponent(std::string pathIncludingDirectory);

std::string FindExecutable(std::string name, MissingFileReporter report = FileNotFound);

std::string FindFile(std::string filename, const std::vector<std::string>& directories,
                     std::function<bool (const std::string&)> test = PathIsFile,
                     MissingFileReporter report = FileNotFound);

std::string JoinPath(const std::string&, const std::string&);

std::string JoinPath(const std::vector<std::string>&);

std::string LibraryFilename(std::string name);

std::vector<std::string> PluginSearchPaths(std::string executablePath);


//
// Fabrique modules:
//

std::string FindModule(std::string srcroot, std::string subdir,
                       std::string filename);

}

#endif