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