infer_clone/infer/models/cpp/include/infer_model/vector.h

/*
 * Copyright (c) Facebook, Inc. and its affiliates.
 *
 * This source code is licensed under the MIT license found in the
 * LICENSE file in the root directory of this source tree.
 */

#pragma once

#include <type_traits>
#include <climits>
#include <limits>
#include <initializer_list>
#include <stdexcept>
#include <memory>
#include <cstring>
#include <cassert>

#include <infer_model/common.h>
#include <infer_model/infer_traits.h>

#ifdef INFER_USE_LIBCPP
// libc++ vector header includes it, but it breaks
// compilation with stdlibc++ implementation
#include <algorithm>
#endif

INFER_NAMESPACE_STD_BEGIN

struct bool_ref {
  bool_ref& operator=(bool x) {}
  bool_ref& operator=(const bool_ref& x) {}

  operator bool() const noexcept {}
  void flip() noexcept {}

  // not part of C++ std, but required for model implementation to compile
  explicit bool_ref(bool x) {}
};

template <class T>
struct vector_ref {
  typedef T& ref;
};

template <>
struct vector_ref<bool> {
  typedef bool_ref ref;
};

int __infer_skip__get_int_val();

// this function will be treated as SKIP by infer
template <class T>
T* __infer_skip__get_nondet_val() {}

template <class T>
void __infer_deref_first_arg(T* ptr) INFER_MODEL_AS_DEREF_FIRST_ARG;

#define INFER_EXCLUDE_CONDITION(cond) \
  if (cond)                           \
    while (1)

// WARNING: do not add any new fields to std::vector model. sizeof(std::vector)
// = 24 !!
#ifdef INFER_USE_LIBCPP
// if using libcpp, then this template will have already a default _Allocator
// set (see include/c++/v1/iosfwd, where vector's declaration has a template
// with a default allocator<_Tp>, like the commented section below)
template <class _Tp, class _Allocator /* = allocator<_Tp> */>
#else
template <class _Tp, class _Allocator = allocator<_Tp>>
#endif
class vector {

 public:
  typedef vector __self;
  typedef _Tp value_type;
  typedef _Allocator allocator_type;
  typedef allocator_traits<allocator_type> __alloc_traits;
  typedef typename vector_ref<value_type>::ref reference;
  typedef const value_type& const_reference;
  typedef typename __alloc_traits::size_type size_type;
  typedef typename __alloc_traits::difference_type difference_type;
  typedef typename __alloc_traits::pointer pointer;
  typedef typename __alloc_traits::const_pointer const_pointer;

  typedef STD_ITER(pointer, vector) iterator;
  typedef STD_ITER(const_pointer, vector) const_iterator;
  typedef std::reverse_iterator<iterator> reverse_iterator;
  typedef std::reverse_iterator<const_iterator> const_reverse_iterator;

  /* INFER SPECIFIC HELPER FUNCTIONS */

  // required to keep sizeof(std::vector) same as in standard
  value_type* beginPtr = nullptr;
  value_type* endPtr = nullptr;
  value_type* __ignore;

  value_type* _get_begin() const {
    // we have to resort to that hack so that infer can truly dereference
    // beginPtr.
    // Another way to model that would be 'auto tmp = *beginPtr' but that will
    // trigger copy constructor that may not exist for value_type
    __infer_deref_first_arg(beginPtr);
    return beginPtr;
  }

  value_type* _get_end() const {
    __infer_deref_first_arg(beginPtr);
    __infer_deref_first_arg(endPtr);
    return endPtr;
  }

  value_type* _get_index(size_type __n) const {
    __infer_deref_first_arg(beginPtr);
    return __infer_skip__get_nondet_val<value_type>();
  }

  void allocate(size_type size) {
    // assume that allocation will produce non-empty vector regardless of the
    // size
    // if (size > 0) {
    beginPtr = __infer_skip__get_nondet_val<value_type>();
    endPtr = __infer_skip__get_nondet_val<value_type>();
    //} else {
    //  deallocate();
    //}
  }

  void deallocate() { beginPtr = nullptr; }

