blob: f7d9b67df711fc7d64db046db3aacc536c06dcba (
plain) (
blame)
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
|
/*******************************************************************************
* Copyright (c) 2002, 2005 QNX Software Systems and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* Contributors:
* QNX Software Systems - Initial API and implementation
*******************************************************************************/
package org.eclipse.cdt.internal.core.model;
import org.eclipse.cdt.core.CConventions;
import org.eclipse.cdt.core.model.ICElement;
import org.eclipse.cdt.core.model.ICModelStatusConstants;
import org.eclipse.cdt.core.model.IInclude;
import org.eclipse.cdt.core.model.ITranslationUnit;
import org.eclipse.cdt.core.model.ICModelStatus;
import org.eclipse.cdt.core.model.CModelException;
import org.eclipse.core.resources.IProject;
import org.eclipse.core.runtime.IStatus;
/**
* <p>This operation adds an include declaration to an existing translation unit.
* If the translation unit already includes the specified include declaration,
* the include is not generated (it does not generate duplicates).
*
* <p>Required Attributes:<ul>
* <li>Translation unit
* <li>Include name - the name of the include to add to the
* translation unit. For example: <code>stdio.h</code>
* </ul>
*/
public class CreateIncludeOperation extends CreateElementInTUOperation {
/**
* The name of the include to be created.
*/
protected String fIncludeName;
/**
* Whether the include is a std include.
*/
protected boolean fIsStandard;
/**
* When executed, this operation will add an include to the given translation unit.
*/
public CreateIncludeOperation(String includeName, boolean isStd, ITranslationUnit parentElement) {
super(parentElement);
fIsStandard = isStd;
fIncludeName = includeName;
}
/**
* @see CreateElementInCUOperation#generateResultHandle
*/
protected ICElement generateResultHandle() {
return getTranslationUnit().getInclude(fIncludeName);
}
/**
* @see CreateElementInCUOperation#getMainTaskName
*/
public String getMainTaskName(){
return "operation.createIncludeProgress"; //$NON-NLS-1$
}
/**
* Sets the correct position for the new include:<ul>
* <li> after the last include
* </ul>
* if no include
*/
protected void initializeDefaultPosition() {
try {
ITranslationUnit cu = getTranslationUnit();
IInclude[] includes = cu.getIncludes();
if (includes.length > 0) {
createAfter(includes[includes.length - 1]);
return;
}
} catch (CModelException npe) {
}
}
/**
* Possible failures: <ul>
* <li>NO_ELEMENTS_TO_PROCESS - the compilation unit supplied to the operation is
* <code>null</code>.
* <li>INVALID_NAME - not a valid include declaration name.
* </ul>
* @see ICModelStatus
* @see CNamingConventions
*/
public ICModelStatus verify() {
ICModelStatus status = super.verify();
if (!status.isOK()) {
return status;
}
IProject project = getParentElement().getCProject().getProject();
if (CConventions.validateIncludeName(project, fIncludeName).getSeverity() == IStatus.ERROR) {
return new CModelStatus(ICModelStatusConstants.INVALID_NAME, fIncludeName);
}
return CModelStatus.VERIFIED_OK;
}
/*
* TODO: Use the ASTRewrite once it is available.
*/
protected String generateElement(ITranslationUnit unit) throws CModelException {
StringBuffer sb = new StringBuffer();
sb.append("#include "); //$NON-NLS-1$;
if (fIsStandard) {
sb.append('<');
} else {
sb.append('"');
}
sb.append(fIncludeName);
if (fIsStandard) {
sb.append('>');
} else {
sb.append('"');
}
sb.append(Util.LINE_SEPARATOR);
return sb.toString();
}
}
|
