aboutsummaryrefslogtreecommitdiffstats
path: root/subprojects/language/src/main/java/tools/refinery/language/naming/NamingUtil.java
blob: feae5ebb089412a55a98f110c5e0d345e9318eaf (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
/*
 * SPDX-FileCopyrightText: 2021-2024 The Refinery Authors <https://refinery.tools/>
 *
 * SPDX-License-Identifier: EPL-2.0
 */
package tools.refinery.language.naming;

import org.eclipse.xtext.naming.QualifiedName;

import java.util.regex.Pattern;

public final class NamingUtil {
	private static final String SINGLETON_VARIABLE_PREFIX = "_";
	public static final QualifiedName ROOT_NAME = QualifiedName.create("");

	private static final Pattern ID_REGEX = Pattern.compile("[_a-zA-Z]\\w*");

	private NamingUtil() {
		throw new IllegalStateException("This is a static utility class and should not be instantiated directly");
	}

	public static boolean isNullOrEmpty(String name) {
		return name == null || name.isEmpty();
	}

	public static boolean isSingletonVariableName(String name) {
		return name != null && name.startsWith(SINGLETON_VARIABLE_PREFIX);
	}

	// This method name only makes sense if it checks for the positive case.
	@SuppressWarnings("BooleanMethodIsAlwaysInverted")
	public static boolean isValidId(String name) {
		return name != null && ID_REGEX.matcher(name).matches();
	}

	public static boolean isFullyQualified(QualifiedName name) {
		return name.startsWith(ROOT_NAME);
	}

	public static QualifiedName stripRootPrefix(QualifiedName name) {
		if (name == null) {
			return null;
		}
		return isFullyQualified(name) ? name.skipFirst(ROOT_NAME.getSegmentCount()) : name;
	}

	public static QualifiedName addRootPrefix(QualifiedName name) {
		if (name == null) {
			return null;
		}
		return isFullyQualified(name) ? name : ROOT_NAME.append(name);
	}
}