  template <class Iter>
  void allocate_iter(Iter begin, Iter end) {
    // very simplified implementation to avoid false positives
    allocate(1);
    // infer doesn't understand iterators well which leads to skip functions
    // they in effect lead to false positives in situations when empty vector
    // is impossible. Implemenatation should look like this:
    /*if (begin != end) {
      allocate(1);
    } else {
      deallocate();
    }*/
  }

  /* std::vector implementation */

  vector() noexcept(is_nothrow_default_constructible<allocator_type>::value) {
    deallocate();
  }

  explicit vector(const allocator_type& __a) noexcept { deallocate(); }

  explicit vector(size_type __n);
  // introduced in C++14
  explicit vector(size_type __n, const allocator_type& __a);
  vector(size_type __n, const_reference __x);
  vector(size_type __n, const_reference __x, const allocator_type& __a);
  template <class _ForwardIterator>
  vector(_ForwardIterator __first,
         typename enable_if<
             is_constructible<
                 value_type,
                 typename iterator_traits<_ForwardIterator>::reference>::value,
             _ForwardIterator>::type __last);
  template <class _ForwardIterator>
  vector(_ForwardIterator __first,
         _ForwardIterator __last,
         const allocator_type& __a,
         typename enable_if<is_constructible<
             value_type,
             typename iterator_traits<_ForwardIterator>::reference>::value>::
             type* = 0);

  vector(initializer_list<value_type> __il);

  vector(initializer_list<value_type> __il, const allocator_type& __a);

  vector(const vector& __x);
  vector(const vector& __x, const allocator_type& __a);

  vector& operator=(const vector& __x);

  vector(vector&& __x) noexcept;

  vector(vector&& __x, const allocator_type& __a);

  vector& operator=(vector&& __x) noexcept;
  /*((__noexcept_move_assign_container<_Allocator, __alloc_traits>::value)); */

  vector& operator=(initializer_list<value_type> __il) {
    assign(__il.begin(), __il.end());
    return *this;
  }

  template <class _ForwardIterator>
  typename enable_if<is_constructible<value_type,
                                      typename iterator_traits<
                                          _ForwardIterator>::reference>::value,
                     void>::type
  assign(_ForwardIterator __first, _ForwardIterator __last);

  void assign(size_type __n, const_reference __u);

  void assign(initializer_list<value_type> __il) {
    assign(__il.begin(), __il.end());
  }

  allocator_type get_allocator() const {}

  iterator begin() noexcept;
  const_iterator begin() const noexcept;
  iterator end() noexcept;
  const_iterator end() const noexcept;

  reverse_iterator rbegin() noexcept { return reverse_iterator(end()); }

  const_reverse_iterator rbegin() const noexcept {
    return const_reverse_iterator(end());
  }

  reverse_iterator rend() noexcept { return reverse_iterator(begin()); }

  const_reverse_iterator rend() const noexcept {
    return const_reverse_iterator(begin());
  }

  const_iterator cbegin() const noexcept { return begin(); }

  const_iterator cend() const noexcept { return end(); }

  const_reverse_iterator crbegin() const noexcept { return rbegin(); }

  const_reverse_iterator crend() const noexcept { return rend(); }

  size_type size() const noexcept {
    if (empty()) {
      return 0;
    }
    return 10;
  }

  size_type capacity() const noexcept {}

  bool empty() const noexcept {
    if (beginPtr == nullptr) {
      // prune branch where beginPtr is nullptr and endPtr isn't
      INFER_EXCLUDE_CONDITION(endPtr != nullptr);
      return true;
    }
    return false;
  }
  size_type max_size() const noexcept;
  void reserve(size_type __n);
  void shrink_to_fit() noexcept;

  reference operator[](size_type __n);
  const_reference operator[](size_type __n) const;
  reference at(size_type __n);
  const_reference at(size_type __n) const;

  reference front() { return (reference)*_get_begin(); }
  const_reference front() const { return (const_reference)*_get_begin(); }
  reference back() {
    size_t last_element = __infer_skip__get_int_val();
    return (reference)*_get_index(last_element);
  }
  const_reference back() const {
    size_t last_element = __infer_skip__get_int_val();
    return (const_reference)*_get_index(last_element);
  }

  value_type* data() noexcept { return _get_begin(); }

  const value_type* data() const noexcept { return _get_begin(); }

