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
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
|
/*
* Copyright 2000-2013 JetBrains s.r.o.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.jetbrains.python.psi.impl;
import com.intellij.openapi.project.Project;
import com.intellij.openapi.util.text.StringUtil;
import com.intellij.psi.PsiElement;
import com.intellij.psi.codeStyle.CodeStyleSettings;
import com.intellij.psi.codeStyle.CodeStyleSettingsManager;
import com.intellij.util.ArrayUtil;
import com.jetbrains.python.PyNames;
import com.jetbrains.python.PythonFileType;
import com.jetbrains.python.documentation.StructuredDocStringBase;
import com.jetbrains.python.psi.*;
import org.jetbrains.annotations.NotNull;
import java.util.*;
import java.util.regex.Pattern;
/**
* @author yole
*/
public class PyFunctionBuilder {
private static final String COMMENTS_BOUNDARY = "\"\"\"";
private static final Pattern INDENT_REMOVE_PATTERN = Pattern.compile("^\\s+", Pattern.MULTILINE);
private final String myName;
private final List<String> myParameters = new ArrayList<String>();
private final List<String> myStatements = new ArrayList<String>();
private final List<String> myDecorators = new ArrayList<String>();
private String myAnnotation = null;
private String[] myDocStringLines = null;
@NotNull
private final Map<String, String> myDecoratorValues = new HashMap<String, String>();
/**
* Creates builder copying signature and doc from another one.
*
* @param source what to copy
* @param decoratorsToCopyIfExist list of decorator names to be copied to new function.
* @return builder configured by this function
*/
@NotNull
public static PyFunctionBuilder copySignature(@NotNull final PyFunction source, @NotNull final String... decoratorsToCopyIfExist) {
final String name = source.getName();
final PyFunctionBuilder functionBuilder = new PyFunctionBuilder((name != null) ? name : "");
for (final PyParameter parameter : source.getParameterList().getParameters()) {
final String parameterName = parameter.getName();
if (parameterName != null) {
functionBuilder.parameter(parameterName);
}
}
final PyDecoratorList decoratorList = source.getDecoratorList();
if (decoratorList != null) {
for (final PyDecorator decorator : decoratorList.getDecorators()) {
final String decoratorName = decorator.getName();
if (decoratorName != null) {
if (ArrayUtil.contains(decoratorName, decoratorsToCopyIfExist)) {
functionBuilder.decorate(decoratorName);
}
}
}
}
final String docString = source.getDocStringValue();
if (docString != null) {
functionBuilder.docString(docString);
}
return functionBuilder;
}
/**
* Adds docstring to function. Provide doc with out of comment blocks.
*
*
* @param docString doc
*/
public void docString(@NotNull final String docString) {
final String[] stringsToAdd = StringUtil.splitByLines(removeIndent(docString));
if (myDocStringLines == null) {
myDocStringLines = stringsToAdd;
}
else {
myDocStringLines = ArrayUtil.mergeArrays(myDocStringLines, stringsToAdd);
}
}
@NotNull
private static String removeIndent(@NotNull final String string) {
return INDENT_REMOVE_PATTERN.matcher(string).replaceAll("");
}
public PyFunctionBuilder(String name) {
myName = name;
}
/**
* Adds param and its type to doc
* @param name param name
* @param type param type
* @param docStyle what docstyle to use to doc param type
*/
@NotNull
public PyFunctionBuilder parameterWithType(@NotNull final String name,
@NotNull final String type,
@NotNull final StructuredDocStringBase docStyle) {
parameter(name);
docString(docStyle.createParameterType(name, type));
return this;
}
public PyFunctionBuilder parameter(String baseName) {
String name = baseName;
int uniqueIndex = 0;
while (myParameters.contains(name)) {
uniqueIndex++;
name = baseName + uniqueIndex;
}
myParameters.add(name);
return this;
}
public PyFunctionBuilder annotation(String text) {
myAnnotation = text;
return this;
}
public PyFunctionBuilder statement(String text) {
myStatements.add(text);
return this;
}
public PyFunction addFunction(PsiElement target, final LanguageLevel languageLevel) {
return (PyFunction)target.add(buildFunction(target.getProject(), languageLevel));
}
public PyFunction addFunctionAfter(PsiElement target, PsiElement anchor, final LanguageLevel languageLevel) {
return (PyFunction)target.addAfter(buildFunction(target.getProject(), languageLevel), anchor);
}
public PyFunction buildFunction(Project project, final LanguageLevel languageLevel) {
PyElementGenerator generator = PyElementGenerator.getInstance(project);
String text = buildText(project, generator, languageLevel);
return generator.createFromText(languageLevel, PyFunction.class, text);
}
private String buildText(Project project, PyElementGenerator generator, LanguageLevel languageLevel) {
StringBuilder builder = new StringBuilder();
for (String decorator : myDecorators) {
final StringBuilder decoratorAppender = builder.append('@' + decorator);
if (myDecoratorValues.containsKey(decorator)) {
final PyCallExpression fakeCall = generator.createCallExpression(languageLevel, "fakeFunction");
fakeCall.getArgumentList().addArgument(generator.createStringLiteralFromString(myDecoratorValues.get(decorator)));
decoratorAppender.append(fakeCall.getArgumentList().getText());
}
decoratorAppender.append("\n");
}
builder.append("def ");
builder.append(myName).append("(");
builder.append(StringUtil.join(myParameters, ", "));
builder.append(")");
if (myAnnotation != null) {
builder.append(myAnnotation);
}
builder.append(":");
List<String> statements = myStatements.isEmpty() ? Collections.singletonList(PyNames.PASS) : myStatements;
if (myDocStringLines != null) {
final List<String> comments = new ArrayList<String>(myDocStringLines.length + 2);
comments.add(COMMENTS_BOUNDARY);
comments.addAll(Arrays.asList(myDocStringLines));
comments.add(COMMENTS_BOUNDARY);
statements = new ArrayList<String>(statements);
statements.addAll(0, comments);
}
final CodeStyleSettings codeStyleSettings = CodeStyleSettingsManager.getInstance(project).getCurrentSettings();
int indentSize = codeStyleSettings.getIndentOptions(PythonFileType.INSTANCE).INDENT_SIZE;
String indent = StringUtil.repeatSymbol(' ', indentSize);
for (String statement : statements) {
builder.append("\n").append(indent).append(statement);
}
return builder.toString();
}
/**
* Adds decorator with argument
*
* @param decoratorName decorator name
* @param value its argument
*/
public void decorate(@NotNull final String decoratorName, @NotNull final String value) {
decorate(decoratorName);
myDecoratorValues.put(decoratorName, value);
}
public void decorate(String decoratorName) {
myDecorators.add(decoratorName);
}
@NotNull
private static String getIndent(@NotNull final Project project) {
final CodeStyleSettings codeStyleSettings = CodeStyleSettingsManager.getInstance(project).getCurrentSettings();
final int indentSize = codeStyleSettings.getIndentOptions(PythonFileType.INSTANCE).INDENT_SIZE;
return StringUtil.repeatSymbol(' ', indentSize);
}
}
|
