include/comphelper/stl_types.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #ifndef INCLUDED_COMPHELPER_STL_TYPES_HXX
  20 #define INCLUDED_COMPHELPER_STL_TYPES_HXX
  21
  22 #include <sal/config.h>
  23
  24 #include <algorithm>
  25 #include <memory>
  26 #include <string_view>
  27
  28 #include <rtl/ustring.hxx>
  29 #include <rtl/ustrbuf.hxx>
  30 #include <o3tl/string_view.hxx>
  31
  32 namespace com::sun::star::uno { template <typename > class Reference; }
  33
  34 namespace comphelper
  35 {
  36
  37 // comparison functors
  38
  39 struct UStringMixLess
  40 {
  41 private:
  42     bool m_bCaseSensitive;
  43 public:
  44     UStringMixLess(bool bCaseSensitive = true):m_bCaseSensitive(bCaseSensitive){}
  45     bool operator() (std::u16string_view x, std::u16string_view y) const
  46     {
  47         if (m_bCaseSensitive)
  48             return x < y;
  49         else
  50             return o3tl::compareToIgnoreAsciiCase(x, y) < 0;
  51     }
  52
  53     bool isCaseSensitive() const {return m_bCaseSensitive;}
  54 };
  55
  56 class UStringMixEqual
  57 {
  58     bool const m_bCaseSensitive;
  59
  60 public:
  61     UStringMixEqual(bool bCaseSensitive = true):m_bCaseSensitive(bCaseSensitive){}
  62     bool operator() (std::u16string_view lhs, std::u16string_view rhs) const
  63     {
  64         return m_bCaseSensitive ? lhs == rhs : o3tl::equalsIgnoreAsciiCase( lhs, rhs );
  65     }
  66     bool isCaseSensitive() const {return m_bCaseSensitive;}
  67 };
  68
  69 /// by-value less functor for std::set<std::unique_ptr<T>>
  70 template<class T> struct UniquePtrValueLess
  71 {
  72         bool operator()(std::unique_ptr<T> const& lhs,
  73                         std::unique_ptr<T> const& rhs) const
  74         {
  75             assert(lhs.get());
  76             assert(rhs.get());
  77             return (*lhs) < (*rhs);
  78         }
  79         // The following are so we can search in std::set without allocating a temporary entry on the heap
  80         typedef bool is_transparent;
  81         bool operator()(T const& lhs,
  82                         std::unique_ptr<T> const& rhs) const
  83         {
  84             assert(rhs.get());
  85             return lhs < (*rhs);
  86         }
  87         bool operator()(std::unique_ptr<T> const& lhs,
  88                         T const& rhs) const
  89         {
  90             assert(lhs.get());
  91             return (*lhs) < rhs;
  92         }
  93 };
  94
  95 /// by-value implementation of std::foo<std::unique_ptr<T>>::operator==
  96 template<template<typename, typename...> class C, typename T, typename... Etc>
  97 bool ContainerUniquePtrEquals(
  98         C<std::unique_ptr<T>, Etc...> const& lhs,
  99         C<std::unique_ptr<T>, Etc...> const& rhs)
 100 {
 101     return lhs.size() == rhs.size()
 102            && std::equal(lhs.begin(), lhs.end(), rhs.begin(),
 103                          [](const auto& p1, const auto& p2) { return *p1 == *p2; });
 104 };
 105
 106
 107 template <class Tp, class Arg>
 108 class mem_fun1_t
 109 {
 110     typedef void (Tp::*_fun_type)(Arg);
 111 public:
 112     explicit mem_fun1_t(_fun_type pf) : M_f(pf) {}
 113     void operator()(Tp* p, Arg x) const { (p->*M_f)(x); }
 114 private:
 115     _fun_type const M_f;
 116 };
 117
 118 template <class Tp, class Arg>
 119 inline mem_fun1_t<Tp,Arg> mem_fun(void (Tp::*f)(Arg))
 120 {
 121     return mem_fun1_t<Tp,Arg>(f);
 122 }
 123
 124 /** output iterator that appends OUStrings into an OUStringBuffer.
 125  */
 126 class OUStringBufferAppender
 127 {
 128 public:
 129     typedef OUStringBufferAppender Self;
 130     typedef ::std::output_iterator_tag iterator_category;
 131     typedef void value_type;
 132     typedef void reference;
 133     typedef void pointer;
 134     typedef size_t difference_type;
 135
 136     OUStringBufferAppender(OUStringBuffer & i_rBuffer)
 137         : m_rBuffer(&i_rBuffer) { }
 138     Self & operator=(std::u16string_view i_rStr)
 139     {
 140         m_rBuffer->append( i_rStr );
 141         return *this;
 142     }
 143     Self & operator*() { return *this; } // so operator= works
 144     Self & operator++() { return *this; }
 145
 146 private:
 147     OUStringBuffer * m_rBuffer;
 148 };
 149
 150 /** algorithm similar to std::copy, but inserts a separator between elements.
 151  */
 152 template< typename ForwardIter, typename OutputIter, typename T >
 153 OutputIter intersperse(
 154     ForwardIter start, ForwardIter end, OutputIter out, T const & separator)
 155 {
 156     if (start != end) {
 157         *out = *start;
 158         ++start;
 159         ++out;
 160     }
 161
 162     while (start != end) {
 163         *out = separator;
 164         ++out;
 165         *out = *start;
 166         ++start;
 167         ++out;
 168     }
 169
 170     return out;
 171 }
 172
 173 }
 174
 175 #endif // INCLUDED_COMPHELPER_STL_TYPES_HXX
 176
 177 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */