FWD » Core Development » Runtime Infrastructure

** 123 TG  20260924 ASM is a client and server dependency, used for the generated widget config accessors.

// Widget config accessors

// ============================================================================

tasks.register('generateConfigAccessors', JavaExec) {

    dependsOn 'aspectjWeave'

    def outDir = "${layout.buildDirectory.get()}/config-accessors"

    outputs.dir(outDir)

    classpath = files("${layout.buildDirectory.get()}/classes.aop") +

                configurations.fwdAllRuntime +

                configurations.aspectjCompile

    mainClass.set('com.goldencode.p2j.ui.ConfigAccessorGenerator')

    args outDir

    doFirst {

        delete outDir

    }

}

// ============================================================================

    from(tasks.named('generateConfigAccessors'))

    fwdClientServer group: 'org.ow2.asm', name: 'asm', version: '9.8'

** 011 TG  20260925 Configs with a virtual ID are skipped; the config caches its tracking config manager.

      if (WidgetId.virtualWidget(cfg.id))

      {

         // not tracked, see ConfigManager.trackConfig

         return;

      }

      cfg.trackingManager().addDirtyConfig(cfg, field);

** 005 TG  20260925 The layout depth is a mutable per-context counter, read once per join point.

   private static final ContextLocal<int[]> local = new ContextLocal<>()

      protected int[] initialValue() 

         return new int[1];

      int[] layoutDepth = local.get();

      if (layoutDepth[0] == 0)

      layoutDepth[0] += 1;

         layoutDepth[0] -= 1;

      int[] layoutDepth = local.get();

      if (layoutDepth[0] == 0)

      layoutDepth[0] += 1;

         layoutDepth[0] -= 1;

      int layoutDepth = local.get()[0];

      int layoutDepth = local.get()[0];

** 006 TG  20260925 The trackingManager() cache assignment is not a config value change.

           "&& !withincode(* com.goldencode.p2j.ui.WidgetConfig.trackingManager()) " +

** 148 TG  20260925          Server-side batch client thread uses the ContextLocal read cache.

            // this thread stays in the new session's context until it terminates

            ContextLocal.setReadCache(true);

            ContextLocal.setReadCache(false);

      Thread launcher = new ContextLocal.DedicatedThread(runner);

** 049 TG  20260925          get() and isAsyncThread() do not use JVM-wide locks.

   /** The {@link #instance} after it was fully constructed, read without locking by {@link #get}. */

   private static volatile SessionManager published = null;

   private final Set<Thread> asyncThreads = ConcurrentHashMap.newKeySet();

   public static SessionManager get()

      SessionManager sm = published;

      if (sm != null)

      {

         return sm;

      }

      // the instance is created while holding this lock; do not publish it if this thread is the one

      // constructing it

      boolean nested = Thread.holdsLock(SessionManager.class);

      synchronized (SessionManager.class)

      {

         sm = instance;

         if (!nested)

         {

            published = sm;

         }

      }

      return sm;

      asyncThreads.add(thread);

      asyncThreads.remove(thread);

      // checked twice for each call of an in-JVM client, without a JVM-wide lock

      return !asyncThreads.isEmpty() && asyncThreads.contains(thread);

