swift-mirror/include/swift/Syntax/SyntaxCollection.h

//===--- SyntaxCollection.h -------------------------------------*- C++ -*-===//
//
// This source file is part of the Swift.org open source project
//
// Copyright (c) 2014 - 2017 Apple Inc. and the Swift project authors
// Licensed under Apache License v2.0 with Runtime Library Exception
//
// See https://swift.org/LICENSE.txt for license information
// See https://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
//
//===----------------------------------------------------------------------===//

#ifndef SWIFT_SYNTAX_SYNTAXCOLLECTION_H
#define SWIFT_SYNTAX_SYNTAXCOLLECTION_H

#include "swift/Syntax/Syntax.h"

#include <iterator>

namespace swift {
namespace syntax {

// MARK: - SyntaxCollection

template <SyntaxKind CollectionKind, typename Element>
class SyntaxCollection;

template <SyntaxKind CollectionKind, typename Element>
struct SyntaxCollectionIterator {
  const SyntaxCollection<CollectionKind, Element> &Collection;
  size_t Index;

  Element operator*() {
    return Collection[Index];
  }

  SyntaxCollectionIterator<CollectionKind, Element> &operator++() {
    ++Index;
    return *this;
  }

  bool
  operator==(const SyntaxCollectionIterator<CollectionKind, Element> &Other) {
    return Collection.hasSameIdentityAs(Other.Collection) &&
    Index == Other.Index;
  }

  bool
  operator!=(const SyntaxCollectionIterator<CollectionKind, Element> &Other) {
    return !operator==(Other);

  }
};

/// A generic unbounded collection of syntax nodes
template <SyntaxKind CollectionKind, typename Element>
class SyntaxCollection : public Syntax {
  friend class Syntax;

private:
  static RC<const SyntaxData> makeData(std::initializer_list<Element> &Elements,
                                       const RC<SyntaxArena> &Arena) {
    auto RawElements = llvm::map_iterator(
        Elements.begin(),
        [](const Element &Elt) -> const RawSyntax * { return Elt.getRaw(); });
    auto Raw = RawSyntax::make(CollectionKind, RawElements, Elements.size(),
                               SourcePresence::Present, Arena);
    return SyntaxData::makeRoot(AbsoluteRawSyntax::forRoot(Raw));
  }

public:
  SyntaxCollection(const RC<const SyntaxData> &Data) : Syntax(Data) {
    validate();
  }

  SyntaxCollection(std::initializer_list<Element> list):
    SyntaxCollection(SyntaxCollection::makeData(list)) {}

  void validate() {}

  /// Returns true if the collection is empty.
  bool empty() const {
    return size() == 0;
  }

  /// Returns the number of elements in the collection.
  size_t size() const {
    return getRaw()->getLayout().size();
  }

  SyntaxCollectionIterator<CollectionKind, Element> begin() const {
    return SyntaxCollectionIterator<CollectionKind, Element> {
      *this,
      0,
    };
  }

  SyntaxCollectionIterator<CollectionKind, Element> end() const {
    return SyntaxCollectionIterator<CollectionKind, Element> {
      *this,
      getRaw()->getLayout().size(),
    };
  }

  /// Return the element at the given Index.
  ///
  /// Precondition: Index < size()
  /// Precondition: !empty()
  Element operator[](const size_t Index) const {
    assert(Index < size());
    assert(!empty());
    return Element(Data->getChild(Index));
  }

  /// Return a new collection with the given element added to the end.
  SyntaxCollection<CollectionKind, Element>
  appending(Element E) const {
    auto OldLayout = getRaw()->getLayout();
    std::vector<const RawSyntax *> NewLayout;
    NewLayout.reserve(OldLayout.size() + 1);
    std::copy(OldLayout.begin(), OldLayout.end(), back_inserter(NewLayout));
    NewLayout.push_back(E.getRaw());
    auto Raw = RawSyntax::make(CollectionKind, NewLayout,
                               getRaw()->getPresence(), getRaw()->getArena());
    return SyntaxCollection<CollectionKind, Element>(Data->replacingSelf(Raw));
  }

  /// Return a new collection with an element removed from the end.
  ///
  /// Precondition: !empty()
  SyntaxCollection<CollectionKind, Element> removingLast() const {
    assert(!empty());
    auto NewLayout = getRaw()->getLayout().drop_back();
    auto Raw = RawSyntax::make(CollectionKind, NewLayout,
                               getRaw()->getPresence(), getRaw()->getArena());
    return SyntaxCollection<CollectionKind, Element>(Data->replacingSelf(Raw));
  }

  /// Return a new collection with the given element appended to the front.
  SyntaxCollection<CollectionKind, Element>
  prepending(Element E) const {
    auto OldLayout = getRaw()->getLayout();
    std::vector<const RawSyntax *> NewLayout = {E.getRaw()};
    std::copy(OldLayout.begin(), OldLayout.end(),
              std::back_inserter(NewLayout));
    auto Raw = RawSyntax::make(CollectionKind, NewLayout,
                               getRaw()->getPresence(), getRaw()->getArena());
    return SyntaxCollection<CollectionKind, Element>(Data->replacingSelf(Raw));
  }

