/*
 * Copyright 2018 Google
 *
 * 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 FIRESTORE_CORE_SRC_MODEL_RESOURCE_PATH_H_
#define FIRESTORE_CORE_SRC_MODEL_RESOURCE_PATH_H_

#include <initializer_list>
#include <string>
#include <utility>

#include "Firestore/core/src/model/base_path.h"
#include "Firestore/core/src/util/comparison.h"
#include "absl/strings/string_view.h"

namespace firebase {
namespace firestore {
namespace remote {
class Serializer;
}  // namespace remote

namespace model {

/**
 * A slash-separated path for navigating resources (documents and collections)
 * within Firestore. Immutable; all instances are fully independent.
 */
class ResourcePath : public impl::BasePath<ResourcePath>,
                     public util::InequalityComparable<ResourcePath> {
 public:
  ResourcePath() = default;
  /** Constructs the path from segments. */
  template <typename IterT>
  ResourcePath(const IterT begin, const IterT end) : BasePath{begin, end} {
  }
  ResourcePath(std::initializer_list<std::string> list) : BasePath{list} {
  }
  explicit ResourcePath(SegmentsT&& segments) : BasePath{std::move(segments)} {
  }
  /**
   * Creates and returns a new path from the given resource-path string, where
   * the path segments are separated by a slash "/".
   */
  static ResourcePath FromString(const std::string& path);
  static ResourcePath FromStringView(absl::string_view path);

 private:
  // TODO(b/146372592): Make this public once we can use Abseil across
  // iOS/public C++ library boundaries.
  friend class DocumentKey;
  friend class remote::Serializer;

 public:
  static ResourcePath Empty() {
    return ResourcePath{};
  }

  /** Returns a standardized string representation of this path. */
  std::string CanonicalString() const;
};

}  // namespace model
}  // namespace firestore
}  // namespace firebase

#endif  // FIRESTORE_CORE_SRC_MODEL_RESOURCE_PATH_H_
