View Javadoc
1   /*
2    * Themis: Java Project Framework
3    * Copyright 2012-2026. Tony Washer
4    *
5    * Licensed under the Apache License, Version 2.0 (the "License"); you may not
6    * use this file except in compliance with the License.  You may obtain a copy
7    * of the License at
8    *
9    *   http://www.apache.org/licenses/LICENSE-2.0
10   *
11   * Unless required by applicable law or agreed to in writing, software
12   * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
13   * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the
14   * License for the specific language governing permissions and limitations under
15   * the License.
16   */
17  package io.github.tonywasher.joceanus.themis.xanalysis.solver.proj;
18  
19  import io.github.tonywasher.joceanus.themis.xanalysis.parser.base.ThemisXAnalysisInstance.ThemisXAnalysisClassInstance;
20  import io.github.tonywasher.joceanus.themis.xanalysis.parser.proj.ThemisXAnalysisFile;
21  import io.github.tonywasher.joceanus.themis.xanalysis.solver.proj.ThemisXAnalysisSolverDef.ThemisXAnalysisSolverFileDef;
22  import io.github.tonywasher.joceanus.themis.xanalysis.solver.proj.ThemisXAnalysisSolverDef.ThemisXAnalysisSolverPackageDef;
23  
24  import java.util.ArrayList;
25  import java.util.List;
26  
27  /**
28   * Solver File.
29   */
30  public class ThemisXAnalysisSolverFile
31          implements ThemisXAnalysisSolverFileDef {
32      /**
33       * The owning package.
34       */
35      private final ThemisXAnalysisSolverPackageDef thePackage;
36  
37      /**
38       * The underlying file.
39       */
40      private final ThemisXAnalysisFile theFile;
41  
42      /**
43       * The top-level class.
44       */
45      private final ThemisXAnalysisSolverClass theTopLevel;
46  
47      /**
48       * The classes.
49       */
50      private final List<ThemisXAnalysisSolverClass> theClasses;
51  
52      /**
53       * The referenced classes.
54       */
55      private final List<ThemisXAnalysisSolverClass> theReferenced;
56  
57      /**
58       * Is the reference list circular?
59       */
60      private boolean isCircular;
61  
62      /**
63       * Constructor.
64       *
65       * @param pPackage the owning package
66       * @param pFile    the parsed file
67       */
68      ThemisXAnalysisSolverFile(final ThemisXAnalysisSolverPackageDef pPackage,
69                                final ThemisXAnalysisFile pFile) {
70          /* Store the parameters */
71          thePackage = pPackage;
72          theFile = pFile;
73  
74          /* Populate the classList */
75          theClasses = new ArrayList<>();
76          for (ThemisXAnalysisClassInstance myClass : theFile.getClasses()) {
77              final ThemisXAnalysisSolverClass mySolverClass = new ThemisXAnalysisSolverClass(this, myClass);
78              theClasses.add(mySolverClass);
79          }
80  
81          /* Determine top-level class */
82          theTopLevel = theClasses.stream().filter(ThemisXAnalysisSolverClass::isTopLevel).findFirst().orElse(null);
83  
84          /* Create the referenced classes */
85          theReferenced = new ArrayList<>();
86      }
87  
88      @Override
89      public ThemisXAnalysisSolverPackageDef getOwningPackage() {
90          return thePackage;
91      }
92  
93      @Override
94      public ThemisXAnalysisFile getUnderlyingFile() {
95          return theFile;
96      }
97  
98      /**
99       * Obtain the top-level class.
100      *
101      * @return the top-level
102      */
103     public ThemisXAnalysisSolverClass getTopLevel() {
104         return theTopLevel;
105     }
106 
107     /**
108      * Obtain the classes.
109      *
110      * @return the classes
111      */
112     public List<ThemisXAnalysisSolverClass> getClasses() {
113         return theClasses;
114     }
115 
116     /**
117      * Is the reference list circular?
118      *
119      * @return true/false
120      */
121     public boolean isCircular() {
122         return isCircular;
123     }
124 
125     @Override
126     public String toString() {
127         return theFile.toString();
128     }
129 
130     /**
131      * Obtain the list of classes that reference the named package.
132      *
133      * @param pPackage the package
134      * @return the list of referencing classes
135      */
136     public List<ThemisXAnalysisSolverClass> getReferencesTo(final String pPackage) {
137         /* Loop through the classes */
138         final List<ThemisXAnalysisSolverClass> myReferences = new ArrayList<>();
139         for (ThemisXAnalysisSolverClass myReference : theReferenced) {
140             if (pPackage.equals(myReference.getPackageName())) {
141                 myReferences.add(myReference);
142             }
143         }
144         return myReferences;
145     }
146 
147     /**
148      * Obtain the list of local classes that are referenced.
149      *
150      * @return the list of referencing classes
151      */
152     private List<ThemisXAnalysisSolverClass> getLocalReferences() {
153         return getReferencesTo(thePackage.toString());
154     }
155 
156     /**
157      * Set the referenced classes.
158      *
159      * @param pReferenced the referenced classes
160      */
161     public void setReferenced(final List<ThemisXAnalysisSolverClass> pReferenced) {
162         /* Add all references except for a self-reference */
163         theReferenced.addAll(pReferenced.stream().filter(s -> !s.equals(getTopLevel())).toList());
164     }
165 
166     /**
167      * process local references.
168      */
169     public void processLocalReferences() {
170         /* Create a reference list */
171         final List<ThemisXAnalysisSolverClass> myFullyReferenced = new ArrayList<>();
172 
173         /* Loop through the referenced local classes */
174         for (ThemisXAnalysisSolverClass myClass : getLocalReferences()) {
175             /* Process the class */
176             processLocalReferences(myFullyReferenced, myClass);
177         }
178 
179         /* Determine whether we are circular */
180         isCircular = myFullyReferenced.contains(theTopLevel);
181     }
182 
183     /**
184      * process local references.
185      *
186      * @param pReferences the references list
187      * @param pClass      the class to process local references for
188      */
189     private void processLocalReferences(final List<ThemisXAnalysisSolverClass> pReferences,
190                                         final ThemisXAnalysisSolverClass pClass) {
191         /* If this is not already in the local reference list */
192         if (!pReferences.contains(pClass)) {
193             /* Add the class */
194             pReferences.add(pClass);
195 
196             /* Only process further if we have not found circularity */
197             if (!pClass.equals(theTopLevel)) {
198                 /* Loop through the local references */
199                 for (ThemisXAnalysisSolverClass myClass : ((ThemisXAnalysisSolverFile) pClass.getOwningFile()).getLocalReferences()) {
200                     /* Process the local references */
201                     processLocalReferences(pReferences, myClass);
202                 }
203             }
204         }
205     }
206 }