qi/path/sdklayout.hpp

Go to the documentation of this file.

#pragma once
#ifndef _LIBQI_QI_PATH_SDKLAYOUT_HPP_
#define _LIBQI_QI_PATH_SDKLAYOUT_HPP_

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

namespace qi
{

  class PrivateSDKLayout;

  class QI_API SDKLayout //: boost::noncopyable
  {
  public:

    SDKLayout();

    explicit SDKLayout(const std::string &prefix, const std::string &mode = "");

    SDKLayout(const SDKLayout &rhs);
    SDKLayout &operator=(const SDKLayout &rhs);

    virtual ~SDKLayout();



    std::string sdkPrefix() const;

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

    void addOptionalSdkPrefix(const char *prefix);

    void clearOptionalSdkPrefix();



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

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

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

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



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

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

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

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



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

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

  private:
    // Pimpl
    PrivateSDKLayout* _private;
  };

}

#endif  // _LIBQI_QI_PATH_SDKLAYOUT_HPP_