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.opendaylight.yangtools.yang.model.api.type.StringTypeDefinition;
  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 @Beta
  41 // FIXME: make this class final after TypeProviderImpl is gone
  42 public class CodegenTypeProvider extends AbstractTypeProvider {
  43     private static final Logger LOG = LoggerFactory.getLogger(CodegenTypeProvider.class);
  44
  45     /**
  46      * Creates new instance of class <code>TypeProviderImpl</code>.
  47      *
  48      * @param schemaContext contains the schema data read from YANG files
  49      * @throws IllegalArgumentException if <code>schemaContext</code> is null.
  50      */
  51     public CodegenTypeProvider(final SchemaContext schemaContext) {
  52         super(schemaContext);
  53     }
  54
  55     @Override
  56     public void addEnumDescription(final EnumBuilder enumBuilder, final EnumTypeDefinition enumTypeDef) {
  57         final Optional<String> optDesc = enumTypeDef.getDescription();
  58         if (optDesc.isPresent()) {
  59             enumBuilder.setDescription(encodeAngleBrackets(optDesc.get()));
  60         }
  61     }
  62
  63     @Override
  64     void addCodegenInformation(final GeneratedTypeBuilderBase<?> genTOBuilder, final TypeDefinition<?> typeDef) {
  65         final Optional<String> optDesc = typeDef.getDescription();
  66         if (optDesc.isPresent()) {
  67             genTOBuilder.setDescription(encodeAngleBrackets(optDesc.get()));
  68         }
  69         typeDef.getReference().ifPresent(genTOBuilder::setReference);
  70     }
  71
  72     @Override
  73     Map<String, String> resolveRegExpressionsFromTypedef(final TypeDefinition<?> typedef) {
  74         if (!(typedef instanceof StringTypeDefinition)) {
  75             return ImmutableMap.of();
  76         }
  77
  78         // TODO: run diff against base ?
  79         final List<PatternConstraint> patternConstraints = ((StringTypeDefinition) typedef).getPatternConstraints();
  80         final Map<String, String> regExps = Maps.newHashMapWithExpectedSize(patternConstraints.size());
  81         for (PatternConstraint patternConstraint : patternConstraints) {
  82             String regEx = patternConstraint.getJavaPatternString();
  83
  84             // The pattern can be inverted
  85             final Optional<ModifierKind> optModifier = patternConstraint.getModifier();
  86             if (optModifier.isPresent()) {
  87                 regEx = applyModifier(optModifier.get(), regEx);
  88             }
  89
  90             regExps.put(regEx, patternConstraint.getRegularExpressionString());
  91         }
  92
  93         return regExps;
  94     }
  95
  96     private static String applyModifier(final ModifierKind modifier, final String pattern) {
  97         switch (modifier) {
  98             case INVERT_MATCH:
  99                 return BindingMapping.negatePatternString(pattern);
 100             default:
 101                 LOG.warn("Ignoring unhandled modifier {}", modifier);
 102                 return pattern;
 103         }
 104     }
 105
 106     @Override
 107     public GeneratedTOBuilder newGeneratedTOBuilder(final String packageName, final String name) {
 108         return new CodegenGeneratedTOBuilder(packageName, name);
 109     }
 110
 111     @Override
 112     public GeneratedTypeBuilder newGeneratedTypeBuilder(final String packageName, final String name) {
 113         return new CodegenGeneratedTypeBuilder(packageName, name);
 114     }
 115
 116     @Override
 117     public AbstractEnumerationBuilder newEnumerationBuilder(final String packageName, final String name) {
 118         return new CodegenEnumerationBuilder(packageName, name);
 119     }
 120 }