gerrit.o-ran-sc Code Review - smo/teiv.git/blob

   1 /*
   2  *  ============LICENSE_START=======================================================
   3  *  Copyright (C) 2024 Ericsson
   4  *  Modifications Copyright (C) 2024 OpenInfra Foundation Europe
   5  *  ================================================================================
   6  *  Licensed under the Apache License, Version 2.0 (the "License");
   7  *  you may not use this file except in compliance with the License.
   8  *  You may obtain a copy of the License at
   9  *
  10  *        http://www.apache.org/licenses/LICENSE-2.0
  11  *
  12  *  Unless required by applicable law or agreed to in writing, software
  13  *  distributed under the License is distributed on an "AS IS" BASIS,
  14  *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  15  *  See the License for the specific language governing permissions and
  16  *  limitations under the License.
  17  *
  18  *  SPDX-License-Identifier: Apache-2.0
  19  *  ============LICENSE_END=========================================================
  20  */
  21 package org.oran.smo.yangtools.parser.model.statements.yang;
  22
  23 import java.util.List;
  24
  25 import org.oran.smo.yangtools.parser.ParserExecutionContext;
  26 import org.oran.smo.yangtools.parser.findings.Finding;
  27 import org.oran.smo.yangtools.parser.findings.ParserFindingType;
  28 import org.oran.smo.yangtools.parser.model.statements.AbstractStatement;
  29 import org.oran.smo.yangtools.parser.model.statements.StatementModuleAndName;
  30 import org.oran.smo.yangtools.parser.model.util.GrammarHelper;
  31 import org.oran.smo.yangtools.parser.model.yangdom.YangDomElement;
  32
  33 /**
  34  * Type-safe Yang core statement.
  35  *
  36  * @author Mark Hollmann
  37  */
  38 public class YEnum extends AbstractStatement {
  39
  40     public YEnum(final AbstractStatement parentStatement, final YangDomElement domNode) {
  41         super(parentStatement, domNode);
  42     }
  43
  44     @Override
  45     public String getStatementIdentifier() {
  46         return getEnumName();
  47     }
  48
  49     @Override
  50     public StatementArgumentType getArgumentType() {
  51         return StatementArgumentType.NAME;
  52     }
  53
  54     @Override
  55     public StatementModuleAndName getStatementModuleAndName() {
  56         return CY.STMT_ENUM;
  57     }
  58
  59     public String getEnumName() {
  60         return domElement.getValue();
  61     }
  62
  63     public List<YIfFeature> getIfFeatures() {
  64         return getChildren(CY.STMT_IF_FEATURE);
  65     }
  66
  67     public YStatus getStatus() {
  68         return getChild(CY.STMT_STATUS);
  69     }
  70
  71     public YValue getValue() {
  72         return getChild(CY.STMT_VALUE);
  73     }
  74
  75     protected void validate(final ParserExecutionContext context) {
  76         if (!validateArgumentNotNullNotEmpty(context)) {
  77             /* no point trying to perform more validation */
  78             return;
  79         }
  80
  81         /*
  82          * Note that the RFC states that an enum can be "any string". Not sure how much this makes
  83          * sense, as this would allow spaces...we check for that as this would cause problems
  84          * somewhere, no doubt.
  85          */
  86         if (GrammarHelper.containsYangWhitespace(getEnumName())) {
  87             context.addFinding(new Finding(this, ParserFindingType.P141_WHITESPACE_IN_ENUM,
  88                     "Usage of whitespace character(s) in enum '" + getEnumName() + "'."));
  89         } else if (containsWeirdCharacters(getEnumName())) {
  90             context.addFinding(new Finding(this, ParserFindingType.P142_UNUSUAL_CHARACTERS_IN_ENUM,
  91                     "enum '" + getEnumName() + "' contains unusual characters."));
  92         }
  93     }
  94
  95     private static boolean containsWeirdCharacters(final String enumName) {
  96
  97         if (enumName == null) {
  98             return false;
  99         }
 100
 101         for (final char c : enumName.toCharArray()) {
 102             if (c == '_' || c == '.' || c == '-' || (c >= 48 && c <= 57) || (c >= 65 && c <= 90) || (c >= 97 && c <= 122)) {
 103                 // all ok
 104             } else {
 105                 return true;
 106             }
 107         }
 108
 109         return false;
 110     }
 111
 112     @Override
 113     protected void subtreeProcessed(final ParserExecutionContext context) {
 114         if (getValue() == null) {
 115             context.addFinding(new Finding(this, ParserFindingType.P143_ENUM_WITHOUT_VALUE,
 116                     "enum '" + getEnumName() + "' does not have a value (bad practice)."));
 117         }
 118     }
 119 }