/*
* Copyright (c) 2007 BUSINESS OBJECTS SOFTWARE LIMITED
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* * Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
*
* * Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* * Neither the name of Business Objects nor the names of its contributors
* may be used to endorse or promote products derived from this software
* without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*/
/*
* RTCompareRecord.java
* Created: Oct 4, 2004
* By: Bo Ilic
*/
package org.openquark.cal.internal.runtime.lecc.functions;
import org.openquark.cal.internal.runtime.lecc.LECCMachineConfiguration;
import org.openquark.cal.internal.runtime.lecc.RTData;
import org.openquark.cal.internal.runtime.lecc.RTExecutionContext;
import org.openquark.cal.internal.runtime.lecc.RTOApp3;
import org.openquark.cal.internal.runtime.lecc.RTRecordValue;
import org.openquark.cal.internal.runtime.lecc.RTResultFunction;
import org.openquark.cal.internal.runtime.lecc.RTSupercombinator;
import org.openquark.cal.internal.runtime.lecc.RTValue;
import org.openquark.cal.runtime.CALExecutorException;
/**
* Implements the built-in primitive function:
* compareRecord :: Ord r => {r} -> {r} -> Ordering
*
* @author Bo Ilic
*/
public final class RTCompareRecord extends RTSupercombinator {
/**
* The index of the Prelude.compare class method. This is currently
* hard-coded. Changes to the type class would necessitate updating this
* value.
*/
private static final RTData.CAL_Int indexOfCompareClassMethod = RTData.CAL_Int.make(5);
private static final int Prelude_LT_INT = 0;
private static final int Prelude_EQ_INT = 1;
private static final int Prelude_GT_INT = 2;
private static final RTData.CAL_Int Prelude_LT = RTData.CAL_Int.make(Prelude_LT_INT);
private static final RTData.CAL_Int Prelude_EQ = RTData.CAL_Int.make(Prelude_EQ_INT);
private static final RTData.CAL_Int Prelude_GT = RTData.CAL_Int.make(Prelude_GT_INT);
public static final RTCompareRecord $instance = new RTCompareRecord();
private RTCompareRecord() {
// Declared private to limit instantiation.
}
public static final RTCompareRecord make(RTExecutionContext $ec) {
return $instance;
}
@Override
public final int getArity() {
return 3;
}
@Override
public final RTValue f(final RTResultFunction rootNode, final RTExecutionContext $ec) throws CALExecutorException {
// Arguments
RTValue y = rootNode.getArgValue();
RTValue currentRootNode;
RTValue x = (currentRootNode = rootNode.prevArg()).getArgValue();
RTValue recordDictionary = currentRootNode.prevArg().getArgValue();
// Release the fields in the root node to open them to garbage collection
rootNode.clearMembers();
return f3S (
RTValue.lastRef(recordDictionary.evaluate($ec), recordDictionary = null),
RTValue.lastRef(x.evaluate($ec), x = null),
RTValue.lastRef(y.evaluate($ec), y = null),
$ec);
}
@Override
public final RTValue f3L(RTValue recordDictionary, RTValue x, RTValue y, RTExecutionContext $ec) throws CALExecutorException {
return f3S (
RTValue.lastRef(recordDictionary.evaluate($ec), recordDictionary = null),
RTValue.lastRef(x.evaluate($ec), x = null),
RTValue.lastRef(y.evaluate($ec), y = null),
$ec);
}
@Override
public final RTValue f3S(RTValue recordDictionary, RTValue x, RTValue y, RTExecutionContext $ec) throws CALExecutorException {
$ec.incrementNMethodCalls();
if (LECCMachineConfiguration.generateDebugCode() && $ec.isDebugProcessingNeeded(getQualifiedName())) {
$ec.debugProcessing(getQualifiedName(), new RTValue[]{recordDictionary, x, y});
}
//compareRecord recordDictionary x y.
//the compiler ensures that the 3 record arguments all have the same fields.
//we iterate in FieldName order over the field names so that the function is well-defined in the presence of side effects.
//If f is a field, then recordDictionary.f is the dictionary for use when calling the class method Prelude.compare on
//the values x.f and y.f.
RTRecordValue recordDict = (RTRecordValue)recordDictionary;
RTRecordValue xRecord = (RTRecordValue)x;
RTRecordValue yRecord = (RTRecordValue)y;
for (int i = 0, nFields = recordDict.getNFields(); i < nFields; ++i) {
RTValue fieldDict = recordDict.getNthValue(i);
RTValue xField = xRecord.getNthValue(i);
RTValue yField = yRecord.getNthValue(i);
//compute "Prelude.compare fieldDict xField yField"
//this is just (after inlining Prelude.compare d = d indexOfCompareClassMethod)
//(where indexOfCompareClassMethod is the dictionary index of the compare method. See
//ClassInstance.getDictionaryIndex for details).
//fieldDict indexOfCompareClassMethod xField yField
switch (new RTOApp3(fieldDict, indexOfCompareClassMethod, xField, yField).evaluate($ec).getOrdinalValue()) {
case 0 :
{
//Prelude.LT
return Prelude_LT;
}
case 1 :
{
//Prelude.EQ
break;
}
case 2 :
{
//Prelude.GT
return Prelude_GT;
}
default:
{
return badValue("Illegal fallthrough to default case in function: " + $instance.getQualifiedName() + ".");
}
}
}
return Prelude_EQ;
}
/**
* This is the version of the function logic that directly returns an unboxed value.
* All functions whose return types can be unboxed should have a version of the function
* logic which returns an unboxed value.
* @param recordDictionary
* @param x
* @param y
* @param $ec
* @return the int value indicating greater, equal, or less than.
* @throws CALExecutorException
*/
public final int fUnboxed3S(RTValue recordDictionary, RTValue x, RTValue y, RTExecutionContext $ec) throws CALExecutorException {
$ec.incrementNMethodCalls();
if (LECCMachineConfiguration.generateDebugCode() && $ec.isDebugProcessingNeeded(getQualifiedName())) {
$ec.debugProcessing(getQualifiedName(), new RTValue[]{recordDictionary, x, y});
}
//compareRecordHelper recordDictionary x y.
//the compiler ensures that the 3 record arguments all have the same fields.
//we iterate in FieldName order over the field names so that the function is well-defined in the presence of side effects.
//If f is a field, then recordDictionary.f is the dictionary for use when calling the class method Prelude.compare on
//the values x.f and y.f.
RTRecordValue recordDict = (RTRecordValue)recordDictionary;
RTRecordValue xRecord = (RTRecordValue)x;
RTRecordValue yRecord = (RTRecordValue)y;
for (int i = 0, nFields = recordDict.getNFields(); i < nFields; ++i) {
RTValue fieldDict = recordDict.getNthValue(i);
RTValue xField = xRecord.getNthValue(i);
RTValue yField = yRecord.getNthValue(i);
//compute "Prelude.compare fieldDict xField yField"
//this is just (after inlining Prelude.compare d = d indexOfCompareClassMethod)
//(where indexOfCompareClassMethod is the dictionary index of the compare method. See
//ClassInstance.getDictionaryIndex for details).
//fieldDict indexOfCompareClassMethod xField yField
switch (new RTOApp3(fieldDict, indexOfCompareClassMethod, xField, yField).evaluate($ec).getOrdinalValue()) {
case 0 :
{
//Prelude.LT
return Prelude_LT_INT;
}
case 1 :
{
//Prelude.EQ
break;
}
case 2 :
{
//Prelude.GT
return Prelude_GT_INT;
}
default:
{
return badValue_int(null, "Illegal fallthrough to default case in function: " + $instance.getQualifiedName() + ".");
}
}
}
return Prelude_EQ_INT;
}
/**
* {@inheritDoc}
*/
@Override
public final String getModuleName () {
//JUnit tested to equal its binding file value in RuntimeStringConstantsTest.
return "Cal.Core.Prelude";
}
/**
* {@inheritDoc}
*/
@Override
public final String getUnqualifiedName () {
//JUnit tested to equal its binding file value in RuntimeStringConstantsTest.
return "compareRecord";
}
/**
* {@inheritDoc}
*/
@Override
public final String getQualifiedName() {
//JUnit tested to equal its binding file value in RuntimeStringConstantsTest.
return "Cal.Core.Prelude.compareRecord";
}
}