blob: 6ea65405ba1a7beea7c182adb85c65214c051ae3 (
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
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
|
/*
* 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.documentation;
import com.intellij.openapi.components.*;
import com.intellij.openapi.module.Module;
import com.intellij.openapi.module.ModuleServiceManager;
import com.intellij.openapi.util.text.StringUtil;
import com.intellij.psi.PsiFile;
import com.intellij.util.xmlb.XmlSerializerUtil;
import com.intellij.util.xmlb.annotations.Transient;
import com.jetbrains.python.PyNames;
import com.jetbrains.python.psi.PyFile;
import com.jetbrains.python.psi.PyTargetExpression;
import com.jetbrains.python.psi.impl.PyPsiUtils;
import org.jetbrains.annotations.NotNull;
import java.util.List;
/**
* @author yole
*/
@State(name = "PyDocumentationSettings",
storages = {@Storage(file = "$MODULE_FILE$")}
)
public class PyDocumentationSettings implements PersistentStateComponent<PyDocumentationSettings> {
public String myDocStringFormat = DocStringFormat.REST;
public boolean analyzeDoctest = true;
public boolean isEpydocFormat(PsiFile file) {
return isFormat(file, DocStringFormat.EPYTEXT);
}
public boolean isReSTFormat(PsiFile file) {
return isFormat(file, DocStringFormat.REST);
}
public boolean isPlain(PsiFile file) {
return isFormat(file, DocStringFormat.PLAIN);
}
private boolean isFormat(PsiFile file, final String format) {
if (file instanceof PyFile) {
PyTargetExpression expr = ((PyFile) file).findTopLevelAttribute(PyNames.DOCFORMAT);
if (expr != null) {
String docformat = PyPsiUtils.strValue(expr.findAssignedValue());
if (docformat != null) {
final List<String> words = StringUtil.split(docformat, " ");
return words.size() > 0 && format.equalsIgnoreCase(words.get(0));
}
}
}
return format.equalsIgnoreCase(myDocStringFormat);
}
public static PyDocumentationSettings getInstance(@NotNull Module module) {
return ModuleServiceManager.getService(module, PyDocumentationSettings.class);
}
public void setFormat(String format) {
myDocStringFormat = format;
}
@Transient
public String getFormat() {
return myDocStringFormat;
}
@Override
public PyDocumentationSettings getState() {
return this;
}
@Override
public void loadState(PyDocumentationSettings state) {
XmlSerializerUtil.copyBean(state, this);
}
}
|