  void push_back(const_reference __x);
  void push_back(value_type&& __x);
  template <class... _Args>

  void emplace_back(_Args&&... __args);

  void pop_back();

  iterator insert(const_iterator __position, const_reference __x);
  iterator insert(const_iterator __position, value_type&& __x);
  template <class... _Args>
  iterator emplace(const_iterator __position, _Args&&... __args);
  iterator insert(const_iterator __position,
                  size_type __n,
                  const_reference __x);
  template <class _ForwardIterator>
  typename enable_if<is_constructible<value_type,
                                      typename iterator_traits<
                                          _ForwardIterator>::reference>::value,
                     iterator>::type
  insert(const_iterator __position,
         _ForwardIterator __first,
         _ForwardIterator __last);

  iterator insert(const_iterator __position,
                  initializer_list<value_type> __il) {
    return insert(__position, __il.begin(), __il.end());
  }

  iterator erase(const_iterator __position);
  iterator erase(const_iterator __first, const_iterator __last);

  void clear() noexcept { deallocate(); }

  void resize(size_type __sz);
  void resize(size_type __sz, const_reference __x);

  // NOTE c++17 adds noexcept
  void swap(vector&);

 private:
  iterator __make_iter(pointer __p) noexcept;

  const_iterator __make_iter(const_pointer __p) const noexcept;
};

template <class _Tp, class _Allocator>
typename vector<_Tp, _Allocator>::size_type vector<_Tp, _Allocator>::max_size()
    const noexcept {}

template <class _Tp, class _Allocator>
vector<_Tp, _Allocator>::vector(size_type __n) {
  allocate(__n);
}

template <class _Tp, class _Allocator>
vector<_Tp, _Allocator>::vector(size_type __n, const allocator_type& __a) {
  allocate(__n);
}

template <class _Tp, class _Allocator>
vector<_Tp, _Allocator>::vector(size_type __n, const_reference __x) {
  allocate(__n);
}

template <class _Tp, class _Allocator>
vector<_Tp, _Allocator>::vector(size_type __n,
                                const_reference __x,
                                const allocator_type& __a) {
  allocate(__n);
}

template <class _Tp, class _Allocator>
template <class _ForwardIterator>
vector<_Tp, _Allocator>::vector(
    _ForwardIterator __first,
    typename enable_if<
        is_constructible<
            value_type,
            typename iterator_traits<_ForwardIterator>::reference>::value,
        _ForwardIterator>::type __last) {
  allocate_iter(__first, __last);
}

template <class _Tp, class _Allocator>
template <class _ForwardIterator>
vector<_Tp, _Allocator>::vector(
    _ForwardIterator __first,
    _ForwardIterator __last,
    const allocator_type& __a,
    typename enable_if<is_constructible<
        value_type,
        typename iterator_traits<_ForwardIterator>::reference>::value>::type*) {
  allocate_iter(__first, __last);
}

template <class _Tp, class _Allocator>
vector<_Tp, _Allocator>::vector(const vector& __x) {
  beginPtr = __x.beginPtr;
}

template <class _Tp, class _Allocator>
vector<_Tp, _Allocator>::vector(const vector& __x, const allocator_type& __a) {
  beginPtr = __x.beginPtr;
}

template <class _Tp, class _Allocator>
inline vector<_Tp, _Allocator>::vector(vector&& __x) noexcept {
  beginPtr = __x.beginPtr;
  __x.beginPtr = nullptr;
}

template <class _Tp, class _Allocator>
inline vector<_Tp, _Allocator>::vector(vector&& __x,
                                       const allocator_type& __a) {
  beginPtr = __x.beginPtr;
  __x.beginPtr = nullptr;
}

template <class _Tp, class _Allocator>
inline vector<_Tp, _Allocator>::vector(initializer_list<value_type> __il) {
  allocate_iter(__il.begin(), __il.end());
}

template <class _Tp, class _Allocator>
inline vector<_Tp, _Allocator>::vector(initializer_list<value_type> __il,
                                       const allocator_type& __a) {
  allocate_iter(__il.begin(), __il.end());
}

