PackageResourceRetriever.hpp

Go to the documentation of this file.

/*
 * Copyright (c) 2011-2021, The DART development contributors
 * All rights reserved.
 *
 * The list of contributors can be found at:
 *   https://github.com/dartsim/dart/blob/master/LICENSE
 *
 * This file is provided under the following "BSD-style" License:
 *   Redistribution and use in source and binary forms, with or
 *   without modification, are permitted provided that the following
 *   conditions are met:
 *   * Redistributions of source code must retain the above copyright
 *     notice, this list of conditions and the following disclaimer.
 *   * Redistributions in binary form must reproduce the above
 *     copyright notice, this list of conditions and the following
 *     disclaimer in the documentation and/or other materials provided
 *     with the distribution.
 *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
 *   CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
 *   INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
 *   MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 *   DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
 *   CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
 *   USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
 *   AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 *   LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
 *   ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 *   POSSIBILITY OF SUCH DAMAGE.
 */
 
#ifndef DART_UTILS_PACKAGERESOURCERETRIEVER_HPP_
#define DART_UTILS_PACKAGERESOURCERETRIEVER_HPP_
 
#include <unordered_map>
#include <vector>
 
#include "dart/common/ClassWithVirtualBase.hpp"
#include "dart/common/ResourceRetriever.hpp"
 
namespace dart {
namespace utils {
 
DART_DECLARE_CLASS_WITH_VIRTUAL_BASE_BEGIN
class PackageResourceRetriever : public virtual common::ResourceRetriever
{
public:
  explicit PackageResourceRetriever(
      const common::ResourceRetrieverPtr& _localRetriever = nullptr);
 
  virtual ~PackageResourceRetriever() = default;
 
  void addPackageDirectory(
      const std::string& _packageName, const std::string& _packageDirectory);
 
  // Documentation inherited.
  bool exists(const common::Uri& _uri) override;
 
  // Documentation inherited.
  common::ResourcePtr retrieve(const common::Uri& _uri) override;
 
  // Documentation inherited.
  std::string getFilePath(const common::Uri& uri) override;
 
private:
  common::ResourceRetrieverPtr mLocalRetriever;
  std::unordered_map<std::string, std::vector<std::string> > mPackageMap;
 
  const std::vector<std::string>& getPackagePaths(
      const std::string& _packageName) const;
  bool resolvePackageUri(
      const common::Uri& _uri,
      std::string& _packageName,
      std::string& _relativePath) const;
};
DART_DECLARE_CLASS_WITH_VIRTUAL_BASE_END
 
using PackageResourceRetrieverPtr = std::shared_ptr<PackageResourceRetriever>;
 
} // namespace utils
} // namespace dart
 
#endif // ifndef DART_UTILS_PACKAGERESOURCERETRIEVER_HPP_