1 /*
   2  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   3  *
   4  * This code is free software; you can redistribute it and/or modify it
   5  * under the terms of the GNU General Public License version 2 only, as
   6  * published by the Free Software Foundation.  Oracle designates this
   7  * particular file as subject to the "Classpath" exception as provided
   8  * by Oracle in the LICENSE file that accompanied this code.
   9  *
  10  * This code is distributed in the hope that it will be useful, but WITHOUT
  11  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  12  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  13  * version 2 for more details (a copy is included in the LICENSE file that
  14  * accompanied this code).
  15  *
  16  * You should have received a copy of the GNU General Public License version
  17  * 2 along with this work; if not, write to the Free Software Foundation,
  18  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  19  *
  20  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  21  * or visit www.oracle.com if you need additional information or have any
  22  * questions.
  23  */
  24 
  25 /*
  26  * This file is available under and governed by the GNU General Public
  27  * License version 2 only, as published by the Free Software Foundation.
  28  * However, the following notice accompanied the original version of this
  29  * file:
  30  *
  31  * ASM: a very small and fast Java bytecode manipulation framework
  32  * Copyright (c) 2000-2011 INRIA, France Telecom
  33  * All rights reserved.
  34  *
  35  * Redistribution and use in source and binary forms, with or without
  36  * modification, are permitted provided that the following conditions
  37  * are met:
  38  * 1. Redistributions of source code must retain the above copyright
  39  *    notice, this list of conditions and the following disclaimer.
  40  * 2. Redistributions in binary form must reproduce the above copyright
  41  *    notice, this list of conditions and the following disclaimer in the
  42  *    documentation and/or other materials provided with the distribution.
  43  * 3. Neither the name of the copyright holders nor the names of its
  44  *    contributors may be used to endorse or promote products derived from
  45  *    this software without specific prior written permission.
  46  *
  47  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  48  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  49  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  50  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
  51  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  52  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  53  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  54  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  55  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  56  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
  57  * THE POSSIBILITY OF SUCH DAMAGE.
  58  */
  59 package jdk.internal.org.objectweb.asm.util;
  60 
  61 import java.util.HashSet;
  62 
  63 import jdk.internal.org.objectweb.asm.ModuleVisitor;
  64 import jdk.internal.org.objectweb.asm.Opcodes;
  65 
  66 /**
  67  * @author Remi Forax
  68  */
  69 public final class CheckModuleAdapter extends ModuleVisitor {
  70     private boolean end;
  71     private final boolean isOpen;
  72 
  73     private final HashSet<String> requireNames = new HashSet<String>();
  74     private final HashSet<String> exportNames = new HashSet<String>();
  75     private final HashSet<String> openNames = new HashSet<String>();
  76     private final HashSet<String> useNames = new HashSet<String>();
  77     private final HashSet<String> provideNames = new HashSet<String>();
  78 
  79     public CheckModuleAdapter(final ModuleVisitor mv, final boolean isOpen) {
  80         super(Opcodes.ASM6, mv);
  81         this.isOpen = isOpen;
  82     }
  83 
  84     @Override
  85     public void visitRequire(String module, int access, String version) {
  86         checkEnd();
  87         if (module == null) {
  88             throw new IllegalArgumentException("require cannot be null");
  89         }
  90         checkDeclared("requires", requireNames, module);
  91         CheckClassAdapter.checkAccess(access, Opcodes.ACC_STATIC_PHASE
  92                 + Opcodes.ACC_TRANSITIVE + Opcodes.ACC_SYNTHETIC + Opcodes.ACC_MANDATED);
  93         super.visitRequire(module, access, version);
  94     }
  95 
  96     @Override
  97     public void visitExport(String packaze, int access, String... modules) {
  98         checkEnd();
  99         if (packaze == null) {
 100             throw new IllegalArgumentException("packaze cannot be null");
 101         }
 102         CheckMethodAdapter.checkInternalName(packaze, "package name");
 103         checkDeclared("exports", exportNames, packaze);
 104         CheckClassAdapter.checkAccess(access, Opcodes.ACC_SYNTHETIC
 105                 + Opcodes.ACC_MANDATED);
 106         if (modules != null) {
 107             for (int i = 0; i < modules.length; i++) {
 108                 if (modules[i] == null) {
 109                     throw new IllegalArgumentException("module at index " + i + " cannot be null");
 110                 }
 111             }
 112         }
 113         super.visitExport(packaze, access, modules);
 114     }
 115 
 116     @Override
 117     public void visitOpen(String packaze, int access, String... modules) {
 118         checkEnd();
 119         if (isOpen) {
 120             throw new IllegalArgumentException("an open module can not use open directive");
 121         }
 122         if (packaze == null) {
 123             throw new IllegalArgumentException("packaze cannot be null");
 124         }
 125         CheckMethodAdapter.checkInternalName(packaze, "package name");
 126         checkDeclared("opens", openNames, packaze);
 127         CheckClassAdapter.checkAccess(access, Opcodes.ACC_SYNTHETIC
 128                 + Opcodes.ACC_MANDATED);
 129         if (modules != null) {
 130             for (int i = 0; i < modules.length; i++) {
 131                 if (modules[i] == null) {
 132                     throw new IllegalArgumentException("module at index " + i + " cannot be null");
 133                 }
 134             }
 135         }
 136         super.visitOpen(packaze, access, modules);
 137     }
 138 
 139     @Override
 140     public void visitUse(String service) {
 141         checkEnd();
 142         CheckMethodAdapter.checkInternalName(service, "service");
 143         checkDeclared("uses", useNames, service);
 144         super.visitUse(service);
 145     }
 146 
 147     @Override
 148     public void visitProvide(String service, String... providers) {
 149         checkEnd();
 150         CheckMethodAdapter.checkInternalName(service, "service");
 151         checkDeclared("provides", provideNames, service);
 152         if (providers == null || providers.length == 0) {
 153             throw new IllegalArgumentException("providers cannot be null or empty");
 154         }
 155         for (int i = 0; i < providers.length; i++) {
 156             CheckMethodAdapter.checkInternalName(providers[i], "provider");
 157         }
 158         super.visitProvide(service, providers);
 159     }
 160 
 161     @Override
 162     public void visitEnd() {
 163         checkEnd();
 164         end = true;
 165         super.visitEnd();
 166     }
 167 
 168     private void checkEnd() {
 169         if (end) {
 170             throw new IllegalStateException(
 171                     "Cannot call a visit method after visitEnd has been called");
 172         }
 173     }
 174 
 175     private static void checkDeclared(String directive, HashSet<String> names, String name) {
 176         if (!names.add(name)) {
 177             throw new IllegalArgumentException(directive + " " + name + " already declared");
 178         }
 179     }
 180 }