blob: 2150714d1ba3114295d91e48c78df7eff672ad7c (
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
|
/*******************************************************************************
* Copyright (c) 2006 Phil Muldoon <pkmuldoon@picobot.org>.
* 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:
* Phil Muldoon <pmuldoon@redhat.com> - initial API and implementation
*******************************************************************************/
package org.eclipse.linuxtools.changelog.core;
import org.eclipse.core.runtime.CoreException;
import org.eclipse.ui.IEditorInput;
import org.eclipse.ui.IEditorPart;
/**
* @author pmuldoon (Phil Muldoon)
*/
public interface IParserChangeLogContrib {
/**
* Used to determine function name from a currently open editor, where the
* cursor is at. Used by KeyAction.
*
* @param editor The editor to check for the function.
* @return The name of the function.
* @throws CoreException If unexpected error happens in the underlying Eclipse APIs.
*/
String parseCurrentFunction(IEditorPart editor) throws CoreException;
/**
* Used to determine function name from and editor input, with offset
* supplied manualy. Used by prepare changelog.
*
* @param input If unexpected error happens in the underlying Eclipse APIs.
* @param offset The offset at which to start.
* @return The name of the function.
* @throws CoreException If unexpected error happens in the underlying Eclipse APIs.
*/
String parseCurrentFunction(IEditorInput input, int offset)
throws CoreException;
}
|
