org.gjt.sp.jedit.MiscUtilities Maven / Gradle / Ivy
/*
* MiscUtilities.java - Various miscallaneous utility functions
* :tabSize=8:indentSize=8:noTabs=false:
* :folding=explicit:collapseFolds=1:
*
* Copyright (C) 1999, 2005 Slava Pestov
* Portions copyright (C) 2000 Richard S. Hall
* Portions copyright (C) 2001 Dirk Moebius
*
* 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 javax.swing.text.Segment;
import javax.swing.JMenuItem;
import java.io.*;
import java.net.MalformedURLException;
import java.net.URL;
import java.text.DecimalFormat;
import java.util.*;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
import org.xml.sax.InputSource;
import org.xml.sax.helpers.DefaultHandler;
import org.gjt.sp.jedit.io.*;
import org.gjt.sp.util.Log;
import org.gjt.sp.util.ProgressObserver;
import org.gjt.sp.util.StandardUtilities;
import org.gjt.sp.util.IOUtilities;
import org.gjt.sp.util.XMLUtilities;
//}}}
/**
* Path name manipulation, string manipulation, and more.
*
* The most frequently used members of this class are:
*
* Some path name methods:
*
* - {@link #getFileName(String)}
* - {@link #getParentOfPath(String)}
* - {@link #constructPath(String,String)}
*
* String comparison:
* A {@link #compareStrings(String,String,boolean)} method that unlike
* String.compareTo() , correctly recognizes and handles
* embedded numbers.
*
* This class also defines several inner classes for use with the
* sorting features of the Java collections API:
*
*
* - {@link MiscUtilities.StringICaseCompare}
* - {@link MiscUtilities.MenuItemCompare}
*
*
* For example, you might call:
*
* Arrays.sort(myListOfStrings,
* new MiscUtilities.StringICaseCompare());
*
* @author Slava Pestov
* @author John Gellene (API documentation)
* @version $Id: MiscUtilities.java 13137 2008-08-02 10:36:56Z k_satoda $
*/
public class MiscUtilities
{
/**
* This encoding is not supported by Java, yet it is useful.
* A UTF-8 file that begins with 0xEFBBBF.
* @deprecated
* Extended encodings are now supported as services.
* This value is no longer used.
*/
@Deprecated public static final String UTF_8_Y = "UTF-8Y";
//{{{ Path name methods
//{{{ canonPath() method
/**
* @return the canonical form of the specified path name. Currently
* only expands a leading ~. For local path names
* only.
* @param path The path name
* @since jEdit 4.0pre2
*/
public static String canonPath(String path)
{
if(path.length() == 0)
return path;
if(path.startsWith("file://"))
path = path.substring("file://".length());
else if(path.startsWith("file:"))
path = path.substring("file:".length());
else if(isURL(path))
return path;
if(File.separatorChar == '\\')
{
// get rid of mixed paths on Windows
path = path.replace('/','\\');
// also get rid of trailing spaces on Windows
int trim = path.length();
while(path.charAt(trim - 1) == ' ')
trim--;
if (path.charAt(trim - 1) == '\\')
while (trim > 1 && path.charAt(trim - 2) == '\\')
{
trim--;
}
path = path.substring(0,trim);
}
else if(OperatingSystem.isMacOS())
{
// do the same on OS X
path = path.replace(':','/');
}
if(path.startsWith('~' + File.separator))
{
path = path.substring(2);
String home = System.getProperty("user.home");
if(home.endsWith(File.separator))
return home + path;
else
return home + File.separator + path;
}
else if("~".equals(path))
return System.getProperty("user.home");
else
return path;
} //}}}
//{{{ expandVariables() method
static final String varPatternString = "(\\$([a-zA-Z0-9_]+))";
static final String varPatternString2 = "(\\$\\{([^}]+)\\})";
static final Pattern varPattern = Pattern.compile(varPatternString);
static final Pattern varPattern2 = Pattern.compile(varPatternString2);
/** Accepts a string from the user which may contain variables of various syntaxes.
* The goal is to support the following:
* $varname
* ${varname}
* And expand each of these by looking at the system environment variables for possible
* expansions.
* @return a string which is either the unchanged input string, or one with expanded variables.
* @since 4.3pre7
* @author ezust
*/
public static String expandVariables(String arg)
{
Pattern p = varPattern;
Matcher m = p.matcher(arg);
if (!m.find())
{
p = varPattern2;
m = p.matcher(arg);
if (!m.find()) // no variables to substitute
return arg;
}
String varName = m.group(2);
String expansion = System.getenv(varName);
if (expansion == null)
{ // try everything uppercase?
varName = varName.toUpperCase();
String uparg = arg.toUpperCase();
m = p.matcher(uparg);
expansion = System.getenv(varName);
}
if (expansion != null)
{
expansion = expansion.replace("\\", "\\\\");
return m.replaceFirst(expansion);
}
return arg;
} //}}}
//{{{ resolveSymlinks() method
/**
* Resolves any symbolic links in the path name specified
* using File.getCanonicalPath(). For local path
* names only.
* @since jEdit 4.2pre1
*/
public static String resolveSymlinks(String path)
{
if(isURL(path))
return path;
// 2 aug 2003: OS/2 Java has a broken getCanonicalPath()
if(OperatingSystem.isOS2())
return path;
// 18 nov 2003: calling this on a drive letter on Windows causes
// drive access
if(OperatingSystem.isDOSDerived())
{
if(path.length() == 2 || path.length() == 3)
{
if(path.charAt(1) == ':')
return path;
}
}
try
{
return new File(path).getCanonicalPath();
}
catch(IOException io)
{
return path;
}
} //}}}
//{{{ isAbsolutePath() method
/**
* Returns if the specified path name is an absolute path or URL.
* @since jEdit 4.1pre11
*/
public static boolean isAbsolutePath(String path)
{
if(isURL(path))
return true;
else if(path.startsWith("~/") || path.startsWith("~" + File.separator) || "~".equals(path))
return true;
else if(OperatingSystem.isDOSDerived())
{
if(path.length() == 2 && path.charAt(1) == ':')
return true;
if(path.length() > 2 && path.charAt(1) == ':'
&& (path.charAt(2) == '\\'
|| path.charAt(2) == '/'))
return true;
if(path.startsWith("\\\\")
|| path.startsWith("//"))
return true;
}
// not sure if this is correct for OpenVMS.
else if(OperatingSystem.isUnix()
|| OperatingSystem.isVMS())
{
// nice and simple
if(path.length() > 0 && path.charAt(0) == '/')
return true;
}
return false;
} //}}}
//{{{ constructPath() method
/**
* Constructs an absolute path name from a directory and another
* path name. This method is VFS-aware.
* @param parent The directory
* @param path The path name
*/
public static String constructPath(String parent, String path)
{
if(isAbsolutePath(path))
return canonPath(path);
if (parent == null)
parent = System.getProperty("user.dir");
if (path == null || path.length() == 0)
return parent;
// have to handle this case specially on windows.
// insert \ between, eg A: and myfile.txt.
if(OperatingSystem.isDOSDerived())
{
if(path.length() == 2 && path.charAt(1) == ':')
return path;
else if(path.length() > 2 && path.charAt(1) == ':'
&& path.charAt(2) != '\\')
{
path = path.substring(0,2) + '\\'
+ path.substring(2);
return canonPath(path);
}
}
String dd = ".." + File.separator;
String d = '.' + File.separator;
for(;;)
{
if(".".equals(path))
return parent;
else if("..".equals(path))
return getParentOfPath(parent);
else if(path.startsWith(dd) || path.startsWith("../"))
{
parent = getParentOfPath(parent);
path = path.substring(3);
}
else if(path.startsWith(d) || path.startsWith("./"))
path = path.substring(2);
else
break;
}
if(path.length() == 0)
return parent;
if(OperatingSystem.isDOSDerived()
&& !isURL(parent)
&& path.charAt(0) == '\\')
parent = parent.substring(0,2);
VFS vfs = VFSManager.getVFSForPath(parent);
return canonPath(vfs.constructPath(parent,path));
} //}}}
//{{{ constructPath() method
/**
* Constructs an absolute path name from three path components.
* This method is VFS-aware.
* @param parent The parent directory
* @param path1 The first path
* @param path2 The second path
*/
public static String constructPath(String parent,
String path1, String path2)
{
return constructPath(constructPath(parent,path1),path2);
} //}}}
//{{{ concatPath() method
/**
* Like {@link #constructPath}, except path will be
* appended to parent even if it is absolute.
* For local path names only..
*
* @param path
* @param parent
*/
public static String concatPath(String parent, String path)
{
parent = canonPath(parent);
path = canonPath(path);
// Make all child paths relative.
if (path.startsWith(File.separator))
path = path.substring(1);
else if ((path.length() >= 3) && (path.charAt(1) == ':'))
path = path.replace(':', File.separatorChar);
if (parent == null)
parent = System.getProperty("user.dir");
if (parent.endsWith(File.separator))
return parent + path;
else
return parent + File.separator + path;
} //}}}
//{{{ getFirstSeparatorIndex() method
/**
* Return the first index of either / or the OS-specific file
* separator.
* @param path The path
* @since jEdit 4.3pre3
*/
public static int getFirstSeparatorIndex(String path)
{
int start = getPathStart(path);
int index = path.indexOf('/',start);
if(index == -1)
index = path.indexOf(File.separatorChar,start);
return index;
} //}}}
//{{{ getLastSeparatorIndex() method
/**
* Return the last index of either / or the OS-specific file
* separator.
* @param path The path
* @since jEdit 4.3pre3
*/
public static int getLastSeparatorIndex(String path)
{
int start = getPathStart(path);
if(start != 0)
path = path.substring(start);
int index = Math.max(
path.lastIndexOf('/'), path.lastIndexOf(File.separatorChar));
if(index == -1)
return index;
else
return index + start;
} //}}}
//{{{ getFileExtension() method
/**
* Returns the extension of the specified filename, or an empty
* string if there is none.
* @param path The path
*/
public static String getFileExtension(String path)
{
int fsIndex = getLastSeparatorIndex(path);
int index = path.lastIndexOf('.');
// there could be a dot in the path and no file extension
if(index == -1 || index < fsIndex )
return "";
else
return path.substring(index);
} //}}}
//{{{ getFileName() method
/**
* Returns the last component of the specified path.
* This method is VFS-aware.
* @param path The path name
*/
public static String getFileName(String path)
{
return VFSManager.getVFSForPath(path).getFileName(path);
} //}}}
//{{{ getFileNameNoExtension() method
/**
* Returns the last component of the specified path name without the
* trailing extension (if there is one).
* @param path The path name
* @since jEdit 4.0pre8
*/
public static String getFileNameNoExtension(String path)
{
String name = getFileName(path);
int index = name.indexOf('.');
if(index == -1)
return name;
else
return name.substring(0,index);
} //}}}
//{{{ getFileParent() method
/**
* @deprecated Call getParentOfPath() instead
*/
@Deprecated
public static String getFileParent(String path)
{
return getParentOfPath(path);
} //}}}
//{{{ getParentOfPath() method
/**
* Returns the parent of the specified path. This method is VFS-aware.
* @param path The path name
* @since jEdit 2.6pre5
*/
public static String getParentOfPath(String path)
{
return VFSManager.getVFSForPath(path).getParentOfPath(path);
} //}}}
//{{{ getFileProtocol() method
/**
* @deprecated Call getProtocolOfURL() instead
*/
@Deprecated
public static String getFileProtocol(String url)
{
return getProtocolOfURL(url);
} //}}}
//{{{ getProtocolOfURL() method
/**
* Returns the protocol specified by a URL.
* @param url The URL
* @since jEdit 2.6pre5
*/
public static String getProtocolOfURL(String url)
{
return url.substring(0,url.indexOf(':'));
} //}}}
//{{{ isURL() method
/**
* Checks if the specified string is a URL.
* @param str The string to check
* @return True if the string is a URL, false otherwise
*/
public static boolean isURL(String str)
{
int fsIndex = getLastSeparatorIndex(str);
if(fsIndex == 0) // /etc/passwd
return false;
else if(fsIndex == 2) // C:\AUTOEXEC.BAT
return false;
int cIndex = str.indexOf(':');
if(cIndex <= 1) // D:\WINDOWS, or doesn't contain : at all
return false;
String protocol = str.substring(0,cIndex);
VFS vfs = VFSManager.getVFSForProtocol(protocol);
if(vfs != null && !(vfs instanceof UrlVFS))
return true;
try
{
new URL(str);
return true;
}
catch(MalformedURLException mf)
{
return false;
}
} //}}}
//{{{ saveBackup() method
/**
* Saves a backup (optionally numbered) of a file.
* @param file A local file
* @param backups The number of backups. Must be >= 1. If > 1, backup
* files will be numbered.
* @param backupPrefix The backup file name prefix
* @param backupSuffix The backup file name suffix
* @param backupDirectory The directory where to save backups; if null,
* they will be saved in the same directory as the file itself.
* @since jEdit 4.0pre1
*/
public static void saveBackup(File file, int backups,
String backupPrefix, String backupSuffix,
String backupDirectory)
{
saveBackup(file,backups,backupPrefix,backupSuffix,backupDirectory,0);
} //}}}
//{{{ saveBackup() method
/**
* Saves a backup (optionally numbered) of a file.
* @param file A local file
* @param backups The number of backups. Must be >= 1. If > 1, backup
* files will be numbered.
* @param backupPrefix The backup file name prefix
* @param backupSuffix The backup file name suffix
* @param backupDirectory The directory where to save backups; if null,
* they will be saved in the same directory as the file itself.
* @param backupTimeDistance The minimum time in minutes when a backup
* version 1 shall be moved into version 2; if 0, backups are always
* moved.
* @since jEdit 4.2pre5
*/
public static void saveBackup(File file, int backups,
String backupPrefix, String backupSuffix,
String backupDirectory, int backupTimeDistance)
{
if(backupPrefix == null)
backupPrefix = "";
if(backupSuffix == null)
backupSuffix = "";
String name = file.getName();
// If backups is 1, create ~ file
if(backups == 1)
{
File backupFile = new File(backupDirectory,
backupPrefix + name + backupSuffix);
long modTime = backupFile.lastModified();
/* if backup file was created less than
* 'backupTimeDistance' ago, we do not
* create the backup */
if(System.currentTimeMillis() - modTime
>= backupTimeDistance)
{
Log.log(Log.DEBUG,MiscUtilities.class,
"Saving backup of file \"" +
file.getAbsolutePath() + "\" to \"" +
backupFile.getAbsolutePath() + '"');
backupFile.delete();
if (!file.renameTo(backupFile))
IOUtilities.moveFile(file, backupFile);
}
}
// If backups > 1, move old ~n~ files, create ~1~ file
else
{
/* delete a backup created using above method */
new File(backupDirectory,
backupPrefix + name + backupSuffix
+ backups + backupSuffix).delete();
File firstBackup = new File(backupDirectory,
backupPrefix + name + backupSuffix
+ "1" + backupSuffix);
long modTime = firstBackup.lastModified();
/* if backup file was created less than
* 'backupTimeDistance' ago, we do not
* create the backup */
if(System.currentTimeMillis() - modTime
>= backupTimeDistance)
{
for(int i = backups - 1; i > 0; i--)
{
File backup = new File(backupDirectory,
backupPrefix + name
+ backupSuffix + i
+ backupSuffix);
backup.renameTo(
new File(backupDirectory,
backupPrefix + name
+ backupSuffix + (i+1)
+ backupSuffix));
}
File backupFile = new File(backupDirectory,
backupPrefix + name + backupSuffix
+ "1" + backupSuffix);
Log.log(Log.DEBUG,MiscUtilities.class,
"Saving backup of file \"" +
file.getAbsolutePath() + "\" to \"" +
backupFile.getAbsolutePath() + '"');
if (!file.renameTo(backupFile))
IOUtilities.moveFile(file, backupFile);
}
}
} //}}}
//{{{ moveFile() method
/**
* Moves the source file to the destination.
*
* If the destination cannot be created or is a read-only file, the
* method returns false. Otherwise, the contents of the
* source are copied to the destination, the source is deleted,
* and true is returned.
*
* @param source The source file to move.
* @param dest The destination where to move the file.
* @return true on success, false otherwise.
*
* @since jEdit 4.3pre1
* @deprecated use {@link org.gjt.sp.util.IOUtilities#moveFile(java.io.File, java.io.File)}
*/
@Deprecated
public static boolean moveFile(File source, File dest)
{
return IOUtilities.moveFile(source, dest);
} //}}}
//{{{ copyStream() method
/**
* Copy an input stream to an output stream.
*
* @param bufferSize the size of the buffer
* @param progress the progress observer it could be null
* @param in the input stream
* @param out the output stream
* @param canStop if true, the copy can be stopped by interrupting the thread
* @return true if the copy was done, false if it was interrupted
* @throws IOException IOException If an I/O error occurs
* @since jEdit 4.3pre3
* @deprecated use {@link IOUtilities#copyStream(int, org.gjt.sp.util.ProgressObserver, java.io.InputStream, java.io.OutputStream, boolean)}
*/
@Deprecated
public static boolean copyStream(int bufferSize, ProgressObserver progress,
InputStream in, OutputStream out, boolean canStop)
throws IOException
{
return IOUtilities.copyStream(bufferSize, progress, in, out, canStop);
} //}}}
//{{{ copyStream() method
/**
* Copy an input stream to an output stream with a buffer of 4096 bytes.
*
* @param progress the progress observer it could be null
* @param in the input stream
* @param out the output stream
* @param canStop if true, the copy can be stopped by interrupting the thread
* @return true if the copy was done, false if it was interrupted
* @throws IOException IOException If an I/O error occurs
* @since jEdit 4.3pre3
* @deprecated use {@link IOUtilities#copyStream(org.gjt.sp.util.ProgressObserver, java.io.InputStream, java.io.OutputStream, boolean)}
*/
@Deprecated
public static boolean copyStream(ProgressObserver progress, InputStream in, OutputStream out, boolean canStop)
throws IOException
{
return IOUtilities.copyStream(4096,progress, in, out, canStop);
} //}}}
//{{{ isBinary() method
/**
* Check if a Reader is binary.
* @deprecated
* Use isBinary(InputStream) instead.
*/
@Deprecated
public static boolean isBinary(Reader reader) throws IOException
{
return containsNullCharacter(reader);
} //}}}
//{{{ isBinary() method
/**
* Check if an InputStream is binary.
* First this tries encoding auto detection. If an encoding is
* detected, the stream should be a text stream. Otherwise, this
* will check the first characters 100
* (jEdit property vfs.binaryCheck.length) in the system default
* encoding. If more than 1 (jEdit property vfs.binaryCheck.count)
* NUL(\u0000) was found, the stream is declared binary.
*
* This is not 100% because sometimes the autodetection could fail.
*
* This method will not close the stream. You have to do it yourself
*
* @param in the stream
* @return true if the stream was detected as binary
* @throws IOException IOException If an I/O error occurs
* @since jEdit 4.3pre10
*/
public static boolean isBinary(InputStream in) throws IOException
{
AutoDetection.Result detection = new AutoDetection.Result(in);
// If an encoding is detected, this is a text stream
if (detection.getDetectedEncoding() != null)
{
return false;
}
// Read the stream in system default encoding. The encoding
// might be wrong. But enough for binary detection.
return containsNullCharacter(
new InputStreamReader(detection.getRewindedStream()));
} //}}}
//{{{ isBackup() method
/**
* Check if the filename is a backup file.
* @param filename the filename to check
* @return true if this is a backup file.
* @since jEdit 4.3pre5
*/
public static boolean isBackup( String filename ) {
if (filename.startsWith("#")) return true;
if (filename.endsWith("~")) return true;
if (filename.endsWith(".bak")) return true;
return false;
} //}}}
//{{{ autodetect() method
/**
* Tries to detect if the stream is gzipped, and if it has an encoding
* specified with an XML PI.
*
* @param in the input stream reader that must be autodetected
* @param buffer a buffer. It can be null if you only want to autodetect the encoding of a file
* @return a Reader using the detected encoding
* @throws IOException io exception during read
* @since jEdit 4.3pre5
*/
public static Reader autodetect(InputStream in, Buffer buffer) throws IOException
{
String encoding;
if (buffer == null)
encoding = System.getProperty("file.encoding");
else
encoding = buffer.getStringProperty(Buffer.ENCODING);
boolean gzipped = false;
if (buffer == null || buffer.getBooleanProperty(Buffer.ENCODING_AUTODETECT))
{
AutoDetection.Result detection = new AutoDetection.Result(in);
gzipped = detection.streamIsGzipped();
if (gzipped)
{
Log.log(Log.DEBUG, MiscUtilities.class
, "Stream is Gzipped");
}
String detected = detection.getDetectedEncoding();
if (detected != null)
{
encoding = detected;
Log.log(Log.DEBUG, MiscUtilities.class
, "Stream encoding detected is " + detected);
}
in = detection.getRewindedStream();
}
else
{
// Make the stream buffered in the same way.
in = AutoDetection.getMarkedStream(in);
}
Reader result = EncodingServer.getTextReader(in, encoding);
if (buffer != null)
{
// Store the successful properties.
if (gzipped)
{
buffer.setBooleanProperty(Buffer.GZIPPED,true);
}
buffer.setProperty(Buffer.ENCODING, encoding);
}
return result;
} //}}}
//{{{ closeQuietly() method
/**
* Method that will close an {@link InputStream} ignoring it if it is null and ignoring exceptions.
*
* @param in the InputStream to close.
* @since jEdit 4.3pre3
* @deprecated use {@link IOUtilities#closeQuietly(java.io.InputStream)}
*/
@Deprecated
public static void closeQuietly(InputStream in)
{
IOUtilities.closeQuietly(in);
} //}}}
//{{{ copyStream() method
/**
* Method that will close an {@link OutputStream} ignoring it if it is null and ignoring exceptions.
*
* @param out the OutputStream to close.
* @since jEdit 4.3pre3
* @deprecated use {@link IOUtilities#closeQuietly(java.io.OutputStream)}
*/
@Deprecated
public static void closeQuietly(OutputStream out)
{
IOUtilities.closeQuietly(out);
} //}}}
//{{{ fileToClass() method
/**
* Converts a file name to a class name. All slash characters are
* replaced with periods and the trailing '.class' is removed.
* @param name The file name
*/
public static String fileToClass(String name)
{
char[] clsName = name.toCharArray();
for(int i = clsName.length - 6; i >= 0; i--)
if(clsName[i] == '/')
clsName[i] = '.';
return new String(clsName,0,clsName.length - 6);
} //}}}
//{{{ classToFile() method
/**
* Converts a class name to a file name. All periods are replaced
* with slashes and the '.class' extension is added.
* @param name The class name
*/
public static String classToFile(String name)
{
return name.replace('.','/').concat(".class");
} //}}}
//{{{ pathsEqual() method
/**
* @param p1 A path name
* @param p2 A path name
* @return True if both paths are equal, ignoring trailing slashes, as
* well as case insensitivity on Windows.
* @since jEdit 4.3pre2
*/
public static boolean pathsEqual(String p1, String p2)
{
VFS v1 = VFSManager.getVFSForPath(p1);
VFS v2 = VFSManager.getVFSForPath(p2);
if(v1 != v2)
return false;
if(p1.endsWith("/") || p1.endsWith(File.separator))
p1 = p1.substring(0,p1.length() - 1);
if(p2.endsWith("/") || p2.endsWith(File.separator))
p2 = p2.substring(0,p2.length() - 1);
if((v1.getCapabilities() & VFS.CASE_INSENSITIVE_CAP) != 0)
return p1.equalsIgnoreCase(p2);
else
return p1.equals(p2);
} //}}}
//}}}
//{{{ Text methods
//{{{ getLeadingWhiteSpace() method
/**
* Returns the number of leading white space characters in the
* specified string.
* @param str The string
* @deprecated use {@link org.gjt.sp.util.StandardUtilities#getLeadingWhiteSpace(String)}
*/
@Deprecated
public static int getLeadingWhiteSpace(String str)
{
return StandardUtilities.getLeadingWhiteSpace(str);
} //}}}
//{{{ getTrailingWhiteSpace() method
/**
* Returns the number of trailing whitespace characters in the
* specified string.
* @param str The string
* @since jEdit 2.5pre5
* @deprecated use {@link org.gjt.sp.util.StandardUtilities#getTrailingWhiteSpace(String)}
*/
@Deprecated
public static int getTrailingWhiteSpace(String str)
{
return StandardUtilities.getTrailingWhiteSpace(str);
} //}}}
//{{{ getLeadingWhiteSpaceWidth() method
/**
* Returns the width of the leading white space in the specified
* string.
* @param str The string
* @param tabSize The tab size
* @deprecated use {@link org.gjt.sp.util.StandardUtilities#getLeadingWhiteSpace(String)}
*/
@Deprecated
public static int getLeadingWhiteSpaceWidth(String str, int tabSize)
{
return StandardUtilities.getLeadingWhiteSpaceWidth(str, tabSize);
} //}}}
//{{{ getVirtualWidth() method
/**
* Returns the virtual column number (taking tabs into account) of the
* specified offset in the segment.
*
* @param seg The segment
* @param tabSize The tab size
* @since jEdit 4.1pre1
* @deprecated use {@link org.gjt.sp.util.StandardUtilities#getVirtualWidth(javax.swing.text.Segment, int)}
*/
@Deprecated
public static int getVirtualWidth(Segment seg, int tabSize)
{
return StandardUtilities.getVirtualWidth(seg, tabSize);
} //}}}
//{{{ getOffsetOfVirtualColumn() method
/**
* Returns the array offset of a virtual column number (taking tabs
* into account) in the segment.
*
* @param seg The segment
* @param tabSize The tab size
* @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
* @deprecated use {@link org.gjt.sp.util.StandardUtilities#getVirtualWidth(javax.swing.text.Segment, int)}
*/
@Deprecated
public static int getOffsetOfVirtualColumn(Segment seg, int tabSize,
int column, int[] totalVirtualWidth)
{
return StandardUtilities.getOffsetOfVirtualColumn(seg, tabSize, column, totalVirtualWidth);
} //}}}
//{{{ createWhiteSpace() method
/**
* Creates a string of white space with the specified length.
*
* To get a whitespace string tuned to the current buffer's
* settings, call this method as follows:
*
*
myWhitespace = MiscUtilities.createWhiteSpace(myLength,
* (buffer.getBooleanProperty("noTabs") ? 0
* : buffer.getTabSize()));
*
* @param len The length
* @param tabSize The tab size, or 0 if tabs are not to be used
* @deprecated use {@link org.gjt.sp.util.StandardUtilities#createWhiteSpace(int, int)}
*/
@Deprecated
public static String createWhiteSpace(int len, int tabSize)
{
return StandardUtilities.createWhiteSpace(len,tabSize,0);
} //}}}
//{{{ createWhiteSpace() method
/**
* Creates a string of white space with the specified length.
*
* To get a whitespace string tuned to the current buffer's
* settings, call this method as follows:
*
*
myWhitespace = MiscUtilities.createWhiteSpace(myLength,
* (buffer.getBooleanProperty("noTabs") ? 0
* : buffer.getTabSize()));
*
* @param len The length
* @param tabSize The tab size, or 0 if tabs are not to be used
* @param start The start offset, for tab alignment
* @since jEdit 4.2pre1
* @deprecated use {@link org.gjt.sp.util.StandardUtilities#createWhiteSpace(int, int, int)}
*/
@Deprecated
public static String createWhiteSpace(int len, int tabSize, int start)
{
return StandardUtilities.createWhiteSpace(len, tabSize, start);
} //}}}
//{{{ globToRE() method
/**
* Converts a Unix-style glob to a regular expression.
*
* ? becomes ., * becomes .*, {aa,bb} becomes (aa|bb).
* @param glob The glob pattern
* @deprecated Use {@link org.gjt.sp.util.StandardUtilities#globToRE(String)}.
*/
@Deprecated
public static String globToRE(String glob)
{
return StandardUtilities.globToRE(glob);
} //}}}
//{{{ escapesToChars() method
/**
* Converts "\n" and "\t" escapes in the specified string to
* newlines and tabs.
* @param str The string
* @since jEdit 2.3pre1
*/
public static String escapesToChars(String str)
{
StringBuilder buf = new StringBuilder();
for(int i = 0; i < str.length(); i++)
{
char c = str.charAt(i);
switch(c)
{
case '\\':
if(i == str.length() - 1)
{
buf.append('\\');
break;
}
c = str.charAt(++i);
switch(c)
{
case 'n':
buf.append('\n');
break;
case 't':
buf.append('\t');
break;
default:
buf.append(c);
break;
}
break;
default:
buf.append(c);
}
}
return buf.toString();
} //}}}
//{{{ charsToEscapes() method
/**
* Escapes newlines, tabs, backslashes, and quotes in the specified
* string.
* @param str The string
* @since jEdit 2.3pre1
* @deprecated use {@link org.gjt.sp.util.StandardUtilities#charsToEscapes(String)}
*/
@Deprecated
public static String charsToEscapes(String str)
{
return StandardUtilities.charsToEscapes(str);
} //}}}
//{{{ charsToEscapes() method
/**
* Escapes the specified characters in the specified string.
* @param str The string
* @param toEscape Any characters that require escaping
* @since jEdit 4.1pre3
* @deprecated use {@link org.gjt.sp.util.StandardUtilities#charsToEscapes(String)}
*/
@Deprecated
public static String charsToEscapes(String str, String toEscape)
{
return StandardUtilities.charsToEscapes(str, toEscape);
} //}}}
//{{{ compareVersions() method
/**
* @deprecated Call compareStrings() instead
*/
@Deprecated
public static int compareVersions(String v1, String v2)
{
return StandardUtilities.compareStrings(v1,v2,false);
} //}}}
//{{{ compareStrings() method
/**
* Compares two strings.
*
* Unlike String.compareTo() ,
* this method correctly recognizes and handles embedded numbers.
* For example, it places "My file 2" before "My file 10".
*
* @param str1 The first string
* @param str2 The second string
* @param ignoreCase If true, case will be ignored
* @return negative If str1 < str2, 0 if both are the same,
* positive if str1 > str2
* @since jEdit 4.0pre1
* @deprecated use {@link org.gjt.sp.util.StandardUtilities#compareStrings(String, String, boolean)}
*/
@Deprecated
public static int compareStrings(String str1, String str2, boolean ignoreCase)
{
return StandardUtilities.compareStrings(str1, str2, ignoreCase);
} //}}}
//{{{ stringsEqual() method
/**
* @deprecated Call objectsEqual() instead.
*/
@Deprecated
public static boolean stringsEqual(String s1, String s2)
{
return org.gjt.sp.util.StandardUtilities.objectsEqual(s1,s2);
} //}}}
//{{{ objectsEqual() method
/**
* Returns if two strings are equal. This correctly handles null pointers,
* as opposed to calling o1.equals(o2).
* @since jEdit 4.2pre1
* @deprecated use {@link StandardUtilities#objectsEqual(Object, Object)}
*/
@Deprecated
public static boolean objectsEqual(Object o1, Object o2)
{
return StandardUtilities.objectsEqual(o1, o2);
} //}}}
//{{{ charsToEntities() method
/**
* Converts <, >, & in the string to their HTML entity
* equivalents.
* @param str The string
* @since jEdit 4.2pre1
* @deprecated Use {@link org.gjt.sp.util.XMLUtilities#charsToEntities(String, boolean)}.
*/
@Deprecated
public static String charsToEntities(String str)
{
return XMLUtilities.charsToEntities(str,false);
} //}}}
//{{{ formatFileSize() method
public static final DecimalFormat KB_FORMAT = new DecimalFormat("#.# kB");
public static final DecimalFormat MB_FORMAT = new DecimalFormat("#.# MB");
/**
* Formats the given file size into a nice string (123 Bytes, 10.6 kB,
* 1.2 MB).
* @param length The size
* @since jEdit 4.2pre1
*/
public static String formatFileSize(long length)
{
if(length < 1024)
{
return length + " Bytes";
}
else if(length < 1024 << 10)
{
return KB_FORMAT.format((double)length / 1024);
}
else
{
return MB_FORMAT.format((double)length / 1024 / 1024);
}
} //}}}
//{{{ getLongestPrefix() method
/**
* Returns the longest common prefix in the given set of strings.
* @param str The strings
* @param ignoreCase If true, case insensitive
* @since jEdit 4.2pre2
*/
public static String getLongestPrefix(List str, boolean ignoreCase)
{
if(str.isEmpty())
return "";
int prefixLength = 0;
loop: for(;;)
{
String s = str.get(0).toString();
if(prefixLength >= s.length())
break loop;
char ch = s.charAt(prefixLength);
for(int i = 1; i < str.size(); i++)
{
s = str.get(i).toString();
if(prefixLength >= s.length())
break loop;
if(!compareChars(s.charAt(prefixLength),ch,ignoreCase))
break loop;
}
prefixLength++;
}
return str.get(0).toString().substring(0,prefixLength);
} //}}}
//{{{ getLongestPrefix() method
/**
* Returns the longest common prefix in the given set of strings.
* @param str The strings
* @param ignoreCase If true, case insensitive
* @since jEdit 4.2pre2
*/
public static String getLongestPrefix(String[] str, boolean ignoreCase)
{
return getLongestPrefix((Object[])str,ignoreCase);
} //}}}
//{{{ getLongestPrefix() method
/**
* Returns the longest common prefix in the given set of strings.
* @param str The strings (calls toString() on each object)
* @param ignoreCase If true, case insensitive
* @since jEdit 4.2pre6
*/
public static String getLongestPrefix(Object[] str, boolean ignoreCase)
{
if(str.length == 0)
return "";
int prefixLength = 0;
String first = str[0].toString();
loop: for(;;)
{
if(prefixLength >= first.length())
break loop;
char ch = first.charAt(prefixLength);
for(int i = 1; i < str.length; i++)
{
String s = str[i].toString();
if(prefixLength >= s.length())
break loop;
if(!compareChars(s.charAt(prefixLength),ch,ignoreCase))
break loop;
}
prefixLength++;
}
return first.substring(0,prefixLength);
} //}}}
//}}}
//{{{ quicksort() deprecated methods
/**
* Sorts the specified array. Equivalent to calling
* Arrays.sort().
* @param obj The array
* @param compare Compares the objects
* @since jEdit 4.0pre4
* @deprecated use Arrays.sort()
*/
@Deprecated
public static void quicksort(Object[] obj, Comparator compare)
{
Arrays.sort(obj,compare);
}
/**
* Sorts the specified vector.
* @param vector The vector
* @param compare Compares the objects
* @since jEdit 4.0pre4
* @deprecated Collections.sort()
*/
@Deprecated
public static void quicksort(Vector vector, Comparator compare)
{
Collections.sort(vector,compare);
}
/**
* Sorts the specified list.
* @param list The list
* @param compare Compares the objects
* @since jEdit 4.0pre4
* @deprecated Collections.sort()
*/
@Deprecated
public static void quicksort(List list, Comparator compare)
{
Collections.sort(list,compare);
}
/**
* Sorts the specified array. Equivalent to calling
* Arrays.sort().
* @param obj The array
* @param compare Compares the objects
* @deprecated use Arrays.sort()
*/
@Deprecated
public static void quicksort(Object[] obj, Compare compare)
{
Arrays.sort(obj,compare);
}
/**
* Sorts the specified vector.
* @param vector The vector
* @param compare Compares the objects
* @deprecated Collections.sort()
*/
@Deprecated
public static void quicksort(Vector vector, Compare compare)
{
Collections.sort(vector,compare);
} //}}}
//{{{ Compare deprecated interface
/**
* An interface for comparing objects. This is a hold-over from
* they days when jEdit had its own sorting API due to JDK 1.1
* compatibility requirements. Use java.util.Comparator
* instead.
* @deprecated
*/
@Deprecated
public interface Compare extends Comparator
{
int compare(Object obj1, Object obj2);
} //}}}
//{{{ StringCompare class
/**
* Compares strings.
* @deprecated use {@link org.gjt.sp.util.StandardUtilities.StringCompare}
*/
@Deprecated
public static class StringCompare implements Compare
{
public int compare(Object obj1, Object obj2)
{
return StandardUtilities.compareStrings(obj1.toString(),
obj2.toString(),false);
}
} //}}}
//{{{ StringICaseCompare class
/**
* Compares strings ignoring case.
* @deprecated use {@link org.gjt.sp.util.StandardUtilities.StringCompare}
*/
@Deprecated
public static class StringICaseCompare implements Comparator