content: /*
   * Copyright (c) 2009, 2021, Oracle and/or its affiliates. All rights reserved.
   * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   *
   * This code is free software; you can redistribute it and/or modify it
   * under the terms of the GNU General Public License version 2 only, as
   * published by the Free Software Foundation.  Oracle designates this
   * particular file as subject to the "Classpath" exception as provided
   * by Oracle in the LICENSE file that accompanied this code.
   *
   * This code is distributed in the hope that it will be useful, but WITHOUT
   * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
   * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
   * version 2 for more details (a copy is included in the LICENSE file that
   * accompanied this code).
   *
   * You should have received a copy of the GNU General Public License version
   * 2 along with this work; if not, write to the Free Software Foundation,
   * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
   *
   * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
   * or visit www.oracle.com if you need additional information or have any
   * questions.
   */
  
  package openjdk.tools.javac.code;
  
  import java.util.Collections;
  import java.util.EnumSet;
  import java.util.Locale;
  import java.util.Set;
  
  import jdkx.lang.model.element.ModuleElement;
  import jdkx.lang.model.element.ModuleElement.DirectiveVisitor;
  
  import openjdk.tools.javac.api.Messages;
  import openjdk.tools.javac.code.Symbol.ClassSymbol;
  import openjdk.tools.javac.code.Symbol.ModuleSymbol;
  import openjdk.tools.javac.code.Symbol.PackageSymbol;
  import openjdk.tools.javac.util.DefinedBy;
  import openjdk.tools.javac.util.DefinedBy.Api;
  import openjdk.tools.javac.util.List;
  
  
  /**
   *  Root class for the directives that may appear in module compilation units.
   *
   *  <p><b>This is NOT part of any supported API.
   *  If you write code that depends on this, you do so at your own risk.
   *  This code and its internal interfaces are subject to change or
   *  deletion without notice.</b>
   */
  public abstract class Directive implements ModuleElement.Directive {
  
      /** Flags for RequiresDirective. */
      public enum RequiresFlag {
          TRANSITIVE(0x0020),
          STATIC_PHASE(0x0040),
          SYNTHETIC(0x1000),
          MANDATED(0x8000),
          EXTRA(0x10000);
  
          // overkill? move to ClassWriter?
          public static int value(Set<RequiresFlag> s) {
              int v = 0;
              for (RequiresFlag f: s)
                  v |= f.value;
              return v;
          }
  
          RequiresFlag(int value) {
              this.value = value;
          }
  
          public final int value;
  
          @Override
          public String toString() {
              return String.format("ACC_%s (0x%04x", name(), value);
          }
      }
  
      /** Flags for ExportsDirective. */
      public enum ExportsFlag {
          SYNTHETIC(0x1000),
          MANDATED(0x8000);
  
          // overkill? move to ClassWriter?
          public static int value(Set<ExportsFlag> s) {
              int v = 0;
              for (ExportsFlag f: s)
                  v |= f.value;
              return v;
          }
  
          ExportsFlag(int value) {
              this.value = value;
          }
  
          public final int value;
      }
  
      /**
       * 'exports' Package ';'
       * 'exports' Package 'to' ModuleList ';'
       */
      public static class ExportsDirective extends Directive
              implements ModuleElement.ExportsDirective {
          public final PackageSymbol packge;
          public final List<ModuleSymbol> modules;
          public final Set<ExportsFlag> flags;
  
          public ExportsDirective(PackageSymbol packge, List<ModuleSymbol> modules) {
              this(packge, modules, EnumSet.noneOf(ExportsFlag.class));
          }
  
          public ExportsDirective(PackageSymbol packge, List<ModuleSymbol> modules, Set<ExportsFlag> flags) {
              this.packge = packge;
              this.modules = modules;
              this.flags = flags;
          }
  
          @Override @DefinedBy(Api.LANGUAGE_MODEL)
          public ModuleElement.DirectiveKind getKind() {
              return ModuleElement.DirectiveKind.EXPORTS;
          }
  
          @Override @DefinedBy(Api.LANGUAGE_MODEL)
          public PackageSymbol getPackage() {
              return packge;
          }
  
          @Override @DefinedBy(Api.LANGUAGE_MODEL)
          public java.util.List<ModuleSymbol> getTargetModules() {
              return modules == null
                      ? null
                      : Collections.unmodifiableList(modules);
          }
  
          @Override
          public String toString() {
              if (modules == null)
                  return "Exports[" + packge + "]";
              else
                  return "Exports[" + packge + ":" + modules + "]";
          }
  
          @Override @DefinedBy(Api.LANGUAGE_MODEL)
          public <R, P> R accept(DirectiveVisitor<R, P> v, P p) {
              return v.visitExports(this, p);
          }
      }
  
      /** Flags for OpensDirective. */
      public enum OpensFlag {
          SYNTHETIC(0x1000),
          MANDATED(0x8000);
  
          // overkill? move to ClassWriter?
          public static int value(Set<OpensFlag> s) {
              int v = 0;
              for (OpensFlag f: s)
                  v |= f.value;
              return v;
          }
  
          OpensFlag(int value) {
              this.value = value;
          }
  
          public final int value;
      }
  
      /**
       * 'opens' Package ';'
       * 'opens' Package 'to' ModuleList ';'
       */
      public static class OpensDirective extends Directive
              implements ModuleElement.OpensDirective {
          public final PackageSymbol packge;
          public final List<ModuleSymbol> modules;
          public final Set<OpensFlag> flags;
  
          public OpensDirective(PackageSymbol packge, List<ModuleSymbol> modules) {
              this(packge, modules, EnumSet.noneOf(OpensFlag.class));
          }
  
          public OpensDirective(PackageSymbol packge, List<ModuleSymbol> modules, Set<OpensFlag> flags) {
              this.packge = packge;
              this.modules = modules;
              this.flags = flags;
          }
  
          @Override @DefinedBy(Api.LANGUAGE_MODEL)
          public ModuleElement.DirectiveKind getKind() {
              return ModuleElement.DirectiveKind.OPENS;
          }
  
          @Override @DefinedBy(Api.LANGUAGE_MODEL)
          public PackageSymbol getPackage() {
              return packge;
          }
  
          @Override @DefinedBy(Api.LANGUAGE_MODEL)
          public java.util.List<ModuleSymbol> getTargetModules() {
              return modules == null
                      ? null
                      : Collections.unmodifiableList(modules);
          }
  
          @Override
          public String toString() {
              if (modules == null)
                  return "Opens[" + packge + "]";
              else
                  return "Opens[" + packge + ":" + modules + "]";
          }
  
          @Override @DefinedBy(Api.LANGUAGE_MODEL)
          public <R, P> R accept(DirectiveVisitor<R, P> v, P p) {
              return v.visitOpens(this, p);
          }
      }
  
      /**
       * 'provides' ServiceName 'with' QualifiedIdentifier ';'
       */
      public static class ProvidesDirective extends Directive
              implements ModuleElement.ProvidesDirective {
          public final ClassSymbol service;
          public final List<ClassSymbol> impls;
  
          public ProvidesDirective(ClassSymbol service, List<ClassSymbol> impls) {
              this.service = service;
              this.impls = impls;
          }
  
          @Override @DefinedBy(Api.LANGUAGE_MODEL)
          public ModuleElement.DirectiveKind getKind() {
              return ModuleElement.DirectiveKind.PROVIDES;
          }
  
          @Override @DefinedBy(Api.LANGUAGE_MODEL)
          public ClassSymbol getService() {
              return service;
          }
  
          @Override @DefinedBy(Api.LANGUAGE_MODEL)
          public List<ClassSymbol> getImplementations() {
              return impls;
          }
  
          @Override
          public String toString() {
              return "Provides[" + service + "," + impls + "]";
          }
  
          @Override @DefinedBy(Api.LANGUAGE_MODEL)
          public <R, P> R accept(DirectiveVisitor<R, P> v, P p) {
              return v.visitProvides(this, p);
          }
  
          // TODO: delete?
          @Override
          public boolean equals(Object obj) {
              if (!(obj instanceof ProvidesDirective)) {
                  return false;
              }
              ProvidesDirective other = (ProvidesDirective)obj;
              return service == other.service && impls.equals(other.impls);
          }
  
          // TODO: delete?
          @Override
          public int hashCode() {
              return service.hashCode() * 31 + impls.hashCode() * 37;
          }
      }
  
      /**
       * 'requires' ('static' | 'transitive')* ModuleName ';'
       */
      public static class RequiresDirective extends Directive
              implements ModuleElement.RequiresDirective {
          public final ModuleSymbol module;
          public final Set<RequiresFlag> flags;
  
          public RequiresDirective(ModuleSymbol module) {
              this(module, EnumSet.noneOf(RequiresFlag.class));
          }
  
          public RequiresDirective(ModuleSymbol module, Set<RequiresFlag> flags) {
              this.module = module;
              this.flags = flags;
          }
  
          @Override @DefinedBy(Api.LANGUAGE_MODEL)
          public ModuleElement.DirectiveKind getKind() {
              return ModuleElement.DirectiveKind.REQUIRES;
          }
  
          @Override @DefinedBy(Api.LANGUAGE_MODEL)
          public boolean isStatic() {
              return flags.contains(RequiresFlag.STATIC_PHASE);
          }
  
          @Override @DefinedBy(Api.LANGUAGE_MODEL)
          public boolean isTransitive() {
              return flags.contains(RequiresFlag.TRANSITIVE);
          }
  
          @Override @DefinedBy(Api.LANGUAGE_MODEL)
          public ModuleSymbol getDependency() {
              return module;
          }
  
          @Override
          public String toString() {
              return "Requires[" + flags + "," + module + "]";
          }
  
          @Override @DefinedBy(Api.LANGUAGE_MODEL)
          public <R, P> R accept(DirectiveVisitor<R, P> v, P p) {
              return v.visitRequires(this, p);
          }
      }
  
      /**
       * 'uses' ServiceName ';'
       */
      public static class UsesDirective extends Directive
              implements ModuleElement.UsesDirective {
          public final ClassSymbol service;
  
          public UsesDirective(ClassSymbol service) {
              this.service = service;
          }
  
          @Override @DefinedBy(Api.LANGUAGE_MODEL)
          public ModuleElement.DirectiveKind getKind() {
              return ModuleElement.DirectiveKind.USES;
          }
  
          @Override @DefinedBy(Api.LANGUAGE_MODEL)
          public ClassSymbol getService() {
              return service;
          }
  
          @Override
          public String toString() {
              return "Uses[" + service + "]";
          }
  
          @Override @DefinedBy(Api.LANGUAGE_MODEL)
          public <R, P> R accept(DirectiveVisitor<R, P> v, P p) {
              return v.visitUses(this, p);
          }
  
          // TODO: delete?
          @Override
          public boolean equals(Object obj) {
               if (!(obj instanceof UsesDirective)) {
                  return false;
              }
              UsesDirective other = (UsesDirective)obj;
              return service == other.service;
          }
  
          // TODO: delete?
          @Override
          public int hashCode() {
              return service.hashCode() * 31;
          }
      }
  }
  