template <class _Tp, class _Allocator>
inline vector<_Tp, _Allocator>& vector<_Tp, _Allocator>::operator=(
    vector&& __x) noexcept /*((__noexcept_move_assign_container<_Allocator,
                              __alloc_traits>::value)) */
{
  beginPtr = __x.beginPtr;
  __x.beginPtr = nullptr;
  return *this;
}

template <class _Tp, class _Allocator>
inline vector<_Tp, _Allocator>& vector<_Tp, _Allocator>::operator=(
    const vector& __x) {
  beginPtr = __x.beginPtr;
  return *this;
}

template <class _Tp, class _Allocator>
template <class _ForwardIterator>
typename enable_if<is_constructible<_Tp,
                                    typename iterator_traits<
                                        _ForwardIterator>::reference>::value,
                   void>::type
vector<_Tp, _Allocator>::assign(_ForwardIterator __first,
                                _ForwardIterator __last) {
  allocate_iter(__first, __last);
}

template <class _Tp, class _Allocator>
void vector<_Tp, _Allocator>::assign(size_type __n, const_reference __u) {
  allocate(__n);
}

template <class _Tp, class _Allocator>
inline typename vector<_Tp, _Allocator>::iterator
vector<_Tp, _Allocator>::__make_iter(pointer __p) noexcept {
  return iterator(__p);
}

template <class _Tp, class _Allocator>
inline typename vector<_Tp, _Allocator>::const_iterator
vector<_Tp, _Allocator>::__make_iter(const_pointer __p) const noexcept {
  return const_iterator(__p);
}

template <class _Tp, class _Allocator>
inline typename vector<_Tp, _Allocator>::iterator
vector<_Tp, _Allocator>::begin() noexcept {
  return __make_iter(beginPtr);
}

template <class _Tp, class _Allocator>
inline typename vector<_Tp, _Allocator>::const_iterator
vector<_Tp, _Allocator>::begin() const noexcept {
  return __make_iter(beginPtr);
}

template <class _Tp, class _Allocator>
inline typename vector<_Tp, _Allocator>::iterator
vector<_Tp, _Allocator>::end() noexcept {
  return __make_iter(endPtr);
}

template <class _Tp, class _Allocator>
inline typename vector<_Tp, _Allocator>::const_iterator
vector<_Tp, _Allocator>::end() const noexcept {
  return __make_iter(endPtr);
}

template <class _Tp, class _Allocator>
inline typename vector<_Tp, _Allocator>::reference vector<_Tp, _Allocator>::
operator[](size_type __n) {
  return (reference)*_get_index(__n);
}

template <class _Tp, class _Allocator>
inline typename vector<_Tp, _Allocator>::const_reference
    vector<_Tp, _Allocator>::operator[](size_type __n) const {
  return (const_reference)*_get_index(__n);
}

template <class _Tp, class _Allocator>
typename vector<_Tp, _Allocator>::reference vector<_Tp, _Allocator>::at(
    size_type __n) {
  return (reference)*_get_index(__n);
}

template <class _Tp, class _Allocator>
typename vector<_Tp, _Allocator>::const_reference vector<_Tp, _Allocator>::at(
    size_type __n) const {
  return (const_reference)*_get_index(__n);
}

template <class _Tp, class _Allocator>
void vector<_Tp, _Allocator>::reserve(size_type __n) {}

template <class _Tp, class _Allocator>
void vector<_Tp, _Allocator>::shrink_to_fit() noexcept {}

template <class _Tp, class _Allocator>
inline void vector<_Tp, _Allocator>::push_back(const_reference __x) {
  allocate(1);
}

template <class _Tp, class _Allocator>
inline void vector<_Tp, _Allocator>::push_back(value_type&& __x) {
  allocate(1);
}

template <class _Tp, class _Allocator>
template <class... _Args>
inline void vector<_Tp, _Allocator>::emplace_back(_Args&&... __args) {
  /* TODO - consider constructing the object
          __alloc_traits::construct(this->__alloc(),
                                    _VSTD::__to_raw_pointer(this->__end_),
                                    _VSTD::forward<_Args>(__args)...);
  */
  allocate(1);
}

template <class _Tp, class _Allocator>
inline void vector<_Tp, _Allocator>::pop_back() {
  // dereference the object
}

