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
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
|
/*******************************************************************************
* Copyright (c) 2011, 2012 Wind River Systems, Inc. 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:
* Wind River Systems - initial API and implementation
*******************************************************************************/
package org.eclipse.tcf.te.ui.terminals.process;
import org.eclipse.cdt.utils.pty.PTY;
import org.eclipse.core.runtime.Assert;
import org.eclipse.tcf.te.runtime.interfaces.properties.IPropertiesContainer;
import org.eclipse.tcf.te.ui.terminals.streams.OutputStreamMonitor;
import org.eclipse.tm.internal.terminal.provisional.api.ISettingsStore;
/**
* Process connector settings implementation.
*/
@SuppressWarnings("restriction")
public class ProcessSettings {
// Reference to the process image
private String image;
// Reference to the process arguments (space separated string)
private String arguments;
// Reference to the process object
private Process process;
// Reference to the pseudo terminal object
private PTY pty;
// Flag to control the local echo (defaults to true if
// the PTY is not supported on the current host platform)
private boolean localEcho = !PTY.isSupported();
// The line separator setting
private String lineSeparator = null;
// The list of stdout output listeners
private OutputStreamMonitor.Listener[] stdoutListeners = null;
// The list of stderr output listeners
private OutputStreamMonitor.Listener[] stderrListeners = null;
// working directory for process
private String workingDir;
/**
* Sets the process image.
*
* @param image The process image or <code>null</code>.
*/
public void setImage(String image) {
this.image = image;
}
/**
* Returns the process image.
*
* @return The process image or <code>null</code>.
*/
public String getImage() {
return image;
}
/**
* Sets the process arguments.
* <p>
* The arguments are space separated. The caller is responsible for
* correct quoting.
*
* @param arguments The process arguments or <code>null</code>.
*/
public void setArguments(String arguments) {
this.arguments = arguments;
}
/**
* Returns the process arguments.
*
* @return The process arguments as space separated list or <code>null</code>.
*/
public String getArguments() {
return arguments;
}
/**
* Sets the process object.
*
* @param image The process object or <code>null</code>.
*/
public void setProcess(Process process) {
this.process = process;
}
/**
* Returns the process object.
*
* @return The process object or <code>null</code>.
*/
public Process getProcess() {
return process;
}
/**
* Sets the pseudo terminal object.
*
* @param pty The pseudo terminal or <code>null</code>.
*/
public void setPTY(PTY pty) {
this.pty = pty;
// If the PTY is set to "null", the local echo will be set to "true"
if (pty == null) setLocalEcho(true);
}
/**
* Returns the pseudo terminal object.
*
* @return The pseudo terminal or <code>null</code>.
*/
public PTY getPTY() {
return pty;
}
/**
* Sets if the process requires a local echo from the
* terminal widget.
*
* @param value Specify <code>true</code> to enable the local echo, <code>false</code> otherwise.
*/
public void setLocalEcho(boolean value) {
this.localEcho = value;
}
/**
* Returns <code>true</code> if the process requires a local echo
* from the terminal widget.
*
* @return <code>True</code> if local echo is enabled, <code>false</code> otherwise.
*/
public boolean isLocalEcho() {
return localEcho;
}
/**
* Sets the process line separator.
*
* @param separator The process line separator <code>null</code>.
*/
public void setLineSeparator(String separator) {
this.lineSeparator = separator;
}
/**
* Returns the process line separator.
*
* @return The process line separator or <code>null</code>.
*/
public String getLineSeparator() {
return lineSeparator;
}
/**
* Sets the list of stdout listeners.
*
* @param listeners The list of stdout listeners or <code>null</code>.
*/
public void setStdOutListeners(OutputStreamMonitor.Listener[] listeners) {
this.stdoutListeners = listeners;
}
/**
* Returns the list of stdout listeners.
*
* @return The list of stdout listeners or <code>null</code>.
*/
public OutputStreamMonitor.Listener[] getStdOutListeners() {
return stdoutListeners;
}
/**
* Sets the list of stderr listeners.
*
* @param listeners The list of stderr listeners or <code>null</code>.
*/
public void setStdErrListeners(OutputStreamMonitor.Listener[] listeners) {
this.stderrListeners = listeners;
}
/**
* Returns the list of stderr listeners.
*
* @return The list of stderr listeners or <code>null</code>.
*/
public OutputStreamMonitor.Listener[] getStdErrListeners() {
return stderrListeners;
}
/**
*
* @return
*/
public String getWorkingDir() {
return this.workingDir;
}
/**
*
* @param workingDir
*/
public void setWorkingDir(String workingDir) {
this.workingDir = workingDir;
}
/**
* Loads the process settings from the given settings store.
*
* @param store The settings store. Must not be <code>null</code>.
*/
public void load(ISettingsStore store) {
Assert.isNotNull(store);
image = store.get("Path", null);//$NON-NLS-1$
arguments = store.get("Arguments", null); //$NON-NLS-1$
localEcho = Boolean.parseBoolean(store.get("LocalEcho", Boolean.FALSE.toString())); //$NON-NLS-1$
lineSeparator = store.get("LineSeparator", null); //$NON-NLS-1$
workingDir = store.get("WorkingDir", null); //$NON-NLS-1$
if (store instanceof IPropertiesContainer) {
process = (Process)((IPropertiesContainer)store).getProperty("Process"); //$NON-NLS-1$
pty = (PTY)((IPropertiesContainer)store).getProperty("PTY"); //$NON-NLS-1$
stdoutListeners = (OutputStreamMonitor.Listener[])((IPropertiesContainer)store).getProperty("StdOutListeners"); //$NON-NLS-1$
stderrListeners = (OutputStreamMonitor.Listener[])((IPropertiesContainer)store).getProperty("StdErrListeners"); //$NON-NLS-1$
}
}
/**
* Saves the process settings to the given settings store.
*
* @param store The settings store. Must not be <code>null</code>.
*/
public void save(ISettingsStore store) {
Assert.isNotNull(store);
store.put("Path", image);//$NON-NLS-1$
store.put("Arguments", arguments); //$NON-NLS-1$
store.put("LocalEcho", Boolean.toString(localEcho)); //$NON-NLS-1$
store.put("LineSeparator", lineSeparator); //$NON-NLS-1$
store.put("WorkingDir", workingDir); //$NON-NLS-1$
if (store instanceof IPropertiesContainer) {
((IPropertiesContainer)store).setProperty("Process", process); //$NON-NLS-1$
((IPropertiesContainer)store).setProperty("PTY", pty); //$NON-NLS-1$
((IPropertiesContainer)store).setProperty("StdOutListeners", stdoutListeners); //$NON-NLS-1$
((IPropertiesContainer)store).setProperty("StdErrListeners", stderrListeners); //$NON-NLS-1$
}
}
}
|