  /// Return a new collection with an element removed from the end.
  ///
  /// Precondition: !empty()
  SyntaxCollection<CollectionKind, Element> removingFirst() const {
    assert(!empty());
    auto NewLayout = getRaw()->getLayout().drop_front();
    auto Raw = RawSyntax::make(CollectionKind, NewLayout,
                               getRaw()->getPresence(), getRaw()->getArena());
    return SyntaxCollection<CollectionKind, Element>(Data->replacingSelf(Raw));
  }

  /// Return a new collection with the Element inserted at index i.
  ///
  /// Precondition: i <= size()
  SyntaxCollection<CollectionKind, Element>
  inserting(size_t i, Element E) const {
    assert(i <= size());
    auto OldLayout = getRaw()->getLayout();
    std::vector<const RawSyntax *> NewLayout;
    NewLayout.reserve(OldLayout.size() + 1);

    std::copy(OldLayout.begin(), OldLayout.begin() + i,
              std::back_inserter(NewLayout));
    NewLayout.push_back(E.getRaw());
    std::copy(OldLayout.begin() + i, OldLayout.end(),
              std::back_inserter(NewLayout));
    auto Raw = RawSyntax::make(CollectionKind, NewLayout,
                               getRaw()->getPresence(), getRaw()->getArena());
    return SyntaxCollection<CollectionKind, Element>(Data->replacingSelf(Raw));
  }

  /// Return a new collection with the element removed at index i.
  SyntaxCollection<CollectionKind, Element> removing(size_t i) const {
    assert(i <= size());
    std::vector<const RawSyntax *> NewLayout = getRaw()->getLayout();
    auto iterator = NewLayout.begin();
    std::advance(iterator, i);
    NewLayout.erase(iterator);
    auto Raw = RawSyntax::make(CollectionKind, NewLayout,
                               getRaw()->getPresence(), getRaw()->getArena());
    return SyntaxCollection<CollectionKind, Element>(Data->replacingSelf(Raw));
  }

  /// Return an empty syntax collection of this type.
  SyntaxCollection<CollectionKind, Element> cleared() const {
    auto Raw = RawSyntax::make(CollectionKind, {}, getRaw()->getPresence(),
                               getRaw()->getArena());
    return SyntaxCollection<CollectionKind, Element>(Data->replacingSelf(Raw));
  }

  static bool kindof(SyntaxKind Kind) {
    return Kind == CollectionKind;
  }

  static bool classof(const Syntax *S) {
    return kindof(S->getKind());
  }
};

// MARK: - SyntaxCollectionRef

template <SyntaxKind CollectionKind, typename Element>
class SyntaxCollectionRef;

template <SyntaxKind CollectionKind, typename Element>
struct SyntaxCollectionRefIterator {
  const SyntaxCollectionRef<CollectionKind, Element> &Collection;
  size_t Index;

  OwnedSyntaxRef<Element> operator*() { return Collection.getChild(Index); }

  SyntaxCollectionRefIterator<CollectionKind, Element> &operator++() {
    ++Index;
    return *this;
  }

  bool operator==(
      const SyntaxCollectionRefIterator<CollectionKind, Element> &Other) {
    return Collection.hasSameIdentityAs(Other.Collection) &&
           Index == Other.Index;
  }

  bool operator!=(
      const SyntaxCollectionRefIterator<CollectionKind, Element> &Other) {
    return !operator==(Other);
  }
};

/// A generic unbounded collection of \c SyntaxRef nodes.
template <SyntaxKind CollectionKind, typename Element>
class SyntaxCollectionRef : public SyntaxRef {
  friend class Syntax;

public:
  SyntaxCollectionRef(const SyntaxDataRef *Data) : SyntaxRef(Data) {
    validate();
  }
  SyntaxCollectionRef(const SyntaxDataRef *Data, no_validation_t)
      : SyntaxRef(Data) {}

  void validate() {}

  /// Returns true if the collection is empty.
  bool empty() const { return size() == 0; }

  /// Returns the number of elements in the collection.
  size_t size() const { return getRaw()->getLayout().size(); }

  SyntaxCollectionRefIterator<CollectionKind, Element> begin() const {
    return SyntaxCollectionRefIterator<CollectionKind, Element>{
        /*Collection=*/*this,
        /*Index=*/0,
    };
  }

  SyntaxCollectionRefIterator<CollectionKind, Element> end() const {
    return SyntaxCollectionRefIterator<CollectionKind, Element>{
        /*Collection=*/*this,
        /*Index=*/getRaw()->getLayout().size(),
    };
  }

  /// Return the element at the given Index.
  ///
  /// Precondition: Index < size()
  OwnedSyntaxRef<Element> getChild(const size_t Index) const {
    assert(Index < size() && "Index out of bounds");
    OwnedSyntaxRef<Element> Result;
    getDataRef()->getChildRef(Index, Result.getDataPtr());
    return Result;
  }

  static bool kindof(SyntaxKind Kind) { return Kind == CollectionKind; }

  static bool classof(const SyntaxRef *S) { return kindof(S->getKind()); }
};


} // end namespace syntax
} // end namespace swift

#endif // SWIFT_SYNTAX_SYNTAXCOLLECTION_H