/jEdit/tags/jedit-4-1-pre5/org/gjt/sp/jedit/Buffer.java
Java | 2986 lines | 1721 code | 377 blank | 888 comment | 362 complexity | ab41d57e7f11db1b29666860e549e327 MD5 | raw file
Possible License(s): BSD-3-Clause, AGPL-1.0, Apache-2.0, LGPL-2.0, LGPL-3.0, GPL-2.0, CC-BY-SA-3.0, LGPL-2.1, GPL-3.0, MPL-2.0-no-copyleft-exception, IPL-1.0
- /*
- * Buffer.java - jEdit buffer
- * :tabSize=8:indentSize=8:noTabs=false:
- * :folding=explicit:collapseFolds=1:
- *
- * Copyright (C) 1998, 1999, 2000, 2001, 2002 Slava Pestov
- * Portions copyright (C) 1999, 2000 mike dillon
- *
- * This program is free software; you can redistribute it and/or
- * modify it under the terms of the GNU General Public License
- * as published by the Free Software Foundation; either version 2
- * of the License, or any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
- */
- package org.gjt.sp.jedit;
- //{{{ Imports
- import gnu.regexp.*;
- import javax.swing.*;
- import javax.swing.event.*;
- import javax.swing.text.*;
- import java.awt.Toolkit;
- import java.io.File;
- import java.util.*;
- import org.gjt.sp.jedit.browser.VFSBrowser;
- import org.gjt.sp.jedit.buffer.*;
- import org.gjt.sp.jedit.io.*;
- import org.gjt.sp.jedit.msg.*;
- import org.gjt.sp.jedit.search.RESearchMatcher;
- import org.gjt.sp.jedit.syntax.*;
- import org.gjt.sp.jedit.textarea.*;
- import org.gjt.sp.util.*;
- //}}}
- /**
- * An in-memory copy of an open file.
- *
- * This class is partially thread-safe, however you must pay attention to a few
- * very important issues:
- * <ul>
- * <li>Changes to a buffer can only be made from the AWT thread.
- * <li>When accessing the buffer from another thread, you must
- * grab a read lock if you plan on performing more than one call, to ensure that
- * the buffer contents are not changed by the AWT thread for the duration of the
- * lock.
- * <li>
- *
- * @author Slava Pestov
- * @version $Id: Buffer.java 4342 2002-09-20 19:53:23Z spestov $
- */
- public class Buffer implements EBComponent
- {
- //{{{ Some constants
- /**
- * Line separator property.
- */
- public static final String LINESEP = "lineSeparator";
- /**
- * Backed up property.
- * @since jEdit 3.2pre2
- */
- public static final String BACKED_UP = "Buffer__backedUp";
- /**
- * Caret info properties.
- * @since jEdit 3.2pre1
- */
- public static final String CARET = "Buffer__caret";
- public static final String SELECTION = "Buffer__selection";
- /**
- * This should be a physical line number, so that the scroll
- * position is preserved correctly across reloads (which will
- * affect virtual line numbers, due to fold being reset)
- */
- public static final String SCROLL_VERT = "Buffer__scrollVert";
- public static final String SCROLL_HORIZ = "Buffer__scrollHoriz";
- /**
- * Character encoding used when loading and saving.
- * @since jEdit 3.2pre4
- */
- public static final String ENCODING = "encoding";
- /**
- * This property is set to 'true' if the file has a trailing newline.
- * @since jEdit 4.0pre1
- */
- public static final String TRAILING_EOL = "trailingEOL";
- /**
- * This property is set to 'true' if the file should be GZipped.
- * @since jEdit 4.0pre4
- */
- public static final String GZIPPED = "gzipped";
- //}}}
- //{{{ Input/output methods
- //{{{ showInsertFileDialog() method
- /**
- * Displays the 'insert file' dialog box and inserts the selected file
- * into the buffer.
- * @param view The view
- * @since jEdit 2.7pre2
- */
- public void showInsertFileDialog(View view)
- {
- String[] files = GUIUtilities.showVFSFileDialog(view,null,
- VFSBrowser.OPEN_DIALOG,false);
- if(files != null)
- insertFile(view,files[0]);
- } //}}}
- //{{{ reload() method
- /**
- * Reloads the buffer from disk, asking for confirmation if the buffer
- * is dirty.
- * @param view The view
- * @since jEdit 2.7pre2
- */
- public void reload(View view)
- {
- if(getFlag(DIRTY))
- {
- String[] args = { name };
- int result = GUIUtilities.confirm(view,"changedreload",
- args,JOptionPane.YES_NO_OPTION,
- JOptionPane.WARNING_MESSAGE);
- if(result != JOptionPane.YES_OPTION)
- return;
- }
- view.getEditPane().saveCaretInfo();
- load(view,true);
- } //}}}
- //{{{ load() method
- /**
- * Loads the buffer from disk, even if it is loaded already.
- * @param view The view
- * @param reload If true, user will not be asked to recover autosave
- * file, if any
- *
- * @since 2.5pre1
- */
- public boolean load(final View view, final boolean reload)
- {
- if(isPerformingIO())
- {
- GUIUtilities.error(view,"buffer-multiple-io",null);
- return false;
- }
- setBooleanProperty(BufferIORequest.ERROR_OCCURRED,false);
- setFlag(LOADING,true);
- // view text areas temporarily blank out while a buffer is
- // being loaded, to indicate to the user that there is no
- // data available yet.
- if(!getFlag(TEMPORARY))
- EditBus.send(new BufferUpdate(this,view,BufferUpdate.LOAD_STARTED));
- final boolean loadAutosave;
- if(reload || !getFlag(NEW_FILE))
- {
- if(file != null)
- modTime = file.lastModified();
- // Only on initial load
- if(!reload && autosaveFile != null && autosaveFile.exists())
- loadAutosave = recoverAutosave(view);
- else
- {
- if(autosaveFile != null)
- autosaveFile.delete();
- loadAutosave = false;
- }
- if(!loadAutosave)
- {
- // this returns false if initial sanity
- // checks (if the file is a directory, etc)
- // fail
- if(!vfs.load(view,this,path))
- {
- setFlag(LOADING,false);
- return false;
- }
- }
- }
- else
- loadAutosave = false;
- //{{{ Do some stuff once loading is finished
- Runnable runnable = new Runnable()
- {
- public void run()
- {
- String newPath = getStringProperty(
- BufferIORequest.NEW_PATH);
- Segment seg = (Segment)getProperty(
- BufferIORequest.LOAD_DATA);
- IntegerArray endOffsets = (IntegerArray)
- getProperty(BufferIORequest.END_OFFSETS);
- // below remove() call only works if read only
- // is false. this is a slightly silly workaround.
- boolean readOnly = isReadOnly();
- setFlag(READ_ONLY,false);
- // For `reload' command
- remove(0,getLength());
- if(seg != null && endOffsets != null)
- {
- // This is faster than Buffer.insert()
- try
- {
- writeLock();
- // theoretically a segment could
- // have seg.offset != 0 but
- // SegmentBuffer never does that
- contentMgr._setContent(seg.array,seg.count);
- contentInserted(0,seg.count,endOffsets);
- }
- catch(OutOfMemoryError oom)
- {
- Log.log(Log.ERROR,this,oom);
- VFSManager.error(view,path,"out-of-memory-error",null);
- }
- finally
- {
- writeUnlock();
- }
- }
- setFlag(READ_ONLY,readOnly);
- unsetProperty(BufferIORequest.LOAD_DATA);
- unsetProperty(BufferIORequest.END_OFFSETS);
- unsetProperty(BufferIORequest.NEW_PATH);
- undoMgr.clear();
- undoMgr.setLimit(jEdit.getIntegerProperty(
- "buffer.undoCount",100));
- if(!getFlag(TEMPORARY))
- finishLoading();
- /* Ultra-obscure: we have to fire this event
- * after the buffer might have been collapsed
- * by finishLoading(), since finishLoading(),
- * unlike "official" fold APIs, does not notify
- * the text area to invalidate its cached
- * virtual to physical information. Note that
- * the text area's contentInserted() handler
- * updates 'lastPhysLine' even if the LOADING
- * flag is set. */
- fireContentInserted(0,0,getLineCount(),getLength() - 1);
- setFlag(LOADING,false);
- // if reloading a file, clear dirty flag
- if(reload)
- setDirty(false);
- if(!loadAutosave && newPath != null && !path.equals(newPath))
- setPath(newPath);
- // if loadAutosave is false, we loaded an
- // autosave file, so we set 'dirty' to true
- // note that we don't use setDirty(),
- // because a) that would send an unnecessary
- // message, b) it would also set the
- // AUTOSAVE_DIRTY flag, which will make
- // the autosave thread write out a
- // redundant autosave file
- if(loadAutosave)
- setFlag(DIRTY,true);
- // send some EditBus messages
- if(!getFlag(TEMPORARY))
- {
- EditBus.send(new BufferUpdate(Buffer.this,
- view,BufferUpdate.LOADED));
- //EditBus.send(new BufferUpdate(Buffer.this,
- // view,BufferUpdate.MARKERS_CHANGED));
- }
- }
- }; //}}}
- if(getFlag(TEMPORARY))
- runnable.run();
- else
- VFSManager.runInAWTThread(runnable);
- return true;
- } //}}}
- //{{{ insertFile() method
- /**
- * Loads a file from disk, and inserts it into this buffer.
- * @param view The view
- *
- * @since 4.0pre1
- */
- public boolean insertFile(final View view, String path)
- {
- if(isPerformingIO())
- {
- GUIUtilities.error(view,"buffer-multiple-io",null);
- return false;
- }
- setBooleanProperty(BufferIORequest.ERROR_OCCURRED,false);
- path = MiscUtilities.constructPath(this.path,path);
- Buffer buffer = jEdit.getBuffer(path);
- if(buffer != null)
- {
- view.getTextArea().setSelectedText(
- buffer.getText(0,buffer.getLength()));
- return true;
- }
- VFS vfs = VFSManager.getVFSForPath(path);
- setFlag(IO,true);
- // this returns false if initial sanity
- // checks (if the file is a directory, etc)
- // fail
- if(!vfs.insert(view,this,path))
- {
- setFlag(IO,false);
- return false;
- }
- // Do some stuff once loading is finished
- VFSManager.runInAWTThread(new Runnable()
- {
- public void run()
- {
- setFlag(IO,false);
- SegmentBuffer sbuf = (SegmentBuffer)getProperty(
- BufferIORequest.LOAD_DATA);
- if(sbuf != null)
- {
- unsetProperty(BufferIORequest.LOAD_DATA);
- view.getTextArea().setSelectedText(sbuf.toString());
- }
- }
- });
- return true;
- } //}}}
- //{{{ autosave() method
- /**
- * Autosaves this buffer.
- */
- public void autosave()
- {
- if(autosaveFile == null || !getFlag(AUTOSAVE_DIRTY)
- || !getFlag(DIRTY)
- || getFlag(LOADING)
- || getFlag(IO))
- return;
- setFlag(AUTOSAVE_DIRTY,false);
- VFSManager.runInWorkThread(new BufferIORequest(
- BufferIORequest.AUTOSAVE,null,this,null,
- VFSManager.getFileVFS(),autosaveFile.getPath()));
- } //}}}
- //{{{ saveAs() method
- /**
- * Prompts the user for a file to save this buffer to.
- * @param view The view
- * @param rename True if the buffer's path should be changed, false
- * if only a copy should be saved to the specified filename
- * @since jEdit 2.6pre5
- */
- public boolean saveAs(View view, boolean rename)
- {
- String[] files = GUIUtilities.showVFSFileDialog(view,path,
- VFSBrowser.SAVE_DIALOG,false);
- // files[] should have length 1, since the dialog type is
- // SAVE_DIALOG
- if(files == null)
- return false;
- return save(view,files[0],rename);
- } //}}}
- //{{{ save() method
- /**
- * Saves this buffer to the specified path name, or the current path
- * name if it's null.
- * @param view The view
- * @param path The path name to save the buffer to, or null to use
- * the existing path
- */
- public boolean save(View view, String path)
- {
- return save(view,path,true);
- } //}}}
- //{{{ save() method
- /**
- * Saves this buffer to the specified path name, or the current path
- * name if it's null.
- * @param view The view
- * @param path The path name to save the buffer to, or null to use
- * the existing path
- * @param rename True if the buffer's path should be changed, false
- * if only a copy should be saved to the specified filename
- * @since jEdit 2.6pre5
- */
- public boolean save(final View view, String path, final boolean rename)
- {
- if(isPerformingIO())
- {
- GUIUtilities.error(view,"buffer-multiple-io",null);
- return false;
- }
- setBooleanProperty(BufferIORequest.ERROR_OCCURRED,false);
- if(path == null && getFlag(NEW_FILE))
- return saveAs(view,rename);
- if(path == null && file != null)
- {
- long newModTime = file.lastModified();
- if(newModTime != modTime
- && jEdit.getBooleanProperty("view.checkModStatus"))
- {
- Object[] args = { this.path };
- int result = GUIUtilities.confirm(view,
- "filechanged-save",args,
- JOptionPane.YES_NO_OPTION,
- JOptionPane.WARNING_MESSAGE);
- if(result != JOptionPane.YES_OPTION)
- return false;
- }
- }
- setFlag(IO,true);
- EditBus.send(new BufferUpdate(this,view,BufferUpdate.SAVING));
- final String oldPath = this.path;
- final String newPath = (path == null ? this.path : path);
- VFS vfs = VFSManager.getVFSForPath(newPath);
- if(!vfs.save(view,this,newPath))
- {
- setFlag(IO,false);
- return false;
- }
- // Once save is complete, do a few other things
- VFSManager.runInAWTThread(new Runnable()
- {
- public void run()
- {
- setFlag(IO,false);
- finishSaving(view,oldPath,newPath,rename,
- getBooleanProperty(BufferIORequest
- .ERROR_OCCURRED));
- }
- });
- return true;
- } //}}}
- //{{{ checkFileStatus() method
- public static final int FILE_NOT_CHANGED = 0;
- public static final int FILE_CHANGED = 1;
- public static final int FILE_DELETED = 2;
- /**
- * Check if the buffer has changed on disk.
- * @return One of <code>NOT_CHANGED</code>, <code>CHANGED</code>, or
- * <code>DELETED</code>.
- *
- * @since jEdit 4.1pre3
- */
- public int checkFileStatus()
- {
- // - don't do these checks while a save is in progress,
- // because for a moment newModTime will be greater than
- // oldModTime, due to the multithreading
- // - only supported on local file system
- if(!getFlag(IO) && !getFlag(LOADING) && file != null)
- {
- boolean newReadOnly = (file.exists() && !file.canWrite());
- if(newReadOnly != getFlag(READ_ONLY))
- {
- setFlag(READ_ONLY,newReadOnly);
- EditBus.send(new BufferUpdate(this,null,
- BufferUpdate.DIRTY_CHANGED));
- }
- long oldModTime = modTime;
- long newModTime = file.lastModified();
- if(newModTime != oldModTime)
- {
- modTime = newModTime;
- if(!file.exists())
- {
- setFlag(NEW_FILE,true);
- EditBus.send(new BufferUpdate(this,null,
- BufferUpdate.DIRTY_CHANGED));
- return FILE_DELETED;
- }
- else
- return FILE_CHANGED;
- }
- }
- return FILE_NOT_CHANGED;
- } //}}}
- //{{{ checkModTime() method
- /**
- * Check if the buffer has changed on disk.
- */
- public void checkModTime(View view)
- {
- int status = checkFileStatus();
- // still need to call the status check even if this option is off,
- // so that the write protection is updated if it changes on disk
- if(!jEdit.getBooleanProperty("view.checkModStatus"))
- return;
- if(status == FILE_DELETED)
- {
- Object[] args = { path };
- GUIUtilities.message(view,"filedeleted",args);
- }
- else if(status == FILE_CHANGED)
- {
- String prop = (isDirty() ? "filechanged-dirty"
- : "filechanged-focus");
- Object[] args = { path };
- int result = GUIUtilities.confirm(view,
- prop,args,JOptionPane.YES_NO_OPTION,
- JOptionPane.WARNING_MESSAGE);
- if(result == JOptionPane.YES_OPTION)
- {
- view.getEditPane().saveCaretInfo();
- load(view,true);
- }
- }
- } //}}}
- //}}}
- //{{{ Getters/setter methods for various buffer meta-data
- //{{{ getLastModified() method
- /**
- * Returns the last time jEdit modified the file on disk.
- */
- public long getLastModified()
- {
- return modTime;
- } //}}}
- //{{{ setLastModified() method
- /**
- * Sets the last time jEdit modified the file on disk.
- * @param modTime The new modification time
- */
- public void setLastModified(long modTime)
- {
- this.modTime = modTime;
- } //}}}
- //{{{ getVFS() method
- /**
- * Returns the virtual filesystem responsible for loading and
- * saving this buffer.
- */
- public VFS getVFS()
- {
- return vfs;
- } //}}}
- //{{{ getAutosaveFile() method
- /**
- * Returns the autosave file for this buffer. This may be null if
- * the file is non-local.
- */
- public final File getAutosaveFile()
- {
- return autosaveFile;
- } //}}}
- //{{{ getName() method
- /**
- * Returns the name of this buffer.
- */
- public final String getName()
- {
- return name;
- } //}}}
- //{{{ getPath() method
- /**
- * Returns the path name of this buffer.
- */
- public final String getPath()
- {
- return path;
- } //}}}
- //{{{ isClosed() method
- /**
- * Returns true if this buffer has been closed with
- * <code>jEdit.closeBuffer()</code>.
- */
- public final boolean isClosed()
- {
- return getFlag(CLOSED);
- } //}}}
- //{{{ isLoaded() method
- /**
- * Returns true if the buffer is loaded.
- */
- public final boolean isLoaded()
- {
- return !getFlag(LOADING);
- } //}}}
- //{{{ isPerformingIO() method
- /**
- * Returns true if the buffer is currently performing I/O.
- * @since jEdit 2.7pre1
- */
- public final boolean isPerformingIO()
- {
- return getFlag(LOADING) || getFlag(IO);
- } //}}}
- //{{{ isNewFile() method
- /**
- * Returns true if this file doesn't exist on disk.
- */
- public final boolean isNewFile()
- {
- return getFlag(NEW_FILE);
- } //}}}
- //{{{ setNewFile() method
- /**
- * Sets the new file flag.
- * @param newFile The new file flag
- */
- public final void setNewFile(boolean newFile)
- {
- setFlag(NEW_FILE,newFile);
- if(!newFile)
- setFlag(UNTITLED,false);
- } //}}}
- //{{{ isUntitled() method
- /**
- * Returns true if this file is 'untitled'.
- */
- public final boolean isUntitled()
- {
- return getFlag(UNTITLED);
- } //}}}
- //{{{ isDirty() method
- /**
- * Returns true if this file has changed since last save, false
- * otherwise.
- */
- public final boolean isDirty()
- {
- return getFlag(DIRTY);
- } //}}}
- //{{{ isReadOnly() method
- /**
- * Returns true if this file is read only, false otherwise.
- */
- public final boolean isReadOnly()
- {
- return getFlag(READ_ONLY);
- } //}}}
- //{{{ isEditable() method
- /**
- * Returns true if this file is editable, false otherwise.
- * @since jEdit 2.7pre1
- */
- public final boolean isEditable()
- {
- return !(getFlag(READ_ONLY) || getFlag(IO) || getFlag(LOADING));
- } //}}}
- //{{{ isReadOnly() method
- /**
- * Sets the read only flag.
- * @param readOnly The read only flag
- */
- public final void setReadOnly(boolean readOnly)
- {
- setFlag(READ_ONLY,readOnly);
- } //}}}
- //{{{ setDirty() method
- /**
- * Sets the `dirty' (changed since last save) flag of this buffer.
- */
- public void setDirty(boolean d)
- {
- boolean old_d = getFlag(DIRTY);
- if(d)
- {
- if(getFlag(LOADING) || getFlag(READ_ONLY))
- return;
- if(getFlag(DIRTY) && getFlag(AUTOSAVE_DIRTY))
- return;
- setFlag(DIRTY,true);
- setFlag(AUTOSAVE_DIRTY,true);
- }
- else
- {
- setFlag(DIRTY,false);
- setFlag(AUTOSAVE_DIRTY,false);
- // this ensures that undo can clear the dirty flag properly
- // when all edits up to a save are undone
- undoMgr.bufferSaved();
- }
- if(d != old_d)
- {
- EditBus.send(new BufferUpdate(this,null,
- BufferUpdate.DIRTY_CHANGED));
- }
- } //}}}
- //{{{ isTemporary() method
- /**
- * Returns if this is a temporary buffer.
- * @see jEdit#openTemporary(View,String,String,boolean)
- * @see jEdit#commitTemporary(Buffer)
- * @since jEdit 2.2pre7
- */
- public boolean isTemporary()
- {
- return getFlag(TEMPORARY);
- } //}}}
- //{{{ getIcon() method
- /**
- * Returns this buffer's icon.
- * @since jEdit 2.6pre6
- */
- public Icon getIcon()
- {
- if(getFlag(DIRTY))
- return GUIUtilities.DIRTY_BUFFER_ICON;
- else if(getFlag(READ_ONLY))
- return GUIUtilities.READ_ONLY_BUFFER_ICON;
- else if(getFlag(NEW_FILE))
- return GUIUtilities.NEW_BUFFER_ICON;
- else
- return GUIUtilities.NORMAL_BUFFER_ICON;
- } //}}}
- //}}}
- //{{{ Thread safety
- //{{{ readLock() method
- /**
- * The buffer is guaranteed not to change between calls to
- * <code>readLock()</code> and <code>readUnlock()</code>.
- */
- public final void readLock()
- {
- lock.readLock();
- } //}}}
- //{{{ readUnlock() method
- /**
- * The buffer is guaranteed not to change between calls to
- * <code>readLock()</code> and <code>readUnlock()</code>.
- */
- public final void readUnlock()
- {
- lock.readUnlock();
- } //}}}
- //{{{ writeLock() method
- /**
- * The buffer cintents are guaranteed not to be read or written
- * by other threads between calls to <code>writeLock()</code>
- * and <code>writeUnlock()</code>.
- */
- public final void writeLock()
- {
- lock.writeLock();
- } //}}}
- //{{{ writeUnlock() method
- /**
- * The buffer cintents are guaranteed not to be read or written
- * by other threads between calls to <code>writeLock()</code>
- * and <code>writeUnlock()</code>.
- */
- public final void writeUnlock()
- {
- lock.writeUnlock();
- } //}}}
- //}}}
- //{{{ Line offset methods
- //{{{ getLength() method
- /**
- * Returns the number of characters in the buffer.
- */
- public int getLength()
- {
- // no need to lock since this just returns a value and that's it
- return contentMgr.getLength();
- } //}}}
- //{{{ getLineCount() method
- /**
- * Returns the number of physical lines in the buffer.
- * This method is thread-safe.
- * @since jEdit 3.1pre1
- */
- public int getLineCount()
- {
- // no need to lock since this just returns a value and that's it
- return offsetMgr.getLineCount();
- } //}}}
- //{{{ getLineOfOffset() method
- /**
- * Returns the line containing the specified offset.
- * This method is thread-safe.
- * @param offset The offset
- * @since jEdit 4.0pre1
- */
- public final int getLineOfOffset(int offset)
- {
- try
- {
- readLock();
- if(offset < 0 || offset > getLength())
- throw new ArrayIndexOutOfBoundsException(offset);
- return offsetMgr.getLineOfOffset(offset);
- }
- finally
- {
- readUnlock();
- }
- } //}}}
- //{{{ getLineStartOffset() method
- /**
- * Returns the start offset of the specified line.
- * This method is thread-safe.
- * @param line The line
- * @return The start offset of the specified line
- * @since jEdit 4.0pre1
- */
- public int getLineStartOffset(int line)
- {
- try
- {
- readLock();
- if(line < 0 || line >= offsetMgr.getLineCount())
- throw new ArrayIndexOutOfBoundsException(line);
- else if(line == 0)
- return 0;
- return offsetMgr.getLineEndOffset(line - 1);
- }
- finally
- {
- readUnlock();
- }
- } //}}}
- //{{{ getLineEndOffset() method
- /**
- * Returns the end offset of the specified line.
- * This method is thread-safe.
- * @param line The line
- * @return The end offset of the specified line
- * invalid.
- * @since jEdit 4.0pre1
- */
- public int getLineEndOffset(int line)
- {
- try
- {
- readLock();
- if(line < 0 || line >= offsetMgr.getLineCount())
- throw new ArrayIndexOutOfBoundsException(line);
- return offsetMgr.getLineEndOffset(line);
- }
- finally
- {
- readUnlock();
- }
- } //}}}
- //{{{ getLineLength() method
- /**
- * Returns the length of the specified line.
- * This method is thread-safe.
- * @param line The line
- * @since jEdit 4.0pre1
- */
- public int getLineLength(int line)
- {
- try
- {
- readLock();
- return getLineEndOffset(line)
- - getLineStartOffset(line) - 1;
- }
- finally
- {
- readUnlock();
- }
- } //}}}
- //}}}
- //{{{ Text getters are setters
- //{{{ getLineText() method
- /**
- * Returns the text on the specified line.
- * This method is thread-safe.
- * @param lineIndex The line
- * @return The text, or null if the line is invalid
- * @since jEdit 4.0pre1
- */
- public String getLineText(int lineIndex)
- {
- try
- {
- readLock();
- return getText(getLineStartOffset(lineIndex),
- getLineLength(lineIndex));
- }
- finally
- {
- readUnlock();
- }
- } //}}}
- //{{{ getLineText() method
- /**
- * Copies the text on the specified line into a segment.
- * This method is thread-safe.
- * @param lineIndex The line
- * @since jEdit 4.0pre1
- */
- public void getLineText(int lineIndex, Segment segment)
- {
- try
- {
- readLock();
- getText(getLineStartOffset(lineIndex),
- getLineLength(lineIndex),segment);
- }
- finally
- {
- readUnlock();
- }
- } //}}}
- //{{{ getText() method
- /**
- * Returns the specified text range.
- * @param start The start offset
- * @param length The number of characters to get
- */
- public String getText(int start, int length)
- {
- try
- {
- readLock();
- if(start < 0 || length < 0
- || start + length > contentMgr.getLength())
- throw new ArrayIndexOutOfBoundsException(start + ":" + length);
- return contentMgr.getText(start,length);
- }
- finally
- {
- readUnlock();
- }
- } //}}}
- //{{{ getText() method
- /**
- * Returns the specified text range.
- * @param start The start offset
- * @param length The number of characters to get
- * @param seg The segment to copy the text to
- */
- public void getText(int start, int length, Segment seg)
- {
- try
- {
- readLock();
- if(start < 0 || length < 0
- || start + length > contentMgr.getLength())
- throw new ArrayIndexOutOfBoundsException(start + ":" + length);
- contentMgr.getText(start,length,seg);
- }
- finally
- {
- readUnlock();
- }
- } //}}}
- //{{{ insert() method
- /**
- * Inserts a string into the buffer.
- * @param offset The offset
- * @param str The string
- * @since jEdit 4.0pre1
- */
- public void insert(int offset, String str)
- {
- if(str == null || str.length() == 0)
- return;
- if(isReadOnly())
- throw new RuntimeException("buffer read-only");
- try
- {
- writeLock();
- if(offset < 0 || offset > contentMgr.getLength())
- throw new ArrayIndexOutOfBoundsException(offset);
- contentMgr.insert(offset,str);
- integerArray.clear();
- for(int i = 0; i < str.length(); i++)
- {
- if(str.charAt(i) == '\n')
- integerArray.add(i);
- }
- if(!getFlag(UNDO_IN_PROGRESS))
- {
- undoMgr.contentInserted(offset,str.length(),str,
- !getFlag(DIRTY));
- }
- contentInserted(offset,str.length(),integerArray);
- }
- finally
- {
- writeUnlock();
- }
- } //}}}
- //{{{ insert() method
- /**
- * Inserts a string into the buffer.
- * @param offset The offset
- * @param seg The segment
- * @since jEdit 4.0pre1
- */
- public void insert(int offset, Segment seg)
- {
- if(seg.count == 0)
- return;
- if(isReadOnly())
- throw new RuntimeException("buffer read-only");
- try
- {
- writeLock();
- if(offset < 0 || offset > contentMgr.getLength())
- throw new ArrayIndexOutOfBoundsException(offset);
- contentMgr.insert(offset,seg);
- integerArray.clear();
- for(int i = 0; i < seg.count; i++)
- {
- if(seg.array[seg.offset + i] == '\n')
- integerArray.add(i);
- }
- if(!getFlag(UNDO_IN_PROGRESS))
- {
- undoMgr.contentInserted(offset,seg.count,
- seg.toString(),!getFlag(DIRTY));
- }
- contentInserted(offset,seg.count,integerArray);
- }
- finally
- {
- writeUnlock();
- }
- } //}}}
- //{{{ remove() method
- /**
- * Removes the specified rang efrom the buffer.
- * @param offset The start offset
- * @param length The number of characters to remove
- */
- public void remove(int offset, int length)
- {
- if(length == 0)
- return;
- if(isReadOnly())
- throw new RuntimeException("buffer read-only");
- try
- {
- writeLock();
- if(offset < 0 || length < 0
- || offset + length > contentMgr.getLength())
- throw new ArrayIndexOutOfBoundsException(offset + ":" + length);
- int startLine = offsetMgr.getLineOfOffset(offset);
- contentMgr.getText(offset,length,seg);
- int numLines = 0;
- for(int i = 0; i < seg.count; i++)
- {
- if(seg.array[seg.offset + i] == '\n')
- numLines++;
- }
- if(!getFlag(UNDO_IN_PROGRESS))
- {
- undoMgr.contentRemoved(offset,length,
- seg.toString(),!getFlag(DIRTY));
- }
- contentMgr.remove(offset,length);
- offsetMgr.contentRemoved(startLine,offset,numLines,length);
- if(numLines > 0)
- {
- for(int i = 0; i < inUseFVMs.length; i++)
- {
- if(inUseFVMs[i] != null)
- inUseFVMs[i]._invalidate(startLine);
- }
- }
- fireContentRemoved(startLine,offset,numLines,length);
- setDirty(true);
- }
- finally
- {
- writeUnlock();
- }
- } //}}}
- //}}}
- //{{{ Undo
- //{{{ undo() method
- /**
- * Undoes the most recent edit.
- *
- * @since jEdit 4.0pre1
- */
- public void undo(JEditTextArea textArea)
- {
- if(undoMgr == null)
- return;
- if(!isEditable())
- {
- textArea.getToolkit().beep();
- return;
- }
- try
- {
- writeLock();
- setFlag(UNDO_IN_PROGRESS,true);
- if(!undoMgr.undo(textArea))
- textArea.getToolkit().beep();
- fireTransactionComplete();
- }
- finally
- {
- setFlag(UNDO_IN_PROGRESS,false);
- writeUnlock();
- }
- } //}}}
- //{{{ redo() method
- /**
- * Redoes the most recently undone edit. Returns true if the redo was
- * successful.
- *
- * @since jEdit 2.7pre2
- */
- public void redo(JEditTextArea textArea)
- {
- if(undoMgr == null)
- return;
- if(!isEditable())
- {
- Toolkit.getDefaultToolkit().beep();
- return;
- }
- try
- {
- writeLock();
- setFlag(UNDO_IN_PROGRESS,true);
- if(!undoMgr.redo(textArea))
- textArea.getToolkit().beep();
- fireTransactionComplete();
- }
- finally
- {
- setFlag(UNDO_IN_PROGRESS,false);
- writeUnlock();
- }
- } //}}}
- //{{{ isTransactionInProgress() method
- /**
- * Returns if an undo or compound edit is currently in progress. If this
- * method returns true, then eventually a
- * <code>transactionComplete()</code> buffer event will get fired.
- * @since jEdit 4.0pre6
- */
- public boolean isTransactionInProgress()
- {
- return getFlag(UNDO_IN_PROGRESS) || insideCompoundEdit();
- } //}}}
- //{{{ beginCompoundEdit() method
- /**
- * Starts a compound edit. All edits from now on until
- * <code>endCompoundEdit()</code> are called will be merged
- * into one. This can be used to make a complex operation
- * undoable in one step. Nested calls to
- * <code>beginCompoundEdit()</code> behave as expected,
- * requiring the same number of <code>endCompoundEdit()</code>
- * calls to end the edit.
- * @see #endCompoundEdit()
- */
- public void beginCompoundEdit()
- {
- if(getFlag(TEMPORARY))
- return;
- try
- {
- writeLock();
- undoMgr.beginCompoundEdit();
- }
- finally
- {
- writeUnlock();
- }
- } //}}}
- //{{{ endCompoundEdit() method
- /**
- * Ends a compound edit. All edits performed since
- * <code>beginCompoundEdit()</code> was called can now
- * be undone in one step by calling <code>undo()</code>.
- * @see #beginCompoundEdit()
- */
- public void endCompoundEdit()
- {
- if(getFlag(TEMPORARY))
- return;
- try
- {
- writeLock();
- undoMgr.endCompoundEdit();
- fireTransactionComplete();
- }
- finally
- {
- writeUnlock();
- }
- }//}}}
- //{{{ insideCompoundEdit() method
- /**
- * Returns if a compound edit is currently active.
- * @since jEdit 3.1pre1
- */
- public boolean insideCompoundEdit()
- {
- return undoMgr.insideCompoundEdit();
- } //}}}
- //}}}
- //{{{ Buffer events
- //{{{ addBufferChangeListener() method
- /**
- * Adds a buffer change listener.
- * @param listener The listener
- * @since jEdit 4.0pre1
- */
- public void addBufferChangeListener(BufferChangeListener listener)
- {
- bufferListeners.addElement(listener);
- } //}}}
- //{{{ removeBufferChangeListener() method
- /**
- * Removes a buffer change listener.
- * @param listener The listener
- * @since jEdit 4.0pre1
- */
- public void removeBufferChangeListener(BufferChangeListener listener)
- {
- bufferListeners.removeElement(listener);
- } //}}}
- //{{{ getBufferChangeListeners() method
- /**
- * Returns an array of registered buffer change listeners.
- * @param listener The listener
- * @since jEdit 4.1pre3
- */
- public BufferChangeListener[] getBufferChangeListeners()
- {
- return (BufferChangeListener[])bufferListeners
- .toArray(new BufferChangeListener[
- bufferListeners.size()]);
- } //}}}
- //}}}
- //{{{ Property methods
- //{{{ propertiesChanged() method
- /**
- * Reloads settings from the properties. This should be called
- * after the <code>syntax</code> or <code>folding</code>
- * buffer-local properties are changed.
- */
- public void propertiesChanged()
- {
- // Need to reset properties that were cached defaults,
- // since the defaults might have changed.
- Iterator iter = properties.values().iterator();
- while(iter.hasNext())
- {
- PropValue value = (PropValue)iter.next();
- if(value.defaultValue)
- iter.remove();
- }
- textMode = "text".equals(mode.getName());
- setTokenMarker(mode.getTokenMarker());
- String folding = getStringProperty("folding");
- FoldHandler handler = FoldHandler.getFoldHandler(folding);
- if(handler != null)
- {
- setFoldHandler(handler);
- }
- else
- {
- if (folding != null)
- Log.log(Log.WARNING, this, path + ": invalid 'folding' property: " + folding);
- setFoldHandler(new DummyFoldHandler());
- }
- if(!isTemporary() && firstTimeDone)
- EditBus.send(new BufferUpdate(this,null,BufferUpdate.PROPERTIES_CHANGED));
- firstTimeDone = true;
- } //}}}
- //{{{ getTabSize() method
- /**
- * Returns the tab size used in this buffer. This is equivalent
- * to calling getProperty("tabSize").
- */
- public int getTabSize()
- {
- return getIntegerProperty("tabSize",8);
- } //}}}
- //{{{ getIndentSize() method
- /**
- * Returns the indent size used in this buffer. This is equivalent
- * to calling getProperty("indentSize").
- * @since jEdit 2.7pre1
- */
- public final int getIndentSize()
- {
- return getIntegerProperty("indentSize",8);
- } //}}}
- //{{{ getProperty() method
- /**
- * Returns the value of a buffer-local property.
- * @param name The property name. For backwards compatibility, this
- * is an <code>Object</code>, not a <code>String</code>.
- */
- public Object getProperty(Object name)
- {
- // First try the buffer-local properties
- PropValue o = (PropValue)properties.get(name);
- if(o != null)
- return o.value;
- // For backwards compatibility
- if(!(name instanceof String))
- return null;
- // Now try mode.<mode>.<property>
- if(mode != null)
- {
- Object retVal = mode.getProperty((String)name);
- if(retVal == null)
- return null;
- properties.put(name,new PropValue(retVal,true));
- return retVal;
- }
- else
- {
- // Now try buffer.<property>
- String value = jEdit.getProperty("buffer." + name);
- if(value == null)
- return null;
- // Try returning it as an integer first
- Object retVal;
- try
- {
- retVal = new Integer(value);
- }
- catch(NumberFormatException nf)
- {
- retVal = value;
- }
- properties.put(name,new PropValue(retVal,true));
- return retVal;
- }
- } //}}}
- //{{{ setProperty() method
- /**
- * Sets the value of a buffer-local property.
- * @param name The property name
- * @param value The property value
- * @since jEdit 4.0pre1
- */
- public void setProperty(String name, Object value)
- {
- if(value == null)
- properties.remove(name);
- else
- {
- PropValue test = (PropValue)properties.get(name);
- if(test == null)
- properties.put(name,new PropValue(value,false));
- else if(test.value.equals(value))
- {
- // do nothing
- }
- else
- {
- test.value = value;
- test.defaultValue = false;
- }
- }
- } //}}}
- //{{{ unsetProperty() method
- /**
- * Clears the value of a buffer-local property.
- * @param name The property name
- * @since jEdit 4.0pre1
- */
- public void unsetProperty(String name)
- {
- properties.remove(name);
- } //}}}
- //{{{ getStringProperty() method
- /**
- * Returns the value of a string property.
- * @param name The property name
- * @since jEdit 4.0pre1
- */
- public String getStringProperty(String name)
- {
- Object obj = getProperty(name);
- if(obj != null)
- return obj.toString();
- else
- return null;
- } //}}}
- //{{{ setStringProperty() method
- /**
- * Sets a string property.
- * @param name The property name
- * @param value The value
- * @since jEdit 4.0pre1
- */
- public void setStringProperty(String name, String value)
- {
- setProperty(name,value);
- } //}}}
- //{{{ getBooleanProperty() method
- /**
- * Returns the value of a boolean property.
- * @param name The property name
- * @since jEdit 4.0pre1
- */
- public boolean getBooleanProperty(String name)
- {
- Object obj = getProperty(name);
- if(obj instanceof Boolean)
- return ((Boolean)obj).booleanValue();
- else if("true".equals(obj) || "on".equals(obj) || "yes".equals(obj))
- return true;
- else
- return false;
- } //}}}
- //{{{ setBooleanProperty() method
- /**
- * Sets a boolean property.
- * @param name The property name
- * @param value The value
- * @since jEdit 4.0pre1
- */
- public void setBooleanProperty(String name, boolean value)
- {
- setProperty(name,value ? Boolean.TRUE : Boolean.FALSE);
- } //}}}
- //{{{ getIntegerProperty() method
- /**
- * Returns the value of an integer property.
- * @param name The property name
- * @since jEdit 4.0pre1
- */
- public int getIntegerProperty(String name, int defaultValue)
- {
- boolean defaultValueFlag;
- Object obj;
- PropValue value = (PropValue)properties.get(name);
- if(value != null)
- {
- obj = value.value;
- defaultValueFlag = value.defaultValue;
- }
- else
- {
- obj = getProperty(name);
- // will be cached from now on...
- defaultValueFlag = true;
- }
- if(obj == null)
- return defaultValue;
- else if(obj instanceof Number)
- return ((Number)obj).intValue();
- else
- {
- try
- {
- int returnValue = Integer.parseInt(
- obj.toString().trim());
- properties.put(name,new PropValue(
- new Integer(returnValue),
- defaultValueFlag));
- return returnValue;
- }
- catch(Exception e)
- {
- return defaultValue;
- }
- }
- } //}}}
- //{{{ setIntegerProperty() method
- /**
- * Sets an integer property.
- * @param name The property name
- * @param value The value
- * @since jEdit 4.0pre1
- */
- public void setIntegerProperty(String name, int value)
- {
- setProperty(name,new Integer(value));
- } //}}}
- //{{{ getRuleSetAtOffset() method
- /**
- * Returns the syntax highlighting ruleset at the specified offset.
- * @since jEdit 4.1pre1
- */
- public ParserRuleSet getRuleSetAtOffset(int offset)
- {
- int line = getLineOfOffset(offset);
- offset -= getLineStartOffset(line);
- if(offset != 0)
- offset--;
- DefaultTokenHandler tokens = new DefaultTokenHandler();
- markTokens(line,tokens);
- Token token = TextUtilities.getTokenAtOffset(tokens.getTokens(),offset);
- return token.rules;
- } //}}}
- //{{{ getKeywordMapAtOffset() method
- /**
- * Returns the syntax highlighting keyword map in effect at the
- * specified offset. Used by the <b>Complete Word</b> command to
- * complete keywords.
- * @param offset The offset
- * @since jEdit 4.0pre3
- */
- public KeywordMap getKeywordMapAtOffset(int offset)
- {
- return getRuleSetAtOffset(offset).getKeywords();
- } //}}}
- //{{{ getContextSensitiveProperty() method
- /**
- * Some settings, like comment start and end strings, can
- * vary between different parts of a buffer (HTML text and inline
- * JavaScript, for example).
- * @param offset The offset
- * @param name The property name
- * @since jEdit 4.0pre3
- */
- public String getContextSensitiveProperty(int offset, String name)
- {
- ParserRuleSet rules = getRuleSetAtOffset(offset);
- Object value = null;
- Hashtable rulesetProps = rules.getProperties();
- if(rulesetProps != null)
- value = rulesetProps.get(name);
- if(value == null)
- {
- value = rules.getMode().getProperty(name);
- if(value == null)
- value = mode.getProperty(name);
- }
- if(value == null)
- return null;
- else
- return String.valueOf(value);
- } //}}}
- //{{{ Used to store property values
- static class PropValue
- {
- PropValue(Object value, boolean defaultValue)
- {
- if(value == null)
- throw new NullPointerException();
- this.value = value;
- this.defaultValue = defaultValue;
- }
- Object value;
- /**
- * If this is true, then this value is cached from the mode
- * or global defaults, so when the defaults change this property
- * value must be reset.
- */
- boolean defaultValue;
- /**
- * For debugging purposes.
- */
- public String toString()
- {
- return value.toString();
- }
- } //}}}
- //{{{ toggleWordWrap() method
- /**
- * Toggles word wrap between the three available modes. This is used
- * by the status bar.
- * @param view We show a message in the view's status bar
- * @since jEdit 4.1pre3
- */
- public void toggleWordWrap(View view)
- {
- String wrap = getStringProperty("wrap");
- if(wrap.equals("none"))
- wrap = "soft";
- else if(wrap.equals("soft"))
- wrap = "hard";
- else if(wrap.equals("hard"))
- wrap = "none";
- view.getStatus().setMessageAndClear(jEdit.getProperty(
- "view.status.wrap-changed",new String[] {
- wrap }));
- setProperty("wrap",wrap);
- propertiesChanged();
- } //}}}
- //{{{ toggleLineSeparator() method
- /**
- * Toggles the line separator between the three available settings.
- * This is used by the status bar.
- * @param view We show a message in the view's status bar
- * @since jEdit 4.1pre3
- */
- public void toggleLineSeparator(View view)
- {
- String status = null;
- String lineSep = getStringProperty("lineSeparator");
- if("\n".equals(lineSep))
- {
- status = "windows";
- lineSep = "\r\n";
- }
- else if("\r\n".equals(lineSep))
- {
- status = "mac";
- lineSep = "\r";
- }
- else if("\r".equals(lineSep))
- {
- status = "unix";
- lineSep = "\n";
- }
- view.getStatus().setMessageAndClear(jEdit.getProperty(
- "view.status.linesep-changed",new String[] {
- jEdit.getProperty("lineSep." + status) }));
- setProperty("lineSeparator",lineSep);
- propertiesChanged();
- } //}}}
- //}}}
- //{{{ Edit modes, syntax highlighting
- //{{{ getMode() method
- /**
- * Returns this buffer's edit mode.
- */
- public final Mode getMode()
- {
- return mode;
- } //}}}
- //{{{ setMode() method
- /**
- * Sets this buffer's edit mode. Note that calling this before a buffer
- * is loaded will have no effect; in that case, set the "mode" property
- * to the name of the mode. A bit inelegant, I know...
- * @param mode The mode
- */
- public void setMode(Mode mode)
- {
- /* This protects against stupid people (like me)
- * doing stuff like buffer.setMode(jEdit.getMode(...)); */
- if(mode == null)
- throw new NullPointerException("Mode must be non-null");
- this.mode = mode;
- propertiesChanged(); // sets up token marker
- } //}}}
- //{{{ setMode() method
- /**
- * Sets this buffer's edit mode by calling the accept() method
- * of each registered edit mode.
- */
- public void setMode()
- {
- String userMode = getStringProperty("mode");
- if(userMode != null)
- {
- Mode m = jEdit.getMode(userMode);
- if(m != null)
- {
- setMode(m);
- return;
- }
- }
- String nogzName = name.substring(0,name.length() -
- (name.endsWith(".gz") ? 3 : 0));
- Mode[] modes = jEdit.getModes();
- String firstLine = getLineText(0);
- for(int i = 0; i < modes.length; i++)
- {
- if(modes[i].accept(nogzName,firstLine))
- {
- setMode(modes[i]);
- return;
- }
- }
- Mode defaultMode = jEdit.getMode(jEdit.getProperty("buffer.defaultMode"));
- if(defaultMode == null)
- defaultMode = jEdit.getMode("text");
- setMode(defaultMode);
- } //}}}
- //{{{ markTokens() method
- /**
- * Returns the syntax tokens for the specified line.
- * @param lineIndex The line number
- * @param tokenHandler The token handler that will receive the syntax
- * tokens
- * @since jEdit 4.1pre1
- */
- public void markTokens(int lineIndex, TokenHandler tokenHandler)
- {
- Segment seg;
- if(SwingUtilities.isEventDispatchThread())
- seg = this.seg;
- else
- seg = new Segment();
- try
- {
- writeLock();
- if(lineIndex < 0 || lineIndex >= offsetMgr.getLineCount())
- throw new ArrayIndexOutOfBoundsException(lineIndex);
- /*
- * Scan backwards, looking for a line with
- * a valid line context.
- */
- int start, end;
- if(textMode)
- {
- start = lineIndex;
- }
- else
- {
- start = 0;
- for(int i = lineIndex - 1; i >= 0; i--)
- {
- if(offsetMgr.isLineContextValid(i))
- {
- start = i;
- break;
- }
- }
- }
- for(int i = start; i <= lineIndex; i++)
- {
- getLineText(i,seg);
- TokenMarker.LineContext prevContext = (i == 0 ? null
- : offsetMgr.getLineContext(i - 1));
- TokenMarker.LineContext context = offsetMgr.getLineContext(i);
- ParserRule oldRule;
- ParserRuleSet oldRules;
- if(context == null)
- {
- oldRule = null;
- oldRules = null;
- }
- else
- {
- oldRule = context.inRule;
- oldRules = context.rules;
- }
- context = tokenMarker.markTokens(prevContext,
- (i == lineIndex ? tokenHandler
- : DummyTokenHandler.INSTANCE),seg);
- offsetMgr.setLineContext(i,context);
- // Could incorrectly be set to 'false' with
- // recursive delegates, where the chaining might
- // have changed but not the rule set in question (?)
- if(oldRule != context.inRule)
- nextLineRequested = true;
- else if(oldRules != context.rules)
- nextLineRequested = true;
- //else if(i != lastTokenizedLine)
- // nextLineRequested = false;
- }
- int lineCount = offsetMgr.getLineCount();
- if(nextLineRequested && lineCount - lineIndex > 1)
- {
- offsetMgr.lineInfoChangedFrom(lineIndex + 1);
- }
- }
- finally
- {
- writeUnlock();
- }
- } //}}}
- //{{{ isNextLineRequested() method
- /**
- * Returns true if the next line should be repainted. This
- * will return true after a line has been tokenized that starts
- * a multiline token that continues onto the next line.
- */
- public boolean isNextLineRequested()
- {
- boolean retVal = nextLineRequested;
- nextLineRequested = false;
- return retVal;
- } //}}}
- //{{{ getTokenMarker() method
- /**
- * This method is only public so that the <code>OffsetManager</code>
- * class can use it.
- * @since jEdit 4.0pre1
- */
- public TokenMarker getTokenMarker()
- {
- return tokenMarker;
- } //}}}
- //}}}
- //{{{ Indentation
- //{{{ removeTrailingWhiteSpace() method
- /**
- * Removes trailing whitespace from all lines in the specified list.
- * @param lines The line numbers
- * @since jEdit 3.2pre1
- */
- public void removeTrailingWhiteSpace(int[] lines)
- {
- try
- {
- beginCompoundEdit();
- for(int i = 0; i < lines.length; i++)
- {
- int pos, lineStart, lineEnd, tail;
- getLineText(lines[i],seg);
- // blank line
- if (seg.count == 0) continue;
- lineStart = seg.offset;
- lineEnd = seg.offset + seg.count - 1;
- for (pos = lineEnd; pos >= lineStart; pos--)
- {
- if (!Character.isWhitespace(seg.array[pos]))
- break;
- }
- tail = lineEnd - pos;
- // no whitespace
- if (tail == 0) continue;
- remove(getLineEndOffset(lines[i]) - 1 - tail,tail);
- }
- }
- finally
- {
- endCompoundEdit();
- }
- } //}}}
- //{{{ shiftIndentLeft() method
- /**
- * Shifts the indent of each line in the specified list to the left.
- * @param lines The line numbers
- * @since jEdit 3.2pre1
- */
- public void shiftIndentLeft(int[] lines)
- {
- int tabSize = getTabSize();
- int indentSize = getIndentSize();
- boolean noTabs = getBooleanProperty("noTabs");
- try
- {
- beginCompoundEdit();
- for(int i = 0; i < lines.length; i++)
- {
- int lineStart = getLineStartOffset(lines[i]);
- String line = getLineText(lines[i]);
- int whiteSpace = MiscUtilities
- .getLeadingWhiteSpace(line);
- if(whiteSpace == 0)
- continue;
- int whiteSpaceWidth = Math.max(0,MiscUtilities
- .getLeadingWhiteSpaceWidth(line,tabSize)
- - indentSize);
-
- insert(lineStart + whiteSpace,MiscUtilities
- .createWhiteSpace(whiteSpaceWidth,
- (noTabs ? 0 : tabSize)));
- remove(lineStart,whiteSpace);
- }
- }
- finally
- {
- endCompoundEdit();
- }
- } //}}}
- //{{{ shiftIndentRight() method
- /**
- * Shifts the indent of each line in the specified list to the right.
- * @param lines The line numbers
- * @since jEdit 3.2pre1
- */
- public void shiftIndentRight(int[] lines)
- {
- try
- {
- beginCompoundEdit();
- int tabSize = getTabSize();
- int indentSize = getIndentSize();
- boolean noTabs = getBooleanProperty("noTabs");
- for(int i = 0; i < lines.length; i++)
- {
- int lineStart = getLineStartOffset(lines[i]);
- String line = getLineText(lines[i]);
- int whiteSpace = MiscUtilities
- .getLeadingWhiteSpace(line);
- // silly usability hack
- //if(lines.length != 1 && whiteSpace == 0)
- // continue;
- int whiteSpaceWidth = MiscUtilities
- .getLeadingWhiteSpaceWidth(
- line,tabSize) + indentSize;
- insert(lineStart + whiteSpace,MiscUtilities
- .createWhiteSpace(whiteSpaceWidth,
- (noTabs ? 0 : tabSize)));
- remove(lineStart,whiteSpace);
- }
- }
- finally
- {
- endCompoundEdit();
- }
- } //}}}
- //{{{ indentLine() method
- /**
- * If auto indent is enabled, this method is called when the `Tab'
- * or `Enter' key is pressed to perform mode-specific indentation
- * and return true, or return false if a normal tab is to be inserted.
- * @param line The line number to indent
- * @param canIncreaseIndent If false, nothing will be done if the
- * calculated indent is greater than the current
- * @param canDecreaseIndent If false, nothing will be done if the
- * calculated indent is less than the current
- * @return true if the tab key event should be swallowed (ignored)
- * false if a real tab should be inserted
- */
- public boolean indentLine(int lineIndex, boolean canIncreaseIndent,
- boolean canDecreaseIndent)
- {
- getLineText(lineIndex,seg);
- int tabSize = getTabSize();
- int whitespaceChars = 0;
- int currentIndent = 0;
- loop: for(int i = 0; i < seg.count; i++)
- {
- char c = seg.array[seg.offset + i];
- switch(c)
- {
- case ' ':
- currentIndent++;
- whitespaceChars++;
- break;
- case '\t':
- currentIndent += (tabSize - (currentIndent
- % tabSize));
- whitespaceChars++;
- break;
- default:
- break loop;
- }
- }
- int idealIndent = getIndentForLine(lineIndex);
- if(idealIndent == -1)
- return false;
- if(!canDecreaseIndent && idealIndent <= currentIndent)
- return false;
- if(!canIncreaseIndent && idealIndent >= currentIndent)
- return false;
- // Do it
- try
- {
- beginCompoundEdit();
- int start = getLineStartOffset(lineIndex);
- remove(start,whitespaceChars);
- insert(start,MiscUtilities.createWhiteSpace(
- idealIndent,(getBooleanProperty("noTabs")
- ? 0 : tabSize)));
- }
- finally
- {
- endCompoundEdit();
- }
- return true;
- } //}}}
- //{{{ indentLines() method
- /**
- * Indents all specified lines.
- * @param start The first line to indent
- * @param end The last line to indent
- * @since jEdit 3.1pre3
- */
- public void indentLines(int start, int end)
- {
- try
- {
- beginCompoundEdit();
- for(int i = start; i <= end; i++)
- indentLine(i,true,true);
- }
- finally
- {
- endCompoundEdit();
- }
- } //}}}
- //{{{ indentLines() method
- /**
- * Indents all specified lines.
- * @param lines The line numbers
- * @since jEdit 3.2pre1
- */
- public void indentLines(int[] lines)
- {
- try
- {
- beginCompoundEdit();
- for(int i = 0; i < lines.length; i++)
- indentLine(lines[i],true,true);
- }
- finally
- {
- endCompoundEdit();
- }
- } //}}}
- //{{{ getIndentForLine() method
- /**
- * Returns the ideal leading indent for the specified line.
- * This will apply the various auto-indent rules.
- * @param lineIndex The line number
- */
- public int getIndentForLine(int lineIndex)
- {
- if(lineIndex == 0)
- return -1;
- // Get properties
- String openBrackets = (String)getProperty("indentOpenBrackets");
- String closeBrackets = (String)getProperty("indentCloseBrackets");
- String _indentPrevLine = (String)getProperty("indentPrevLine");
- boolean doubleBracketIndent = getBooleanProperty("doubleBracketIndent");
- RE indentPrevLineRE = null;
- if(openBrackets == null)
- openBrackets = "";
- if(closeBrackets == null)
- closeBrackets = "";
- if(_indentPrevLine != null)
- {
- try
- {
- indentPrevLineRE = new RE(_indentPrevLine,
- RE.REG_ICASE,RESearchMatcher.RE_SYNTAX_JEDIT);
- }
- catch(REException re)
- {
- Log.log(Log.ERROR,this,"Invalid 'indentPrevLine'"
- + " regexp: " + _indentPrevLine);
- Log.log(Log.ERROR,this,re);
- }
- }
- int tabSize = getTabSize();
- int indentSize = getIndentSize();
- String prevLine = null;
- String line = null;
- int start = getLineStartOffset(lineIndex);
- // Get line text
- line = getLineText(lineIndex);
- int prevLineIndex = -1;
- for(int i = lineIndex - 1; i >= 0; i--)
- {
- if(getLineLength(i) != 0)
- {
- prevLine = getLineText(i);
- prevLineIndex = i;
- break;
- }
- }
- if(prevLine == null)
- return -1;
- /*
- * If 'prevLineIndent' matches a line --> +1
- */
- boolean prevLineMatches = (indentPrevLineRE == null ? false
- : indentPrevLineRE.isMatch(prevLine));
- /*
- * On the previous line,
- * if(bob) { --> +1
- * if(bob) { } --> 0
- * } else if(bob) { --> +1
- */
- boolean prevLineStart = true; // False after initial indent
- int prevLineIndent = 0; // Indent width (tab expanded)
- int prevLineBrackets = 0; // Additional bracket indent
- int prevLineCloseBracketIndex = -1; // For finding whether we're in
- // this kind of construct:
- // if (cond1)
- // while (cond2)
- // if (cond3){
- //
- // }
- // So we know to indent the next line under the 1st if.
-
- for(int i = 0; i < prevLine.length(); i++)
- {
- char c = prevLine.charAt(i);
- switch(c)
- {
- case ' ':
- if(prevLineStart)
- prevLineIndent++;
- break;
- case '\t':
- if(prevLineStart)
- {
- prevLineIndent += (tabSize
- - (prevLineIndent
- % tabSize));
- }
- break;
- default:
- prevLineStart = false;
- if(closeBrackets.indexOf(c) != -1)
- {
- prevLineBrackets = Math.max(
- prevLineBrackets-1,0);
- prevLineCloseBracketIndex = i;
- }
- else if(openBrackets.indexOf(c) != -1)
- {
- /*
- * If supressBracketAfterIndent is true
- * and we have something that looks like:
- * if(bob)
- * {
- * then the 'if' will not shift the indent,
- * because of the {.
- *
- * If supressBracketAfterIndent is false,
- * the above would be indented like:
- * if(bob)
- * {
- */
- if(!doubleBracketIndent)
- prevLineMatches = false;
- prevLineBrackets++;
- }
- break;
- }
- }
- // This is a hack so that auto indent does not go haywire
- // with explicit folding. Proper fix will be done later,
- // when the auto indent is rewritten.
- if(prevLineBrackets == 3)
- prevLineBrackets = 0;
- /*
- * On the current line,
- * } --> -1
- * } else if(bob) { --> -1
- * if(bob) { } --> 0
- */
- boolean lineStart = true; // False after initial indent
- int lineIndent = 0; // Indent width (tab expanded)
- int lineWidth = 0; // White space count
- int lineBrackets = 0; // Additional bracket indent
- int closeBracketIndex = -1; // For lining up closing
- // and opening brackets
- for(int i = 0; i < line.length(); i++)
- {
- char c = line.charAt(i);
- switch(c)
- {
- case ' ':
- if(lineStart)
- {
- lineIndent++;
- lineWidth++;
- }
- break;
- case '\t':
- if(lineStart)
- {
- lineIndent += (tabSize
- - (lineIndent
- % tabSize));
- lineWidth++;
- }
- break;
- default:
- if(closeBrackets.indexOf(c) != -1)
- {
- if(lineBrackets == 0)
- closeBracketIndex = i;
- else
- lineBrackets--;
- }
- else if(openBrackets.indexOf(c) != -1)
- {
- if((!doubleBracketIndent)&&lineStart)
- prevLineMatches = false;
- lineBrackets++;
- }
- lineStart = false;
- break;
- }
- }
- // This is a hack so that auto indent does not go haywire
- // with explicit folding. Proper fix will be done later,
- // when the auto indent is rewritten.
- if(lineBrackets == 3)
- {
- closeBracketIndex = -1;
- lineBrackets = 0;
- }
- if((indentPrevLineRE != null) && (!prevLineMatches) && (prevLineBrackets == 0))
- {
- int indentLineIndex;
- if(prevLineCloseBracketIndex != -1)
- {
- int offset = TextUtilities.findMatchingBracket(
- this,prevLineIndex,prevLineCloseBracketIndex);
- if(offset == -1)
- return -1;
- indentLineIndex = getLineOfOffset(offset);
- }
- else
- indentLineIndex = prevLineIndex;
- if(indentLineIndex >= 0)
- {
- String closeLine = getLineText(indentLineIndex);
- while(--indentLineIndex > 0)
- {
- String tempLine = getLineText(indentLineIndex);
- if(tempLine.trim().length() == 0)
- continue;
- if(indentPrevLineRE.isMatch(tempLine))
- closeLine = tempLine;
- else
- break;
- }
- prevLineIndent = MiscUtilities
- .getLeadingWhiteSpaceWidth(
- closeLine,tabSize);
- }
- else
- return -1;
- }
- if(closeBracketIndex != -1)
- {
- int offset = TextUtilities.findMatchingBracket(
- this,lineIndex,closeBracketIndex);
- if(offset != -1)
- {
- String closeLine = getLineText(getLineOfOffset(offset));
- prevLineIndent = MiscUtilities.getLeadingWhiteSpaceWidth(
- closeLine,tabSize);
- }
- else
- return -1;
- }
- else
- {
- prevLineIndent += (prevLineBrackets * indentSize);
- }
- if (prevLineMatches)
- prevLineIndent += indentSize;
- return prevLineIndent;
- } //}}}
- //{{{ getVirtualWidth() method
- /**
- * Returns the virtual column number (taking tabs into account) of the
- * specified position.
- *
- * @param line The line number
- * @param column The column number
- * @since jEdit 4.1pre1
- */
- public int getVirtualWidth(int line, int column)
- {
- try
- {
- readLock();
- int start = getLineStartOffset(line);
- getText(start,column,seg);
- return MiscUtilities.getVirtualWidth(seg,getTabSize());
- }
- finally
- {
- readUnlock();
- }
- } //}}}
- //{{{ getOffsetOfVirtualColumn() method
- /**
- * Returns the array offset of a virtual column number (taking tabs
- * into account) in the segment.
- *
- * @param line The line number
- * @param column The virtual column number
- * @param totalVirtualWidth If this array is non-null, the total
- * virtual width will be stored in its first location if this method
- * returns -1.
- *
- * @return -1 if the column is out of bounds
- *
- * @since jEdit 4.1pre1
- */
- public int getOffsetOfVirtualColumn(int line, int column,
- int[] totalVirtualWidth)
- {
- try
- {
- readLock();
- getLineText(line,seg);
- return MiscUtilities.getOffsetOfVirtualColumn(seg,
- getTabSize(),column,totalVirtualWidth);
- }
- finally
- {
- readUnlock();
- }
- } //}}}
- //{{{ insertAtColumn()
- /**
- * Like the <code>insert()</code> method, but inserts the string at
- * the specified virtual column. Inserts spaces as appropriate if
- * the line is shorter than the column.
- * @param line The line number
- * @param col The virtual column number
- * @param str The string
- */
- public void insertAtColumn(int line, int col, String str)
- {
- try
- {
- writeLock();
- int[] total = new int[1];
- int offset = getOffsetOfVirtualColumn(line,col,total);
- if(offset == -1)
- {
- offset = getLineEndOffset(line) - 1;
- str = MiscUtilities.createWhiteSpace(col - total[0],0) + str;
- }
- else
- offset += getLineStartOffset(line);
- insert(offset,str);
- }
- finally
- {
- writeUnlock();
- }
- } //}}}
- //}}}
- //{{{ Deprecated methods
- //{{{ putProperty() method
- /**
- * @deprecated Call <code>setProperty()</code> instead.
- */
- public void putProperty(Object name, Object value)
- {
- // for backwards compatibility
- if(!(name instanceof String))
- return;
- setProperty((String)name,value);
- } //}}}
- //{{{ putBooleanProperty() method
- /**
- * @deprecated Call <code>setBooleanProperty()</code> instead
- */
- public void putBooleanProperty(String name, boolean value)
- {
- setBooleanProperty(name,value);
- } //}}}
- //{{{ markTokens() method
- /**
- * @deprecated Use org.gjt.sp.jedit.syntax.DefaultTokenHandler instead
- */
- public static class TokenList extends DefaultTokenHandler
- {
- public Token getFirstToken()
- {
- return getTokens();
- }
- }
- /**
- * @deprecated Use the other form of <code>markTokens()</code> instead
- */
- public TokenList markTokens(int lineIndex)
- {
- TokenList list = new TokenList();
- markTokens(lineIndex,list);
- return list;
- } //}}}
- //{{{ getRootElements() method
- /**
- * @deprecated
- */
- public Element[] getRootElements()
- {
- return new Element[] { getDefaultRootElement() };
- } //}}}
- //{{{ getParagraphElement() method
- /**
- * @deprecated
- */
- public Element getParagraphElement(int offset)
- {
- return new LineElement(this,getLineOfOffset(offset));
- } //}}}
- //{{{ getDefaultRootElement() method
- /**
- * @deprecated Use <code>getLineOfOffset()</code>,
- * <code>getLineStartOffset()</code>, and
- * <code>getLineEndOffset()</code> instead.
- */
- public Element getDefaultRootElement()
- {
- return new RootElement(this);
- } //}}}
- //{{{ insertString() method
- /**
- * @deprecated Call <code>insert()</code> instead.
- */
- public void insertString(int offset, String str, AttributeSet attr)
- {
- insert(offset,str);
- } //}}}
- //{{{ getFile() method
- /**
- * @deprecated Do not call this method, use <code>getPath()</code>
- * instead.
- */
- public final File getFile()
- {
- return file;
- } //}}}
- //}}}
- //{{{ Folding methods
- //{{{ isFoldStart() method
- /**
- * Returns if the specified line begins a fold.
- * @since jEdit 3.1pre1
- */
- public boolean isFoldStart(int line)
- {
- return (line != getLineCount() - 1
- && getFoldLevel(line) < getFoldLevel(line + 1));
- } //}}}
- //{{{ getFoldLevel() method
- /**
- * Returns the fold level of the specified line.
- * @param line A physical line index
- * @since jEdit 3.1pre1
- */
- public int getFoldLevel(int line)
- {
- try
- {
- writeLock();
- if(line < 0 || line >= offsetMgr.getLineCount())
- throw new ArrayIndexOutOfBoundsException(line);
- if(offsetMgr.isFoldLevelValid(line))
- {
- return offsetMgr.getFoldLevel(line);
- }
- else
- {
- //System.err.println("level invalid: " + line + ":"
- // + offsetMgr.getFoldLevel(line));
- int start = 0;
- for(int i = line - 1; i >= 0; i--)
- {
- if(offsetMgr.isFoldLevelValid(i))
- {
- start = i + 1;
- break;
- }
- }
- int newFoldLevel = 0;
- boolean changed = false;
- for(int i = start; i <= line; i++)
- {
- newFoldLevel = foldHandler.getFoldLevel(this,i,seg);
- if(newFoldLevel != offsetMgr.getFoldLevel(i))
- changed = true;
- offsetMgr.setFoldLevel(i,newFoldLevel);
- }
- if(changed && !getFlag(INSIDE_INSERT))
- {
- //System.err.println("fold level changed: " + start + ":" + line);
- fireFoldLevelChanged(start,line);
- }
- return newFoldLevel;
- }
- }
- finally
- {
- writeUnlock();
- }
- } //}}}
- //{{{ getFoldAtLine() method
- /**
- * Returns an array. The first element is the start line, the
- * second element is the end line, of the fold containing the
- * specified line number.
- * @param line The line number
- * @since jEdit 4.0pre3
- */
- public int[] getFoldAtLine(int line)
- {
- int start, end;
- if(isFoldStart(line))
- {
- start = line;
- int foldLevel = getFoldLevel(line);
- line++;
- while(getFoldLevel(line) > foldLevel)
- {
- line++;
- if(line == getLineCount())
- break;
- }
- end = line - 1;
- }
- else
- {
- start = line;
- int foldLevel = getFoldLevel(line);
- while(getFoldLevel(start) >= foldLevel)
- {
- if(start == 0)
- break;
- else
- start--;
- }
- end = line;
- while(getFoldLevel(end) >= foldLevel)
- {
- end++;
- if(end == getLineCount())
- break;
- }
- end--;
- }
- while(getLineLength(end) == 0 && end > start)
- end--;
- return new int[] { start, end };
- } //}}}
- //}}}
- //{{{ Position methods
- //{{{ createPosition() method
- /**
- * Creates a floating position.
- * @param offset The offset
- */
- public Position createPosition(int offset)
- {
- try
- {
- readLock();
- if(offset < 0 || offset > contentMgr.getLength())
- throw new ArrayIndexOutOfBoundsException(offset);
- return offsetMgr.createPosition(offset);
- }
- finally
- {
- readUnlock();
- }
- } //}}}
- //}}}
- //{{{ Marker methods
- //{{{ getMarkers() method
- /**
- * Returns a vector of markers.
- * @since jEdit 3.2pre1
- */
- public final Vector getMarkers()
- {
- return markers;
- } //}}}
- //{{{ addOrRemoveMarker() method
- /**
- * If a marker is set on the line of the position, it is removed. Otherwise
- * a new marker with the specified shortcut is added.
- * @param pos The position of the marker
- * @param shortcut The shortcut ('\0' if none)
- * @since jEdit 3.2pre5
- */
- public void addOrRemoveMarker(char shortcut, int pos)
- {
- int line = getLineOfOffset(pos);
- if(getMarkerAtLine(line) != null)
- removeMarker(line);
- else
- addMarker(shortcut,pos);
- } //}}}
- //{{{ addMarker() method
- /**
- * Adds a marker to this buffer.
- * @param pos The position of the marker
- * @param shortcut The shortcut ('\0' if none)
- * @since jEdit 3.2pre1
- */
- public void addMarker(char shortcut, int pos)
- {
- if(!getFlag(READ_ONLY) && jEdit.getBooleanProperty("persistentMarkers"))
- setDirty(true);
- Marker markerN = new Marker(this,shortcut,pos);
- boolean added = false;
- // don't sort markers while buffer is being loaded
- if(!getFlag(LOADING))
- {
- markerN.createPosition();
- for(int i = 0; i < markers.size(); i++)
- {
- Marker marker = (Marker)markers.elementAt(i);
- if(shortcut != '\0' && marker.getShortcut() == shortcut)
- marker.setShortcut('\0');
- if(marker.getPosition() == pos)
- {
- markers.removeElementAt(i);
- i--;
- }
- }
- for(int i = 0; i < markers.size(); i++)
- {
- Marker marker = (Marker)markers.elementAt(i);
- if(marker.getPosition() > pos)
- {
- markers.insertElementAt(markerN,i);
- added = true;
- break;
- }
- }
- }
- if(!added)
- markers.addElement(markerN);
- if(!getFlag(LOADING) && !getFlag(TEMPORARY))
- {
- EditBus.send(new BufferUpdate(this,null,
- BufferUpdate.MARKERS_CHANGED));
- }
- } //}}}
- //{{{ getMarkerInRange() method
- /**
- * Returns the first marker within the specified range.
- * @param start The start offset
- * @param end The end offset
- * @since jEdit 4.0pre4
- */
- public Marker getMarkerInRange(int start, int end)
- {
- for(int i = 0; i < markers.size(); i++)
- {
- Marker marker = (Marker)markers.elementAt(i);
- int pos = marker.getPosition();
- if(pos >= start && pos < end)
- return marker;
- }
- return null;
- } //}}}
- //{{{ getM