com.google.template.soy.shared.internal.InternalPlugins.java Source code

Introduction

Here is the source code for com.google.template.soy.shared.internal.InternalPlugins.java

Source

/*
 * Copyright 2018 Google Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.google.template.soy.shared.internal;

import static com.google.common.base.Preconditions.checkState;

import com.google.common.base.Supplier;
import com.google.common.collect.ImmutableMap;
import com.google.common.collect.Iterables;
import com.google.template.soy.basicdirectives.BasicDirectives;
import com.google.template.soy.basicfunctions.BasicFunctions;
import com.google.template.soy.bididirectives.BidiDirectives;
import com.google.template.soy.bidifunctions.BidiFunctions;
import com.google.template.soy.coredirectives.CoreDirectives;
import com.google.template.soy.i18ndirectives.I18nDirectives;
import com.google.template.soy.internal.i18n.BidiGlobalDir;
import com.google.template.soy.plugin.restricted.SoySourceFunction;
import com.google.template.soy.shared.restricted.SoyFunction;
import com.google.template.soy.shared.restricted.SoyFunctionSignature;
import com.google.template.soy.shared.restricted.SoyPrintDirective;

/** Lists all functions & directives shipped with Soy. */
public final class InternalPlugins {
    private InternalPlugins() {
    }

    public static ImmutableMap<String, SoyFunction> internalLegacyFunctionMap() {
        ImmutableMap.Builder<String, SoyFunction> builder = ImmutableMap.builder();
        for (String builtinFunctionName : BuiltinFunction.names()) {
            builder.put(builtinFunctionName, BuiltinFunction.forFunctionName(builtinFunctionName));
        }
        return builder.build();
    }

    public static ImmutableMap<String, SoyFunction> fromLegacyFunctions(Iterable<? extends SoyFunction> functions) {
        ImmutableMap.Builder<String, SoyFunction> builder = ImmutableMap.builder();
        for (SoyFunction function : functions) {
            builder.put(function.getName(), function);
        }
        return builder.build();
    }

    /** Returns a map (whose key is the name of the function) of the functions shipped with Soy. */
    public static ImmutableMap<String, SoySourceFunction> internalFunctionMap(final SoyScopedData soyScopedData) {
        Supplier<BidiGlobalDir> bidiProvider = new Supplier<BidiGlobalDir>() {
            @Override
            public BidiGlobalDir get() {
                return soyScopedData.getBidiGlobalDir();
            }
        };
        // TODO(b/19252021): Include BuiltInFunctions
        return fromFunctions(Iterables.concat(BasicFunctions.functions(), BidiFunctions.functions(bidiProvider)));
    }

    public static ImmutableMap<String, SoySourceFunction> fromFunctions(
            Iterable<? extends SoySourceFunction> functions) {
        ImmutableMap.Builder<String, SoySourceFunction> builder = ImmutableMap.builder();
        for (SoySourceFunction fn : functions) {
            SoyFunctionSignature sig = fn.getClass().getAnnotation(SoyFunctionSignature.class);
            checkState(sig != null, "Missing @SoyFunctionSignature on %s", fn.getClass());
            builder.put(sig.name(), fn);
        }
        return builder.build();
    }

    public static ImmutableMap<String, SoyPrintDirective> internalDirectiveMap(final SoyScopedData soyScopedData) {
        Supplier<BidiGlobalDir> bidiProvider = new Supplier<BidiGlobalDir>() {
            @Override
            public BidiGlobalDir get() {
                return soyScopedData.getBidiGlobalDir();
            }
        };
        Supplier<String> localeProvider = new Supplier<String>() {
            @Override
            public String get() {
                return soyScopedData.getLocale();
            }
        };
        return fromDirectives(Iterables.concat(CoreDirectives.directives(), BasicDirectives.directives(),
                BidiDirectives.directives(bidiProvider), I18nDirectives.directives(localeProvider)));
    }

    public static ImmutableMap<String, SoyPrintDirective> fromDirectives(
            Iterable<? extends SoyPrintDirective> directives) {
        ImmutableMap.Builder<String, SoyPrintDirective> builder = ImmutableMap.builder();
        for (SoyPrintDirective directive : directives) {
            builder.put(directive.getName(), directive);
        }
        return builder.build();
    }
}