| /* ==================================================================== |
| Licensed to the Apache Software Foundation (ASF) under one or more |
| contributor license agreements. See the NOTICE file distributed with |
| this work for additional information regarding copyright ownership. |
| The ASF licenses this file to You under the Apache License, Version 2.0 |
| (the "License"); you may not use this file except in compliance with |
| the License. You may obtain a copy of the License at |
| |
| http://www.apache.org/licenses/LICENSE-2.0 |
| |
| Unless required by applicable law or agreed to in writing, software |
| distributed under the License is distributed on an "AS IS" BASIS, |
| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| See the License for the specific language governing permissions and |
| limitations under the License. |
| ==================================================================== */ |
| |
| package org.apache.poi.ss.formula.ptg; |
| import java.util.Map; |
| import java.util.function.Supplier; |
| |
| import org.apache.poi.ss.formula.function.FunctionMetadata; |
| import org.apache.poi.ss.formula.function.FunctionMetadataRegistry; |
| import org.apache.poi.util.BitField; |
| import org.apache.poi.util.BitFieldFactory; |
| import org.apache.poi.util.GenericRecordUtil; |
| import org.apache.poi.util.LittleEndianInput; |
| import org.apache.poi.util.LittleEndianOutput; |
| |
| public final class FuncVarPtg extends AbstractFunctionPtg { |
| public static final byte sid = 0x22; |
| private static final int SIZE = 4; |
| |
| // See spec at 2.5.198.63 PtgFuncVar |
| private static final BitField ceFunc = BitFieldFactory.getInstance(0xF000); |
| |
| /** |
| * Single instance of this token for 'sum() taking a single argument' |
| */ |
| public static final OperationPtg SUM = FuncVarPtg.create("SUM", 1); |
| |
| private final boolean _isCetab; |
| |
| private FuncVarPtg(int functionIndex, int returnClass, byte[] paramClasses, int numArgs, boolean isCetab) { |
| super(functionIndex, returnClass, paramClasses, numArgs); |
| _isCetab = isCetab; |
| } |
| |
| /**Creates new function pointer from a byte array |
| * usually called while reading an excel file. |
| */ |
| public static FuncVarPtg create(LittleEndianInput in) { |
| return create(in.readByte(), in.readUShort()); |
| } |
| |
| /** |
| * Create a function ptg from a string tokenised by the parser |
| */ |
| public static FuncVarPtg create(String pName, int numArgs) { |
| return create(numArgs, lookupIndex(pName)); |
| } |
| |
| private static FuncVarPtg create(int numArgs, int functionIndex) { |
| final FunctionMetadata fm; |
| boolean isCetab = ceFunc.isSet(functionIndex); |
| if(isCetab) { |
| functionIndex = ceFunc.clear(functionIndex); |
| fm = FunctionMetadataRegistry.getCetabFunctionByIndex(functionIndex); |
| } else { |
| fm = FunctionMetadataRegistry.getFunctionByIndex(functionIndex); |
| } |
| |
| if (fm == null) { |
| // Happens only as a result of a call to FormulaParser.parse(), with a non-built-in function name |
| return new FuncVarPtg(functionIndex, Ptg.CLASS_VALUE, new byte[]{Ptg.CLASS_VALUE}, numArgs, isCetab); |
| } |
| return new FuncVarPtg(functionIndex, fm.getReturnClassCode(), fm.getParameterClassCodes(), numArgs, isCetab); |
| } |
| |
| @Override |
| protected String lookupName(short index) { |
| return lookupName(index, _isCetab); |
| } |
| |
| public void write(LittleEndianOutput out) { |
| out.writeByte(sid + getPtgClass()); |
| out.writeByte(getNumberOfOperands()); |
| out.writeShort(getFunctionIndex()); |
| } |
| |
| @Override |
| public byte getSid() { |
| return sid; |
| } |
| |
| public int getSize() { |
| return SIZE; |
| } |
| |
| @Override |
| public FuncVarPtg copy() { |
| // immutable |
| return this; |
| } |
| |
| @Override |
| public Map<String, Supplier<?>> getGenericProperties() { |
| return GenericRecordUtil.getGenericProperties( |
| "base", super::getGenericProperties, |
| "cetab", () -> _isCetab |
| ); |
| } |
| } |