diff dwtx/jface/text/ILineTrackerExtension.d @ 129:eb30df5ca28b

Added JFace Text sources
author Frank Benoit <benoit@tionex.de>
date Sat, 23 Aug 2008 19:10:48 +0200
parents
children c4fb132a086c
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/dwtx/jface/text/ILineTrackerExtension.d	Sat Aug 23 19:10:48 2008 +0200
@@ -0,0 +1,47 @@
+/*******************************************************************************
+ * Copyright (c) 2000, 2005 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
+ * Port to the D programming language:
+ *     Frank Benoit <benoit@tionex.de>
+ *******************************************************************************/
+module dwtx.jface.text.ILineTrackerExtension;
+
+import dwt.dwthelper.utils;
+
+/**
+ * Extension interface for {@link dwtx.jface.text.ILineTracker}. Adds the
+ * concept of rewrite sessions. A rewrite session is a sequence of replace
+ * operations that form a semantic unit.
+ *
+ * @since 3.1
+ */
+public interface ILineTrackerExtension {
+
+    /**
+     * Tells the line tracker that a rewrite session started. A rewrite session
+     * is a sequence of replace operations that form a semantic unit. The line
+     * tracker is allowed to use that information for internal optimization.
+     *
+     * @param session the rewrite session
+     * @throws IllegalStateException in case there is already an active rewrite
+     *             session
+     */
+    void startRewriteSession(DocumentRewriteSession session) throws IllegalStateException;
+
+    /**
+     * Tells the line tracker that the rewrite session has finished. This method
+     * is only called when <code>startRewriteSession</code> has been called
+     * before. The text resulting from the rewrite session is passed to the line
+     * tracker.
+     *
+     * @param session the rewrite session
+     * @param text the text with which to re-initialize the line tracker
+     */
+    void stopRewriteSession(DocumentRewriteSession session, String text);
+}