Branch data Line data Source code
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 : :
20 : : #ifndef _COMPHELPER_STLUNOITERATOR_HXX
21 : : #define _COMPHELPER_STLUNOITERATOR_HXX
22 : :
23 : : #include <com/sun/star/uno/Sequence.hxx>
24 : : #include <sal/types.h>
25 : :
26 : :
27 : : namespace comphelper
28 : : {
29 : : /**
30 : : @short stl-container-like access to an existing ::com::sun::star::uno::Sequence
31 : : @descr These template functions allows using an existing
32 : : ::com::sun::star::uno::Sequence using stl algorithms. They provides
33 : : standard-compliant mutable random access iterators. Because random access
34 : : iterators are the most generic iterators defined by the stl, any stl algorithm
35 : : can be applied to the Sequence (excluding algorithms requiring output
36 : : iterators).
37 : : <p>
38 : : Example: (creating a ::std::list from a ::com::sun::star::uno::Sequence)
39 : : <code>
40 : : ::com::sun::star::uno::Sequence<sal_Int32> aSeq(10);
41 : : ::std::list stl_list(stl_begin(aSeq), stl_end(aSeq));
42 : : </code>
43 : : <p>
44 : : Example: (sorting ::com::sun::star::uno::Sequence inplace)
45 : : <code>
46 : : ::com::sun::star::uno::Sequence<sal_Int32> aSeq(10);
47 : : ::std::sort(stl_begin(aSeq), stl_seq.end(aSeq));
48 : : </code>
49 : : <p>
50 : : Example: (counting occurrences of 4711 in a ::com::sun::star::uno::Sequence)
51 : : <code>
52 : : ::com::sun::star::uno::Sequence<sal_Int32> aSeq(10);
53 : : sal_Int32 count = 0;
54 : : ::std::count(stl_begin(aSeq), stl_end(aSeq), 4711, count);
55 : : </code>
56 : : <p>
57 : :
58 : : @see http://www.sgi.com/tech/stl/Container.html
59 : : @see http://www.sgi.com/tech/stl/Sequence.html
60 : : @see http://www.sgi.com/tech/stl/RandomAccessIterator.html
61 : : */
62 : :
63 : : template <typename V>
64 : 72 : V* stl_begin(::com::sun::star::uno::Sequence<V>& rSeq)
65 : 72 : { return rSeq.getArray(); }
66 : :
67 : : template <typename V>
68 : 0 : V* stl_end(::com::sun::star::uno::Sequence<V>& rSeq)
69 : 0 : { return rSeq.getArray() + rSeq.getLength(); }
70 : :
71 : : template <typename V>
72 : 733 : const V* stl_begin(const ::com::sun::star::uno::Sequence<V>& rSeq)
73 : 733 : { return rSeq.getConstArray(); }
74 : :
75 : : template <typename V>
76 : 1179 : const V* stl_end(const ::com::sun::star::uno::Sequence<V>& rSeq)
77 : 1179 : { return rSeq.getConstArray() + rSeq.getLength(); }
78 : : }
79 : : #endif
80 : :
81 : : /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
