OCX.java

/*
** Module   : OCX.java
** Abstract : OCX runtime semantics.
**
** Copyright (c) 2020-2022, Golden Code Development Corporation.
**
** -#- -I- --Date-- ---------------------------------Description---------------------------------
** 001 HC  20200805 Created initial version.
**     HC  20200829 Added number argument to logical runtime conversion.
**     HC  20211116 Renamed this class from OCXSemantics to OCX. Added methods characterParam and
**                  numberTypeParams.
**     VVT 20220720 handleParam() now supports conversion from comhandle. See #6244.
*/
/*
** 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.comauto;

import com.goldencode.p2j.util.*;

/**
 * Implements runtime semantics for OCX converted components.
 */
public class OCX
{
   /**
    * Performs a runtime conversion of the supplied BDT value to the expected type.
    *
    * @param   value
    *          The input BDT value.
    *
    * @return  The converted value.
    */
   public static handle handleParam(BaseDataType value)
   {
      if (value instanceof handle)
      {
         return (handle) value;
      }
      
      if (value instanceof comhandle)
      {
         ComObject obj = ((comhandle) value).getResource();
         if (obj instanceof POJOComObject)
         {
            return new handle ((WrappedResource) obj.getComObjectInstance());
         }
         
         return new handle(value);
      }

      return new handle(value);
   }

   /**
    * Performs a runtime conversion of the supplied BDT value to the expected type.
    *
    * @param   value
    *          The input BDT value.
    *
    * @return  The converted value.
    */
   public static character characterParam(BaseDataType value)
   {
      return value instanceof character ? (character) value : new character(value);
   }

   /**
    * Performs a runtime conversion of the supplied BDT value to the expected type.
    *
    * @param   value
    *          The input BDT value.
    *
    * @return  The converted value.
    */
   public static NumberType numberTypeParam(BaseDataType value)
   {
      if (value instanceof NumberType)
      {
         return (NumberType) value;
      }
      else if (value instanceof date)
      {
         return new decimal(legacyToNativeDate(((date) value).intValue()));
      }
      else
      {
         return new decimal(value);
      }
   }

   /**
    * Performs a runtime conversion of the supplied BDT value to the expected type.
    *
    * @param   value
    *          The input BDT value.
    *
    * @return  The converted value.
    */
   public static decimal decimalParam(BaseDataType value)
   {
      if (value instanceof decimal)
      {
         return (decimal) value;
      }
      
      if (value instanceof date)
      {
         return new decimal(legacyToNativeDate(((date) value).intValue()));
      }
      
      return new decimal(value);
   }

   /**
    * Performs a runtime conversion of the supplied value to the expected type.
    *
    * @param   value
    *          The input value.
    *
    * @return  The converted value.
    */
   public static integer integerParam(BaseDataType value)
   {
      if (value instanceof integer)
      {
         return (integer) value;
      }
      
      if (value instanceof date)
      {
         return new integer(legacyToNativeDate(((date) value).intValue()));
      }
      
      return new integer(value);
   }

   /**
    * Performs a runtime conversion of the supplied BDT value to the expected type.
    *
    * @param   value
    *          The input BDT value.
    *
    * @return  The converted value.
    */
   public static logical logicalParam(BaseDataType value)
   {
      if (value instanceof logical)
      {
         return (logical) value;
      }
      
      return new logical(value);
   }

   /**
    * Converts legacy date value to native date value (with initial date 1-1-1900).
    *
    * @param   legacyDate
    *          The date to convert.
    *
    * @return  The converted date.
    */
   private static int legacyToNativeDate(int legacyDate)
   {
      // native base date is 01-01-1900, in OE/4GL this is 12/31/-4714
      return (int) (legacyDate - date.OCX_EPOCH_OFFSET);
   }
}