123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123 |
- /* ====================================================================
- 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.util.GenericRecordUtil;
- import org.apache.poi.util.LittleEndianInput;
- import org.apache.poi.util.LittleEndianOutput;
- import org.apache.poi.util.StringUtil;
-
- /**
- * String Stores a String value in a formula value stored in the format
- * <length 2 bytes>char[]
- */
- public final class StringPtg extends ScalarConstantPtg {
- public static final byte sid = 0x17;
- /** the character (") used in formulas to delimit string literals */
- private static final char FORMULA_DELIMITER = '"';
-
- private final boolean _is16bitUnicode;
- /**
- * NOTE: OO doc says 16bit length, but BiffViewer says 8 Book says something
- * totally different, so don't look there!
- */
- private final String field_3_string;
-
- /** Create a StringPtg from a stream */
- public StringPtg(LittleEndianInput in) {
- int nChars = in.readUByte(); // Note - nChars is 8-bit
- _is16bitUnicode = (in.readByte() & 0x01) != 0;
- if (_is16bitUnicode) {
- field_3_string = StringUtil.readUnicodeLE(in, nChars);
- } else {
- field_3_string = StringUtil.readCompressedUnicode(in, nChars);
- }
- }
-
- /**
- * Create a StringPtg from a string representation of the number Number
- * format is not checked, it is expected to be validated in the parser that
- * calls this method.
- *
- * @param value :
- * String representation of a floating point number
- */
- public StringPtg(String value) {
- if (value.length() > 255) {
- throw new IllegalArgumentException(
- "String literals in formulas can't be bigger than 255 characters ASCII");
- }
- _is16bitUnicode = StringUtil.hasMultibyte(value);
- field_3_string = value;
- }
-
- public String getValue() {
- return field_3_string;
- }
-
- public void write(LittleEndianOutput out) {
- out.writeByte(sid + getPtgClass());
- out.writeByte(field_3_string.length()); // Note - nChars is 8-bit
- out.writeByte(_is16bitUnicode ? 0x01 : 0x00);
- if (_is16bitUnicode) {
- StringUtil.putUnicodeLE(field_3_string, out);
- } else {
- StringUtil.putCompressedUnicode(field_3_string, out);
- }
- }
-
- @Override
- public byte getSid() {
- return sid;
- }
-
- public int getSize() {
- return 3 + field_3_string.length() * (_is16bitUnicode ? 2 : 1);
- }
-
- public String toFormulaString() {
- String value = field_3_string;
- int len = value.length();
- StringBuilder sb = new StringBuilder(len + 4);
- sb.append(FORMULA_DELIMITER);
-
- for (int i = 0; i < len; i++) {
- char c = value.charAt(i);
- if (c == FORMULA_DELIMITER) {
- sb.append(FORMULA_DELIMITER);
- }
- sb.append(c);
- }
-
- sb.append(FORMULA_DELIMITER);
- return sb.toString();
- }
-
- @Override
- public StringPtg copy() {
- return this;
- }
-
- @Override
- public Map<String, Supplier<?>> getGenericProperties() {
- return GenericRecordUtil.getGenericProperties("value", this::getValue);
- }
- }
|