diff options
Diffstat (limited to 'changelog/org.eclipse.linuxtools.changelog.core/src/org/eclipse/linuxtools/changelog/core/IParserChangeLogContrib.java')
| -rw-r--r-- | changelog/org.eclipse.linuxtools.changelog.core/src/org/eclipse/linuxtools/changelog/core/IParserChangeLogContrib.java | 44 |
1 files changed, 44 insertions, 0 deletions
diff --git a/changelog/org.eclipse.linuxtools.changelog.core/src/org/eclipse/linuxtools/changelog/core/IParserChangeLogContrib.java b/changelog/org.eclipse.linuxtools.changelog.core/src/org/eclipse/linuxtools/changelog/core/IParserChangeLogContrib.java new file mode 100644 index 0000000000..bf72fa749f --- /dev/null +++ b/changelog/org.eclipse.linuxtools.changelog.core/src/org/eclipse/linuxtools/changelog/core/IParserChangeLogContrib.java @@ -0,0 +1,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. + */ + public 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. + */ + public String parseCurrentFunction(IEditorInput input, int offset) + throws CoreException; + +} |