130d4e1f3d81ad9f7a1aa14ce6d2ceb5df56c15cdSelim Gurun/*
230d4e1f3d81ad9f7a1aa14ce6d2ceb5df56c15cdSelim Gurun * Copyright 2011 Google Inc. All Rights Reserved.
330d4e1f3d81ad9f7a1aa14ce6d2ceb5df56c15cdSelim Gurun *
430d4e1f3d81ad9f7a1aa14ce6d2ceb5df56c15cdSelim Gurun * Licensed under the Apache License, Version 2.0 (the "License");
530d4e1f3d81ad9f7a1aa14ce6d2ceb5df56c15cdSelim Gurun * you may not use this file except in compliance with the License.
630d4e1f3d81ad9f7a1aa14ce6d2ceb5df56c15cdSelim Gurun * You may obtain a copy of the License at
730d4e1f3d81ad9f7a1aa14ce6d2ceb5df56c15cdSelim Gurun *
830d4e1f3d81ad9f7a1aa14ce6d2ceb5df56c15cdSelim Gurun *      http://www.apache.org/licenses/LICENSE-2.0
930d4e1f3d81ad9f7a1aa14ce6d2ceb5df56c15cdSelim Gurun *
1030d4e1f3d81ad9f7a1aa14ce6d2ceb5df56c15cdSelim Gurun * Unless required by applicable law or agreed to in writing, software
1130d4e1f3d81ad9f7a1aa14ce6d2ceb5df56c15cdSelim Gurun * distributed under the License is distributed on an "AS IS" BASIS,
1230d4e1f3d81ad9f7a1aa14ce6d2ceb5df56c15cdSelim Gurun * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
1330d4e1f3d81ad9f7a1aa14ce6d2ceb5df56c15cdSelim Gurun * See the License for the specific language governing permissions and
1430d4e1f3d81ad9f7a1aa14ce6d2ceb5df56c15cdSelim Gurun * limitations under the License.
1530d4e1f3d81ad9f7a1aa14ce6d2ceb5df56c15cdSelim Gurun */
1630d4e1f3d81ad9f7a1aa14ce6d2ceb5df56c15cdSelim Gurun
1730d4e1f3d81ad9f7a1aa14ce6d2ceb5df56c15cdSelim Gurun#ifndef SFNTLY_CPP_SRC_SFNTLY_PORT_JAVA_ITERATOR_H_
1830d4e1f3d81ad9f7a1aa14ce6d2ceb5df56c15cdSelim Gurun#define SFNTLY_CPP_SRC_SFNTLY_PORT_JAVA_ITERATOR_H_
1930d4e1f3d81ad9f7a1aa14ce6d2ceb5df56c15cdSelim Gurun
2030d4e1f3d81ad9f7a1aa14ce6d2ceb5df56c15cdSelim Gurun#include "sfntly/port/refcount.h"
2130d4e1f3d81ad9f7a1aa14ce6d2ceb5df56c15cdSelim Gurun
2230d4e1f3d81ad9f7a1aa14ce6d2ceb5df56c15cdSelim Gurun// Interface of Java iterator.
2330d4e1f3d81ad9f7a1aa14ce6d2ceb5df56c15cdSelim Gurun// This is a forward read-only iterator that represents java.util.Iterator<E>
2430d4e1f3d81ad9f7a1aa14ce6d2ceb5df56c15cdSelim Gurun
2530d4e1f3d81ad9f7a1aa14ce6d2ceb5df56c15cdSelim Gurunnamespace sfntly {
2630d4e1f3d81ad9f7a1aa14ce6d2ceb5df56c15cdSelim Gurun
2730d4e1f3d81ad9f7a1aa14ce6d2ceb5df56c15cdSelim Guruntemplate <typename ReturnType, typename ContainerBase>
2830d4e1f3d81ad9f7a1aa14ce6d2ceb5df56c15cdSelim Gurunclass Iterator : public virtual RefCount {
2930d4e1f3d81ad9f7a1aa14ce6d2ceb5df56c15cdSelim Gurun public:
3030d4e1f3d81ad9f7a1aa14ce6d2ceb5df56c15cdSelim Gurun  virtual ~Iterator() {}
3130d4e1f3d81ad9f7a1aa14ce6d2ceb5df56c15cdSelim Gurun  virtual ContainerBase* container_base() = 0;
3230d4e1f3d81ad9f7a1aa14ce6d2ceb5df56c15cdSelim Gurun
3330d4e1f3d81ad9f7a1aa14ce6d2ceb5df56c15cdSelim Gurun protected:
3430d4e1f3d81ad9f7a1aa14ce6d2ceb5df56c15cdSelim Gurun  Iterator() {}
3530d4e1f3d81ad9f7a1aa14ce6d2ceb5df56c15cdSelim Gurun  NO_COPY_AND_ASSIGN(Iterator);
3630d4e1f3d81ad9f7a1aa14ce6d2ceb5df56c15cdSelim Gurun};
3730d4e1f3d81ad9f7a1aa14ce6d2ceb5df56c15cdSelim Gurun
3830d4e1f3d81ad9f7a1aa14ce6d2ceb5df56c15cdSelim Guruntemplate <typename ReturnType, typename Container,
3930d4e1f3d81ad9f7a1aa14ce6d2ceb5df56c15cdSelim Gurun          typename ContainerBase = Container>
4030d4e1f3d81ad9f7a1aa14ce6d2ceb5df56c15cdSelim Gurunclass PODIterator : public Iterator<ReturnType, ContainerBase>,
4130d4e1f3d81ad9f7a1aa14ce6d2ceb5df56c15cdSelim Gurun                    public RefCounted< PODIterator<ReturnType, Container> > {
4230d4e1f3d81ad9f7a1aa14ce6d2ceb5df56c15cdSelim Gurun public:
4330d4e1f3d81ad9f7a1aa14ce6d2ceb5df56c15cdSelim Gurun  explicit PODIterator(Container* container) : container_(container) {}
4430d4e1f3d81ad9f7a1aa14ce6d2ceb5df56c15cdSelim Gurun  virtual ~PODIterator() {}
4530d4e1f3d81ad9f7a1aa14ce6d2ceb5df56c15cdSelim Gurun  virtual ContainerBase* container_base() {
4630d4e1f3d81ad9f7a1aa14ce6d2ceb5df56c15cdSelim Gurun    return static_cast<ContainerBase*>(container_);
4730d4e1f3d81ad9f7a1aa14ce6d2ceb5df56c15cdSelim Gurun  }
4830d4e1f3d81ad9f7a1aa14ce6d2ceb5df56c15cdSelim Gurun
4930d4e1f3d81ad9f7a1aa14ce6d2ceb5df56c15cdSelim Gurun  virtual bool HasNext() = 0;
5030d4e1f3d81ad9f7a1aa14ce6d2ceb5df56c15cdSelim Gurun  virtual ReturnType Next() = 0;
5130d4e1f3d81ad9f7a1aa14ce6d2ceb5df56c15cdSelim Gurun  virtual void Remove() {
5230d4e1f3d81ad9f7a1aa14ce6d2ceb5df56c15cdSelim Gurun#if !defined (SFNTLY_NO_EXCEPTION)
5330d4e1f3d81ad9f7a1aa14ce6d2ceb5df56c15cdSelim Gurun    // Default to no support.
5430d4e1f3d81ad9f7a1aa14ce6d2ceb5df56c15cdSelim Gurun    throw UnsupportedOperationException();
5530d4e1f3d81ad9f7a1aa14ce6d2ceb5df56c15cdSelim Gurun#endif
5630d4e1f3d81ad9f7a1aa14ce6d2ceb5df56c15cdSelim Gurun  }
5730d4e1f3d81ad9f7a1aa14ce6d2ceb5df56c15cdSelim Gurun
5830d4e1f3d81ad9f7a1aa14ce6d2ceb5df56c15cdSelim Gurun protected:
5930d4e1f3d81ad9f7a1aa14ce6d2ceb5df56c15cdSelim Gurun  Container* container() { return container_; }
6030d4e1f3d81ad9f7a1aa14ce6d2ceb5df56c15cdSelim Gurun
6130d4e1f3d81ad9f7a1aa14ce6d2ceb5df56c15cdSelim Gurun private:
6230d4e1f3d81ad9f7a1aa14ce6d2ceb5df56c15cdSelim Gurun  Container* container_;  // Dumb pointer is used to avoid circular ref-counting
6330d4e1f3d81ad9f7a1aa14ce6d2ceb5df56c15cdSelim Gurun};
6430d4e1f3d81ad9f7a1aa14ce6d2ceb5df56c15cdSelim Gurun
6530d4e1f3d81ad9f7a1aa14ce6d2ceb5df56c15cdSelim Guruntemplate <typename ReturnType, typename Container,
6630d4e1f3d81ad9f7a1aa14ce6d2ceb5df56c15cdSelim Gurun          typename ContainerBase = Container>
6730d4e1f3d81ad9f7a1aa14ce6d2ceb5df56c15cdSelim Gurunclass RefIterator : public Iterator<ReturnType, ContainerBase>,
6830d4e1f3d81ad9f7a1aa14ce6d2ceb5df56c15cdSelim Gurun                    public RefCounted< RefIterator<ReturnType, Container> > {
6930d4e1f3d81ad9f7a1aa14ce6d2ceb5df56c15cdSelim Gurun public:
7030d4e1f3d81ad9f7a1aa14ce6d2ceb5df56c15cdSelim Gurun  explicit RefIterator(Container* container) : container_(container) {}
7130d4e1f3d81ad9f7a1aa14ce6d2ceb5df56c15cdSelim Gurun  virtual ~RefIterator() {}
7230d4e1f3d81ad9f7a1aa14ce6d2ceb5df56c15cdSelim Gurun  virtual ContainerBase* container_base() {
7330d4e1f3d81ad9f7a1aa14ce6d2ceb5df56c15cdSelim Gurun    return static_cast<ContainerBase*>(container_);
7430d4e1f3d81ad9f7a1aa14ce6d2ceb5df56c15cdSelim Gurun  }
7530d4e1f3d81ad9f7a1aa14ce6d2ceb5df56c15cdSelim Gurun
7630d4e1f3d81ad9f7a1aa14ce6d2ceb5df56c15cdSelim Gurun  virtual bool HasNext() = 0;
7730d4e1f3d81ad9f7a1aa14ce6d2ceb5df56c15cdSelim Gurun  CALLER_ATTACH virtual ReturnType* Next() = 0;
7830d4e1f3d81ad9f7a1aa14ce6d2ceb5df56c15cdSelim Gurun  virtual void Remove() {
7930d4e1f3d81ad9f7a1aa14ce6d2ceb5df56c15cdSelim Gurun#if !defined (SFNTLY_NO_EXCEPTION)
8030d4e1f3d81ad9f7a1aa14ce6d2ceb5df56c15cdSelim Gurun    // Default to no support.
8130d4e1f3d81ad9f7a1aa14ce6d2ceb5df56c15cdSelim Gurun    throw UnsupportedOperationException();
8230d4e1f3d81ad9f7a1aa14ce6d2ceb5df56c15cdSelim Gurun#endif
8330d4e1f3d81ad9f7a1aa14ce6d2ceb5df56c15cdSelim Gurun  }
8430d4e1f3d81ad9f7a1aa14ce6d2ceb5df56c15cdSelim Gurun
8530d4e1f3d81ad9f7a1aa14ce6d2ceb5df56c15cdSelim Gurun protected:
8630d4e1f3d81ad9f7a1aa14ce6d2ceb5df56c15cdSelim Gurun  Container* container() { return container_; }
8730d4e1f3d81ad9f7a1aa14ce6d2ceb5df56c15cdSelim Gurun
8830d4e1f3d81ad9f7a1aa14ce6d2ceb5df56c15cdSelim Gurun private:
8930d4e1f3d81ad9f7a1aa14ce6d2ceb5df56c15cdSelim Gurun  Container* container_;  // Dumb pointer is used to avoid circular ref-counting
9030d4e1f3d81ad9f7a1aa14ce6d2ceb5df56c15cdSelim Gurun};
9130d4e1f3d81ad9f7a1aa14ce6d2ceb5df56c15cdSelim Gurun
9230d4e1f3d81ad9f7a1aa14ce6d2ceb5df56c15cdSelim Gurun}  // namespace sfntly
9330d4e1f3d81ad9f7a1aa14ce6d2ceb5df56c15cdSelim Gurun
9430d4e1f3d81ad9f7a1aa14ce6d2ceb5df56c15cdSelim Gurun#endif  // SFNTLY_CPP_SRC_SFNTLY_PORT_JAVA_ITERATOR_H_
95