Path.h

Go to the documentation of this file.

/*
 * Copyright (C) 2012 by
 *   MetraLabs GmbH (MLAB), GERMANY
 * and
 *   Neuroinformatics and Cognitive Robotics Labs (NICR) at TU Ilmenau, GERMANY
 * All rights reserved.
 *
 * Contact: info@mira-project.org
 *
 * Commercial Usage:
 *   Licensees holding valid commercial licenses may use this file in
 *   accordance with the commercial license agreement provided with the
 *   software or, alternatively, in accordance with the terms contained in
 *   a written agreement between you and MLAB or NICR.
 *
 * GNU General Public License Usage:
 *   Alternatively, this file may be used under the terms of the GNU
 *   General Public License version 3.0 as published by the Free Software
 *   Foundation and appearing in the file LICENSE.GPL3 included in the
 *   packaging of this file. Please review the following information to
 *   ensure the GNU General Public License version 3.0 requirements will be
 *   met: http://www.gnu.org/copyleft/gpl.html.
 *   Alternatively you may (at your option) use any later version of the GNU
 *   General Public License if such license has been publicly approved by
 *   MLAB and NICR (or its successors, if any).
 *
 * IN NO EVENT SHALL "MLAB" OR "NICR" BE LIABLE TO ANY PARTY FOR DIRECT,
 * INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF
 * THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF "MLAB" OR
 * "NICR" HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * "MLAB" AND "NICR" SPECIFICALLY DISCLAIM ANY WARRANTIES, INCLUDING,
 * BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
 * FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE PROVIDED HEREUNDER IS
 * ON AN "AS IS" BASIS, AND "MLAB" AND "NICR" HAVE NO OBLIGATION TO
 * PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS OR MODIFICATIONS.
 */

#ifndef _MIRA_PATH_H_
#define _MIRA_PATH_H_

#ifndef Q_MOC_RUN
#include <boost/filesystem/operations.hpp>
#include <boost/filesystem/path.hpp>
#endif

#include <platform/Types.h>

#include <serialization/IsTransparentSerializable.h>
#include <serialization/SplitReflect.h>
#include <serialization/PropertyHint.h>

namespace mira {


typedef boost::filesystem::path Path;

typedef std::vector<Path> PathVector;

MIRA_BASE_EXPORT PathVector extractPaths(const std::string& env);

MIRA_BASE_EXPORT Path normalizePath(const Path& path);

MIRA_BASE_EXPORT Path resolvePath(const Path& path, bool makeAbsolute=true);

MIRA_BASE_EXPORT bool isRootOfPath(const Path& root, const Path& path);

MIRA_BASE_EXPORT Path getExecutableDirectory();

MIRA_BASE_EXPORT Path getHomeDirectory();

MIRA_BASE_EXPORT Path getAppDataDirectory(const std::string& appName = "mira");

MIRA_BASE_EXPORT Path getTempDirectory();

MIRA_BASE_EXPORT Path relativizePath(const Path& path, const Path& base);


template <typename Reflector>
void reflectRead(Reflector& r, Path& path)
{
    std::string s = path.string();
    r.delegate(s);
}

template <typename Reflector>
void reflectWrite(Reflector& r, Path& path)
{
    std::string s;
    r.delegate(s);
    path = s;
}

MIRA_SPLIT_REFLECT(Path)

template<typename SerializerTag>
class IsTransparentSerializable<Path,SerializerTag> : public std::true_type {};


namespace PropertyHints {

inline PropertyHint file(const std::string& filters = std::string(),
                         bool save = false) {
    return PropertyHint("file", filters) | PropertyHint("save", toString(save));
}

}


}

#endif