blob: 1c1de71529a57cf2a92db9002aabd5e7a66e17fe [file] [log] [blame]
Bharat saraswal97459962016-02-20 21:57:16 +05301/*
Brian O'Connor0f7908b2016-04-09 01:19:45 -07002 * Copyright 2016-present Open Networking Laboratory
Bharat saraswal97459962016-02-20 21:57:16 +05303 *
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
17package org.onosproject.yangutils.utils.io.impl;
18
Bharat saraswal715d3fc2016-05-17 19:59:16 +053019import java.io.BufferedReader;
Bharat saraswal97459962016-02-20 21:57:16 +053020import java.io.BufferedWriter;
21import java.io.File;
Bharat saraswal715d3fc2016-05-17 19:59:16 +053022import java.io.FileReader;
Bharat saraswal97459962016-02-20 21:57:16 +053023import java.io.FileWriter;
24import java.io.IOException;
Vinod Kumar S9f26ae52016-03-23 15:30:27 +053025import java.util.ArrayList;
Gaurav Agrawalbfce9342016-06-15 13:58:01 +053026import java.util.Arrays;
Gaurav Agrawalab7c4bd2016-05-17 18:06:38 +053027import java.util.LinkedList;
Bharat saraswal715d3fc2016-05-17 19:59:16 +053028import java.util.List;
Bharat saraswal715d3fc2016-05-17 19:59:16 +053029import java.util.Stack;
30import java.util.regex.Pattern;
Bharat saraswald14cbe82016-07-14 13:26:18 +053031
VinodKumarS-Huawei6266db32016-05-10 17:58:57 +053032import org.apache.commons.io.FileUtils;
Gaurav Agrawalbfce9342016-06-15 13:58:01 +053033import org.onosproject.yangutils.translator.exception.TranslatorException;
Bharat saraswale50edca2016-08-05 01:58:25 +053034import org.onosproject.yangutils.utils.io.YangPluginConfig;
35import org.onosproject.yangutils.utils.io.YangToJavaNamingConflictUtil;
Bharat saraswal97459962016-02-20 21:57:16 +053036
Gaurav Agrawalbfce9342016-06-15 13:58:01 +053037import static org.onosproject.yangutils.utils.UtilConstants.COLAN;
Bharat saraswal84366c52016-03-23 19:40:35 +053038import static org.onosproject.yangutils.utils.UtilConstants.EMPTY_STRING;
Bharat saraswal715d3fc2016-05-17 19:59:16 +053039import static org.onosproject.yangutils.utils.UtilConstants.HASH;
Bharat saraswalc2d3be12016-06-16 00:29:12 +053040import static org.onosproject.yangutils.utils.UtilConstants.HYPHEN;
Gaurav Agrawalbfce9342016-06-15 13:58:01 +053041import static org.onosproject.yangutils.utils.UtilConstants.JAVA_KEY_WORDS;
Bharat saraswal84366c52016-03-23 19:40:35 +053042import static org.onosproject.yangutils.utils.UtilConstants.NEW_LINE;
Bharat saraswal715d3fc2016-05-17 19:59:16 +053043import static org.onosproject.yangutils.utils.UtilConstants.OPEN_PARENTHESIS;
Bharat saraswal84366c52016-03-23 19:40:35 +053044import static org.onosproject.yangutils.utils.UtilConstants.ORG;
45import static org.onosproject.yangutils.utils.UtilConstants.PACKAGE;
Bharat saraswal715d3fc2016-05-17 19:59:16 +053046import static org.onosproject.yangutils.utils.UtilConstants.PERIOD;
Gaurav Agrawalbfce9342016-06-15 13:58:01 +053047import static org.onosproject.yangutils.utils.UtilConstants.REGEX_FOR_DIGITS_WITH_SINGLE_LETTER;
48import static org.onosproject.yangutils.utils.UtilConstants.REGEX_FOR_FIRST_DIGIT;
49import static org.onosproject.yangutils.utils.UtilConstants.REGEX_FOR_HYPHEN;
50import static org.onosproject.yangutils.utils.UtilConstants.REGEX_FOR_IDENTIFIER_SPECIAL_CHAR;
51import static org.onosproject.yangutils.utils.UtilConstants.REGEX_FOR_PERIOD;
52import static org.onosproject.yangutils.utils.UtilConstants.REGEX_FOR_SINGLE_LETTER;
53import static org.onosproject.yangutils.utils.UtilConstants.REGEX_FOR_UNDERSCORE;
54import static org.onosproject.yangutils.utils.UtilConstants.REGEX_WITH_ALL_SPECIAL_CHAR;
55import static org.onosproject.yangutils.utils.UtilConstants.REGEX_WITH_DIGITS;
56import static org.onosproject.yangutils.utils.UtilConstants.REGEX_WITH_SINGLE_CAPITAL_CASE;
57import static org.onosproject.yangutils.utils.UtilConstants.REGEX_WITH_SINGLE_CAPITAL_CASE_AND_DIGITS_SMALL_CASES;
58import static org.onosproject.yangutils.utils.UtilConstants.REGEX_WITH_UPPERCASE;
Bharat saraswal84366c52016-03-23 19:40:35 +053059import static org.onosproject.yangutils.utils.UtilConstants.SEMI_COLAN;
60import static org.onosproject.yangutils.utils.UtilConstants.SLASH;
61import static org.onosproject.yangutils.utils.UtilConstants.SPACE;
Bharat saraswal84366c52016-03-23 19:40:35 +053062import static org.onosproject.yangutils.utils.UtilConstants.TWELVE_SPACE_INDENTATION;
Gaurav Agrawalbfce9342016-06-15 13:58:01 +053063import static org.onosproject.yangutils.utils.UtilConstants.UNDER_SCORE;
64import static org.onosproject.yangutils.utils.UtilConstants.YANG_AUTO_PREFIX;
Bharat saraswal8beac342016-08-04 02:00:03 +053065import static org.onosproject.yangutils.utils.io.impl.CopyrightHeader.getCopyrightHeader;
Bharat saraswal84366c52016-03-23 19:40:35 +053066import static org.onosproject.yangutils.utils.io.impl.FileSystemUtil.appendFileContents;
67import static org.onosproject.yangutils.utils.io.impl.FileSystemUtil.updateFileHandle;
Bharat saraswalc2d3be12016-06-16 00:29:12 +053068import static org.onosproject.yangutils.utils.io.impl.JavaDocGen.JavaDocType.PACKAGE_INFO;
Gaurav Agrawalbfce9342016-06-15 13:58:01 +053069import static org.onosproject.yangutils.utils.io.impl.JavaDocGen.getJavaDoc;
Vinod Kumar S9f26ae52016-03-23 15:30:27 +053070
Bharat saraswal97459962016-02-20 21:57:16 +053071/**
Bharat saraswal63f26fb2016-04-05 15:13:44 +053072 * Represents common utility functionalities for code generation.
Bharat saraswal97459962016-02-20 21:57:16 +053073 */
74public final class YangIoUtils {
75
VinodKumarS-Huaweid81eccb2016-06-01 14:30:22 +053076 private static final int LINE_SIZE = 118;
Bharat saraswal715d3fc2016-05-17 19:59:16 +053077 private static final int SUB_LINE_SIZE = 112;
78 private static final int ZERO = 0;
Bharat saraswal97459962016-02-20 21:57:16 +053079
80 /**
Bharat saraswal63f26fb2016-04-05 15:13:44 +053081 * Creates an instance of YANG io utils.
Bharat saraswal97459962016-02-20 21:57:16 +053082 */
83 private YangIoUtils() {
84 }
85
86 /**
87 * Creates the directory structure.
88 *
89 * @param path directory path
90 * @return directory structure
Bharat saraswal8beac342016-08-04 02:00:03 +053091 * @throws IOException when fails to do IO operations
Bharat saraswal97459962016-02-20 21:57:16 +053092 */
Bharat saraswal8beac342016-08-04 02:00:03 +053093 public static File createDirectories(String path) throws IOException {
b.janani66b749c2016-02-24 12:23:03 +053094 File generatedDir = new File(path);
Bharat saraswal8beac342016-08-04 02:00:03 +053095 if (!generatedDir.exists()) {
96 boolean isGenerated = generatedDir.mkdirs();
97 if (!isGenerated) {
98 throw new IOException("failed to generated directory " + path);
99 }
100 }
Bharat saraswal97459962016-02-20 21:57:16 +0530101 return generatedDir;
102 }
103
104 /**
105 * Adds package info file for the created directory.
106 *
VinodKumarS-Huaweid81eccb2016-06-01 14:30:22 +0530107 * @param path directory path
108 * @param classInfo class info for the package
109 * @param pack package of the directory
110 * @param isChildNode is it a child node
Bharat saraswal715d3fc2016-05-17 19:59:16 +0530111 * @param pluginConfig plugin configurations
Vinod Kumar S08710982016-03-03 19:55:30 +0530112 * @throws IOException when fails to create package info file
Bharat saraswal97459962016-02-20 21:57:16 +0530113 */
Bharat saraswal715d3fc2016-05-17 19:59:16 +0530114 public static void addPackageInfo(File path, String classInfo, String pack, boolean isChildNode,
Bharat saraswalaf413b82016-07-14 15:18:20 +0530115 YangPluginConfig pluginConfig)
Bharat saraswal250a7472016-05-12 13:16:57 +0530116 throws IOException {
Bharat saraswal97459962016-02-20 21:57:16 +0530117
Bharat saraswal715d3fc2016-05-17 19:59:16 +0530118 pack = parsePkg(pack);
119
Bharat saraswal97459962016-02-20 21:57:16 +0530120 try {
121
Bharat saraswal84366c52016-03-23 19:40:35 +0530122 File packageInfo = new File(path + SLASH + "package-info.java");
Bharat saraswal8beac342016-08-04 02:00:03 +0530123 if (!packageInfo.exists()) {
124 boolean isGenerated = packageInfo.createNewFile();
125 if (!isGenerated) {
126 throw new IOException("failed to generated package-info " + path);
127 }
128 }
Bharat saraswal84366c52016-03-23 19:40:35 +0530129 FileWriter fileWriter = new FileWriter(packageInfo);
130 BufferedWriter bufferedWriter = new BufferedWriter(fileWriter);
131
Bharat saraswal8beac342016-08-04 02:00:03 +0530132 bufferedWriter.write(getCopyrightHeader());
Vidyashree Ramab3670472016-08-06 15:49:56 +0530133 //TODO: get the compiler annotations and pass the info
134 bufferedWriter.write(getJavaDoc(PACKAGE_INFO, classInfo, isChildNode, pluginConfig, null));
Bharat saraswal715d3fc2016-05-17 19:59:16 +0530135 String pkg = PACKAGE + SPACE + pack + SEMI_COLAN;
136 if (pkg.length() > LINE_SIZE) {
Bharat saraswal8beac342016-08-04 02:00:03 +0530137 pkg = whenDelimiterIsPresent(pkg, LINE_SIZE);
Bharat saraswal715d3fc2016-05-17 19:59:16 +0530138 }
139 bufferedWriter.write(pkg);
b.janani66b749c2016-02-24 12:23:03 +0530140 bufferedWriter.close();
Bharat saraswal84366c52016-03-23 19:40:35 +0530141 fileWriter.close();
Bharat saraswal97459962016-02-20 21:57:16 +0530142 } catch (IOException e) {
Bharat saraswal8beac342016-08-04 02:00:03 +0530143 throw new IOException("Exception occurred while creating package info file.");
Bharat saraswal97459962016-02-20 21:57:16 +0530144 }
145 }
146
147 /**
Bharat saraswal715d3fc2016-05-17 19:59:16 +0530148 * Parses package and returns updated package.
149 *
150 * @param pack package needs to be updated
151 * @return updated package
152 */
153 public static String parsePkg(String pack) {
154
155 if (pack.contains(ORG)) {
156 String[] strArray = pack.split(ORG);
157 if (strArray.length >= 3) {
158 for (int i = 1; i < strArray.length; i++) {
159 if (i == 1) {
160 pack = ORG + strArray[1];
161 } else {
162 pack = pack + ORG + strArray[i];
163 }
164 }
165 } else {
166 pack = ORG + strArray[1];
167 }
168 }
169
170 return pack;
171 }
172
173 /**
Bharat saraswal97459962016-02-20 21:57:16 +0530174 * Cleans the generated directory if already exist in source folder.
175 *
Vinod Kumar S9f26ae52016-03-23 15:30:27 +0530176 * @param dir generated directory in previous build
Bharat saraswal84366c52016-03-23 19:40:35 +0530177 * @throws IOException when failed to delete directory
Bharat saraswal97459962016-02-20 21:57:16 +0530178 */
VinodKumarS-Huaweid81eccb2016-06-01 14:30:22 +0530179 public static void deleteDirectory(String dir)
180 throws IOException {
Vinod Kumar S9f26ae52016-03-23 15:30:27 +0530181 File generatedDirectory = new File(dir);
Bharat saraswal97459962016-02-20 21:57:16 +0530182 if (generatedDirectory.exists()) {
Bharat saraswal97459962016-02-20 21:57:16 +0530183 try {
VinodKumarS-Huawei6266db32016-05-10 17:58:57 +0530184 FileUtils.deleteDirectory(generatedDirectory);
Bharat saraswal97459962016-02-20 21:57:16 +0530185 } catch (IOException e) {
Bharat saraswal250a7472016-05-12 13:16:57 +0530186 throw new IOException(
187 "Failed to delete the generated files in " + generatedDirectory + " directory");
Bharat saraswal97459962016-02-20 21:57:16 +0530188 }
Bharat saraswal97459962016-02-20 21:57:16 +0530189 }
190 }
191
192 /**
Bharat saraswal250a7472016-05-12 13:16:57 +0530193 * Searches and deletes generated temporary directories.
194 *
195 * @param root root directory
196 * @throws IOException when fails to do IO operations.
197 */
VinodKumarS-Huaweid81eccb2016-06-01 14:30:22 +0530198 public static void searchAndDeleteTempDir(String root)
199 throws IOException {
Bharat saraswal250a7472016-05-12 13:16:57 +0530200 List<File> store = new LinkedList<>();
201 Stack<String> stack = new Stack<>();
202 stack.push(root);
203
204 while (!stack.empty()) {
205 root = stack.pop();
206 File file = new File(root);
Bharat saraswal8beac342016-08-04 02:00:03 +0530207 File[] fileList = file.listFiles();
208 if (fileList == null || fileList.length == 0) {
Bharat saraswal250a7472016-05-12 13:16:57 +0530209 continue;
210 }
Bharat saraswal8beac342016-08-04 02:00:03 +0530211 for (File current : fileList) {
Bharat saraswal250a7472016-05-12 13:16:57 +0530212 if (current.isDirectory()) {
213 stack.push(current.toString());
214 if (current.getName().endsWith("-Temp")) {
215 store.add(current);
216 }
217 }
218 }
219 }
220
221 for (File dir : store) {
Bharat saraswal4aaab4d2016-05-17 14:19:38 +0530222 FileUtils.deleteDirectory(dir);
Bharat saraswal250a7472016-05-12 13:16:57 +0530223 }
224 }
225
226 /**
Bharat saraswal022dae92016-03-04 20:08:09 +0530227 * Removes extra char from the string.
228 *
Bharat saraswald14cbe82016-07-14 13:26:18 +0530229 * @param valueString string to be trimmed
Bharat saraswal8beac342016-08-04 02:00:03 +0530230 * @param removalString extra chars
Bharat saraswal022dae92016-03-04 20:08:09 +0530231 * @return new string
232 */
Bharat saraswal8beac342016-08-04 02:00:03 +0530233 public static String trimAtLast(String valueString, String removalString) {
Bharat saraswal022dae92016-03-04 20:08:09 +0530234 StringBuilder stringBuilder = new StringBuilder(valueString);
Bharat saraswal8beac342016-08-04 02:00:03 +0530235 int index = valueString.lastIndexOf(removalString);
Bharat saraswald14cbe82016-07-14 13:26:18 +0530236 if (index != -1) {
237 stringBuilder.deleteCharAt(index);
Bharat saraswal022dae92016-03-04 20:08:09 +0530238 }
Bharat saraswald14cbe82016-07-14 13:26:18 +0530239 return stringBuilder.toString();
Bharat saraswal022dae92016-03-04 20:08:09 +0530240 }
241
Vinod Kumar S9f26ae52016-03-23 15:30:27 +0530242 /**
Bharat saraswal63f26fb2016-04-05 15:13:44 +0530243 * Returns the directory path of the package in canonical form.
Vinod Kumar S9f26ae52016-03-23 15:30:27 +0530244 *
245 * @param baseCodeGenPath base path where the generated files needs to be
VinodKumarS-Huaweid81eccb2016-06-01 14:30:22 +0530246 * put
247 * @param pathOfJavaPkg java package of the file being generated
Vinod Kumar S9f26ae52016-03-23 15:30:27 +0530248 * @return absolute path of the package in canonical form
249 */
250 public static String getDirectory(String baseCodeGenPath, String pathOfJavaPkg) {
251
252 if (pathOfJavaPkg.charAt(pathOfJavaPkg.length() - 1) == File.separatorChar) {
Bharat saraswal84366c52016-03-23 19:40:35 +0530253 pathOfJavaPkg = trimAtLast(pathOfJavaPkg, SLASH);
Vinod Kumar S9f26ae52016-03-23 15:30:27 +0530254 }
Bharat saraswal84366c52016-03-23 19:40:35 +0530255 String[] strArray = pathOfJavaPkg.split(SLASH);
256 if (strArray[0].equals(EMPTY_STRING)) {
Vinod Kumar S9f26ae52016-03-23 15:30:27 +0530257 return pathOfJavaPkg;
258 } else {
Bharat saraswal84366c52016-03-23 19:40:35 +0530259 return baseCodeGenPath + SLASH + pathOfJavaPkg;
Vinod Kumar S9f26ae52016-03-23 15:30:27 +0530260 }
261 }
262
263 /**
Bharat saraswal63f26fb2016-04-05 15:13:44 +0530264 * Returns the absolute path of the package in canonical form.
Vinod Kumar S9f26ae52016-03-23 15:30:27 +0530265 *
266 * @param baseCodeGenPath base path where the generated files needs to be
VinodKumarS-Huaweid81eccb2016-06-01 14:30:22 +0530267 * put
268 * @param pathOfJavaPkg java package of the file being generated
Vinod Kumar S9f26ae52016-03-23 15:30:27 +0530269 * @return absolute path of the package in canonical form
270 */
271 public static String getAbsolutePackagePath(String baseCodeGenPath, String pathOfJavaPkg) {
Vinod Kumar S9f26ae52016-03-23 15:30:27 +0530272 return baseCodeGenPath + pathOfJavaPkg;
273 }
274
275 /**
Bharat saraswal63f26fb2016-04-05 15:13:44 +0530276 * Merges the temp java files to main java files.
Bharat saraswal84366c52016-03-23 19:40:35 +0530277 *
278 * @param appendFile temp file
Gaurav Agrawalab7c4bd2016-05-17 18:06:38 +0530279 * @param srcFile main file
Bharat saraswal84366c52016-03-23 19:40:35 +0530280 * @throws IOException when fails to append contents
281 */
VinodKumarS-Huaweid81eccb2016-06-01 14:30:22 +0530282 public static void mergeJavaFiles(File appendFile, File srcFile)
283 throws IOException {
Bharat saraswal84366c52016-03-23 19:40:35 +0530284 try {
285 appendFileContents(appendFile, srcFile);
286 } catch (IOException e) {
287 throw new IOException("Failed to append " + appendFile + " in " + srcFile);
288 }
289 }
290
291 /**
Bharat saraswal63f26fb2016-04-05 15:13:44 +0530292 * Inserts data in the generated file.
Bharat saraswal84366c52016-03-23 19:40:35 +0530293 *
294 * @param file file in which need to be inserted
295 * @param data data which need to be inserted
296 * @throws IOException when fails to insert into file
297 */
VinodKumarS-Huaweid81eccb2016-06-01 14:30:22 +0530298 public static void insertDataIntoJavaFile(File file, String data)
299 throws IOException {
Bharat saraswal84366c52016-03-23 19:40:35 +0530300 try {
301 updateFileHandle(file, data, false);
302 } catch (IOException e) {
303 throw new IOException("Failed to insert in " + file + "file");
304 }
305 }
Bharat saraswal715d3fc2016-05-17 19:59:16 +0530306
307 /**
308 * Validates a line size in given file whether it is having more then 120 characters.
309 * If yes it will update and give a new file.
310 *
311 * @param dataFile file in which need to verify all lines.
312 * @return updated file
313 * @throws IOException when fails to do IO operations.
314 */
VinodKumarS-Huaweid81eccb2016-06-01 14:30:22 +0530315 public static File validateLineLength(File dataFile)
316 throws IOException {
Bharat saraswal715d3fc2016-05-17 19:59:16 +0530317 FileReader fileReader = new FileReader(dataFile);
318 BufferedReader bufferReader = new BufferedReader(fileReader);
Bharat saraswal8beac342016-08-04 02:00:03 +0530319 String append;
Bharat saraswal715d3fc2016-05-17 19:59:16 +0530320 try {
321 StringBuilder stringBuilder = new StringBuilder();
322 String line = bufferReader.readLine();
323
324 while (line != null) {
325 if (line.length() > LINE_SIZE) {
326 if (line.contains(PERIOD)) {
Bharat saraswal8beac342016-08-04 02:00:03 +0530327 line = whenDelimiterIsPresent(line, LINE_SIZE);
Bharat saraswal715d3fc2016-05-17 19:59:16 +0530328 } else if (line.contains(SPACE)) {
329 line = whenSpaceIsPresent(line, LINE_SIZE);
330 }
331 stringBuilder.append(line);
332 } else {
Bharat saraswal8beac342016-08-04 02:00:03 +0530333 append = line + NEW_LINE;
334 stringBuilder.append(append);
Bharat saraswal715d3fc2016-05-17 19:59:16 +0530335 }
336 line = bufferReader.readLine();
337 }
Bharat saraswal8beac342016-08-04 02:00:03 +0530338 FileWriter writer = new FileWriter(dataFile);
Bharat saraswal715d3fc2016-05-17 19:59:16 +0530339 writer.write(stringBuilder.toString());
340 writer.close();
Bharat saraswal8beac342016-08-04 02:00:03 +0530341 return dataFile;
Bharat saraswal715d3fc2016-05-17 19:59:16 +0530342 } finally {
343 fileReader.close();
344 bufferReader.close();
345 }
346 }
347
Bharat saraswalc2d3be12016-06-16 00:29:12 +0530348 /* When delimiters are present in the given line. */
Bharat saraswal8beac342016-08-04 02:00:03 +0530349 private static String whenDelimiterIsPresent(String line, int lineSize) {
Bharat saraswal715d3fc2016-05-17 19:59:16 +0530350 StringBuilder stringBuilder = new StringBuilder();
Bharat saraswal8beac342016-08-04 02:00:03 +0530351 String append;
Bharat saraswal715d3fc2016-05-17 19:59:16 +0530352 if (line.length() > lineSize) {
353 String[] strArray = line.split(Pattern.quote(PERIOD));
354 stringBuilder = updateString(strArray, stringBuilder, PERIOD, lineSize);
355 } else {
Bharat saraswal8beac342016-08-04 02:00:03 +0530356 append = line + NEW_LINE;
357 stringBuilder.append(append);
Bharat saraswal715d3fc2016-05-17 19:59:16 +0530358 }
359 String[] strArray = stringBuilder.toString().split(NEW_LINE);
360 StringBuilder tempBuilder = new StringBuilder();
361 for (String str : strArray) {
362 if (str.length() > SUB_LINE_SIZE) {
363 if (line.contains(PERIOD) && !line.contains(PERIOD + HASH + OPEN_PARENTHESIS)) {
364 String[] strArr = str.split(Pattern.quote(PERIOD));
365 tempBuilder = updateString(strArr, tempBuilder, PERIOD, SUB_LINE_SIZE);
366 } else if (str.contains(SPACE)) {
367 tempBuilder.append(whenSpaceIsPresent(str, SUB_LINE_SIZE));
368 }
369 } else {
Bharat saraswal8beac342016-08-04 02:00:03 +0530370 append = str + NEW_LINE;
371 tempBuilder.append(append);
Bharat saraswal715d3fc2016-05-17 19:59:16 +0530372 }
373 }
374 return tempBuilder.toString();
375
376 }
377
Bharat saraswalc2d3be12016-06-16 00:29:12 +0530378 /* When spaces are present in the given line. */
Bharat saraswal715d3fc2016-05-17 19:59:16 +0530379 private static String whenSpaceIsPresent(String line, int lineSize) {
380 StringBuilder stringBuilder = new StringBuilder();
Bharat saraswal8beac342016-08-04 02:00:03 +0530381 String append;
Bharat saraswal715d3fc2016-05-17 19:59:16 +0530382 if (line.length() > lineSize) {
383 String[] strArray = line.split(SPACE);
384 stringBuilder = updateString(strArray, stringBuilder, SPACE, lineSize);
385 } else {
Bharat saraswal8beac342016-08-04 02:00:03 +0530386 append = line + NEW_LINE;
387 stringBuilder.append(append);
Bharat saraswal715d3fc2016-05-17 19:59:16 +0530388 }
Bharat saraswal5cd9e9c2016-05-26 23:48:38 +0530389
390 String[] strArray = stringBuilder.toString().split(NEW_LINE);
391 StringBuilder tempBuilder = new StringBuilder();
392 for (String str : strArray) {
393 if (str.length() > SUB_LINE_SIZE) {
394 if (str.contains(SPACE)) {
395 String[] strArr = str.split(SPACE);
396 tempBuilder = updateString(strArr, tempBuilder, SPACE, SUB_LINE_SIZE);
397 }
398 } else {
Bharat saraswal8beac342016-08-04 02:00:03 +0530399 append = str + NEW_LINE;
400 tempBuilder.append(append);
Bharat saraswal5cd9e9c2016-05-26 23:48:38 +0530401 }
402 }
403 return tempBuilder.toString();
Bharat saraswal715d3fc2016-05-17 19:59:16 +0530404 }
405
Bharat saraswalc2d3be12016-06-16 00:29:12 +0530406 /* Updates the given line with the given size conditions. */
Bharat saraswal715d3fc2016-05-17 19:59:16 +0530407 private static StringBuilder updateString(String[] strArray, StringBuilder stringBuilder, String string,
Bharat saraswalaf413b82016-07-14 15:18:20 +0530408 int lineSize) {
Bharat saraswal715d3fc2016-05-17 19:59:16 +0530409
410 StringBuilder tempBuilder = new StringBuilder();
Bharat saraswal8beac342016-08-04 02:00:03 +0530411 String append;
Bharat saraswal715d3fc2016-05-17 19:59:16 +0530412 for (String str : strArray) {
Bharat saraswal8beac342016-08-04 02:00:03 +0530413 append = str + string;
414 tempBuilder.append(append);
Bharat saraswal715d3fc2016-05-17 19:59:16 +0530415 if (tempBuilder.length() > lineSize) {
416 String tempString = stringBuilder.toString();
417 stringBuilder.delete(ZERO, stringBuilder.length());
418 tempString = trimAtLast(tempString, string);
419 stringBuilder.append(tempString);
420 if (string.equals(PERIOD)) {
Bharat saraswal8beac342016-08-04 02:00:03 +0530421 append = NEW_LINE + TWELVE_SPACE_INDENTATION + PERIOD + str + string;
422 stringBuilder.append(append);
Bharat saraswal715d3fc2016-05-17 19:59:16 +0530423 } else {
Bharat saraswal8beac342016-08-04 02:00:03 +0530424 append = NEW_LINE + TWELVE_SPACE_INDENTATION + str + string;
425 stringBuilder.append(append);
Bharat saraswal715d3fc2016-05-17 19:59:16 +0530426 }
427 tempBuilder.delete(ZERO, tempBuilder.length());
428 tempBuilder.append(TWELVE_SPACE_INDENTATION);
429 } else {
Bharat saraswal8beac342016-08-04 02:00:03 +0530430 append = str + string;
431 stringBuilder.append(append);
Bharat saraswal715d3fc2016-05-17 19:59:16 +0530432 }
433 }
434 String tempString = stringBuilder.toString();
435 tempString = trimAtLast(tempString, string);
436 stringBuilder.delete(ZERO, stringBuilder.length());
Bharat saraswal8beac342016-08-04 02:00:03 +0530437 append = tempString + NEW_LINE;
438 stringBuilder.append(append);
Bharat saraswal715d3fc2016-05-17 19:59:16 +0530439 return stringBuilder;
440 }
Bharat saraswalc2d3be12016-06-16 00:29:12 +0530441
442 /**
Gaurav Agrawalbfce9342016-06-15 13:58:01 +0530443 * Returns the java Package from package path.
Bharat saraswalc2d3be12016-06-16 00:29:12 +0530444 *
Gaurav Agrawalbfce9342016-06-15 13:58:01 +0530445 * @param packagePath package path
446 * @return java package
Bharat saraswalc2d3be12016-06-16 00:29:12 +0530447 */
Gaurav Agrawalbfce9342016-06-15 13:58:01 +0530448 public static String getJavaPackageFromPackagePath(String packagePath) {
449 return packagePath.replace(SLASH, PERIOD);
Bharat saraswalc2d3be12016-06-16 00:29:12 +0530450 }
451
452 /**
Gaurav Agrawalbfce9342016-06-15 13:58:01 +0530453 * Returns the directory path corresponding to java package.
Bharat saraswalc2d3be12016-06-16 00:29:12 +0530454 *
Gaurav Agrawalbfce9342016-06-15 13:58:01 +0530455 * @param packagePath package path
456 * @return java package
Bharat saraswalc2d3be12016-06-16 00:29:12 +0530457 */
Gaurav Agrawalbfce9342016-06-15 13:58:01 +0530458 public static String getPackageDirPathFromJavaJPackage(String packagePath) {
459 return packagePath.replace(PERIOD, SLASH);
Bharat saraswalc2d3be12016-06-16 00:29:12 +0530460 }
461
462 /**
Gaurav Agrawalbfce9342016-06-15 13:58:01 +0530463 * Returns the YANG identifier name as java identifier with first letter
464 * in small.
Bharat saraswalc2d3be12016-06-16 00:29:12 +0530465 *
Gaurav Agrawalbfce9342016-06-15 13:58:01 +0530466 * @param yangIdentifier identifier in YANG file.
467 * @return corresponding java identifier
Bharat saraswalc2d3be12016-06-16 00:29:12 +0530468 */
Gaurav Agrawalbfce9342016-06-15 13:58:01 +0530469 public static String getSmallCase(String yangIdentifier) {
470 return yangIdentifier.substring(0, 1).toLowerCase() + yangIdentifier.substring(1);
Bharat saraswalc2d3be12016-06-16 00:29:12 +0530471 }
472
473 /**
Gaurav Agrawalbfce9342016-06-15 13:58:01 +0530474 * Returns the YANG identifier name as java identifier with first letter
475 * in capital.
Bharat saraswalc2d3be12016-06-16 00:29:12 +0530476 *
Gaurav Agrawalbfce9342016-06-15 13:58:01 +0530477 * @param yangIdentifier identifier in YANG file
478 * @return corresponding java identifier
Bharat saraswalc2d3be12016-06-16 00:29:12 +0530479 */
Gaurav Agrawalbfce9342016-06-15 13:58:01 +0530480 public static String getCapitalCase(String yangIdentifier) {
481 yangIdentifier = yangIdentifier.substring(0, 1).toUpperCase() + yangIdentifier.substring(1);
482 return restrictConsecutiveCapitalCase(yangIdentifier);
Bharat saraswalc2d3be12016-06-16 00:29:12 +0530483 }
484
485 /**
Gaurav Agrawalbfce9342016-06-15 13:58:01 +0530486 * Restricts consecutive capital cased string as a rule in camel case.
Bharat saraswalc2d3be12016-06-16 00:29:12 +0530487 *
Gaurav Agrawalbfce9342016-06-15 13:58:01 +0530488 * @param consecCapitalCaseRemover which requires the restriction of consecutive capital case
489 * @return string without consecutive capital case
Bharat saraswalc2d3be12016-06-16 00:29:12 +0530490 */
Bharat saraswal8beac342016-08-04 02:00:03 +0530491 private static String restrictConsecutiveCapitalCase(String consecCapitalCaseRemover) {
Bharat saraswalc2d3be12016-06-16 00:29:12 +0530492
Gaurav Agrawalbfce9342016-06-15 13:58:01 +0530493 for (int k = 0; k < consecCapitalCaseRemover.length(); k++) {
494 if (k + 1 < consecCapitalCaseRemover.length()) {
495 if (Character.isUpperCase(consecCapitalCaseRemover.charAt(k))) {
496 if (Character.isUpperCase(consecCapitalCaseRemover.charAt(k + 1))) {
497 consecCapitalCaseRemover = consecCapitalCaseRemover.substring(0, k + 1)
498 + consecCapitalCaseRemover.substring(k + 1, k + 2).toLowerCase()
499 + consecCapitalCaseRemover.substring(k + 2);
Bharat saraswalc2d3be12016-06-16 00:29:12 +0530500 }
Bharat saraswalc2d3be12016-06-16 00:29:12 +0530501 }
Bharat saraswalc2d3be12016-06-16 00:29:12 +0530502 }
503 }
Gaurav Agrawalbfce9342016-06-15 13:58:01 +0530504 return consecCapitalCaseRemover;
Bharat saraswalc2d3be12016-06-16 00:29:12 +0530505 }
506
Gaurav Agrawalbfce9342016-06-15 13:58:01 +0530507 /**
508 * Adds prefix, if the string begins with digit or is a java key word.
509 *
Bharat saraswalaf413b82016-07-14 15:18:20 +0530510 * @param camelCasePrefix string for adding prefix
Gaurav Agrawalbfce9342016-06-15 13:58:01 +0530511 * @param conflictResolver object of YANG to java naming conflict util
512 * @return prefixed camel case string
513 */
Bharat saraswal8beac342016-08-04 02:00:03 +0530514 private static String addPrefix(String camelCasePrefix, YangToJavaNamingConflictUtil conflictResolver) {
Gaurav Agrawalbfce9342016-06-15 13:58:01 +0530515
516 String prefix = getPrefixForIdentifier(conflictResolver);
517 if (camelCasePrefix.matches(REGEX_FOR_FIRST_DIGIT)) {
518 camelCasePrefix = prefix + camelCasePrefix;
519 }
520 if (JAVA_KEY_WORDS.contains(camelCasePrefix)) {
521 camelCasePrefix = prefix + camelCasePrefix.substring(0, 1).toUpperCase()
522 + camelCasePrefix.substring(1);
523 }
524 return camelCasePrefix;
525 }
526
527 /**
528 * Applies the rule that a string does not end with a capitalized letter and capitalizes
529 * the letter next to a number in an array.
530 *
Bharat saraswalaf413b82016-07-14 15:18:20 +0530531 * @param stringArray containing strings for camel case separation
Gaurav Agrawalbfce9342016-06-15 13:58:01 +0530532 * @param conflictResolver object of YANG to java naming conflict util
533 * @return camel case rule checked string
534 */
Bharat saraswal8beac342016-08-04 02:00:03 +0530535 private static String applyCamelCaseRule(String[] stringArray, YangToJavaNamingConflictUtil conflictResolver) {
Gaurav Agrawalbfce9342016-06-15 13:58:01 +0530536
537 String ruleChecker = stringArray[0].toLowerCase();
538 int i;
539 if (ruleChecker.matches(REGEX_FOR_FIRST_DIGIT)) {
540 i = 0;
541 ruleChecker = EMPTY_STRING;
542 } else {
543 i = 1;
544 }
545 for (; i < stringArray.length; i++) {
546 if (i + 1 == stringArray.length) {
547 if (stringArray[i].matches(REGEX_FOR_SINGLE_LETTER)
548 || stringArray[i].matches(REGEX_FOR_DIGITS_WITH_SINGLE_LETTER)) {
549 ruleChecker = ruleChecker + stringArray[i].toLowerCase();
550 break;
551 }
552 }
553 if (stringArray[i].matches(REGEX_FOR_FIRST_DIGIT)) {
554 for (int j = 0; j < stringArray[i].length(); j++) {
555 char letterCheck = stringArray[i].charAt(j);
556 if (Character.isLetter(letterCheck)) {
557 stringArray[i] = stringArray[i].substring(0, j)
558 + stringArray[i].substring(j, j + 1).toUpperCase() + stringArray[i].substring(j + 1);
559 break;
560 }
561 }
562 ruleChecker = ruleChecker + stringArray[i];
563 } else {
564 ruleChecker = ruleChecker + stringArray[i].substring(0, 1).toUpperCase() + stringArray[i].substring(1);
565 }
566 }
567 String ruleCheckerWithPrefix = addPrefix(ruleChecker, conflictResolver);
568 return restrictConsecutiveCapitalCase(ruleCheckerWithPrefix);
569 }
570
571 /**
572 * Resolves the conflict when input has upper case.
573 *
Bharat saraswalaf413b82016-07-14 15:18:20 +0530574 * @param stringArray containing strings for upper case conflict resolver
Gaurav Agrawalbfce9342016-06-15 13:58:01 +0530575 * @param conflictResolver object of YANG to java naming conflict util
576 * @return camel cased string
577 */
Bharat saraswal8beac342016-08-04 02:00:03 +0530578 private static String upperCaseConflictResolver(String[] stringArray,
579 YangToJavaNamingConflictUtil conflictResolver) {
Gaurav Agrawalbfce9342016-06-15 13:58:01 +0530580
581 for (int l = 0; l < stringArray.length; l++) {
582 String[] upperCaseSplitArray = stringArray[l].split(REGEX_WITH_UPPERCASE);
583 for (int m = 0; m < upperCaseSplitArray.length; m++) {
584 if (upperCaseSplitArray[m].matches(REGEX_WITH_SINGLE_CAPITAL_CASE)) {
585 int check = m;
586 while (check + 1 < upperCaseSplitArray.length) {
587 if (upperCaseSplitArray[check + 1].matches(REGEX_WITH_SINGLE_CAPITAL_CASE)) {
588 upperCaseSplitArray[check + 1] = upperCaseSplitArray[check + 1].toLowerCase();
589 check = check + 1;
590 } else if (upperCaseSplitArray[check + 1]
591 .matches(REGEX_WITH_SINGLE_CAPITAL_CASE_AND_DIGITS_SMALL_CASES)) {
592 upperCaseSplitArray[check + 1] = upperCaseSplitArray[check + 1].toLowerCase();
593 break;
594 } else {
595 break;
596 }
597 }
598 }
599 }
600 StringBuilder strBuilder = new StringBuilder();
601 for (String element : upperCaseSplitArray) {
602 strBuilder.append(element);
603 }
604 stringArray[l] = strBuilder.toString();
605 }
Bharat saraswal8beac342016-08-04 02:00:03 +0530606 List<String> result = new ArrayList<>();
Gaurav Agrawalbfce9342016-06-15 13:58:01 +0530607 for (String element : stringArray) {
608 String[] capitalCaseSplitArray = element.split(REGEX_WITH_UPPERCASE);
609 for (String letter : capitalCaseSplitArray) {
610 String[] arrayForAddition = letter.split(REGEX_WITH_DIGITS);
611 List<String> list = Arrays.asList(arrayForAddition);
612 for (String str : list) {
613 if (str != null && !str.isEmpty()) {
614 result.add(str);
615 }
616 }
617 }
618 }
619 stringArray = result.toArray(new String[result.size()]);
620 return applyCamelCaseRule(stringArray, conflictResolver);
621 }
622
623 /**
624 * Returns the YANG identifier name as java identifier.
625 *
Bharat saraswalaf413b82016-07-14 15:18:20 +0530626 * @param yangIdentifier identifier in YANG file
Gaurav Agrawalbfce9342016-06-15 13:58:01 +0530627 * @param conflictResolver object of YANG to java naming conflict util
628 * @return corresponding java identifier
629 */
630 public static String getCamelCase(String yangIdentifier, YangToJavaNamingConflictUtil conflictResolver) {
631
632 if (conflictResolver != null) {
633 String replacementForHyphen = conflictResolver.getReplacementForHyphen();
634 String replacementForPeriod = conflictResolver.getReplacementForPeriod();
635 String replacementForUnderscore = conflictResolver.getReplacementForUnderscore();
636 if (replacementForPeriod != null) {
637 yangIdentifier = yangIdentifier.replaceAll(REGEX_FOR_PERIOD,
638 PERIOD + replacementForPeriod.toLowerCase() + PERIOD);
639 }
640 if (replacementForUnderscore != null) {
641 yangIdentifier = yangIdentifier.replaceAll(REGEX_FOR_UNDERSCORE,
642 UNDER_SCORE + replacementForUnderscore.toLowerCase() + UNDER_SCORE);
643 }
644 if (replacementForHyphen != null) {
645 yangIdentifier = yangIdentifier.replaceAll(REGEX_FOR_HYPHEN,
646 HYPHEN + replacementForHyphen.toLowerCase() + HYPHEN);
647 }
648 }
649 yangIdentifier = yangIdentifier.replaceAll(REGEX_FOR_IDENTIFIER_SPECIAL_CHAR, COLAN);
650 String[] strArray = yangIdentifier.split(COLAN);
651 if (strArray[0].isEmpty()) {
Bharat saraswal8beac342016-08-04 02:00:03 +0530652 List<String> stringArrangement = new ArrayList<>();
653 stringArrangement.addAll(Arrays.asList(strArray).subList(1, strArray.length));
Gaurav Agrawalbfce9342016-06-15 13:58:01 +0530654 strArray = stringArrangement.toArray(new String[stringArrangement.size()]);
655 }
656 return upperCaseConflictResolver(strArray, conflictResolver);
657 }
658
659 /**
660 * Prefix for adding with identifier and namespace, when it is a java keyword or starting with digits.
661 *
662 * @param conflictResolver object of YANG to java naming conflict util
663 * @return prefix which needs to be added
664 */
665 public static String getPrefixForIdentifier(YangToJavaNamingConflictUtil conflictResolver) {
666
667 String prefixForIdentifier = null;
668 if (conflictResolver != null) {
669 prefixForIdentifier = conflictResolver.getPrefixForIdentifier();
670 }
671 if (prefixForIdentifier != null) {
672 prefixForIdentifier = prefixForIdentifier.replaceAll(REGEX_WITH_ALL_SPECIAL_CHAR, COLAN);
673 String[] strArray = prefixForIdentifier.split(COLAN);
674 try {
675 if (strArray[0].isEmpty()) {
Bharat saraswal8beac342016-08-04 02:00:03 +0530676 List<String> stringArrangement = new ArrayList<>();
677 stringArrangement.addAll(Arrays.asList(strArray).subList(1, strArray.length));
Gaurav Agrawalbfce9342016-06-15 13:58:01 +0530678 strArray = stringArrangement.toArray(new String[stringArrangement.size()]);
679 }
680 prefixForIdentifier = strArray[0];
681 for (int j = 1; j < strArray.length; j++) {
682 prefixForIdentifier = prefixForIdentifier + strArray[j].substring(0, 1).toUpperCase() +
683 strArray[j].substring(1);
684 }
685 } catch (ArrayIndexOutOfBoundsException outOfBoundsException) {
686 throw new TranslatorException("The given prefix in pom.xml is invalid.");
687 }
688 } else {
689 prefixForIdentifier = YANG_AUTO_PREFIX;
690 }
691 return prefixForIdentifier;
692 }
Bharat saraswal97459962016-02-20 21:57:16 +0530693}