svf-lib 1.0.1291 → 1.0.1293

package/SVF-linux/include/Util/iterator.h

@@ -0,0 +1,407 @@
+//===- iterator.h - Utilities for using and defining iterators --*- C++ -*-===//
+//
+// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
+// See https://llvm.org/LICENSE.txt for license information.
+// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+//
+//===----------------------------------------------------------------------===//
+
+#ifndef LLVM_ADT_ITERATOR_H
+#define LLVM_ADT_ITERATOR_H
+
+#include "Util/iterator_range.h"
+#include <cstddef>
+#include <iterator>
+#include <type_traits>
+#include <utility>
+
+namespace llvm
+{
+
+/// CRTP base class which implements the entire standard iterator facade
+/// in terms of a minimal subset of the interface.
+///
+/// Use this when it is reasonable to implement most of the iterator
+/// functionality in terms of a core subset. If you need special behavior or
+/// there are performance implications for this, you may want to override the
+/// relevant members instead.
+///
+/// Note, one abstraction that this does *not* provide is implementing
+/// subtraction in terms of addition by negating the difference. Negation isn't
+/// always information preserving, and I can see very reasonable iterator
+/// designs where this doesn't work well. It doesn't really force much added
+/// boilerplate anyways.
+///
+/// Another abstraction that this doesn't provide is implementing increment in
+/// terms of addition of one. These aren't equivalent for all iterator
+/// categories, and respecting that adds a lot of complexity for little gain.
+///
+/// Classes wishing to use `iterator_facade_base` should implement the following
+/// methods:
+///
+/// Forward Iterators:
+///   (All of the following methods)
+///   - DerivedT &operator=(const DerivedT &R);
+///   - bool operator==(const DerivedT &R) const;
+///   - const T &operator*() const;
+///   - T &operator*();
+///   - DerivedT &operator++();
+///
+/// Bidirectional Iterators:
+///   (All methods of forward iterators, plus the following)
+///   - DerivedT &operator--();
+///
+/// Random-access Iterators:
+///   (All methods of bidirectional iterators excluding the following)
+///   - DerivedT &operator++();
+///   - DerivedT &operator--();
+///   (and plus the following)
+///   - bool operator<(const DerivedT &RHS) const;
+///   - DifferenceTypeT operator-(const DerivedT &R) const;
+///   - DerivedT &operator+=(DifferenceTypeT N);
+///   - DerivedT &operator-=(DifferenceTypeT N);
+///
+template <typename DerivedT, typename IteratorCategoryT, typename T,
+          typename DifferenceTypeT = std::ptrdiff_t, typename PointerT = T *,
+          typename ReferenceT = T &>
+class iterator_facade_base
+{
+public:
+    using iterator_category = IteratorCategoryT;
+    using value_type = T;
+    using difference_type = DifferenceTypeT;
+    using pointer = PointerT;
+    using reference = ReferenceT;
+
+protected:
+    enum
+    {
+        IsRandomAccess = std::is_base_of<std::random_access_iterator_tag,
+        IteratorCategoryT>::value,
+        IsBidirectional = std::is_base_of<std::bidirectional_iterator_tag,
+        IteratorCategoryT>::value,
+    };
+
+    /// A proxy object for computing a reference via indirecting a copy of an
+    /// iterator. This is used in APIs which need to produce a reference via
+    /// indirection but for which the iterator object might be a temporary. The
+    /// proxy preserves the iterator internally and exposes the indirected
+    /// reference via a conversion operator.
+    class ReferenceProxy
+    {
+        friend iterator_facade_base;
+
+        DerivedT I;
+
+        ReferenceProxy(DerivedT I) : I(std::move(I)) {}
+
+    public:
+        operator ReferenceT() const
+        {
+            return *I;
+        }
+    };
+
+public:
+    DerivedT operator+(DifferenceTypeT n) const
+    {
+        static_assert(std::is_base_of<iterator_facade_base, DerivedT>::value,
+                      "Must pass the derived type to this template!");
+        static_assert(
+            IsRandomAccess,
+            "The '+' operator is only defined for random access iterators.");
+        DerivedT tmp = *static_cast<const DerivedT *>(this);
+        tmp += n;
+        return tmp;
+    }
+    friend DerivedT operator+(DifferenceTypeT n, const DerivedT &i)
+    {
+        static_assert(
+            IsRandomAccess,
+            "The '+' operator is only defined for random access iterators.");
+        return i + n;
+    }
+    DerivedT operator-(DifferenceTypeT n) const
+    {
+        static_assert(
+            IsRandomAccess,
+            "The '-' operator is only defined for random access iterators.");
+        DerivedT tmp = *static_cast<const DerivedT *>(this);
+        tmp -= n;
+        return tmp;
+    }
+
+    DerivedT &operator++()
+    {
+        static_assert(std::is_base_of<iterator_facade_base, DerivedT>::value,
+                      "Must pass the derived type to this template!");
+        return static_cast<DerivedT *>(this)->operator+=(1);
+    }
+    DerivedT operator++(int)
+    {
+        DerivedT tmp = *static_cast<DerivedT *>(this);
+        ++*static_cast<DerivedT *>(this);
+        return tmp;
+    }
+    DerivedT &operator--()
+    {
+        static_assert(
+            IsBidirectional,
+            "The decrement operator is only defined for bidirectional iterators.");
+        return static_cast<DerivedT *>(this)->operator-=(1);
+    }
+    DerivedT operator--(int)
+    {
+        static_assert(
+            IsBidirectional,
+            "The decrement operator is only defined for bidirectional iterators.");
+        DerivedT tmp = *static_cast<DerivedT *>(this);
+        --*static_cast<DerivedT *>(this);
+        return tmp;
+    }
+
+#ifndef __cpp_impl_three_way_comparison
+    bool operator!=(const DerivedT &RHS) const
+    {
+        return !(static_cast<const DerivedT &>(*this) == RHS);
+    }
+#endif
+
+    bool operator>(const DerivedT &RHS) const
+    {
+        static_assert(
+            IsRandomAccess,
+            "Relational operators are only defined for random access iterators.");
+        return !(static_cast<const DerivedT &>(*this) < RHS) &&
+               !(static_cast<const DerivedT &>(*this) == RHS);
+    }
+    bool operator<=(const DerivedT &RHS) const
+    {
+        static_assert(
+            IsRandomAccess,
+            "Relational operators are only defined for random access iterators.");
+        return !(static_cast<const DerivedT &>(*this) > RHS);
+    }
+    bool operator>=(const DerivedT &RHS) const
+    {
+        static_assert(
+            IsRandomAccess,
+            "Relational operators are only defined for random access iterators.");
+        return !(static_cast<const DerivedT &>(*this) < RHS);
+    }
+
+    PointerT operator->()
+    {
+        return &static_cast<DerivedT *>(this)->operator*();
+    }
+    PointerT operator->() const
+    {
+        return &static_cast<const DerivedT *>(this)->operator*();
+    }
+    ReferenceProxy operator[](DifferenceTypeT n)
+    {
+        static_assert(IsRandomAccess,
+                      "Subscripting is only defined for random access iterators.");
+        return ReferenceProxy(static_cast<DerivedT *>(this)->operator+(n));
+    }
+    ReferenceProxy operator[](DifferenceTypeT n) const
+    {
+        static_assert(IsRandomAccess,
+                      "Subscripting is only defined for random access iterators.");
+        return ReferenceProxy(static_cast<const DerivedT *>(this)->operator+(n));
+    }
+};
+
+/// CRTP base class for adapting an iterator to a different type.
+///
+/// This class can be used through CRTP to adapt one iterator into another.
+/// Typically this is done through providing in the derived class a custom \c
+/// operator* implementation. Other methods can be overridden as well.
+template <
+    typename DerivedT, typename WrappedIteratorT,
+    typename IteratorCategoryT =
+    typename std::iterator_traits<WrappedIteratorT>::iterator_category,
+    typename T = typename std::iterator_traits<WrappedIteratorT>::value_type,
+    typename DifferenceTypeT =
+    typename std::iterator_traits<WrappedIteratorT>::difference_type,
+    typename PointerT = std::conditional_t<
+        std::is_same<T, typename std::iterator_traits<
+                         WrappedIteratorT>::value_type>::value,
+        typename std::iterator_traits<WrappedIteratorT>::pointer, T *>,
+    typename ReferenceT = std::conditional_t<
+        std::is_same<T, typename std::iterator_traits<
+                         WrappedIteratorT>::value_type>::value,
+        typename std::iterator_traits<WrappedIteratorT>::reference, T &>>
+class iterator_adaptor_base
+    : public iterator_facade_base<DerivedT, IteratorCategoryT, T,
+      DifferenceTypeT, PointerT, ReferenceT>
+{
+    using BaseT = typename iterator_adaptor_base::iterator_facade_base;
+
+protected:
+    WrappedIteratorT I;
+
+    iterator_adaptor_base() = default;
+
+    explicit iterator_adaptor_base(WrappedIteratorT u) : I(std::move(u))
+    {
+        static_assert(std::is_base_of<iterator_adaptor_base, DerivedT>::value,
+                      "Must pass the derived type to this template!");
+    }
+
+    const WrappedIteratorT &wrapped() const
+    {
+        return I;
+    }
+
+public:
+    using difference_type = DifferenceTypeT;
+
+    DerivedT &operator+=(difference_type n)
+    {
+        static_assert(
+            BaseT::IsRandomAccess,
+            "The '+=' operator is only defined for random access iterators.");
+        I += n;
+        return *static_cast<DerivedT *>(this);
+    }
+    DerivedT &operator-=(difference_type n)
+    {
+        static_assert(
+            BaseT::IsRandomAccess,
+            "The '-=' operator is only defined for random access iterators.");
+        I -= n;
+        return *static_cast<DerivedT *>(this);
+    }
+    using BaseT::operator-;
+    difference_type operator-(const DerivedT &RHS) const
+    {
+        static_assert(
+            BaseT::IsRandomAccess,
+            "The '-' operator is only defined for random access iterators.");
+        return I - RHS.I;
+    }
+
+    // We have to explicitly provide ++ and -- rather than letting the facade
+    // forward to += because WrappedIteratorT might not support +=.
+    using BaseT::operator++;
+    DerivedT &operator++()
+    {
+        ++I;
+        return *static_cast<DerivedT *>(this);
+    }
+    using BaseT::operator--;
+    DerivedT &operator--()
+    {
+        static_assert(
+            BaseT::IsBidirectional,
+            "The decrement operator is only defined for bidirectional iterators.");
+        --I;
+        return *static_cast<DerivedT *>(this);
+    }
+
+    friend bool operator==(const iterator_adaptor_base &LHS,
+                           const iterator_adaptor_base &RHS)
+    {
+        return LHS.I == RHS.I;
+    }
+    friend bool operator<(const iterator_adaptor_base &LHS,
+                          const iterator_adaptor_base &RHS)
+    {
+        static_assert(
+            BaseT::IsRandomAccess,
+            "Relational operators are only defined for random access iterators.");
+        return LHS.I < RHS.I;
+    }
+
+    ReferenceT operator*() const
+    {
+        return *I;
+    }
+};
+
+/// An iterator type that allows iterating over the pointees via some
+/// other iterator.
+///
+/// The typical usage of this is to expose a type that iterates over Ts, but
+/// which is implemented with some iterator over T*s:
+///
+/// \code
+///   using iterator = pointee_iterator<SmallVectorImpl<T *>::iterator>;
+/// \endcode
+template <typename WrappedIteratorT,
+          typename T = std::remove_reference_t<decltype(
+                      **std::declval<WrappedIteratorT>())>>
+struct pointee_iterator
+    : iterator_adaptor_base<
+      pointee_iterator<WrappedIteratorT, T>, WrappedIteratorT,
+      typename std::iterator_traits<WrappedIteratorT>::iterator_category,
+      T>
+{
+    pointee_iterator() = default;
+    template <typename U>
+    pointee_iterator(U &&u)
+        : pointee_iterator::iterator_adaptor_base(std::forward<U &&>(u)) {}
+
+    T &operator*() const
+    {
+        return **this->I;
+    }
+};
+
+template <typename RangeT, typename WrappedIteratorT =
+          decltype(std::begin(std::declval<RangeT>()))>
+iterator_range<pointee_iterator<WrappedIteratorT>>
+        make_pointee_range(RangeT &&Range)
+{
+    using PointeeIteratorT = pointee_iterator<WrappedIteratorT>;
+    return make_range(PointeeIteratorT(std::begin(std::forward<RangeT>(Range))),
+                      PointeeIteratorT(std::end(std::forward<RangeT>(Range))));
+}
+
+template <typename WrappedIteratorT,
+          typename T = decltype(&*std::declval<WrappedIteratorT>())>
+class pointer_iterator
+    : public iterator_adaptor_base<
+      pointer_iterator<WrappedIteratorT, T>, WrappedIteratorT,
+      typename std::iterator_traits<WrappedIteratorT>::iterator_category,
+      T>
+{
+    mutable T Ptr;
+
+public:
+    pointer_iterator() = default;
+
+    explicit pointer_iterator(WrappedIteratorT u)
+        : pointer_iterator::iterator_adaptor_base(std::move(u)) {}
+
+    T &operator*()
+    {
+        return Ptr = &*this->I;
+    }
+    const T &operator*() const
+    {
+        return Ptr = &*this->I;
+    }
+};
+
+template <typename RangeT, typename WrappedIteratorT =
+          decltype(std::begin(std::declval<RangeT>()))>
+iterator_range<pointer_iterator<WrappedIteratorT>>
+        make_pointer_range(RangeT &&Range)
+{
+    using PointerIteratorT = pointer_iterator<WrappedIteratorT>;
+    return make_range(PointerIteratorT(std::begin(std::forward<RangeT>(Range))),
+                      PointerIteratorT(std::end(std::forward<RangeT>(Range))));
+}
+
+template <typename WrappedIteratorT,
+          typename T1 = std::remove_reference_t<decltype(
+                      **std::declval<WrappedIteratorT>())>,
+          typename T2 = std::add_pointer_t<T1>>
+using raw_pointer_iterator =
+    pointer_iterator<pointee_iterator<WrappedIteratorT, T1>, T2>;
+
+} // end namespace llvm
+
+#endif // LLVM_ADT_ITERATOR_H

