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