Bharat saraswal | 9745996 | 2016-02-20 21:57:16 +0530 | [diff] [blame] | 1 | /* |
Brian O'Connor | 0f7908b | 2016-04-09 01:19:45 -0700 | [diff] [blame] | 2 | * Copyright 2016-present Open Networking Laboratory |
Bharat saraswal | 9745996 | 2016-02-20 21:57:16 +0530 | [diff] [blame] | 3 | * |
| 4 | * Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | * you may not use this file except in compliance with the License. |
| 6 | * You may obtain a copy of the License at |
| 7 | * |
| 8 | * http://www.apache.org/licenses/LICENSE-2.0 |
| 9 | * |
| 10 | * Unless required by applicable law or agreed to in writing, software |
| 11 | * distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | * See the License for the specific language governing permissions and |
| 14 | * limitations under the License. |
| 15 | */ |
| 16 | |
| 17 | package org.onosproject.yangutils.translator.tojava.utils; |
| 18 | |
Gaurav Agrawal | bfce934 | 2016-06-15 13:58:01 +0530 | [diff] [blame] | 19 | import java.io.File; |
| 20 | import java.io.IOException; |
Vidyashree Rama | 13b4c55 | 2016-06-20 15:12:43 +0530 | [diff] [blame] | 21 | import java.text.SimpleDateFormat; |
Bharat saraswal | 9745996 | 2016-02-20 21:57:16 +0530 | [diff] [blame] | 22 | import java.util.ArrayList; |
Bharat saraswal | 8beac34 | 2016-08-04 02:00:03 +0530 | [diff] [blame] | 23 | import java.util.Arrays; |
| 24 | import java.util.Collections; |
Vidyashree Rama | 13b4c55 | 2016-06-20 15:12:43 +0530 | [diff] [blame] | 25 | import java.util.Date; |
janani b | 1c6acc4 | 2016-04-15 16:18:30 +0530 | [diff] [blame] | 26 | import java.util.List; |
Bharat saraswal | 8beac34 | 2016-08-04 02:00:03 +0530 | [diff] [blame] | 27 | |
Vinod Kumar S | 9f26ae5 | 2016-03-23 15:30:27 +0530 | [diff] [blame] | 28 | import org.onosproject.yangutils.datamodel.YangNode; |
Bharat saraswal | e50edca | 2016-08-05 01:58:25 +0530 | [diff] [blame] | 29 | import org.onosproject.yangutils.utils.io.YangToJavaNamingConflictUtil; |
Bharat saraswal | 8beac34 | 2016-08-04 02:00:03 +0530 | [diff] [blame] | 30 | import org.onosproject.yangutils.translator.exception.TranslatorException; |
| 31 | import org.onosproject.yangutils.translator.tojava.JavaFileInfoContainer; |
Bharat saraswal | e50edca | 2016-08-05 01:58:25 +0530 | [diff] [blame] | 32 | import org.onosproject.yangutils.translator.tojava.JavaFileInfoTranslator; |
Bharat saraswal | 84366c5 | 2016-03-23 19:40:35 +0530 | [diff] [blame] | 33 | |
Gaurav Agrawal | bfce934 | 2016-06-15 13:58:01 +0530 | [diff] [blame] | 34 | import static org.onosproject.yangutils.datamodel.utils.DataModelUtils.getParentNodeInGenCode; |
Bharat saraswal | 84366c5 | 2016-03-23 19:40:35 +0530 | [diff] [blame] | 35 | import static org.onosproject.yangutils.utils.UtilConstants.COLAN; |
| 36 | import static org.onosproject.yangutils.utils.UtilConstants.DEFAULT_BASE_PKG; |
| 37 | import static org.onosproject.yangutils.utils.UtilConstants.EMPTY_STRING; |
| 38 | import static org.onosproject.yangutils.utils.UtilConstants.HYPHEN; |
| 39 | import static org.onosproject.yangutils.utils.UtilConstants.JAVA_KEY_WORDS; |
| 40 | import static org.onosproject.yangutils.utils.UtilConstants.PERIOD; |
| 41 | import static org.onosproject.yangutils.utils.UtilConstants.QUOTES; |
| 42 | import static org.onosproject.yangutils.utils.UtilConstants.REGEX_FOR_FIRST_DIGIT; |
janani b | 1c6acc4 | 2016-04-15 16:18:30 +0530 | [diff] [blame] | 43 | import static org.onosproject.yangutils.utils.UtilConstants.REGEX_WITH_ALL_SPECIAL_CHAR; |
Bharat saraswal | d532a4c | 2016-03-25 18:19:46 +0530 | [diff] [blame] | 44 | import static org.onosproject.yangutils.utils.UtilConstants.REVISION_PREFIX; |
Bharat saraswal | 84366c5 | 2016-03-23 19:40:35 +0530 | [diff] [blame] | 45 | import static org.onosproject.yangutils.utils.UtilConstants.SLASH; |
| 46 | import static org.onosproject.yangutils.utils.UtilConstants.UNDER_SCORE; |
Bharat saraswal | d532a4c | 2016-03-25 18:19:46 +0530 | [diff] [blame] | 47 | import static org.onosproject.yangutils.utils.UtilConstants.VERSION_PREFIX; |
Gaurav Agrawal | bfce934 | 2016-06-15 13:58:01 +0530 | [diff] [blame] | 48 | import static org.onosproject.yangutils.utils.io.impl.YangIoUtils.addPackageInfo; |
| 49 | import static org.onosproject.yangutils.utils.io.impl.YangIoUtils.createDirectories; |
| 50 | import static org.onosproject.yangutils.utils.io.impl.YangIoUtils.getAbsolutePackagePath; |
| 51 | import static org.onosproject.yangutils.utils.io.impl.YangIoUtils.getJavaPackageFromPackagePath; |
| 52 | import static org.onosproject.yangutils.utils.io.impl.YangIoUtils.getPackageDirPathFromJavaJPackage; |
Bharat saraswal | 8beac34 | 2016-08-04 02:00:03 +0530 | [diff] [blame] | 53 | import static org.onosproject.yangutils.utils.io.impl.YangIoUtils.getPrefixForIdentifier; |
Bharat saraswal | 9745996 | 2016-02-20 21:57:16 +0530 | [diff] [blame] | 54 | |
| 55 | /** |
Bharat saraswal | 63f26fb | 2016-04-05 15:13:44 +0530 | [diff] [blame] | 56 | * Represents an utility Class for translating the name from YANG to java convention. |
Bharat saraswal | 9745996 | 2016-02-20 21:57:16 +0530 | [diff] [blame] | 57 | */ |
| 58 | public final class JavaIdentifierSyntax { |
| 59 | |
b.janani | e6d43af | 2016-03-04 12:29:05 +0530 | [diff] [blame] | 60 | private static final int INDEX_ZERO = 0; |
| 61 | private static final int INDEX_ONE = 1; |
Bharat saraswal | 780eca3 | 2016-04-05 12:45:45 +0530 | [diff] [blame] | 62 | private static final int VALUE_CHECK = 10; |
| 63 | private static final String ZERO = "0"; |
Vidyashree Rama | 13b4c55 | 2016-06-20 15:12:43 +0530 | [diff] [blame] | 64 | private static final String DATE_FORMAT = "yyyy-MM-dd"; |
b.janani | e6d43af | 2016-03-04 12:29:05 +0530 | [diff] [blame] | 65 | |
Bharat saraswal | 9745996 | 2016-02-20 21:57:16 +0530 | [diff] [blame] | 66 | /** |
Bharat saraswal | 63f26fb | 2016-04-05 15:13:44 +0530 | [diff] [blame] | 67 | * Create instance of java identifier syntax. |
Bharat saraswal | 9745996 | 2016-02-20 21:57:16 +0530 | [diff] [blame] | 68 | */ |
| 69 | private JavaIdentifierSyntax() { |
| 70 | } |
| 71 | |
| 72 | /** |
Bharat saraswal | 63f26fb | 2016-04-05 15:13:44 +0530 | [diff] [blame] | 73 | * Returns the root package string. |
Bharat saraswal | 9745996 | 2016-02-20 21:57:16 +0530 | [diff] [blame] | 74 | * |
Gaurav Agrawal | bfce934 | 2016-06-15 13:58:01 +0530 | [diff] [blame] | 75 | * @param version YANG version |
| 76 | * @param nameSpace name space of the module |
| 77 | * @param revision revision of the module defined |
janani b | 3e357f6 | 2016-05-19 17:39:50 +0530 | [diff] [blame] | 78 | * @param conflictResolver object of YANG to java naming conflict util |
| 79 | * @return the root package string |
Bharat saraswal | 9745996 | 2016-02-20 21:57:16 +0530 | [diff] [blame] | 80 | */ |
Vidyashree Rama | 13b4c55 | 2016-06-20 15:12:43 +0530 | [diff] [blame] | 81 | public static String getRootPackage(byte version, String nameSpace, Date revision, |
Gaurav Agrawal | bfce934 | 2016-06-15 13:58:01 +0530 | [diff] [blame] | 82 | YangToJavaNamingConflictUtil conflictResolver) { |
Bharat saraswal | 9745996 | 2016-02-20 21:57:16 +0530 | [diff] [blame] | 83 | |
| 84 | String pkg; |
Bharat saraswal | 84366c5 | 2016-03-23 19:40:35 +0530 | [diff] [blame] | 85 | pkg = DEFAULT_BASE_PKG; |
| 86 | pkg = pkg + PERIOD; |
Bharat saraswal | 9745996 | 2016-02-20 21:57:16 +0530 | [diff] [blame] | 87 | pkg = pkg + getYangVersion(version); |
Bharat saraswal | 84366c5 | 2016-03-23 19:40:35 +0530 | [diff] [blame] | 88 | pkg = pkg + PERIOD; |
janani b | 3e357f6 | 2016-05-19 17:39:50 +0530 | [diff] [blame] | 89 | pkg = pkg + getPkgFromNameSpace(nameSpace, conflictResolver); |
Bharat saraswal | 84366c5 | 2016-03-23 19:40:35 +0530 | [diff] [blame] | 90 | pkg = pkg + PERIOD; |
Bharat saraswal | 9745996 | 2016-02-20 21:57:16 +0530 | [diff] [blame] | 91 | pkg = pkg + getYangRevisionStr(revision); |
| 92 | |
Bharat saraswal | c46ee2a | 2016-02-25 02:26:43 +0530 | [diff] [blame] | 93 | return pkg.toLowerCase(); |
Bharat saraswal | 9745996 | 2016-02-20 21:57:16 +0530 | [diff] [blame] | 94 | } |
| 95 | |
| 96 | /** |
| 97 | * Returns version. |
| 98 | * |
Vinod Kumar S | 0871098 | 2016-03-03 19:55:30 +0530 | [diff] [blame] | 99 | * @param ver YANG version |
Bharat saraswal | 9745996 | 2016-02-20 21:57:16 +0530 | [diff] [blame] | 100 | * @return version |
| 101 | */ |
| 102 | private static String getYangVersion(byte ver) { |
Bharat saraswal | d532a4c | 2016-03-25 18:19:46 +0530 | [diff] [blame] | 103 | return VERSION_PREFIX + ver; |
Bharat saraswal | 9745996 | 2016-02-20 21:57:16 +0530 | [diff] [blame] | 104 | } |
| 105 | |
| 106 | /** |
Bharat saraswal | 63f26fb | 2016-04-05 15:13:44 +0530 | [diff] [blame] | 107 | * Returns package name from name space. |
Bharat saraswal | 9745996 | 2016-02-20 21:57:16 +0530 | [diff] [blame] | 108 | * |
Gaurav Agrawal | bfce934 | 2016-06-15 13:58:01 +0530 | [diff] [blame] | 109 | * @param nameSpace name space of YANG module |
janani b | 3e357f6 | 2016-05-19 17:39:50 +0530 | [diff] [blame] | 110 | * @param conflictResolver object of YANG to java naming conflict util |
Vinod Kumar S | 0871098 | 2016-03-03 19:55:30 +0530 | [diff] [blame] | 111 | * @return java package name as per java rules |
Bharat saraswal | 9745996 | 2016-02-20 21:57:16 +0530 | [diff] [blame] | 112 | */ |
janani b | 3e357f6 | 2016-05-19 17:39:50 +0530 | [diff] [blame] | 113 | private static String getPkgFromNameSpace(String nameSpace, YangToJavaNamingConflictUtil conflictResolver) { |
Vinod Kumar S | 9f26ae5 | 2016-03-23 15:30:27 +0530 | [diff] [blame] | 114 | |
Bharat saraswal | 8beac34 | 2016-08-04 02:00:03 +0530 | [diff] [blame] | 115 | ArrayList<String> pkgArr = new ArrayList<>(); |
Bharat saraswal | 84366c5 | 2016-03-23 19:40:35 +0530 | [diff] [blame] | 116 | nameSpace = nameSpace.replace(QUOTES, EMPTY_STRING); |
janani b | 1c6acc4 | 2016-04-15 16:18:30 +0530 | [diff] [blame] | 117 | String properNameSpace = nameSpace.replaceAll(REGEX_WITH_ALL_SPECIAL_CHAR, COLAN); |
Bharat saraswal | 84366c5 | 2016-03-23 19:40:35 +0530 | [diff] [blame] | 118 | String[] nameSpaceArr = properNameSpace.split(COLAN); |
Bharat saraswal | 9745996 | 2016-02-20 21:57:16 +0530 | [diff] [blame] | 119 | |
Bharat saraswal | 8beac34 | 2016-08-04 02:00:03 +0530 | [diff] [blame] | 120 | Collections.addAll(pkgArr, nameSpaceArr); |
janani b | 3e357f6 | 2016-05-19 17:39:50 +0530 | [diff] [blame] | 121 | return getPkgFrmArr(pkgArr, conflictResolver); |
Bharat saraswal | 9745996 | 2016-02-20 21:57:16 +0530 | [diff] [blame] | 122 | } |
| 123 | |
| 124 | /** |
| 125 | * Returns revision string array. |
| 126 | * |
| 127 | * @param date YANG module revision |
| 128 | * @return revision string |
| 129 | */ |
Vidyashree Rama | 13b4c55 | 2016-06-20 15:12:43 +0530 | [diff] [blame] | 130 | private static String getYangRevisionStr(Date date) { |
| 131 | SimpleDateFormat sdf = new SimpleDateFormat(DATE_FORMAT); |
| 132 | String dateInString = sdf.format(date); |
| 133 | String[] revisionArr = dateInString.split(HYPHEN); |
Bharat saraswal | 9745996 | 2016-02-20 21:57:16 +0530 | [diff] [blame] | 134 | |
Bharat saraswal | d532a4c | 2016-03-25 18:19:46 +0530 | [diff] [blame] | 135 | String rev = REVISION_PREFIX; |
Bharat saraswal | 022dae9 | 2016-03-04 20:08:09 +0530 | [diff] [blame] | 136 | rev = rev + revisionArr[INDEX_ZERO]; |
b.janani | e6d43af | 2016-03-04 12:29:05 +0530 | [diff] [blame] | 137 | |
Vidyashree Rama | 13b4c55 | 2016-06-20 15:12:43 +0530 | [diff] [blame] | 138 | for (int i = INDEX_ONE; i < revisionArr.length; i++) { |
| 139 | Integer val = Integer.parseInt(revisionArr[i]); |
| 140 | if (val < VALUE_CHECK) { |
| 141 | rev = rev + ZERO; |
Bharat saraswal | 9745996 | 2016-02-20 21:57:16 +0530 | [diff] [blame] | 142 | } |
Vidyashree Rama | 13b4c55 | 2016-06-20 15:12:43 +0530 | [diff] [blame] | 143 | rev = rev + val; |
Bharat saraswal | 9745996 | 2016-02-20 21:57:16 +0530 | [diff] [blame] | 144 | } |
Vidyashree Rama | 13b4c55 | 2016-06-20 15:12:43 +0530 | [diff] [blame] | 145 | return rev; |
Bharat saraswal | 9745996 | 2016-02-20 21:57:16 +0530 | [diff] [blame] | 146 | } |
| 147 | |
| 148 | /** |
| 149 | * Returns the package string. |
| 150 | * |
Gaurav Agrawal | bfce934 | 2016-06-15 13:58:01 +0530 | [diff] [blame] | 151 | * @param pkgArr package array |
janani b | 3e357f6 | 2016-05-19 17:39:50 +0530 | [diff] [blame] | 152 | * @param conflictResolver object of YANG to java naming conflict util |
Bharat saraswal | 9745996 | 2016-02-20 21:57:16 +0530 | [diff] [blame] | 153 | * @return package string |
| 154 | */ |
janani b | 3e357f6 | 2016-05-19 17:39:50 +0530 | [diff] [blame] | 155 | private static String getPkgFrmArr(ArrayList<String> pkgArr, YangToJavaNamingConflictUtil conflictResolver) { |
Bharat saraswal | 9745996 | 2016-02-20 21:57:16 +0530 | [diff] [blame] | 156 | |
Bharat saraswal | 84366c5 | 2016-03-23 19:40:35 +0530 | [diff] [blame] | 157 | String pkg = EMPTY_STRING; |
Bharat saraswal | 9745996 | 2016-02-20 21:57:16 +0530 | [diff] [blame] | 158 | int size = pkgArr.size(); |
| 159 | int i = 0; |
| 160 | for (String member : pkgArr) { |
janani b | 3e357f6 | 2016-05-19 17:39:50 +0530 | [diff] [blame] | 161 | boolean presenceOfKeyword = JAVA_KEY_WORDS.contains(member.toLowerCase()); |
Bharat saraswal | 84366c5 | 2016-03-23 19:40:35 +0530 | [diff] [blame] | 162 | if (presenceOfKeyword || member.matches(REGEX_FOR_FIRST_DIGIT)) { |
Bharat saraswal | 8beac34 | 2016-08-04 02:00:03 +0530 | [diff] [blame] | 163 | String prefix = getPrefixForIdentifier(conflictResolver); |
janani b | 3e357f6 | 2016-05-19 17:39:50 +0530 | [diff] [blame] | 164 | member = prefix + member; |
b.janani | e6d43af | 2016-03-04 12:29:05 +0530 | [diff] [blame] | 165 | } |
Bharat saraswal | 9745996 | 2016-02-20 21:57:16 +0530 | [diff] [blame] | 166 | pkg = pkg + member; |
| 167 | if (i != size - 1) { |
Bharat saraswal | 84366c5 | 2016-03-23 19:40:35 +0530 | [diff] [blame] | 168 | pkg = pkg + PERIOD; |
Bharat saraswal | 9745996 | 2016-02-20 21:57:16 +0530 | [diff] [blame] | 169 | } |
| 170 | i++; |
| 171 | } |
| 172 | return pkg; |
| 173 | } |
| 174 | |
| 175 | /** |
Bharat saraswal | 68fa0d1 | 2016-04-19 01:00:16 +0530 | [diff] [blame] | 176 | * Returns enum's java name. |
| 177 | * |
| 178 | * @param name enum's name |
| 179 | * @return enum's java name |
| 180 | */ |
| 181 | public static String getEnumJavaAttribute(String name) { |
| 182 | |
janani b | 3e357f6 | 2016-05-19 17:39:50 +0530 | [diff] [blame] | 183 | name = name.replaceAll(REGEX_WITH_ALL_SPECIAL_CHAR, COLAN); |
| 184 | String[] strArray = name.split(COLAN); |
Bharat saraswal | 68fa0d1 | 2016-04-19 01:00:16 +0530 | [diff] [blame] | 185 | String output = EMPTY_STRING; |
janani b | 3e357f6 | 2016-05-19 17:39:50 +0530 | [diff] [blame] | 186 | if (strArray[0].isEmpty()) { |
Bharat saraswal | 8beac34 | 2016-08-04 02:00:03 +0530 | [diff] [blame] | 187 | List<String> stringArrangement = new ArrayList<>(); |
| 188 | stringArrangement.addAll(Arrays.asList(strArray).subList(1, strArray.length)); |
janani b | 3e357f6 | 2016-05-19 17:39:50 +0530 | [diff] [blame] | 189 | strArray = stringArrangement.toArray(new String[stringArrangement.size()]); |
| 190 | } |
Bharat saraswal | 68fa0d1 | 2016-04-19 01:00:16 +0530 | [diff] [blame] | 191 | for (int i = 0; i < strArray.length; i++) { |
janani b | 3e357f6 | 2016-05-19 17:39:50 +0530 | [diff] [blame] | 192 | if (i > 0 && i < strArray.length) { |
Bharat saraswal | 68fa0d1 | 2016-04-19 01:00:16 +0530 | [diff] [blame] | 193 | output = output + UNDER_SCORE; |
| 194 | } |
janani b | 3e357f6 | 2016-05-19 17:39:50 +0530 | [diff] [blame] | 195 | output = output + strArray[i]; |
Bharat saraswal | 68fa0d1 | 2016-04-19 01:00:16 +0530 | [diff] [blame] | 196 | } |
| 197 | return output; |
| 198 | } |
| 199 | |
| 200 | /** |
Gaurav Agrawal | bfce934 | 2016-06-15 13:58:01 +0530 | [diff] [blame] | 201 | * Creates a package structure with package info java file if not present. |
Vinod Kumar S | 9f26ae5 | 2016-03-23 15:30:27 +0530 | [diff] [blame] | 202 | * |
Gaurav Agrawal | bfce934 | 2016-06-15 13:58:01 +0530 | [diff] [blame] | 203 | * @param yangNode YANG node for which code is being generated |
| 204 | * @throws IOException any IO exception |
Vinod Kumar S | 9f26ae5 | 2016-03-23 15:30:27 +0530 | [diff] [blame] | 205 | */ |
Gaurav Agrawal | bfce934 | 2016-06-15 13:58:01 +0530 | [diff] [blame] | 206 | public static void createPackage(YangNode yangNode) throws IOException { |
| 207 | if (!(yangNode instanceof JavaFileInfoContainer)) { |
| 208 | throw new TranslatorException("current node must have java file info"); |
| 209 | } |
| 210 | String pkgInfo; |
Bharat saraswal | e50edca | 2016-08-05 01:58:25 +0530 | [diff] [blame] | 211 | JavaFileInfoTranslator javaFileInfo = ((JavaFileInfoContainer) yangNode).getJavaFileInfo(); |
Gaurav Agrawal | bfce934 | 2016-06-15 13:58:01 +0530 | [diff] [blame] | 212 | String pkg = getAbsolutePackagePath(javaFileInfo.getBaseCodeGenPath(), javaFileInfo.getPackageFilePath()); |
| 213 | if (!doesPackageExist(pkg)) { |
| 214 | try { |
| 215 | File pack = createDirectories(pkg); |
| 216 | YangNode parent = getParentNodeInGenCode(yangNode); |
| 217 | if (parent != null) { |
| 218 | pkgInfo = ((JavaFileInfoContainer) parent).getJavaFileInfo().getJavaName(); |
| 219 | addPackageInfo(pack, pkgInfo, getJavaPackageFromPackagePath(pkg), true, |
| 220 | ((JavaFileInfoContainer) parent).getJavaFileInfo().getPluginConfig()); |
| 221 | } else { |
| 222 | pkgInfo = ((JavaFileInfoContainer) yangNode).getJavaFileInfo().getJavaName(); |
| 223 | addPackageInfo(pack, pkgInfo, getJavaPackageFromPackagePath(pkg), false, |
| 224 | ((JavaFileInfoContainer) yangNode).getJavaFileInfo().getPluginConfig()); |
| 225 | } |
| 226 | } catch (IOException e) { |
| 227 | throw new IOException("failed to create package-info file"); |
| 228 | } |
| 229 | } |
| 230 | } |
| 231 | |
| 232 | /** |
| 233 | * Checks if the package directory structure created. |
| 234 | * |
| 235 | * @param pkg Package to check if it is created |
| 236 | * @return existence status of package |
| 237 | */ |
Bharat saraswal | 8beac34 | 2016-08-04 02:00:03 +0530 | [diff] [blame] | 238 | static boolean doesPackageExist(String pkg) { |
Gaurav Agrawal | bfce934 | 2016-06-15 13:58:01 +0530 | [diff] [blame] | 239 | File pkgDir = new File(getPackageDirPathFromJavaJPackage(pkg)); |
| 240 | File pkgWithFile = new File(pkgDir + SLASH + "package-info.java"); |
| 241 | return pkgDir.exists() && pkgWithFile.isFile(); |
Vinod Kumar S | 9f26ae5 | 2016-03-23 15:30:27 +0530 | [diff] [blame] | 242 | } |
Bharat saraswal | 9745996 | 2016-02-20 21:57:16 +0530 | [diff] [blame] | 243 | } |