path.hpp

Go to the documentation of this file.

#pragma once
/*
 * Copyright (c) 2012 Aldebaran Robotics. All rights reserved.
 * Use of this source code is governed by a BSD-style license that can be
 * found in the COPYING file.
 */

#ifndef _QI_PATH_HPP_
#define _QI_PATH_HPP_

# include <string>
# include <vector>
# include <boost/shared_ptr.hpp>
# include <qi/api.hpp>

namespace qi
{

  class PrivatePath;
  class Path;
  typedef std::vector<Path> PathVector;
  class QI_API Path {
  public:
    Path(const std::string& unicodePath = std::string());

    bool isEmpty() const;
    bool isDir() const;
    bool isRegularFile() const;

    std::string filename() const;
    std::string extension() const;

    Path parent();
    Path absolute();

    PathVector files();
    PathVector dirs();

    operator std::string() const;

    Path operator/(const qi::Path& rhs) const;
    const Path& operator/=(const qi::Path& rhs) const;

  private:
    Path(const boost::shared_ptr<PrivatePath> &p);;
    boost::shared_ptr<PrivatePath> _p;
  };

  namespace path
  {

    QI_API std::string sdkPrefix();

    // not thread-safe, must be kept internal
    namespace detail {

      QI_API std::vector<std::string> getSdkPrefixes();

      QI_API void addOptionalSdkPrefix(const char* prefix);

      QI_API void clearOptionalSdkPrefix();

    }

    QI_API std::string findBin(const std::string& name);

    QI_API std::string findLib(const std::string& name);

    QI_API std::string findConf(const std::string& applicationName,
                                const std::string& filename);

    QI_API std::string findData(const std::string& applicationName,
                                const std::string& filename);

    QI_API std::vector<std::string> listData(const std::string& applicationName,
                                             const std::string& pattern="*");

    QI_API std::vector<std::string> confPaths(const std::string& applicationName="");

    QI_API std::vector<std::string> dataPaths(const std::string& applicationName="");

    QI_API std::vector<std::string> binPaths();

    QI_API std::vector<std::string> libPaths();


    QI_API void setWritablePath(const std::string &path);

    QI_API std::string userWritableDataPath(const std::string& applicationName,
                                            const std::string& filename);

    QI_API std::string userWritableConfPath(const std::string& applicationName,
                                            const std::string& filename="");

    QI_API std::string convertToDosPath(const std::string &pathString);
  }
}

#endif  // _QI_PATH_HPP_