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