121 lines
4.3 KiB
C++
121 lines
4.3 KiB
C++
// Copyright 2010-2017 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 OR_TOOLS_BASE_STL_UTIL_H_
|
|
#define OR_TOOLS_BASE_STL_UTIL_H_
|
|
|
|
#include <algorithm>
|
|
#include <string>
|
|
|
|
namespace gtl {
|
|
|
|
// STLDeleteContainerPointers()
|
|
// For a range within a container of pointers, calls delete
|
|
// (non-array version) on these pointers.
|
|
// NOTE: for these three functions, we could just implement a DeleteObject
|
|
// functor and then call for_each() on the range and functor, but this
|
|
// requires us to pull in all of algorithm.h, which seems expensive.
|
|
// For hash_[multi]set, it is important that this deletes behind the iterator
|
|
// because the hash_set may call the hash function on the iterator when it is
|
|
// advanced, which could result in the hash function trying to deference a
|
|
// stale pointer.
|
|
template <class ForwardIterator>
|
|
void STLDeleteContainerPointers(ForwardIterator begin, ForwardIterator end) {
|
|
while (begin != end) {
|
|
ForwardIterator temp = begin;
|
|
++begin;
|
|
delete *temp;
|
|
}
|
|
}
|
|
|
|
// STLDeleteContainerPairSecondPointers()
|
|
// For a range within a container of pairs, calls delete
|
|
// (non-array version) on the SECOND item in the pairs.
|
|
// NOTE: Like STLDeleteContainerPointers, deleting behind the iterator.
|
|
// Deleting the value does not always invalidate the iterator, but it may
|
|
// do so if the key is a pointer into the value object.
|
|
template <class ForwardIterator>
|
|
void STLDeleteContainerPairSecondPointers(ForwardIterator begin,
|
|
ForwardIterator end) {
|
|
while (begin != end) {
|
|
ForwardIterator temp = begin;
|
|
++begin;
|
|
delete temp->second;
|
|
}
|
|
}
|
|
|
|
inline void STLStringResizeUninitialized(std::string* s, size_t new_size) {
|
|
s->resize(new_size);
|
|
}
|
|
|
|
// Return a mutable char* pointing to a std::string's internal buffer,
|
|
// which may not be null-terminated. Writing through this pointer will
|
|
// modify the std::string.
|
|
//
|
|
// string_as_array(&str)[i] is valid for 0 <= i < str.size() until the
|
|
// next call to a std::string method that invalidates iterators.
|
|
//
|
|
// As of 2006-04, there is no standard-blessed way of getting a
|
|
// mutable reference to a std::string's internal buffer. However, issue 530
|
|
// (http://www.open-std.org/JTC1/SC22/WG21/docs/lwg-active.html#530)
|
|
// proposes this as the method. According to Matt Austern, this should
|
|
// already work on all current implementations.
|
|
inline char* string_as_array(std::string* str) {
|
|
return str->empty() ? NULL : &*str->begin();
|
|
}
|
|
|
|
// STLDeleteElements() deletes all the elements in an STL container and clears
|
|
// the container. This function is suitable for use with a std::vector, set,
|
|
// hash_set, or any other STL container which defines sensible begin(), end(),
|
|
// and clear() methods.
|
|
//
|
|
// If container is NULL, this function is a no-op.
|
|
//
|
|
// As an alternative to calling STLDeleteElements() directly, consider
|
|
// ElementDeleter (defined below), which ensures that your container's elements
|
|
// are deleted when the ElementDeleter goes out of scope.
|
|
template <class T>
|
|
void STLDeleteElements(T* container) {
|
|
if (!container) return;
|
|
STLDeleteContainerPointers(container->begin(), container->end());
|
|
container->clear();
|
|
}
|
|
|
|
// Given an STL container consisting of (key, value) pairs, STLDeleteValues
|
|
// deletes all the "value" components and clears the container. Does nothing
|
|
// in the case it's given a NULL pointer.
|
|
template <class T>
|
|
void STLDeleteValues(T* v) {
|
|
if (!v) return;
|
|
for (typename T::iterator i = v->begin(); i != v->end(); ++i) {
|
|
delete i->second;
|
|
}
|
|
v->clear();
|
|
}
|
|
|
|
template <typename T>
|
|
void STLClearObject(T* obj) {
|
|
T tmp;
|
|
tmp.swap(*obj);
|
|
obj->reserve(0);
|
|
}
|
|
|
|
template <typename T>
|
|
inline void STLSortAndRemoveDuplicates(T* v) {
|
|
std::sort(v->begin(), v->end());
|
|
v->erase(std::unique(v->begin(), v->end()), v->end());
|
|
}
|
|
|
|
} // namespace gtl
|
|
#endif // OR_TOOLS_BASE_STL_UTIL_H_
|