2004-04-09 09:05:39 -04:00
|
|
|
/* ====================================================================
|
2006-12-22 14:18:16 -05:00
|
|
|
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
|
2004-04-09 09:05:39 -04:00
|
|
|
|
|
|
|
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.
|
|
|
|
==================================================================== */
|
2009-06-01 17:07:20 -04:00
|
|
|
|
2002-02-13 23:00:59 -05:00
|
|
|
package org.apache.poi.hpsf;
|
|
|
|
|
2003-08-30 05:13:53 -04:00
|
|
|
import java.util.Collections;
|
2003-08-23 11:12:22 -04:00
|
|
|
import java.util.HashMap;
|
|
|
|
import java.util.Map;
|
|
|
|
|
2002-02-13 23:00:59 -05:00
|
|
|
/**
|
2003-02-01 08:28:28 -05:00
|
|
|
* <p>The <em>Variant</em> types as defined by Microsoft's COM. I
|
|
|
|
* found this information in <a
|
|
|
|
* href="http://www.marin.clara.net/COM/variant_type_definitions.htm">
|
|
|
|
* http://www.marin.clara.net/COM/variant_type_definitions.htm</a>.</p>
|
2002-05-11 10:47:24 -04:00
|
|
|
*
|
2003-02-01 08:28:28 -05:00
|
|
|
* <p>In the variant types descriptions the following shortcuts are
|
|
|
|
* used: <strong> [V]</strong> - may appear in a VARIANT,
|
|
|
|
* <strong>[T]</strong> - may appear in a TYPEDESC,
|
|
|
|
* <strong>[P]</strong> - may appear in an OLE property set,
|
|
|
|
* <strong>[S]</strong> - may appear in a Safe Array.</p>
|
2002-02-13 23:00:59 -05:00
|
|
|
*/
|
2003-02-01 08:28:28 -05:00
|
|
|
public class Variant
|
|
|
|
{
|
2002-02-13 23:00:59 -05:00
|
|
|
|
|
|
|
/**
|
2003-07-26 17:17:17 -04:00
|
|
|
* <p>[V][P] Nothing, i.e. not a single byte of data.</p>
|
2002-02-13 23:00:59 -05:00
|
|
|
*/
|
2003-07-26 17:17:17 -04:00
|
|
|
public static final int VT_EMPTY = 0;
|
2002-02-13 23:00:59 -05:00
|
|
|
|
|
|
|
/**
|
2003-02-01 08:28:28 -05:00
|
|
|
* <p>[V][P] SQL style Null.</p>
|
2002-02-13 23:00:59 -05:00
|
|
|
*/
|
2003-07-26 17:17:17 -04:00
|
|
|
public static final int VT_NULL = 1;
|
2002-02-13 23:00:59 -05:00
|
|
|
|
|
|
|
/**
|
2003-02-01 08:28:28 -05:00
|
|
|
* <p>[V][T][P][S] 2 byte signed int.</p>
|
2002-02-13 23:00:59 -05:00
|
|
|
*/
|
2003-07-26 17:17:17 -04:00
|
|
|
public static final int VT_I2 = 2;
|
2002-02-13 23:00:59 -05:00
|
|
|
|
|
|
|
/**
|
2003-02-01 08:28:28 -05:00
|
|
|
* <p>[V][T][P][S] 4 byte signed int.</p>
|
2002-02-13 23:00:59 -05:00
|
|
|
*/
|
2003-07-26 17:17:17 -04:00
|
|
|
public static final int VT_I4 = 3;
|
2002-02-13 23:00:59 -05:00
|
|
|
|
|
|
|
/**
|
2003-02-01 08:28:28 -05:00
|
|
|
* <p>[V][T][P][S] 4 byte real.</p>
|
2002-02-13 23:00:59 -05:00
|
|
|
*/
|
2003-07-26 17:17:17 -04:00
|
|
|
public static final int VT_R4 = 4;
|
2002-02-13 23:00:59 -05:00
|
|
|
|
|
|
|
/**
|
2003-02-01 08:28:28 -05:00
|
|
|
* <p>[V][T][P][S] 8 byte real.</p>
|
2002-02-13 23:00:59 -05:00
|
|
|
*/
|
2003-07-26 17:17:17 -04:00
|
|
|
public static final int VT_R8 = 5;
|
2002-02-13 23:00:59 -05:00
|
|
|
|
|
|
|
/**
|
2003-02-01 08:28:28 -05:00
|
|
|
* <p>[V][T][P][S] currency. <span style="background-color:
|
|
|
|
* #ffff00">How long is this? How is it to be
|
|
|
|
* interpreted?</span></p>
|
2002-02-13 23:00:59 -05:00
|
|
|
*/
|
2003-07-26 17:17:17 -04:00
|
|
|
public static final int VT_CY = 6;
|
2002-02-13 23:00:59 -05:00
|
|
|
|
|
|
|
/**
|
2003-02-01 08:28:28 -05:00
|
|
|
* <p>[V][T][P][S] date. <span style="background-color:
|
|
|
|
* #ffff00">How long is this? How is it to be
|
|
|
|
* interpreted?</span></p>
|
2002-02-13 23:00:59 -05:00
|
|
|
*/
|
2003-07-26 17:17:17 -04:00
|
|
|
public static final int VT_DATE = 7;
|
2002-02-13 23:00:59 -05:00
|
|
|
|
|
|
|
/**
|
2003-02-01 08:28:28 -05:00
|
|
|
* <p>[V][T][P][S] OLE Automation string. <span
|
|
|
|
* style="background-color: #ffff00">How long is this? How is it
|
|
|
|
* to be interpreted?</span></p>
|
2002-02-13 23:00:59 -05:00
|
|
|
*/
|
2003-07-26 17:17:17 -04:00
|
|
|
public static final int VT_BSTR = 8;
|
2002-02-13 23:00:59 -05:00
|
|
|
|
|
|
|
/**
|
2003-02-01 08:28:28 -05:00
|
|
|
* <p>[V][T][P][S] IDispatch *. <span style="background-color:
|
|
|
|
* #ffff00">How long is this? How is it to be
|
|
|
|
* interpreted?</span></p>
|
2002-02-13 23:00:59 -05:00
|
|
|
*/
|
2003-07-26 17:17:17 -04:00
|
|
|
public static final int VT_DISPATCH = 9;
|
2002-02-13 23:00:59 -05:00
|
|
|
|
|
|
|
/**
|
2003-02-01 08:28:28 -05:00
|
|
|
* <p>[V][T][S] SCODE. <span style="background-color: #ffff00">How
|
|
|
|
* long is this? How is it to be interpreted?</span></p>
|
2002-02-13 23:00:59 -05:00
|
|
|
*/
|
2003-07-26 17:17:17 -04:00
|
|
|
public static final int VT_ERROR = 10;
|
2002-02-13 23:00:59 -05:00
|
|
|
|
|
|
|
/**
|
2003-02-01 08:28:28 -05:00
|
|
|
* <p>[V][T][P][S] True=-1, False=0.</p>
|
2002-02-13 23:00:59 -05:00
|
|
|
*/
|
2003-07-26 17:17:17 -04:00
|
|
|
public static final int VT_BOOL = 11;
|
2002-02-13 23:00:59 -05:00
|
|
|
|
|
|
|
/**
|
2003-02-01 08:28:28 -05:00
|
|
|
* <p>[V][T][P][S] VARIANT *. <span style="background-color:
|
|
|
|
* #ffff00">How long is this? How is it to be
|
|
|
|
* interpreted?</span></p>
|
2002-02-13 23:00:59 -05:00
|
|
|
*/
|
2003-07-26 17:17:17 -04:00
|
|
|
public static final int VT_VARIANT = 12;
|
2002-02-13 23:00:59 -05:00
|
|
|
|
|
|
|
/**
|
2003-02-01 08:28:28 -05:00
|
|
|
* <p>[V][T][S] IUnknown *. <span style="background-color:
|
|
|
|
* #ffff00">How long is this? How is it to be
|
|
|
|
* interpreted?</span></p>
|
2002-02-13 23:00:59 -05:00
|
|
|
*/
|
2003-07-26 17:17:17 -04:00
|
|
|
public static final int VT_UNKNOWN = 13;
|
2002-02-13 23:00:59 -05:00
|
|
|
|
|
|
|
/**
|
2003-02-01 08:28:28 -05:00
|
|
|
* <p>[V][T][S] 16 byte fixed point.</p>
|
2002-02-13 23:00:59 -05:00
|
|
|
*/
|
2003-07-26 17:17:17 -04:00
|
|
|
public static final int VT_DECIMAL = 14;
|
2002-02-13 23:00:59 -05:00
|
|
|
|
|
|
|
/**
|
2003-02-01 08:28:28 -05:00
|
|
|
* <p>[T] signed char.</p>
|
2002-02-13 23:00:59 -05:00
|
|
|
*/
|
2003-07-26 17:17:17 -04:00
|
|
|
public static final int VT_I1 = 16;
|
2002-02-13 23:00:59 -05:00
|
|
|
|
|
|
|
/**
|
2003-02-01 08:28:28 -05:00
|
|
|
* <p>[V][T][P][S] unsigned char.</p>
|
2002-02-13 23:00:59 -05:00
|
|
|
*/
|
2003-07-26 17:17:17 -04:00
|
|
|
public static final int VT_UI1 = 17;
|
2002-02-13 23:00:59 -05:00
|
|
|
|
|
|
|
/**
|
2003-02-01 08:28:28 -05:00
|
|
|
* <p>[T][P] unsigned short.</p>
|
2002-02-13 23:00:59 -05:00
|
|
|
*/
|
2003-07-26 17:17:17 -04:00
|
|
|
public static final int VT_UI2 = 18;
|
2002-02-13 23:00:59 -05:00
|
|
|
|
|
|
|
/**
|
2003-02-01 08:28:28 -05:00
|
|
|
* <p>[T][P] unsigned int.</p>
|
2002-02-13 23:00:59 -05:00
|
|
|
*/
|
2003-07-26 17:17:17 -04:00
|
|
|
public static final int VT_UI4 = 19;
|
2002-02-13 23:00:59 -05:00
|
|
|
|
|
|
|
/**
|
2003-02-01 08:28:28 -05:00
|
|
|
* <p>[T][P] signed 64-bit int.</p>
|
2002-02-13 23:00:59 -05:00
|
|
|
*/
|
2003-07-26 17:17:17 -04:00
|
|
|
public static final int VT_I8 = 20;
|
2002-02-13 23:00:59 -05:00
|
|
|
|
|
|
|
/**
|
2003-02-01 08:28:28 -05:00
|
|
|
* <p>[T][P] unsigned 64-bit int.</p>
|
2002-02-13 23:00:59 -05:00
|
|
|
*/
|
2003-07-26 17:17:17 -04:00
|
|
|
public static final int VT_UI8 = 21;
|
2002-02-13 23:00:59 -05:00
|
|
|
|
|
|
|
/**
|
2003-02-01 08:28:28 -05:00
|
|
|
* <p>[T] signed machine int.</p>
|
2002-02-13 23:00:59 -05:00
|
|
|
*/
|
2003-07-26 17:17:17 -04:00
|
|
|
public static final int VT_INT = 22;
|
2002-02-13 23:00:59 -05:00
|
|
|
|
|
|
|
/**
|
2003-02-01 08:28:28 -05:00
|
|
|
* <p>[T] unsigned machine int.</p>
|
2002-02-13 23:00:59 -05:00
|
|
|
*/
|
2003-07-26 17:17:17 -04:00
|
|
|
public static final int VT_UINT = 23;
|
2002-02-13 23:00:59 -05:00
|
|
|
|
|
|
|
/**
|
2003-02-01 08:28:28 -05:00
|
|
|
* <p>[T] C style void.</p>
|
2002-02-13 23:00:59 -05:00
|
|
|
*/
|
2003-07-26 17:17:17 -04:00
|
|
|
public static final int VT_VOID = 24;
|
2002-02-13 23:00:59 -05:00
|
|
|
|
|
|
|
/**
|
2003-02-01 08:28:28 -05:00
|
|
|
* <p>[T] Standard return type. <span style="background-color:
|
|
|
|
* #ffff00">How long is this? How is it to be
|
|
|
|
* interpreted?</span></p>
|
2002-02-13 23:00:59 -05:00
|
|
|
*/
|
2003-07-26 17:17:17 -04:00
|
|
|
public static final int VT_HRESULT = 25;
|
2002-02-13 23:00:59 -05:00
|
|
|
|
|
|
|
/**
|
2003-02-01 08:28:28 -05:00
|
|
|
* <p>[T] pointer type. <span style="background-color:
|
|
|
|
* #ffff00">How long is this? How is it to be
|
|
|
|
* interpreted?</span></p>
|
2002-05-11 10:47:24 -04:00
|
|
|
*/
|
2003-07-26 17:17:17 -04:00
|
|
|
public static final int VT_PTR = 26;
|
2002-02-13 23:00:59 -05:00
|
|
|
|
|
|
|
/**
|
2003-02-01 08:28:28 -05:00
|
|
|
* <p>[T] (use VT_ARRAY in VARIANT).</p>
|
2002-05-11 10:47:24 -04:00
|
|
|
*/
|
2003-07-26 17:17:17 -04:00
|
|
|
public static final int VT_SAFEARRAY = 27;
|
2002-02-13 23:00:59 -05:00
|
|
|
|
|
|
|
/**
|
2003-02-01 08:28:28 -05:00
|
|
|
* <p>[T] C style array. <span style="background-color:
|
|
|
|
* #ffff00">How long is this? How is it to be
|
|
|
|
* interpreted?</span></p>
|
2002-02-13 23:00:59 -05:00
|
|
|
*/
|
2003-07-26 17:17:17 -04:00
|
|
|
public static final int VT_CARRAY = 28;
|
2002-02-13 23:00:59 -05:00
|
|
|
|
|
|
|
/**
|
2003-02-01 08:28:28 -05:00
|
|
|
* <p>[T] user defined type. <span style="background-color:
|
|
|
|
* #ffff00">How long is this? How is it to be
|
|
|
|
* interpreted?</span></p>
|
2002-02-13 23:00:59 -05:00
|
|
|
*/
|
2003-07-26 17:17:17 -04:00
|
|
|
public static final int VT_USERDEFINED = 29;
|
2002-02-13 23:00:59 -05:00
|
|
|
|
|
|
|
/**
|
2003-02-01 08:28:28 -05:00
|
|
|
* <p>[T][P] null terminated string.</p>
|
2002-02-13 23:00:59 -05:00
|
|
|
*/
|
2003-07-26 17:17:17 -04:00
|
|
|
public static final int VT_LPSTR = 30;
|
2002-02-13 23:00:59 -05:00
|
|
|
|
|
|
|
/**
|
2003-02-01 08:28:28 -05:00
|
|
|
* <p>[T][P] wide (Unicode) null terminated string.</p>
|
2002-02-13 23:00:59 -05:00
|
|
|
*/
|
2003-07-26 17:17:17 -04:00
|
|
|
public static final int VT_LPWSTR = 31;
|
2002-02-13 23:00:59 -05:00
|
|
|
|
|
|
|
/**
|
2003-02-01 08:28:28 -05:00
|
|
|
* <p>[P] FILETIME. The FILETIME structure holds a date and time
|
|
|
|
* associated with a file. The structure identifies a 64-bit
|
|
|
|
* integer specifying the number of 100-nanosecond intervals which
|
|
|
|
* have passed since January 1, 1601. This 64-bit value is split
|
|
|
|
* into the two dwords stored in the structure.</p>
|
2002-02-13 23:00:59 -05:00
|
|
|
*/
|
2003-07-26 17:17:17 -04:00
|
|
|
public static final int VT_FILETIME = 64;
|
2002-02-13 23:00:59 -05:00
|
|
|
|
|
|
|
/**
|
2003-02-01 08:28:28 -05:00
|
|
|
* <p>[P] Length prefixed bytes.</p>
|
2002-02-13 23:00:59 -05:00
|
|
|
*/
|
2003-07-26 17:17:17 -04:00
|
|
|
public static final int VT_BLOB = 65;
|
2002-02-13 23:00:59 -05:00
|
|
|
|
|
|
|
/**
|
2003-02-01 08:28:28 -05:00
|
|
|
* <p>[P] Name of the stream follows.</p>
|
2002-02-13 23:00:59 -05:00
|
|
|
*/
|
2003-07-26 17:17:17 -04:00
|
|
|
public static final int VT_STREAM = 66;
|
2002-02-13 23:00:59 -05:00
|
|
|
|
|
|
|
/**
|
2003-02-01 08:28:28 -05:00
|
|
|
* <p>[P] Name of the storage follows.</p>
|
2002-02-13 23:00:59 -05:00
|
|
|
*/
|
2003-07-26 17:17:17 -04:00
|
|
|
public static final int VT_STORAGE = 67;
|
2002-02-13 23:00:59 -05:00
|
|
|
|
|
|
|
/**
|
2003-02-01 08:28:28 -05:00
|
|
|
* <p>[P] Stream contains an object. <span
|
|
|
|
* style="background-color: #ffff00"> How long is this? How is it
|
|
|
|
* to be interpreted?</span></p>
|
2002-02-13 23:00:59 -05:00
|
|
|
*/
|
2003-07-26 17:17:17 -04:00
|
|
|
public static final int VT_STREAMED_OBJECT = 68;
|
2002-02-13 23:00:59 -05:00
|
|
|
|
|
|
|
/**
|
2003-02-01 08:28:28 -05:00
|
|
|
* <p>[P] Storage contains an object. <span
|
|
|
|
* style="background-color: #ffff00"> How long is this? How is it
|
|
|
|
* to be interpreted?</span></p>
|
2002-02-13 23:00:59 -05:00
|
|
|
*/
|
2003-07-26 17:17:17 -04:00
|
|
|
public static final int VT_STORED_OBJECT = 69;
|
2002-02-13 23:00:59 -05:00
|
|
|
|
|
|
|
/**
|
2003-02-01 08:28:28 -05:00
|
|
|
* <p>[P] Blob contains an object. <span style="background-color:
|
|
|
|
* #ffff00">How long is this? How is it to be
|
|
|
|
* interpreted?</span></p>
|
2002-02-13 23:00:59 -05:00
|
|
|
*/
|
2003-07-26 17:17:17 -04:00
|
|
|
public static final int VT_BLOB_OBJECT = 70;
|
2002-02-13 23:00:59 -05:00
|
|
|
|
|
|
|
/**
|
2003-02-01 08:28:28 -05:00
|
|
|
* <p>[P] Clipboard format. <span style="background-color:
|
|
|
|
* #ffff00">How long is this? How is it to be
|
|
|
|
* interpreted?</span></p>
|
2002-02-13 23:00:59 -05:00
|
|
|
*/
|
2003-07-26 17:17:17 -04:00
|
|
|
public static final int VT_CF = 71;
|
2002-02-13 23:00:59 -05:00
|
|
|
|
|
|
|
/**
|
2003-02-01 08:28:28 -05:00
|
|
|
* <p>[P] A Class ID.</p>
|
2002-05-11 10:47:24 -04:00
|
|
|
*
|
2003-02-01 08:28:28 -05:00
|
|
|
* <p>It consists of a 32 bit unsigned integer indicating the size
|
|
|
|
* of the structure, a 32 bit signed integer indicating (Clipboard
|
|
|
|
* Format Tag) indicating the type of data that it contains, and
|
|
|
|
* then a byte array containing the data.</p>
|
2002-05-01 05:31:52 -04:00
|
|
|
*
|
2003-02-01 08:28:28 -05:00
|
|
|
* <p>The valid Clipboard Format Tags are:</p>
|
2002-05-01 05:31:52 -04:00
|
|
|
*
|
2003-02-01 08:28:28 -05:00
|
|
|
* <ul>
|
|
|
|
* <li>{@link Thumbnail#CFTAG_WINDOWS}</li>
|
|
|
|
* <li>{@link Thumbnail#CFTAG_MACINTOSH}</li>
|
|
|
|
* <li>{@link Thumbnail#CFTAG_NODATA}</li>
|
|
|
|
* <li>{@link Thumbnail#CFTAG_FMTID}</li>
|
|
|
|
* </ul>
|
2002-05-11 10:47:24 -04:00
|
|
|
*
|
2003-02-01 08:28:28 -05:00
|
|
|
* <pre>typedef struct tagCLIPDATA {
|
2002-05-01 05:31:52 -04:00
|
|
|
* // cbSize is the size of the buffer pointed to
|
|
|
|
* // by pClipData, plus sizeof(ulClipFmt)
|
|
|
|
* ULONG cbSize;
|
|
|
|
* long ulClipFmt;
|
|
|
|
* BYTE* pClipData;
|
2003-02-01 08:28:28 -05:00
|
|
|
* } CLIPDATA;</pre>
|
|
|
|
*
|
|
|
|
* <p>See <a
|
|
|
|
* href="msdn.microsoft.com/library/en-us/com/stgrstrc_0uwk.asp"
|
|
|
|
* target="_blank">
|
|
|
|
* msdn.microsoft.com/library/en-us/com/stgrstrc_0uwk.asp</a>.</p>
|
2002-02-13 23:00:59 -05:00
|
|
|
*/
|
2003-07-26 17:17:17 -04:00
|
|
|
public static final int VT_CLSID = 72;
|
2002-02-13 23:00:59 -05:00
|
|
|
|
2011-10-21 19:45:01 -04:00
|
|
|
/**
|
|
|
|
* "MUST be a VersionedStream. The storage representing the (non-simple)
|
|
|
|
* property set MUST have a stream element with the name in the StreamName
|
|
|
|
* field." -- [MS-OLEPS] -- v20110920; Object Linking and Embedding (OLE)
|
|
|
|
* Property Set Data Structures; page 24 / 63
|
|
|
|
*/
|
|
|
|
public static final int VT_VERSIONED_STREAM = 0x0049;
|
|
|
|
|
2002-02-13 23:00:59 -05:00
|
|
|
/**
|
2003-02-01 08:28:28 -05:00
|
|
|
* <p>[P] simple counted array. <span style="background-color:
|
|
|
|
* #ffff00">How long is this? How is it to be
|
|
|
|
* interpreted?</span></p>
|
2002-02-13 23:00:59 -05:00
|
|
|
*/
|
2003-07-26 17:17:17 -04:00
|
|
|
public static final int VT_VECTOR = 0x1000;
|
2002-02-13 23:00:59 -05:00
|
|
|
|
|
|
|
/**
|
2003-02-01 08:28:28 -05:00
|
|
|
* <p>[V] SAFEARRAY*. <span style="background-color: #ffff00">How
|
|
|
|
* long is this? How is it to be interpreted?</span></p>
|
2002-02-13 23:00:59 -05:00
|
|
|
*/
|
2003-07-26 17:17:17 -04:00
|
|
|
public static final int VT_ARRAY = 0x2000;
|
2002-02-13 23:00:59 -05:00
|
|
|
|
|
|
|
/**
|
2003-02-01 08:28:28 -05:00
|
|
|
* <p>[V] void* for local use. <span style="background-color:
|
|
|
|
* #ffff00">How long is this? How is it to be
|
|
|
|
* interpreted?</span></p>
|
2002-02-13 23:00:59 -05:00
|
|
|
*/
|
2003-07-26 17:17:17 -04:00
|
|
|
public static final int VT_BYREF = 0x4000;
|
2002-02-13 23:00:59 -05:00
|
|
|
|
2003-07-26 17:17:17 -04:00
|
|
|
/**
|
2003-08-30 05:13:53 -04:00
|
|
|
* <p>FIXME (3): Document this!</p>
|
2003-07-26 17:17:17 -04:00
|
|
|
*/
|
|
|
|
public static final int VT_RESERVED = 0x8000;
|
2002-02-13 23:00:59 -05:00
|
|
|
|
2003-07-26 17:17:17 -04:00
|
|
|
/**
|
2003-08-30 05:13:53 -04:00
|
|
|
* <p>FIXME (3): Document this!</p>
|
2003-07-26 17:17:17 -04:00
|
|
|
*/
|
|
|
|
public static final int VT_ILLEGAL = 0xFFFF;
|
2002-02-13 23:00:59 -05:00
|
|
|
|
2003-07-26 17:17:17 -04:00
|
|
|
/**
|
2003-08-30 05:13:53 -04:00
|
|
|
* <p>FIXME (3): Document this!</p>
|
2003-07-26 17:17:17 -04:00
|
|
|
*/
|
|
|
|
public static final int VT_ILLEGALMASKED = 0xFFF;
|
2002-02-13 23:00:59 -05:00
|
|
|
|
2003-07-26 17:17:17 -04:00
|
|
|
/**
|
2003-08-30 05:13:53 -04:00
|
|
|
* <p>FIXME (3): Document this!</p>
|
2003-07-26 17:17:17 -04:00
|
|
|
*/
|
|
|
|
public static final int VT_TYPEMASK = 0xFFF;
|
2002-02-13 23:00:59 -05:00
|
|
|
|
2003-08-23 11:12:22 -04:00
|
|
|
|
|
|
|
|
2003-08-30 05:13:53 -04:00
|
|
|
/**
|
|
|
|
* <p>Maps the numbers denoting the variant types to their corresponding
|
|
|
|
* variant type names.</p>
|
|
|
|
*/
|
2014-12-28 04:06:12 -05:00
|
|
|
private static Map<Long,String> numberToName;
|
2003-08-30 05:13:53 -04:00
|
|
|
|
2014-12-28 04:06:12 -05:00
|
|
|
private static Map<Long,Integer> numberToLength;
|
2003-08-30 05:13:53 -04:00
|
|
|
|
|
|
|
/**
|
|
|
|
* <p>Denotes a variant type with a length that is unknown to HPSF yet.</p>
|
|
|
|
*/
|
2009-10-08 18:29:41 -04:00
|
|
|
public static final Integer LENGTH_UNKNOWN = Integer.valueOf(-2);
|
2003-08-30 05:13:53 -04:00
|
|
|
|
|
|
|
/**
|
|
|
|
* <p>Denotes a variant type with a variable length.</p>
|
|
|
|
*/
|
2009-10-08 18:29:41 -04:00
|
|
|
public static final Integer LENGTH_VARIABLE = Integer.valueOf(-1);
|
2003-08-30 05:13:53 -04:00
|
|
|
|
|
|
|
/**
|
|
|
|
* <p>Denotes a variant type with a length of 0 bytes.</p>
|
|
|
|
*/
|
2009-10-08 18:29:41 -04:00
|
|
|
public static final Integer LENGTH_0 = Integer.valueOf(0);
|
2003-08-30 05:13:53 -04:00
|
|
|
|
|
|
|
/**
|
|
|
|
* <p>Denotes a variant type with a length of 2 bytes.</p>
|
|
|
|
*/
|
2009-10-08 18:29:41 -04:00
|
|
|
public static final Integer LENGTH_2 = Integer.valueOf(2);
|
2003-08-30 05:13:53 -04:00
|
|
|
|
|
|
|
/**
|
|
|
|
* <p>Denotes a variant type with a length of 4 bytes.</p>
|
|
|
|
*/
|
2009-10-08 18:29:41 -04:00
|
|
|
public static final Integer LENGTH_4 = Integer.valueOf(4);
|
2003-08-30 05:13:53 -04:00
|
|
|
|
|
|
|
/**
|
|
|
|
* <p>Denotes a variant type with a length of 8 bytes.</p>
|
|
|
|
*/
|
2009-10-08 18:29:41 -04:00
|
|
|
public static final Integer LENGTH_8 = Integer.valueOf(8);
|
2003-08-30 05:13:53 -04:00
|
|
|
|
|
|
|
|
2003-08-23 11:12:22 -04:00
|
|
|
|
|
|
|
static
|
|
|
|
{
|
2003-08-30 05:13:53 -04:00
|
|
|
/* Initialize the number-to-name map: */
|
2014-12-28 04:06:12 -05:00
|
|
|
Map<Long,String> tm1 = new HashMap<Long,String>();
|
2009-10-08 18:29:41 -04:00
|
|
|
tm1.put(Long.valueOf(0), "VT_EMPTY");
|
|
|
|
tm1.put(Long.valueOf(1), "VT_NULL");
|
|
|
|
tm1.put(Long.valueOf(2), "VT_I2");
|
|
|
|
tm1.put(Long.valueOf(3), "VT_I4");
|
|
|
|
tm1.put(Long.valueOf(4), "VT_R4");
|
|
|
|
tm1.put(Long.valueOf(5), "VT_R8");
|
|
|
|
tm1.put(Long.valueOf(6), "VT_CY");
|
|
|
|
tm1.put(Long.valueOf(7), "VT_DATE");
|
|
|
|
tm1.put(Long.valueOf(8), "VT_BSTR");
|
|
|
|
tm1.put(Long.valueOf(9), "VT_DISPATCH");
|
|
|
|
tm1.put(Long.valueOf(10), "VT_ERROR");
|
|
|
|
tm1.put(Long.valueOf(11), "VT_BOOL");
|
|
|
|
tm1.put(Long.valueOf(12), "VT_VARIANT");
|
|
|
|
tm1.put(Long.valueOf(13), "VT_UNKNOWN");
|
|
|
|
tm1.put(Long.valueOf(14), "VT_DECIMAL");
|
|
|
|
tm1.put(Long.valueOf(16), "VT_I1");
|
|
|
|
tm1.put(Long.valueOf(17), "VT_UI1");
|
|
|
|
tm1.put(Long.valueOf(18), "VT_UI2");
|
|
|
|
tm1.put(Long.valueOf(19), "VT_UI4");
|
|
|
|
tm1.put(Long.valueOf(20), "VT_I8");
|
|
|
|
tm1.put(Long.valueOf(21), "VT_UI8");
|
|
|
|
tm1.put(Long.valueOf(22), "VT_INT");
|
|
|
|
tm1.put(Long.valueOf(23), "VT_UINT");
|
|
|
|
tm1.put(Long.valueOf(24), "VT_VOID");
|
|
|
|
tm1.put(Long.valueOf(25), "VT_HRESULT");
|
|
|
|
tm1.put(Long.valueOf(26), "VT_PTR");
|
|
|
|
tm1.put(Long.valueOf(27), "VT_SAFEARRAY");
|
|
|
|
tm1.put(Long.valueOf(28), "VT_CARRAY");
|
|
|
|
tm1.put(Long.valueOf(29), "VT_USERDEFINED");
|
|
|
|
tm1.put(Long.valueOf(30), "VT_LPSTR");
|
|
|
|
tm1.put(Long.valueOf(31), "VT_LPWSTR");
|
|
|
|
tm1.put(Long.valueOf(64), "VT_FILETIME");
|
|
|
|
tm1.put(Long.valueOf(65), "VT_BLOB");
|
|
|
|
tm1.put(Long.valueOf(66), "VT_STREAM");
|
|
|
|
tm1.put(Long.valueOf(67), "VT_STORAGE");
|
|
|
|
tm1.put(Long.valueOf(68), "VT_STREAMED_OBJECT");
|
|
|
|
tm1.put(Long.valueOf(69), "VT_STORED_OBJECT");
|
|
|
|
tm1.put(Long.valueOf(70), "VT_BLOB_OBJECT");
|
|
|
|
tm1.put(Long.valueOf(71), "VT_CF");
|
|
|
|
tm1.put(Long.valueOf(72), "VT_CLSID");
|
2014-12-28 04:06:12 -05:00
|
|
|
Map<Long,String> tm2 = new HashMap<Long,String>(tm1.size(), 1.0F);
|
2003-08-30 05:13:53 -04:00
|
|
|
tm2.putAll(tm1);
|
|
|
|
numberToName = Collections.unmodifiableMap(tm2);
|
|
|
|
|
|
|
|
/* Initialize the number-to-length map: */
|
2014-12-28 04:06:12 -05:00
|
|
|
Map<Long,Integer> tm3 = new HashMap<Long,Integer>();
|
|
|
|
tm3.put(Long.valueOf(0), LENGTH_0);
|
|
|
|
tm3.put(Long.valueOf(1), LENGTH_UNKNOWN);
|
|
|
|
tm3.put(Long.valueOf(2), LENGTH_2);
|
|
|
|
tm3.put(Long.valueOf(3), LENGTH_4);
|
|
|
|
tm3.put(Long.valueOf(4), LENGTH_4);
|
|
|
|
tm3.put(Long.valueOf(5), LENGTH_8);
|
|
|
|
tm3.put(Long.valueOf(6), LENGTH_UNKNOWN);
|
|
|
|
tm3.put(Long.valueOf(7), LENGTH_UNKNOWN);
|
|
|
|
tm3.put(Long.valueOf(8), LENGTH_UNKNOWN);
|
|
|
|
tm3.put(Long.valueOf(9), LENGTH_UNKNOWN);
|
|
|
|
tm3.put(Long.valueOf(10), LENGTH_UNKNOWN);
|
|
|
|
tm3.put(Long.valueOf(11), LENGTH_UNKNOWN);
|
|
|
|
tm3.put(Long.valueOf(12), LENGTH_UNKNOWN);
|
|
|
|
tm3.put(Long.valueOf(13), LENGTH_UNKNOWN);
|
|
|
|
tm3.put(Long.valueOf(14), LENGTH_UNKNOWN);
|
|
|
|
tm3.put(Long.valueOf(16), LENGTH_UNKNOWN);
|
|
|
|
tm3.put(Long.valueOf(17), LENGTH_UNKNOWN);
|
|
|
|
tm3.put(Long.valueOf(18), LENGTH_UNKNOWN);
|
|
|
|
tm3.put(Long.valueOf(19), LENGTH_UNKNOWN);
|
|
|
|
tm3.put(Long.valueOf(20), LENGTH_UNKNOWN);
|
|
|
|
tm3.put(Long.valueOf(21), LENGTH_UNKNOWN);
|
|
|
|
tm3.put(Long.valueOf(22), LENGTH_UNKNOWN);
|
|
|
|
tm3.put(Long.valueOf(23), LENGTH_UNKNOWN);
|
|
|
|
tm3.put(Long.valueOf(24), LENGTH_UNKNOWN);
|
|
|
|
tm3.put(Long.valueOf(25), LENGTH_UNKNOWN);
|
|
|
|
tm3.put(Long.valueOf(26), LENGTH_UNKNOWN);
|
|
|
|
tm3.put(Long.valueOf(27), LENGTH_UNKNOWN);
|
|
|
|
tm3.put(Long.valueOf(28), LENGTH_UNKNOWN);
|
|
|
|
tm3.put(Long.valueOf(29), LENGTH_UNKNOWN);
|
|
|
|
tm3.put(Long.valueOf(30), LENGTH_VARIABLE);
|
|
|
|
tm3.put(Long.valueOf(31), LENGTH_UNKNOWN);
|
|
|
|
tm3.put(Long.valueOf(64), LENGTH_8);
|
|
|
|
tm3.put(Long.valueOf(65), LENGTH_UNKNOWN);
|
|
|
|
tm3.put(Long.valueOf(66), LENGTH_UNKNOWN);
|
|
|
|
tm3.put(Long.valueOf(67), LENGTH_UNKNOWN);
|
|
|
|
tm3.put(Long.valueOf(68), LENGTH_UNKNOWN);
|
|
|
|
tm3.put(Long.valueOf(69), LENGTH_UNKNOWN);
|
|
|
|
tm3.put(Long.valueOf(70), LENGTH_UNKNOWN);
|
|
|
|
tm3.put(Long.valueOf(71), LENGTH_UNKNOWN);
|
|
|
|
tm3.put(Long.valueOf(72), LENGTH_UNKNOWN);
|
|
|
|
Map<Long,Integer> tm4 = new HashMap<Long,Integer>(tm1.size(), 1.0F);
|
|
|
|
tm4.putAll(tm3);
|
|
|
|
numberToLength = Collections.unmodifiableMap(tm4);
|
2003-08-23 11:12:22 -04:00
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
|
2003-08-30 05:13:53 -04:00
|
|
|
/**
|
|
|
|
* <p>Returns the variant type name associated with a variant type
|
|
|
|
* number.</p>
|
|
|
|
*
|
|
|
|
* @param variantType The variant type number
|
|
|
|
* @return The variant type name or the string "unknown variant type"
|
|
|
|
*/
|
2003-08-23 11:12:22 -04:00
|
|
|
public static String getVariantName(final long variantType)
|
|
|
|
{
|
2014-12-28 04:06:12 -05:00
|
|
|
final String name = numberToName.get(Long.valueOf(variantType));
|
2003-08-23 11:12:22 -04:00
|
|
|
return name != null ? name : "unknown variant type";
|
|
|
|
}
|
|
|
|
|
2003-08-30 05:13:53 -04:00
|
|
|
/**
|
|
|
|
* <p>Returns a variant type's length.</p>
|
|
|
|
*
|
|
|
|
* @param variantType The variant type number
|
|
|
|
* @return The length of the variant type's data in bytes. If the length is
|
|
|
|
* variable, i.e. the length of a string, -1 is returned. If HPSF does not
|
|
|
|
* know the length, -2 is returned. The latter usually indicates an
|
|
|
|
* unsupported variant type.
|
|
|
|
*/
|
|
|
|
public static int getVariantLength(final long variantType)
|
|
|
|
{
|
2009-10-08 18:29:41 -04:00
|
|
|
final Long key = Long.valueOf((int) variantType);
|
2014-12-28 04:06:12 -05:00
|
|
|
final Integer length = numberToLength.get(key);
|
2003-08-30 05:13:53 -04:00
|
|
|
if (length == null)
|
|
|
|
return -2;
|
|
|
|
return length.intValue();
|
|
|
|
}
|
|
|
|
|
|
|
|
}
|