LegacyStack.java

/*
** Module   : LegacyStack.java
** Abstract : Implementation of the builtin class.
**
** Copyright (c) 2019-2023, Golden Code Development Corporation.
**
** -#- -I- --Date-- ---------------------------------------Description----------------------------------------
** 001 ME  20210908 First version, stubs taken by converting the skeleton using FWD.
**     CA  20220513 Renamed _BaseObject_.clone() to legacyClone(), as it can be overriden by sub-classes and
**                  the access mode may collide with the Java's Object.clone().
** 002 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.collections;

import com.goldencode.p2j.util.*;

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

import com.goldencode.p2j.oo.lang.BaseObject;
import com.goldencode.p2j.security.ContextLocal;

/**
 * Business logic (converted to Java from the 4GL source code
 * in OpenEdge/Core/Collections/Stack.cls).
 */
@LegacyResource(resource = "OpenEdge.Core.Collections.Stack")
@LegacyResourceSupport(supportLvl = CVT_LVL_PARTIAL|RT_LVL_STUB)
public abstract class LegacyStack
extends BaseObject
{
   @LegacySignature(type = Type.VARIABLE, name = "DefaultStackDepth")
   @LoadLegacyClass
   public static ContextLocal<integer> defaultStackDepth = new ContextLocal<integer>()
   {
      protected integer initialValue()
      {
         return TypeFactory.integer();
      }
   };

   @LegacySignature(type = Type.PROPERTY, name = "AutoExpand")
   private logical autoExpand = TypeFactory.logical();

   @LegacySignature(type = Type.PROPERTY, name = "DiscardOnShrink")
   private logical discardOnShrink = TypeFactory.logical();

   @LegacySignature(type = Type.PROPERTY, name = "Depth")
   private integer depth = TypeFactory.integer();

   @LegacySignature(type = Type.PROPERTY, name = "Size")
   private integer size = TypeFactory.integer();

   @LegacySignature(type = Type.CONSTRUCTOR, parameters = 
   {
      @LegacyParameter(name = "poArray", type = "OBJECT", extent = -1, qualified = "progress.lang.object", mode = "INPUT")
   })
   @LegacyResourceSupport(supportLvl = CVT_LVL_PARTIAL|RT_LVL_STUB)
   protected void __core_collections_LegacyStack_constructor__(final object<? extends com.goldencode.p2j.oo.lang._BaseObject_>[] _poArray)
   {
      object<? extends com.goldencode.p2j.oo.lang._BaseObject_>[] poArray[] = new object[][]
      {
         TypeFactory.initInput(_poArray)
      };
      
      internalProcedure(LegacyStack.class, this, "__core_collections_LegacyStack_constructor__", new Block((Body) () -> 
      {
         __lang_BaseObject_constructor__();
      }));
   }

   @LegacySignature(type = Type.CONSTRUCTOR, parameters = 
   {
      @LegacyParameter(name = "pcArray", type = "CHARACTER", extent = -1, mode = "INPUT")
   })
   @LegacyResourceSupport(supportLvl = CVT_LVL_PARTIAL|RT_LVL_STUB)
   protected void __core_collections_LegacyStack_constructor__(final character[] _pcArray)
   {
      character[] pcArray[] = 
      {
         TypeFactory.initInput(_pcArray)
      };
      
      internalProcedure(LegacyStack.class, this, "__core_collections_LegacyStack_constructor__", new Block((Body) () -> 
      {
         __lang_BaseObject_constructor__();
      }));
   }

   @LegacySignature(type = Type.CONSTRUCTOR, parameters = 
   {
      @LegacyParameter(name = "piDepth", type = "INTEGER", mode = "INPUT")
   })
   @LegacyResourceSupport(supportLvl = CVT_LVL_PARTIAL|RT_LVL_STUB)
   public void __core_collections_LegacyStack_constructor__(final integer _piDepth)
   {
      integer piDepth = TypeFactory.initInput(_piDepth);
      
      internalProcedure(LegacyStack.class, this, "__core_collections_LegacyStack_constructor__", new Block((Body) () -> 
      {
         __lang_BaseObject_constructor__();
      }));
   }

   @LegacySignature(type = Type.CONSTRUCTOR)
   @LegacyResourceSupport(supportLvl = CVT_LVL_PARTIAL|RT_LVL_STUB)
   public void __core_collections_LegacyStack_constructor__()
   {
      internalProcedure(LegacyStack.class, this, "__core_collections_LegacyStack_constructor__", new Block((Body) () -> 
      {
         __lang_BaseObject_constructor__();
      }));
   }

   @LegacySignature(type = Type.GETTER, name = "AutoExpand", returns = "LOGICAL")
   @LegacyResourceSupport(supportLvl = CVT_LVL_PARTIAL|RT_LVL_STUB)
   public logical getAutoExpand()
   {
      return function(LegacyStack.class, this, "AutoExpand", logical.class, new Block((Body) () -> 
      {
         returnNormal(autoExpand);
      }));
   }

   @LegacySignature(type = Type.SETTER, name = "AutoExpand", parameters = 
   {
      @LegacyParameter(name = "var", type = "LOGICAL", mode = "INPUT")
   })
   @LegacyResourceSupport(supportLvl = CVT_LVL_PARTIAL|RT_LVL_STUB)
   public void setAutoExpand(final logical _var)
   {
      logical var = TypeFactory.initInput(_var);
      
      internalProcedure(LegacyStack.class, this, "AutoExpand", new Block((Body) () -> 
      {
         autoExpand.assign(var);
      }));
   }

   @LegacySignature(type = Type.GETTER, name = "DiscardOnShrink", returns = "LOGICAL")
   @LegacyResourceSupport(supportLvl = CVT_LVL_PARTIAL|RT_LVL_STUB)
   public logical getDiscardOnShrink()
   {
      return function(LegacyStack.class, this, "DiscardOnShrink", logical.class, new Block((Body) () -> 
      {
         returnNormal(discardOnShrink);
      }));
   }

   @LegacySignature(type = Type.SETTER, name = "DiscardOnShrink", parameters = 
   {
      @LegacyParameter(name = "var", type = "LOGICAL", mode = "INPUT")
   })
   @LegacyResourceSupport(supportLvl = CVT_LVL_PARTIAL|RT_LVL_STUB)
   public void setDiscardOnShrink(final logical _var)
   {
      logical var = TypeFactory.initInput(_var);
      
      internalProcedure(LegacyStack.class, this, "DiscardOnShrink", new Block((Body) () -> 
      {
         discardOnShrink.assign(var);
      }));
   }

   @LegacySignature(type = Type.GETTER, name = "Depth", returns = "INTEGER")
   @LegacyResourceSupport(supportLvl = CVT_LVL_PARTIAL|RT_LVL_STUB)
   public integer getDepth()
   {
      return function(LegacyStack.class, this, "Depth", integer.class, new Block((Body) () -> 
      {
         returnNormal(depth);
      }));
   }

   @LegacySignature(type = Type.SETTER, name = "Depth", parameters = 
   {
      @LegacyParameter(name = "var", type = "INTEGER", mode = "INPUT")
   })
   @LegacyResourceSupport(supportLvl = CVT_LVL_PARTIAL|RT_LVL_STUB)
   public void setDepth(final integer _var)
   {
      integer var = TypeFactory.initInput(_var);
      
      internalProcedure(LegacyStack.class, this, "Depth", new Block((Body) () -> 
      {
         depth.assign(var);
      }));
   }

   @LegacySignature(type = Type.GETTER, name = "Size", returns = "INTEGER")
   @LegacyResourceSupport(supportLvl = CVT_LVL_PARTIAL|RT_LVL_STUB)
   public integer getSize()
   {
      return function(LegacyStack.class, this, "Size", integer.class, new Block((Body) () -> 
      {
         returnNormal(size);
      }));
   }

   @LegacySignature(type = Type.SETTER, name = "Size", parameters = 
   {
      @LegacyParameter(name = "var", type = "INTEGER", mode = "INPUT")
   })
   @LegacyResourceSupport(supportLvl = CVT_LVL_PARTIAL|RT_LVL_STUB)
   protected void setSize(final integer _var)
   {
      integer var = TypeFactory.initInput(_var);
      
      internalProcedure(LegacyStack.class, this, "Size", new Block((Body) () -> 
      {
         size.assign(var);
      }));
   }

   @LegacySignature(type = Type.METHOD, name = "ObjectPush", parameters = 
   {
      @LegacyParameter(name = "poValue", type = "OBJECT", qualified = "progress.lang.object", mode = "INPUT")
   })
   @LegacyResourceSupport(supportLvl = CVT_LVL_PARTIAL|RT_LVL_STUB)
   protected void objectPush(final object<? extends com.goldencode.p2j.oo.lang._BaseObject_> _poValue)
   {
      object<? extends com.goldencode.p2j.oo.lang._BaseObject_> poValue = TypeFactory.initInput(_poValue);
      
      internalProcedure(LegacyStack.class, this, "ObjectPush", new Block());
   }

   @LegacySignature(type = Type.METHOD, name = "ObjectPeek", returns = "OBJECT", qualified = "progress.lang.object")
   @LegacyResourceSupport(supportLvl = CVT_LVL_PARTIAL|RT_LVL_STUB)
   protected object<? extends com.goldencode.p2j.oo.lang._BaseObject_> objectPeek()
   {
      return function(LegacyStack.class, this, "ObjectPeek", object.class, new Block());
   }

   @LegacySignature(type = Type.METHOD, name = "ObjectPop", returns = "OBJECT", qualified = "progress.lang.object")
   @LegacyResourceSupport(supportLvl = CVT_LVL_PARTIAL|RT_LVL_STUB)
   protected object<? extends com.goldencode.p2j.oo.lang._BaseObject_> objectPop()
   {
      return function(LegacyStack.class, this, "ObjectPop", object.class, new Block());
   }

   @LegacySignature(type = Type.METHOD, name = "PrimitivePush", parameters = 
   {
      @LegacyParameter(name = "pcValue", type = "CHARACTER", mode = "INPUT")
   })
   @LegacyResourceSupport(supportLvl = CVT_LVL_PARTIAL|RT_LVL_STUB)
   protected void primitivePush(final character _pcValue)
   {
      character pcValue = TypeFactory.initInput(_pcValue);
      
      internalProcedure(LegacyStack.class, this, "PrimitivePush", new Block());
   }

   @LegacySignature(type = Type.METHOD, name = "PrimitivePeek", returns = "CHARACTER")
   @LegacyResourceSupport(supportLvl = CVT_LVL_PARTIAL|RT_LVL_STUB)
   protected character primitivePeek()
   {
      return function(LegacyStack.class, this, "PrimitivePeek", character.class, new Block());
   }

   @LegacySignature(type = Type.METHOD, name = "PrimitivePop", returns = "CHARACTER")
   @LegacyResourceSupport(supportLvl = CVT_LVL_PARTIAL|RT_LVL_STUB)
   protected character primitivePop()
   {
      return function(LegacyStack.class, this, "PrimitivePop", character.class, new Block());
   }

   @LegacySignature(type = Type.METHOD, name = "Swap", parameters = 
   {
      @LegacyParameter(name = "piFromPos", type = "INTEGER", mode = "INPUT"),
      @LegacyParameter(name = "piToPos", type = "INTEGER", mode = "INPUT")
   })
   @LegacyResourceSupport(supportLvl = CVT_LVL_PARTIAL|RT_LVL_STUB)
   public void swap(final integer _piFromPos, final integer _piToPos)
   {
      integer piFromPos = TypeFactory.initInput(_piFromPos);
      integer piToPos = TypeFactory.initInput(_piToPos);
      
      internalProcedure(LegacyStack.class, this, "Swap", new Block());
   }

   @LegacySignature(type = Type.METHOD, name = "Rotate", parameters = 
   {
      @LegacyParameter(name = "piItems", type = "INTEGER", mode = "INPUT")
   })
   @LegacyResourceSupport(supportLvl = CVT_LVL_PARTIAL|RT_LVL_STUB)
   public void rotate(final integer _piItems)
   {
      integer piItems = TypeFactory.initInput(_piItems);
      
      internalProcedure(LegacyStack.class, this, "Rotate", new Block());
   }

   @LegacySignature(type = Type.METHOD, name = "ObjectToArray", extent = -1, returns = "OBJECT", qualified = "progress.lang.object")
   @LegacyResourceSupport(supportLvl = CVT_LVL_PARTIAL|RT_LVL_STUB)
   protected object<? extends com.goldencode.p2j.oo.lang._BaseObject_>[] objectToArray()
   {
      return extentFunction(LegacyStack.class, this, "ObjectToArray", object.class, new Block());
   }

   @LegacySignature(type = Type.METHOD, name = "PrimitiveToArray", extent = -1, returns = "CHARACTER")
   @LegacyResourceSupport(supportLvl = CVT_LVL_PARTIAL|RT_LVL_STUB)
   protected character[] primitiveToArray()
   {
      return extentFunction(LegacyStack.class, this, "PrimitiveToArray", character.class, new Block());
   }

   @LegacySignature(type = Type.METHOD, name = "Invert")
   @LegacyResourceSupport(supportLvl = CVT_LVL_PARTIAL|RT_LVL_STUB)
   public void invert()
   {
      internalProcedure(LegacyStack.class, this, "Invert", new Block());
   }

   @LegacySignature(type = Type.METHOD, name = "Clone", returns = "OBJECT", qualified = "progress.lang.object")
   @LegacyResourceSupport(supportLvl = CVT_LVL_PARTIAL|RT_LVL_STUB)
   @Override
   public object<? extends com.goldencode.p2j.oo.lang._BaseObject_> legacyClone()
   {
      return function(LegacyStack.class, this, "Clone", object.class, new Block());
   }

   @LegacySignature(type = Type.METHOD, name = "ObjectContains", returns = "LOGICAL", parameters = 
   {
      @LegacyParameter(name = "poItem", type = "OBJECT", qualified = "progress.lang.object", mode = "INPUT")
   })
   @LegacyResourceSupport(supportLvl = CVT_LVL_PARTIAL|RT_LVL_STUB)
   protected logical objectContains(final object<? extends com.goldencode.p2j.oo.lang._BaseObject_> _poItem)
   {
      object<? extends com.goldencode.p2j.oo.lang._BaseObject_> poItem = TypeFactory.initInput(_poItem);
      
      return function(LegacyStack.class, this, "ObjectContains", logical.class, new Block());
   }

   @LegacySignature(type = Type.METHOD, name = "PrimitiveContains", returns = "LOGICAL", parameters = 
   {
      @LegacyParameter(name = "pcItem", type = "CHARACTER", mode = "INPUT")
   })
   @LegacyResourceSupport(supportLvl = CVT_LVL_PARTIAL|RT_LVL_STUB)
   protected logical primitiveContains(final character _pcItem)
   {
      character pcItem = TypeFactory.initInput(_pcItem);
      
      return function(LegacyStack.class, this, "PrimitiveContains", logical.class, new Block());
   }
}