blob: bba934d0a1ca1c6d3f0bdcca376ba1fb0e931f05 (
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
|
/*******************************************************************************
* Copyright (c) 2000, 2006 IBM Corporation 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:
* IBM Corporation - initial API and implementation
*******************************************************************************/
package org.eclipse.cdt.ui;
import org.eclipse.cdt.core.model.IWorkingCopy;
import org.eclipse.core.runtime.CoreException;
import org.eclipse.ui.IEditorInput;
/**
* Interface for accessing working copies of <code>ITranslationUnit</code>
* objects. The original translation unit is only given indirectly by means
* of an <code>IEditorInput</code>. The life cycle is as follows:
* <ul>
* <li> <code>connect</code> creates and remembers a working copy of the
* translation unit which is encoded in the given editor input</li>
* <li> <code>getWorkingCopy</code> returns the working copy remembered on
* <code>connect</code></li>
* <li> <code>disconnect</code> destroys the working copy remembered on
* <code>connect</code></li>
* </ul>
* <p>
* This interface is not intended to be implemented by clients.
* </p>
* @noimplement This interface is not intended to be implemented by clients.
*
* @see CUIPlugin#getWorkingCopyManager
*/
public interface IWorkingCopyManager {
/**
* Connects the given editor input to this manager. After calling
* this method, a working copy will be available for the translation unit encoded
* in the given editor input (does nothing if there is no encoded translation unit).
*
* @param input the editor input
* @exception CoreException if the working copy cannot be created for the
* translation unit
*/
void connect(IEditorInput input) throws CoreException;
/**
* Disconnects the given editor input from this manager. After calling
* this method, a working copy for the translation unit encoded
* in the given editor input will no longer be available. Does nothing if there
* is no encoded translation unit, or if there is no remembered working copy for
* the translation unit.
*
* @param input the editor input
*/
void disconnect(IEditorInput input);
/**
* Returns the working copy remembered for the translation unit encoded in the
* given editor input.
*
* @param input the editor input
* @return the working copy of the translation unit, or <code>null</code> if the
* input does not encode an editor input, or if there is no remembered working
* copy for this translation unit
*/
IWorkingCopy getWorkingCopy(IEditorInput input);
/**
* Shuts down this working copy manager. All working copies still remembered
* by this manager are destroyed.
*/
void shutdown();
}
|
