eu.mihosoft.vrl.lang.Patterns Maven / Gradle / Ivy
/*
* Patterns.java
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 2009–2015 Steinbeis Forschungszentrum (STZ Ölbronn),
* Copyright (c) 2007–2017 by Michael Hoffer
*
* This file is part of Visual Reflection Library (VRL).
*
* VRL is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License version 3
* as published by the Free Software Foundation.
*
* see: http://opensource.org/licenses/LGPL-3.0
* file://path/to/VRL/src/eu/mihosoft/vrl/resources/license/lgplv3.txt
*
* VRL 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 Lesser General Public License for more details.
*
* This version of VRL includes copyright notice and attribution requirements.
* According to the LGPL this information must be displayed even if you modify
* the source code of VRL. Neither the VRL Canvas attribution icon nor any
* copyright statement/attribution may be removed.
*
* Attribution Requirements:
*
* If you create derived work you must do three things regarding copyright
* notice and author attribution.
*
* First, the following text must be displayed on the Canvas:
* "based on VRL source code". In this case the VRL canvas icon must be removed.
*
* Second, the copyright notice must remain. It must be reproduced in any
* program that uses VRL.
*
* Third, add an additional notice, stating that you modified VRL. A suitable
* notice might read
* "VRL source code modified by YourName 2012".
*
* Note, that these requirements are in full accordance with the LGPL v3
* (see 7. Additional Terms, b).
*
* Please cite the publication(s) listed below.
*
* Publications:
*
* M. Hoffer, C. Poliwoda, & G. Wittum. (2013). Visual reflection library:
* a framework for declarative GUI programming on the Java platform.
* Computing and Visualization in Science, 2013, 16(4),
* 181–192. http://doi.org/10.1007/s00791-014-0230-y
*/
package eu.mihosoft.vrl.lang;
import java.util.regex.Pattern;
/**
* Regular expression patterns for analysing Java/Groovy sourcecode.
*
* @author Michael Hoffer <[email protected]>
*/
public class Patterns {
/**
* Regular expression for a valid identifier (variable, class or method
* names).
*/
public static final String IDENTIFIER_STRING = "[a-zA-Z\\p{L}$_][a-zA-Z\\p{L}$_0-9]*";
/**
* Regular expression for a valid vrl identifier (variable, class or method
* names). VRL does not allow names that contain the $ sign.
* @see VLangUtils#isComponentClassNameValid(java.lang.String)
*/
public static final String VRL_IDENTIFIER_STRING = "[a-zA-Z\\p{L}_][a-zA-Z\\p{L}_0-9]*";
/**
* Regular expression for a valid vrl class identifier. VRL does not allow
* class names that start with lowercase characters or contain
* the $ sign.
* @see VLangUtils#isComponentClassNameValid(java.lang.String)
*/
public static final String VRL_CLASS_IDENTIFIER_STRING = "[\\p{Lu}_][\\p{L}_0-9]*";
/**
* Regular expression for a list of valid identifiers.
*/
public static final String IDENTIFIER_LIST_STRING =
"(" + IDENTIFIER_STRING + "\\s*,\\s*)*"
+ IDENTIFIER_STRING;
/**
* Regular expression to match a valid template argument, e.g,
* <T,V>.
*/
public static final String TEMPLATE_ARGUMENT_STRING =
"<\\s*" + IDENTIFIER_LIST_STRING + "\\s*>";
/**
* Regular expression to match block-comments.
Note: does
* also match block-comments inside strings! Thus, to work correctly strings
* have to be removed before using this expression.
*/
public static final String BLOCK_COMMENT_STRING =
"/\\*(?:.|[\\n\\r])*?\\*/";
/**
* Regular expression to match package names.
(default package, i.e.,
* empty string is NOT supported)
*/
public static final String PACKAGE_NAME_STRING =
"(" + IDENTIFIER_STRING + ")" + "(\\." + IDENTIFIER_STRING + ")*";
/**
* Regular expression to match class definition (without class name).
*/
public static final String CLASS_DEFINITION_WITHOUT_IDENTIFIER_STRING =
"(\\s+|^|(\\s+|^)public\\s+|(\\s+|^)protected\\s+|(\\s+|^)"
+ "private\\s+)(static\\s+|abstract\\s+|final\\s+|)class\\s+";
/**
* Regular expression to match interface definition (without interface
* name).
*/
public static final String INTERFACE_DEFINITION_WITHOUT_IDENTIFIER_STRING =
"(\\s+|^|(\\s+|^)public\\s+|(\\s+|^)protected\\s+|(\\s+|^)"
+ "private\\s+)(static\\s+|abstract\\s+|final\\s+|)interface\\s+";
/**
* Regular expression to match class definition.
*/
public static final String CLASS_DEFINITION_STRING =
CLASS_DEFINITION_WITHOUT_IDENTIFIER_STRING
+ IDENTIFIER_STRING;
/**
* Regular expression to match interface definition.
*/
public static final String INTERFACE_DEFINITION_STRING =
INTERFACE_DEFINITION_WITHOUT_IDENTIFIER_STRING
+ IDENTIFIER_STRING;
/**
* Regular expression to match variable assignments.
*/
public static final String VARIABLE_ASSIGNMENT_STRING =
"^" + IDENTIFIER_STRING + "\\s*=\\s*";
/**
* Regular expression to match plugin names.
*/
// public static final String PLUGIN_NAME_STRING = "[A-Za-z0-9-+_\\s]+";
public static final String PLUGIN_NAME_STRING = "[A-Za-z0-9-+_]+"; // we dont want spaces anymore
/**
* Pattern to match plugin names.
*/
public static final Pattern PLUGIN_NAME =
Pattern.compile(PLUGIN_NAME_STRING);
/**
* Pattern to match variable assignment.
*/
public static final Pattern VARIABLE_ASSIGNMENT_PATTERN =
Pattern.compile(VARIABLE_ASSIGNMENT_STRING, Pattern.MULTILINE);
/**
* Pattern to match class definition. Example:
*
* public class Sample01
*
*/
public static final Pattern CLASS_DEFINITION =
Pattern.compile(CLASS_DEFINITION_STRING);
/**
* Pattern to match interface definition. Example:
*
* public interface Sample01
*
*/
public static final Pattern INTERFACE_DEFINITION =
Pattern.compile(INTERFACE_DEFINITION_STRING);
/**
* Pattern to match template class headers. Example:
*
* public class Sample01 <Type, Type2> extends Base01
*
*/
public static final Pattern TEMPLATE_CLS_HEADER = Pattern.compile(
"(\\s+|^|(\\s+|^)public\\s+|(\\s+|^)protected\\s+|(\\s+|^)"
+ "private\\s+)(static\\s+|abstract\\s+|final\\s+|)class\\s+"
+ IDENTIFIER_STRING
+ "\\s*" + TEMPLATE_ARGUMENT_STRING
+ "(\\s*extends\\s+" + IDENTIFIER_STRING + ")*"
+ "(\\s+implements\\s+" + IDENTIFIER_LIST_STRING + ")*",
Pattern.MULTILINE);
/**
* Pattern to match template arguments, e.g.,
* <T,V>.
*/
public static final Pattern TEMPLATE_ARGUMENT = Pattern.compile(TEMPLATE_ARGUMENT_STRING);
/**
* Pattern to match an identifier.
*/
public static final Pattern IDENTIFIER = Pattern.compile(IDENTIFIER_STRING);
/**
* Pattern to match an identifier list.
*/
public static final Pattern IDENTIFIER_LIST = Pattern.compile(IDENTIFIER_LIST_STRING);
/**
* Pattern to match package definition.
*/
public static final String PACKAGE_DEFINITION_STRING =
"^\\s*package\\s+" + Patterns.PACKAGE_NAME_STRING + "\\s*;"+ "\\s*";
/**
* Pattern to match package definition.
*/
public static final Pattern PACKAGE_DEFINITION =
Pattern.compile(PACKAGE_DEFINITION_STRING,
Pattern.DOTALL | Pattern.MULTILINE);
/**
* Pattern to match package name (default package, i.e., empty string is NOT
* supported)
*/
public static final Pattern PACKAGE_NAME =
Pattern.compile(PACKAGE_NAME_STRING,
Pattern.DOTALL);
/**
* Regular expression to match import definition.
*/
// \\b is stands for word boundary
public static final String IMPORT_DEFINITION_STRING =
"\\bimport\\b\\s+" + Patterns.PACKAGE_NAME_STRING
+ "\\s*(;|\\.\\*\\s*;)";
/**
* Pattern to match import definition.
*/
public static final Pattern IMPORT_DEFINITION =
Pattern.compile(IMPORT_DEFINITION_STRING,
Pattern.DOTALL);
/**
* Creates a regular expression to match opening and closing vrl tags with
* the specified tag name. All characters between the tags are captured
* into the first backreference. Backreferences are accessible in the
* replacement text via
* $1, $2, $3 etc..
*
* @param tagName tag name
* @return a regular expression to match opening and closing vrl tags with
* the specified tag name
*/
public static String createVRLTagPatternString(String tagName) {
return "<" + tagName + ".*?>.*?";
}
/**
* Creates a regular expression to match opening vrl tags with the specified
* tag name.
*
* @param tagName tag name
* @return a regular expression to match opening vrl tags with the specified
* tag name
*/
public static String createVRLOpenTagPatternString(String tagName) {
return "<\\s*" + tagName + ".*?>";
}
/**
* Creates a regular expression to match closing vrl tags with the specified
* tag name.
*
* @param tagName tag name
* @return a regular expression to match closing vrl tags with the specified
* tag name
*/
public static String createVRLCloseTagPatternString(String tagName) {
return "";
}
/**
* Creates a pattern to match opening vrl tags with the specified tag name.
*
* @param tagName tag name
* @return a pattern to match opening vrl tags with the specified tag name
*/
public static Pattern createVRLOpenTagPattern(String tagName) {
return Pattern.compile(createVRLOpenTagPatternString(tagName));
}
/**
* Creates a pattern to match closing vrl tags with the specified tag name.
*
* @param tagName
* @return a pattern to match closing vrl tags with the specified tag name
*/
public static Pattern createVRLCloseTagPattern(String tagName) {
return Pattern.compile(createVRLCloseTagPatternString(tagName));
}
/**
* Creates a pattern to match opening and closing vrl tags with the
* specified tag name. All characters between the tags is captured into the
* first backreference. Backreferences are accessible in the replacement
* text via
* $1, $2, $3 etc..
*
* @param tagName
* @return a pattern to match opening and closing vrl tags with the
* specified tag name
*/
public static Pattern createVRLTagPattern(String tagName) {
return Pattern.compile(createVRLTagPatternString(tagName),
Pattern.DOTALL);
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy