WidgetHandle.java

/*
** Module   : WidgetHandle.java
** Abstract : Implementation of the builtin class.
**
** Copyright (c) 2019-2021, Golden Code Development Corporation.
**
** -#- -I- --Date-- -------------------------------Description--------------------------------
** 001 CA  20190526 First version, stubs taken by converting the skeleton using FWD.
** 002 CA  20190710 Runtime implementation.
** 003 CA  20191024 Added method support levels and updated the class support level.
** 004 CA  20210221 Fixed 'qualified', 'extent' and 'returns' annotations at the legacy
**                  signature.
**     ME  20211001 Fix toString method, returns unknown if invalid handle.
** 005 CA  20231113 The 'execute' method must be annotated with LegacySignature Type.Execute, and also can be
**                  dropped if is a no-op.
*/

/*
** 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.oo.core;

import com.goldencode.p2j.util.*;
import com.goldencode.p2j.oo.lang.*;

import static com.goldencode.p2j.util.BlockManager.*;
import static com.goldencode.p2j.report.ReportConstants.*;
import static com.goldencode.p2j.util.InternalEntry.Type;

/**
 * Business logic (converted to Java from the 4GL source code
 * in OpenEdge/Core/WidgetHandle.cls).
 */
@LegacyResource(resource = "OpenEdge.Core.WidgetHandle")
@LegacyResourceSupport(supportLvl = CVT_LVL_FULL|RT_LVL_FULL)
public class WidgetHandle
extends BaseObject
implements com.goldencode.p2j.oo.common.support.IhandleHolder
{
   private logical autoDestroy = UndoableFactory.logical();

   private handle value = UndoableFactory.handle();

   @LegacySignature(returns = "LOGICAL", type = Type.GETTER, name = "AutoDestroy")
   @LegacyResourceSupport(supportLvl = CVT_LVL_FULL|RT_LVL_FULL)
   public logical getAutoDestroy()
   {
      return function(this, "AutoDestroy", logical.class, new Block((Body) () -> 
      {
         returnNormal(autoDestroy);
      }));
   }

   @LegacySignature(type = Type.SETTER, name = "AutoDestroy", parameters = 
   {
      @LegacyParameter(name = "var", type = "LOGICAL", mode = "INPUT")
   })
   @LegacyResourceSupport(supportLvl = CVT_LVL_FULL|RT_LVL_FULL)
   public void setAutoDestroy(final logical _var)
   {
      logical var = TypeFactory.initInput(_var);
      
      internalProcedure(this, "AutoDestroy", new Block((Body) () -> 
      {
         autoDestroy.assign(var);
      }));
   }

   @LegacySignature(returns = "HANDLE", type = Type.GETTER, name = "Value")
   @LegacyResourceSupport(supportLvl = CVT_LVL_FULL|RT_LVL_FULL)
   public handle getValue()
   {
      return function(this, "Value", handle.class, new Block((Body) () -> 
      {
         returnNormal(value);
      }));
   }

   @LegacySignature(type = Type.SETTER, name = "Value", parameters = 
   {
      @LegacyParameter(name = "var", type = "HANDLE", mode = "INPUT")
   })
   @LegacyResourceSupport(supportLvl = CVT_LVL_FULL|RT_LVL_FULL)
   public void setValue(final handle _var)
   {
      handle var = TypeFactory.initInput(_var);
      
      internalProcedure(this, "Value", new Block((Body) () -> 
      {
         value.assign(var);
      }));
   }

   @LegacySignature(type = Type.CONSTRUCTOR)
   @LegacyResourceSupport(supportLvl = CVT_LVL_FULL|RT_LVL_FULL)
   public void __core_WidgetHandle_constructor__()
   {
      internalProcedure(this, "__core_WidgetHandle_constructor__", new Block((Body) () -> 
      {
         __lang_BaseObject_constructor__();
         this.autoDestroy.assign(false);
      }));
   }

   @LegacySignature(type = Type.CONSTRUCTOR, parameters = 
   {
      @LegacyParameter(name = "p1", type = "HANDLE", mode = "INPUT")
   })
   @LegacyResourceSupport(supportLvl = CVT_LVL_FULL|RT_LVL_FULL)
   public void __core_WidgetHandle_constructor__(final handle _p1)
   {
      handle p1 = TypeFactory.initInput(_p1);
      
      internalProcedure(this, "__core_WidgetHandle_constructor__", new Block((Body) () -> 
      {
         __lang_BaseObject_constructor__();
         this.value.assign(p1);
         this.autoDestroy.assign(false);
      }));
   }

   @LegacySignature(type = Type.CONSTRUCTOR, parameters = 
   {
      @LegacyParameter(name = "p1", type = "HANDLE", mode = "INPUT"),
      @LegacyParameter(name = "p2", type = "LOGICAL", mode = "INPUT")
   })
   @LegacyResourceSupport(supportLvl = CVT_LVL_FULL|RT_LVL_FULL)
   public void __core_WidgetHandle_constructor__(final handle _p1, final logical _p2)
   {
      handle p1 = TypeFactory.initInput(_p1);
      logical p2 = TypeFactory.initInput(_p2);
      
      internalProcedure(this, "__core_WidgetHandle_constructor__", new Block((Body) () -> 
      {
         __core_WidgetHandle_constructor__();
         this.value.assign(p1);
         this.autoDestroy.assign(p2);
      }));
   }
   
   /**
    * Destructor for this class.  Cleanup/delete any created resources.
    */
   @LegacySignature(type = Type.DESTRUCTOR)
   @LegacyResourceSupport(supportLvl = CVT_LVL_FULL|RT_LVL_FULL)
   public void __core_WidgetHandle_destructor__()
   {
      internalProcedure(this, "__core_WidgetHandle_destructor__", new Block((Body) () -> 
      {
         if (autoDestroy.booleanValue() && !value.isUnknown() && value._isValid())
         {
            HandleOps.delete(value);
         }
      }));
   }

   @LegacySignature(returns = "LOGICAL", type = Type.METHOD, name = "Equals", parameters = 
   {
      @LegacyParameter(name = "p1", type = "OBJECT", qualified = "progress.lang.object", mode = "INPUT")
   })
   @LegacyResourceSupport(supportLvl = CVT_LVL_FULL|RT_LVL_FULL)
   public logical legacyEquals(final object<? extends com.goldencode.p2j.oo.lang._BaseObject_> _p1)
   {
      object<? extends com.goldencode.p2j.oo.lang._BaseObject_> p1 = TypeFactory.initInput(_p1);
      
      return function(this, "Equals", logical.class, new Block((Body) () ->
      {
         if (p1.isUnknown() || !(p1.ref() instanceof WidgetHandle))
         {
            returnNormal(false);
         }
         
         returnNormal(CompareOps.equals(this.value, ((WidgetHandle) p1.ref()).value));
      }));
   }

   @LegacySignature(returns = "CHARACTER", type = Type.METHOD, name = "ToString")
   @LegacyResourceSupport(supportLvl = CVT_LVL_FULL|RT_LVL_FULL)
   public character toLegacyString()
   {
      return function(this, "ToString", character.class, new Block((Body) () ->
      {
         returnNormal(character.valueOf(this.value));
      }));
   }
}