package/SVF-linux/include/Util/iterator_range.h

@@ -0,0 +1,76 @@
+//===- iterator_range.h - A range adaptor for iterators ---------*- C++ -*-===//
+//
+// From the LLVM Project with some modifications, under the Apache License v2.0
+// with LLVM Exceptions. See https://llvm.org/LICENSE.txt for license information.
+// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+//
+//===----------------------------------------------------------------------===//
+/// \file
+/// This provides a very simple, boring adaptor for a begin and end iterator
+/// into a range type. This should be used to build range views that work well
+/// with range based for loops and range based constructors.
+///
+/// Note that code here follows more standards-based coding conventions as it
+/// is mirroring proposed interfaces for standardization.
+///
+//===----------------------------------------------------------------------===//
+
+#ifndef LLVM_ADT_ITERATOR_RANGE_H
+#define LLVM_ADT_ITERATOR_RANGE_H
+
+#include <utility>
+
+namespace llvm
+{
+
+/// A range adaptor for a pair of iterators.
+///
+/// This just wraps two iterators into a range-compatible interface. Nothing
+/// fancy at all.
+template <typename IteratorT>
+class iterator_range
+{
+    IteratorT begin_iterator, end_iterator;
+
+public:
+    //TODO: Add SFINAE to test that the Container's iterators match the range's
+    //      iterators.
+    template <typename Container>
+    iterator_range(Container &&c)
+    //TODO: Consider ADL/non-member begin/end calls.
+        : begin_iterator(c.begin()), end_iterator(c.end()) {}
+    iterator_range(IteratorT begin_iterator, IteratorT end_iterator)
+        : begin_iterator(std::move(begin_iterator)),
+          end_iterator(std::move(end_iterator)) {}
+
+    IteratorT begin() const
+    {
+        return begin_iterator;
+    }
+    IteratorT end() const
+    {
+        return end_iterator;
+    }
+    bool empty() const
+    {
+        return begin_iterator == end_iterator;
+    }
+};
+
+/// Convenience function for iterating over sub-ranges.
+///
+/// This provides a bit of syntactic sugar to make using sub-ranges
+/// in for loops a bit easier. Analogous to std::make_pair().
+template <class T> iterator_range<T> make_range(T x, T y)
+{
+    return iterator_range<T>(std::move(x), std::move(y));
+}
+
+template <typename T> iterator_range<T> make_range(std::pair<T, T> p)
+{
+    return iterator_range<T>(std::move(p.first), std::move(p.second));
+}
+
+}
+
+#endif

