[ONOS-4744] Leafref implementation and UT
Change-Id: I151797185e0bb1695c0640b667ae76ef87c4d4b0
diff --git a/utils/yangutils/plugin/src/main/java/org/onosproject/yangutils/linker/impl/YangLinkerManager.java b/utils/yangutils/plugin/src/main/java/org/onosproject/yangutils/linker/impl/YangLinkerManager.java
index dc321bd..914b5d5 100644
--- a/utils/yangutils/plugin/src/main/java/org/onosproject/yangutils/linker/impl/YangLinkerManager.java
+++ b/utils/yangutils/plugin/src/main/java/org/onosproject/yangutils/linker/impl/YangLinkerManager.java
@@ -161,6 +161,8 @@
((YangReferenceResolver) yangNode).resolveInterFileLinking(ResolvableType.YANG_USES);
((YangReferenceResolver) yangNode)
.resolveInterFileLinking(ResolvableType.YANG_DERIVED_DATA_TYPE);
+ ((YangReferenceResolver) yangNode)
+ .resolveInterFileLinking(ResolvableType.YANG_LEAFREF);
} catch (DataModelException e) {
String errorInfo = "Error in file: " + yangNode.getName() + " at line: "
+ e.getLineNumber() + " at position: " + e.getCharPositionInLine() + NEW_LINE + e.getMessage();
diff --git a/utils/yangutils/plugin/src/main/java/org/onosproject/yangutils/linker/impl/YangResolutionInfoImpl.java b/utils/yangutils/plugin/src/main/java/org/onosproject/yangutils/linker/impl/YangResolutionInfoImpl.java
index 5786224..b70d44c 100644
--- a/utils/yangutils/plugin/src/main/java/org/onosproject/yangutils/linker/impl/YangResolutionInfoImpl.java
+++ b/utils/yangutils/plugin/src/main/java/org/onosproject/yangutils/linker/impl/YangResolutionInfoImpl.java
@@ -22,7 +22,8 @@
import java.util.Stack;
import org.onosproject.yangutils.datamodel.Resolvable;
-import org.onosproject.yangutils.datamodel.utils.builtindatatype.YangDataTypes;
+import org.onosproject.yangutils.datamodel.ResolvableType;
+import org.onosproject.yangutils.datamodel.YangAtomicPath;
import org.onosproject.yangutils.datamodel.YangDerivedInfo;
import org.onosproject.yangutils.datamodel.YangEntityToResolveInfo;
import org.onosproject.yangutils.datamodel.YangFeature;
@@ -31,15 +32,29 @@
import org.onosproject.yangutils.datamodel.YangIfFeature;
import org.onosproject.yangutils.datamodel.YangImport;
import org.onosproject.yangutils.datamodel.YangInclude;
+import org.onosproject.yangutils.datamodel.YangInput;
+import org.onosproject.yangutils.datamodel.YangLeaf;
+import org.onosproject.yangutils.datamodel.YangLeafList;
+import org.onosproject.yangutils.datamodel.YangLeafRef;
+import org.onosproject.yangutils.datamodel.YangLeavesHolder;
+import org.onosproject.yangutils.datamodel.YangList;
+import org.onosproject.yangutils.datamodel.YangModule;
import org.onosproject.yangutils.datamodel.YangNode;
import org.onosproject.yangutils.datamodel.YangNodeIdentifier;
+import org.onosproject.yangutils.datamodel.YangOutput;
+import org.onosproject.yangutils.datamodel.YangPathArgType;
+import org.onosproject.yangutils.datamodel.YangPathPredicate;
import org.onosproject.yangutils.datamodel.YangReferenceResolver;
+import org.onosproject.yangutils.datamodel.YangRelativePath;
import org.onosproject.yangutils.datamodel.YangResolutionInfo;
+import org.onosproject.yangutils.datamodel.YangRpc;
+import org.onosproject.yangutils.datamodel.YangSubModule;
import org.onosproject.yangutils.datamodel.YangType;
import org.onosproject.yangutils.datamodel.YangTypeDef;
import org.onosproject.yangutils.datamodel.YangUses;
import org.onosproject.yangutils.datamodel.exceptions.DataModelException;
import org.onosproject.yangutils.datamodel.utils.ResolvableStatus;
+import org.onosproject.yangutils.datamodel.utils.builtindatatype.YangDataTypes;
import org.onosproject.yangutils.linker.YangLinkingPhase;
import static org.onosproject.yangutils.datamodel.utils.ResolvableStatus.INTER_FILE_LINKED;
@@ -52,6 +67,10 @@
import static org.onosproject.yangutils.linker.YangLinkingPhase.INTRA_FILE;
import static org.onosproject.yangutils.utils.UtilConstants.FEATURE_LINKER_ERROR;
import static org.onosproject.yangutils.utils.UtilConstants.GROUPING_LINKER_ERROR;
+import static org.onosproject.yangutils.utils.UtilConstants.INPUT;
+import static org.onosproject.yangutils.utils.UtilConstants.LEAFREF;
+import static org.onosproject.yangutils.utils.UtilConstants.LEAFREF_LINKER_ERROR;
+import static org.onosproject.yangutils.utils.UtilConstants.OUTPUT;
import static org.onosproject.yangutils.utils.UtilConstants.TYPEDEF_LINKER_ERROR;
/**
@@ -124,7 +143,7 @@
setCurReferenceResolver(dataModelRootNode);
- // Current node to resolve, it can be a YANG type, YANG uses or YANG if-feature.
+ // Current node to resolve, it can be a YANG type, YANG uses or YANG if-feature or YANG leafref.
T entityToResolve = getEntityToResolveInfo().getEntityToResolve();
// Check if linking is already done
@@ -138,13 +157,15 @@
}
} else {
throw new DataModelException("Data Model Exception: Entity to resolved is other than " +
- "type/uses/if-feature");
+ "type/uses/if-feature/leafref");
}
// Push the initial entity to resolve in stack.
addInPartialResolvedStack(getEntityToResolveInfo());
linkAndResolvePartialResolvedStack();
+
+ addDerivedRefTypeToRefTypeResolutionList();
}
/**
@@ -204,8 +225,10 @@
errorInfo = TYPEDEF_LINKER_ERROR;
} else if (resolvable instanceof YangUses) {
errorInfo = GROUPING_LINKER_ERROR;
- } else {
+ } else if (resolvable instanceof YangIfFeature) {
errorInfo = FEATURE_LINKER_ERROR;
+ } else {
+ errorInfo = LEAFREF_LINKER_ERROR;
}
DataModelException dataModelException =
new DataModelException(errorInfo);
@@ -222,14 +245,78 @@
}
} else {
- throw new DataModelException("Data Model Exception: Entity to resolved is other than type/uses");
+ throw new DataModelException(
+ "Data Model Exception: Entity to resolved is other than type/uses/if-feature/leafref");
}
-
}
}
/**
+ * Adds the leafref type to the type, which has derived type referring to typedef with leafref type.
+ */
+ private void addDerivedRefTypeToRefTypeResolutionList() throws DataModelException {
+
+ YangNode potentialAncestorWithReferredNode = getEntityToResolveInfo().getHolderOfEntityToResolve();
+
+ // If holder is typedef return.
+ if (potentialAncestorWithReferredNode instanceof YangTypeDef) {
+ return;
+ }
+
+ // If entity is not type return.
+ if (!(getEntityToResolveInfo().getEntityToResolve() instanceof YangType)) {
+ return;
+ }
+
+ YangType yangType = (YangType) getEntityToResolveInfo().getEntityToResolve();
+
+ // If type is not resolved return.
+ if (yangType.getResolvableStatus() != RESOLVED) {
+ return;
+ }
+
+ YangDerivedInfo derivedInfo = (YangDerivedInfo) yangType.getDataTypeExtendedInfo();
+
+ /*
+ * If the derived types referred type is not leaf ref return
+ */
+ if (derivedInfo.getEffectiveBuiltInType() != YangDataTypes.LEAFREF) {
+ return;
+ }
+
+ T extendedInfo = (T) derivedInfo.getReferredTypeDef().getTypeDefBaseType().getDataTypeExtendedInfo();
+
+ while (extendedInfo instanceof YangDerivedInfo) {
+ YangDerivedInfo derivedInfoFromTypedef = (YangDerivedInfo) extendedInfo;
+ extendedInfo = (T) derivedInfoFromTypedef.getReferredTypeDef().getTypeDefBaseType()
+ .getDataTypeExtendedInfo();
+ }
+ /*
+ * Backup the derived types leaf ref info, delete all the info in
+ * current type, but for resolution status as resolved. Copy the backed
+ * up leaf ref to types extended info, create a leaf ref resolution info
+ * using the current resolution info and add to leaf ref resolution
+ * list.
+ */
+ YangLeafRef leafRefInTypeDef = (YangLeafRef) extendedInfo;
+ yangType.resetYangType();
+
+ yangType.setResolvableStatus(RESOLVED);
+ yangType.setDataType(YangDataTypes.LEAFREF);
+ yangType.setDataTypeName(LEAFREF);
+ yangType.setDataTypeExtendedInfo(leafRefInTypeDef);
+ leafRefInTypeDef.setResolvableStatus(UNRESOLVED);
+
+ // Add resolution information to the list.
+ YangResolutionInfoImpl resolutionInfoImpl = new YangResolutionInfoImpl<>(leafRefInTypeDef,
+ potentialAncestorWithReferredNode, getLineNumber(), getCharPosition());
+ getCurReferenceResolver().addToResolutionList(resolutionInfoImpl,
+ ResolvableType.YANG_LEAFREF);
+ getCurReferenceResolver().resolveSelfFileLinking(ResolvableType.YANG_LEAFREF);
+ }
+
+ /**
* Resolves the current entity in the stack.
*/
private void resolveTopOfStack(YangLinkingPhase linkingPhase)
@@ -237,7 +324,7 @@
((Resolvable) getCurrentEntityToResolveFromStack()).resolve();
if (((Resolvable) getCurrentEntityToResolveFromStack()).getResolvableStatus() != INTRA_FILE_RESOLVED
&& ((Resolvable) getCurrentEntityToResolveFromStack()).getResolvableStatus() != UNDEFINED) {
- // Sets the resolution status in inside the type/uses/if-feature.
+ // Sets the resolution status in inside the type/uses/if-feature/leafref.
((Resolvable) getCurrentEntityToResolveFromStack()).setResolvableStatus(RESOLVED);
}
}
@@ -270,6 +357,9 @@
if (getCurrentEntityToResolveFromStack() instanceof YangIfFeature) {
resolveSelfFileLinkingForIfFeature(potentialAncestorWithReferredNode);
return;
+ } else if (getCurrentEntityToResolveFromStack() instanceof YangLeafRef) {
+ resolveSelfFileLinkingForLeafref(potentialAncestorWithReferredNode);
+ return;
} else {
/**
@@ -300,6 +390,91 @@
}
/**
+ * Resolves self file linking for leafref.
+ *
+ * @param potentialAncestorWithReferredNode leafref holder node
+ * @throws DataModelException a violation of data model rules
+ */
+ private void resolveSelfFileLinkingForLeafref(YangNode potentialAncestorWithReferredNode)
+ throws DataModelException {
+
+ YangNode ancestorWithTheReferredNode = potentialAncestorWithReferredNode;
+ YangLeafRef leafref = (YangLeafRef) getCurrentEntityToResolveFromStack();
+ boolean referredLeafFound = false;
+
+ /*
+ * Takes absolute path and takes the root node as module/sub-module,
+ * then sends the list of nodes for finding the target leaf.
+ */
+ if (leafref.getPathType() == YangPathArgType.ABSOLUTE_PATH) {
+ List<YangAtomicPath> atomicPathList = leafref.getAtomicPath();
+ if (atomicPathList != null && !atomicPathList.isEmpty()) {
+ Iterator<YangAtomicPath> listOfYangAtomicPath = atomicPathList.listIterator();
+ if (getCurReferenceResolver() instanceof YangModule) {
+ YangModule rootNode = (YangModule) getCurReferenceResolver();
+ // Sends list of nodes for finding the target leaf.
+ referredLeafFound = isLeafReferenceFound(listOfYangAtomicPath, rootNode,
+ referredLeafFound, potentialAncestorWithReferredNode);
+ } else if (getCurReferenceResolver() instanceof YangSubModule) {
+ YangSubModule rootNode = (YangSubModule) getCurReferenceResolver();
+ // Sends list of nodes for finding the target leaf.
+ referredLeafFound = isLeafReferenceFound(listOfYangAtomicPath, rootNode,
+ referredLeafFound, potentialAncestorWithReferredNode);
+ }
+ }
+ /*
+ * Takes relative path, goes to the parent node by using the
+ * ancestor count and sends the list of nodes for finding the target
+ * leaf.
+ */
+ } else if (leafref.getPathType() == YangPathArgType.RELATIVE_PATH) {
+ YangRelativePath yangRelativePath = leafref.getRelativePath();
+ int parentNodes = yangRelativePath.getAncestorNodeCount();
+ List<YangAtomicPath> atomicPathList = yangRelativePath.getAtomicPathList();
+ if (atomicPathList != null && !atomicPathList.isEmpty()) {
+ Iterator<YangAtomicPath> listOfAtomicPath = atomicPathList.listIterator();
+ // Gets the root node from ancestor count.
+ YangNode rootparentNode = getRootNodeWithAncestorCount(parentNodes, ancestorWithTheReferredNode);
+ // Sends list of nodes for finding the target leaf.
+ referredLeafFound = isLeafReferenceFound(listOfAtomicPath, rootparentNode,
+ referredLeafFound, potentialAncestorWithReferredNode);
+ }
+ }
+ if (referredLeafFound) {
+ return;
+ }
+ /*
+ * In case prefix is not present it's a candidate for inter-file
+ * resolution via include list.
+ */
+ if (getRefPrefix() == null) {
+ ((Resolvable) getCurrentEntityToResolveFromStack()).setResolvableStatus(INTRA_FILE_RESOLVED);
+ }
+ }
+
+ /**
+ * Returns the root parent with respect to the ancestor count from leafref.
+ *
+ * @param ancestorCount count of node where parent node can be reached
+ * @param currentParent current parent node
+ * @return root node
+ * @throws DataModelException a violation of data model rules
+ */
+ private YangNode getRootNodeWithAncestorCount(int ancestorCount, YangNode currentParent)
+ throws DataModelException {
+
+ int currentParentCount = 1;
+ while (currentParentCount < ancestorCount) {
+ if (currentParent.getParent() == null) {
+ throw new DataModelException("YANG file error: The target node of leafref is invalid.");
+ }
+ currentParent = currentParent.getParent();
+ currentParentCount = currentParentCount + 1;
+ }
+ return currentParent;
+ }
+
+ /**
* Resolves self file linking for if-feature.
*
* @param potentialAncestorWithReferredNode if-feature holder node
@@ -333,6 +508,289 @@
}
}
+ /**
+ * Returns the status of the referred leaf/leaf-list found for leafref.
+ *
+ * @param listOfYangAtomicPath list of atomic paths
+ * @param ancestorWithTheReferredNode the parent node of leafref
+ * @param referredLeafFound status of referred leaf/leaf-list
+ * @param potentialAncestorWithReferredNode holder of the leafref leaf
+ * @return status of referred leaf
+ * @throws DataModelException a violation of data model rules
+ */
+ private boolean isLeafReferenceFound(Iterator<YangAtomicPath> listOfYangAtomicPath,
+ YangNode ancestorWithTheReferredNode, boolean referredLeafFound, YangNode potentialAncestorWithReferredNode)
+ throws DataModelException {
+
+ while (listOfYangAtomicPath.hasNext()) {
+ YangAtomicPath atomicPath = listOfYangAtomicPath.next();
+ String nodeName = atomicPath.getNodeIdentifier().getName();
+
+ // When child is not present, only leaf/leaf-list is available in the node.
+ if (ancestorWithTheReferredNode.getChild() == null) {
+ referredLeafFound = isReferredLeafOrLeafListFound(ancestorWithTheReferredNode, nodeName, (T) LINKED);
+ break;
+ }
+ ancestorWithTheReferredNode = ancestorWithTheReferredNode.getChild();
+
+ // Checks all the siblings under the node and returns the matched node.
+ YangNode nodeFound = isReferredNodeInSiblingProcessedForLeafref(ancestorWithTheReferredNode, nodeName);
+
+ // When node is not found in all the siblings, leaf-list may be the node we have to find.
+ if (nodeFound == null) {
+ referredLeafFound = isReferredLeafOrLeafListFound(ancestorWithTheReferredNode.getParent(), nodeName,
+ (T) LINKED);
+ } else {
+ ancestorWithTheReferredNode = nodeFound;
+
+ // For the node check if path predicate is present and fill its values.
+ List<YangPathPredicate> pathPredicateList = atomicPath.getPathPredicatesList();
+ if (pathPredicateList != null && !pathPredicateList.isEmpty()) {
+ Iterator<YangPathPredicate> listOfYangPathPredicate = pathPredicateList.listIterator();
+ fillPathPredicatesForTheNode(ancestorWithTheReferredNode, listOfYangPathPredicate,
+ potentialAncestorWithReferredNode);
+ }
+ }
+
+ // If leaf is also not found and node is also not found return the status as false.
+ if (!referredLeafFound && nodeFound == null) {
+ break;
+ }
+ }
+ return referredLeafFound;
+ }
+
+ /**
+ * Fills the referred leaf or leaf-list inside the path predicates.
+ *
+ * @param ancestorWithTheReferredNode the actual node where YANG list will be present
+ * @param listOfYangPathPredicate the path predicates present for the node
+ * @param potentialAncestorWithReferredNode the current leaf node parent
+ * @throws DataModelException a violation of data model rules
+ */
+ private void fillPathPredicatesForTheNode(YangNode ancestorWithTheReferredNode,
+ Iterator<YangPathPredicate> listOfYangPathPredicate, YangNode potentialAncestorWithReferredNode)
+ throws DataModelException {
+
+ while (listOfYangPathPredicate.hasNext()) {
+ if (!(ancestorWithTheReferredNode instanceof YangList)) {
+ throw new DataModelException("YANG file error: The path predicates are applicable only for list");
+ }
+ YangPathPredicate pathPredicate = listOfYangPathPredicate.next();
+ YangNodeIdentifier leftNode = pathPredicate.getNodeIdentifier();
+ YangRelativePath relativePath = pathPredicate.getRightRelativePath();
+
+ // Checks that the left axis is filled in the path predicate.
+ boolean isLeftLeafOrLeafListSetForLeftAxis = getLeftLeafOrLeafListInPredicate(
+ (YangList) ancestorWithTheReferredNode, pathPredicate, leftNode);
+ if (!isLeftLeafOrLeafListSetForLeftAxis) {
+ throw new DataModelException(
+ "YANG file error: The path predicate is not referring to an existing leaf/leaflist");
+ }
+ int parentNodes = relativePath.getAncestorNodeCount();
+
+ // Finds the root node for the right relative path.
+ YangNode rootParentNode = getRootNodeWithAncestorCount(parentNodes, potentialAncestorWithReferredNode);
+
+ // Finds the leaf/leaf-list from the right side relative path.
+ resolveRightAxisNodeInPathPredicate(relativePath, rootParentNode, pathPredicate);
+ }
+ }
+
+ /**
+ * Resolves the right axis node in the path predicate.
+ *
+ * @param relativePath the relative path in the path predicate
+ * @param rootParentNode parent node from where the node has to be found
+ * @param pathPredicate data tree reference in YANG list
+ * @throws DataModelException a violation of data model rules
+ */
+ private void resolveRightAxisNodeInPathPredicate(YangRelativePath relativePath, YangNode rootParentNode,
+ YangPathPredicate pathPredicate) throws DataModelException {
+
+ List<YangAtomicPath> absolutePathList = relativePath.getAtomicPathList();
+ if (absolutePathList != null && !absolutePathList.isEmpty()) {
+ Iterator<YangAtomicPath> listOfYangAtomicPathForRightRelative = absolutePathList.listIterator();
+ while (listOfYangAtomicPathForRightRelative.hasNext()) {
+ boolean isRightAxisNodeFound = false;
+ YangAtomicPath absolutePathInPredicate = listOfYangAtomicPathForRightRelative.next();
+ String nodeNameInAtomicPath = absolutePathInPredicate.getNodeIdentifier().getName();
+
+ // When child is not there check the leaf/leaf-list.
+ if (rootParentNode.getChild() == null) {
+ isRightAxisNodeFound = isReferredLeafOrLeafListFound(rootParentNode,
+ nodeNameInAtomicPath, (T) pathPredicate);
+ if (!isRightAxisNodeFound) {
+ throw new DataModelException(
+ "YANG file error: The path predicates is not referring to an existing leaf/leaflist");
+ }
+ break;
+ }
+ rootParentNode = rootParentNode.getChild();
+ YangNode nodeFoundInTheRelativePath = isReferredNodeInSiblingProcessedForLeafref(
+ rootParentNode, nodeNameInAtomicPath);
+
+ if (nodeFoundInTheRelativePath == null) {
+
+ // When node is not found check the leaf/leaf-list.
+ isRightAxisNodeFound = isReferredLeafOrLeafListFound(rootParentNode.getParent(),
+ nodeNameInAtomicPath, (T) pathPredicate);
+ } else {
+ rootParentNode = nodeFoundInTheRelativePath;
+ }
+ if (!isRightAxisNodeFound && nodeFoundInTheRelativePath == null) {
+ throw new DataModelException(
+ "YANG file error: The path predicates is not referring to an existing leaf/leaflist");
+ }
+ }
+ }
+ }
+
+ /**
+ * Returns the status, if referred leaf/leaf-list is found.
+ *
+ * @param ancestorWithTheReferredNode the parent node of leaf/leaf-list
+ * @param nodeName the name of the leaf/leaf-list
+ * @param statusOrPathPredicate the status to be set for the leaf-ref or the path predicate
+ * @return status of the target node is found
+ * @throws DataModelException a violation of data model rules
+ */
+ private boolean isReferredLeafOrLeafListFound(YangNode ancestorWithTheReferredNode, String nodeName,
+ T statusOrPathPredicate) throws DataModelException {
+
+ if (!(ancestorWithTheReferredNode instanceof YangLeavesHolder)) {
+ throw new DataModelException("Yang file error: The target node of leafref is invalid.");
+ }
+ YangLeavesHolder leavesHolder = (YangLeavesHolder) ancestorWithTheReferredNode;
+ if (leavesHolder.getListOfLeaf() != null) {
+ Iterator<YangLeaf> yangLeavesList = leavesHolder.getListOfLeaf().listIterator();
+ while (yangLeavesList.hasNext()) {
+ YangLeaf yangleaf = yangLeavesList.next();
+ if (yangleaf.getName().contentEquals(nodeName)) {
+ if (statusOrPathPredicate instanceof ResolvableStatus) {
+ ResolvableStatus status = (ResolvableStatus) statusOrPathPredicate;
+
+ // Sets the referred leaf to YANG leafref.
+ ((YangLeafRef) getCurrentEntityToResolveFromStack()).setReferredLeafOrLeafList(yangleaf);
+
+ // Adds reference link of entity to the node under resolution.
+ addReferredEntityLink(ancestorWithTheReferredNode, status);
+ addUnResolvedLeafRefTypeToStack((T) yangleaf, ancestorWithTheReferredNode);
+ return true;
+ } else if (statusOrPathPredicate instanceof YangPathPredicate) {
+ YangPathPredicate pathPredicate = (YangPathPredicate) statusOrPathPredicate;
+
+ // Sets the right axis node.
+ pathPredicate.setRightAxisNode(yangleaf);
+ return true;
+ } else {
+ throw new DataModelException("YANG file error: The target node of leafref is invalid.");
+ }
+ }
+ }
+ }
+ if (leavesHolder.getListOfLeafList() != null) {
+ Iterator<YangLeafList> yangLeafListList = leavesHolder.getListOfLeafList().listIterator();
+ while (yangLeafListList.hasNext()) {
+ YangLeafList yangLeaflist = yangLeafListList.next();
+ if (yangLeaflist.getName().contentEquals(nodeName)) {
+ if (statusOrPathPredicate instanceof ResolvableStatus) {
+ ResolvableStatus status = (ResolvableStatus) statusOrPathPredicate;
+
+ // Sets the referred leaf-list to YANG leafref.
+ ((YangLeafRef) getCurrentEntityToResolveFromStack()).setReferredLeafOrLeafList(yangLeaflist);
+
+ // Adds reference link of entity to the node under resolution.
+ addReferredEntityLink(ancestorWithTheReferredNode, status);
+ addUnResolvedLeafRefTypeToStack((T) yangLeaflist, ancestorWithTheReferredNode);
+ return true;
+ } else if (statusOrPathPredicate instanceof YangPathPredicate) {
+ YangPathPredicate pathPredicate = (YangPathPredicate) statusOrPathPredicate;
+ pathPredicate.setRightAxisNode(yangLeaflist);
+ return true;
+ } else {
+ throw new DataModelException("YANG file error: The target node of leafref is invalid.");
+ }
+ }
+ }
+ }
+ return false;
+ }
+
+ /**
+ * Adds the unresolved constructs to stack which has to be resolved for leafref.
+ *
+ * @param yangleafOrLeafList YANG leaf or leaf list which holds the type
+ * @param ancestorWithTheReferredNode holder of the YANG leaf or leaf list
+ */
+ private void addUnResolvedLeafRefTypeToStack(T yangleafOrLeafList, YangNode ancestorWithTheReferredNode) {
+
+ YangType referredTypeInLeafOrLeafList;
+ if (yangleafOrLeafList instanceof YangLeaf) {
+ YangLeaf leaf = (YangLeaf) yangleafOrLeafList;
+ referredTypeInLeafOrLeafList = leaf.getDataType();
+ if (referredTypeInLeafOrLeafList.getDataType() == YangDataTypes.LEAFREF) {
+ YangEntityToResolveInfoImpl<YangLeafRef<?>> unResolvedEntityInfo = new YangEntityToResolveInfoImpl<>();
+ unResolvedEntityInfo.setEntityToResolve((YangLeafRef<?>) leaf.getDataType().getDataTypeExtendedInfo());
+ unResolvedEntityInfo.setHolderOfEntityToResolve(ancestorWithTheReferredNode);
+ addInPartialResolvedStack((YangEntityToResolveInfoImpl<T>) unResolvedEntityInfo);
+ } else if (referredTypeInLeafOrLeafList.getDataType() == YangDataTypes.DERIVED) {
+ YangEntityToResolveInfoImpl<YangType<?>> unResolvedEntityInfo = new YangEntityToResolveInfoImpl<>();
+ unResolvedEntityInfo.setEntityToResolve(referredTypeInLeafOrLeafList);
+ unResolvedEntityInfo.setHolderOfEntityToResolve(ancestorWithTheReferredNode);
+ addInPartialResolvedStack((YangEntityToResolveInfoImpl<T>) unResolvedEntityInfo);
+ }
+ } else {
+ YangLeafList leafList = (YangLeafList) yangleafOrLeafList;
+ referredTypeInLeafOrLeafList = leafList.getDataType();
+ if (referredTypeInLeafOrLeafList.getDataType() == YangDataTypes.LEAFREF) {
+ YangEntityToResolveInfoImpl<YangLeafRef<?>> unResolvedEntityInfo = new YangEntityToResolveInfoImpl<>();
+ unResolvedEntityInfo
+ .setEntityToResolve((YangLeafRef<?>) leafList.getDataType().getDataTypeExtendedInfo());
+ unResolvedEntityInfo.setHolderOfEntityToResolve(ancestorWithTheReferredNode);
+ addInPartialResolvedStack((YangEntityToResolveInfoImpl<T>) unResolvedEntityInfo);
+ } else if (referredTypeInLeafOrLeafList.getDataType() == YangDataTypes.DERIVED) {
+ YangEntityToResolveInfoImpl<YangType<?>> unResolvedEntityInfo = new YangEntityToResolveInfoImpl<>();
+ unResolvedEntityInfo.setEntityToResolve(referredTypeInLeafOrLeafList);
+ unResolvedEntityInfo.setHolderOfEntityToResolve(ancestorWithTheReferredNode);
+ addInPartialResolvedStack((YangEntityToResolveInfoImpl<T>) unResolvedEntityInfo);
+ }
+ }
+ }
+
+ /**
+ * Returns true if referred leaf/leaf-list is found in a particular node. This is for path in path predicate.
+ *
+ * @param listForLeaf list node where referred leaf is found
+ * @param pathPredicate path predicate instance where the value of nodes to be found are available
+ * @param leftNode node identifier of the left side parameter in path predicate
+ * @return status of the leaf/leaf-list found
+ */
+ private boolean getLeftLeafOrLeafListInPredicate(YangList listForLeaf, YangPathPredicate pathPredicate,
+ YangNodeIdentifier leftNode) {
+
+ if (listForLeaf.getListOfLeaf() != null) {
+ Iterator<YangLeaf> yangLeavesUnderList = listForLeaf.getListOfLeaf().listIterator();
+ while (yangLeavesUnderList.hasNext()) {
+ YangLeaf yangleafUnderList = yangLeavesUnderList.next();
+ if (yangleafUnderList.getName().contentEquals(leftNode.getName())) {
+ pathPredicate.setLeftAxisNode(yangleafUnderList);
+ return true;
+ }
+ }
+ }
+ if (listForLeaf.getListOfLeafList() != null) {
+ Iterator<YangLeafList> yangLeavesListUnderList = listForLeaf.getListOfLeafList().listIterator();
+ while (yangLeavesListUnderList.hasNext()) {
+ YangLeafList yangleafListUnderList = yangLeavesListUnderList.next();
+ if (yangleafListUnderList.getName().contentEquals(leftNode.getName())) {
+ pathPredicate.setLeftAxisNode(yangleafListUnderList);
+ return true;
+ }
+ }
+ }
+ return false;
+ }
/**
* Returns feature holder(module/sub-module node) .
@@ -362,12 +820,70 @@
}
/**
+ * Checks for the referred parent node for the leafref path.
+ *
+ * @param potentialReferredNode potential referred node
+ * @return the reffered parent node of leaf/leaf-list
+ * @throws DataModelException data model errors
+ */
+ private YangNode isReferredNodeInSiblingProcessedForLeafref(YangNode potentialReferredNode, String referredNodeName)
+ throws DataModelException {
+
+ while (potentialReferredNode != null) {
+ if (potentialReferredNode instanceof YangInput) {
+ if (referredNodeName.equalsIgnoreCase(INPUT)) {
+ return potentialReferredNode;
+ }
+ } else if (potentialReferredNode instanceof YangOutput) {
+ if (referredNodeName.equalsIgnoreCase(OUTPUT)) {
+ return potentialReferredNode;
+ }
+ }
+ // Check if the potential referred node is the actual referred node
+ if (isReferredNodeForLeafref(potentialReferredNode, referredNodeName)) {
+ if (potentialReferredNode instanceof YangGrouping || potentialReferredNode instanceof YangTypeDef) {
+ if (potentialReferredNode.getParent() instanceof YangRpc) {
+ potentialReferredNode = potentialReferredNode.getNextSibling();
+ } else {
+ throw new DataModelException("YANG file error: The target node of leafref is invalid.");
+ }
+ }
+ return potentialReferredNode;
+ }
+ potentialReferredNode = potentialReferredNode.getNextSibling();
+ }
+ return null;
+ }
+
+ /**
+ * Checks if the current reference node name and the name in the path are equal.
+ *
+ * @param currentReferredNode the node where the reference is pointed
+ * @param nameOfNodeinPath name of the node in the path
+ * @return status of the match between the name
+ * @throws DataModelException a violation of data model rules
+ */
+ private boolean isReferredNodeForLeafref(YangNode currentReferredNode, String nameOfNodeinPath)
+ throws DataModelException {
+
+ if (getCurrentEntityToResolveFromStack() instanceof YangLeafRef) {
+ /*
+ * Check if name of node name matches with the current reference
+ * node.
+ */
+ return currentReferredNode.getName().contentEquals(nameOfNodeinPath);
+ } else {
+ throw new DataModelException("Data Model Exception: Entity to resolved is other than leafref");
+ }
+ }
+
+ /**
* Checks for the referred node defined in a ancestor scope.
*
* @param potentialReferredNode potential referred node
* @return status of resolution and updating the partial resolved stack with
* the any recursive references
- * @throws DataModelException data model errors
+ * @throws DataModelException a violation of data model rules
*/
private boolean isReferredNodeInSiblingListProcessed(YangNode potentialReferredNode)
throws DataModelException {
@@ -502,6 +1018,8 @@
.setRefGroup((YangGrouping) referredNode);
} else if (getCurrentEntityToResolveFromStack() instanceof YangIfFeature) {
// do nothing , referred node is already set
+ } else if (getCurrentEntityToResolveFromStack() instanceof YangLeafRef) {
+ // do nothing , referred node is already set
} else {
throw new DataModelException("Data Model Exception: Entity to resolved is other than type/uses");
}
@@ -541,7 +1059,8 @@
addUnResolvedUsesToStack(referredNode);
} else if (getCurrentEntityToResolveFromStack() instanceof YangIfFeature) {
addUnResolvedIfFeatureToStack(referredNode);
- } else {
+ } else if (getCurrentEntityToResolveFromStack() instanceof YangLeafRef) {
+ // do nothing , referred node is already set
throw new DataModelException("Data Model Exception: Entity to resolved is other than type/uses");
}
}
@@ -706,6 +1225,9 @@
// Inter file linking and resolution.
linkInterFileAndResolve();
+
+ // Resolve the derived types having leafref.
+ addDerivedRefTypeToRefTypeResolutionList();
}
/**
@@ -723,6 +1245,8 @@
refPrefix = ((YangUses) getCurrentEntityToResolveFromStack()).getPrefix();
} else if (getCurrentEntityToResolveFromStack() instanceof YangIfFeature) {
refPrefix = ((YangIfFeature) getCurrentEntityToResolveFromStack()).getPrefix();
+ } else if (getCurrentEntityToResolveFromStack() instanceof YangLeafRef) {
+ refPrefix = refPrefixForLeafRef();
} else {
throw new DataModelException("Data Model Exception: Entity to resolved is other than type/uses");
}
@@ -730,6 +1254,27 @@
}
/**
+ * Returns the referenced prefix for leafref under resolution.
+ *
+ * @return referenced prefix of leafref under resolution
+ */
+ private String refPrefixForLeafRef() {
+
+ String refPrefix;
+ if (((YangLeafRef) getCurrentEntityToResolveFromStack()).getPathType() == YangPathArgType.ABSOLUTE_PATH) {
+ List<YangAtomicPath> theList = ((YangLeafRef) getCurrentEntityToResolveFromStack()).getAtomicPath();
+ YangAtomicPath absPath = theList.iterator().next();
+ refPrefix = absPath.getNodeIdentifier().getPrefix();
+ } else {
+ YangRelativePath relativePath = ((YangLeafRef) getCurrentEntityToResolveFromStack()).getRelativePath();
+ List<YangAtomicPath> theList = relativePath.getAtomicPathList();
+ YangAtomicPath absPath = theList.iterator().next();
+ refPrefix = absPath.getNodeIdentifier().getPrefix();
+ }
+ return refPrefix;
+ }
+
+ /**
* Performs inter file linking and resolution.
*
* @throws DataModelException a violation in data model rule
@@ -838,9 +1383,19 @@
((YangIfFeature) getCurrentEntityToResolveFromStack()).setResolvableStatus(UNDEFINED);
return;
}
- // Exception when referred typedef/grouping is not found.
- DataModelException dataModelException = new DataModelException("YANG file error: Referred " +
- "typedef/grouping for a given type/uses can't be found.");
+ // If current entity is still not resolved, then
+ // linking/resolution has failed.
+ String errorInfo;
+ if (getCurrentEntityToResolveFromStack() instanceof YangType) {
+ errorInfo = TYPEDEF_LINKER_ERROR;
+ } else if (getCurrentEntityToResolveFromStack() instanceof YangUses) {
+ errorInfo = GROUPING_LINKER_ERROR;
+ } else if (getCurrentEntityToResolveFromStack() instanceof YangIfFeature) {
+ errorInfo = FEATURE_LINKER_ERROR;
+ } else {
+ errorInfo = LEAFREF_LINKER_ERROR;
+ }
+ DataModelException dataModelException = new DataModelException(errorInfo);
dataModelException.setLine(getLineNumber());
dataModelException.setCharPosition(getCharPosition());
throw dataModelException;
@@ -849,8 +1404,19 @@
* If referred node is already linked, then just change the status
* and push to the stack.
*/
- ((Resolvable) getCurrentEntityToResolveFromStack()).setResolvableStatus(INTER_FILE_LINKED);
- addUnresolvedRecursiveReferenceToStack((YangNode) referredNode);
+ if (getCurrentEntityToResolveFromStack() instanceof YangLeafRef) {
+ ((Resolvable) getCurrentEntityToResolveFromStack()).setResolvableStatus(INTER_FILE_LINKED);
+ if (referredNode instanceof YangLeaf) {
+ YangLeaf yangleaf = (YangLeaf) referredNode;
+ addUnResolvedLeafRefTypeToStack((T) yangleaf, (YangNode) yangleaf.getContainedIn());
+ } else if (referredNode instanceof YangLeafList) {
+ YangLeafList yangLeafList = (YangLeafList) referredNode;
+ addUnResolvedLeafRefTypeToStack((T) yangLeafList, (YangNode) yangLeafList.getContainedIn());
+ }
+ } else {
+ ((Resolvable) getCurrentEntityToResolveFromStack()).setResolvableStatus(INTER_FILE_LINKED);
+ addUnresolvedRecursiveReferenceToStack((YangNode) referredNode);
+ }
}
}
@@ -874,6 +1440,15 @@
linkedNode = findRefGrouping(yangInclude.getIncludedNode());
} else if (getCurrentEntityToResolveFromStack() instanceof YangIfFeature) {
linkedNode = findRefFeature(yangInclude.getIncludedNode());
+ } else if (getCurrentEntityToResolveFromStack() instanceof YangLeafRef) {
+ boolean referredNode = findRefLeaf(yangInclude.getIncludedNode());
+ /*
+ * Update the current reference resolver to external
+ * module/sub-module containing the referred typedef/grouping.
+ */
+ setCurReferenceResolver((YangReferenceResolver) yangInclude.getIncludedNode());
+
+ return referredNode;
}
if (linkedNode != null) {
// Add the link to external entity.
@@ -917,6 +1492,16 @@
linkedNode = findRefGrouping(yangImport.getImportedNode());
} else if (getCurrentEntityToResolveFromStack() instanceof YangIfFeature) {
linkedNode = findRefFeature(yangImport.getImportedNode());
+ } else if (getCurrentEntityToResolveFromStack() instanceof YangLeafRef) {
+ boolean referredNode = findRefLeaf(yangImport.getImportedNode());
+ /*
+ * Update the current reference resolver to external
+ * module/sub-module containing the referred
+ * typedef/grouping.
+ */
+ setCurReferenceResolver((YangReferenceResolver) yangImport.getImportedNode());
+
+ return referredNode;
}
if (linkedNode != null) {
// Add the link to external entity.
@@ -944,6 +1529,44 @@
}
/**
+ * Returns the status of referred leaf.
+ *
+ * @param importedNode the root node from a YANG file
+ * @return status of the referred leaf
+ * @throws DataModelException
+ */
+ private boolean findRefLeaf(YangNode importedNode) throws DataModelException {
+
+ boolean isReferredNodeFound = false;
+ List<YangAtomicPath> absolutePathList = ((YangLeafRef) getCurrentEntityToResolveFromStack())
+ .getAtomicPath();
+ if (absolutePathList != null && !absolutePathList.isEmpty()) {
+ Iterator<YangAtomicPath> listOfYangAtomicPath = absolutePathList.listIterator();
+
+ while (listOfYangAtomicPath.hasNext()) {
+ YangAtomicPath absolutePath = listOfYangAtomicPath.next();
+ String nodeName = absolutePath.getNodeIdentifier().getName();
+
+ if (importedNode.getChild() == null) {
+ isReferredNodeFound = isReferredLeafOrLeafListFound(importedNode, nodeName, (T) INTER_FILE_LINKED);
+ break;
+ }
+ importedNode = importedNode.getChild();
+
+ YangNode nodeFound = isReferredNodeInSiblingProcessedForLeafref(importedNode, nodeName);
+ if (nodeFound == null) {
+ isReferredNodeFound = isReferredLeafOrLeafListFound(importedNode.getParent(), nodeName,
+ (T) INTER_FILE_LINKED);
+ } else {
+ importedNode = nodeFound;
+ }
+ }
+ }
+ // TODO: Path predicates filling for inter file has to be done.
+ return isReferredNodeFound;
+ }
+
+ /**
* Returns referred typedef/grouping node.
*
* @return referred typedef/grouping node
@@ -959,6 +1582,8 @@
return (T) ((YangUses) getCurrentEntityToResolveFromStack()).getRefGroup();
} else if (getCurrentEntityToResolveFromStack() instanceof YangIfFeature) {
return (T) ((YangIfFeature) getCurrentEntityToResolveFromStack()).getReferredFeatureHolder();
+ } else if (getCurrentEntityToResolveFromStack() instanceof YangLeafRef) {
+ return (T) ((YangLeafRef) getCurrentEntityToResolveFromStack()).getReferredLeafOrLeafList();
} else {
throw new DataModelException("Data Model Exception: Entity to resolved is other than type/uses");
}
diff --git a/utils/yangutils/plugin/src/main/java/org/onosproject/yangutils/parser/antlrgencode/GeneratedYangListener.java b/utils/yangutils/plugin/src/main/java/org/onosproject/yangutils/parser/antlrgencode/GeneratedYangListener.java
index 31bbba5..9f5e0cc 100644
--- a/utils/yangutils/plugin/src/main/java/org/onosproject/yangutils/parser/antlrgencode/GeneratedYangListener.java
+++ b/utils/yangutils/plugin/src/main/java/org/onosproject/yangutils/parser/antlrgencode/GeneratedYangListener.java
@@ -16,7 +16,6 @@
// Generated from GeneratedYang.g4 by ANTLR 4.5
-
package org.onosproject.yangutils.parser.antlrgencode;
import org.antlr.v4.runtime.tree.ParseTreeListener;
@@ -1950,4 +1949,18 @@
*/
void exitAnnotationIdentifier(GeneratedYangParser.AnnotationIdentifierContext
currentContext);
+
+ /**
+ * Enters a parse tree produced by GeneratedYangParser for grammar rule require instance.
+ *
+ * @param currentContext current context in the parsed tree
+ */
+ void enterRequireInstance(GeneratedYangParser.RequireInstanceContext currentContext);
+
+ /**
+ * Exits a parse tree produced by GeneratedYangParser for grammar require instance.
+ *
+ * @param currentContext current context in the parsed tree
+ */
+ void exitRequireInstance(GeneratedYangParser.RequireInstanceContext currentContext);
}
diff --git a/utils/yangutils/plugin/src/main/java/org/onosproject/yangutils/parser/impl/TreeWalkListener.java b/utils/yangutils/plugin/src/main/java/org/onosproject/yangutils/parser/impl/TreeWalkListener.java
index 67c2e36..443c071 100644
--- a/utils/yangutils/plugin/src/main/java/org/onosproject/yangutils/parser/impl/TreeWalkListener.java
+++ b/utils/yangutils/plugin/src/main/java/org/onosproject/yangutils/parser/impl/TreeWalkListener.java
@@ -49,6 +49,7 @@
import org.onosproject.yangutils.parser.impl.listeners.KeyListener;
import org.onosproject.yangutils.parser.impl.listeners.LeafListListener;
import org.onosproject.yangutils.parser.impl.listeners.LeafListener;
+import org.onosproject.yangutils.parser.impl.listeners.LeafrefListener;
import org.onosproject.yangutils.parser.impl.listeners.LengthRestrictionListener;
import org.onosproject.yangutils.parser.impl.listeners.ListListener;
import org.onosproject.yangutils.parser.impl.listeners.MandatoryListener;
@@ -56,16 +57,18 @@
import org.onosproject.yangutils.parser.impl.listeners.MinElementsListener;
import org.onosproject.yangutils.parser.impl.listeners.ModuleListener;
import org.onosproject.yangutils.parser.impl.listeners.MustListener;
-import org.onosproject.yangutils.parser.impl.listeners.NotificationListener;
import org.onosproject.yangutils.parser.impl.listeners.NamespaceListener;
+import org.onosproject.yangutils.parser.impl.listeners.NotificationListener;
import org.onosproject.yangutils.parser.impl.listeners.OrganizationListener;
import org.onosproject.yangutils.parser.impl.listeners.OutputListener;
+import org.onosproject.yangutils.parser.impl.listeners.PathListener;
import org.onosproject.yangutils.parser.impl.listeners.PatternRestrictionListener;
import org.onosproject.yangutils.parser.impl.listeners.PositionListener;
import org.onosproject.yangutils.parser.impl.listeners.PrefixListener;
import org.onosproject.yangutils.parser.impl.listeners.PresenceListener;
import org.onosproject.yangutils.parser.impl.listeners.RangeRestrictionListener;
import org.onosproject.yangutils.parser.impl.listeners.ReferenceListener;
+import org.onosproject.yangutils.parser.impl.listeners.RequireInstanceListener;
import org.onosproject.yangutils.parser.impl.listeners.RevisionDateListener;
import org.onosproject.yangutils.parser.impl.listeners.RevisionListener;
import org.onosproject.yangutils.parser.impl.listeners.RpcListener;
@@ -81,9 +84,9 @@
import org.onosproject.yangutils.parser.impl.listeners.VersionListener;
import org.onosproject.yangutils.parser.impl.listeners.WhenListener;
-import static org.onosproject.yangutils.utils.UtilConstants.UNSUPPORTED_YANG_CONSTRUCT;
-import static org.onosproject.yangutils.utils.UtilConstants.CURRENTLY_UNSUPPORTED;
import static org.onosproject.yangutils.parser.impl.parserutils.ListenerUtil.handleUnsupportedYangConstruct;
+import static org.onosproject.yangutils.utils.UtilConstants.CURRENTLY_UNSUPPORTED;
+import static org.onosproject.yangutils.utils.UtilConstants.UNSUPPORTED_YANG_CONSTRUCT;
/**
* Represents ANTLR generates parse-tree. ANTLR generates a parse-tree listener interface that responds to events
@@ -667,17 +670,17 @@
@Override
public void enterLeafrefSpecification(GeneratedYangParser.LeafrefSpecificationContext ctx) {
- // do nothing.
+ LeafrefListener.processLeafrefEntry(this, ctx);
}
@Override
public void exitLeafrefSpecification(GeneratedYangParser.LeafrefSpecificationContext ctx) {
- // do nothing.
+ LeafrefListener.processLeafrefExit(this, ctx);
}
@Override
public void enterPathStatement(GeneratedYangParser.PathStatementContext ctx) {
- handleUnsupportedYangConstruct(YangConstructType.PATH_DATA, ctx, CURRENTLY_UNSUPPORTED);
+ PathListener.processPathEntry(this, ctx);
}
@Override
@@ -687,7 +690,7 @@
@Override
public void enterRequireInstanceStatement(GeneratedYangParser.RequireInstanceStatementContext ctx) {
- handleUnsupportedYangConstruct(YangConstructType.REQUIRE_INSTANCE_DATA, ctx, UNSUPPORTED_YANG_CONSTRUCT);
+ RequireInstanceListener.processRequireInstanceEntry(this, ctx);
}
@Override
@@ -1489,6 +1492,16 @@
}
@Override
+ public void enterRequireInstance(GeneratedYangParser.RequireInstanceContext ctx) {
+ // do nothing.
+ }
+
+ @Override
+ public void exitRequireInstance(GeneratedYangParser.RequireInstanceContext ctx) {
+ // do nothing.
+ }
+
+ @Override
public void enterFraction(GeneratedYangParser.FractionContext ctx) {
// TODO: implement the method.
}
diff --git a/utils/yangutils/plugin/src/main/java/org/onosproject/yangutils/parser/impl/listeners/LeafrefListener.java b/utils/yangutils/plugin/src/main/java/org/onosproject/yangutils/parser/impl/listeners/LeafrefListener.java
new file mode 100644
index 0000000..6ada8c5
--- /dev/null
+++ b/utils/yangutils/plugin/src/main/java/org/onosproject/yangutils/parser/impl/listeners/LeafrefListener.java
@@ -0,0 +1,212 @@
+/*
+ * Copyright 2016-present Open Networking Laboratory
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.onosproject.yangutils.parser.impl.listeners;
+
+import org.onosproject.yangutils.datamodel.YangLeaf;
+import org.onosproject.yangutils.datamodel.YangLeafList;
+import org.onosproject.yangutils.datamodel.YangLeafRef;
+import org.onosproject.yangutils.datamodel.YangNode;
+import org.onosproject.yangutils.datamodel.YangType;
+import org.onosproject.yangutils.datamodel.exceptions.DataModelException;
+import org.onosproject.yangutils.datamodel.utils.Parsable;
+import org.onosproject.yangutils.linker.impl.YangResolutionInfoImpl;
+import org.onosproject.yangutils.parser.antlrgencode.GeneratedYangParser;
+import org.onosproject.yangutils.parser.exceptions.ParserException;
+import org.onosproject.yangutils.parser.impl.TreeWalkListener;
+
+import static org.onosproject.yangutils.datamodel.utils.DataModelUtils.addResolutionInfo;
+import static org.onosproject.yangutils.datamodel.utils.ResolvableStatus.UNRESOLVED;
+import static org.onosproject.yangutils.datamodel.utils.YangConstructType.LEAFREF_DATA;
+import static org.onosproject.yangutils.parser.impl.parserutils.ListenerErrorLocation.ENTRY;
+import static org.onosproject.yangutils.parser.impl.parserutils.ListenerErrorLocation.EXIT;
+import static org.onosproject.yangutils.parser.impl.parserutils.ListenerErrorMessageConstruction.constructExtendedListenerErrorMessage;
+import static org.onosproject.yangutils.parser.impl.parserutils.ListenerErrorMessageConstruction.constructListenerErrorMessage;
+import static org.onosproject.yangutils.parser.impl.parserutils.ListenerErrorType.INVALID_HOLDER;
+import static org.onosproject.yangutils.parser.impl.parserutils.ListenerErrorType.MISSING_CURRENT_HOLDER;
+import static org.onosproject.yangutils.parser.impl.parserutils.ListenerErrorType.MISSING_HOLDER;
+import static org.onosproject.yangutils.parser.impl.parserutils.ListenerErrorType.UNHANDLED_PARSED_DATA;
+import static org.onosproject.yangutils.parser.impl.parserutils.ListenerValidation.checkStackIsNotEmpty;
+
+/*
+ * Reference: RFC6020 and YANG ANTLR Grammar
+ *
+ * ABNF grammar as per RFC6020
+ * type-body-stmts = numerical-restrictions /
+ * decimal64-specification /
+ * string-restrictions /
+ * enum-specification /
+ * leafref-specification /
+ * identityref-specification /
+ * instance-identifier-specification /
+ * bits-specification /
+ * union-specification
+ *
+ * leafref-specification =
+ * ;; these stmts can appear in any order
+ * path-stmt stmtsep
+ * [require-instance-stmt stmtsep]
+ *
+ * ANTLR grammar rule
+ *
+ * typeBodyStatements : numericalRestrictions | stringRestrictions | enumSpecification
+ * | leafrefSpecification | identityrefSpecification | instanceIdentifierSpecification
+ * | bitsSpecification | unionSpecification;
+ *
+ * leafrefSpecification : (pathStatement (requireInstanceStatement)?) | ((requireInstanceStatement)? pathStatement);
+ */
+
+/**
+ * Represents listener based call back function corresponding to the
+ * "leafref" rule defined in ANTLR grammar file for corresponding ABNF rule
+ * in RFC 6020.
+ */
+public final class LeafrefListener {
+
+ /**
+ * Creates a new leafref listener.
+ */
+ private LeafrefListener() {
+ }
+
+ /**
+ * It is called when parser receives an input matching the grammar rule
+ * (leafref), perform validations and updates the data model tree.
+ *
+ * @param listener listener's object
+ * @param ctx context object of the grammar rule
+ */
+ public static void processLeafrefEntry(TreeWalkListener listener,
+ GeneratedYangParser.LeafrefSpecificationContext ctx) {
+
+ // Check for stack to be non empty.
+ checkStackIsNotEmpty(listener, MISSING_HOLDER, LEAFREF_DATA, "", ENTRY);
+
+ int errorLine = ctx.getStart().getLine();
+ int errorPosition = ctx.getStart().getCharPositionInLine();
+
+ YangLeafRef<?> leafRef = new YangLeafRef<>();
+
+ Parsable typeData = listener.getParsedDataStack().pop();
+
+ if (!(typeData instanceof YangType)) {
+ throw new ParserException(constructListenerErrorMessage(INVALID_HOLDER, LEAFREF_DATA,
+ "", ENTRY));
+ }
+
+ YangType type = (YangType) typeData;
+ type.setDataTypeExtendedInfo(leafRef);
+
+ // Setting by default the value of require-instance as true.
+ leafRef.setRequireInstance(true);
+ Parsable tmpData = listener.getParsedDataStack().peek();
+
+ switch (tmpData.getYangConstructType()) {
+
+ case LEAF_DATA:
+
+ // Parent YANG node of leaf to be added in resolution information.
+ YangLeaf leaf = (YangLeaf) listener.getParsedDataStack().pop();
+ Parsable parentNodeOfLeaf = listener.getParsedDataStack().peek();
+ listener.getParsedDataStack().push(leaf);
+
+ // Verify parent node of leaf.
+ if (!(parentNodeOfLeaf instanceof YangNode)) {
+ throw new ParserException(constructListenerErrorMessage(INVALID_HOLDER, LEAFREF_DATA,
+ "", ENTRY));
+ }
+
+ leafRef.setResolvableStatus(UNRESOLVED);
+
+ // Add resolution information to the list.
+ YangResolutionInfoImpl resolutionInfo = new YangResolutionInfoImpl<YangLeafRef>(leafRef,
+ (YangNode) parentNodeOfLeaf, errorLine, errorPosition);
+ addToResolutionList(resolutionInfo);
+ break;
+
+ case LEAF_LIST_DATA:
+
+ // Parent YANG node of leaf-list to be added in resolution information.
+ YangLeafList leafList = (YangLeafList) listener.getParsedDataStack().pop();
+ Parsable parentNodeOfLeafList = listener.getParsedDataStack().peek();
+ listener.getParsedDataStack().push(leafList);
+
+ // Verify parent node of leaf-list.
+ if (!(parentNodeOfLeafList instanceof YangNode)) {
+ throw new ParserException(constructListenerErrorMessage(INVALID_HOLDER, LEAFREF_DATA,
+ "", ENTRY));
+ }
+
+ leafRef.setResolvableStatus(UNRESOLVED);
+
+ // Add resolution information to the list.
+ YangResolutionInfoImpl resolutionInfoImpl = new YangResolutionInfoImpl<YangLeafRef>(leafRef,
+ (YangNode) parentNodeOfLeafList, errorLine, errorPosition);
+ addToResolutionList(resolutionInfoImpl);
+ break;
+
+ case TYPEDEF_DATA:
+ /*
+ * Do not add the leaf ref to resolution list. It needs to be
+ * added to resolution list, when leaf/leaf list references to
+ * this typedef. At this time that leaf/leaf-list becomes the
+ * parent for the leafref.
+ */
+ break;
+
+ default:
+ throw new ParserException(constructListenerErrorMessage(INVALID_HOLDER, LEAFREF_DATA,
+ "", ENTRY));
+ }
+ listener.getParsedDataStack().push(typeData);
+ listener.getParsedDataStack().push(leafRef);
+ }
+
+ /**
+ * It is called when parser exits from grammar rule (leafref), it performs
+ * validation and updates the data model tree.
+ *
+ * @param listener listener's object
+ * @param ctx context object of the grammar rule
+ */
+ public static void processLeafrefExit(TreeWalkListener listener,
+ GeneratedYangParser.LeafrefSpecificationContext ctx) {
+
+ // Check for stack to be non empty.
+ checkStackIsNotEmpty(listener, MISSING_CURRENT_HOLDER, LEAFREF_DATA, "", EXIT);
+
+ Parsable parsableType = listener.getParsedDataStack().pop();
+ if (!(parsableType instanceof YangLeafRef)) {
+ throw new ParserException(constructListenerErrorMessage(INVALID_HOLDER, LEAFREF_DATA,
+ "", EXIT));
+ }
+ }
+
+ /**
+ * Adds to resolution list.
+ *
+ * @param resolutionInfo resolution information
+ */
+ private static void addToResolutionList(YangResolutionInfoImpl resolutionInfo) {
+
+ try {
+ addResolutionInfo(resolutionInfo);
+ } catch (DataModelException e) {
+ throw new ParserException(constructExtendedListenerErrorMessage(UNHANDLED_PARSED_DATA,
+ LEAFREF_DATA, "", ENTRY, e.getMessage()));
+ }
+ }
+}
diff --git a/utils/yangutils/plugin/src/main/java/org/onosproject/yangutils/parser/impl/listeners/ModuleListener.java b/utils/yangutils/plugin/src/main/java/org/onosproject/yangutils/parser/impl/listeners/ModuleListener.java
index 05cfdb3..ebf9d97 100644
--- a/utils/yangutils/plugin/src/main/java/org/onosproject/yangutils/parser/impl/listeners/ModuleListener.java
+++ b/utils/yangutils/plugin/src/main/java/org/onosproject/yangutils/parser/impl/listeners/ModuleListener.java
@@ -128,6 +128,8 @@
.peek()).resolveSelfFileLinking(ResolvableType.YANG_USES);
((YangReferenceResolver) listener.getParsedDataStack()
.peek()).resolveSelfFileLinking(ResolvableType.YANG_DERIVED_DATA_TYPE);
+ ((YangReferenceResolver) listener.getParsedDataStack()
+ .peek()).resolveSelfFileLinking(ResolvableType.YANG_LEAFREF);
} catch (DataModelException e) {
LinkerException linkerException = new LinkerException(e.getMessage());
linkerException.setLine(e.getLineNumber());
diff --git a/utils/yangutils/plugin/src/main/java/org/onosproject/yangutils/parser/impl/listeners/PathListener.java b/utils/yangutils/plugin/src/main/java/org/onosproject/yangutils/parser/impl/listeners/PathListener.java
new file mode 100644
index 0000000..b02c6f4
--- /dev/null
+++ b/utils/yangutils/plugin/src/main/java/org/onosproject/yangutils/parser/impl/listeners/PathListener.java
@@ -0,0 +1,89 @@
+/*
+ * Copyright 2016-present Open Networking Laboratory
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.onosproject.yangutils.parser.impl.listeners;
+
+import org.onosproject.yangutils.datamodel.YangLeafRef;
+import org.onosproject.yangutils.datamodel.utils.Parsable;
+import org.onosproject.yangutils.parser.antlrgencode.GeneratedYangParser;
+import org.onosproject.yangutils.parser.exceptions.ParserException;
+import org.onosproject.yangutils.parser.impl.TreeWalkListener;
+
+import static org.onosproject.yangutils.parser.impl.parserutils.ListenerErrorMessageConstruction.constructListenerErrorMessage;
+import static org.onosproject.yangutils.parser.impl.parserutils.ListenerUtil.validatePathArgument;
+import static org.onosproject.yangutils.parser.impl.parserutils.ListenerValidation.checkStackIsNotEmpty;
+import static org.onosproject.yangutils.datamodel.utils.YangConstructType.PATH_DATA;
+import static org.onosproject.yangutils.parser.impl.parserutils.ListenerErrorType.MISSING_HOLDER;
+import static org.onosproject.yangutils.parser.impl.parserutils.ListenerErrorLocation.ENTRY;
+import static org.onosproject.yangutils.parser.impl.parserutils.ListenerErrorType.INVALID_HOLDER;
+
+/*
+ * Reference: RFC6020 and YANG ANTLR Grammar
+ *
+ * ABNF grammar as per RFC6020
+ * leafref-specification =
+ * ;; these stmts can appear in any order
+ * path-stmt stmtsep
+ * [require-instance-stmt stmtsep]
+ *
+ * path-stmt = path-keyword sep path-arg-str stmtend
+ *
+ * ANTLR grammar rule
+ *
+ * leafrefSpecification : (pathStatement (requireInstanceStatement)?) | ((requireInstanceStatement)? pathStatement);
+ *
+ * pathStatement : PATH_KEYWORD path STMTEND;
+ */
+
+/**
+ * Represents listener based call back function corresponding to the
+ * "path" rule defined in ANTLR grammar file for corresponding ABNF rule
+ * in RFC 6020.
+ */
+public final class PathListener {
+
+ /**
+ * Creates a new path listener.
+ */
+ private PathListener() {
+ }
+
+ /**
+ * It is called when parser receives an input matching the grammar rule
+ * (path), performs validation and updates the data model tree.
+ *
+ * @param listener listener's object
+ * @param ctx context object of the grammar rule
+ */
+ public static void processPathEntry(TreeWalkListener listener,
+ GeneratedYangParser.PathStatementContext ctx) {
+
+ // Check for stack to be non empty.
+ checkStackIsNotEmpty(listener, MISSING_HOLDER, PATH_DATA, ctx.path().getText(), ENTRY);
+
+ Parsable curData = listener.getParsedDataStack().peek();
+
+ // Checks the holder of path as leafref, else throws error.
+ if (curData instanceof YangLeafRef) {
+
+ // Splitting the path argument and updating it in the datamodel tree.
+ validatePathArgument(ctx.path().getText(), PATH_DATA, ctx, (YangLeafRef) curData);
+ } else {
+ throw new ParserException(constructListenerErrorMessage(INVALID_HOLDER, PATH_DATA,
+ ctx.path().getText(), ENTRY));
+ }
+ }
+}
diff --git a/utils/yangutils/plugin/src/main/java/org/onosproject/yangutils/parser/impl/listeners/RequireInstanceListener.java b/utils/yangutils/plugin/src/main/java/org/onosproject/yangutils/parser/impl/listeners/RequireInstanceListener.java
new file mode 100644
index 0000000..21c7533
--- /dev/null
+++ b/utils/yangutils/plugin/src/main/java/org/onosproject/yangutils/parser/impl/listeners/RequireInstanceListener.java
@@ -0,0 +1,106 @@
+/*
+ * Copyright 2016-present Open Networking Laboratory
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.onosproject.yangutils.parser.impl.listeners;
+
+import org.onosproject.yangutils.datamodel.YangLeafRef;
+import org.onosproject.yangutils.datamodel.YangType;
+import org.onosproject.yangutils.datamodel.utils.Parsable;
+import org.onosproject.yangutils.datamodel.utils.builtindatatype.YangDataTypes;
+import org.onosproject.yangutils.parser.antlrgencode.GeneratedYangParser;
+import org.onosproject.yangutils.parser.exceptions.ParserException;
+import org.onosproject.yangutils.parser.impl.TreeWalkListener;
+
+import static org.onosproject.yangutils.datamodel.utils.YangConstructType.REQUIRE_INSTANCE_DATA;
+import static org.onosproject.yangutils.parser.impl.parserutils.ListenerErrorMessageConstruction.constructListenerErrorMessage;
+import static org.onosproject.yangutils.parser.impl.parserutils.ListenerUtil.getValidBooleanValue;
+import static org.onosproject.yangutils.parser.impl.parserutils.ListenerValidation.checkStackIsNotEmpty;
+import static org.onosproject.yangutils.parser.impl.parserutils.ListenerErrorType.MISSING_HOLDER;
+import static org.onosproject.yangutils.parser.impl.parserutils.ListenerErrorLocation.ENTRY;
+import static org.onosproject.yangutils.parser.impl.parserutils.ListenerErrorType.INVALID_HOLDER;
+
+/*
+ * Reference: RFC6020 and YANG ANTLR Grammar
+ *
+ * ABNF grammar as per RFC6020
+ * require-instance-stmt = require-instance-keyword sep
+ * require-instance-arg-str stmtend
+ *
+ * require-instance-arg-str = < a string that matches the rule
+ * require-instance-arg >
+ *
+ * require-instance-arg = true-keyword / false-keyword
+ *
+ * ANTLR grammar rule
+ *
+ * requireInstanceStatement : REQUIRE_INSTANCE_KEYWORD requireInstance STMTEND;
+ *
+ * requireInstance : string;
+ */
+
+/**
+ * Represents listener based call back function corresponding to the
+ * "require-instance" rule defined in ANTLR grammar file for corresponding ABNF rule
+ * in RFC 6020.
+ */
+public final class RequireInstanceListener {
+
+ /**
+ * Creates a new require instance listener.
+ */
+ private RequireInstanceListener() {
+ }
+
+ /**
+ * It is called when parser receives an input matching the grammar rule
+ * (require-instance), performs validation and updates the data model tree.
+ *
+ * @param listener listener's object
+ * @param ctx context object of the grammar rule
+ */
+ public static void processRequireInstanceEntry(TreeWalkListener listener,
+ GeneratedYangParser.RequireInstanceStatementContext ctx) {
+
+ // Check for stack to be non empty.
+ checkStackIsNotEmpty(listener, MISSING_HOLDER, REQUIRE_INSTANCE_DATA, "", ENTRY);
+
+ Parsable curData = listener.getParsedDataStack().peek();
+
+ // Gets the status of require instance
+ boolean isRequireInstance = getValidBooleanValue(ctx.requireInstance().getText(), REQUIRE_INSTANCE_DATA, ctx);
+
+ // Checks the holder of require-instance as leafref or type, else throws error.
+ if (curData instanceof YangLeafRef) {
+
+ // Sets the require-instance status to leafref.
+ ((YangLeafRef) curData).setRequireInstance(isRequireInstance);
+ } else if (curData instanceof YangType) {
+
+ // Checks type should be instance-identifier, else throw error.
+ if (((YangType) curData).getDataType() == YangDataTypes.INSTANCE_IDENTIFIER) {
+
+ // Sets the require-instance status to instance-identifier type.
+ ((YangType) curData).setDataTypeExtendedInfo(isRequireInstance);
+ } else {
+ throw new ParserException(constructListenerErrorMessage(INVALID_HOLDER, REQUIRE_INSTANCE_DATA,
+ ctx.getText(), ENTRY));
+ }
+ } else {
+ throw new ParserException(constructListenerErrorMessage(INVALID_HOLDER, REQUIRE_INSTANCE_DATA,
+ ctx.getText(), ENTRY));
+ }
+ }
+}
diff --git a/utils/yangutils/plugin/src/main/java/org/onosproject/yangutils/parser/impl/listeners/SubModuleListener.java b/utils/yangutils/plugin/src/main/java/org/onosproject/yangutils/parser/impl/listeners/SubModuleListener.java
index b2223b8..2132324 100644
--- a/utils/yangutils/plugin/src/main/java/org/onosproject/yangutils/parser/impl/listeners/SubModuleListener.java
+++ b/utils/yangutils/plugin/src/main/java/org/onosproject/yangutils/parser/impl/listeners/SubModuleListener.java
@@ -133,6 +133,8 @@
.resolveSelfFileLinking(ResolvableType.YANG_USES);
((YangReferenceResolver) listener.getParsedDataStack().peek())
.resolveSelfFileLinking(ResolvableType.YANG_DERIVED_DATA_TYPE);
+ ((YangReferenceResolver) listener.getParsedDataStack().peek())
+ .resolveSelfFileLinking(ResolvableType.YANG_LEAFREF);
} catch (DataModelException e) {
LinkerException linkerException = new LinkerException(e.getMessage());
linkerException.setLine(e.getLineNumber());
diff --git a/utils/yangutils/plugin/src/main/java/org/onosproject/yangutils/parser/impl/listeners/TypeListener.java b/utils/yangutils/plugin/src/main/java/org/onosproject/yangutils/parser/impl/listeners/TypeListener.java
index 4043a8e..32955d5 100644
--- a/utils/yangutils/plugin/src/main/java/org/onosproject/yangutils/parser/impl/listeners/TypeListener.java
+++ b/utils/yangutils/plugin/src/main/java/org/onosproject/yangutils/parser/impl/listeners/TypeListener.java
@@ -101,6 +101,9 @@
type.setNodeIdentifier(nodeIdentifier);
type.setDataType(yangDataTypes);
+ // Set default require instance value as true for instance identifier.
+ setDefaultRequireInstanceForInstanceIdentifier(type);
+
int errorLine = ctx.getStart().getLine();
int errorPosition = ctx.getStart().getCharPositionInLine();
@@ -233,6 +236,18 @@
}
/**
+ * Sets the default require instance value as true when the type is instance identifier.
+ *
+ * @param type type to which the value has to be set
+ */
+ private static void setDefaultRequireInstanceForInstanceIdentifier(YangType<?> type) {
+
+ if (type.getDataType() == YangDataTypes.INSTANCE_IDENTIFIER) {
+ ((YangType<Boolean>) type).setDataTypeExtendedInfo(true);
+ }
+ }
+
+ /**
* It is called when parser exits from grammar rule (type), it perform
* validations and update the data model tree.
*
@@ -291,7 +306,11 @@
parserException = new ParserException("YANG file error : a type bits" +
" must have atleast one bit statement.");
break;
- // TODO : decimal64, identity ref, leafref
+ case LEAFREF:
+ parserException = new ParserException("YANG file error : a type leafref" +
+ " must have one path statement.");
+ break;
+ // TODO : decimal64, identity ref
default:
return;
}
diff --git a/utils/yangutils/plugin/src/main/java/org/onosproject/yangutils/parser/impl/parserutils/ListenerUtil.java b/utils/yangutils/plugin/src/main/java/org/onosproject/yangutils/parser/impl/parserutils/ListenerUtil.java
index e2097fc..2aaa563 100644
--- a/utils/yangutils/plugin/src/main/java/org/onosproject/yangutils/parser/impl/parserutils/ListenerUtil.java
+++ b/utils/yangutils/plugin/src/main/java/org/onosproject/yangutils/parser/impl/parserutils/ListenerUtil.java
@@ -18,28 +18,44 @@
import java.text.ParseException;
import java.text.SimpleDateFormat;
+import java.util.ArrayList;
import java.util.Date;
+import java.util.Iterator;
import java.util.LinkedList;
import java.util.List;
import java.util.regex.Pattern;
import org.antlr.v4.runtime.ParserRuleContext;
+import org.onosproject.yangutils.datamodel.YangAtomicPath;
+import org.onosproject.yangutils.datamodel.YangLeafRef;
import org.onosproject.yangutils.datamodel.YangNodeIdentifier;
+import org.onosproject.yangutils.datamodel.YangPathPredicate;
+import org.onosproject.yangutils.datamodel.YangRelativePath;
import org.onosproject.yangutils.datamodel.utils.YangConstructType;
import org.onosproject.yangutils.parser.antlrgencode.GeneratedYangParser;
import org.onosproject.yangutils.parser.exceptions.ParserException;
+import static org.onosproject.yangutils.datamodel.YangPathArgType.ABSOLUTE_PATH;
+import static org.onosproject.yangutils.datamodel.YangPathArgType.RELATIVE_PATH;
+import static org.onosproject.yangutils.datamodel.YangPathOperator.EQUALTO;
import static org.onosproject.yangutils.utils.UtilConstants.ADD;
+import static org.onosproject.yangutils.utils.UtilConstants.ANCESTOR_ACCESSOR;
+import static org.onosproject.yangutils.utils.UtilConstants.ANCESTOR_ACCESSOR_IN_PATH;
import static org.onosproject.yangutils.utils.UtilConstants.CARET;
+import static org.onosproject.yangutils.utils.UtilConstants.CHAR_OF_CLOSE_SQUARE_BRACKET;
+import static org.onosproject.yangutils.utils.UtilConstants.CHAR_OF_OPEN_SQUARE_BRACKET;
+import static org.onosproject.yangutils.utils.UtilConstants.CHAR_OF_SLASH;
+import static org.onosproject.yangutils.utils.UtilConstants.CLOSE_PARENTHESIS;
import static org.onosproject.yangutils.utils.UtilConstants.COLON;
+import static org.onosproject.yangutils.utils.UtilConstants.CURRENT;
import static org.onosproject.yangutils.utils.UtilConstants.CURRENTLY_UNSUPPORTED;
import static org.onosproject.yangutils.utils.UtilConstants.EMPTY_STRING;
import static org.onosproject.yangutils.utils.UtilConstants.FALSE;
import static org.onosproject.yangutils.utils.UtilConstants.IDENTITYREF;
-import static org.onosproject.yangutils.utils.UtilConstants.INSTANCE_IDENTIFIER;
-import static org.onosproject.yangutils.utils.UtilConstants.LEAFREF;
+import static org.onosproject.yangutils.utils.UtilConstants.OPEN_SQUARE_BRACKET;
import static org.onosproject.yangutils.utils.UtilConstants.QUOTES;
import static org.onosproject.yangutils.utils.UtilConstants.SLASH;
+import static org.onosproject.yangutils.utils.UtilConstants.SLASH_FOR_STRING;
import static org.onosproject.yangutils.utils.UtilConstants.TRUE;
import static org.onosproject.yangutils.utils.UtilConstants.YANG_FILE_ERROR;
@@ -52,6 +68,7 @@
private static final String DATE_PATTERN = "[0-9]{4}-([0-9]{2}|[0-9])-([0-9]{2}|[0-9])";
private static final String NON_NEGATIVE_INTEGER_PATTERN = "[0-9]+";
private static final Pattern INTEGER_PATTERN = Pattern.compile("[-][0-9]+|[0-9]+");
+ private static final Pattern PATH_PREDICATE_PATTERN = Pattern.compile("\\[(.*?)\\]");
private static final String XML = "xml";
private static final String ONE = "1";
private static final int IDENTIFIER_LENGTH = 64;
@@ -115,6 +132,42 @@
}
/**
+ * Validates identifier and returns concatenated string if string contains plus symbol.
+ *
+ * @param identifier string from yang file
+ * @param yangConstruct yang construct for creating error message
+ * @param ctx yang construct's context to get the line number and character position
+ * @param yangLeafRef instance of leafref where the path argument has to be set
+ * @return concatenated string after removing double quotes
+ */
+ public static String getValidIdentifierForLeafref(String identifier, YangConstructType yangConstruct,
+ ParserRuleContext ctx, YangLeafRef yangLeafRef) {
+
+ String identifierString = removeQuotesAndHandleConcat(identifier);
+ ParserException parserException;
+
+ if (identifierString.length() > IDENTIFIER_LENGTH) {
+ parserException = new ParserException("YANG file error : " + " identifier " + identifierString + " in " +
+ YangConstructType.getYangConstructType(yangConstruct) + " " + yangLeafRef.getPath() + " is " +
+ "greater than 64 characters.");
+ } else if (!IDENTIFIER_PATTERN.matcher(identifierString).matches()) {
+ parserException = new ParserException("YANG file error : " + " identifier " + identifierString + " in " +
+ YangConstructType.getYangConstructType(yangConstruct) + " " + yangLeafRef.getPath() + " is not " +
+ "valid.");
+ } else if (identifierString.toLowerCase().startsWith(XML)) {
+ parserException = new ParserException("YANG file error : " + " identifier " + identifierString + " in " +
+ YangConstructType.getYangConstructType(yangConstruct) + " " + yangLeafRef.getPath() +
+ " must not start with (('X'|'x') ('M'|'m') ('L'|'l')).");
+ } else {
+ return identifierString;
+ }
+
+ parserException.setLine(ctx.getStart().getLine());
+ parserException.setCharPosition(ctx.getStart().getCharPositionInLine());
+ throw parserException;
+ }
+
+ /**
* Validates the revision date.
*
* @param dateToValidate input revision date
@@ -307,6 +360,352 @@
}
/**
+ * Checks and return valid node identifier specific to nodes in leafref path.
+ *
+ * @param nodeIdentifierString string from yang file
+ * @param yangConstruct yang construct for creating error message
+ * @param ctx yang construct's context to get the line number and character position
+ * @param yangLeafRef instance of leafref where the path argument has to be set
+ * @return valid node identifier
+ */
+ public static YangNodeIdentifier getValidNodeIdentifierForLeafref(String nodeIdentifierString,
+ YangConstructType yangConstruct, ParserRuleContext ctx, YangLeafRef yangLeafRef) {
+
+ String tmpIdentifierString = removeQuotesAndHandleConcat(nodeIdentifierString);
+ String[] tmpData = tmpIdentifierString.split(Pattern.quote(COLON));
+ if (tmpData.length == 1) {
+ YangNodeIdentifier nodeIdentifier = new YangNodeIdentifier();
+ checkForUnsupportedTypes(tmpData[0], yangConstruct, ctx);
+ nodeIdentifier.setName(getValidIdentifierForLeafref(tmpData[0], yangConstruct, ctx, yangLeafRef));
+ return nodeIdentifier;
+ } else if (tmpData.length == 2) {
+ YangNodeIdentifier nodeIdentifier = new YangNodeIdentifier();
+ nodeIdentifier.setPrefix(getValidIdentifierForLeafref(tmpData[0], yangConstruct, ctx, yangLeafRef));
+ nodeIdentifier.setName(getValidIdentifierForLeafref(tmpData[1], yangConstruct, ctx, yangLeafRef));
+ return nodeIdentifier;
+ } else {
+ ParserException parserException = new ParserException("YANG file error : " +
+ YangConstructType.getYangConstructType(yangConstruct) + yangLeafRef.getPath() +
+ " is not valid.");
+ parserException.setLine(ctx.getStart().getLine());
+ parserException.setCharPosition(ctx.getStart().getCharPositionInLine());
+ throw parserException;
+ }
+ }
+
+ /**
+ * Validates the path argument. It can be either absolute or relative path.
+ *
+ * @param pathString the path string from the path type
+ * @param yangConstruct yang construct for creating error message
+ * @param ctx yang construct's context to get the line number and character position
+ * @param yangLeafRef instance of leafref where the path argument has to be set
+ */
+ public static void validatePathArgument(String pathString, YangConstructType yangConstruct,
+ ParserRuleContext ctx, YangLeafRef yangLeafRef) {
+
+ String completePathString = removeQuotesAndHandleConcat(pathString);
+ yangLeafRef.setPath(completePathString);
+ if (completePathString.startsWith(SLASH)) {
+ yangLeafRef.setPathType(ABSOLUTE_PATH);
+ List<YangAtomicPath> yangAtomicPathListList = validateAbsolutePath(completePathString, yangConstruct, ctx,
+ yangLeafRef);
+ yangLeafRef.setAtomicPath(yangAtomicPathListList);
+ } else if (completePathString.startsWith(ANCESTOR_ACCESSOR)) {
+ yangLeafRef.setPathType(RELATIVE_PATH);
+ validateRelativePath(completePathString, yangConstruct, ctx, yangLeafRef);
+ } else {
+ ParserException parserException = new ParserException("YANG file error : " +
+ YangConstructType.getYangConstructType(yangConstruct) + yangLeafRef.getPath() +
+ " does not follow valid path syntax");
+ parserException.setLine(ctx.getStart().getLine());
+ parserException.setCharPosition(ctx.getStart().getCharPositionInLine());
+ throw parserException;
+ }
+ }
+
+ /**
+ * Validates the relative path.
+ *
+ * @param completePathString the path string of relative path
+ * @param yangConstruct yang construct for creating error message
+ * @param ctx yang construct's context to get the line number and character position
+ * @param yangLeafRef instance of leafref where the path argument has to be set
+ */
+ private static void validateRelativePath(String completePathString, YangConstructType yangConstruct,
+ ParserRuleContext ctx, YangLeafRef yangLeafRef) {
+
+ YangRelativePath relativePath = new YangRelativePath();
+ int numberOfAncestors = 0;
+ while (completePathString.startsWith(ANCESTOR_ACCESSOR_IN_PATH)) {
+ completePathString = completePathString.replaceFirst(ANCESTOR_ACCESSOR_IN_PATH, EMPTY_STRING);
+ numberOfAncestors = numberOfAncestors + 1;
+ }
+ if (completePathString == null || completePathString.length() == 0) {
+ ParserException parserException = new ParserException("YANG file error : "
+ + YangConstructType.getYangConstructType(yangConstruct) + yangLeafRef.getPath() +
+ " does not follow valid path syntax");
+ parserException.setLine(ctx.getStart().getLine());
+ parserException.setCharPosition(ctx.getStart().getCharPositionInLine());
+ throw parserException;
+ }
+ relativePath.setAncestorNodeCount(numberOfAncestors);
+ List<YangAtomicPath> atomicPath = validateAbsolutePath(SLASH_FOR_STRING + completePathString,
+ yangConstruct,
+ ctx, yangLeafRef);
+ relativePath.setAtomicPathList(atomicPath);
+ yangLeafRef.setRelativePath(relativePath);
+ }
+
+ /**
+ * Validates the absolute path.
+ *
+ * @param completePathString the path string of absolute path
+ * @param yangConstruct yang construct for creating error message
+ * @param ctx yang construct's context to get the line number and character position
+ * @param yangLeafRef instance of leafref where the path argument has to be set
+ * @return list of object of node in absolute path
+ */
+ private static List<YangAtomicPath> validateAbsolutePath(String completePathString,
+ YangConstructType yangConstruct, ParserRuleContext ctx, YangLeafRef yangLeafRef) {
+
+ List<YangAtomicPath> absolutePathList = new LinkedList<>();
+ YangPathPredicate yangPathPredicate = new YangPathPredicate();
+ YangNodeIdentifier yangNodeIdentifier;
+
+ while (completePathString != null) {
+ String path = completePathString.replaceFirst(SLASH_FOR_STRING, EMPTY_STRING);
+ if (path == null || path.length() == 0) {
+ ParserException parserException = new ParserException("YANG file error : "
+ + YangConstructType.getYangConstructType(yangConstruct) + " " + yangLeafRef.getPath() +
+ " does not follow valid path syntax");
+ parserException.setLine(ctx.getStart().getLine());
+ parserException.setCharPosition(ctx.getStart().getCharPositionInLine());
+ throw parserException;
+ }
+ String matchedPathPredicate;
+ String nodeIdentifier;
+ String[] differentiate = new String[2];
+ int forNodeIdentifier = path.indexOf(CHAR_OF_SLASH);
+ int forPathPredicate = path.indexOf(CHAR_OF_OPEN_SQUARE_BRACKET);
+
+ // Checks if path predicate is present for the node.
+ if ((forPathPredicate < forNodeIdentifier) && (forPathPredicate != -1)) {
+ List<String> pathPredicate = new ArrayList<>();
+ matchedPathPredicate = matchForPathPredicate(path);
+
+ if (matchedPathPredicate == null || matchedPathPredicate.length() == 0) {
+ ParserException parserException = new ParserException("YANG file error : "
+ + YangConstructType.getYangConstructType(yangConstruct) + " " + yangLeafRef.getPath() +
+ " does not follow valid path syntax");
+ parserException.setLine(ctx.getStart().getLine());
+ parserException.setCharPosition(ctx.getStart().getCharPositionInLine());
+ throw parserException;
+ }
+ int indexOfMatchedFirstOpenBrace = path.indexOf(CHAR_OF_OPEN_SQUARE_BRACKET);
+ differentiate[0] = path.substring(0, indexOfMatchedFirstOpenBrace);
+ differentiate[1] = path.substring(indexOfMatchedFirstOpenBrace);
+ pathPredicate.add(matchedPathPredicate);
+ nodeIdentifier = differentiate[0];
+ // Starts adding all path predicates of a node into the list.
+ if (!differentiate[1].isEmpty()) {
+ while (differentiate[1].startsWith(OPEN_SQUARE_BRACKET)) {
+ matchedPathPredicate = matchForPathPredicate(differentiate[1]);
+ if (matchedPathPredicate == null || matchedPathPredicate.length() == 0) {
+ ParserException parserException = new ParserException(
+ "YANG file error : " + YangConstructType.getYangConstructType(yangConstruct) + " "
+ + yangLeafRef.getPath() +
+ " does not follow valid path syntax");
+ parserException.setLine(ctx.getStart().getLine());
+ parserException.setCharPosition(ctx.getStart().getCharPositionInLine());
+ throw parserException;
+ }
+ pathPredicate.add(matchedPathPredicate);
+ differentiate[1] = differentiate[1].substring(matchedPathPredicate.length());
+ }
+ }
+
+ List<YangPathPredicate> pathPredicateList = validatePathPredicate(pathPredicate, yangConstruct, ctx,
+ yangPathPredicate, yangLeafRef);
+ YangAtomicPath atomicPath = new YangAtomicPath();
+ yangNodeIdentifier = getValidNodeIdentifierForLeafref(nodeIdentifier, yangConstruct, ctx, yangLeafRef);
+ atomicPath.setNodeIdentifier(yangNodeIdentifier);
+ atomicPath.setPathPredicatesList(pathPredicateList);
+ absolutePathList.add(atomicPath);
+ } else {
+ if (path.contains(SLASH_FOR_STRING)) {
+ nodeIdentifier = path.substring(0, path.indexOf(CHAR_OF_SLASH));
+ differentiate[1] = path.substring(path.indexOf(CHAR_OF_SLASH));
+ } else {
+ nodeIdentifier = path;
+ differentiate[1] = null;
+ }
+ yangNodeIdentifier = getValidNodeIdentifierForLeafref(nodeIdentifier, yangConstruct, ctx, yangLeafRef);
+
+ YangAtomicPath atomicPath = new YangAtomicPath();
+ atomicPath.setNodeIdentifier(yangNodeIdentifier);
+ atomicPath.setPathPredicatesList(null);
+ absolutePathList.add(atomicPath);
+ }
+ if (differentiate[1] == null || differentiate[1].length() == 0) {
+ completePathString = null;
+ } else {
+ completePathString = differentiate[1];
+ }
+ }
+ return absolutePathList;
+ }
+
+ /**
+ * Validates path predicate in the absolute path's node.
+ *
+ * @param pathPredicate list of path predicates in the node of absolute path
+ * @param yangConstruct yang construct for creating error message
+ * @param ctx yang construct's context to get the line number and character position
+ * @param yangPathPredicate instance of path predicate where it has to be set
+ * @param yangLeafRef instance of leafref where the path argument has to be set
+ * @return list of object of path predicates in absolute path's node
+ */
+ private static List<YangPathPredicate> validatePathPredicate(List<String> pathPredicate,
+ YangConstructType yangConstruct, ParserRuleContext ctx, YangPathPredicate yangPathPredicate,
+ YangLeafRef yangLeafRef) {
+
+ Iterator<String> pathPredicateString = pathPredicate.iterator();
+ List<String> pathEqualityExpression = new ArrayList<>();
+
+ while (pathPredicateString.hasNext()) {
+ String pathPredicateForNode = pathPredicateString.next();
+ pathPredicateForNode = (pathPredicateForNode.substring(1)).trim();
+ pathPredicateForNode = pathPredicateForNode.substring(0,
+ pathPredicateForNode.indexOf(CHAR_OF_CLOSE_SQUARE_BRACKET));
+ pathEqualityExpression.add(pathPredicateForNode);
+ }
+ List<YangPathPredicate> validatedPathPredicateList = validatePathEqualityExpression(pathEqualityExpression,
+ yangConstruct, ctx, yangPathPredicate, yangLeafRef);
+ return validatedPathPredicateList;
+ }
+
+ /**
+ * Validates the path equality expression.
+ *
+ * @param pathEqualityExpression list of path equality expression in the path predicates of the node
+ * @param yangConstruct yang construct for creating error message
+ * @param ctx yang construct's context to get the line number and character position
+ * @param yangPathPredicate instance of path predicate where it has to be set
+ * @param yangLeafRef instance of leafref where the path argument has to be set
+ * @return list of object of path predicates in absolute path's node
+ */
+ private static List<YangPathPredicate> validatePathEqualityExpression(List<String> pathEqualityExpression,
+ YangConstructType yangConstruct, ParserRuleContext ctx, YangPathPredicate yangPathPredicate,
+ YangLeafRef yangLeafRef) {
+
+ Iterator<String> pathEqualityExpressionString = pathEqualityExpression.iterator();
+ List<YangPathPredicate> yangPathPredicateList = new ArrayList<>();
+
+ while (pathEqualityExpressionString.hasNext()) {
+ String pathEqualityExpressionForNode = pathEqualityExpressionString.next();
+ String[] pathEqualityExpressionArray = pathEqualityExpressionForNode.split("[=]");
+
+ YangNodeIdentifier yangNodeIdentifierForPredicate;
+ YangRelativePath yangRelativePath;
+ yangNodeIdentifierForPredicate = getValidNodeIdentifierForLeafref(pathEqualityExpressionArray[0].trim(),
+ yangConstruct, ctx, yangLeafRef);
+ yangRelativePath = validatePathKeyExpression(pathEqualityExpressionArray[1].trim(), yangConstruct, ctx,
+ yangLeafRef);
+ yangPathPredicate.setNodeIdentifier(yangNodeIdentifierForPredicate);
+ yangPathPredicate.setPathOperator(EQUALTO);
+ yangPathPredicate.setRightRelativePath(yangRelativePath);
+ yangPathPredicateList.add(yangPathPredicate);
+ }
+ return yangPathPredicateList;
+ }
+
+ /**
+ * Validate the path key expression.
+ *
+ * @param rightRelativePath relative path in the path predicate
+ * @param yangConstruct yang construct for creating error message
+ * @param ctx yang construct's context to get the line number and character position
+ * @param yangLeafRef instance of leafref where the path argument has to be set
+ * @return object of right relative path in path predicate
+ */
+ private static YangRelativePath validatePathKeyExpression(String rightRelativePath,
+ YangConstructType yangConstruct, ParserRuleContext ctx, YangLeafRef yangLeafRef) {
+
+ YangRelativePath yangRelativePath = new YangRelativePath();
+ String[] relativePath = rightRelativePath.split(SLASH_FOR_STRING);
+ List<String> rightAbsolutePath = new ArrayList<>();
+ int accessAncestor = 0;
+ for (String path : relativePath) {
+ if (path.trim().equals(ANCESTOR_ACCESSOR)) {
+ accessAncestor = accessAncestor + 1;
+ } else {
+ rightAbsolutePath.add(path);
+ }
+ }
+ List<YangAtomicPath> atomicPathInRelativePath = validateRelativePathKeyExpression(rightAbsolutePath,
+ yangConstruct, ctx, yangLeafRef);
+ yangRelativePath.setAtomicPathList(atomicPathInRelativePath);
+ yangRelativePath.setAncestorNodeCount(accessAncestor);
+ return yangRelativePath;
+ }
+
+ /**
+ * Validates the relative path key expression.
+ *
+ * @param rightAbsolutePath absolute path nodes present in the relative path
+ * @param yangConstruct yang construct for creating error message
+ * @param ctx yang construct's context to get the line number and character position
+ * @param yangLeafRef instance of leafref where the path argument has to be set
+ * @return list of object of absolute path nodes present in the relative path
+ */
+ private static List<YangAtomicPath> validateRelativePathKeyExpression(List<String> rightAbsolutePath,
+ YangConstructType yangConstruct, ParserRuleContext ctx, YangLeafRef yangLeafRef) {
+
+ List<YangAtomicPath> atomicPathList = new ArrayList<>();
+ YangNodeIdentifier yangNodeIdentifier;
+
+ Iterator<String> nodes = rightAbsolutePath.iterator();
+ String currentInvocationFunction = nodes.next();
+ currentInvocationFunction = currentInvocationFunction.trim();
+ String[] currentFunction = currentInvocationFunction.split("[(]");
+
+ if (!(currentFunction[0].trim().equals(CURRENT)) || !(currentFunction[1].trim().equals(CLOSE_PARENTHESIS))) {
+ ParserException parserException = new ParserException("YANG file error : "
+ + YangConstructType.getYangConstructType(yangConstruct) + " " + yangLeafRef.getPath() +
+ " does not follow valid path syntax");
+ parserException.setLine(ctx.getStart().getLine());
+ parserException.setCharPosition(ctx.getStart().getCharPositionInLine());
+ throw parserException;
+ }
+
+ while (nodes.hasNext()) {
+ YangAtomicPath atomicPath = new YangAtomicPath();
+ String node = nodes.next();
+ yangNodeIdentifier = getValidNodeIdentifierForLeafref(node.trim(), yangConstruct, ctx, yangLeafRef);
+ atomicPath.setNodeIdentifier(yangNodeIdentifier);
+ atomicPathList.add(atomicPath);
+ }
+ return atomicPathList;
+ }
+
+ /**
+ * Validates the match for first path predicate in a given string.
+ *
+ * @param matchRequiredString string for which match has to be done
+ * @return the matched string
+ */
+ private static String matchForPathPredicate(String matchRequiredString) {
+
+ String matchedString = null;
+ java.util.regex.Matcher matcher = PATH_PREDICATE_PATTERN.matcher(matchRequiredString);
+ if (matcher.find()) {
+ matchedString = matcher.group(0);
+ }
+ return matchedString;
+ }
+
+ /**
* Checks whether the type is an unsupported type.
*
* @param typeName name of the type
@@ -317,15 +716,9 @@
YangConstructType yangConstruct, ParserRuleContext ctx) {
if (yangConstruct == YangConstructType.TYPE_DATA) {
- if (typeName.equalsIgnoreCase(LEAFREF)) {
- handleUnsupportedYangConstruct(YangConstructType.LEAFREF_DATA,
- ctx, CURRENTLY_UNSUPPORTED);
- } else if (typeName.equalsIgnoreCase(IDENTITYREF)) {
+ if (typeName.equalsIgnoreCase(IDENTITYREF)) {
handleUnsupportedYangConstruct(YangConstructType.IDENTITYREF_DATA,
ctx, CURRENTLY_UNSUPPORTED);
- } else if (typeName.equalsIgnoreCase(INSTANCE_IDENTIFIER)) {
- handleUnsupportedYangConstruct(YangConstructType.INSTANCE_IDENTIFIER_DATA,
- ctx, CURRENTLY_UNSUPPORTED);
}
}
}
diff --git a/utils/yangutils/plugin/src/main/java/org/onosproject/yangutils/translator/tojava/JavaCodeGeneratorUtil.java b/utils/yangutils/plugin/src/main/java/org/onosproject/yangutils/translator/tojava/JavaCodeGeneratorUtil.java
index fec42ca..83a2999 100644
--- a/utils/yangutils/plugin/src/main/java/org/onosproject/yangutils/translator/tojava/JavaCodeGeneratorUtil.java
+++ b/utils/yangutils/plugin/src/main/java/org/onosproject/yangutils/translator/tojava/JavaCodeGeneratorUtil.java
@@ -19,6 +19,8 @@
import java.io.IOException;
import org.onosproject.yangutils.datamodel.YangNode;
+import org.onosproject.yangutils.datamodel.YangTypeDef;
+import org.onosproject.yangutils.datamodel.utils.builtindatatype.YangDataTypes;
import org.onosproject.yangutils.translator.exception.TranslatorException;
import org.onosproject.yangutils.utils.io.impl.YangPluginConfig;
@@ -80,7 +82,20 @@
if (!(codeGenNode instanceof JavaCodeGenerator)) {
throw new TranslatorException("Unsupported node to generate code");
}
-
+ if (codeGenNode instanceof YangTypeDef) {
+ YangTypeDef typeDef = (YangTypeDef) codeGenNode;
+ if (typeDef.getTypeDefBaseType().getDataType() == YangDataTypes.LEAFREF
+ || typeDef.getTypeDefBaseType().getDataType() == YangDataTypes.IDENTITYREF) {
+ if (codeGenNode.getNextSibling() != null) {
+ curTraversal = SIBILING;
+ codeGenNode = codeGenNode.getNextSibling();
+ } else {
+ curTraversal = PARENT;
+ codeGenNode = codeGenNode.getParent();
+ }
+ continue;
+ }
+ }
setCurNode(codeGenNode);
try {
generateCodeEntry(codeGenNode, yangPlugin);
diff --git a/utils/yangutils/plugin/src/main/java/org/onosproject/yangutils/translator/tojava/javamodel/AttributesJavaDataType.java b/utils/yangutils/plugin/src/main/java/org/onosproject/yangutils/translator/tojava/javamodel/AttributesJavaDataType.java
index 4d7c9fc..6df66af 100644
--- a/utils/yangutils/plugin/src/main/java/org/onosproject/yangutils/translator/tojava/javamodel/AttributesJavaDataType.java
+++ b/utils/yangutils/plugin/src/main/java/org/onosproject/yangutils/translator/tojava/javamodel/AttributesJavaDataType.java
@@ -17,13 +17,15 @@
package org.onosproject.yangutils.translator.tojava.javamodel;
import java.util.Stack;
-import org.onosproject.yangutils.datamodel.utils.builtindatatype.YangDataTypes;
+
import org.onosproject.yangutils.datamodel.YangDerivedInfo;
import org.onosproject.yangutils.datamodel.YangEnumeration;
+import org.onosproject.yangutils.datamodel.YangLeafRef;
import org.onosproject.yangutils.datamodel.YangNode;
import org.onosproject.yangutils.datamodel.YangType;
import org.onosproject.yangutils.datamodel.YangTypeDef;
import org.onosproject.yangutils.datamodel.YangUnion;
+import org.onosproject.yangutils.datamodel.utils.builtindatatype.YangDataTypes;
import org.onosproject.yangutils.translator.exception.TranslatorException;
import org.onosproject.yangutils.translator.tojava.JavaCodeGeneratorInfo;
import org.onosproject.yangutils.translator.tojava.JavaFileInfo;
@@ -101,6 +103,10 @@
return STRING_DATA_TYPE;
case BOOLEAN:
return BOOLEAN_DATA_TYPE;
+ case INSTANCE_IDENTIFIER:
+ return STRING_DATA_TYPE;
+ case LEAFREF:
+ return getJavaDataType(getReferredTypeFromLeafref(yangType));
default:
throw new TranslatorException("given data type is not supported.");
}
@@ -152,8 +158,8 @@
case BINARY:
return YANG_BINARY_CLASS;
case LEAFREF:
- //TODO:LEAFREF
- break;
+ YangType<?> referredType = getReferredTypeFromLeafref(yangType);
+ return getJavaImportClass(referredType, isListAttr, pluginConfig);
case IDENTITYREF:
//TODO:IDENTITYREF
break;
@@ -163,8 +169,7 @@
return getCapitalCase(getCamelCase(((YangJavaUnion) yangType.getDataTypeExtendedInfo()).getName(),
pluginConfig));
case INSTANCE_IDENTIFIER:
- //TODO:INSTANCE_IDENTIFIER
- break;
+ return STRING_DATA_TYPE;
case DERIVED:
return getCapitalCase(
getCamelCase(yangType.getDataTypeName(), pluginConfig));
@@ -188,8 +193,8 @@
case BINARY:
return YANG_BINARY_CLASS;
case LEAFREF:
- //TODO:LEAFREF
- break;
+ YangType<?> referredType = getReferredTypeFromLeafref(yangType);
+ return getJavaImportClass(referredType, isListAttr, pluginConfig);
case IDENTITYREF:
//TODO:IDENTITYREF
break;
@@ -199,8 +204,7 @@
return getCapitalCase(getCamelCase(((YangJavaUnion) yangType.getDataTypeExtendedInfo()).getName(),
pluginConfig));
case INSTANCE_IDENTIFIER:
- //TODO:INSTANCE_IDENTIFIER
- break;
+ return STRING_DATA_TYPE;
case DERIVED:
return getCapitalCase(
getCamelCase(yangType.getDataTypeName(), pluginConfig));
@@ -246,16 +250,15 @@
case BINARY:
return YANG_TYPES_PKG;
case LEAFREF:
- //TODO:LEAFREF
- break;
+ YangType<?> referredType = getReferredTypeFromLeafref(yangType);
+ return getJavaImportPackage(referredType, isListAttr, conflictResolver);
case IDENTITYREF:
//TODO:IDENTITYREF
break;
case UNION:
return getUnionPackage(yangType, conflictResolver);
case INSTANCE_IDENTIFIER:
- //TODO:INSTANCE_IDENTIFIER
- break;
+ return JAVA_LANG;
case DERIVED:
return getTypDefsPackage(yangType, conflictResolver);
default:
@@ -274,8 +277,8 @@
case BINARY:
return YANG_TYPES_PKG;
case LEAFREF:
- //TODO:LEAFREF
- break;
+ YangType<?> referredType = getReferredTypeFromLeafref(yangType);
+ return getJavaImportPackage(referredType, isListAttr, conflictResolver);
case IDENTITYREF:
//TODO:IDENTITYREF
break;
@@ -284,8 +287,7 @@
case UNION:
return getUnionPackage(yangType, conflictResolver);
case INSTANCE_IDENTIFIER:
- //TODO:INSTANCE_IDENTIFIER
- break;
+ return JAVA_LANG;
case DERIVED:
return getTypDefsPackage(yangType, conflictResolver);
default:
@@ -444,4 +446,15 @@
.getPackage()));
}
}
+
+ /**
+ * Returns the referred type from leaf/leaf-list.
+ *
+ * @param type current type in leaf
+ * @return type from the leafref
+ */
+ private static YangType<?> getReferredTypeFromLeafref(YangType type) {
+ YangLeafRef<?> leafRefInfo = (YangLeafRef<?>) type.getDataTypeExtendedInfo();
+ return leafRefInfo.getEffectiveDataType();
+ }
}
diff --git a/utils/yangutils/plugin/src/main/java/org/onosproject/yangutils/translator/tojava/utils/MethodsGenerator.java b/utils/yangutils/plugin/src/main/java/org/onosproject/yangutils/translator/tojava/utils/MethodsGenerator.java
index 85aa784..2f8c8d1 100644
--- a/utils/yangutils/plugin/src/main/java/org/onosproject/yangutils/translator/tojava/utils/MethodsGenerator.java
+++ b/utils/yangutils/plugin/src/main/java/org/onosproject/yangutils/translator/tojava/utils/MethodsGenerator.java
@@ -18,8 +18,9 @@
import java.util.List;
import java.util.Map;
-import org.onosproject.yangutils.datamodel.utils.builtindatatype.YangDataTypes;
+
import org.onosproject.yangutils.datamodel.YangType;
+import org.onosproject.yangutils.datamodel.utils.builtindatatype.YangDataTypes;
import org.onosproject.yangutils.translator.exception.TranslatorException;
import org.onosproject.yangutils.translator.tojava.JavaAttributeInfo;
import org.onosproject.yangutils.utils.io.impl.JavaDocGen;
@@ -118,6 +119,7 @@
import static org.onosproject.yangutils.utils.UtilConstants.VALUE;
import static org.onosproject.yangutils.utils.UtilConstants.VOID;
import static org.onosproject.yangutils.utils.UtilConstants.YANG_UTILS_TODO;
+import static org.onosproject.yangutils.utils.io.impl.JavaDocGen.getJavaDoc;
import static org.onosproject.yangutils.utils.io.impl.JavaDocGen.JavaDocType.BUILD_METHOD;
import static org.onosproject.yangutils.utils.io.impl.JavaDocGen.JavaDocType.CONSTRUCTOR;
import static org.onosproject.yangutils.utils.io.impl.JavaDocGen.JavaDocType.DEFAULT_CONSTRUCTOR;
@@ -127,7 +129,6 @@
import static org.onosproject.yangutils.utils.io.impl.JavaDocGen.JavaDocType.OF_METHOD;
import static org.onosproject.yangutils.utils.io.impl.JavaDocGen.JavaDocType.SETTER_METHOD;
import static org.onosproject.yangutils.utils.io.impl.JavaDocGen.JavaDocType.TYPE_CONSTRUCTOR;
-import static org.onosproject.yangutils.utils.io.impl.JavaDocGen.getJavaDoc;
import static org.onosproject.yangutils.utils.io.impl.YangIoUtils.getCamelCase;
import static org.onosproject.yangutils.utils.io.impl.YangIoUtils.getCapitalCase;
import static org.onosproject.yangutils.utils.io.impl.YangIoUtils.getSmallCase;
diff --git a/utils/yangutils/plugin/src/main/java/org/onosproject/yangutils/utils/UtilConstants.java b/utils/yangutils/plugin/src/main/java/org/onosproject/yangutils/utils/UtilConstants.java
index f4999b6..032493c 100644
--- a/utils/yangutils/plugin/src/main/java/org/onosproject/yangutils/utils/UtilConstants.java
+++ b/utils/yangutils/plugin/src/main/java/org/onosproject/yangutils/utils/UtilConstants.java
@@ -282,6 +282,16 @@
public static final String INPUT = "input";
/**
+ * Static attribute for output string.
+ */
+ public static final String OUTPUT = "output";
+
+ /**
+ * Static attribute for current string.
+ */
+ public static final String CURRENT = "current";
+
+ /**
* Static attribute for leafref string.
*/
public static final String LEAFREF = "leafref";
@@ -342,6 +352,41 @@
public static final String COMMA = ",";
/**
+ * Static attribute for slash character.
+ */
+ public static final char CHAR_OF_SLASH = '/';
+
+ /**
+ * Static attribute for open square bracket character.
+ */
+ public static final char CHAR_OF_OPEN_SQUARE_BRACKET = '[';
+
+ /**
+ * Static attribute for close square bracket character.
+ */
+ public static final char CHAR_OF_CLOSE_SQUARE_BRACKET = ']';
+
+ /**
+ * Static attribute for slash string.
+ */
+ public static final String SLASH_FOR_STRING = "/";
+
+ /**
+ * Static attribute for open square bracket.
+ */
+ public static final String OPEN_SQUARE_BRACKET = "[";
+
+ /**
+ * Static attribute for ancestor accessor.
+ */
+ public static final String ANCESTOR_ACCESSOR = "..";
+
+ /**
+ * Static attribute for ancestor accessor along with path.
+ */
+ public static final String ANCESTOR_ACCESSOR_IN_PATH = "../";
+
+ /**
* Static attribute for add syntax.
*/
public static final String ADD_STRING = "add";
@@ -1110,7 +1155,6 @@
*/
public static final String YANG_DECIMAL64_CLASS = "YangDecimal64";
-
/**
* Static attribute for YANG file error.
*/
@@ -1140,12 +1184,18 @@
+ "grouping for given uses";
/**
- * Static attribute for grouping linker error information.
+ * Static attribute for if-feature linker error information.
*/
public static final String FEATURE_LINKER_ERROR = "YANG file error: Unable to find feature "
+ "for given if-feature";
/**
+ * Static attribute for leafref linker error information.
+ */
+ public static final String LEAFREF_LINKER_ERROR = "YANG file error: Unable to find base "
+ + "leaf/leaf-list for given leafref";
+
+ /**
* Static attribute for reference.
*/
public static final String REFERENCE = "Reference";