SystemPaths.hh

Go to the documentation of this file.

/*
 * Copyright (C) 2016 Open Source Robotics Foundation
 *
 * 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.
 *
*/
#ifndef IGNITION_COMMON_SYSTEMPATHS_HH_
#define IGNITION_COMMON_SYSTEMPATHS_HH_

#include <stdio.h>

#ifdef _WIN32
  #include <direct.h>
  #define GetCurrentDir _getcwd
#else
  #include <unistd.h>
  #define GetCurrentDir getcwd
#endif

#include <functional>
#include <list>
#include <memory>
#include <string>
#include <vector>

#include <ignition/common/Export.hh>
#include <ignition/common/SuppressWarning.hh>
#include <ignition/common/URI.hh>

namespace ignition
{
  namespace common
  {
    // Forward declare private data class
    class SystemPathsPrivate;

    class IGNITION_COMMON_VISIBLE  SystemPaths
    {
      public: SystemPaths();

      public: virtual ~SystemPaths();

      public: std::string LogPath() const;

      public: const std::list<std::string> &PluginPaths();

      public: std::string FindFileURI(const std::string &_uri) const;

      public: std::string FindFileURI(const ignition::common::URI &_uri) const;

      public: void SetPluginPathEnv(const std::string &_env);

      public: std::string FindFile(const std::string &_filename,
                                   const bool _searchLocalPath = true) const;

      public: std::string FindSharedLibrary(const std::string &_libName);

      public: void AddPluginPaths(const std::string &_path);

      public: void ClearPluginPaths();

      public: void SetFilePathEnv(const std::string &_env);

      public: std::string FilePathEnv() const;

      public: const std::list<std::string> &FilePaths();

      public: void AddFilePaths(const std::string &_path);

      public: void ClearFilePaths();

      public: void AddSearchPathSuffix(const std::string &_suffix);

      public: void IGN_DEPRECATED(3) SetFindFileCallback(
                  std::function<std::string(const std::string &)> _cb);

      public: void AddFindFileCallback(
                  std::function<std::string(const std::string &)> _cb);

      public: void AddFindFileURICallback(
          std::function<std::string(const ignition::common::URI &)> _cb);

      public: void IGN_DEPRECATED(3) SetFindFileURICallback(
                  std::function<std::string(const std::string &)> _cb);

      //          or an empty string if the file was not found
      public: static std::string LocateLocalFile(const std::string &_filename,
                                  const std::vector<std::string> &_paths);

      public: static std::string NormalizeDirectoryPath(
                const std::string &_path);

      public: static std::list<std::string> PathsFromEnv(
                const std::string &_env);

      public: static char Delimiter();

      IGN_COMMON_WARN_IGNORE__DLL_INTERFACE_MISSING
      private: std::unique_ptr<SystemPathsPrivate> dataPtr;
      IGN_COMMON_WARN_RESUME__DLL_INTERFACE_MISSING
    };
  }
}
#endif