template <class _Tp, class _Allocator>
inline typename vector<_Tp, _Allocator>::iterator
vector<_Tp, _Allocator>::erase(const_iterator __position) {
  // dereference the object
  /* TODO return __r;*/
}

template <class _Tp, class _Allocator>
typename vector<_Tp, _Allocator>::iterator vector<_Tp, _Allocator>::erase(
    const_iterator __first, const_iterator __last) {
  // dereference the object
  /* TODO return __r;*/
}

template <class _Tp, class _Allocator>
typename vector<_Tp, _Allocator>::iterator vector<_Tp, _Allocator>::insert(
    const_iterator __position, const_reference __x) {}

template <class _Tp, class _Allocator>
typename vector<_Tp, _Allocator>::iterator vector<_Tp, _Allocator>::insert(
    const_iterator __position, value_type&& __x) {}

template <class _Tp, class _Allocator>
template <class... _Args>
typename vector<_Tp, _Allocator>::iterator vector<_Tp, _Allocator>::emplace(
    const_iterator __position, _Args&&... __args) {
  // TODO consider constructing the object
  allocate(1);
}

template <class _Tp, class _Allocator>
typename vector<_Tp, _Allocator>::iterator vector<_Tp, _Allocator>::insert(
    const_iterator __position, size_type __n, const_reference __x) {
  if (empty()) {
    allocate(__n);
  }
}

template <class _Tp, class _Allocator>
template <class _ForwardIterator>
typename enable_if<is_constructible<_Tp,
                                    typename iterator_traits<
                                        _ForwardIterator>::reference>::value,
                   typename vector<_Tp, _Allocator>::iterator>::type
vector<_Tp, _Allocator>::insert(const_iterator __position,
                                _ForwardIterator __first,
                                _ForwardIterator __last) {
  // TODO return __make_iter(__p);
}

template <class _Tp, class _Allocator>
void vector<_Tp, _Allocator>::resize(size_type __sz) {
  allocate(__sz);
}

template <class _Tp, class _Allocator>
void vector<_Tp, _Allocator>::resize(size_type __sz, const_reference __x) {
  allocate(__sz);
}

template <class _Tp, class _Allocator>
void vector<_Tp, _Allocator>::swap(vector& __x) {
  value_type* tmp = __x.beginPtr;
  __x.beginPtr = beginPtr;
  beginPtr = tmp;
}

template <class _Allocator>
struct hash<vector<bool, _Allocator>>
    : public unary_function<vector<bool, _Allocator>, size_t> {

  size_t operator()(const vector<bool, _Allocator>& __vec) const noexcept {}
};

template <class _Tp, class _Allocator>
inline bool operator==(const vector<_Tp, _Allocator>& __x,
                       const vector<_Tp, _Allocator>& __y) {
  const typename vector<_Tp, _Allocator>::size_type __sz = __x.size();
  return __sz == __y.size() && equal(__x.begin(), __x.end(), __y.begin());
}

template <class _Tp, class _Allocator>
inline bool operator!=(const vector<_Tp, _Allocator>& __x,
                       const vector<_Tp, _Allocator>& __y) {
  return !(__x == __y);
}

template <class _Tp, class _Allocator>
inline bool operator<(const vector<_Tp, _Allocator>& __x,
                      const vector<_Tp, _Allocator>& __y) {
  return lexicographical_compare(
      __x.begin(), __x.end(), __y.begin(), __y.end());
}

template <class _Tp, class _Allocator>
inline bool operator>(const vector<_Tp, _Allocator>& __x,
                      const vector<_Tp, _Allocator>& __y) {
  return __y < __x;
}

template <class _Tp, class _Allocator>
inline bool operator>=(const vector<_Tp, _Allocator>& __x,
                       const vector<_Tp, _Allocator>& __y) {
  return !(__x < __y);
}

template <class _Tp, class _Allocator>
inline bool operator<=(const vector<_Tp, _Allocator>& __x,
                       const vector<_Tp, _Allocator>& __y) {
  return !(__y < __x);
}

template <class _Tp, class _Allocator>
inline void swap(vector<_Tp, _Allocator>& __x, vector<_Tp, _Allocator>& __y) {
  __x.swap(__y);
}

INFER_NAMESPACE_STD_END