buildSrc/src/main/java/cc/squirreljme/plugin/ErrorCodeManager.java

   1 // -*- Mode: Java; indent-tabs-mode: t; tab-width: 4 -*-
   2 // ---------------------------------------------------------------------------
   3 // SquirrelJME
   4 //     Copyright (C) Stephanie Gawroriski <xer@multiphasicapps.net>
   5 // ---------------------------------------------------------------------------
   6 // SquirrelJME is under the GNU General Public License v3+, or later.
   7 // See license.mkd for licensing and copyright information.
   8 // ---------------------------------------------------------------------------
   9
  10 package cc.squirreljme.plugin;
  11
  12 import java.io.PrintStream;
  13 import java.util.Map;
  14 import java.util.NoSuchElementException;
  15 import java.util.Set;
  16 import java.util.SortedSet;
  17 import java.util.TreeMap;
  18 import java.util.TreeSet;
  19 import org.gradle.api.Project;
  20
  21 /**
  22  * This is a mapping of error codes to projects.
  23  *
  24  * @since 2020/02/22
  25  */
  26 public final class ErrorCodeManager
  27 {
  28         /** The project for discovery. */
  29         protected final Project project;
  30
  31         /** The mapping of error codes to projects. */
  32         private final Map<String, Project> _codeMap =
  33                 new TreeMap<>(String.CASE_INSENSITIVE_ORDER);
  34
  35         /** Unclaimed error codes. */
  36         private final SortedSet<String> _unclaimed =
  37                 new TreeSet<>(String.CASE_INSENSITIVE_ORDER);
  38
  39         /**
  40          * Initializes the error code manager.
  41          *
  42          * @param __project The root project to manage.
  43          * @throws NullPointerException On null arguments.
  44          * @since 2020/02/22
  45          */
  46         public ErrorCodeManager(Project __project)
  47                 throws NullPointerException
  48         {
  49                 if (__project == null)
  50                         throw new NullPointerException("No project.");
  51
  52                 this.project = __project.getRootProject();
  53
  54                 // Add all unclaimed codes
  55                 Set<String> unclaimed = this._unclaimed;
  56                 for (char a = 'A'; a <= 'Z'; a++)
  57                         for (char b = 'A'; b <= 'Z'; b++)
  58                                 unclaimed.add(a + "" + b);
  59         }
  60
  61         /**
  62          * Returns an error list manager for the given code ID.
  63          *
  64          * @param __code The code to get.
  65          * @return The error list manager.
  66          * @since 2020/02/22
  67          */
  68         public final ErrorListManager errorList(String __code)
  69         {
  70                 return new ErrorListManager(this.projectByCode(__code));
  71         }
  72
  73         /**
  74          * Returns the next available error code.
  75          *
  76          * @return The next available error code.
  77          * @since 2020/02/22
  78          */
  79         public final String next()
  80         {
  81                 this.__init();
  82
  83                 synchronized (this)
  84                 {
  85                         return this._unclaimed.first();
  86                 }
  87         }
  88
  89         /**
  90          * Prints the error codes to the given stream.
  91          *
  92          * @param __out The stream to print to.
  93          * @throws NullPointerException On null arguments.
  94          * @since 2020/02/22
  95          */
  96         public final void print(PrintStream __out)
  97                 throws NullPointerException
  98         {
  99                 if (__out == null)
 100                         throw new NullPointerException("No output stream.");
 101
 102                 this.__init();
 103
 104                 // Print out every project
 105                 Map<String, Project> codeMap = this._codeMap;
 106                 synchronized (this)
 107                 {
 108                         for (Map.Entry<String, Project> e : codeMap.entrySet())
 109                                 __out.printf("%2s: %s%n", e.getKey(), e.getValue().getName());
 110                 }
 111         }
 112
 113         /**
 114          * Returns the project which owns the given code.
 115          *
 116          * @param __code The code to obtain.
 117          * @throws NoSuchElementException If no such project exists.
 118          * @return The resulting
 119          */
 120         public final Project projectByCode(String __code)
 121                 throws NoSuchElementException
 122         {
 123                 this.__init();
 124
 125                 // Search
 126                 Map<String, Project> codeMap = this._codeMap;
 127                 synchronized (this)
 128                 {
 129                         Project rv = codeMap.get(__code);
 130                         if (rv == null)
 131                                 throw new IllegalArgumentException(
 132                                         String.format("No project for code %s", __code));
 133
 134                         return rv;
 135                 }
 136         }
 137
 138         /**
 139          * Initializes the code map.
 140          *
 141          * @since 2020/02/22
 142          */
 143         private void __init()
 144         {
 145                 Map<String, Project> codeMap = this._codeMap;
 146                 Set<String> unclaimed = this._unclaimed;
 147                 synchronized (this)
 148                 {
 149                         // Already has been loaded?
 150                         if (!codeMap.isEmpty())
 151                                 return;
 152
 153                         // Add all projects found to the list
 154                         for (Project sub : this.project.getAllprojects())
 155                         {
 156                                 // Only choose SquirrelJME projects
 157                                 SquirrelJMEPluginConfiguration config = sub.getExtensions()
 158                                         .<SquirrelJMEPluginConfiguration>findByType(
 159                                                 SquirrelJMEPluginConfiguration.class);
 160                                 if (config == null)
 161                                         continue;
 162
 163                                 String code = config.javaDocErrorCode;
 164                                 if (code == null)
 165                                 {
 166                                         System.err.printf(
 167                                                 "WARNING: Project %s has no error code.\n",
 168                                                 sub.getName());
 169
 170                                         // Cannot do anything at this point
 171                                         continue;
 172                                 }
 173
 174                                 Project dup = codeMap.put(code.toUpperCase(), sub);
 175                                 if (dup != null)
 176                                         System.err.printf(
 177                                                 "WARNING: Project %s shares error code %s with %s.\n",
 178                                                 sub.getName(), code, dup.getName());
 179
 180                                 unclaimed.remove(code.toUpperCase());
 181                         }
 182                 }
 183         }
 184 }