Pathname.h

Go to the documentation of this file.

#ifndef SimTK_SimTKCOMMON_PATHNAME_H_
#define SimTK_SimTKCOMMON_PATHNAME_H_

/* -------------------------------------------------------------------------- *
 *                       Simbody(tm): SimTKcommon                             *
 * -------------------------------------------------------------------------- *
 * This is part of the SimTK biosimulation toolkit originating from           *
 * Simbios, the NIH National Center for Physics-Based Simulation of           *
 * Biological Structures at Stanford, funded under the NIH Roadmap for        *
 * Medical Research, grant U54 GM072970. See https://simtk.org/home/simbody.  *
 *                                                                            *
 * Portions copyright (c) 2009-15 Stanford University and the Authors.        *
 * Authors: Michael Sherman, Carmichael Ong                                   *
 * Contributors:                                                              *
 *                                                                            *
 * Licensed under the Apache License, Version 2.0 (the "License"); you may    *
 * not use this file except in compliance with the License. You may obtain a  *
 * copy of the License at http://www.apache.org/licenses/LICENSE-2.0.         *
 *                                                                            *
 * Unless required by applicable law or agreed to in writing, software        *
 * distributed under the License is distributed on an "AS IS" BASIS,          *
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.   *
 * See the License for the specific language governing permissions and        *
 * limitations under the License.                                             *
 * -------------------------------------------------------------------------- */

#include "SimTKcommon/internal/common.h"
#include "SimTKcommon/internal/Array.h"
#include <string>
#include <stdexcept>

namespace SimTK {

class SimTK_SimTKCOMMON_EXPORT Pathname {
public:


    static void deconstructPathname(    const std::string& pathname,
                                        bool&        dontApplySearchPath,
                                        std::string& directory,
                                        std::string& fileName,
                                        std::string& extension);

    static void deconstructPathnameUsingSpecifiedWorkingDirectory(const std::string& swd,
                                                                  const std::string& pathname,
                                                                  std::string& directory,
                                                                  std::string& fileName,
                                                                  std::string& extension);
    
    static void deconstructAbsolutePathname(const std::string& pathname,
                                            std::string& directory,
                                            std::string& fileName,
                                            std::string& extension) {
        bool dontApplySearchPath;
        deconstructPathname(pathname, dontApplySearchPath, directory, fileName, extension);
        if (!dontApplySearchPath)
            directory = getCurrentWorkingDirectory() + directory;
    }

    static std::string getAbsolutePathname(const std::string& pathname) {
        std::string directory, fileName, extension;
        deconstructAbsolutePathname(pathname, directory, fileName, extension);
        return directory + fileName + extension;
    }

    static std::string getAbsoluteDirectoryPathname(const std::string& dirPathname) {
        std::string absPath = getAbsolutePathname(dirPathname);
        if (!absPath.empty() && absPath[absPath.size()-1] != getPathSeparatorChar())
            absPath += getPathSeparatorChar();
        return absPath;
    }

    static std::string getAbsolutePathnameUsingSpecifiedWorkingDirectory
       (const std::string& swd, const std::string& pathname) {
        std::string directory, fileName, extension;
        deconstructPathnameUsingSpecifiedWorkingDirectory
           (swd, pathname, directory, fileName, extension);
        return directory + fileName + extension;
    }

    static std::string 
    getAbsoluteDirectoryPathnameUsingSpecifiedWorkingDirectory
       (const std::string& swd, const std::string& dirPathname) {
        std::string absPath = 
            getAbsolutePathnameUsingSpecifiedWorkingDirectory(swd, dirPathname);
        if (!absPath.empty() && absPath[absPath.size()-1] != getPathSeparatorChar())
            absPath += getPathSeparatorChar();
        return absPath;
    }

    static bool fileExists(const std::string& pathname);

    static std::string getDefaultInstallDir();

    static std::string addDirectoryOffset(const std::string& base, 
                                          const std::string& offset);

    static std::string getInstallDir(const std::string& envInstallDir,
                                     const std::string& offsetFromDefaultInstallDir);

    static std::string getThisExecutablePath();
    static std::string getThisExecutableDirectory();
    static bool getFunctionLibraryDirectory(void* func,
                                            std::string& absolutePathname);
    static std::string getCurrentWorkingDirectory(const std::string& drive="");
    static std::string getRootDirectory(const std::string& drive="");
    static std::string getCurrentDriveLetter();
    static std::string getCurrentDrive();
    static bool environmentVariableExists(const std::string& name);
    static std::string getEnvironmentVariable(const std::string& name);
    static std::string getPathSeparator();
    static char getPathSeparatorChar();
    static bool isPathSeparator(char c) {
        return c=='/' || c=='\\';
    }
};

} // namespace SimTK

#endif // SimTK_SimTKCOMMON_PATHNAME_H_