/*******************************************************************************
- * Copyright (c) 2000, 2003 IBM Corporation and others.
+ * Copyright (c) 2000, 2004 IBM Corporation and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Common Public License v1.0
* which accompanies this distribution, and is available at
import java.util.List;
import java.util.ResourceBundle;
-import net.sourceforge.phpdt.internal.corext.Assert;
import net.sourceforge.phpdt.internal.ui.text.IPHPPartitions;
+import net.sourceforge.phpeclipse.phpeditor.php.PHPDocumentPartitioner;
+import org.eclipse.jface.text.Assert;
import org.eclipse.jface.text.BadLocationException;
import org.eclipse.jface.text.BadPartitioningException;
import org.eclipse.jface.text.IDocument;
import org.eclipse.ui.texteditor.ITextEditor;
/**
- * Action that encloses the editor's current selection with Java block comment terminators
- * (<code>/*</code> and <code>*/</code>).
- *
+ * Action that encloses the editor's current selection with Java block comment terminators (<code>/*</code> and
+ * <code>*/</code>).
+ *
* @since 3.0
*/
public class AddBlockCommentAction extends BlockCommentAction {
- /**
- * Creates a new instance.
- *
- * @param bundle the resource bundle
- * @param prefix a prefix to be prepended to the various resource keys
- * (described in <code>ResourceAction</code> constructor), or
- * <code>null</code> if none
- * @param editor the text editor
- */
- public AddBlockCommentAction(ResourceBundle bundle, String prefix, ITextEditor editor) {
- super(bundle, prefix, editor);
- }
-
- /*
- * @see org.eclipse.jdt.internal.ui.actions.BlockCommentAction#runInternal(org.eclipse.jface.text.ITextSelection, org.eclipse.jface.text.IDocumentExtension3, org.eclipse.jdt.internal.ui.actions.BlockCommentAction.Edit.EditFactory)
- */
- protected void runInternal(ITextSelection selection, IDocumentExtension3 docExtension, Edit.EditFactory factory) throws BadLocationException, BadPartitioningException {
- int selectionOffset= selection.getOffset();
- int selectionEndOffset= selectionOffset + selection.getLength();
- List edits= new LinkedList();
- ITypedRegion partition= docExtension.getPartition(IPHPPartitions.PHP_PARTITIONING, selectionOffset);
-
- handleFirstPartition(partition, edits, factory, selectionOffset);
-
- while (partition.getOffset() + partition.getLength() < selectionEndOffset) {
- partition= handleInteriorPartition(partition, edits, factory, docExtension);
- }
-
- handleLastPartition(partition, edits, factory, selectionEndOffset);
-
- executeEdits(edits);
- }
-
- /**
- * Handle the first partition of the selected text.
- *
- * @param partition
- * @param edits
- * @param factory
- * @param offset
- */
- private void handleFirstPartition(ITypedRegion partition, List edits, Edit.EditFactory factory, int offset) throws BadLocationException {
-
- int partOffset= partition.getOffset();
- String partType= partition.getType();
-
- Assert.isTrue(partOffset <= offset, "illegal partition"); //$NON-NLS-1$
-
- // first partition: mark start of comment
- if (partType == IDocument.DEFAULT_CONTENT_TYPE) {
- // Java code: right where selection starts
- edits.add(factory.createEdit(offset, 0, getCommentStart()));
- } else if (isSpecialPartition(partType)) {
- // special types: include the entire partition
- edits.add(factory.createEdit(partOffset, 0, getCommentStart()));
- } // javadoc: no mark, will only start after comment
-
- }
-
- /**
- * Handles the end of the given partition and the start of the next partition, which is returned.
- *
- * @param partition
- * @param edits
- * @param factory
- * @param docExtension
- * @return
- * @throws BadLocationException
- * @throws BadPartitioningException
- */
- private ITypedRegion handleInteriorPartition(ITypedRegion partition, List edits, Edit.EditFactory factory, IDocumentExtension3 docExtension) throws BadPartitioningException, BadLocationException {
-
- // end of previous partition
- String partType= partition.getType();
- int partEndOffset= partition.getOffset() + partition.getLength();
- int tokenLength= getCommentStart().length();
-
- boolean wasJavadoc= false; // true if the previous partition is javadoc
-
- if (partType == IPHPPartitions.PHP_MULTILINE_COMMENT) {
-
- wasJavadoc= true;
-
-// } else if (partType == IPHPPartitions.JAVA_MULTI_LINE_COMMENT) {
-//
-// // already in a comment - remove ending mark
-// edits.add(factory.createEdit(partEndOffset - tokenLength, tokenLength, "")); //$NON-NLS-1$
-//
- }
-
- // advance to next partition
- partition= docExtension.getPartition(IPHPPartitions.PHP_PARTITIONING, partEndOffset);
- partType= partition.getType();
-
- // start of next partition
- if (wasJavadoc) {
-
- // if previous was javadoc, and the current one is not, then add block comment start
- if (partType == IDocument.DEFAULT_CONTENT_TYPE
- || isSpecialPartition(partType)) {
- edits.add(factory.createEdit(partition.getOffset(), 0, getCommentStart()));
- }
-
- } else { // !wasJavadoc
-
- if (partType == IPHPPartitions.PHP_MULTILINE_COMMENT) {
- // if next is javadoc, end block comment before
- edits.add(factory.createEdit(partition.getOffset(), 0, getCommentEnd()));
-// } else if (partType == IJavaPartitions.JAVA_MULTI_LINE_COMMENT) {
-// // already in a comment - remove startToken
-// edits.add(factory.createEdit(partition.getOffset(), getCommentStart().length(), "")); //$NON-NLS-1$
- }
- }
-
- return partition;
- }
-
- /**
- * Handles the end of the last partition.
- *
- * @param partition
- * @param edits
- * @param factory
- * @param endOffset
- */
- private void handleLastPartition(ITypedRegion partition, List edits, Edit.EditFactory factory, int endOffset) throws BadLocationException {
-
- String partType= partition.getType();
-
- if (partType == IDocument.DEFAULT_CONTENT_TYPE) {
- // normal java: end comment where selection ends
- edits.add(factory.createEdit(endOffset, 0, getCommentEnd()));
- } else if (isSpecialPartition(partType)) {
- // special types: consume entire partition
- edits.add(factory.createEdit(partition.getOffset() + partition.getLength(), 0, getCommentEnd()));
- }
-
- }
-
- /**
- * Returns whether <code>partType</code> is special, i.e. a Java <code>String</code>,
- * <code>Character</code>, or <code>Line End Comment</code> partition.
- *
- * @param partType the partition type to check
- * @return <code>true</code> if <code>partType</code> is special, <code>false</code> otherwise
- */
- private boolean isSpecialPartition(String partType) {
- return// partType == IPHPPartitions.PHP_CHARACTER
- //||
- partType == IPHPPartitions.PHP_STRING;
- //|| partType == IPHPPartitions.PHP_SINGLE_LINE_COMMENT;
- }
-
- /*
- * @see org.eclipse.jdt.internal.ui.actions.BlockCommentAction#validSelection(org.eclipse.jface.text.ITextSelection)
- */
- protected boolean isValidSelection(ITextSelection selection) {
- return selection != null && !selection.isEmpty() && selection.getLength() > 0;
- }
-
-}
+ /**
+ * Creates a new instance.
+ *
+ * @param bundle
+ * the resource bundle
+ * @param prefix
+ * a prefix to be prepended to the various resource keys (described in <code>ResourceAction</code> constructor), or
+ * <code>null</code> if none
+ * @param editor
+ * the text editor
+ */
+ public AddBlockCommentAction(ResourceBundle bundle, String prefix, ITextEditor editor) {
+ super(bundle, prefix, editor);
+ }
+
+ /*
+ * @see net.sourceforge.phpdt.internal.ui.actions.BlockCommentAction#runInternal(org.eclipse.jface.text.ITextSelection,
+ * org.eclipse.jface.text.IDocumentExtension3, net.sourceforge.phpdt.internal.ui.actions.BlockCommentAction.Edit.EditFactory)
+ */
+ protected void runInternal(ITextSelection selection, IDocumentExtension3 docExtension, Edit.EditFactory factory)
+ throws BadLocationException, BadPartitioningException {
+ int selectionOffset = selection.getOffset();
+ int selectionEndOffset = selectionOffset + selection.getLength();
+ List edits = new LinkedList();
+ ITypedRegion partition = docExtension.getPartition(IPHPPartitions.PHP_PARTITIONING, selectionOffset, false);
+
+ handleFirstPartition(partition, edits, factory, selectionOffset);
+
+ while (partition.getOffset() + partition.getLength() < selectionEndOffset) {
+ partition = handleInteriorPartition(partition, edits, factory, docExtension);
+ }
+
+ handleLastPartition(partition, edits, factory, selectionEndOffset);
+
+ executeEdits(edits);
+ }
+
+ /**
+ * Handle the first partition of the selected text.
+ *
+ * @param partition
+ * @param edits
+ * @param factory
+ * @param offset
+ */
+ private void handleFirstPartition(ITypedRegion partition, List edits, Edit.EditFactory factory, int offset)
+ throws BadLocationException {
+
+ int partOffset = partition.getOffset();
+ String partType = partition.getType();
+
+ Assert.isTrue(partOffset <= offset, "illegal partition"); //$NON-NLS-1$
+
+ // first partition: mark start of comment
+ if (partType == IDocument.DEFAULT_CONTENT_TYPE ||
+ partType == PHPDocumentPartitioner.PHP_SCRIPT_CODE) {
+ // Java code: right where selection starts
+ edits.add(factory.createEdit(offset, 0, getCommentStart()));
+ } else if (isSpecialPartition(partType)) {
+ // special types: include the entire partition
+ edits.add(factory.createEdit(partOffset, 0, getCommentStart()));
+ } // javadoc: no mark, will only start after comment
+
+ }
+
+ /**
+ * Handles the end of the given partition and the start of the next partition, which is returned.
+ *
+ * @param partition
+ * @param edits
+ * @param factory
+ * @param docExtension
+ * @return
+ * @throws BadLocationException
+ * @throws BadPartitioningException
+ */
+ private ITypedRegion handleInteriorPartition(ITypedRegion partition, List edits, Edit.EditFactory factory,
+ IDocumentExtension3 docExtension) throws BadPartitioningException, BadLocationException {
+
+ // end of previous partition
+ String partType = partition.getType();
+ int partEndOffset = partition.getOffset() + partition.getLength();
+ int tokenLength = getCommentStart().length();
+
+ boolean wasJavadoc = false; // true if the previous partition is javadoc
+
+ if (partType == IPHPPartitions.PHP_PHPDOC_COMMENT) {
+
+ wasJavadoc = true;
+
+ } else if (partType == IPHPPartitions.PHP_MULTILINE_COMMENT) {
+
+ // already in a comment - remove ending mark
+ edits.add(factory.createEdit(partEndOffset - tokenLength, tokenLength, "")); //$NON-NLS-1$
+
+ }
+
+ // advance to next partition
+ partition = docExtension.getPartition(IPHPPartitions.PHP_PARTITIONING, partEndOffset, false);
+ partType = partition.getType();
+
+ // start of next partition
+ if (wasJavadoc) {
+
+ // if previous was javadoc, and the current one is not, then add block comment start
+ if (partType == IDocument.DEFAULT_CONTENT_TYPE ||
+ partType == PHPDocumentPartitioner.PHP_SCRIPT_CODE ||
+ isSpecialPartition(partType)) {
+ edits.add(factory.createEdit(partition.getOffset(), 0, getCommentStart()));
+ }
+
+ } else { // !wasJavadoc
+
+ if (partType == IPHPPartitions.PHP_PHPDOC_COMMENT) {
+ // if next is javadoc, end block comment before
+ edits.add(factory.createEdit(partition.getOffset(), 0, getCommentEnd()));
+ } else if (partType == IPHPPartitions.PHP_MULTILINE_COMMENT) {
+ // already in a comment - remove startToken
+ edits.add(factory.createEdit(partition.getOffset(), getCommentStart().length(), "")); //$NON-NLS-1$
+ }
+ }
+
+ return partition;
+ }
+
+ /**
+ * Handles the end of the last partition.
+ *
+ * @param partition
+ * @param edits
+ * @param factory
+ * @param endOffset
+ */
+ private void handleLastPartition(ITypedRegion partition, List edits, Edit.EditFactory factory, int endOffset)
+ throws BadLocationException {
+
+ String partType = partition.getType();
+
+ if (partType == IDocument.DEFAULT_CONTENT_TYPE ||
+ partType == PHPDocumentPartitioner.PHP_SCRIPT_CODE) {
+ // normal java: end comment where selection ends
+ edits.add(factory.createEdit(endOffset, 0, getCommentEnd()));
+ } else if (isSpecialPartition(partType)) {
+ // special types: consume entire partition
+ edits.add(factory.createEdit(partition.getOffset() + partition.getLength(), 0, getCommentEnd()));
+ }
+
+ }
+
+ /**
+ * Returns whether <code>partType</code> is special, i.e. a Java <code>String</code>,<code>Character</code>, or
+ * <code>Line End Comment</code> partition.
+ *
+ * @param partType
+ * the partition type to check
+ * @return <code>true</code> if <code>partType</code> is special, <code>false</code> otherwise
+ */
+ private boolean isSpecialPartition(String partType) {
+ // return partType == IJavaPartitions.JAVA_CHARACTER
+ return partType == IPHPPartitions.PHP_STRING_DQ || partType == IPHPPartitions.PHP_STRING_SQ || partType == IPHPPartitions.PHP_STRING_HEREDOC
+ || partType == IPHPPartitions.PHP_SINGLELINE_COMMENT;
+ }
+
+ /*
+ * @see net.sourceforge.phpdt.internal.ui.actions.BlockCommentAction#validSelection(org.eclipse.jface.text.ITextSelection)
+ */
+ protected boolean isValidSelection(ITextSelection selection) {
+ return selection != null && !selection.isEmpty() && selection.getLength() > 0;
+ }
+
+}
\ No newline at end of file
git://git.phpeclipse.com / phpeclipse.git / blobdiff