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.GeneratedTypeBuilder;
  22 import org.opendaylight.mdsal.binding.model.api.type.builder.GeneratedTypeBuilderBase;
  23 import org.opendaylight.mdsal.binding.model.ri.generated.type.builder.AbstractEnumerationBuilder;
  24 import org.opendaylight.mdsal.binding.model.ri.generated.type.builder.CodegenEnumerationBuilder;
  25 import org.opendaylight.mdsal.binding.model.ri.generated.type.builder.CodegenGeneratedTOBuilder;
  26 import org.opendaylight.mdsal.binding.model.ri.generated.type.builder.CodegenGeneratedTypeBuilder;
  27 import org.opendaylight.yangtools.yang.binding.RegexPatterns;
  28 import org.opendaylight.yangtools.yang.model.api.EffectiveModelContext;
  29 import org.opendaylight.yangtools.yang.model.api.TypeDefinition;
  30 import org.opendaylight.yangtools.yang.model.api.type.EnumTypeDefinition;
  31 import org.opendaylight.yangtools.yang.model.api.type.ModifierKind;
  32 import org.opendaylight.yangtools.yang.model.api.type.PatternConstraint;
  33 import org.slf4j.Logger;
  34 import org.slf4j.LoggerFactory;
  35
  36 /**
  37  * {@link AbstractTypeProvider} which generates full metadata, suitable for codegen purposes. For runtime purposes,
  38  * considering using {@link RuntimeTypeProvider}.
  39  */
  40 // FIXME: remove this class
  41 @Deprecated(forRemoval = true)
  42 final class CodegenTypeProvider extends AbstractTypeProvider {
  43     private static final Logger LOG = LoggerFactory.getLogger(CodegenTypeProvider.class);
  44
  45     @VisibleForTesting
  46     CodegenTypeProvider(final EffectiveModelContext schemaContext) {
  47         super(schemaContext);
  48     }
  49
  50     @Override
  51     public void addEnumDescription(final EnumBuilder enumBuilder, final EnumTypeDefinition enumTypeDef) {
  52         final Optional<String> optDesc = enumTypeDef.getDescription();
  53         if (optDesc.isPresent()) {
  54             enumBuilder.setDescription(encodeAngleBrackets(optDesc.get()));
  55         }
  56     }
  57
  58     @Override
  59     void addCodegenInformation(final GeneratedTypeBuilderBase<?> genTOBuilder, final TypeDefinition<?> typeDef) {
  60         final Optional<String> optDesc = typeDef.getDescription();
  61         if (optDesc.isPresent()) {
  62             genTOBuilder.setDescription(encodeAngleBrackets(optDesc.get()));
  63         }
  64         typeDef.getReference().ifPresent(genTOBuilder::setReference);
  65     }
  66
  67     /**
  68      * Converts the pattern constraints to the list of
  69      * the strings which represents these constraints.
  70      *
  71      * @param patternConstraints
  72      *            list of pattern constraints
  73      * @return list of strings which represents the constraint patterns
  74      */
  75     @Override
  76     public Map<String, String> resolveRegExpressions(final List<PatternConstraint> patternConstraints) {
  77         if (patternConstraints.isEmpty()) {
  78             return ImmutableMap.of();
  79         }
  80
  81         final Map<String, String> regExps = Maps.newHashMapWithExpectedSize(patternConstraints.size());
  82         for (PatternConstraint patternConstraint : patternConstraints) {
  83             String regEx = patternConstraint.getJavaPatternString();
  84
  85             // The pattern can be inverted
  86             final Optional<ModifierKind> optModifier = patternConstraint.getModifier();
  87             if (optModifier.isPresent()) {
  88                 regEx = applyModifier(optModifier.get(), regEx);
  89             }
  90
  91             regExps.put(regEx, patternConstraint.getRegularExpressionString());
  92         }
  93
  94         return regExps;
  95     }
  96
  97     private static String applyModifier(final ModifierKind modifier, final String pattern) {
  98         switch (modifier) {
  99             case INVERT_MATCH:
 100                 return RegexPatterns.negatePatternString(pattern);
 101             default:
 102                 LOG.warn("Ignoring unhandled modifier {}", modifier);
 103                 return pattern;
 104         }
 105     }
 106
 107     @Override
 108     public GeneratedTOBuilder newGeneratedTOBuilder(final JavaTypeName identifier) {
 109         return new CodegenGeneratedTOBuilder(identifier);
 110     }
 111
 112     @Override
 113     public GeneratedTypeBuilder newGeneratedTypeBuilder(final JavaTypeName identifier) {
 114         return new CodegenGeneratedTypeBuilder(identifier);
 115     }
 116
 117     @Override
 118     public AbstractEnumerationBuilder newEnumerationBuilder(final JavaTypeName identifier) {
 119         return new CodegenEnumerationBuilder(identifier);
 120     }
 121 }