com.google.gwt.dev.cfg.RuntimeRebindRegistratorGenerator Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of vaadin-client-compiler Show documentation

Vaadin is a web application framework for Rich Internet Applications (RIA). Vaadin enables easy development and maintenance of fast and secure rich web applications with a stunning look and feel and a wide browser support. It features a server-side architecture with the majority of the logic running on the server. Ajax technology is used at the browser-side to ensure a rich and interactive user experience.

There is a newer version: 8.25.2

Show newest version

/*
 * Copyright 2013 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.gwt.dev.cfg;

import com.google.gwt.core.ext.Generator;
import com.google.gwt.core.ext.GeneratorContext;
import com.google.gwt.core.ext.TreeLogger;

import java.io.PrintWriter;
import java.util.Map;

/**
 * Generator used to generate a class unique to the current module which has a register() function
 * which when invoked will register all currently known runtime rebind rule implementations with a
 * global registry.

 *
 * The resulting class is expected to be invoked as part of per module bootstrapping and before
 * anything that might depend on GWT.create() rebinding (including onModuleLoad() or gwtOnLoad()
 * methods).
 */
public class RuntimeRebindRegistratorGenerator extends Generator {

  private static final String PACKAGE_PATH = "com.google.gwt.lang";

  /**
   * The extension for all generated runtime rebind registrator classes. Is exposed publicly so
   * others can filter using the extension.
   */
  public static final String RUNTIME_REBIND_REGISTRATOR_SUFFIX = "RuntimeRebindRegistrator";

  @Override
  public String generate(TreeLogger logger, GeneratorContext context, String canonicalModuleName) {
    Map runtimeRebindRuleSourcesByShortName =
        RuntimeRebindRuleGenerator.RUNTIME_REBIND_RULE_SOURCES_BY_SHORT_NAME;

    // Creates a new class definition unique per module to avoid collision.
    String typeShortName = canonicalModuleName.replace(".", "_").replace("-", "_") + "_"
        + RUNTIME_REBIND_REGISTRATOR_SUFFIX;
    PrintWriter out = context.tryCreate(logger, PACKAGE_PATH, typeShortName);

    if (out != null) {
      out.println("package " + PACKAGE_PATH + ";");
      out.println("public class " + typeShortName + " {");

      // Drop all of the runtime rebind rule class implementations in.
      for (String runtimeRebindRuleSource : runtimeRebindRuleSourcesByShortName.values()) {
        out.println(runtimeRebindRuleSource);
      }

      out.println("  public static void register() {");
      if (!runtimeRebindRuleSourcesByShortName.isEmpty()) {
        // Instantiates and registers each one.
        for (String runtimeRebindRuleShortName : runtimeRebindRuleSourcesByShortName.keySet()) {
          out.println(String.format("    RuntimeRebinder.registerRuntimeRebindRule(new %s());",
              runtimeRebindRuleShortName));
        }
      } else {
        out.println("    // There are no runtime rebind rules for this module.");
      }
      out.println("  }");
      out.println("}");

      context.commit(logger, out);
    } else {
      // Must have been a cache hit.
    }

    return PACKAGE_PATH + "." + typeShortName;
  }
}