Gaurav Agrawal | 1c8f80c | 2016-04-12 13:30:16 +0530 | [diff] [blame] | 1 | /* |
| 2 | * Copyright 2016-present Open Networking Laboratory |
| 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 | |
| 19 | import java.io.IOException; |
Vinod Kumar S | e4b9b0c | 2016-04-30 21:09:15 +0530 | [diff] [blame^] | 20 | |
| 21 | import org.onosproject.yangutils.datamodel.YangTypeContainer; |
Bharat saraswal | cc1cdab | 2016-04-16 02:28:25 +0530 | [diff] [blame] | 22 | import org.onosproject.yangutils.datamodel.YangAugment; |
| 23 | import org.onosproject.yangutils.datamodel.YangCase; |
| 24 | import org.onosproject.yangutils.datamodel.YangChoice; |
| 25 | import org.onosproject.yangutils.datamodel.YangContainer; |
| 26 | import org.onosproject.yangutils.datamodel.YangInput; |
Gaurav Agrawal | 1c8f80c | 2016-04-12 13:30:16 +0530 | [diff] [blame] | 27 | import org.onosproject.yangutils.datamodel.YangLeavesHolder; |
Bharat saraswal | cc1cdab | 2016-04-16 02:28:25 +0530 | [diff] [blame] | 28 | import org.onosproject.yangutils.datamodel.YangList; |
Gaurav Agrawal | 1c8f80c | 2016-04-12 13:30:16 +0530 | [diff] [blame] | 29 | import org.onosproject.yangutils.datamodel.YangNode; |
Bharat saraswal | cc1cdab | 2016-04-16 02:28:25 +0530 | [diff] [blame] | 30 | import org.onosproject.yangutils.datamodel.YangNotification; |
| 31 | import org.onosproject.yangutils.datamodel.YangOutput; |
Vinod Kumar S | e4b9b0c | 2016-04-30 21:09:15 +0530 | [diff] [blame^] | 32 | import org.onosproject.yangutils.translator.exception.TranslatorException; |
| 33 | import org.onosproject.yangutils.translator.tojava.JavaFileInfoContainer; |
Gaurav Agrawal | 1c8f80c | 2016-04-12 13:30:16 +0530 | [diff] [blame] | 34 | import org.onosproject.yangutils.translator.tojava.TempJavaCodeFragmentFiles; |
| 35 | import org.onosproject.yangutils.translator.tojava.javamodel.JavaCodeGeneratorInfo; |
Bharat saraswal | d72411a | 2016-04-19 01:00:16 +0530 | [diff] [blame] | 36 | import org.onosproject.yangutils.translator.tojava.javamodel.YangJavaEnumeration; |
Gaurav Agrawal | 1c8f80c | 2016-04-12 13:30:16 +0530 | [diff] [blame] | 37 | |
Vinod Kumar S | e4b9b0c | 2016-04-30 21:09:15 +0530 | [diff] [blame^] | 38 | import static org.onosproject.yangutils.translator.tojava.TempJavaFragmentFiles.addCurNodeInfoInParentTempFile; |
Gaurav Agrawal | 1c8f80c | 2016-04-12 13:30:16 +0530 | [diff] [blame] | 39 | import static org.onosproject.yangutils.translator.tojava.utils.JavaIdentifierSyntax.getCamelCase; |
| 40 | import static org.onosproject.yangutils.translator.tojava.utils.JavaIdentifierSyntax.getCaptialCase; |
| 41 | import static org.onosproject.yangutils.translator.tojava.utils.JavaIdentifierSyntax.getCurNodePackage; |
| 42 | import static org.onosproject.yangutils.translator.tojava.utils.JavaIdentifierSyntax.getPackageDirPathFromJavaJPackage; |
Bharat saraswal | cc1cdab | 2016-04-16 02:28:25 +0530 | [diff] [blame] | 43 | import static org.onosproject.yangutils.utils.UtilConstants.AUGMENTED_INFO; |
| 44 | import static org.onosproject.yangutils.utils.UtilConstants.HAS_AUGMENTATION; |
Vidyashree Rama | 7142d9c | 2016-04-26 15:06:06 +0530 | [diff] [blame] | 45 | import static org.onosproject.yangutils.utils.UtilConstants.PERIOD; |
Gaurav Agrawal | 1c8f80c | 2016-04-12 13:30:16 +0530 | [diff] [blame] | 46 | |
| 47 | /** |
| 48 | * Represents utility class for YANG java model. |
| 49 | */ |
| 50 | public final class YangJavaModelUtils { |
| 51 | |
| 52 | /** |
| 53 | * Creates YANG java model utility. |
| 54 | */ |
| 55 | private YangJavaModelUtils() { |
| 56 | } |
| 57 | |
| 58 | /** |
| 59 | * Updates YANG java file package information. |
| 60 | * |
Vinod Kumar S | e4b9b0c | 2016-04-30 21:09:15 +0530 | [diff] [blame^] | 61 | * @param javaCodeGeneratorInfo YANG java file info node |
| 62 | * @param yangPlugin YANG plugin config |
Gaurav Agrawal | 1c8f80c | 2016-04-12 13:30:16 +0530 | [diff] [blame] | 63 | * @throws IOException IO operations fails |
| 64 | */ |
Vinod Kumar S | e4b9b0c | 2016-04-30 21:09:15 +0530 | [diff] [blame^] | 65 | public static void updatePackageInfo(JavaCodeGeneratorInfo javaCodeGeneratorInfo, YangPluginConfig yangPlugin) |
Gaurav Agrawal | 1c8f80c | 2016-04-12 13:30:16 +0530 | [diff] [blame] | 66 | throws IOException { |
Vinod Kumar S | e4b9b0c | 2016-04-30 21:09:15 +0530 | [diff] [blame^] | 67 | javaCodeGeneratorInfo.getJavaFileInfo() |
janani b | de4ffab | 2016-04-15 16:18:30 +0530 | [diff] [blame] | 68 | .setJavaName(getCaptialCase( |
Vinod Kumar S | e4b9b0c | 2016-04-30 21:09:15 +0530 | [diff] [blame^] | 69 | getCamelCase(((YangNode) javaCodeGeneratorInfo).getName(), yangPlugin.getConflictResolver()))); |
| 70 | javaCodeGeneratorInfo.getJavaFileInfo().setPackage(getCurNodePackage((YangNode) javaCodeGeneratorInfo)); |
| 71 | javaCodeGeneratorInfo.getJavaFileInfo().setPackageFilePath( |
| 72 | getPackageDirPathFromJavaJPackage(javaCodeGeneratorInfo.getJavaFileInfo().getPackage())); |
| 73 | javaCodeGeneratorInfo.getJavaFileInfo().setBaseCodeGenPath(yangPlugin.getCodeGenDir()); |
Gaurav Agrawal | 1c8f80c | 2016-04-12 13:30:16 +0530 | [diff] [blame] | 74 | } |
| 75 | |
| 76 | /** |
| 77 | * Updates YANG java file package information for specified package. |
| 78 | * |
| 79 | * @param javaCodeGeneratorInfo YANG java file info node |
Vinod Kumar S | e4b9b0c | 2016-04-30 21:09:15 +0530 | [diff] [blame^] | 80 | * @param yangPlugin YANG plugin config |
Gaurav Agrawal | 1c8f80c | 2016-04-12 13:30:16 +0530 | [diff] [blame] | 81 | * @throws IOException IO operations fails |
| 82 | */ |
janani b | de4ffab | 2016-04-15 16:18:30 +0530 | [diff] [blame] | 83 | private static void updatePackageInfo(JavaCodeGeneratorInfo javaCodeGeneratorInfo, YangPluginConfig yangPlugin, |
Vinod Kumar S | e4b9b0c | 2016-04-30 21:09:15 +0530 | [diff] [blame^] | 84 | String pkg) |
Gaurav Agrawal | 1c8f80c | 2016-04-12 13:30:16 +0530 | [diff] [blame] | 85 | throws IOException { |
| 86 | javaCodeGeneratorInfo.getJavaFileInfo() |
janani b | de4ffab | 2016-04-15 16:18:30 +0530 | [diff] [blame] | 87 | .setJavaName(getCaptialCase( |
| 88 | getCamelCase(((YangNode) javaCodeGeneratorInfo).getName(), yangPlugin.getConflictResolver()))); |
Gaurav Agrawal | 1c8f80c | 2016-04-12 13:30:16 +0530 | [diff] [blame] | 89 | javaCodeGeneratorInfo.getJavaFileInfo().setPackage(pkg); |
| 90 | javaCodeGeneratorInfo.getJavaFileInfo().setPackageFilePath( |
| 91 | getPackageDirPathFromJavaJPackage(javaCodeGeneratorInfo.getJavaFileInfo().getPackage())); |
janani b | de4ffab | 2016-04-15 16:18:30 +0530 | [diff] [blame] | 92 | javaCodeGeneratorInfo.getJavaFileInfo().setBaseCodeGenPath(yangPlugin.getCodeGenDir()); |
Gaurav Agrawal | 1c8f80c | 2016-04-12 13:30:16 +0530 | [diff] [blame] | 93 | } |
| 94 | |
| 95 | /** |
| 96 | * Updates temporary java code fragment files. |
| 97 | * |
| 98 | * @param javaCodeGeneratorInfo YANG java file info node |
| 99 | * @throws IOException IO operations fails |
| 100 | */ |
Vinod Kumar S | e4b9b0c | 2016-04-30 21:09:15 +0530 | [diff] [blame^] | 101 | private static void createTempFragmentFile(JavaCodeGeneratorInfo javaCodeGeneratorInfo) |
| 102 | throws IOException { |
Gaurav Agrawal | 1c8f80c | 2016-04-12 13:30:16 +0530 | [diff] [blame] | 103 | javaCodeGeneratorInfo.setTempJavaCodeFragmentFiles( |
Vinod Kumar S | e4b9b0c | 2016-04-30 21:09:15 +0530 | [diff] [blame^] | 104 | new TempJavaCodeFragmentFiles(javaCodeGeneratorInfo.getJavaFileInfo())); |
Gaurav Agrawal | 1c8f80c | 2016-04-12 13:30:16 +0530 | [diff] [blame] | 105 | } |
| 106 | |
| 107 | /** |
| 108 | * Updates leaf information in temporary java code fragment files. |
| 109 | * |
| 110 | * @param javaCodeGeneratorInfo YANG java file info node |
| 111 | * @throws IOException IO operations fails |
| 112 | */ |
Vinod Kumar S | e4b9b0c | 2016-04-30 21:09:15 +0530 | [diff] [blame^] | 113 | private static void updateTempFragmentFiles(JavaCodeGeneratorInfo javaCodeGeneratorInfo) |
Gaurav Agrawal | 1c8f80c | 2016-04-12 13:30:16 +0530 | [diff] [blame] | 114 | throws IOException { |
Gaurav Agrawal | 1c8f80c | 2016-04-12 13:30:16 +0530 | [diff] [blame] | 115 | if (javaCodeGeneratorInfo instanceof YangLeavesHolder) { |
| 116 | javaCodeGeneratorInfo.getTempJavaCodeFragmentFiles() |
| 117 | .addCurNodeLeavesInfoToTempFiles((YangNode) javaCodeGeneratorInfo); |
Vinod Kumar S | e4b9b0c | 2016-04-30 21:09:15 +0530 | [diff] [blame^] | 118 | } else if (javaCodeGeneratorInfo instanceof YangTypeContainer) { |
Gaurav Agrawal | 338735b | 2016-04-18 18:53:11 +0530 | [diff] [blame] | 119 | javaCodeGeneratorInfo.getTempJavaCodeFragmentFiles() |
Vinod Kumar S | e4b9b0c | 2016-04-30 21:09:15 +0530 | [diff] [blame^] | 120 | .addTypeInfoToTempFiles((YangTypeContainer) javaCodeGeneratorInfo); |
Bharat saraswal | d72411a | 2016-04-19 01:00:16 +0530 | [diff] [blame] | 121 | } else if (javaCodeGeneratorInfo instanceof YangJavaEnumeration) { |
| 122 | javaCodeGeneratorInfo.getTempJavaCodeFragmentFiles() |
| 123 | .addEnumAttributeToTempFiles((YangNode) javaCodeGeneratorInfo); |
Vinod Kumar S | e4b9b0c | 2016-04-30 21:09:15 +0530 | [diff] [blame^] | 124 | } else if (javaCodeGeneratorInfo instanceof YangChoice) { |
| 125 | /*Do nothing, only the interface needs to be generated*/ |
Gaurav Agrawal | 1c8f80c | 2016-04-12 13:30:16 +0530 | [diff] [blame] | 126 | } else { |
Vinod Kumar S | e4b9b0c | 2016-04-30 21:09:15 +0530 | [diff] [blame^] | 127 | throw new TranslatorException("Unsupported Node Translation"); |
Gaurav Agrawal | 1c8f80c | 2016-04-12 13:30:16 +0530 | [diff] [blame] | 128 | } |
| 129 | } |
| 130 | |
| 131 | /** |
| 132 | * Process generate code entry of YANG node. |
| 133 | * |
| 134 | * @param javaCodeGeneratorInfo YANG java file info node |
Gaurav Agrawal | 1c8f80c | 2016-04-12 13:30:16 +0530 | [diff] [blame] | 135 | * @throws IOException IO operations fails |
| 136 | */ |
| 137 | private static void generateTempFiles(JavaCodeGeneratorInfo javaCodeGeneratorInfo, String codeGenDir) |
| 138 | throws IOException { |
| 139 | if (!(javaCodeGeneratorInfo instanceof YangNode)) { |
Vinod Kumar S | e4b9b0c | 2016-04-30 21:09:15 +0530 | [diff] [blame^] | 140 | throw new TranslatorException("translation is not supported for the node"); |
Gaurav Agrawal | 1c8f80c | 2016-04-12 13:30:16 +0530 | [diff] [blame] | 141 | } |
| 142 | createTempFragmentFile(javaCodeGeneratorInfo); |
Vinod Kumar S | e4b9b0c | 2016-04-30 21:09:15 +0530 | [diff] [blame^] | 143 | updateTempFragmentFiles(javaCodeGeneratorInfo); |
Gaurav Agrawal | 1c8f80c | 2016-04-12 13:30:16 +0530 | [diff] [blame] | 144 | |
| 145 | } |
| 146 | |
| 147 | /** |
| 148 | * Process generate code entry of YANG node. |
| 149 | * |
| 150 | * @param javaCodeGeneratorInfo YANG java file info node |
Vinod Kumar S | e4b9b0c | 2016-04-30 21:09:15 +0530 | [diff] [blame^] | 151 | * @param yangPlugin YANG plugin config |
| 152 | * @param isMultiInstance flag to indicate whether it's a list |
Gaurav Agrawal | 1c8f80c | 2016-04-12 13:30:16 +0530 | [diff] [blame] | 153 | * @throws IOException IO operations fails |
| 154 | */ |
Vinod Kumar S | e4b9b0c | 2016-04-30 21:09:15 +0530 | [diff] [blame^] | 155 | public static void generateCodeAndUpdateInParent(JavaCodeGeneratorInfo javaCodeGeneratorInfo, |
| 156 | YangPluginConfig yangPlugin, boolean isMultiInstance) |
| 157 | throws IOException { |
Gaurav Agrawal | 1c8f80c | 2016-04-12 13:30:16 +0530 | [diff] [blame] | 158 | if (!(javaCodeGeneratorInfo instanceof YangNode)) { |
Vinod Kumar S | e4b9b0c | 2016-04-30 21:09:15 +0530 | [diff] [blame^] | 159 | throw new TranslatorException("Invalid node for translation"); |
Gaurav Agrawal | 1c8f80c | 2016-04-12 13:30:16 +0530 | [diff] [blame] | 160 | } |
Gaurav Agrawal | 1c8f80c | 2016-04-12 13:30:16 +0530 | [diff] [blame] | 161 | |
Vinod Kumar S | e4b9b0c | 2016-04-30 21:09:15 +0530 | [diff] [blame^] | 162 | /** |
| 163 | * Generate the Java files corresponding to the current node. |
| 164 | */ |
| 165 | generateCodeOfAugmentableNode(javaCodeGeneratorInfo, yangPlugin); |
| 166 | |
| 167 | /** |
| 168 | * Update the current nodes info in its parent nodes generated files. |
| 169 | */ |
| 170 | addCurNodeInfoInParentTempFile((YangNode) javaCodeGeneratorInfo, isMultiInstance); |
| 171 | } |
| 172 | |
| 173 | /** |
| 174 | * Process generate code entry of YANG type. |
| 175 | * |
| 176 | * @param javaCodeGeneratorInfo YANG java file info node |
| 177 | * @param yangPlugin YANG plugin config |
| 178 | * @throws IOException IO operations fails |
| 179 | */ |
| 180 | public static void generateCodeOfAugmentableNode(JavaCodeGeneratorInfo javaCodeGeneratorInfo, |
| 181 | YangPluginConfig yangPlugin) |
| 182 | throws IOException { |
| 183 | if (!(javaCodeGeneratorInfo instanceof YangNode)) { |
| 184 | throw new TranslatorException("invalid node for translation"); |
Vidyashree Rama | 7142d9c | 2016-04-26 15:06:06 +0530 | [diff] [blame] | 185 | } |
Bharat saraswal | cc1cdab | 2016-04-16 02:28:25 +0530 | [diff] [blame] | 186 | |
Vinod Kumar S | e4b9b0c | 2016-04-30 21:09:15 +0530 | [diff] [blame^] | 187 | generateCodeOfNode(javaCodeGeneratorInfo, yangPlugin); |
| 188 | |
Bharat saraswal | cc1cdab | 2016-04-16 02:28:25 +0530 | [diff] [blame] | 189 | /** |
| 190 | * For augmentation of nodes. |
| 191 | */ |
| 192 | if (javaCodeGeneratorInfo instanceof YangContainer |
| 193 | || javaCodeGeneratorInfo instanceof YangCase |
| 194 | || javaCodeGeneratorInfo instanceof YangChoice |
| 195 | || javaCodeGeneratorInfo instanceof YangInput |
| 196 | || javaCodeGeneratorInfo instanceof YangList |
| 197 | || javaCodeGeneratorInfo instanceof YangNotification |
| 198 | || javaCodeGeneratorInfo instanceof YangOutput) { |
| 199 | javaCodeGeneratorInfo.getTempJavaCodeFragmentFiles().addToExtendsList(HAS_AUGMENTATION); |
| 200 | } else if (javaCodeGeneratorInfo instanceof YangAugment) { |
| 201 | javaCodeGeneratorInfo.getTempJavaCodeFragmentFiles().addToExtendsList(AUGMENTED_INFO); |
| 202 | } |
Vidyashree Rama | 7142d9c | 2016-04-26 15:06:06 +0530 | [diff] [blame] | 203 | |
| 204 | if (javaCodeGeneratorInfo instanceof YangCase) { |
| 205 | YangNode parent = ((YangCase) javaCodeGeneratorInfo).getParent(); |
| 206 | String curNodeName = ((YangCase) javaCodeGeneratorInfo).getName(); |
| 207 | if (!parent.getName().equals(curNodeName)) { |
| 208 | javaCodeGeneratorInfo.getTempJavaCodeFragmentFiles().addToExtendsList(getCaptialCase(getCamelCase( |
Vinod Kumar S | e4b9b0c | 2016-04-30 21:09:15 +0530 | [diff] [blame^] | 209 | parent.getName(), null))); |
| 210 | javaCodeGeneratorInfo.getTempJavaCodeFragmentFiles().getBeanTempFiles() |
| 211 | .addParentInfoInCurNodeTempFile((YangNode) javaCodeGeneratorInfo); |
Vidyashree Rama | 7142d9c | 2016-04-26 15:06:06 +0530 | [diff] [blame] | 212 | } else { |
Vinod Kumar S | e4b9b0c | 2016-04-30 21:09:15 +0530 | [diff] [blame^] | 213 | String parentPackage = ((JavaFileInfoContainer) parent).getJavaFileInfo().getPackage(); |
Vidyashree Rama | 7142d9c | 2016-04-26 15:06:06 +0530 | [diff] [blame] | 214 | String caseExtendInfo = parentPackage + PERIOD + parent.getName(); |
| 215 | javaCodeGeneratorInfo.getTempJavaCodeFragmentFiles().addToExtendsList(caseExtendInfo); |
| 216 | } |
| 217 | } |
Gaurav Agrawal | 1c8f80c | 2016-04-12 13:30:16 +0530 | [diff] [blame] | 218 | } |
| 219 | |
| 220 | /** |
Gaurav Agrawal | 338735b | 2016-04-18 18:53:11 +0530 | [diff] [blame] | 221 | * Process generate code entry of YANG type. |
| 222 | * |
| 223 | * @param javaCodeGeneratorInfo YANG java file info node |
Vinod Kumar S | e4b9b0c | 2016-04-30 21:09:15 +0530 | [diff] [blame^] | 224 | * @param yangPlugin YANG plugin config |
Gaurav Agrawal | 338735b | 2016-04-18 18:53:11 +0530 | [diff] [blame] | 225 | * @throws IOException IO operations fails |
| 226 | */ |
Gaurav Agrawal | 5652766 | 2016-04-20 15:49:17 +0530 | [diff] [blame] | 227 | public static void generateCodeOfNode(JavaCodeGeneratorInfo javaCodeGeneratorInfo, YangPluginConfig yangPlugin) |
| 228 | throws IOException { |
Gaurav Agrawal | 338735b | 2016-04-18 18:53:11 +0530 | [diff] [blame] | 229 | if (!(javaCodeGeneratorInfo instanceof YangNode)) { |
| 230 | // TODO:throw exception |
| 231 | } |
Vinod Kumar S | e4b9b0c | 2016-04-30 21:09:15 +0530 | [diff] [blame^] | 232 | updatePackageInfo(javaCodeGeneratorInfo, yangPlugin); |
Gaurav Agrawal | 338735b | 2016-04-18 18:53:11 +0530 | [diff] [blame] | 233 | generateTempFiles(javaCodeGeneratorInfo, yangPlugin.getCodeGenDir()); |
| 234 | } |
| 235 | |
| 236 | /** |
Gaurav Agrawal | 1c8f80c | 2016-04-12 13:30:16 +0530 | [diff] [blame] | 237 | * Process generate code entry of root node. |
| 238 | * |
| 239 | * @param javaCodeGeneratorInfo YANG java file info node |
Vinod Kumar S | e4b9b0c | 2016-04-30 21:09:15 +0530 | [diff] [blame^] | 240 | * @param yangPlugin YANG plugin config |
| 241 | * @param rootPkg package of the root node |
Gaurav Agrawal | 1c8f80c | 2016-04-12 13:30:16 +0530 | [diff] [blame] | 242 | * @throws IOException IO operations fails |
| 243 | */ |
janani b | de4ffab | 2016-04-15 16:18:30 +0530 | [diff] [blame] | 244 | public static void generateCodeOfRootNode(JavaCodeGeneratorInfo javaCodeGeneratorInfo, YangPluginConfig yangPlugin, |
Vinod Kumar S | e4b9b0c | 2016-04-30 21:09:15 +0530 | [diff] [blame^] | 245 | String rootPkg) |
| 246 | throws IOException { |
Gaurav Agrawal | 1c8f80c | 2016-04-12 13:30:16 +0530 | [diff] [blame] | 247 | if (!(javaCodeGeneratorInfo instanceof YangNode)) { |
| 248 | // TODO:throw exception |
| 249 | } |
janani b | de4ffab | 2016-04-15 16:18:30 +0530 | [diff] [blame] | 250 | updatePackageInfo(javaCodeGeneratorInfo, yangPlugin, rootPkg); |
| 251 | generateTempFiles(javaCodeGeneratorInfo, yangPlugin.getCodeGenDir()); |
Gaurav Agrawal | 1c8f80c | 2016-04-12 13:30:16 +0530 | [diff] [blame] | 252 | } |
| 253 | } |