package/SVF-osx/include/Graphs/DOTGraphTraits.h

@@ -0,0 +1,188 @@
+//===-- Graphs/DOTGraphTraits.h - Customize .dot output ---*- C++ -*-===//
+//
+// From the LLVM Project with some modifications, under the Apache License v2.0
+// with LLVM Exceptions. See https://llvm.org/LICENSE.txt for license information.
+// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+//
+//===----------------------------------------------------------------------===//
+//
+// This file defines a template class that can be used to customize dot output
+// graphs generated by the GraphWriter.h file.  The default implementation of
+// this file will produce a simple, but not very polished graph.  By
+// specializing this template, lots of customization opportunities are possible.
+//
+//===----------------------------------------------------------------------===//
+
+#ifndef LLVM_SUPPORT_DOTGRAPHTRAITS_H
+#define LLVM_SUPPORT_DOTGRAPHTRAITS_H
+
+#include <string>
+
+namespace llvm
+{
+
+/// DefaultDOTGraphTraits - This class provides the default implementations of
+/// all of the DOTGraphTraits methods.  If a specialization does not need to
+/// override all methods here it should inherit so that it can get the default
+/// implementations.
+///
+struct DefaultDOTGraphTraits
+{
+private:
+    bool IsSimple;
+
+protected:
+    bool isSimple()
+    {
+        return IsSimple;
+    }
+
+public:
+    explicit DefaultDOTGraphTraits(bool simple=false) : IsSimple (simple) {}
+
+    /// getGraphName - Return the label for the graph as a whole.  Printed at the
+    /// top of the graph.
+    ///
+    template<typename GraphType>
+    static std::string getGraphName(const GraphType &)
+    {
+        return "";
+    }
+
+    /// getGraphProperties - Return any custom properties that should be included
+    /// in the top level graph structure for dot.
+    ///
+    template<typename GraphType>
+    static std::string getGraphProperties(const GraphType &)
+    {
+        return "";
+    }
+
+    /// renderGraphFromBottomUp - If this function returns true, the graph is
+    /// emitted bottom-up instead of top-down.  This requires graphviz 2.0 to work
+    /// though.
+    static bool renderGraphFromBottomUp()
+    {
+        return false;
+    }
+
+    /// isNodeHidden - If the function returns true, the given node is not
+    /// displayed in the graph.
+    template <typename GraphType>
+    static bool isNodeHidden(const void *, const GraphType &)
+    {
+        return false;
+    }
+
+    /// getNodeLabel - Given a node and a pointer to the top level graph, return
+    /// the label to print in the node.
+    template<typename GraphType>
+    std::string getNodeLabel(const void *, const GraphType &)
+    {
+        return "";
+    }
+
+    // getNodeIdentifierLabel - Returns a string representing the
+    // address or other unique identifier of the node. (Only used if
+    // non-empty.)
+    template <typename GraphType>
+    static std::string getNodeIdentifierLabel(const void *, const GraphType &)
+    {
+        return "";
+    }
+
+    template<typename GraphType>
+    static std::string getNodeDescription(const void *, const GraphType &)
+    {
+        return "";
+    }
+
+    /// If you want to specify custom node attributes, this is the place to do so
+    ///
+    template<typename GraphType>
+    static std::string getNodeAttributes(const void *,
+                                         const GraphType &)
+    {
+        return "";
+    }
+
+    /// If you want to override the dot attributes printed for a particular edge,
+    /// override this method.
+    template<typename EdgeIter, typename GraphType>
+    static std::string getEdgeAttributes(const void *, EdgeIter,
+                                         const GraphType &)
+    {
+        return "";
+    }
+
+    /// getEdgeSourceLabel - If you want to label the edge source itself,
+    /// implement this method.
+    template<typename EdgeIter>
+    static std::string getEdgeSourceLabel(const void *, EdgeIter)
+    {
+        return "";
+    }
+
+    /// edgeTargetsEdgeSource - This method returns true if this outgoing edge
+    /// should actually target another edge source, not a node.  If this method is
+    /// implemented, getEdgeTarget should be implemented.
+    template<typename EdgeIter>
+    static bool edgeTargetsEdgeSource(const void *, EdgeIter)
+    {
+        return false;
+    }
+
+    /// getEdgeTarget - If edgeTargetsEdgeSource returns true, this method is
+    /// called to determine which outgoing edge of Node is the target of this
+    /// edge.
+    template<typename EdgeIter>
+    static EdgeIter getEdgeTarget(const void *, EdgeIter I)
+    {
+        return I;
+    }
+
+    /// hasEdgeDestLabels - If this function returns true, the graph is able
+    /// to provide labels for edge destinations.
+    static bool hasEdgeDestLabels()
+    {
+        return false;
+    }
+
+    /// numEdgeDestLabels - If hasEdgeDestLabels, this function returns the
+    /// number of incoming edge labels the given node has.
+    static unsigned numEdgeDestLabels(const void *)
+    {
+        return 0;
+    }
+
+    /// getEdgeDestLabel - If hasEdgeDestLabels, this function returns the
+    /// incoming edge label with the given index in the given node.
+    static std::string getEdgeDestLabel(const void *, unsigned)
+    {
+        return "";
+    }
+
+    /// addCustomGraphFeatures - If a graph is made up of more than just
+    /// straight-forward nodes and edges, this is the place to put all of the
+    /// custom stuff necessary.  The GraphWriter object, instantiated with your
+    /// GraphType is passed in as an argument.  You may call arbitrary methods on
+    /// it to add things to the output graph.
+    ///
+    template<typename GraphType, typename GraphWriter>
+    static void addCustomGraphFeatures(const GraphType &, GraphWriter &) {}
+};
+
+
+/// DOTGraphTraits - Template class that can be specialized to customize how
+/// graphs are converted to 'dot' graphs.  When specializing, you may inherit
+/// from DefaultDOTGraphTraits if you don't need to override everything.
+///
+template <typename Ty>
+struct DOTGraphTraits : public DefaultDOTGraphTraits
+{
+    DOTGraphTraits (bool simple=false) : DefaultDOTGraphTraits (simple) {}
+};
+
+} // End llvm namespace
+
+#endif