org.jruby.util.IdUtil Maven / Gradle / Ivy
/*
***** BEGIN LICENSE BLOCK *****
* Version: CPL 1.0/GPL 2.0/LGPL 2.1
*
* The contents of this file are subject to the Common Public
* License Version 1.0 (the "License"); you may not use this file
* except in compliance with the License. You may obtain a copy of
* the License at http://www.eclipse.org/legal/cpl-v10.html
*
* Software distributed under the License is distributed on an "AS
* IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
* implied. See the License for the specific language governing
* rights and limitations under the License.
*
* Copyright (C) 2001-2002 Jan Arne Petersen
* Copyright (C) 2007 William N Dortch
*
* Alternatively, the contents of this file may be used under the terms of
* either of the GNU General Public License Version 2 or later (the "GPL"),
* or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
* in which case the provisions of the GPL or the LGPL are applicable instead
* of those above. If you wish to allow use of your version of this file only
* under the terms of either the GPL or the LGPL, and not to allow others to
* use your version of this file under the terms of the CPL, indicate your
* decision by deleting the provisions above and replace them with the notice
* and other provisions required by the GPL or the LGPL. If you do not delete
* the provisions above, a recipient may use your version of this file under
* the terms of any one of the CPL, the GPL or the LGPL.
***** END LICENSE BLOCK *****/
package org.jruby.util;
public final class IdUtil {
/**
* rb_is_const_id and is_const_id
*/
public static boolean isConstant(String id) {
return Character.isUpperCase(id.charAt(0));
}
/**
* rb_is_class_id and is_class_id
*/
public static boolean isClassVariable(String id) {
return id.length()>1 && id.charAt(0) == '@' && id.charAt(1) == '@';
}
/**
* rb_is_instance_id and is_instance_id
*/
public static boolean isInstanceVariable(String id) {
return id.length()>0 && id.charAt(0) == '@' && (id.length() < 2 || id.charAt(1) != '@');
}
/**
* rb_is_global_id and is_global_id
*/
public static boolean isGlobal(String id) {
return id.length()>0 && id.charAt(0) == '$';
}
/**
* rb_is_local_id and is_local_id
*/
public static boolean isLocal(String id) {
return !isGlobal(id) && !isClassVariable(id) && !isInstanceVariable(id) && !isConstant(id);
}
public static boolean isAttrSet(String id) {
return id.endsWith("=");
}
public static boolean isValidConstantName(String id) {
char c;
int len;
if ((len = id.length()) > 0 && (c = id.charAt(0)) <= 'Z' && c >= 'A') {
return isNameString(id, 1, len);
}
return false;
}
// Pickaxe says @ must be followed by a name character, but MRI
// does not require this.
public static boolean isValidInstanceVariableName(String id) {
int len;
if ((len = id.length()) > 0 && '@' == id.charAt(0)) {
if (len > 1) {
if (isInitialCharacter(id.charAt(1))) {
return isNameString(id, 2, len);
}
return false;
}
return true;
}
return false;
}
// Pickaxe says @@ must be followed by a name character, but MRI
// does not require this.
public static boolean isValidClassVariableName(String id) {
int len;
if ((len = id.length()) > 1 && '@' == id.charAt(0) && '@' == id.charAt(1)) {
if (len > 2) {
if (isInitialCharacter(id.charAt(2))) {
return isNameString(id, 3, len);
}
return false;
}
return true;
}
return false;
}
public static boolean isInitialCharacter(int c) {
return ((c &= ~0x20) <= 'Z' && c >= 'A') || c == '_';
}
public static boolean isNameCharacter(char c) {
int letter;
return ((letter = c & ~0x20) <= 'Z' && letter >= 'A') ||
c == '_' ||
(c <= '9' && c >= '0');
}
public static boolean isNameString(String id, int start, int limit) {
for (int i = start; i < limit; i++) {
if (!isNameCharacter(id.charAt(i))) {
return false;
}
}
return true;
}
/**
* Check the syntax of a Ruby variable, including that it's longer
* than zero characters, and starts with either an @ or a capital
* letter.
*/
// FIXME: this should go somewhere more generic -- maybe IdUtil
public static final boolean isRubyVariable(String name) {
char c;
return name.length() > 0 && ((c = name.charAt(0)) == '@' || (c <= 'Z' && c >= 'A'));
}
}