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 SC_STRINGUTIL_HXX
21 : #define SC_STRINGUTIL_HXX
22 :
23 : #include "rtl/ustring.hxx"
24 : #include "tools/string.hxx"
25 : #include "scdllapi.h"
26 : #include "i18nlangtag/lang.h"
27 :
28 : class SvNumberFormatter;
29 :
30 : /**
31 : * Store parameters used in the ScDocument::SetString() method. Various
32 : * options for string-setting operation are specified herein.
33 : */
34 : struct SC_DLLPUBLIC ScSetStringParam
35 : {
36 : enum TextFormatPolicy
37 : {
38 : /**
39 : * Set Text number format no matter what the input string is.
40 : */
41 : Always,
42 :
43 : /**
44 : * Set Text number format only when the input string is considered a
45 : * special number but we only want to detect a simple number.
46 : */
47 : SpecialNumberOnly,
48 :
49 : /**
50 : * Never set Text number format.
51 : */
52 : Never
53 : };
54 :
55 : /**
56 : * Stores the pointer to the number formatter instance to be used during
57 : * number format detection. The caller must manage the life cycle of the
58 : * instance.
59 : */
60 : SvNumberFormatter* mpNumFormatter;
61 :
62 : /**
63 : * When true, we try to detect special number format (dates etc) from the
64 : * input string, when false, we only try to detect a basic decimal number
65 : * format.
66 : */
67 : bool mbDetectNumberFormat;
68 :
69 : /**
70 : * Determine when to set the 'Text' number format to the cell where the
71 : * input string is being set.
72 : */
73 : TextFormatPolicy meSetTextNumFormat;
74 :
75 : /**
76 : * When true, treat input with a leading apostrophe as an escape character
77 : * for a numeric value content, to treat the numeric value as a text. When
78 : * false, the whole string input including the leading apostrophe will be
79 : * entered literally as string.
80 : */
81 : bool mbHandleApostrophe;
82 :
83 : ScSetStringParam();
84 :
85 : /**
86 : * Call this whenever you need to unconditionally set input as text, no
87 : * matter what the input is.
88 : */
89 : void setTextInput();
90 :
91 : /**
92 : * Call this whenever you need to maximize the chance of input being
93 : * detected as a numeric value (numbers, dates, times etc).
94 : */
95 : void setNumericInput();
96 : };
97 :
98 : // ============================================================================
99 :
100 4900 : struct ScInputStringType
101 : {
102 : enum StringType { Unknown = 0, Text, Formula, Number };
103 :
104 : StringType meType;
105 :
106 : OUString maText;
107 : double mfValue;
108 : short mnFormatType;
109 : };
110 :
111 : class ScStringUtil
112 : {
113 : public:
114 :
115 : /**
116 : * Check if a given string is a simple decimal number (e.g. 12.345). We
117 : * don't do any elaborate parsing here; we only check for the simplest
118 : * case of decimal number format.
119 : *
120 : * Note that preceding and trailing spaces are ignored during parsing.
121 : *
122 : * @param rStr string to parse
123 : * @param dsep decimal separator
124 : * @param gsep group separator (aka thousands separator)
125 : * @param rVal value of successfully parsed number
126 : *
127 : * @return true if the string is a valid number, false otherwise.
128 : */
129 : static bool parseSimpleNumber(
130 : const OUString& rStr, sal_Unicode dsep, sal_Unicode gsep, double& rVal);
131 :
132 : static sal_Int32 SC_DLLPUBLIC GetQuotedTokenCount(const OUString &rIn, const OUString& rQuotedPairs, sal_Unicode cTok = ';' );
133 : static OUString SC_DLLPUBLIC GetQuotedToken(const OUString &rIn, sal_Int32 nToken, const OUString& rQuotedPairs,
134 : sal_Unicode cTok, sal_Int32& rIndex );
135 :
136 : static bool SC_DLLPUBLIC isMultiline( const OUString& rStr );
137 :
138 : static ScInputStringType parseInputString(
139 : SvNumberFormatter& rFormatter, const OUString& rStr, LanguageType eLang );
140 : };
141 :
142 :
143 : #endif
144 :
145 : /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
