CompilerOps.java
/*
** Module : CompilerOps.java
** Abstract : Utility for working with COMPILER system handle and COMPILE statement.
**
** Copyright (c) 2022-2025, Golden Code Development Corporation.
**
** -#- -I- --Date-- -------------------------------------- Description --------------------------------------
** 001 CA 20220516 Created initial version.
** CA 20220517 Added CLASS-TYPE and NUM-MESSAGES attributes.
** CA 20201003 CommonHandle.getResourceType() method renamed to resourceType() to prevent conflicts
** with namesakes in DMO. See #6694.
** CA 20230115 Added WARNING attribute.
** 002 CA 20250130 Added ERROR-ROW and FILE-NAME attributes.
*/
/*
** 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.util;
import com.goldencode.p2j.security.*;
import com.goldencode.proxy.*;
/**
* Utility for working with COMPILER system handle and COMPILE statement.
* <p>
* A COMPILER instance must be created after each COMPILE statement.
* TODO: check if previous instance must be automatically deleted.
*/
public class CompilerOps
{
/** Stores context-local state variables. */
private static ContextLocal<WorkArea> local = new ContextLocal<WorkArea>()
{
/** Retrieve the initial value of this context local variable. */
@Override
protected WorkArea initialValue()
{
return new WorkArea();
}
};
/**
* Implementation of the COMPILE XREF-XML statement.
*
* @param proc
* The source procedure or class to compile.
* @param target
* The target where to save the XREF information.
*/
public static void compileXRefXML(String proc, String target)
{
UnimplementedFeature.unsupported("COMPILE XREF-XML statement is not supported");
}
/**
* Implementation of the COMPILE statement.
*
* @param proc
* The source procedure or class to compile.
*/
public static void compile(String proc)
{
UnimplementedFeature.unsupported("COMPILE statement is not supported");
}
/**
* Implementation of the COMPILE statement.
*
* @param save
* Flag indicating if the r-code needs to be saved.
* @param proc
* The source procedure or class to compile.
*/
public static void compile(boolean save, String proc)
{
UnimplementedFeature.unsupported("COMPILE ... SAVE statement is not supported");
}
/**
* Implementation of the COMPILE statement.
*
* @param save
* Flag indicating if the r-code needs to be saved.
* @param proc
* The source procedure or class to compile.
* @param xcode
* The target xcode file.
*/
public static void compile(boolean save, String proc, character xcode)
{
UnimplementedFeature.unsupported("COMPILE ... SAVE statement is not supported");
}
/**
* Get the COMPILER system handle.
*
* @return COMPILER system handle.
*/
public static handle asHandle()
{
WorkArea wa = local.get();
Class[] classes = { CompilerOps.class };
Compiler proxy = StaticProxy.obtain(Compiler.class, classes);
if (wa.id == null)
{
wa.id = handle.resourceId(proxy);
}
return new handle(proxy);
}
/**
* Returns the state of the CLASS-TYPE attribute
*
* @return The CLASS-TYPE attribute.
*/
public static character getClassType()
{
UnimplementedFeature.unsupported("COMPILER:CLASS-TYPE attribute getter is not supported");
return new character();
}
/**
* Returns the state of the NUM-MESSAGES attribute
*
* @return The NUM-MESSAGES attribute.
*/
public static integer numErrors()
{
UnimplementedFeature.unsupported("COMPILER:NUM-MESSAGES attribute getter is not supported");
return new integer();
}
/**
* Returns the state of the WARNING attribute
*
* @return Current state of the WARNING attribute.
*/
public static logical warning()
{
UnimplementedFeature.unsupported("COMPILER:WARNING attribute getter is not supported");
return new logical(true);
}
/**
* Returns the state of the ERROR attribute
*
* @return Current state of the ERROR attribute.
*/
public static logical error()
{
UnimplementedFeature.unsupported("COMPILER:ERROR attribute getter is not supported");
return new logical(true);
}
/**
* Setter for ERROR attribute.
*
* @param value
* The new value of ERROR attribute.
*/
public static void error(boolean value)
{
readOnlyError("ERROR");
}
/**
* Setter for ERROR attribute.
*
* @param value
* The new value of ERROR attribute.
*/
public static void error(logical value)
{
readOnlyError("ERROR");
}
/**
* Returns the state of the ERROR-ROW attribute.
*
* @return The ERROR-ROW attribute.
*/
public static integer getErrorRow()
{
UnimplementedFeature.unsupported("COMPILER:ERROR-ROW attribute getter is not supported");
return new integer();
}
/**
* Get the name of the target file.
*
* @return the name of the target file.
*/
public static character getFileName()
{
UnimplementedFeature.unsupported("COMPILER:FILENAME attribute getter is not supported");
return new character();
}
/**
* Set the name of the target compiled file.
*
* @param fileName
* The name of the file to compile.
*/
public static void initFileInfo(character fileName)
{
UnimplementedFeature.unsupported("COMPILER:FILENAME attribute getter is not supported");
}
/**
* Set the name of the target compiled file.
*
* @param fileName
* The name of the file to compile.
*/
public static void initFileInfo(String fileName)
{
UnimplementedFeature.unsupported("COMPILER:FILENAME attribute getter is not supported");
}
/**
* API needed to implement read-only attribute assignment (a 4GL "feature").
*
* @param attribute
* The attribute's name.
*
* @see handle#readOnlyError(handle, String)
*/
public static void readOnlyError(String attribute)
{
handle.readOnlyError(asHandle(), attribute);
}
/**
* API needed to implement read-only attribute assignment (a 4GL "feature").
*
* @param attribute
* The attribute's name.
* @param expr
* The value which is attempted to be assigned to the read-only attribute.
*
* @see handle#readOnlyError(handle, String, Object)
*/
public static void readOnlyError(String attribute, Object expr)
{
handle.readOnlyError(asHandle(), attribute);
}
/**
* Get the type of its associated handle.
*
* @return Always return the PSEUDO-WIDGET value.
*/
public static character resourceType()
{
return new character(LegacyResource.PSEUDO_WIDGET);
}
/**
* Implementation for the {@link WrappedResource#valid()} API.
*
* @return Always true.
*/
public static boolean valid()
{
return true;
}
/**
* Get this resource's ID.
*
* @return The resource's ID.
*/
public static Long id()
{
WorkArea wa = local.get();
return wa.id;
}
/**
* Set this resource's ID.
* <p>
* This is a no-op for system handles.
*
* @param id
* The resource's ID.
*/
public static void id(long id)
{
// no-op
}
/**
* Implementation for the {@link WrappedResource#unknown()} API.
*
* @return Always false.
*/
public static boolean unknown()
{
return false;
}
/**
* Stores global data relating to the state of the current context.
*/
private static class WorkArea
{
/** The resource's ID. */
private Long id = null;
}
}