1// Copyright (c) 2012 The Chromium Authors. All rights reserved.
2// Use of this source code is governed by a BSD-style license that can be
3// found in the LICENSE file.
4
5#ifndef BASE_MEMORY_SCOPED_VECTOR_H_
6#define BASE_MEMORY_SCOPED_VECTOR_H_
7
8#include <stddef.h>
9
10#include <vector>
11
12#include "base/logging.h"
13#include "base/memory/scoped_ptr.h"
14#include "base/move.h"
15#include "base/stl_util.h"
16
17// ScopedVector wraps a vector deleting the elements from its
18// destructor.
19//
20// TODO(http://crbug.com/554289): DEPRECATED: Use std::vector instead (now that
21// we have support for moveable types inside containers).
22template <class T>
23class ScopedVector {
24  MOVE_ONLY_TYPE_FOR_CPP_03(ScopedVector)
25
26 public:
27  typedef typename std::vector<T*>::allocator_type allocator_type;
28  typedef typename std::vector<T*>::size_type size_type;
29  typedef typename std::vector<T*>::difference_type difference_type;
30  typedef typename std::vector<T*>::pointer pointer;
31  typedef typename std::vector<T*>::const_pointer const_pointer;
32  typedef typename std::vector<T*>::reference reference;
33  typedef typename std::vector<T*>::const_reference const_reference;
34  typedef typename std::vector<T*>::value_type value_type;
35  typedef typename std::vector<T*>::iterator iterator;
36  typedef typename std::vector<T*>::const_iterator const_iterator;
37  typedef typename std::vector<T*>::reverse_iterator reverse_iterator;
38  typedef typename std::vector<T*>::const_reverse_iterator
39      const_reverse_iterator;
40
41  ScopedVector() {}
42  ~ScopedVector() { clear(); }
43  ScopedVector(ScopedVector&& other) { swap(other); }
44
45  ScopedVector& operator=(ScopedVector&& rhs) {
46    swap(rhs);
47    return *this;
48  }
49
50  reference operator[](size_t index) { return v_[index]; }
51  const_reference operator[](size_t index) const { return v_[index]; }
52
53  bool empty() const { return v_.empty(); }
54  size_t size() const { return v_.size(); }
55
56  reverse_iterator rbegin() { return v_.rbegin(); }
57  const_reverse_iterator rbegin() const { return v_.rbegin(); }
58  reverse_iterator rend() { return v_.rend(); }
59  const_reverse_iterator rend() const { return v_.rend(); }
60
61  iterator begin() { return v_.begin(); }
62  const_iterator begin() const { return v_.begin(); }
63  iterator end() { return v_.end(); }
64  const_iterator end() const { return v_.end(); }
65
66  const_reference front() const { return v_.front(); }
67  reference front() { return v_.front(); }
68  const_reference back() const { return v_.back(); }
69  reference back() { return v_.back(); }
70
71  void push_back(T* elem) { v_.push_back(elem); }
72  void push_back(scoped_ptr<T> elem) { v_.push_back(elem.release()); }
73
74  void pop_back() {
75    DCHECK(!empty());
76    delete v_.back();
77    v_.pop_back();
78  }
79
80  std::vector<T*>& get() { return v_; }
81  const std::vector<T*>& get() const { return v_; }
82  void swap(std::vector<T*>& other) { v_.swap(other); }
83  void swap(ScopedVector<T>& other) { v_.swap(other.v_); }
84  void release(std::vector<T*>* out) {
85    out->swap(v_);
86    v_.clear();
87  }
88
89  void reserve(size_t capacity) { v_.reserve(capacity); }
90
91  // Resize, deleting elements in the disappearing range if we are shrinking.
92  void resize(size_t new_size) {
93    if (v_.size() > new_size)
94      STLDeleteContainerPointers(v_.begin() + new_size, v_.end());
95    v_.resize(new_size);
96  }
97
98  template<typename InputIterator>
99  void assign(InputIterator begin, InputIterator end) {
100    v_.assign(begin, end);
101  }
102
103  void clear() { STLDeleteElements(&v_); }
104
105  // Like |clear()|, but doesn't delete any elements.
106  void weak_clear() { v_.clear(); }
107
108  // Lets the ScopedVector take ownership of |x|.
109  iterator insert(iterator position, T* x) {
110    return v_.insert(position, x);
111  }
112
113  iterator insert(iterator position, scoped_ptr<T> x) {
114    return v_.insert(position, x.release());
115  }
116
117  // Lets the ScopedVector take ownership of elements in [first,last).
118  template<typename InputIterator>
119  void insert(iterator position, InputIterator first, InputIterator last) {
120    v_.insert(position, first, last);
121  }
122
123  iterator erase(iterator position) {
124    delete *position;
125    return v_.erase(position);
126  }
127
128  iterator erase(iterator first, iterator last) {
129    STLDeleteContainerPointers(first, last);
130    return v_.erase(first, last);
131  }
132
133  // Like |erase()|, but doesn't delete the element at |position|.
134  iterator weak_erase(iterator position) {
135    return v_.erase(position);
136  }
137
138  // Like |erase()|, but doesn't delete the elements in [first, last).
139  iterator weak_erase(iterator first, iterator last) {
140    return v_.erase(first, last);
141  }
142
143 private:
144  std::vector<T*> v_;
145};
146
147#endif  // BASE_MEMORY_SCOPED_VECTOR_H_
148