qi/path.hpp

Go to the documentation of this file.

/*
 * 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.
 */

#pragma once
#ifndef _LIBQI_QI_PATH_HPP_
#define _LIBQI_QI_PATH_HPP_

# include <string>
# include <vector>
# include <qi/config.hpp>

namespace qi
{
  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> 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 std::string userWritableDataPath(const std::string& applicationName,
                                            const std::string& filename);

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


  };
};

#endif  // _LIBQI_QI_PATH_HPP_