summaryrefslogtreecommitdiffstats
path: root/sw/inc/ToxWhitespaceStripper.hxx
blob: 9decbc020bf465c66d1ab5d9d541c26b78048ae8 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 */

#ifndef TOXWHITESPACESTRIPPER_HXX_
#define TOXWHITESPACESTRIPPER_HXX_

#include <rtl/ustring.hxx>
#include <vector>

namespace sw
{
/** This class helps to remove unwanted whitespaces from a string to use in a Tox.
 *
 * The new string will have
 * - Newlines changed to spaces
 * - Consecutive spaces merged
 * - Trailing spaces removed
 *
 * It also allows to find the corresponding new positions of the input string in the stripped string.
 * This is important for attributes which might have to be imported, e.g., it helps to answer the question:
 * The 3rd character of the input string is subscript, which character in the output string is that?
 *
 * @note One leading whitespace is preserved.
 */
class ToxWhitespaceStripper
{
public:
    ToxWhitespaceStripper(const OUString&);

    sal_Int32 GetPositionInStrippedString(sal_Int32 pos) const;

    const OUString& GetStrippedString() const { return mStripped; }

private:
    OUString mStripped;
    std::vector<sal_Int32> mNewPositions;
};

} // end namespace sw

#endif /* TOXWHITESPACESTRIPPER_HXX_ */