Gaurav Agrawal | cfa1c41 | 2016-05-03 00:41:48 +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 | |
Gaurav Agrawal | 95b416c | 2016-06-07 14:00:26 +0530 | [diff] [blame] | 17 | package org.onosproject.yangutils.datamodel.utils; |
Gaurav Agrawal | cfa1c41 | 2016-05-03 00:41:48 +0530 | [diff] [blame] | 18 | |
Bharat saraswal | 96dfef0 | 2016-06-16 00:29:12 +0530 | [diff] [blame] | 19 | import java.util.regex.Pattern; |
Bharat saraswal | 96dfef0 | 2016-06-16 00:29:12 +0530 | [diff] [blame] | 20 | import org.onosproject.yangutils.datamodel.YangRangeInterval; |
| 21 | import org.onosproject.yangutils.datamodel.YangRangeRestriction; |
| 22 | import org.onosproject.yangutils.datamodel.exceptions.DataModelException; |
| 23 | import org.onosproject.yangutils.datamodel.utils.builtindatatype.YangBuiltInDataTypeInfo; |
Gaurav Agrawal | 72cd1b7 | 2016-06-30 13:28:14 +0530 | [diff] [blame] | 24 | import org.onosproject.yangutils.datamodel.utils.builtindatatype.YangDataTypes; |
| 25 | |
| 26 | import static org.onosproject.yangutils.datamodel.BuiltInTypeObjectFactory.getDataObjectFromString; |
| 27 | import static org.onosproject.yangutils.datamodel.utils.YangConstructType.LENGTH_DATA; |
| 28 | import static org.onosproject.yangutils.datamodel.utils.YangConstructType.RANGE_DATA; |
Bharat saraswal | 96dfef0 | 2016-06-16 00:29:12 +0530 | [diff] [blame] | 29 | |
Gaurav Agrawal | cfa1c41 | 2016-05-03 00:41:48 +0530 | [diff] [blame] | 30 | /** |
| 31 | * Represents restriction resolver which provide common utility used by parser |
| 32 | * and during linking for restriction resolution. |
| 33 | */ |
| 34 | public final class RestrictionResolver { |
| 35 | |
| 36 | private static final String PIPE = "|"; |
Bharat saraswal | 96dfef0 | 2016-06-16 00:29:12 +0530 | [diff] [blame] | 37 | private static final String ADD = "+"; |
| 38 | private static final String EMPTY_STRING = ""; |
Gaurav Agrawal | cfa1c41 | 2016-05-03 00:41:48 +0530 | [diff] [blame] | 39 | private static final String INTERVAL = ".."; |
| 40 | private static final int MAX_RANGE_BOUNDARY = 2; |
| 41 | private static final int MIN_RANGE_BOUNDARY = 1; |
| 42 | private static final String MIN_KEYWORD = "min"; |
| 43 | private static final String MAX_KEYWORD = "max"; |
| 44 | |
| 45 | /** |
| 46 | * Creates a restriction resolver. |
| 47 | */ |
| 48 | private RestrictionResolver() { |
| 49 | } |
| 50 | |
| 51 | /** |
| 52 | * Processes the range restriction for parser and linker. |
| 53 | * |
| 54 | * @param refRangeRestriction range restriction of referred typedef |
| 55 | * @param lineNumber error line number |
| 56 | * @param charPositionInLine error character position in line |
| 57 | * @param hasReferredRestriction whether has referred restriction |
| 58 | * @param curRangeString caller type's range string |
| 59 | * @param effectiveType effective type, when called from linker |
| 60 | * @return YANG range restriction |
Gaurav Agrawal | 95b416c | 2016-06-07 14:00:26 +0530 | [diff] [blame] | 61 | * @throws DataModelException a violation in data model rule |
Gaurav Agrawal | cfa1c41 | 2016-05-03 00:41:48 +0530 | [diff] [blame] | 62 | */ |
| 63 | public static YangRangeRestriction processRangeRestriction(YangRangeRestriction refRangeRestriction, |
Gaurav Agrawal | 72cd1b7 | 2016-06-30 13:28:14 +0530 | [diff] [blame] | 64 | int lineNumber, int charPositionInLine, |
| 65 | boolean hasReferredRestriction, |
| 66 | String curRangeString, YangDataTypes effectiveType) |
Gaurav Agrawal | 95b416c | 2016-06-07 14:00:26 +0530 | [diff] [blame] | 67 | throws DataModelException { |
Gaurav Agrawal | cfa1c41 | 2016-05-03 00:41:48 +0530 | [diff] [blame] | 68 | YangBuiltInDataTypeInfo<?> startValue; |
| 69 | YangBuiltInDataTypeInfo<?> endValue; |
| 70 | YangRangeRestriction rangeRestriction = new YangRangeRestriction(); |
| 71 | |
| 72 | String rangeArgument = removeQuotesAndHandleConcat(curRangeString); |
| 73 | String[] rangeArguments = rangeArgument.trim().split(Pattern.quote(PIPE)); |
| 74 | |
| 75 | for (String rangePart : rangeArguments) { |
| 76 | String startInterval; |
| 77 | String endInterval; |
| 78 | YangRangeInterval rangeInterval = new YangRangeInterval(); |
| 79 | String[] rangeBoundary = rangePart.trim().split(Pattern.quote(INTERVAL)); |
| 80 | |
| 81 | if (rangeBoundary.length > MAX_RANGE_BOUNDARY) { |
Gaurav Agrawal | 95b416c | 2016-06-07 14:00:26 +0530 | [diff] [blame] | 82 | DataModelException dataModelException = new DataModelException("YANG file error : " + |
Gaurav Agrawal | cfa1c41 | 2016-05-03 00:41:48 +0530 | [diff] [blame] | 83 | YangConstructType.getYangConstructType(RANGE_DATA) + " " + rangeArgument + |
| 84 | " is not valid."); |
Gaurav Agrawal | 95b416c | 2016-06-07 14:00:26 +0530 | [diff] [blame] | 85 | dataModelException.setLine(lineNumber); |
| 86 | dataModelException.setCharPosition(charPositionInLine); |
| 87 | throw dataModelException; |
Gaurav Agrawal | cfa1c41 | 2016-05-03 00:41:48 +0530 | [diff] [blame] | 88 | } |
| 89 | |
| 90 | if (rangeBoundary.length == MIN_RANGE_BOUNDARY) { |
janani b | dd1314f | 2016-05-19 17:39:50 +0530 | [diff] [blame] | 91 | startInterval = rangeBoundary[0].trim(); |
| 92 | endInterval = rangeBoundary[0].trim(); |
Gaurav Agrawal | cfa1c41 | 2016-05-03 00:41:48 +0530 | [diff] [blame] | 93 | } else { |
janani b | dd1314f | 2016-05-19 17:39:50 +0530 | [diff] [blame] | 94 | startInterval = rangeBoundary[0].trim(); |
| 95 | endInterval = rangeBoundary[1].trim(); |
Gaurav Agrawal | cfa1c41 | 2016-05-03 00:41:48 +0530 | [diff] [blame] | 96 | } |
| 97 | |
| 98 | try { |
| 99 | if (hasReferredRestriction && startInterval.equals(MIN_KEYWORD) |
| 100 | && refRangeRestriction.getMinRestrictedvalue() != null) { |
| 101 | startValue = refRangeRestriction.getMinRestrictedvalue(); |
| 102 | } else if (hasReferredRestriction && startInterval.equals(MAX_KEYWORD) |
| 103 | && refRangeRestriction.getMaxRestrictedvalue() != null) { |
| 104 | startValue = refRangeRestriction.getMaxRestrictedvalue(); |
| 105 | } else { |
| 106 | startValue = getDataObjectFromString(startInterval, effectiveType); |
| 107 | } |
| 108 | if (hasReferredRestriction && endInterval.equals(MIN_KEYWORD) |
| 109 | && refRangeRestriction.getMinRestrictedvalue() != null) { |
| 110 | endValue = refRangeRestriction.getMinRestrictedvalue(); |
| 111 | } else if (hasReferredRestriction && endInterval.equals(MAX_KEYWORD) |
| 112 | && refRangeRestriction.getMaxRestrictedvalue() != null) { |
| 113 | endValue = refRangeRestriction.getMaxRestrictedvalue(); |
| 114 | } else { |
| 115 | endValue = getDataObjectFromString(endInterval, effectiveType); |
| 116 | } |
Gaurav Agrawal | 95b416c | 2016-06-07 14:00:26 +0530 | [diff] [blame] | 117 | } catch (Exception e) { |
| 118 | DataModelException dataModelException = new DataModelException(e.getMessage()); |
| 119 | dataModelException.setLine(lineNumber); |
| 120 | dataModelException.setCharPosition(charPositionInLine); |
| 121 | throw dataModelException; |
Gaurav Agrawal | cfa1c41 | 2016-05-03 00:41:48 +0530 | [diff] [blame] | 122 | } |
| 123 | |
| 124 | rangeInterval.setStartValue(startValue); |
| 125 | rangeInterval.setEndValue(endValue); |
| 126 | |
| 127 | try { |
| 128 | rangeRestriction.addRangeRestrictionInterval(rangeInterval); |
Gaurav Agrawal | 95b416c | 2016-06-07 14:00:26 +0530 | [diff] [blame] | 129 | } catch (DataModelException dataModelException) { |
| 130 | dataModelException.setLine(lineNumber); |
| 131 | dataModelException.setCharPosition(charPositionInLine); |
| 132 | throw dataModelException; |
Gaurav Agrawal | cfa1c41 | 2016-05-03 00:41:48 +0530 | [diff] [blame] | 133 | } |
| 134 | } |
| 135 | return rangeRestriction; |
| 136 | } |
| 137 | |
| 138 | /** |
| 139 | * Processes the length restriction for parser and linker. |
| 140 | * |
| 141 | * @param refLengthRestriction length restriction of referred typedef |
| 142 | * @param lineNumber error line number |
| 143 | * @param charPositionInLine error character position in line |
| 144 | * @param hasReferredRestriction whether has referred restriction |
| 145 | * @param curLengthString caller type's length string |
| 146 | * @return YANG range restriction |
Gaurav Agrawal | 95b416c | 2016-06-07 14:00:26 +0530 | [diff] [blame] | 147 | * @throws DataModelException a violation in data model rule |
Gaurav Agrawal | cfa1c41 | 2016-05-03 00:41:48 +0530 | [diff] [blame] | 148 | */ |
| 149 | public static YangRangeRestriction processLengthRestriction(YangRangeRestriction refLengthRestriction, |
Gaurav Agrawal | 72cd1b7 | 2016-06-30 13:28:14 +0530 | [diff] [blame] | 150 | int lineNumber, int charPositionInLine, |
| 151 | boolean hasReferredRestriction, |
| 152 | String curLengthString) throws DataModelException { |
Gaurav Agrawal | cfa1c41 | 2016-05-03 00:41:48 +0530 | [diff] [blame] | 153 | |
| 154 | YangBuiltInDataTypeInfo<?> startValue; |
| 155 | YangBuiltInDataTypeInfo<?> endValue; |
| 156 | YangRangeRestriction lengthRestriction = new YangRangeRestriction<>(); |
| 157 | |
| 158 | String rangeArgument = removeQuotesAndHandleConcat(curLengthString); |
| 159 | String[] rangeArguments = rangeArgument.trim().split(Pattern.quote(PIPE)); |
| 160 | |
| 161 | for (String rangePart : rangeArguments) { |
| 162 | String startInterval; |
| 163 | String endInterval; |
| 164 | YangRangeInterval rangeInterval = new YangRangeInterval<>(); |
| 165 | String[] rangeBoundary = rangePart.trim().split(Pattern.quote(INTERVAL)); |
| 166 | |
| 167 | if (rangeBoundary.length > MAX_RANGE_BOUNDARY) { |
Gaurav Agrawal | 95b416c | 2016-06-07 14:00:26 +0530 | [diff] [blame] | 168 | DataModelException dataModelException = new DataModelException("YANG file error : " + |
Gaurav Agrawal | cfa1c41 | 2016-05-03 00:41:48 +0530 | [diff] [blame] | 169 | YangConstructType.getYangConstructType(LENGTH_DATA) + " " + rangeArgument + |
| 170 | " is not valid."); |
Gaurav Agrawal | 95b416c | 2016-06-07 14:00:26 +0530 | [diff] [blame] | 171 | dataModelException.setLine(lineNumber); |
| 172 | dataModelException.setCharPosition(charPositionInLine); |
| 173 | throw dataModelException; |
Gaurav Agrawal | cfa1c41 | 2016-05-03 00:41:48 +0530 | [diff] [blame] | 174 | } |
| 175 | |
| 176 | if (rangeBoundary.length == MIN_RANGE_BOUNDARY) { |
janani b | dd1314f | 2016-05-19 17:39:50 +0530 | [diff] [blame] | 177 | startInterval = rangeBoundary[0].trim(); |
| 178 | endInterval = rangeBoundary[0].trim(); |
Gaurav Agrawal | cfa1c41 | 2016-05-03 00:41:48 +0530 | [diff] [blame] | 179 | } else { |
janani b | dd1314f | 2016-05-19 17:39:50 +0530 | [diff] [blame] | 180 | startInterval = rangeBoundary[0].trim(); |
| 181 | endInterval = rangeBoundary[1].trim(); |
Gaurav Agrawal | cfa1c41 | 2016-05-03 00:41:48 +0530 | [diff] [blame] | 182 | } |
| 183 | |
| 184 | try { |
| 185 | if (hasReferredRestriction && startInterval.equals(MIN_KEYWORD) |
| 186 | && refLengthRestriction.getMinRestrictedvalue() != null) { |
| 187 | startValue = refLengthRestriction.getMinRestrictedvalue(); |
| 188 | } else if (hasReferredRestriction && startInterval.equals(MAX_KEYWORD) |
| 189 | && refLengthRestriction.getMaxRestrictedvalue() != null) { |
| 190 | startValue = refLengthRestriction.getMaxRestrictedvalue(); |
| 191 | } else { |
| 192 | startValue = getDataObjectFromString(startInterval, YangDataTypes.UINT64); |
| 193 | } |
| 194 | if (hasReferredRestriction && endInterval.equals(MIN_KEYWORD) |
| 195 | && refLengthRestriction.getMinRestrictedvalue() != null) { |
| 196 | endValue = refLengthRestriction.getMinRestrictedvalue(); |
| 197 | } else if (hasReferredRestriction && endInterval.equals(MAX_KEYWORD) |
| 198 | && refLengthRestriction.getMaxRestrictedvalue() != null) { |
| 199 | endValue = refLengthRestriction.getMaxRestrictedvalue(); |
| 200 | } else { |
| 201 | endValue = getDataObjectFromString(endInterval, YangDataTypes.UINT64); |
| 202 | } |
Gaurav Agrawal | 95b416c | 2016-06-07 14:00:26 +0530 | [diff] [blame] | 203 | } catch (Exception e) { |
| 204 | DataModelException dataModelException = new DataModelException(e.getMessage()); |
| 205 | dataModelException.setLine(lineNumber); |
| 206 | dataModelException.setCharPosition(charPositionInLine); |
| 207 | throw dataModelException; |
Gaurav Agrawal | cfa1c41 | 2016-05-03 00:41:48 +0530 | [diff] [blame] | 208 | } |
| 209 | |
| 210 | rangeInterval.setStartValue(startValue); |
| 211 | rangeInterval.setEndValue(endValue); |
| 212 | |
| 213 | try { |
| 214 | lengthRestriction.addRangeRestrictionInterval(rangeInterval); |
Gaurav Agrawal | 95b416c | 2016-06-07 14:00:26 +0530 | [diff] [blame] | 215 | } catch (DataModelException dataModelException) { |
| 216 | dataModelException.setLine(lineNumber); |
| 217 | dataModelException.setCharPosition(charPositionInLine); |
| 218 | throw dataModelException; |
Gaurav Agrawal | cfa1c41 | 2016-05-03 00:41:48 +0530 | [diff] [blame] | 219 | } |
| 220 | } |
| 221 | return lengthRestriction; |
| 222 | } |
| 223 | |
| 224 | /** |
Gaurav Agrawal | 95b416c | 2016-06-07 14:00:26 +0530 | [diff] [blame] | 225 | * Removes doubles quotes and concatenates if string has plus symbol. |
| 226 | * |
| 227 | * @param yangStringData string from yang file |
| 228 | * @return concatenated string after removing double quotes |
| 229 | */ |
| 230 | private static String removeQuotesAndHandleConcat(String yangStringData) { |
| 231 | |
| 232 | yangStringData = yangStringData.replace("\"", EMPTY_STRING); |
| 233 | String[] tmpData = yangStringData.split(Pattern.quote(ADD)); |
| 234 | StringBuilder builder = new StringBuilder(); |
| 235 | for (String yangString : tmpData) { |
| 236 | builder.append(yangString); |
| 237 | } |
| 238 | return builder.toString(); |
| 239 | } |
Gaurav Agrawal | cfa1c41 | 2016-05-03 00:41:48 +0530 | [diff] [blame] | 240 | } |