//===-- STLUtils.h ----------------------------------------------*- C++ -*-===//
//
//                     The LLVM Compiler Infrastructure
//
// This file is distributed under the University of Illinois Open Source
// License. See LICENSE.TXT for details.
//
//===----------------------------------------------------------------------===//

#ifndef liblldb_STLUtils_h_
#define liblldb_STLUtils_h_

// C Includes
#include <string.h>

// C++ Includes
#include <map>
#include <ostream>
#include <vector>

// Other libraries and framework includes
// Project includes

//----------------------------------------------------------------------
// C string less than compare function object
//----------------------------------------------------------------------
struct CStringCompareFunctionObject
{
    bool operator() (const char* s1, const char* s2) const
    {
        return strcmp(s1, s2) < 0;
    }
};

//----------------------------------------------------------------------
// C string equality function object (binary predicate).
//----------------------------------------------------------------------
struct CStringEqualBinaryPredicate
{
    bool operator()(const char* s1, const char* s2) const
    {
        return strcmp(s1, s2) == 0;
    }
};

//----------------------------------------------------------------------
// Templated type for finding an entry in a std::map<F,S> whose value
// is equal to something
//----------------------------------------------------------------------
template <class F, class S>
class ValueEquals
{
public:
    ValueEquals (const S& val) : second_value(val)
    {}

    // Compare the second item
    bool operator() (std::pair<const F, S> elem)
    {
        return elem.second == second_value;
    }

private:
    S second_value;
};

template <class T>
inline void
PrintAllCollectionElements(std::ostream &s,
                           const T& coll,
                           const char* header_cstr = nullptr,
                           const char* separator_cstr = " ")
{
    typename T::const_iterator pos;

    if (header_cstr)
        s << header_cstr;
    for (pos=coll.begin(); pos!=coll.end(); ++pos) {
        s << *pos << separator_cstr;
    }
    s << std::endl;
}

// The function object below can be used to delete a STL container that
// contains C++ object pointers.
//
// Usage: std::for_each(vector.begin(), vector.end(), for_each_delete());

struct for_each_cplusplus_delete
{
   template <typename T>
   void operator()(T *ptr){ delete ptr;}
};

typedef std::vector<std::string> STLStringArray;
typedef std::vector<const char *> CStringArray;

#endif // liblldb_STLUtils_h_