001/* 002 * Portions of this software was developed by employees of the National Institute 003 * of Standards and Technology (NIST), an agency of the Federal Government and is 004 * being made available as a public service. Pursuant to title 17 United States 005 * Code Section 105, works of NIST employees are not subject to copyright 006 * protection in the United States. This software may be subject to foreign 007 * copyright. Permission in the United States and in foreign countries, to the 008 * extent that NIST may hold copyright, to use, copy, modify, create derivative 009 * works, and distribute this software and its documentation without fee is hereby 010 * granted on a non-exclusive basis, provided that this notice and disclaimer 011 * of warranty appears in all copies. 012 * 013 * THE SOFTWARE IS PROVIDED 'AS IS' WITHOUT ANY WARRANTY OF ANY KIND, EITHER 014 * EXPRESSED, IMPLIED, OR STATUTORY, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY 015 * THAT THE SOFTWARE WILL CONFORM TO SPECIFICATIONS, ANY IMPLIED WARRANTIES OF 016 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND FREEDOM FROM 017 * INFRINGEMENT, AND ANY WARRANTY THAT THE DOCUMENTATION WILL CONFORM TO THE 018 * SOFTWARE, OR ANY WARRANTY THAT THE SOFTWARE WILL BE ERROR FREE. IN NO EVENT 019 * SHALL NIST BE LIABLE FOR ANY DAMAGES, INCLUDING, BUT NOT LIMITED TO, DIRECT, 020 * INDIRECT, SPECIAL OR CONSEQUENTIAL DAMAGES, ARISING OUT OF, RESULTING FROM, 021 * OR IN ANY WAY CONNECTED WITH THIS SOFTWARE, WHETHER OR NOT BASED UPON WARRANTY, 022 * CONTRACT, TORT, OR OTHERWISE, WHETHER OR NOT INJURY WAS SUSTAINED BY PERSONS OR 023 * PROPERTY OR OTHERWISE, AND WHETHER OR NOT LOSS WAS SUSTAINED FROM, OR AROSE OUT 024 * OF THE RESULTS OF, OR USE OF, THE SOFTWARE OR SERVICES PROVIDED HEREUNDER. 025 */ 026 027package gov.nist.secauto.metaschema.core.model; 028 029import gov.nist.secauto.metaschema.core.util.CollectionUtil; 030 031import java.util.Collection; 032import java.util.HashSet; 033import java.util.Set; 034import java.util.function.Function; 035 036import edu.umd.cs.findbugs.annotations.NonNull; 037 038/** 039 * This model walker can be used to gather metaschema definitions that are 040 * defined globally. 041 */ 042public class UsedDefinitionModelWalker 043 extends DefinitionCollectingModelWalker { 044 private static final Function<IDefinition, Boolean> FILTER = (def) -> { 045 return true; 046 // return def.isGlobal(); 047 // return def.isGlobal() || (def instanceof AssemblyDefinition && 048 // ((AssemblyDefinition)def).getRootName() != null); 049 }; 050 051 /** 052 * Get the collection of all definitions used directly and transitively by the 053 * provided definitions. 054 * 055 * @param definitions 056 * a collection of definitions to generate used definitions from 057 * @return the collection of used definitions 058 */ 059 @NonNull 060 public static Collection<? extends IDefinition> 061 collectUsedDefinitions(Collection<? extends IAssemblyDefinition> definitions) { 062 UsedDefinitionModelWalker walker = new UsedDefinitionModelWalker(); 063 for (IAssemblyDefinition definition : definitions) { 064 assert definition != null; 065 walker.walk(definition); 066 } 067 return walker.getDefinitions(); 068 } 069 070 /** 071 * Collect the globally defined Metaschema definitions from the provided 072 * Metaschema modules, and any Metaschema modules imported directly or 073 * indirectly by these modules. 074 * 075 * @param modules 076 * the Metaschema modules to analyze 077 * @return a collection of matching definitions 078 */ 079 @NonNull 080 public static Collection<? extends IDefinition> collectUsedDefinitionsFromModule( 081 @NonNull Collection<? extends IModule> modules) { 082 Set<IAssemblyDefinition> definitions = new HashSet<>(); 083 for (IModule module : modules) { 084 // get local roots in case they are scope=local 085 for (IAssemblyDefinition rootDef : module.getRootAssemblyDefinitions()) { 086 definitions.add(rootDef); 087 } 088 089 // get roots from exported 090 for (IAssemblyDefinition assembly : module.getExportedAssemblyDefinitions()) { 091 if (assembly.isRoot()) { 092 definitions.add(assembly); 093 } 094 } 095 } 096 return collectUsedDefinitions(definitions); 097 } 098 099 /** 100 * Collect the globally defined Metaschema definitions from the provided 101 * Metaschema module, and any Metaschema modules imported directly or indirectly 102 * by this module. 103 * 104 * @param module 105 * the metaschema module to analyze 106 * @return a collection of matching definitions 107 */ 108 @NonNull 109 public static Collection<? extends IDefinition> collectUsedDefinitionsFromModule( 110 @NonNull IModule module) { 111 return collectUsedDefinitionsFromModule(CollectionUtil.singleton(module)); 112 } 113 114 /** 115 * Construct a new walker. 116 */ 117 protected UsedDefinitionModelWalker() { 118 super(FILTER); 119 } 120}