** 031 TG  20260925          Added DedicatedThread, which can use the read cache like conversation threads.

      if (SessionManager.isConversationThread())

      {

         return true;

      }

      Thread t = Thread.currentThread();

      return t instanceof DedicatedThread && ((DedicatedThread) t).readCache;

   }

   /**

    * Enable or disable the read cache for the current thread, which must be a {@link DedicatedThread}.

    * The cache must be enabled only while the thread stays in the same security context.

    * 

    * @param    on

    *           <code>true</code> to enable the read cache.

    */

   public static void setReadCache(boolean on)

   {

      Thread t = Thread.currentThread();

      if (!(t instanceof DedicatedThread))

      {

         throw new IllegalStateException("The read cache can be enabled only on a DedicatedThread.");

      }

      ((DedicatedThread) t).readCache = on;

   }

   /**

    * A thread which is dedicated to a single security context for (a part of) its lifetime, like a

    * conversation thread.  While it is in that context, it can enable the read cache used to optimize

    * {@link ContextLocal#get()}, via {@link ContextLocal#setReadCache}.

    */

   public static class DedicatedThread

   extends Thread

   {

      /** Flag indicating if the read cache is enabled; accessed only by this thread. */

      private boolean readCache = false;

      /**

       * Create a new thread.

       * 

       * @param    target

       *           The code to run.

       */

      public DedicatedThread(Runnable target)

      {

         super(target);

      }

** -#- -I- --Date-- ---------------------------------------Description----------------------------------------

** 025 TG  20260924 Field access via generated ConfigAccessor; added setConfigFields for batched updates.

** 026 TG  20260925 Added setBackupField(s), to apply server-pushed values to a backup config.

** 027 TG  20260925 Added snapshotConfig and firstDifference, used by FrameLayoutCache.

    * Set the widget config fields to the specified values.

    *

    * @param    wid

    *           The widget ID.

    * @param    wcfg

    *           The widget configuration; if this is a down widget, this will be used.

    * @param    fids

    *           The config field ids.

    * @param    values

    *           The new config field values.

    */

   public void setConfigFields(WidgetId wid, WidgetConfig wcfg, Integer[] fids, Object[] values)

   {

      if (!(wid instanceof WidgetDownId))

      {

         wcfg = getActiveConfig(wid);

      }

      WidgetConfigDef wdef = getConfigDef(wid.asInt());

      int[] ids = new int[fids.length];

      for (int i = 0; i < fids.length; i++)

      {

         ids[i] = fids[i];

      }

      setWidgetConfigs(wcfg, wdef, ids, values);

   }

   /**

    * Apply the values of the specified fields, pushed by the server-side, to the backup config of a

    * (non-down) widget, so the backup config reflects what the server-side knows.  Only fields tracked

    * for changed values (immutable types) are applied; the other fields are always sent when dirty.

    *

    * @param    wid

    *           The widget ID.

    * @param    fname

    *           The config field name.

    * @param    value

    *           The value pushed by the server-side.

    */

   public void setBackupField(WidgetId wid, String fname, Object value)

   {

      WidgetConfig backup = (wid instanceof WidgetDownId) ? null : backupConfigs.get(wid);

      if (backup == null)

      {

         return;

      }

      WidgetConfigDef wdef = getConfigDef(wid.asInt());

      Integer fid = wdef.fieldIds.get(fname);

      if (fid != null && wdef.trackChanged[fid])

      {

         // the backup config has no owner, it must not be registered for state synchronization

         super.setWidgetConfig(backup, value, wdef, fid);

      }

   }

   /**

    * Apply the values of the specified fields, pushed by the server-side, to the backup config of a

    * (non-down) widget; see {@link #setBackupField}.

    *

    * @param    wid

    *           The widget ID.

    * @param    fids

    *           The config field ids.

    * @param    values

    *           The values pushed by the server-side.

    */

   public void setBackupFields(WidgetId wid, Integer[] fids, Object[] values)

   {

      WidgetConfig backup = (wid instanceof WidgetDownId) ? null : backupConfigs.get(wid);

      if (backup == null)

      {

         return;

      }

      WidgetConfigDef wdef = getConfigDef(wid.asInt());

      for (int i = 0; i < fids.length; i++)

      {

         int fid = fids[i];

         if (wdef.trackChanged[fid])

         {

            super.setWidgetConfig(backup, values[i], wdef, fid);

         }

      }

   }

   /**

    * Create a copy of the given config, which is not registered anywhere and has no ID.  It is meant

    * for comparisons, see {@link #firstDifference}.

    *

    * @param    cfg

    *           The config to copy.

    *

    * @return   The copy.

    */

   public WidgetConfig snapshotConfig(WidgetConfig cfg)

   {

      WidgetConfig copy = getConfigDef(cfg.cfgClass).newInstance();

      ConfigSyncManager.applyUnregistered(copy, cfg);

      return copy;

   }

   /**

    * Find the first field which has different values in the given configs of the same class.

    *

    * @param    a

    *           The first config.

    * @param    b

    *           The second config.

    * @param    ignored

    *           The names of the fields which are not compared.

    *

    * @return   The name of the first different field, or <code>null</code> if all compared fields have

    *           the same values.

    */

   public String firstDifference(WidgetConfig a, WidgetConfig b, Set<String> ignored)

   {

      if (a.cfgClass != b.cfgClass)

      {

         return "<class>";

      }

      WidgetConfigDef wdef = getConfigDef(a.cfgClass);

      for (int fid = 0; fid < wdef.fieldCount; fid++)

      {

         if (!wdef.accessor.same(a, b, fid))

         {

            String name = wdef.fieldNames.get(fid);

            if (!ignored.contains(name))

            {

               return name;

            }

         }

      }

      return null;

   }

   /**

            if (!wdef.accessor.same(cfg, backup, fid))

   /**

    * Set the specified widget configuration fields to the given values.

    *

    * @param    cfg

    *           The widget configuration to be updated.

    * @param    wdef

    *           The definition of the widget configuration.

    * @param    fids

    *           The IDs of the changed fields.

    * @param    values

    *           The new field values.

    */

   @Override

   <T extends WidgetConfig> void setWidgetConfigs(T               cfg,

                                                  WidgetConfigDef wdef,

                                                  int[]           fids,

                                                  Object[]        values)

   {

      ConfigSyncManager.registerConfig(null, cfg);

      super.setWidgetConfigs(cfg, wdef, fids, values);

   }

/*

** Module   : ConfigAccessor.java

** Abstract : Indexed access to the tracked fields of a widget configuration class.

**

** Copyright (c) 2026, Golden Code Development Corporation.

**

** -#- -I- --Date-- ---------------------------------------Description----------------------------------------

** 001 TG  20260924 Created initial version.

*/

/*

** This program is free software: you can redistribute it and/or modify

** it under the terms of the GNU Affero General Public License as

** published by the Free Software Foundation, either version 3 of the

** License, or (at your option) any later version.

**

** This program 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 Affero General Public License for more details.

**

** You may find a copy of the GNU Affero GPL version 3 at the following

** location: https://www.gnu.org/licenses/agpl-3.0.en.html

** 

** Additional terms under GNU Affero GPL version 3 section 7:

** 

**   Under Section 7 of the GNU Affero GPL version 3, the following additional

**   terms apply to the works covered under the License.  These additional terms

**   are non-permissive additional terms allowed under Section 7 of the GNU

**   Affero GPL version 3 and may not be removed by you.

** 

**   0. Attribution Requirement.

** 

**     You must preserve all legal notices or author attributions in the covered

**     work or Appropriate Legal Notices displayed by works containing the covered

**     work.  You may not remove from the covered work any author or developer

**     credit already included within the covered work.

** 

**   1. No License To Use Trademarks.

** 

**     This license does not grant any license or rights to use the trademarks

**     Golden Code, FWD, any Golden Code or FWD logo, or any other trademarks

**     of Golden Code Development Corporation. You are not authorized to use the

**     name Golden Code, FWD, or the names of any author or contributor, for

**     publicity purposes without written authorization.

** 

**   2. No Misrepresentation of Affiliation.

** 

**     You may not represent yourself as Golden Code Development Corporation or FWD.

** 

**     You may not represent yourself for publicity purposes as associated with

**     Golden Code Development Corporation, FWD, or any author or contributor to

**     the covered work, without written authorization.

** 

**   3. No Misrepresentation of Source or Origin.

** 

**     You may not represent the covered work as solely your work.  All modified

**     versions of the covered work must be marked in a reasonable way to make it

**     clear that the modified work is not originating from Golden Code Development

**     Corporation or FWD.  All modified versions must contain the notices of

**     attribution required in this license.

*/

package com.goldencode.p2j.ui;

import java.util.*;

/**

 * Provides access to the tracked fields of a single {@link WidgetConfig} class, using the field IDs

 * defined by the associated {@link WidgetConfigDef}.

 * <p>

 * Implementations are generated by {@link ConfigAccessorGenerator}, one class for each widget

 * configuration class, so that each field access compiles to a direct field instruction.  The

 * accessors of the built-in configuration classes are generated at build time; see

 * {@link ConfigAccessorFactory}.

 * The bulk operations run their loop inside the generated class, so that the per-field calls are

 * bound to a single receiver type.

 * <p>

 * The public static helpers are invoked by the generated code and reproduce the conversions

 * applied by a {@link java.lang.invoke.VarHandle} invoked with {@code Object} values, and the

 * equality applied by {@link Objects#equals(Object, Object)} on boxed values.

 */

public abstract class ConfigAccessor

{

   /**

    * Constructor for the sub-classes.

    */

   protected ConfigAccessor()

   {

   }

   /**

    * Unbox a value assigned to a {@code boolean} field.

    *

    * @param    v

    *           The value.

    *

    * @return   See above.

    *

    * @throws   NullPointerException

    *           If the value is {@code null}.

    * @throws   ClassCastException

    *           If the value can not be converted.

    */

   public static boolean unboxBoolean(Object v)

   {

      if (v instanceof Boolean)

      {

         return ((Boolean) v).booleanValue();

      }

      throw wrongType(v, boolean.class);

   }

   /**

    * Unbox a value assigned to a {@code byte} field.

    *

    * @param    v

    *           The value.

    *

    * @return   See above.

    *

    * @throws   NullPointerException

    *           If the value is {@code null}.

    * @throws   ClassCastException

    *           If the value can not be converted.

    */

   public static byte unboxByte(Object v)

   {

      if (v instanceof Byte)

      {

         return ((Byte) v).byteValue();

      }

      throw wrongType(v, byte.class);

   }

   /**

    * Unbox a value assigned to a {@code short} field, allowing primitive widening.

    *

    * @param    v

    *           The value.

    *

    * @return   See above.

    *

    * @throws   NullPointerException

    *           If the value is {@code null}.

    * @throws   ClassCastException

    *           If the value can not be converted.

    */

   public static short unboxShort(Object v)

   {

      if (v instanceof Short)

      {

         return ((Short) v).shortValue();

      }

      if (v instanceof Byte)

      {

         return ((Byte) v).byteValue();

      }

      throw wrongType(v, short.class);

   }

   /**

    * Unbox a value assigned to a {@code char} field.

    *

    * @param    v

    *           The value.

    *

    * @return   See above.

    *

    * @throws   NullPointerException

    *           If the value is {@code null}.

    * @throws   ClassCastException

    *           If the value can not be converted.

    */

   public static char unboxChar(Object v)

   {

      if (v instanceof Character)

      {

         return ((Character) v).charValue();

      }

      throw wrongType(v, char.class);

   }

   /**

    * Unbox a value assigned to an {@code int} field, allowing primitive widening.

    *

    * @param    v

    *           The value.

    *

    * @return   See above.

    *

    * @throws   NullPointerException

    *           If the value is {@code null}.

    * @throws   ClassCastException

    *           If the value can not be converted.

    */

   public static int unboxInt(Object v)

   {

      if (v instanceof Integer)

      {

         return ((Integer) v).intValue();

      }

      if (v instanceof Short || v instanceof Byte)

      {

         return ((Number) v).intValue();

      }

      if (v instanceof Character)

      {

         return ((Character) v).charValue();

      }

      throw wrongType(v, int.class);

   }

   /**

    * Unbox a value assigned to a {@code long} field, allowing primitive widening.

    *

    * @param    v

    *           The value.

    *

    * @return   See above.

    *

    * @throws   NullPointerException

    *           If the value is {@code null}.

    * @throws   ClassCastException

    *           If the value can not be converted.

    */

   public static long unboxLong(Object v)

   {

      if (v instanceof Long)

      {

         return ((Long) v).longValue();

      }

      if (v instanceof Integer || v instanceof Short || v instanceof Byte)

      {

         return ((Number) v).longValue();

      }

      if (v instanceof Character)

      {

         return ((Character) v).charValue();

      }

      throw wrongType(v, long.class);

   }

   /**

    * Unbox a value assigned to a {@code float} field, allowing primitive widening.

    *

    * @param    v

    *           The value.

    *

    * @return   See above.

    *

    * @throws   NullPointerException

    *           If the value is {@code null}.

    * @throws   ClassCastException

    *           If the value can not be converted.

    */

   public static float unboxFloat(Object v)

   {

      if (v instanceof Float)

      {

         return ((Float) v).floatValue();

      }

      if (v instanceof Long || v instanceof Integer || v instanceof Short || v instanceof Byte)

      {

         return ((Number) v).floatValue();

      }

      if (v instanceof Character)

      {

         return ((Character) v).charValue();

      }

      throw wrongType(v, float.class);

   }

   /**

    * Unbox a value assigned to a {@code double} field, allowing primitive widening.

    *

    * @param    v

    *           The value.

    *

    * @return   See above.

    *

    * @throws   NullPointerException

    *           If the value is {@code null}.

    * @throws   ClassCastException

    *           If the value can not be converted.

    */

   public static double unboxDouble(Object v)

   {

      if (v instanceof Double)

      {

         return ((Double) v).doubleValue();

      }

      if (v instanceof Float   ||

          v instanceof Long    ||

          v instanceof Integer ||

          v instanceof Short   ||

          v instanceof Byte)

      {

         return ((Number) v).doubleValue();

      }

      if (v instanceof Character)

      {

         return ((Character) v).charValue();

      }

      throw wrongType(v, double.class);

   }

   /**

    * Compare two {@code int} compatible field values.

    *

    * @param    a

    *           The first value.

    * @param    b

    *           The second value.

    *

    * @return   {@code true} if the values are equal.

    */

   public static boolean same(int a, int b)

   {

      return a == b;

   }

   /**

    * Compare two {@code long} field values.

    *

    * @param    a

    *           The first value.

    * @param    b

    *           The second value.

    *

    * @return   {@code true} if the values are equal.

    */

   public static boolean same(long a, long b)

   {

      return a == b;

   }

   /**

    * Compare two {@code float} field values, as {@link Float#equals(Object)} does.

    *

    * @param    a

    *           The first value.

    * @param    b

    *           The second value.

    *

    * @return   {@code true} if the values are equal.

    */

   public static boolean same(float a, float b)

   {

      return Float.floatToIntBits(a) == Float.floatToIntBits(b);

   }

   /**

    * Compare two {@code double} field values, as {@link Double#equals(Object)} does.

    *

    * @param    a

    *           The first value.

    * @param    b

    *           The second value.

    *

    * @return   {@code true} if the values are equal.

    */

   public static boolean same(double a, double b)

   {

      return Double.doubleToLongBits(a) == Double.doubleToLongBits(b);

   }

   /**

    * Compare two reference field values.

    *

    * @param    a

    *           The first value.

    * @param    b

    *           The second value.

    *

    * @return   {@code true} if the values are equal.

    */

   public static boolean same(Object a, Object b)

   {

      return Objects.equals(a, b);

   }

   /**

    * Create the exception thrown for a field ID which is not defined by the config class.

    *

    * @param    fid

    *           The field ID.

    *

    * @return   See above.

    */

   public static RuntimeException unknownField(int fid)

   {

      return new IllegalArgumentException("Unknown widget config field ID " + fid);

   }

   /**

    * Get the fingerprint of the fields this accessor was generated for, as computed by

    * {@link ConfigAccessorFactory#fingerprint}.

    *

    * @return   See above.

    */

   public abstract long fingerprint();

   /**

    * Get the value of a field.

    *

    * @param    cfg

    *           The widget config.

    * @param    fid

    *           The field ID.

    *

    * @return   The field value, boxed if the field is primitive.

    */

   public abstract Object get(WidgetConfig cfg, int fid);

   /**

    * Set the value of a field.

    *

    * @param    cfg

    *           The widget config.

    * @param    fid

    *           The field ID.

    * @param    value

    *           The new value, boxed if the field is primitive.

    */

   public abstract void set(WidgetConfig cfg, int fid, Object value);

   /**

    * Check if a field has the same value in two configs.

    *

    * @param    a

    *           The first widget config.

    * @param    b

    *           The second widget config.

    * @param    fid

    *           The field ID.

    *

    * @return   {@code true} if the values are equal.

    */

   public abstract boolean same(WidgetConfig a, WidgetConfig b, int fid);

   /**

    * Collect the values of the given fields from the active config.  A field which is tracked

    * for changed value is skipped when its value is the same in the backup config.

    *

    * @param    active

    *           The active widget config.

    * @param    backup

    *           The backup widget config.

    * @param    fids

    *           The IDs of the candidate fields.

    * @param    count

    *           The number of candidate fields in {@code fids}.

    * @param    track

    *           Flags indicating the fields tracked for changed value, indexed by field ID, or

    *           {@code null} to collect all candidate fields.

    * @param    outFids

    *           Receives the IDs of the collected fields.

    * @param    outVals

    *           Receives the values of the collected fields.

    *

    * @return   The number of collected fields.

    */

   public abstract int collectChanges(WidgetConfig active,

                                      WidgetConfig backup,

                                      int[]        fids,

                                      int          count,

                                      boolean[]    track,

                                      int[]        outFids,

                                      Object[]     outVals);

   /**

    * Set the values of the given fields.

    *

    * @param    cfg

    *           The widget config.

    * @param    fids

    *           The field IDs.

    * @param    values

    *           The new values, boxed for primitive fields.

    * @param    count

    *           The number of fields to set.

    */

   public abstract void applyUpdates(WidgetConfig cfg, int[] fids, Object[] values, int count);

   /**

    * Create the exception thrown when a value can not be assigned to a primitive field.

    *

    * @param    v

    *           The value.

    * @param    type

    *           The primitive field type.

    *

    * @return   See above.

    *

    * @throws   NullPointerException

    *           If the value is {@code null}.

    */

   private static RuntimeException wrongType(Object v, Class<?> type)

   {

      if (v == null)

      {

         throw new NullPointerException("Can not assign null to a " + type.getName() + " field");

      }

      return new ClassCastException("Cannot convert " + v.getClass().getName() + " to " + type.getName());

   }

}

/*

** Module   : ConfigAccessorFactory.java

** Abstract : Resolution of the prebuilt or runtime generated widget configuration field accessors.

**

** Copyright (c) 2026, Golden Code Development Corporation.

**

** -#- -I- --Date-- ---------------------------------------Description----------------------------------------

** 001 TG  20260924 Created initial version.

*/

/*

** This program is free software: you can redistribute it and/or modify

** it under the terms of the GNU Affero General Public License as

** published by the Free Software Foundation, either version 3 of the

** License, or (at your option) any later version.

**

** This program 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 Affero General Public License for more details.

**

** You may find a copy of the GNU Affero GPL version 3 at the following

** location: https://www.gnu.org/licenses/agpl-3.0.en.html

** 

** Additional terms under GNU Affero GPL version 3 section 7:

** 

**   Under Section 7 of the GNU Affero GPL version 3, the following additional

**   terms apply to the works covered under the License.  These additional terms

**   are non-permissive additional terms allowed under Section 7 of the GNU

**   Affero GPL version 3 and may not be removed by you.

** 

**   0. Attribution Requirement.

** 

**     You must preserve all legal notices or author attributions in the covered

**     work or Appropriate Legal Notices displayed by works containing the covered

**     work.  You may not remove from the covered work any author or developer

**     credit already included within the covered work.

** 

**   1. No License To Use Trademarks.

** 

**     This license does not grant any license or rights to use the trademarks

**     Golden Code, FWD, any Golden Code or FWD logo, or any other trademarks

**     of Golden Code Development Corporation. You are not authorized to use the

**     name Golden Code, FWD, or the names of any author or contributor, for

**     publicity purposes without written authorization.

** 

**   2. No Misrepresentation of Affiliation.

** 

**     You may not represent yourself as Golden Code Development Corporation or FWD.

** 

**     You may not represent yourself for publicity purposes as associated with

**     Golden Code Development Corporation, FWD, or any author or contributor to

**     the covered work, without written authorization.

** 

**   3. No Misrepresentation of Source or Origin.

** 

**     You may not represent the covered work as solely your work.  All modified

**     versions of the covered work must be marked in a reasonable way to make it

**     clear that the modified work is not originating from Golden Code Development

**     Corporation or FWD.  All modified versions must contain the notices of

**     attribution required in this license.

*/

package com.goldencode.p2j.ui;

import java.lang.reflect.*;

import java.nio.charset.*;

import com.goldencode.p2j.util.logging.*;

/**

 * Resolves the {@link ConfigAccessor} for a widget configuration class.

 * <p>

 * The accessors of the built-in configuration classes are generated at build time by

 * {@link ConfigAccessorGenerator} and packaged in the FWD jar, named with the

 * {@link #PREBUILT_PREFIX} prefix followed by the configuration class name.  Being regular classes

 * loaded from the jar, they can be included in an AppCDS archive.  A prebuilt accessor is used only

 * if its {@link ConfigAccessor#fingerprint() fingerprint} matches the fields of the configuration

 * class; otherwise, and for the configuration classes without a prebuilt accessor, the accessor is

 * generated at runtime as a hidden class.

 * <p>

 * This class does not reference the bytecode generation library, so it is loaded only when an

 * accessor needs to be generated at runtime.

 */

final class ConfigAccessorFactory

{

   /** The class name prefix of the prebuilt accessors. */

   static final String PREBUILT_PREFIX = "com.goldencode.p2j.ui.ConfigAccessors$";

   /** Logger */

   private static final CentralLogger LOG = CentralLogger.get(ConfigAccessorFactory.class.getSimpleName());

   /** The package of the built-in widget configuration classes. */

   private static final String CONFIG_PACKAGE = WidgetConfig.class.getPackageName();

   /**

    * Private constructor, this class has only static members.

    */

   private ConfigAccessorFactory()

   {

   }

   /**

    * Get the accessor for the given widget configuration class.

    *

    * @param    cfgCls

    *           The widget configuration class.

    * @param    fields

    *           The tracked fields, indexed by field ID.

    *

    * @return   See above.

    */

   static ConfigAccessor create(Class<? extends WidgetConfig> cfgCls, Field[] fields)

   {

      long           fp  = fingerprint(fields);

      ConfigAccessor acc = loadPrebuilt(cfgCls);

      if (acc != null)

      {

         if (acc.fingerprint() == fp)

         {

            return acc;

         }

         LOG.warning("The prebuilt config accessor for " + cfgCls.getName() +

                     " does not match the config fields, generating it at runtime.");

      }

      return ConfigAccessorGenerator.define(cfgCls, fields, fp);

   }

   /**

    * Get the name of the prebuilt accessor of the given widget configuration class.

    *

    * @param    cfgCls

    *           The widget configuration class.

    *

    * @return   The class name, or {@code null} if the class is not a built-in configuration class.

    */

   static String prebuiltName(Class<?> cfgCls)

   {

      if (!CONFIG_PACKAGE.equals(cfgCls.getPackageName()))

      {

         return null;

      }

      return PREBUILT_PREFIX + cfgCls.getName().substring(CONFIG_PACKAGE.length() + 1);

   }

   /**

    * Compute the fingerprint of the tracked fields: a 64-bit FNV-1a hash of the field names and

    * type descriptors, in field ID order.

    *

    * @param    fields

    *           The tracked fields, indexed by field ID.

    *

    * @return   See above.

    */

   static long fingerprint(Field[] fields)

   {

      long hash = 0xcbf29ce484222325L;

      for (Field f : fields)

      {

         String sig = f.getName() + ':' + f.getType().descriptorString() + ';';

         for (byte b : sig.getBytes(StandardCharsets.UTF_8))

         {

            hash ^= (b & 0xff);

            hash *= 0x100000001b3L;

         }

      }

      return hash;

   }

   /**

    * Load and instantiate the prebuilt accessor of the given widget configuration class.

    *

    * @param    cfgCls

    *           The widget configuration class.

    *

    * @return   The accessor, or {@code null} if there is no prebuilt accessor for the class.

    */

   private static ConfigAccessor loadPrebuilt(Class<? extends WidgetConfig> cfgCls)

   {

      String name = prebuiltName(cfgCls);

      if (name == null)

      {

         return null;

      }

      Class<?> cls;

      try

      {

         cls = Class.forName(name, true, ConfigAccessor.class.getClassLoader());

      }

      catch (ClassNotFoundException e)

      {

         return null;

      }

      try

      {

         return (ConfigAccessor) cls.getDeclaredConstructor().newInstance();

      }

      catch (ReflectiveOperationException e)

      {

         throw new IllegalStateException("Could not instantiate the config accessor " + name, e);

      }

   }

}

/*

** Module   : ConfigAccessorGenerator.java

** Abstract : Bytecode generation of the widget configuration field accessors.

**

** Copyright (c) 2026, Golden Code Development Corporation.

**

** -#- -I- --Date-- ---------------------------------------Description----------------------------------------

** 001 TG  20260924 Created initial version.

*/

/*

** This program is free software: you can redistribute it and/or modify

** it under the terms of the GNU Affero General Public License as

** published by the Free Software Foundation, either version 3 of the

** License, or (at your option) any later version.

**

** This program 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 Affero General Public License for more details.

**

** You may find a copy of the GNU Affero GPL version 3 at the following

** location: https://www.gnu.org/licenses/agpl-3.0.en.html

** 

** Additional terms under GNU Affero GPL version 3 section 7:

** 

**   Under Section 7 of the GNU Affero GPL version 3, the following additional

**   terms apply to the works covered under the License.  These additional terms

**   are non-permissive additional terms allowed under Section 7 of the GNU

**   Affero GPL version 3 and may not be removed by you.

** 

**   0. Attribution Requirement.

** 

**     You must preserve all legal notices or author attributions in the covered

**     work or Appropriate Legal Notices displayed by works containing the covered

**     work.  You may not remove from the covered work any author or developer

**     credit already included within the covered work.

** 

**   1. No License To Use Trademarks.

** 

**     This license does not grant any license or rights to use the trademarks

**     Golden Code, FWD, any Golden Code or FWD logo, or any other trademarks

**     of Golden Code Development Corporation. You are not authorized to use the

**     name Golden Code, FWD, or the names of any author or contributor, for

**     publicity purposes without written authorization.

** 

**   2. No Misrepresentation of Affiliation.

** 

**     You may not represent yourself as Golden Code Development Corporation or FWD.

** 

**     You may not represent yourself for publicity purposes as associated with

**     Golden Code Development Corporation, FWD, or any author or contributor to

**     the covered work, without written authorization.

** 

**   3. No Misrepresentation of Source or Origin.

** 

**     You may not represent the covered work as solely your work.  All modified

**     versions of the covered work must be marked in a reasonable way to make it

**     clear that the modified work is not originating from Golden Code Development

**     Corporation or FWD.  All modified versions must contain the notices of

**     attribution required in this license.

*/

package com.goldencode.p2j.ui;

import java.io.*;

import java.lang.invoke.*;

import java.lang.reflect.*;

import java.nio.file.*;

import java.util.*;

import org.objectweb.asm.*;

import org.objectweb.asm.Type;

/**

 * Generates the bytecode of the {@link ConfigAccessor} for a widget configuration class.

 * <p>

 * Each operation dispatches the field ID with a {@code tableswitch} to a direct {@code getfield} or

 * {@code putfield} instruction, and the bulk operations invoke the per-field operations of the same

 * final class, so the JIT can compile them without any dynamic dispatch.

 * <p>

 * The accessors of the {@link ConfigManager#CONFIG_CLASSES built-in configuration classes} are

 * generated at build time by {@link #main}, as regular classes packaged in the FWD jar, so they

 * can be included in an AppCDS archive.  The accessors of any other configuration class (external

 * widgets) are {@link #define defined} at runtime as hidden classes.

 */

final class ConfigAccessorGenerator

{

   /** Internal name of the {@link ConfigAccessor} class. */

   private static final String ACCESSOR = Type.getInternalName(ConfigAccessor.class);

   /** Descriptor of the {@link ConfigAccessor#get} method. */

   private static final String GET_DESC =

      "(Lcom/goldencode/p2j/ui/WidgetConfig;I)Ljava/lang/Object;";

   /** Descriptor of the {@link ConfigAccessor#set} method. */

   private static final String SET_DESC =

      "(Lcom/goldencode/p2j/ui/WidgetConfig;ILjava/lang/Object;)V";

   /** Descriptor of the {@link ConfigAccessor#same(WidgetConfig, WidgetConfig, int)} method. */

   private static final String SAME_DESC =

      "(Lcom/goldencode/p2j/ui/WidgetConfig;Lcom/goldencode/p2j/ui/WidgetConfig;I)Z";

   /** Descriptor of the {@link ConfigAccessor#collectChanges} method. */

   private static final String COLLECT_DESC =

      "(Lcom/goldencode/p2j/ui/WidgetConfig;Lcom/goldencode/p2j/ui/WidgetConfig;[II[Z[I[Ljava/lang/Object;)I";