1 /****************************************************************************
2 **
3 ** Copyright (C) 2016 The Qt Company Ltd.
4 ** Contact: https://www.qt.io/licensing/
5 **
6 ** This file is part of Qt Creator.
7 **
8 ** Commercial License Usage
9 ** Licensees holding valid commercial Qt licenses may use this file in
10 ** accordance with the commercial license agreement provided with the
11 ** Software or, alternatively, in accordance with the terms contained in
12 ** a written agreement between you and The Qt Company. For licensing terms
13 ** and conditions see https://www.qt.io/terms-conditions. For further
14 ** information use the contact form at https://www.qt.io/contact-us.
15 **
16 ** GNU General Public License Usage
17 ** Alternatively, this file may be used under the terms of the GNU
18 ** General Public License version 3 as published by the Free Software
19 ** Foundation with exceptions as appearing in the file LICENSE.GPL3-EXCEPT
20 ** included in the packaging of this file. Please review the following
21 ** information to ensure the GNU General Public License requirements will
22 ** be met: https://www.gnu.org/licenses/gpl-3.0.html.
23 **
24 ****************************************************************************/
25
26 #include "classnamevalidatinglineedit.h"
27
28 #include <utils/qtcassert.h>
29
30 #include <QDebug>
31 #include <QRegularExpression>
32
33 /*!
34 \class Utils::ClassNameValidatingLineEdit
35
36 \brief The ClassNameValidatingLineEdit class implements a line edit that
37 validates a C++ class name and emits a signal
38 to derive suggested file names from it.
39 */
40
41 namespace Utils {
42
43 // Match something like "Namespace1::Namespace2::ClassName".
44
45 struct ClassNameValidatingLineEditPrivate
46 {
47 QRegularExpression m_nameRegexp;
48 QString m_namespaceDelimiter{"::"};
49 bool m_namespacesEnabled = false;
50 bool m_lowerCaseFileName = true;
51 bool m_forceFirstCapitalLetter = false;
52 };
53
54 // --------------------- ClassNameValidatingLineEdit
ClassNameValidatingLineEdit(QWidget * parent)55 ClassNameValidatingLineEdit::ClassNameValidatingLineEdit(QWidget *parent) :
56 FancyLineEdit(parent),
57 d(new ClassNameValidatingLineEditPrivate)
58 {
59 setValidationFunction([this](FancyLineEdit *edit, QString *errorMessage) {
60 return validateClassName(edit, errorMessage);
61 });
62 updateRegExp();
63 }
64
~ClassNameValidatingLineEdit()65 ClassNameValidatingLineEdit::~ClassNameValidatingLineEdit()
66 {
67 delete d;
68 }
69
namespacesEnabled() const70 bool ClassNameValidatingLineEdit::namespacesEnabled() const
71 {
72 return d->m_namespacesEnabled;
73 }
74
setNamespacesEnabled(bool b)75 void ClassNameValidatingLineEdit::setNamespacesEnabled(bool b)
76 {
77 d->m_namespacesEnabled = b;
78 }
79
80 /**
81 * @return Language-specific namespace delimiter, e.g. '::' or '.'
82 */
namespaceDelimiter()83 QString ClassNameValidatingLineEdit::namespaceDelimiter()
84 {
85 return d->m_namespaceDelimiter;
86 }
87
88 /**
89 * @brief Sets language-specific namespace delimiter, e.g. '::' or '.'
90 * Do not use identifier characters in delimiter
91 */
setNamespaceDelimiter(const QString & delimiter)92 void ClassNameValidatingLineEdit::setNamespaceDelimiter(const QString &delimiter)
93 {
94 d->m_namespaceDelimiter = delimiter;
95 }
96
validateClassName(FancyLineEdit * edit,QString * errorMessage) const97 bool ClassNameValidatingLineEdit::validateClassName(FancyLineEdit *edit, QString *errorMessage) const
98 {
99 QTC_ASSERT(d->m_nameRegexp.isValid(), return false);
100
101 const QString value = edit->text();
102 if (!d->m_namespacesEnabled && value.contains(d->m_namespaceDelimiter)) {
103 if (errorMessage)
104 *errorMessage = tr("The class name must not contain namespace delimiters.");
105 return false;
106 } else if (value.isEmpty()) {
107 if (errorMessage)
108 *errorMessage = tr("Please enter a class name.");
109 return false;
110 } else if (!d->m_nameRegexp.match(value).hasMatch()) {
111 if (errorMessage)
112 *errorMessage = tr("The class name contains invalid characters.");
113 return false;
114 }
115 return true;
116 }
117
handleChanged(const QString & t)118 void ClassNameValidatingLineEdit::handleChanged(const QString &t)
119 {
120 if (isValid()) {
121 // Suggest file names, strip namespaces
122 QString fileName = d->m_lowerCaseFileName ? t.toLower() : t;
123 if (d->m_namespacesEnabled) {
124 const int namespaceIndex = fileName.lastIndexOf(d->m_namespaceDelimiter);
125 if (namespaceIndex != -1)
126 fileName.remove(0, namespaceIndex + d->m_namespaceDelimiter.size());
127 }
128 emit updateFileName(fileName);
129 }
130 }
131
fixInputString(const QString & string)132 QString ClassNameValidatingLineEdit::fixInputString(const QString &string)
133 {
134 if (!forceFirstCapitalLetter())
135 return string;
136
137 QString fixedString = string;
138 if (!string.isEmpty() && string.at(0).isLower())
139 fixedString[0] = string.at(0).toUpper();
140
141 return fixedString;
142 }
143
updateRegExp() const144 void ClassNameValidatingLineEdit::updateRegExp() const
145 {
146 const QString pattern = "^%1(%2%1)*$";
147 d->m_nameRegexp.setPattern(pattern.arg("[a-zA-Z_][a-zA-Z0-9_]*")
148 .arg(QRegularExpression::escape(d->m_namespaceDelimiter)));
149 }
150
createClassName(const QString & name)151 QString ClassNameValidatingLineEdit::createClassName(const QString &name)
152 {
153 // Remove spaces and convert the adjacent characters to uppercase
154 QString className = name;
155 const QRegularExpression spaceMatcher(" +(\\w)");
156 QTC_CHECK(spaceMatcher.isValid());
157 while (true) {
158 const QRegularExpressionMatch match = spaceMatcher.match(className);
159 if (!match.hasMatch())
160 break;
161 className.replace(match.capturedStart(), match.capturedLength(), match.captured(1).toUpper());
162 }
163
164 // Filter out any remaining invalid characters
165 className.remove(QRegularExpression("[^a-zA-Z0-9_]"));
166
167 // If the first character is numeric, prefix the name with a "_"
168 if (className.at(0).isNumber()) {
169 className.prepend(QLatin1Char('_'));
170 } else {
171 // Convert the first character to uppercase
172 className.replace(0, 1, className.left(1).toUpper());
173 }
174
175 return className;
176 }
177
lowerCaseFileName() const178 bool ClassNameValidatingLineEdit::lowerCaseFileName() const
179 {
180 return d->m_lowerCaseFileName;
181 }
182
setLowerCaseFileName(bool v)183 void ClassNameValidatingLineEdit::setLowerCaseFileName(bool v)
184 {
185 d->m_lowerCaseFileName = v;
186 }
187
forceFirstCapitalLetter() const188 bool ClassNameValidatingLineEdit::forceFirstCapitalLetter() const
189 {
190 return d->m_forceFirstCapitalLetter;
191 }
192
setForceFirstCapitalLetter(bool b)193 void ClassNameValidatingLineEdit::setForceFirstCapitalLetter(bool b)
194 {
195 d->m_forceFirstCapitalLetter = b;
196 }
197
198 } // namespace Utils
199