SystemPaths.hh

Go to the documentation of this file.

/*
 * Copyright (C) 2012-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 _GAZEBO_SYSTEMPATHS_HH_
#define _GAZEBO_SYSTEMPATHS_HH_

#include <stdio.h>

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

#include <boost/filesystem.hpp>
#include <list>
#include <string>

#include "gazebo/common/CommonTypes.hh"
#include "gazebo/common/Event.hh"
#include "gazebo/common/SingletonT.hh"
#include "gazebo/util/system.hh"

namespace gazebo
{
  namespace common
  {

    class GZ_COMMON_VISIBLE SystemPaths : public SingletonT<SystemPaths>
    {
      private: SystemPaths();

      public: std::string GetLogPath() const;

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

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

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

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

      public: std::string GetWorldPathExtension();

      public: std::string GetTmpPath() GAZEBO_DEPRECATED(8.0);

      public: const std::string &TmpPath() const;

      public: std::string GetTmpInstancePath() GAZEBO_DEPRECATED(8.0);

      public: const std::string &TmpInstancePath() const;

      public: std::string GetDefaultTestPath() GAZEBO_DEPRECATED(8.0);

      public: std::string DefaultTestPath() const;

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

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

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

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

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

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

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

      public: void ClearGazeboPaths();

      public: void ClearModelPaths();

      public: void ClearOgrePaths();

      public: void ClearPluginPaths();

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

      private: void UpdateModelPaths();

      private: void UpdateGazeboPaths();

      private: void UpdatePluginPaths();

      private: void UpdateOgrePaths();

      private: void InsertUnique(const std::string &_path,
                                 std::list<std::string> &_list);

      private: std::list<std::string> gazeboPaths;

      private: std::list<std::string> ogrePaths;

      private: std::list<std::string> pluginPaths;

      private: std::list<std::string> suffixPaths;

      private: std::list<std::string> modelPaths;

      private: std::string logPath;

      public: event::EventT<void (std::string)> updateModelRequest;

      public: bool modelPathsFromEnv;

      public: bool gazeboPathsFromEnv;

      public: bool pluginPathsFromEnv;

      public: bool ogrePathsFromEnv;

      private: friend class SingletonT<SystemPaths>;

      private: boost::filesystem::path tmpPath;

      private: boost::filesystem::path tmpInstancePath;
    };
  }
}
#endif