binding/mdsal-binding-generator/src/main/java/org/opendaylight/mdsal/binding/yang/types/CodegenTypeProvider.java

   1 /*
   2  * Copyright (c) 2018 Pantheon Technologies, s.r.o.  All rights reserved.
   3  *
   4  * This program and the accompanying materials are made available under the
   5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
   6  * and is available at http://www.eclipse.org/legal/epl-v10.html
   7  */
   8 package org.opendaylight.mdsal.binding.yang.types;
   9
  10 import static org.opendaylight.mdsal.binding.generator.BindingGeneratorUtil.encodeAngleBrackets;
  11
  12 import com.google.common.annotations.VisibleForTesting;
  13 import com.google.common.collect.ImmutableMap;
  14 import com.google.common.collect.Maps;
  15 import java.util.List;
  16 import java.util.Map;
  17 import java.util.Optional;
  18 import org.opendaylight.mdsal.binding.model.api.JavaTypeName;
  19 import org.opendaylight.mdsal.binding.model.api.type.builder.EnumBuilder;
  20 import org.opendaylight.mdsal.binding.model.api.type.builder.GeneratedTOBuilder;
  21 import org.opendaylight.mdsal.binding.model.api.type.builder.GeneratedTypeBuilderBase;
  22 import org.opendaylight.mdsal.binding.model.ri.generated.type.builder.AbstractEnumerationBuilder;
  23 import org.opendaylight.mdsal.binding.model.ri.generated.type.builder.CodegenEnumerationBuilder;
  24 import org.opendaylight.mdsal.binding.model.ri.generated.type.builder.CodegenGeneratedTOBuilder;
  25 import org.opendaylight.yangtools.yang.binding.RegexPatterns;
  26 import org.opendaylight.yangtools.yang.model.api.EffectiveModelContext;
  27 import org.opendaylight.yangtools.yang.model.api.TypeDefinition;
  28 import org.opendaylight.yangtools.yang.model.api.type.EnumTypeDefinition;
  29 import org.opendaylight.yangtools.yang.model.api.type.ModifierKind;
  30 import org.opendaylight.yangtools.yang.model.api.type.PatternConstraint;
  31 import org.slf4j.Logger;
  32 import org.slf4j.LoggerFactory;
  33
  34 /**
  35  * {@link AbstractTypeProvider} which generates full metadata, suitable for codegen purposes. For runtime purposes,
  36  * considering using {@link RuntimeTypeProvider}.
  37  */
  38 // FIXME: remove this class
  39 @Deprecated(forRemoval = true)
  40 final class CodegenTypeProvider extends AbstractTypeProvider {
  41     private static final Logger LOG = LoggerFactory.getLogger(CodegenTypeProvider.class);
  42
  43     @VisibleForTesting
  44     CodegenTypeProvider(final EffectiveModelContext schemaContext) {
  45         super(schemaContext);
  46     }
  47
  48     @Override
  49     public void addEnumDescription(final EnumBuilder enumBuilder, final EnumTypeDefinition enumTypeDef) {
  50         final Optional<String> optDesc = enumTypeDef.getDescription();
  51         if (optDesc.isPresent()) {
  52             enumBuilder.setDescription(encodeAngleBrackets(optDesc.get()));
  53         }
  54     }
  55
  56     @Override
  57     void addCodegenInformation(final GeneratedTypeBuilderBase<?> genTOBuilder, final TypeDefinition<?> typeDef) {
  58         final Optional<String> optDesc = typeDef.getDescription();
  59         if (optDesc.isPresent()) {
  60             genTOBuilder.setDescription(encodeAngleBrackets(optDesc.get()));
  61         }
  62         typeDef.getReference().ifPresent(genTOBuilder::setReference);
  63     }
  64
  65     /**
  66      * Converts the pattern constraints to the list of
  67      * the strings which represents these constraints.
  68      *
  69      * @param patternConstraints
  70      *            list of pattern constraints
  71      * @return list of strings which represents the constraint patterns
  72      */
  73     @Override
  74     public Map<String, String> resolveRegExpressions(final List<PatternConstraint> patternConstraints) {
  75         if (patternConstraints.isEmpty()) {
  76             return ImmutableMap.of();
  77         }
  78
  79         final Map<String, String> regExps = Maps.newHashMapWithExpectedSize(patternConstraints.size());
  80         for (PatternConstraint patternConstraint : patternConstraints) {
  81             String regEx = patternConstraint.getJavaPatternString();
  82
  83             // The pattern can be inverted
  84             final Optional<ModifierKind> optModifier = patternConstraint.getModifier();
  85             if (optModifier.isPresent()) {
  86                 regEx = applyModifier(optModifier.get(), regEx);
  87             }
  88
  89             regExps.put(regEx, patternConstraint.getRegularExpressionString());
  90         }
  91
  92         return regExps;
  93     }
  94
  95     private static String applyModifier(final ModifierKind modifier, final String pattern) {
  96         switch (modifier) {
  97             case INVERT_MATCH:
  98                 return RegexPatterns.negatePatternString(pattern);
  99             default:
 100                 LOG.warn("Ignoring unhandled modifier {}", modifier);
 101                 return pattern;
 102         }
 103     }
 104
 105     @Override
 106     public GeneratedTOBuilder newGeneratedTOBuilder(final JavaTypeName identifier) {
 107         return new CodegenGeneratedTOBuilder(identifier);
 108     }
 109
 110     @Override
 111     public AbstractEnumerationBuilder newEnumerationBuilder(final JavaTypeName identifier) {
 112         return new CodegenEnumerationBuilder(identifier);
 113     }
 114 }