oleaut32: Fix rounding.
[wine/multimedia.git] / dlls / oleaut32 / varformat.c
blob370b4f036298d5016116e377b42cf68053b52508
1 /*
2 * Variant formatting functions
4 * Copyright 2008 Damjan Jovanovic
5 * Copyright 2003 Jon Griffiths
7 * This library is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU Lesser General Public
9 * License as published by the Free Software Foundation; either
10 * version 2.1 of the License, or (at your option) any later version.
12 * This library is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * Lesser General Public License for more details.
17 * You should have received a copy of the GNU Lesser General Public
18 * License along with this library; if not, write to the Free Software
19 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
21 * NOTES
22 * Since the formatting functions aren't properly documented, I used the
23 * Visual Basic documentation as a guide to implementing these functions. This
24 * means that some named or user-defined formats may work slightly differently.
25 * Please submit a test case if you find a difference.
28 #include "config.h"
30 #include <string.h>
31 #include <stdlib.h>
32 #include <stdarg.h>
33 #include <stdio.h>
35 #define NONAMELESSUNION
36 #define NONAMELESSSTRUCT
37 #include "windef.h"
38 #include "winbase.h"
39 #include "wine/unicode.h"
40 #include "winerror.h"
41 #include "variant.h"
42 #include "wine/debug.h"
44 WINE_DEFAULT_DEBUG_CHANNEL(variant);
46 /* Make sure internal conversions to strings use the '.','+'/'-' and ','
47 * format chars from the US locale. This enables us to parse the created
48 * strings to determine the number of decimal places, exponent, etc.
50 #define LCID_US MAKELCID(MAKELANGID(LANG_ENGLISH,SUBLANG_ENGLISH_US),SORT_DEFAULT)
52 static const WCHAR szPercent_d[] = { '%','d','\0' };
53 static const WCHAR szPercentZeroTwo_d[] = { '%','0','2','d','\0' };
54 static const WCHAR szPercentZeroStar_d[] = { '%','0','*','d','\0' };
56 #if 0
57 #define dump_tokens(rgb) do { \
58 int i_; TRACE("Tokens->{\n"); \
59 for (i_ = 0; i_ < rgb[0]; i_++) \
60 TRACE("%s0x%02x", i_?",":"",rgb[i_]); \
61 TRACE(" }\n"); \
62 } while(0)
63 #endif
65 /******************************************************************************
66 * Variant-Formats {OLEAUT32}
68 * NOTES
69 * When formatting a variant a variety of format strings may be used to generate
70 * different kinds of formatted output. A format string consists of either a named
71 * format, or a user-defined format.
73 * The following named formats are defined:
74 *| Name Description
75 *| ---- -----------
76 *| General Date Display Date, and time for non-integer values
77 *| Short Date Short date format as defined by locale settings
78 *| Medium Date Medium date format as defined by locale settings
79 *| Long Date Long date format as defined by locale settings
80 *| Short Time Short Time format as defined by locale settings
81 *| Medium Time Medium time format as defined by locale settings
82 *| Long Time Long time format as defined by locale settings
83 *| True/False Localised text of "True" or "False"
84 *| Yes/No Localised text of "Yes" or "No"
85 *| On/Off Localised text of "On" or "Off"
86 *| General Number No thousands separator. No decimal points for integers
87 *| Currency General currency format using localised characters
88 *| Fixed At least one whole and two fractional digits
89 *| Standard Same as 'Fixed', but including decimal separators
90 *| Percent Multiply by 100 and display a trailing '%' character
91 *| Scientific Display with exponent
93 * User-defined formats consist of a combination of tokens and literal
94 * characters. Literal characters are copied unmodified to the formatted
95 * output at the position they occupy in the format string. Any character
96 * that is not recognised as a token is treated as a literal. A literal can
97 * also be specified by preceding it with a backslash character
98 * (e.g. "\L\i\t\e\r\a\l") or enclosing it in double quotes.
100 * A user-defined format can have up to 4 sections, depending on the type of
101 * format. The following table lists sections and their meaning:
102 *| Format Type Sections Meaning
103 *| ----------- -------- -------
104 *| Number 1 Use the same format for all numbers
105 *| Number 2 Use format 1 for positive and 2 for negative numbers
106 *| Number 3 Use format 1 for positive, 2 for zero, and 3
107 *| for negative numbers.
108 *| Number 4 Use format 1 for positive, 2 for zero, 3 for
109 *| negative, and 4 for null numbers.
110 *| String 1 Use the same format for all strings
111 *| String 2 Use format 2 for null and empty strings, otherwise
112 *| use format 1.
113 *| Date 1 Use the same format for all dates
115 * The formatting tokens fall into several categories depending on the type
116 * of formatted output. For more information on each type, see
117 * VarFormat-Dates(), VarFormat-Strings() and VarFormat-Numbers().
119 * SEE ALSO
120 * VarTokenizeFormatString(), VarFormatFromTokens(), VarFormat(),
121 * VarFormatDateTime(), VarFormatNumber(), VarFormatCurrency().
124 /******************************************************************************
125 * VarFormat-Strings {OLEAUT32}
127 * NOTES
128 * When formatting a variant as a string, it is first converted to a VT_BSTR.
129 * The user-format string defines which characters are copied into which
130 * positions in the output string. Literals may be inserted in the format
131 * string. When creating the formatted string, excess characters in the string
132 * (those not consumed by a token) are appended to the end of the output. If
133 * there are more tokens than characters in the string to format, spaces will
134 * be inserted at the start of the string if the '@' token was used.
136 * By default strings are converted to lowercase, or uppercase if the '>' token
137 * is encountered. This applies to the whole string: it is not possible to
138 * generate a mixed-case output string.
140 * In user-defined string formats, the following tokens are recognised:
141 *| Token Description
142 *| ----- -----------
143 *| '@' Copy a char from the source, or a space if no chars are left.
144 *| '&' Copy a char from the source, or write nothing if no chars are left.
145 *| '<' Output the whole string as lower-case (the default).
146 *| '>' Output the whole string as upper-case.
147 *| '!' MSDN indicates that this character should cause right-to-left
148 *| copying, however tests show that it is tokenised but not processed.
152 * Common format definitions
155 /* Format types */
156 #define FMT_TYPE_UNKNOWN 0x0
157 #define FMT_TYPE_GENERAL 0x1
158 #define FMT_TYPE_NUMBER 0x2
159 #define FMT_TYPE_DATE 0x3
160 #define FMT_TYPE_STRING 0x4
162 #define FMT_TO_STRING 0x0 /* If header->size == this, act like VB's Str() fn */
164 typedef struct tagFMT_SHORT_HEADER
166 BYTE size; /* Size of tokenised block (including header), or FMT_TO_STRING */
167 BYTE type; /* Allowable types (FMT_TYPE_*) */
168 BYTE offset[1]; /* Offset of the first (and only) format section */
169 } FMT_SHORT_HEADER;
171 typedef struct tagFMT_HEADER
173 BYTE size; /* Total size of the whole tokenised block (including header) */
174 BYTE type; /* Allowable types (FMT_TYPE_*) */
175 BYTE starts[4]; /* Offset of each of the 4 format sections, or 0 if none */
176 } FMT_HEADER;
178 #define FmtGetPositive(x) (x->starts[0])
179 #define FmtGetNegative(x) (x->starts[1] ? x->starts[1] : x->starts[0])
180 #define FmtGetZero(x) (x->starts[2] ? x->starts[2] : x->starts[0])
181 #define FmtGetNull(x) (x->starts[3] ? x->starts[3] : x->starts[0])
184 * String formats
187 #define FMT_FLAG_LT 0x1 /* Has '<' (lower case) */
188 #define FMT_FLAG_GT 0x2 /* Has '>' (upper case) */
189 #define FMT_FLAG_RTL 0x4 /* Has '!' (Copy right to left) */
191 typedef struct tagFMT_STRING_HEADER
193 BYTE flags; /* LT, GT, RTL */
194 BYTE unknown1;
195 BYTE unknown2;
196 BYTE copy_chars; /* Number of chars to be copied */
197 BYTE unknown3;
198 } FMT_STRING_HEADER;
201 * Number formats
204 #define FMT_FLAG_PERCENT 0x1 /* Has '%' (Percentage) */
205 #define FMT_FLAG_EXPONENT 0x2 /* Has 'e' (Exponent/Scientific notation) */
206 #define FMT_FLAG_THOUSANDS 0x4 /* Has ',' (Standard use of the thousands separator) */
207 #define FMT_FLAG_BOOL 0x20 /* Boolean format */
209 typedef struct tagFMT_NUMBER_HEADER
211 BYTE flags; /* PERCENT, EXPONENT, THOUSANDS, BOOL */
212 BYTE multiplier; /* Multiplier, 100 for percentages */
213 BYTE divisor; /* Divisor, 1000 if '%%' was used */
214 BYTE whole; /* Number of digits before the decimal point */
215 BYTE fractional; /* Number of digits after the decimal point */
216 } FMT_NUMBER_HEADER;
219 * Date Formats
221 typedef struct tagFMT_DATE_HEADER
223 BYTE flags;
224 BYTE unknown1;
225 BYTE unknown2;
226 BYTE unknown3;
227 BYTE unknown4;
228 } FMT_DATE_HEADER;
231 * Format token values
233 #define FMT_GEN_COPY 0x00 /* \n, "lit" => 0,pos,len: Copy len chars from input+pos */
234 #define FMT_GEN_INLINE 0x01 /* => 1,len,[chars]: Copy len chars from token stream */
235 #define FMT_GEN_END 0x02 /* \0,; => 2: End of the tokenised format */
236 #define FMT_DATE_TIME_SEP 0x03 /* Time separator char */
237 #define FMT_DATE_DATE_SEP 0x04 /* Date separator char */
238 #define FMT_DATE_GENERAL 0x05 /* General format date */
239 #define FMT_DATE_QUARTER 0x06 /* Quarter of the year from 1-4 */
240 #define FMT_DATE_TIME_SYS 0x07 /* System long time format */
241 #define FMT_DATE_DAY 0x08 /* Day with no leading 0 */
242 #define FMT_DATE_DAY_0 0x09 /* Day with leading 0 */
243 #define FMT_DATE_DAY_SHORT 0x0A /* Short day name */
244 #define FMT_DATE_DAY_LONG 0x0B /* Long day name */
245 #define FMT_DATE_SHORT 0x0C /* Short date format */
246 #define FMT_DATE_LONG 0x0D /* Long date format */
247 #define FMT_DATE_MEDIUM 0x0E /* Medium date format */
248 #define FMT_DATE_DAY_WEEK 0x0F /* First day of the week */
249 #define FMT_DATE_WEEK_YEAR 0x10 /* First week of the year */
250 #define FMT_DATE_MON 0x11 /* Month with no leading 0 */
251 #define FMT_DATE_MON_0 0x12 /* Month with leading 0 */
252 #define FMT_DATE_MON_SHORT 0x13 /* Short month name */
253 #define FMT_DATE_MON_LONG 0x14 /* Long month name */
254 #define FMT_DATE_YEAR_DOY 0x15 /* Day of the year with no leading 0 */
255 #define FMT_DATE_YEAR_0 0x16 /* 2 digit year with leading 0 */
256 /* NOTE: token 0x17 is not defined, 'yyy' is not valid */
257 #define FMT_DATE_YEAR_LONG 0x18 /* 4 digit year */
258 #define FMT_DATE_MIN 0x1A /* Minutes with no leading 0 */
259 #define FMT_DATE_MIN_0 0x1B /* Minutes with leading 0 */
260 #define FMT_DATE_SEC 0x1C /* Seconds with no leading 0 */
261 #define FMT_DATE_SEC_0 0x1D /* Seconds with leading 0 */
262 #define FMT_DATE_HOUR 0x1E /* Hours with no leading 0 */
263 #define FMT_DATE_HOUR_0 0x1F /* Hours with leading 0 */
264 #define FMT_DATE_HOUR_12 0x20 /* Hours with no leading 0, 12 hour clock */
265 #define FMT_DATE_HOUR_12_0 0x21 /* Hours with leading 0, 12 hour clock */
266 #define FMT_DATE_TIME_UNK2 0x23
267 /* FIXME: probably missing some here */
268 #define FMT_DATE_AMPM_SYS1 0x2E /* AM/PM as defined by system settings */
269 #define FMT_DATE_AMPM_UPPER 0x2F /* Upper-case AM or PM */
270 #define FMT_DATE_A_UPPER 0x30 /* Upper-case A or P */
271 #define FMT_DATE_AMPM_SYS2 0x31 /* AM/PM as defined by system settings */
272 #define FMT_DATE_AMPM_LOWER 0x32 /* Lower-case AM or PM */
273 #define FMT_DATE_A_LOWER 0x33 /* Lower-case A or P */
274 #define FMT_NUM_COPY_ZERO 0x34 /* Copy 1 digit or 0 if no digit */
275 #define FMT_NUM_COPY_SKIP 0x35 /* Copy 1 digit or skip if no digit */
276 #define FMT_NUM_DECIMAL 0x36 /* Decimal separator */
277 #define FMT_NUM_EXP_POS_U 0x37 /* Scientific notation, uppercase, + sign */
278 #define FMT_NUM_EXP_NEG_U 0x38 /* Scientific notation, uppercase, - sign */
279 #define FMT_NUM_EXP_POS_L 0x39 /* Scientific notation, lowercase, + sign */
280 #define FMT_NUM_EXP_NEG_L 0x3A /* Scientific notation, lowercase, - sign */
281 #define FMT_NUM_CURRENCY 0x3B /* Currency symbol */
282 #define FMT_NUM_TRUE_FALSE 0x3D /* Convert to "True" or "False" */
283 #define FMT_NUM_YES_NO 0x3E /* Convert to "Yes" or "No" */
284 #define FMT_NUM_ON_OFF 0x3F /* Convert to "On" or "Off" */
285 #define FMT_STR_COPY_SPACE 0x40 /* Copy len chars with space if no char */
286 #define FMT_STR_COPY_SKIP 0x41 /* Copy len chars or skip if no char */
287 /* Wine additions */
288 #define FMT_WINE_HOURS_12 0x81 /* Hours using 12 hour clock */
290 /* Named Formats and their tokenised values */
291 static const WCHAR szGeneralDate[] = { 'G','e','n','e','r','a','l',' ','D','a','t','e','\0' };
292 static const BYTE fmtGeneralDate[0x0a] =
294 0x0a,FMT_TYPE_DATE,sizeof(FMT_SHORT_HEADER),
295 0x0,0x0,0x0,0x0,0x0,
296 FMT_DATE_GENERAL,FMT_GEN_END
299 static const WCHAR szShortDate[] = { 'S','h','o','r','t',' ','D','a','t','e','\0' };
300 static const BYTE fmtShortDate[0x0a] =
302 0x0a,FMT_TYPE_DATE,sizeof(FMT_SHORT_HEADER),
303 0x0,0x0,0x0,0x0,0x0,
304 FMT_DATE_SHORT,FMT_GEN_END
307 static const WCHAR szMediumDate[] = { 'M','e','d','i','u','m',' ','D','a','t','e','\0' };
308 static const BYTE fmtMediumDate[0x0a] =
310 0x0a,FMT_TYPE_DATE,sizeof(FMT_SHORT_HEADER),
311 0x0,0x0,0x0,0x0,0x0,
312 FMT_DATE_MEDIUM,FMT_GEN_END
315 static const WCHAR szLongDate[] = { 'L','o','n','g',' ','D','a','t','e','\0' };
316 static const BYTE fmtLongDate[0x0a] =
318 0x0a,FMT_TYPE_DATE,sizeof(FMT_SHORT_HEADER),
319 0x0,0x0,0x0,0x0,0x0,
320 FMT_DATE_LONG,FMT_GEN_END
323 static const WCHAR szShortTime[] = { 'S','h','o','r','t',' ','T','i','m','e','\0' };
324 static const BYTE fmtShortTime[0x0c] =
326 0x0c,FMT_TYPE_DATE,sizeof(FMT_SHORT_HEADER),
327 0x0,0x0,0x0,0x0,0x0,
328 FMT_DATE_TIME_UNK2,FMT_DATE_TIME_SEP,FMT_DATE_MIN_0,FMT_GEN_END
331 static const WCHAR szMediumTime[] = { 'M','e','d','i','u','m',' ','T','i','m','e','\0' };
332 static const BYTE fmtMediumTime[0x11] =
334 0x11,FMT_TYPE_DATE,sizeof(FMT_SHORT_HEADER),
335 0x0,0x0,0x0,0x0,0x0,
336 FMT_DATE_HOUR_12_0,FMT_DATE_TIME_SEP,FMT_DATE_MIN_0,
337 FMT_GEN_INLINE,0x01,' ','\0',FMT_DATE_AMPM_SYS1,FMT_GEN_END
340 static const WCHAR szLongTime[] = { 'L','o','n','g',' ','T','i','m','e','\0' };
341 static const BYTE fmtLongTime[0x0d] =
343 0x0a,FMT_TYPE_DATE,sizeof(FMT_SHORT_HEADER),
344 0x0,0x0,0x0,0x0,0x0,
345 FMT_DATE_TIME_SYS,FMT_GEN_END
348 static const WCHAR szTrueFalse[] = { 'T','r','u','e','/','F','a','l','s','e','\0' };
349 static const BYTE fmtTrueFalse[0x0d] =
351 0x0d,FMT_TYPE_NUMBER,sizeof(FMT_HEADER),0x0,0x0,0x0,
352 FMT_FLAG_BOOL,0x0,0x0,0x0,0x0,
353 FMT_NUM_TRUE_FALSE,FMT_GEN_END
356 static const WCHAR szYesNo[] = { 'Y','e','s','/','N','o','\0' };
357 static const BYTE fmtYesNo[0x0d] =
359 0x0d,FMT_TYPE_NUMBER,sizeof(FMT_HEADER),0x0,0x0,0x0,
360 FMT_FLAG_BOOL,0x0,0x0,0x0,0x0,
361 FMT_NUM_YES_NO,FMT_GEN_END
364 static const WCHAR szOnOff[] = { 'O','n','/','O','f','f','\0' };
365 static const BYTE fmtOnOff[0x0d] =
367 0x0d,FMT_TYPE_NUMBER,sizeof(FMT_HEADER),0x0,0x0,0x0,
368 FMT_FLAG_BOOL,0x0,0x0,0x0,0x0,
369 FMT_NUM_ON_OFF,FMT_GEN_END
372 static const WCHAR szGeneralNumber[] = { 'G','e','n','e','r','a','l',' ','N','u','m','b','e','r','\0' };
373 static const BYTE fmtGeneralNumber[sizeof(FMT_HEADER)] =
375 sizeof(FMT_HEADER),FMT_TYPE_GENERAL,sizeof(FMT_HEADER),0x0,0x0,0x0
378 static const WCHAR szCurrency[] = { 'C','u','r','r','e','n','c','y','\0' };
379 static const BYTE fmtCurrency[0x26] =
381 0x26,FMT_TYPE_NUMBER,sizeof(FMT_HEADER),0x12,0x0,0x0,
382 /* Positive numbers */
383 FMT_FLAG_THOUSANDS,0xcc,0x0,0x1,0x2,
384 FMT_NUM_CURRENCY,FMT_NUM_COPY_ZERO,0x1,FMT_NUM_DECIMAL,FMT_NUM_COPY_ZERO,0x2,
385 FMT_GEN_END,
386 /* Negative numbers */
387 FMT_FLAG_THOUSANDS,0xcc,0x0,0x1,0x2,
388 FMT_GEN_INLINE,0x1,'(','\0',FMT_NUM_CURRENCY,FMT_NUM_COPY_ZERO,0x1,
389 FMT_NUM_DECIMAL,FMT_NUM_COPY_ZERO,0x2,FMT_GEN_INLINE,0x1,')','\0',
390 FMT_GEN_END
393 static const WCHAR szFixed[] = { 'F','i','x','e','d','\0' };
394 static const BYTE fmtFixed[0x11] =
396 0x11,FMT_TYPE_NUMBER,sizeof(FMT_HEADER),0x0,0x0,0x0,
397 0x0,0x0,0x0,0x1,0x2,
398 FMT_NUM_COPY_ZERO,0x1,FMT_NUM_DECIMAL,FMT_NUM_COPY_ZERO,0x2,FMT_GEN_END
401 static const WCHAR szStandard[] = { 'S','t','a','n','d','a','r','d','\0' };
402 static const BYTE fmtStandard[0x11] =
404 0x11,FMT_TYPE_NUMBER,sizeof(FMT_HEADER),0x0,0x0,0x0,
405 FMT_FLAG_THOUSANDS,0x0,0x0,0x1,0x2,
406 FMT_NUM_COPY_ZERO,0x1,FMT_NUM_DECIMAL,FMT_NUM_COPY_ZERO,0x2,FMT_GEN_END
409 static const WCHAR szPercent[] = { 'P','e','r','c','e','n','t','\0' };
410 static const BYTE fmtPercent[0x15] =
412 0x15,FMT_TYPE_NUMBER,sizeof(FMT_HEADER),0x0,0x0,0x0,
413 FMT_FLAG_PERCENT,0x1,0x0,0x1,0x2,
414 FMT_NUM_COPY_ZERO,0x1,FMT_NUM_DECIMAL,FMT_NUM_COPY_ZERO,0x2,
415 FMT_GEN_INLINE,0x1,'%','\0',FMT_GEN_END
418 static const WCHAR szScientific[] = { 'S','c','i','e','n','t','i','f','i','c','\0' };
419 static const BYTE fmtScientific[0x13] =
421 0x13,FMT_TYPE_NUMBER,sizeof(FMT_HEADER),0x0,0x0,0x0,
422 FMT_FLAG_EXPONENT,0x0,0x0,0x1,0x2,
423 FMT_NUM_COPY_ZERO,0x1,FMT_NUM_DECIMAL,FMT_NUM_COPY_ZERO,0x2,FMT_NUM_EXP_POS_U,0x2,FMT_GEN_END
426 typedef struct tagNAMED_FORMAT
428 LPCWSTR name;
429 const BYTE* format;
430 } NAMED_FORMAT;
432 /* Format name to tokenised format. Must be kept sorted by name */
433 static const NAMED_FORMAT VARIANT_NamedFormats[] =
435 { szCurrency, fmtCurrency },
436 { szFixed, fmtFixed },
437 { szGeneralDate, fmtGeneralDate },
438 { szGeneralNumber, fmtGeneralNumber },
439 { szLongDate, fmtLongDate },
440 { szLongTime, fmtLongTime },
441 { szMediumDate, fmtMediumDate },
442 { szMediumTime, fmtMediumTime },
443 { szOnOff, fmtOnOff },
444 { szPercent, fmtPercent },
445 { szScientific, fmtScientific },
446 { szShortDate, fmtShortDate },
447 { szShortTime, fmtShortTime },
448 { szStandard, fmtStandard },
449 { szTrueFalse, fmtTrueFalse },
450 { szYesNo, fmtYesNo }
452 typedef const NAMED_FORMAT *LPCNAMED_FORMAT;
454 static int FormatCompareFn(const void *l, const void *r)
456 return strcmpiW(((LPCNAMED_FORMAT)l)->name, ((LPCNAMED_FORMAT)r)->name);
459 static inline const BYTE *VARIANT_GetNamedFormat(LPCWSTR lpszFormat)
461 NAMED_FORMAT key;
462 LPCNAMED_FORMAT fmt;
464 key.name = lpszFormat;
465 fmt = bsearch(&key, VARIANT_NamedFormats,
466 sizeof(VARIANT_NamedFormats)/sizeof(NAMED_FORMAT),
467 sizeof(NAMED_FORMAT), FormatCompareFn);
468 return fmt ? fmt->format : NULL;
471 /* Return an error if the token for the value will not fit in the destination */
472 #define NEED_SPACE(x) if (cbTok < (int)(x)) return TYPE_E_BUFFERTOOSMALL; cbTok -= (x)
474 /* Non-zero if the format is unknown or a given type */
475 #define COULD_BE(typ) ((!fmt_number && header->type==FMT_TYPE_UNKNOWN)||header->type==typ)
477 /* State during tokenising */
478 #define FMT_STATE_OPEN_COPY 0x1 /* Last token written was a copy */
479 #define FMT_STATE_WROTE_DECIMAL 0x2 /* Already wrote a decimal separator */
480 #define FMT_STATE_SEEN_HOURS 0x4 /* See the hh specifier */
481 #define FMT_STATE_WROTE_MINUTES 0x8 /* Wrote minutes */
483 /**********************************************************************
484 * VarTokenizeFormatString [OLEAUT32.140]
486 * Convert a format string into tokenised form.
488 * PARAMS
489 * lpszFormat [I] Format string to tokenise
490 * rgbTok [O] Destination for tokenised format
491 * cbTok [I] Size of rgbTok in bytes
492 * nFirstDay [I] First day of the week (1-7, or 0 for current system default)
493 * nFirstWeek [I] How to treat the first week (see notes)
494 * lcid [I] Locale Id of the format string
495 * pcbActual [O] If non-NULL, filled with the first token generated
497 * RETURNS
498 * Success: S_OK. rgbTok contains the tokenised format.
499 * Failure: E_INVALIDARG, if any argument is invalid.
500 * TYPE_E_BUFFERTOOSMALL, if rgbTok is not large enough.
502 * NOTES
503 * Valid values for the nFirstWeek parameter are:
504 *| Value Meaning
505 *| ----- -------
506 *| 0 Use the current system default
507 *| 1 The first week is that containing Jan 1
508 *| 2 Four or more days of the first week are in the current year
509 *| 3 The first week is 7 days long
510 * See Variant-Formats(), VarFormatFromTokens().
512 HRESULT WINAPI VarTokenizeFormatString(LPOLESTR lpszFormat, LPBYTE rgbTok,
513 int cbTok, int nFirstDay, int nFirstWeek,
514 LCID lcid, int *pcbActual)
516 /* Note: none of these strings should be NUL terminated */
517 static const WCHAR szTTTTT[] = { 't','t','t','t','t' };
518 static const WCHAR szAMPM[] = { 'A','M','P','M' };
519 static const WCHAR szampm[] = { 'a','m','p','m' };
520 static const WCHAR szAMSlashPM[] = { 'A','M','/','P','M' };
521 static const WCHAR szamSlashpm[] = { 'a','m','/','p','m' };
522 const BYTE *namedFmt;
523 FMT_HEADER *header = (FMT_HEADER*)rgbTok;
524 FMT_STRING_HEADER *str_header = (FMT_STRING_HEADER*)(rgbTok + sizeof(FMT_HEADER));
525 FMT_NUMBER_HEADER *num_header = (FMT_NUMBER_HEADER*)str_header;
526 BYTE* pOut = rgbTok + sizeof(FMT_HEADER) + sizeof(FMT_STRING_HEADER);
527 BYTE* pLastHours = NULL;
528 BYTE fmt_number = 0;
529 DWORD fmt_state = 0;
530 LPCWSTR pFormat = lpszFormat;
532 TRACE("(%s,%p,%d,%d,%d,0x%08x,%p)\n", debugstr_w(lpszFormat), rgbTok, cbTok,
533 nFirstDay, nFirstWeek, lcid, pcbActual);
535 if (!rgbTok ||
536 nFirstDay < 0 || nFirstDay > 7 || nFirstWeek < 0 || nFirstWeek > 3)
537 return E_INVALIDARG;
539 if (!lpszFormat || !*lpszFormat)
541 /* An empty string means 'general format' */
542 NEED_SPACE(sizeof(BYTE));
543 *rgbTok = FMT_TO_STRING;
544 if (pcbActual)
545 *pcbActual = FMT_TO_STRING;
546 return S_OK;
549 if (cbTok > 255)
550 cbTok = 255; /* Ensure we error instead of wrapping */
552 /* Named formats */
553 namedFmt = VARIANT_GetNamedFormat(lpszFormat);
554 if (namedFmt)
556 NEED_SPACE(namedFmt[0]);
557 memcpy(rgbTok, namedFmt, namedFmt[0]);
558 TRACE("Using pre-tokenised named format %s\n", debugstr_w(lpszFormat));
559 /* FIXME: pcbActual */
560 return S_OK;
563 /* Insert header */
564 NEED_SPACE(sizeof(FMT_HEADER) + sizeof(FMT_STRING_HEADER));
565 memset(header, 0, sizeof(FMT_HEADER));
566 memset(str_header, 0, sizeof(FMT_STRING_HEADER));
568 header->starts[fmt_number] = sizeof(FMT_HEADER);
570 while (*pFormat)
572 /* --------------
573 * General tokens
574 * --------------
576 if (*pFormat == ';')
578 while (*pFormat == ';')
580 TRACE(";\n");
581 if (++fmt_number > 3)
582 return E_INVALIDARG; /* too many formats */
583 pFormat++;
585 if (*pFormat)
587 TRACE("New header\n");
588 NEED_SPACE(sizeof(BYTE) + sizeof(FMT_STRING_HEADER));
589 *pOut++ = FMT_GEN_END;
591 header->starts[fmt_number] = pOut - rgbTok;
592 str_header = (FMT_STRING_HEADER*)pOut;
593 num_header = (FMT_NUMBER_HEADER*)pOut;
594 memset(str_header, 0, sizeof(FMT_STRING_HEADER));
595 pOut += sizeof(FMT_STRING_HEADER);
596 fmt_state = 0;
597 pLastHours = NULL;
600 else if (*pFormat == '\\')
602 /* Escaped character */
603 if (pFormat[1])
605 NEED_SPACE(3 * sizeof(BYTE));
606 pFormat++;
607 *pOut++ = FMT_GEN_COPY;
608 *pOut++ = pFormat - lpszFormat;
609 *pOut++ = 0x1;
610 fmt_state |= FMT_STATE_OPEN_COPY;
611 TRACE("'\\'\n");
613 else
614 fmt_state &= ~FMT_STATE_OPEN_COPY;
615 pFormat++;
617 else if (*pFormat == '"')
619 /* Escaped string
620 * Note: Native encodes "" as a copy of length zero. That's just dumb, so
621 * here we avoid encoding anything in this case.
623 if (!pFormat[1])
624 pFormat++;
625 else if (pFormat[1] == '"')
627 pFormat += 2;
629 else
631 LPCWSTR start = ++pFormat;
632 while (*pFormat && *pFormat != '"')
633 pFormat++;
634 NEED_SPACE(3 * sizeof(BYTE));
635 *pOut++ = FMT_GEN_COPY;
636 *pOut++ = start - lpszFormat;
637 *pOut++ = pFormat - start;
638 if (*pFormat == '"')
639 pFormat++;
640 TRACE("Quoted string pos %d, len %d\n", pOut[-2], pOut[-1]);
642 fmt_state &= ~FMT_STATE_OPEN_COPY;
644 /* -------------
645 * Number tokens
646 * -------------
648 else if (*pFormat == '0' && COULD_BE(FMT_TYPE_NUMBER))
650 /* Number formats: Digit from number or '0' if no digits
651 * Other formats: Literal
652 * Types the format if found
654 header->type = FMT_TYPE_NUMBER;
655 NEED_SPACE(2 * sizeof(BYTE));
656 *pOut++ = FMT_NUM_COPY_ZERO;
657 *pOut = 0x0;
658 while (*pFormat == '0')
660 *pOut = *pOut + 1;
661 pFormat++;
663 if (fmt_state & FMT_STATE_WROTE_DECIMAL)
664 num_header->fractional += *pOut;
665 else
666 num_header->whole += *pOut;
667 TRACE("%d 0's\n", *pOut);
668 pOut++;
669 fmt_state &= ~FMT_STATE_OPEN_COPY;
671 else if (*pFormat == '#' && COULD_BE(FMT_TYPE_NUMBER))
673 /* Number formats: Digit from number or blank if no digits
674 * Other formats: Literal
675 * Types the format if found
677 header->type = FMT_TYPE_NUMBER;
678 NEED_SPACE(2 * sizeof(BYTE));
679 *pOut++ = FMT_NUM_COPY_SKIP;
680 *pOut = 0x0;
681 while (*pFormat == '#')
683 *pOut = *pOut + 1;
684 pFormat++;
686 if (fmt_state & FMT_STATE_WROTE_DECIMAL)
687 num_header->fractional += *pOut;
688 else
689 num_header->whole += *pOut;
690 TRACE("%d #'s\n", *pOut);
691 pOut++;
692 fmt_state &= ~FMT_STATE_OPEN_COPY;
694 else if (*pFormat == '.' && COULD_BE(FMT_TYPE_NUMBER) &&
695 !(fmt_state & FMT_STATE_WROTE_DECIMAL))
697 /* Number formats: Decimal separator when 1st seen, literal thereafter
698 * Other formats: Literal
699 * Types the format if found
701 header->type = FMT_TYPE_NUMBER;
702 NEED_SPACE(sizeof(BYTE));
703 *pOut++ = FMT_NUM_DECIMAL;
704 fmt_state |= FMT_STATE_WROTE_DECIMAL;
705 fmt_state &= ~FMT_STATE_OPEN_COPY;
706 pFormat++;
707 TRACE("decimal sep\n");
709 else if ((*pFormat == 'e' || *pFormat == 'E') && (pFormat[1] == '-' ||
710 pFormat[1] == '+') && header->type == FMT_TYPE_NUMBER)
712 /* Number formats: Exponent specifier
713 * Other formats: Literal
715 num_header->flags |= FMT_FLAG_EXPONENT;
716 NEED_SPACE(2 * sizeof(BYTE));
717 if (*pFormat == 'e') {
718 if (pFormat[1] == '+')
719 *pOut = FMT_NUM_EXP_POS_L;
720 else
721 *pOut = FMT_NUM_EXP_NEG_L;
722 } else {
723 if (pFormat[1] == '+')
724 *pOut = FMT_NUM_EXP_POS_U;
725 else
726 *pOut = FMT_NUM_EXP_NEG_U;
728 pFormat += 2;
729 *++pOut = 0x0;
730 while (*pFormat == '0')
732 *pOut = *pOut + 1;
733 pFormat++;
735 pOut++;
736 TRACE("exponent\n");
738 /* FIXME: %% => Divide by 1000 */
739 else if (*pFormat == ',' && header->type == FMT_TYPE_NUMBER)
741 /* Number formats: Use the thousands separator
742 * Other formats: Literal
744 num_header->flags |= FMT_FLAG_THOUSANDS;
745 pFormat++;
746 fmt_state &= ~FMT_STATE_OPEN_COPY;
747 TRACE("thousands sep\n");
749 /* -----------
750 * Date tokens
751 * -----------
753 else if (*pFormat == '/' && COULD_BE(FMT_TYPE_DATE))
755 /* Date formats: Date separator
756 * Other formats: Literal
757 * Types the format if found
759 header->type = FMT_TYPE_DATE;
760 NEED_SPACE(sizeof(BYTE));
761 *pOut++ = FMT_DATE_DATE_SEP;
762 pFormat++;
763 fmt_state &= ~FMT_STATE_OPEN_COPY;
764 TRACE("date sep\n");
766 else if (*pFormat == ':' && COULD_BE(FMT_TYPE_DATE))
768 /* Date formats: Time separator
769 * Other formats: Literal
770 * Types the format if found
772 header->type = FMT_TYPE_DATE;
773 NEED_SPACE(sizeof(BYTE));
774 *pOut++ = FMT_DATE_TIME_SEP;
775 pFormat++;
776 fmt_state &= ~FMT_STATE_OPEN_COPY;
777 TRACE("time sep\n");
779 else if ((*pFormat == 'a' || *pFormat == 'A') &&
780 !strncmpiW(pFormat, szAMPM, sizeof(szAMPM)/sizeof(WCHAR)))
782 /* Date formats: System AM/PM designation
783 * Other formats: Literal
784 * Types the format if found
786 header->type = FMT_TYPE_DATE;
787 NEED_SPACE(sizeof(BYTE));
788 pFormat += sizeof(szAMPM)/sizeof(WCHAR);
789 if (!strncmpW(pFormat, szampm, sizeof(szampm)/sizeof(WCHAR)))
790 *pOut++ = FMT_DATE_AMPM_SYS2;
791 else
792 *pOut++ = FMT_DATE_AMPM_SYS1;
793 if (pLastHours)
794 *pLastHours = *pLastHours + 2;
795 TRACE("ampm\n");
797 else if (*pFormat == 'a' && pFormat[1] == '/' &&
798 (pFormat[2] == 'p' || pFormat[2] == 'P'))
800 /* Date formats: lowercase a or p designation
801 * Other formats: Literal
802 * Types the format if found
804 header->type = FMT_TYPE_DATE;
805 NEED_SPACE(sizeof(BYTE));
806 pFormat += 3;
807 *pOut++ = FMT_DATE_A_LOWER;
808 if (pLastHours)
809 *pLastHours = *pLastHours + 2;
810 TRACE("a/p\n");
812 else if (*pFormat == 'A' && pFormat[1] == '/' &&
813 (pFormat[2] == 'p' || pFormat[2] == 'P'))
815 /* Date formats: Uppercase a or p designation
816 * Other formats: Literal
817 * Types the format if found
819 header->type = FMT_TYPE_DATE;
820 NEED_SPACE(sizeof(BYTE));
821 pFormat += 3;
822 *pOut++ = FMT_DATE_A_UPPER;
823 if (pLastHours)
824 *pLastHours = *pLastHours + 2;
825 TRACE("A/P\n");
827 else if (*pFormat == 'a' &&
828 !strncmpW(pFormat, szamSlashpm, sizeof(szamSlashpm)/sizeof(WCHAR)))
830 /* Date formats: lowercase AM or PM designation
831 * Other formats: Literal
832 * Types the format if found
834 header->type = FMT_TYPE_DATE;
835 NEED_SPACE(sizeof(BYTE));
836 pFormat += sizeof(szamSlashpm)/sizeof(WCHAR);
837 *pOut++ = FMT_DATE_AMPM_LOWER;
838 if (pLastHours)
839 *pLastHours = *pLastHours + 2;
840 TRACE("AM/PM\n");
842 else if (*pFormat == 'A' &&
843 !strncmpW(pFormat, szAMSlashPM, sizeof(szAMSlashPM)/sizeof(WCHAR)))
845 /* Date formats: Uppercase AM or PM designation
846 * Other formats: Literal
847 * Types the format if found
849 header->type = FMT_TYPE_DATE;
850 NEED_SPACE(sizeof(BYTE));
851 pFormat += sizeof(szAMSlashPM)/sizeof(WCHAR);
852 *pOut++ = FMT_DATE_AMPM_UPPER;
853 TRACE("AM/PM\n");
855 else if (*pFormat == 'c' || *pFormat == 'C')
857 /* Date formats: General date format
858 * Other formats: Literal
859 * Types the format if found
861 header->type = FMT_TYPE_DATE;
862 NEED_SPACE(sizeof(BYTE));
863 pFormat += sizeof(szAMSlashPM)/sizeof(WCHAR);
864 *pOut++ = FMT_DATE_GENERAL;
865 TRACE("gen date\n");
867 else if ((*pFormat == 'd' || *pFormat == 'D') && COULD_BE(FMT_TYPE_DATE))
869 /* Date formats: Day specifier
870 * Other formats: Literal
871 * Types the format if found
873 int count = -1;
874 header->type = FMT_TYPE_DATE;
875 while ((*pFormat == 'd' || *pFormat == 'D') && count < 6)
877 pFormat++;
878 count++;
880 NEED_SPACE(sizeof(BYTE));
881 *pOut++ = FMT_DATE_DAY + count;
882 fmt_state &= ~FMT_STATE_OPEN_COPY;
883 /* When we find the days token, reset the seen hours state so that
884 * 'mm' is again written as month when encountered.
886 fmt_state &= ~FMT_STATE_SEEN_HOURS;
887 TRACE("%d d's\n", count + 1);
889 else if ((*pFormat == 'h' || *pFormat == 'H') && COULD_BE(FMT_TYPE_DATE))
891 /* Date formats: Hour specifier
892 * Other formats: Literal
893 * Types the format if found
895 header->type = FMT_TYPE_DATE;
896 NEED_SPACE(sizeof(BYTE));
897 pFormat++;
898 /* Record the position of the hours specifier - if we encounter
899 * an am/pm specifier we will change the hours from 24 to 12.
901 pLastHours = pOut;
902 if (*pFormat == 'h' || *pFormat == 'H')
904 pFormat++;
905 *pOut++ = FMT_DATE_HOUR_0;
906 TRACE("hh\n");
908 else
910 *pOut++ = FMT_DATE_HOUR;
911 TRACE("h\n");
913 fmt_state &= ~FMT_STATE_OPEN_COPY;
914 /* Note that now we have seen an hours token, the next occurrence of
915 * 'mm' indicates minutes, not months.
917 fmt_state |= FMT_STATE_SEEN_HOURS;
919 else if ((*pFormat == 'm' || *pFormat == 'M') && COULD_BE(FMT_TYPE_DATE))
921 /* Date formats: Month specifier (or Minute specifier, after hour specifier)
922 * Other formats: Literal
923 * Types the format if found
925 int count = -1;
926 header->type = FMT_TYPE_DATE;
927 while ((*pFormat == 'm' || *pFormat == 'M') && count < 4)
929 pFormat++;
930 count++;
932 NEED_SPACE(sizeof(BYTE));
933 if (count <= 1 && fmt_state & FMT_STATE_SEEN_HOURS &&
934 !(fmt_state & FMT_STATE_WROTE_MINUTES))
936 /* We have seen an hours specifier and not yet written a minutes
937 * specifier. Write this as minutes and thereafter as months.
939 *pOut++ = count == 1 ? FMT_DATE_MIN_0 : FMT_DATE_MIN;
940 fmt_state |= FMT_STATE_WROTE_MINUTES; /* Hereafter write months */
942 else
943 *pOut++ = FMT_DATE_MON + count; /* Months */
944 fmt_state &= ~FMT_STATE_OPEN_COPY;
945 TRACE("%d m's\n", count + 1);
947 else if ((*pFormat == 'n' || *pFormat == 'N') && COULD_BE(FMT_TYPE_DATE))
949 /* Date formats: Minute specifier
950 * Other formats: Literal
951 * Types the format if found
953 header->type = FMT_TYPE_DATE;
954 NEED_SPACE(sizeof(BYTE));
955 pFormat++;
956 if (*pFormat == 'n' || *pFormat == 'N')
958 pFormat++;
959 *pOut++ = FMT_DATE_MIN_0;
960 TRACE("nn\n");
962 else
964 *pOut++ = FMT_DATE_MIN;
965 TRACE("n\n");
967 fmt_state &= ~FMT_STATE_OPEN_COPY;
969 else if ((*pFormat == 'q' || *pFormat == 'Q') && COULD_BE(FMT_TYPE_DATE))
971 /* Date formats: Quarter specifier
972 * Other formats: Literal
973 * Types the format if found
975 header->type = FMT_TYPE_DATE;
976 NEED_SPACE(sizeof(BYTE));
977 *pOut++ = FMT_DATE_QUARTER;
978 pFormat++;
979 fmt_state &= ~FMT_STATE_OPEN_COPY;
980 TRACE("quarter\n");
982 else if ((*pFormat == 's' || *pFormat == 'S') && COULD_BE(FMT_TYPE_DATE))
984 /* Date formats: Second specifier
985 * Other formats: Literal
986 * Types the format if found
988 header->type = FMT_TYPE_DATE;
989 NEED_SPACE(sizeof(BYTE));
990 pFormat++;
991 if (*pFormat == 's' || *pFormat == 'S')
993 pFormat++;
994 *pOut++ = FMT_DATE_SEC_0;
995 TRACE("ss\n");
997 else
999 *pOut++ = FMT_DATE_SEC;
1000 TRACE("s\n");
1002 fmt_state &= ~FMT_STATE_OPEN_COPY;
1004 else if ((*pFormat == 't' || *pFormat == 'T') &&
1005 !strncmpiW(pFormat, szTTTTT, sizeof(szTTTTT)/sizeof(WCHAR)))
1007 /* Date formats: System time specifier
1008 * Other formats: Literal
1009 * Types the format if found
1011 header->type = FMT_TYPE_DATE;
1012 pFormat += sizeof(szTTTTT)/sizeof(WCHAR);
1013 NEED_SPACE(sizeof(BYTE));
1014 *pOut++ = FMT_DATE_TIME_SYS;
1015 fmt_state &= ~FMT_STATE_OPEN_COPY;
1017 else if ((*pFormat == 'w' || *pFormat == 'W') && COULD_BE(FMT_TYPE_DATE))
1019 /* Date formats: Week of the year/Day of the week
1020 * Other formats: Literal
1021 * Types the format if found
1023 header->type = FMT_TYPE_DATE;
1024 pFormat++;
1025 if (*pFormat == 'w' || *pFormat == 'W')
1027 NEED_SPACE(3 * sizeof(BYTE));
1028 pFormat++;
1029 *pOut++ = FMT_DATE_WEEK_YEAR;
1030 *pOut++ = nFirstDay;
1031 *pOut++ = nFirstWeek;
1032 TRACE("ww\n");
1034 else
1036 NEED_SPACE(2 * sizeof(BYTE));
1037 *pOut++ = FMT_DATE_DAY_WEEK;
1038 *pOut++ = nFirstDay;
1039 TRACE("w\n");
1042 fmt_state &= ~FMT_STATE_OPEN_COPY;
1044 else if ((*pFormat == 'y' || *pFormat == 'Y') && COULD_BE(FMT_TYPE_DATE))
1046 /* Date formats: Day of year/Year specifier
1047 * Other formats: Literal
1048 * Types the format if found
1050 int count = -1;
1051 header->type = FMT_TYPE_DATE;
1052 while ((*pFormat == 'y' || *pFormat == 'Y') && count < 4)
1054 pFormat++;
1055 count++;
1057 if (count == 2)
1059 count--; /* 'yyy' has no meaning, despite what MSDN says */
1060 pFormat--;
1062 NEED_SPACE(sizeof(BYTE));
1063 *pOut++ = FMT_DATE_YEAR_DOY + count;
1064 fmt_state &= ~FMT_STATE_OPEN_COPY;
1065 TRACE("%d y's\n", count + 1);
1067 /* -------------
1068 * String tokens
1069 * -------------
1071 else if (*pFormat == '@' && COULD_BE(FMT_TYPE_STRING))
1073 /* String formats: Character from string or space if no char
1074 * Other formats: Literal
1075 * Types the format if found
1077 header->type = FMT_TYPE_STRING;
1078 NEED_SPACE(2 * sizeof(BYTE));
1079 *pOut++ = FMT_STR_COPY_SPACE;
1080 *pOut = 0x0;
1081 while (*pFormat == '@')
1083 *pOut = *pOut + 1;
1084 str_header->copy_chars++;
1085 pFormat++;
1087 TRACE("%d @'s\n", *pOut);
1088 pOut++;
1089 fmt_state &= ~FMT_STATE_OPEN_COPY;
1091 else if (*pFormat == '&' && COULD_BE(FMT_TYPE_STRING))
1093 /* String formats: Character from string or skip if no char
1094 * Other formats: Literal
1095 * Types the format if found
1097 header->type = FMT_TYPE_STRING;
1098 NEED_SPACE(2 * sizeof(BYTE));
1099 *pOut++ = FMT_STR_COPY_SKIP;
1100 *pOut = 0x0;
1101 while (*pFormat == '&')
1103 *pOut = *pOut + 1;
1104 str_header->copy_chars++;
1105 pFormat++;
1107 TRACE("%d &'s\n", *pOut);
1108 pOut++;
1109 fmt_state &= ~FMT_STATE_OPEN_COPY;
1111 else if ((*pFormat == '<' || *pFormat == '>') && COULD_BE(FMT_TYPE_STRING))
1113 /* String formats: Use upper/lower case
1114 * Other formats: Literal
1115 * Types the format if found
1117 header->type = FMT_TYPE_STRING;
1118 if (*pFormat == '<')
1119 str_header->flags |= FMT_FLAG_LT;
1120 else
1121 str_header->flags |= FMT_FLAG_GT;
1122 TRACE("to %s case\n", *pFormat == '<' ? "lower" : "upper");
1123 pFormat++;
1124 fmt_state &= ~FMT_STATE_OPEN_COPY;
1126 else if (*pFormat == '!' && COULD_BE(FMT_TYPE_STRING))
1128 /* String formats: Copy right to left
1129 * Other formats: Literal
1130 * Types the format if found
1132 header->type = FMT_TYPE_STRING;
1133 str_header->flags |= FMT_FLAG_RTL;
1134 pFormat++;
1135 fmt_state &= ~FMT_STATE_OPEN_COPY;
1136 TRACE("copy right-to-left\n");
1138 /* --------
1139 * Literals
1140 * --------
1142 /* FIXME: [ seems to be ignored */
1143 else
1145 if (*pFormat == '%' && header->type == FMT_TYPE_NUMBER)
1147 /* Number formats: Percentage indicator, also a literal
1148 * Other formats: Literal
1149 * Doesn't type the format
1151 num_header->flags |= FMT_FLAG_PERCENT;
1154 if (fmt_state & FMT_STATE_OPEN_COPY)
1156 pOut[-1] = pOut[-1] + 1; /* Increase the length of the open copy */
1157 TRACE("extend copy (char '%c'), length now %d\n", *pFormat, pOut[-1]);
1159 else
1161 /* Create a new open copy */
1162 TRACE("New copy (char '%c')\n", *pFormat);
1163 NEED_SPACE(3 * sizeof(BYTE));
1164 *pOut++ = FMT_GEN_COPY;
1165 *pOut++ = pFormat - lpszFormat;
1166 *pOut++ = 0x1;
1167 fmt_state |= FMT_STATE_OPEN_COPY;
1169 pFormat++;
1173 *pOut++ = FMT_GEN_END;
1175 header->size = pOut - rgbTok;
1176 if (pcbActual)
1177 *pcbActual = header->size;
1179 return S_OK;
1182 /* Number formatting state flags */
1183 #define NUM_WROTE_DEC 0x01 /* Written the decimal separator */
1184 #define NUM_WRITE_ON 0x02 /* Started to write the number */
1185 #define NUM_WROTE_SIGN 0x04 /* Written the negative sign */
1187 /* Format a variant using a number format */
1188 static HRESULT VARIANT_FormatNumber(LPVARIANT pVarIn, LPOLESTR lpszFormat,
1189 LPBYTE rgbTok, ULONG dwFlags,
1190 BSTR *pbstrOut, LCID lcid)
1192 BYTE rgbDig[256], *prgbDig;
1193 NUMPARSE np;
1194 int have_int, need_int = 0, have_frac, need_frac, exponent = 0, pad = 0;
1195 WCHAR buff[256], *pBuff = buff;
1196 WCHAR thousandSeparator[32];
1197 VARIANT vString, vBool;
1198 DWORD dwState = 0;
1199 FMT_HEADER *header = (FMT_HEADER*)rgbTok;
1200 FMT_NUMBER_HEADER *numHeader;
1201 const BYTE* pToken = NULL;
1202 HRESULT hRes = S_OK;
1204 TRACE("(%p->(%s%s),%s,%p,0x%08x,%p,0x%08x)\n", pVarIn, debugstr_VT(pVarIn),
1205 debugstr_VF(pVarIn), debugstr_w(lpszFormat), rgbTok, dwFlags, pbstrOut,
1206 lcid);
1208 V_VT(&vString) = VT_EMPTY;
1209 V_VT(&vBool) = VT_BOOL;
1211 if (V_TYPE(pVarIn) == VT_EMPTY || V_TYPE(pVarIn) == VT_NULL)
1213 have_int = have_frac = 0;
1214 numHeader = (FMT_NUMBER_HEADER*)(rgbTok + FmtGetNull(header));
1215 V_BOOL(&vBool) = VARIANT_FALSE;
1217 else
1219 /* Get a number string from pVarIn, and parse it */
1220 hRes = VariantChangeTypeEx(&vString, pVarIn, LCID_US, VARIANT_NOUSEROVERRIDE, VT_BSTR);
1221 if (FAILED(hRes))
1222 return hRes;
1224 np.cDig = sizeof(rgbDig);
1225 np.dwInFlags = NUMPRS_STD;
1226 hRes = VarParseNumFromStr(V_BSTR(&vString), LCID_US, 0, &np, rgbDig);
1227 if (FAILED(hRes))
1228 return hRes;
1230 have_int = np.cDig;
1231 have_frac = 0;
1232 exponent = np.nPwr10;
1234 /* Figure out which format to use */
1235 if (np.dwOutFlags & NUMPRS_NEG)
1237 numHeader = (FMT_NUMBER_HEADER*)(rgbTok + FmtGetNegative(header));
1238 V_BOOL(&vBool) = VARIANT_TRUE;
1240 else if (have_int == 1 && !exponent && rgbDig[0] == 0)
1242 numHeader = (FMT_NUMBER_HEADER*)(rgbTok + FmtGetZero(header));
1243 V_BOOL(&vBool) = VARIANT_FALSE;
1245 else
1247 numHeader = (FMT_NUMBER_HEADER*)(rgbTok + FmtGetPositive(header));
1248 V_BOOL(&vBool) = VARIANT_TRUE;
1251 TRACE("num header: flags = 0x%x, mult=%d, div=%d, whole=%d, fract=%d\n",
1252 numHeader->flags, numHeader->multiplier, numHeader->divisor,
1253 numHeader->whole, numHeader->fractional);
1255 need_int = numHeader->whole;
1256 need_frac = numHeader->fractional;
1258 if (numHeader->flags & FMT_FLAG_PERCENT &&
1259 !(have_int == 1 && !exponent && rgbDig[0] == 0))
1260 exponent += 2;
1262 if (numHeader->flags & FMT_FLAG_EXPONENT)
1264 /* Exponent format: length of the integral number part is fixed and
1265 specified by the format. */
1266 pad = need_int - have_int;
1267 if (pad >= 0)
1268 exponent -= pad;
1269 else
1271 have_int = need_int;
1272 have_frac -= pad;
1273 exponent -= pad;
1274 pad = 0;
1277 else
1279 /* Convert the exponent */
1280 pad = max(exponent, -have_int);
1281 exponent -= pad;
1282 if (pad < 0)
1284 have_int += pad;
1285 have_frac = -pad;
1286 pad = 0;
1288 if(exponent < 0 && exponent > (-256 + have_int + have_frac))
1290 /* Remove exponent notation */
1291 memmove(rgbDig - exponent, rgbDig, have_int + have_frac);
1292 ZeroMemory(rgbDig, -exponent);
1293 have_frac -= exponent;
1294 exponent = 0;
1298 /* Rounding the number */
1299 if (have_frac > need_frac)
1301 prgbDig = &rgbDig[have_int + need_frac ? need_frac + 1 : 0];
1302 if (*prgbDig < 5) prgbDig--;
1303 have_frac = need_frac;
1304 if (*prgbDig >= 5)
1306 while (prgbDig-- > rgbDig && *prgbDig == 9)
1307 *prgbDig = 0;
1308 if (prgbDig < rgbDig)
1310 /* We reached the first digit and that was also a 9 */
1311 rgbDig[0] = 1;
1312 if (numHeader->flags & FMT_FLAG_EXPONENT)
1313 exponent++;
1314 else
1316 rgbDig[have_int + need_frac] = 0;
1317 if (exponent < 0)
1318 exponent++;
1319 else
1320 have_int++;
1323 else
1324 (*prgbDig)++;
1325 /* We converted trailing digits to zeroes => have_frac has changed */
1326 while (have_frac > 0 && rgbDig[have_int + have_frac - 1] == 0)
1327 have_frac--;
1330 TRACE("have_int=%d,need_int=%d,have_frac=%d,need_frac=%d,pad=%d,exp=%d\n",
1331 have_int, need_int, have_frac, need_frac, pad, exponent);
1334 if (numHeader->flags & FMT_FLAG_THOUSANDS)
1336 if (!GetLocaleInfoW(lcid, LOCALE_STHOUSAND, thousandSeparator,
1337 sizeof(thousandSeparator)/sizeof(WCHAR)))
1339 thousandSeparator[0] = ',';
1340 thousandSeparator[1] = 0;
1344 pToken = (const BYTE*)numHeader + sizeof(FMT_NUMBER_HEADER);
1345 prgbDig = rgbDig;
1347 while (SUCCEEDED(hRes) && *pToken != FMT_GEN_END)
1349 WCHAR defaultChar = '?';
1350 DWORD boolFlag, localeValue = 0;
1351 BOOL shouldAdvance = TRUE;
1353 if (pToken - rgbTok > header->size)
1355 ERR("Ran off the end of the format!\n");
1356 hRes = E_INVALIDARG;
1357 goto VARIANT_FormatNumber_Exit;
1360 switch (*pToken)
1362 case FMT_GEN_COPY:
1363 TRACE("copy %s\n", debugstr_wn(lpszFormat + pToken[1], pToken[2]));
1364 memcpy(pBuff, lpszFormat + pToken[1], pToken[2] * sizeof(WCHAR));
1365 pBuff += pToken[2];
1366 pToken += 2;
1367 break;
1369 case FMT_GEN_INLINE:
1370 pToken += 2;
1371 TRACE("copy %s\n", debugstr_a((LPCSTR)pToken));
1372 while (*pToken)
1373 *pBuff++ = *pToken++;
1374 break;
1376 case FMT_NUM_YES_NO:
1377 boolFlag = VAR_BOOLYESNO;
1378 goto VARIANT_FormatNumber_Bool;
1380 case FMT_NUM_ON_OFF:
1381 boolFlag = VAR_BOOLONOFF;
1382 goto VARIANT_FormatNumber_Bool;
1384 case FMT_NUM_TRUE_FALSE:
1385 boolFlag = VAR_LOCALBOOL;
1387 VARIANT_FormatNumber_Bool:
1389 BSTR boolStr = NULL;
1391 if (pToken[1] != FMT_GEN_END)
1393 ERR("Boolean token not at end of format!\n");
1394 hRes = E_INVALIDARG;
1395 goto VARIANT_FormatNumber_Exit;
1397 hRes = VarBstrFromBool(V_BOOL(&vBool), lcid, boolFlag, &boolStr);
1398 if (SUCCEEDED(hRes))
1400 strcpyW(pBuff, boolStr);
1401 SysFreeString(boolStr);
1402 while (*pBuff)
1403 pBuff++;
1406 break;
1408 case FMT_NUM_DECIMAL:
1409 if ((np.dwOutFlags & NUMPRS_NEG) && !(dwState & NUM_WROTE_SIGN) && !header->starts[1])
1411 /* last chance for a negative sign in the .# case */
1412 TRACE("write negative sign\n");
1413 localeValue = LOCALE_SNEGATIVESIGN;
1414 defaultChar = '-';
1415 dwState |= NUM_WROTE_SIGN;
1416 shouldAdvance = FALSE;
1417 break;
1419 TRACE("write decimal separator\n");
1420 localeValue = LOCALE_SDECIMAL;
1421 defaultChar = '.';
1422 dwState |= NUM_WROTE_DEC;
1423 break;
1425 case FMT_NUM_CURRENCY:
1426 TRACE("write currency symbol\n");
1427 localeValue = LOCALE_SCURRENCY;
1428 defaultChar = '$';
1429 break;
1431 case FMT_NUM_EXP_POS_U:
1432 case FMT_NUM_EXP_POS_L:
1433 case FMT_NUM_EXP_NEG_U:
1434 case FMT_NUM_EXP_NEG_L:
1435 if (*pToken == FMT_NUM_EXP_POS_L || *pToken == FMT_NUM_EXP_NEG_L)
1436 *pBuff++ = 'e';
1437 else
1438 *pBuff++ = 'E';
1439 if (exponent < 0)
1441 *pBuff++ = '-';
1442 sprintfW(pBuff, szPercentZeroStar_d, pToken[1], -exponent);
1444 else
1446 if (*pToken == FMT_NUM_EXP_POS_L || *pToken == FMT_NUM_EXP_POS_U)
1447 *pBuff++ = '+';
1448 sprintfW(pBuff, szPercentZeroStar_d, pToken[1], exponent);
1450 while (*pBuff)
1451 pBuff++;
1452 pToken++;
1453 break;
1455 case FMT_NUM_COPY_ZERO:
1456 dwState |= NUM_WRITE_ON;
1457 /* Fall through */
1459 case FMT_NUM_COPY_SKIP:
1460 TRACE("write %d %sdigits or %s\n", pToken[1],
1461 dwState & NUM_WROTE_DEC ? "fractional " : "",
1462 *pToken == FMT_NUM_COPY_ZERO ? "0" : "skip");
1464 if (dwState & NUM_WROTE_DEC)
1466 int count, i;
1468 if (!(numHeader->flags & FMT_FLAG_EXPONENT) && exponent < 0)
1470 /* Pad with 0 before writing the fractional digits */
1471 pad = max(exponent, -pToken[1]);
1472 exponent -= pad;
1473 count = min(have_frac, pToken[1] + pad);
1474 for (i = 0; i > pad; i--)
1475 *pBuff++ = '0';
1477 else
1478 count = min(have_frac, pToken[1]);
1480 pad += pToken[1] - count;
1481 have_frac -= count;
1482 while (count--)
1483 *pBuff++ = '0' + *prgbDig++;
1484 if (*pToken == FMT_NUM_COPY_ZERO)
1486 for (; pad > 0; pad--)
1487 *pBuff++ = '0'; /* Write zeros for missing trailing digits */
1490 else
1492 int count, count_max, position;
1494 if ((np.dwOutFlags & NUMPRS_NEG) && !(dwState & NUM_WROTE_SIGN) && !header->starts[1])
1496 TRACE("write negative sign\n");
1497 localeValue = LOCALE_SNEGATIVESIGN;
1498 defaultChar = '-';
1499 dwState |= NUM_WROTE_SIGN;
1500 shouldAdvance = FALSE;
1501 break;
1504 position = have_int + pad;
1505 if (dwState & NUM_WRITE_ON)
1506 position = max(position, need_int);
1507 need_int -= pToken[1];
1508 count_max = have_int + pad - need_int;
1509 if (count_max < 0)
1510 count_max = 0;
1511 if (dwState & NUM_WRITE_ON)
1513 count = pToken[1] - count_max;
1514 TRACE("write %d leading zeros\n", count);
1515 while (count-- > 0)
1517 *pBuff++ = '0';
1518 if ((numHeader->flags & FMT_FLAG_THOUSANDS) &&
1519 position > 1 && (--position % 3) == 0)
1521 int k;
1522 TRACE("write thousand separator\n");
1523 for (k = 0; thousandSeparator[k]; k++)
1524 *pBuff++ = thousandSeparator[k];
1528 if (*pToken == FMT_NUM_COPY_ZERO || have_int > 1 ||
1529 (have_int > 0 && *prgbDig > 0))
1531 count = min(count_max, have_int);
1532 count_max -= count;
1533 have_int -= count;
1534 TRACE("write %d whole number digits\n", count);
1535 while (count--)
1537 dwState |= NUM_WRITE_ON;
1538 *pBuff++ = '0' + *prgbDig++;
1539 if ((numHeader->flags & FMT_FLAG_THOUSANDS) &&
1540 position > 1 && (--position % 3) == 0)
1542 int k;
1543 TRACE("write thousand separator\n");
1544 for (k = 0; thousandSeparator[k]; k++)
1545 *pBuff++ = thousandSeparator[k];
1549 count = min(count_max, pad);
1550 pad -= count;
1551 TRACE("write %d whole trailing 0's\n", count);
1552 while (count--)
1554 *pBuff++ = '0';
1555 if ((numHeader->flags & FMT_FLAG_THOUSANDS) &&
1556 position > 1 && (--position % 3) == 0)
1558 int k;
1559 TRACE("write thousand separator\n");
1560 for (k = 0; thousandSeparator[k]; k++)
1561 *pBuff++ = thousandSeparator[k];
1565 pToken++;
1566 break;
1568 default:
1569 ERR("Unknown token 0x%02x!\n", *pToken);
1570 hRes = E_INVALIDARG;
1571 goto VARIANT_FormatNumber_Exit;
1573 if (localeValue)
1575 if (GetLocaleInfoW(lcid, localeValue, pBuff,
1576 sizeof(buff)/sizeof(WCHAR)-(pBuff-buff)))
1578 TRACE("added %s\n", debugstr_w(pBuff));
1579 while (*pBuff)
1580 pBuff++;
1582 else
1584 TRACE("added %d '%c'\n", defaultChar, defaultChar);
1585 *pBuff++ = defaultChar;
1588 if (shouldAdvance)
1589 pToken++;
1592 VARIANT_FormatNumber_Exit:
1593 VariantClear(&vString);
1594 *pBuff = '\0';
1595 TRACE("buff is %s\n", debugstr_w(buff));
1596 if (SUCCEEDED(hRes))
1598 *pbstrOut = SysAllocString(buff);
1599 if (!*pbstrOut)
1600 hRes = E_OUTOFMEMORY;
1602 return hRes;
1605 /* Format a variant using a date format */
1606 static HRESULT VARIANT_FormatDate(LPVARIANT pVarIn, LPOLESTR lpszFormat,
1607 LPBYTE rgbTok, ULONG dwFlags,
1608 BSTR *pbstrOut, LCID lcid)
1610 WCHAR buff[256], *pBuff = buff;
1611 VARIANT vDate;
1612 UDATE udate;
1613 FMT_HEADER *header = (FMT_HEADER*)rgbTok;
1614 FMT_DATE_HEADER *dateHeader;
1615 const BYTE* pToken = NULL;
1616 HRESULT hRes;
1618 TRACE("(%p->(%s%s),%s,%p,0x%08x,%p,0x%08x)\n", pVarIn, debugstr_VT(pVarIn),
1619 debugstr_VF(pVarIn), debugstr_w(lpszFormat), rgbTok, dwFlags, pbstrOut,
1620 lcid);
1622 V_VT(&vDate) = VT_EMPTY;
1624 if (V_TYPE(pVarIn) == VT_EMPTY || V_TYPE(pVarIn) == VT_NULL)
1626 dateHeader = (FMT_DATE_HEADER*)(rgbTok + FmtGetNegative(header));
1627 V_DATE(&vDate) = 0;
1629 else
1631 USHORT usFlags = dwFlags & VARIANT_CALENDAR_HIJRI ? VAR_CALENDAR_HIJRI : 0;
1633 hRes = VariantChangeTypeEx(&vDate, pVarIn, LCID_US, usFlags, VT_DATE);
1634 if (FAILED(hRes))
1635 return hRes;
1636 dateHeader = (FMT_DATE_HEADER*)(rgbTok + FmtGetPositive(header));
1639 hRes = VarUdateFromDate(V_DATE(&vDate), 0 /* FIXME: flags? */, &udate);
1640 if (FAILED(hRes))
1641 return hRes;
1642 pToken = (const BYTE*)dateHeader + sizeof(FMT_DATE_HEADER);
1644 while (*pToken != FMT_GEN_END)
1646 DWORD dwVal = 0, localeValue = 0, dwFmt = 0;
1647 LPCWSTR szPrintFmt = NULL;
1648 WCHAR defaultChar = '?';
1650 if (pToken - rgbTok > header->size)
1652 ERR("Ran off the end of the format!\n");
1653 hRes = E_INVALIDARG;
1654 goto VARIANT_FormatDate_Exit;
1657 switch (*pToken)
1659 case FMT_GEN_COPY:
1660 TRACE("copy %s\n", debugstr_wn(lpszFormat + pToken[1], pToken[2]));
1661 memcpy(pBuff, lpszFormat + pToken[1], pToken[2] * sizeof(WCHAR));
1662 pBuff += pToken[2];
1663 pToken += 2;
1664 break;
1666 case FMT_DATE_TIME_SEP:
1667 TRACE("time separator\n");
1668 localeValue = LOCALE_STIME;
1669 defaultChar = ':';
1670 break;
1672 case FMT_DATE_DATE_SEP:
1673 TRACE("date separator\n");
1674 localeValue = LOCALE_SDATE;
1675 defaultChar = '/';
1676 break;
1678 case FMT_DATE_GENERAL:
1680 BSTR date = NULL;
1681 WCHAR *pDate;
1682 hRes = VarBstrFromDate(V_DATE(&vDate), lcid, 0, &date);
1683 if (FAILED(hRes))
1684 goto VARIANT_FormatDate_Exit;
1685 pDate = date;
1686 while (*pDate)
1687 *pBuff++ = *pDate++;
1688 SysFreeString(date);
1690 break;
1692 case FMT_DATE_QUARTER:
1693 if (udate.st.wMonth <= 3)
1694 *pBuff++ = '1';
1695 else if (udate.st.wMonth <= 6)
1696 *pBuff++ = '2';
1697 else if (udate.st.wMonth <= 9)
1698 *pBuff++ = '3';
1699 else
1700 *pBuff++ = '4';
1701 break;
1703 case FMT_DATE_TIME_SYS:
1705 /* FIXME: VARIANT_CALENDAR HIJRI should cause Hijri output */
1706 BSTR date = NULL;
1707 WCHAR *pDate;
1708 hRes = VarBstrFromDate(V_DATE(&vDate), lcid, VAR_TIMEVALUEONLY, &date);
1709 if (FAILED(hRes))
1710 goto VARIANT_FormatDate_Exit;
1711 pDate = date;
1712 while (*pDate)
1713 *pBuff++ = *pDate++;
1714 SysFreeString(date);
1716 break;
1718 case FMT_DATE_DAY:
1719 szPrintFmt = szPercent_d;
1720 dwVal = udate.st.wDay;
1721 break;
1723 case FMT_DATE_DAY_0:
1724 szPrintFmt = szPercentZeroTwo_d;
1725 dwVal = udate.st.wDay;
1726 break;
1728 case FMT_DATE_DAY_SHORT:
1729 /* FIXME: VARIANT_CALENDAR HIJRI should cause Hijri output */
1730 TRACE("short day\n");
1731 localeValue = LOCALE_SABBREVDAYNAME1 + udate.st.wMonth - 1;
1732 defaultChar = '?';
1733 break;
1735 case FMT_DATE_DAY_LONG:
1736 /* FIXME: VARIANT_CALENDAR HIJRI should cause Hijri output */
1737 TRACE("long day\n");
1738 localeValue = LOCALE_SDAYNAME1 + udate.st.wMonth - 1;
1739 defaultChar = '?';
1740 break;
1742 case FMT_DATE_SHORT:
1743 /* FIXME: VARIANT_CALENDAR HIJRI should cause Hijri output */
1744 dwFmt = LOCALE_SSHORTDATE;
1745 break;
1747 case FMT_DATE_LONG:
1748 /* FIXME: VARIANT_CALENDAR HIJRI should cause Hijri output */
1749 dwFmt = LOCALE_SLONGDATE;
1750 break;
1752 case FMT_DATE_MEDIUM:
1753 FIXME("Medium date treated as long date\n");
1754 dwFmt = LOCALE_SLONGDATE;
1755 break;
1757 case FMT_DATE_DAY_WEEK:
1758 szPrintFmt = szPercent_d;
1759 if (pToken[1])
1760 dwVal = udate.st.wDayOfWeek + 2 - pToken[1];
1761 else
1763 GetLocaleInfoW(lcid,LOCALE_RETURN_NUMBER|LOCALE_IFIRSTDAYOFWEEK,
1764 (LPWSTR)&dwVal, sizeof(dwVal)/sizeof(WCHAR));
1765 dwVal = udate.st.wDayOfWeek + 1 - dwVal;
1767 pToken++;
1768 break;
1770 case FMT_DATE_WEEK_YEAR:
1771 szPrintFmt = szPercent_d;
1772 dwVal = udate.wDayOfYear / 7 + 1;
1773 pToken += 2;
1774 FIXME("Ignoring nFirstDay of %d, nFirstWeek of %d\n", pToken[0], pToken[1]);
1775 break;
1777 case FMT_DATE_MON:
1778 szPrintFmt = szPercent_d;
1779 dwVal = udate.st.wMonth;
1780 break;
1782 case FMT_DATE_MON_0:
1783 szPrintFmt = szPercentZeroTwo_d;
1784 dwVal = udate.st.wMonth;
1785 break;
1787 case FMT_DATE_MON_SHORT:
1788 /* FIXME: VARIANT_CALENDAR HIJRI should cause Hijri output */
1789 TRACE("short month\n");
1790 localeValue = LOCALE_SABBREVMONTHNAME1 + udate.st.wMonth - 1;
1791 defaultChar = '?';
1792 break;
1794 case FMT_DATE_MON_LONG:
1795 /* FIXME: VARIANT_CALENDAR HIJRI should cause Hijri output */
1796 TRACE("long month\n");
1797 localeValue = LOCALE_SMONTHNAME1 + udate.st.wMonth - 1;
1798 defaultChar = '?';
1799 break;
1801 case FMT_DATE_YEAR_DOY:
1802 szPrintFmt = szPercent_d;
1803 dwVal = udate.wDayOfYear;
1804 break;
1806 case FMT_DATE_YEAR_0:
1807 szPrintFmt = szPercentZeroTwo_d;
1808 dwVal = udate.st.wYear % 100;
1809 break;
1811 case FMT_DATE_YEAR_LONG:
1812 szPrintFmt = szPercent_d;
1813 dwVal = udate.st.wYear;
1814 break;
1816 case FMT_DATE_MIN:
1817 szPrintFmt = szPercent_d;
1818 dwVal = udate.st.wMinute;
1819 break;
1821 case FMT_DATE_MIN_0:
1822 szPrintFmt = szPercentZeroTwo_d;
1823 dwVal = udate.st.wMinute;
1824 break;
1826 case FMT_DATE_SEC:
1827 szPrintFmt = szPercent_d;
1828 dwVal = udate.st.wSecond;
1829 break;
1831 case FMT_DATE_SEC_0:
1832 szPrintFmt = szPercentZeroTwo_d;
1833 dwVal = udate.st.wSecond;
1834 break;
1836 case FMT_DATE_HOUR:
1837 szPrintFmt = szPercent_d;
1838 dwVal = udate.st.wHour;
1839 break;
1841 case FMT_DATE_HOUR_0:
1842 szPrintFmt = szPercentZeroTwo_d;
1843 dwVal = udate.st.wHour;
1844 break;
1846 case FMT_DATE_HOUR_12:
1847 szPrintFmt = szPercent_d;
1848 dwVal = udate.st.wHour ? udate.st.wHour > 12 ? udate.st.wHour - 12 : udate.st.wHour : 12;
1849 break;
1851 case FMT_DATE_HOUR_12_0:
1852 szPrintFmt = szPercentZeroTwo_d;
1853 dwVal = udate.st.wHour ? udate.st.wHour > 12 ? udate.st.wHour - 12 : udate.st.wHour : 12;
1854 break;
1856 case FMT_DATE_AMPM_SYS1:
1857 case FMT_DATE_AMPM_SYS2:
1858 localeValue = udate.st.wHour < 12 ? LOCALE_S1159 : LOCALE_S2359;
1859 defaultChar = '?';
1860 break;
1862 case FMT_DATE_AMPM_UPPER:
1863 *pBuff++ = udate.st.wHour < 12 ? 'A' : 'P';
1864 *pBuff++ = 'M';
1865 break;
1867 case FMT_DATE_A_UPPER:
1868 *pBuff++ = udate.st.wHour < 12 ? 'A' : 'P';
1869 break;
1871 case FMT_DATE_AMPM_LOWER:
1872 *pBuff++ = udate.st.wHour < 12 ? 'a' : 'p';
1873 *pBuff++ = 'm';
1874 break;
1876 case FMT_DATE_A_LOWER:
1877 *pBuff++ = udate.st.wHour < 12 ? 'a' : 'p';
1878 break;
1880 default:
1881 ERR("Unknown token 0x%02x!\n", *pToken);
1882 hRes = E_INVALIDARG;
1883 goto VARIANT_FormatDate_Exit;
1885 if (localeValue)
1887 *pBuff = '\0';
1888 if (GetLocaleInfoW(lcid, localeValue, pBuff,
1889 sizeof(buff)/sizeof(WCHAR)-(pBuff-buff)))
1891 TRACE("added %s\n", debugstr_w(pBuff));
1892 while (*pBuff)
1893 pBuff++;
1895 else
1897 TRACE("added %d %c\n", defaultChar, defaultChar);
1898 *pBuff++ = defaultChar;
1901 else if (dwFmt)
1903 WCHAR fmt_buff[80];
1905 if (!GetLocaleInfoW(lcid, dwFmt, fmt_buff, sizeof(fmt_buff)/sizeof(WCHAR)) ||
1906 !GetDateFormatW(lcid, 0, &udate.st, fmt_buff, pBuff,
1907 sizeof(buff)/sizeof(WCHAR)-(pBuff-buff)))
1909 hRes = E_INVALIDARG;
1910 goto VARIANT_FormatDate_Exit;
1912 while (*pBuff)
1913 pBuff++;
1915 else if (szPrintFmt)
1917 sprintfW(pBuff, szPrintFmt, dwVal);
1918 while (*pBuff)
1919 pBuff++;
1921 pToken++;
1924 VARIANT_FormatDate_Exit:
1925 *pBuff = '\0';
1926 TRACE("buff is %s\n", debugstr_w(buff));
1927 if (SUCCEEDED(hRes))
1929 *pbstrOut = SysAllocString(buff);
1930 if (!*pbstrOut)
1931 hRes = E_OUTOFMEMORY;
1933 return hRes;
1936 /* Format a variant using a string format */
1937 static HRESULT VARIANT_FormatString(LPVARIANT pVarIn, LPOLESTR lpszFormat,
1938 LPBYTE rgbTok, ULONG dwFlags,
1939 BSTR *pbstrOut, LCID lcid)
1941 static WCHAR szEmpty[] = { '\0' };
1942 WCHAR buff[256], *pBuff = buff;
1943 WCHAR *pSrc;
1944 FMT_HEADER *header = (FMT_HEADER*)rgbTok;
1945 FMT_STRING_HEADER *strHeader;
1946 const BYTE* pToken = NULL;
1947 VARIANT vStr;
1948 int blanks_first;
1949 BOOL bUpper = FALSE;
1950 HRESULT hRes = S_OK;
1952 TRACE("(%p->(%s%s),%s,%p,0x%08x,%p,0x%08x)\n", pVarIn, debugstr_VT(pVarIn),
1953 debugstr_VF(pVarIn), debugstr_w(lpszFormat), rgbTok, dwFlags, pbstrOut,
1954 lcid);
1956 V_VT(&vStr) = VT_EMPTY;
1958 if (V_TYPE(pVarIn) == VT_EMPTY || V_TYPE(pVarIn) == VT_NULL)
1960 strHeader = (FMT_STRING_HEADER*)(rgbTok + FmtGetNegative(header));
1961 V_BSTR(&vStr) = szEmpty;
1963 else
1965 hRes = VariantChangeTypeEx(&vStr, pVarIn, LCID_US, VARIANT_NOUSEROVERRIDE, VT_BSTR);
1966 if (FAILED(hRes))
1967 return hRes;
1969 if (V_BSTR(pVarIn)[0] == '\0')
1970 strHeader = (FMT_STRING_HEADER*)(rgbTok + FmtGetNegative(header));
1971 else
1972 strHeader = (FMT_STRING_HEADER*)(rgbTok + FmtGetPositive(header));
1974 pSrc = V_BSTR(&vStr);
1975 if ((strHeader->flags & (FMT_FLAG_LT|FMT_FLAG_GT)) == FMT_FLAG_GT)
1976 bUpper = TRUE;
1977 blanks_first = strHeader->copy_chars - strlenW(pSrc);
1978 pToken = (const BYTE*)strHeader + sizeof(FMT_DATE_HEADER);
1980 while (*pToken != FMT_GEN_END)
1982 int dwCount = 0;
1984 if (pToken - rgbTok > header->size)
1986 ERR("Ran off the end of the format!\n");
1987 hRes = E_INVALIDARG;
1988 goto VARIANT_FormatString_Exit;
1991 switch (*pToken)
1993 case FMT_GEN_COPY:
1994 TRACE("copy %s\n", debugstr_wn(lpszFormat + pToken[1], pToken[2]));
1995 memcpy(pBuff, lpszFormat + pToken[1], pToken[2] * sizeof(WCHAR));
1996 pBuff += pToken[2];
1997 pToken += 2;
1998 break;
2000 case FMT_STR_COPY_SPACE:
2001 case FMT_STR_COPY_SKIP:
2002 dwCount = pToken[1];
2003 if (*pToken == FMT_STR_COPY_SPACE && blanks_first > 0)
2005 TRACE("insert %d initial spaces\n", blanks_first);
2006 while (dwCount > 0 && blanks_first > 0)
2008 *pBuff++ = ' ';
2009 dwCount--;
2010 blanks_first--;
2013 TRACE("copy %d chars%s\n", dwCount,
2014 *pToken == FMT_STR_COPY_SPACE ? " with space" :"");
2015 while (dwCount > 0 && *pSrc)
2017 if (bUpper)
2018 *pBuff++ = toupperW(*pSrc);
2019 else
2020 *pBuff++ = tolowerW(*pSrc);
2021 dwCount--;
2022 pSrc++;
2024 if (*pToken == FMT_STR_COPY_SPACE && dwCount > 0)
2026 TRACE("insert %d spaces\n", dwCount);
2027 while (dwCount-- > 0)
2028 *pBuff++ = ' ';
2030 pToken++;
2031 break;
2033 default:
2034 ERR("Unknown token 0x%02x!\n", *pToken);
2035 hRes = E_INVALIDARG;
2036 goto VARIANT_FormatString_Exit;
2038 pToken++;
2041 VARIANT_FormatString_Exit:
2042 /* Copy out any remaining chars */
2043 while (*pSrc)
2045 if (bUpper)
2046 *pBuff++ = toupperW(*pSrc);
2047 else
2048 *pBuff++ = tolowerW(*pSrc);
2049 pSrc++;
2051 VariantClear(&vStr);
2052 *pBuff = '\0';
2053 TRACE("buff is %s\n", debugstr_w(buff));
2054 if (SUCCEEDED(hRes))
2056 *pbstrOut = SysAllocString(buff);
2057 if (!*pbstrOut)
2058 hRes = E_OUTOFMEMORY;
2060 return hRes;
2063 #define NUMBER_VTBITS (VTBIT_I1|VTBIT_UI1|VTBIT_I2|VTBIT_UI2| \
2064 VTBIT_I4|VTBIT_UI4|VTBIT_I8|VTBIT_UI8| \
2065 VTBIT_R4|VTBIT_R8|VTBIT_CY|VTBIT_DECIMAL| \
2066 VTBIT_BOOL|VTBIT_INT|VTBIT_UINT)
2068 /**********************************************************************
2069 * VarFormatFromTokens [OLEAUT32.139]
2071 HRESULT WINAPI VarFormatFromTokens(LPVARIANT pVarIn, LPOLESTR lpszFormat,
2072 LPBYTE rgbTok, ULONG dwFlags,
2073 BSTR *pbstrOut, LCID lcid)
2075 FMT_SHORT_HEADER *header = (FMT_SHORT_HEADER *)rgbTok;
2076 VARIANT vTmp;
2077 HRESULT hres;
2079 TRACE("(%p,%s,%p,%x,%p,0x%08x)\n", pVarIn, debugstr_w(lpszFormat),
2080 rgbTok, dwFlags, pbstrOut, lcid);
2082 if (!pbstrOut)
2083 return E_INVALIDARG;
2085 *pbstrOut = NULL;
2087 if (!pVarIn || !rgbTok)
2088 return E_INVALIDARG;
2090 if (V_VT(pVarIn) == VT_NULL)
2091 return S_OK;
2093 if (*rgbTok == FMT_TO_STRING || header->type == FMT_TYPE_GENERAL)
2095 /* According to MSDN, general format acts somewhat like the 'Str'
2096 * function in Visual Basic.
2098 VarFormatFromTokens_AsStr:
2099 V_VT(&vTmp) = VT_EMPTY;
2100 hres = VariantChangeTypeEx(&vTmp, pVarIn, lcid, dwFlags, VT_BSTR);
2101 *pbstrOut = V_BSTR(&vTmp);
2103 else
2105 if (header->type == FMT_TYPE_NUMBER ||
2106 (header->type == FMT_TYPE_UNKNOWN && ((1 << V_TYPE(pVarIn)) & NUMBER_VTBITS)))
2108 hres = VARIANT_FormatNumber(pVarIn, lpszFormat, rgbTok, dwFlags, pbstrOut, lcid);
2110 else if (header->type == FMT_TYPE_DATE ||
2111 (header->type == FMT_TYPE_UNKNOWN && V_TYPE(pVarIn) == VT_DATE))
2113 hres = VARIANT_FormatDate(pVarIn, lpszFormat, rgbTok, dwFlags, pbstrOut, lcid);
2115 else if (header->type == FMT_TYPE_STRING || V_TYPE(pVarIn) == VT_BSTR)
2117 hres = VARIANT_FormatString(pVarIn, lpszFormat, rgbTok, dwFlags, pbstrOut, lcid);
2119 else
2121 ERR("unrecognised format type 0x%02x\n", header->type);
2122 return E_INVALIDARG;
2124 /* If the coercion failed, still try to create output, unless the
2125 * VAR_FORMAT_NOSUBSTITUTE flag is set.
2127 if ((hres == DISP_E_OVERFLOW || hres == DISP_E_TYPEMISMATCH) &&
2128 !(dwFlags & VAR_FORMAT_NOSUBSTITUTE))
2129 goto VarFormatFromTokens_AsStr;
2132 return hres;
2135 /**********************************************************************
2136 * VarFormat [OLEAUT32.87]
2138 * Format a variant from a format string.
2140 * PARAMS
2141 * pVarIn [I] Variant to format
2142 * lpszFormat [I] Format string (see notes)
2143 * nFirstDay [I] First day of the week, (See VarTokenizeFormatString() for details)
2144 * nFirstWeek [I] First week of the year (See VarTokenizeFormatString() for details)
2145 * dwFlags [I] Flags for the format (VAR_ flags from "oleauto.h")
2146 * pbstrOut [O] Destination for formatted string.
2148 * RETURNS
2149 * Success: S_OK. pbstrOut contains the formatted value.
2150 * Failure: E_INVALIDARG, if any parameter is invalid.
2151 * E_OUTOFMEMORY, if enough memory cannot be allocated.
2152 * DISP_E_TYPEMISMATCH, if the variant cannot be formatted.
2154 * NOTES
2155 * - See Variant-Formats for details concerning creating format strings.
2156 * - This function uses LOCALE_USER_DEFAULT when calling VarTokenizeFormatString()
2157 * and VarFormatFromTokens().
2159 HRESULT WINAPI VarFormat(LPVARIANT pVarIn, LPOLESTR lpszFormat,
2160 int nFirstDay, int nFirstWeek, ULONG dwFlags,
2161 BSTR *pbstrOut)
2163 BYTE buff[256];
2164 HRESULT hres;
2166 TRACE("(%p->(%s%s),%s,%d,%d,0x%08x,%p)\n", pVarIn, debugstr_VT(pVarIn),
2167 debugstr_VF(pVarIn), debugstr_w(lpszFormat), nFirstDay, nFirstWeek,
2168 dwFlags, pbstrOut);
2170 if (!pbstrOut)
2171 return E_INVALIDARG;
2172 *pbstrOut = NULL;
2174 hres = VarTokenizeFormatString(lpszFormat, buff, sizeof(buff), nFirstDay,
2175 nFirstWeek, LOCALE_USER_DEFAULT, NULL);
2176 if (SUCCEEDED(hres))
2177 hres = VarFormatFromTokens(pVarIn, lpszFormat, buff, dwFlags,
2178 pbstrOut, LOCALE_USER_DEFAULT);
2179 TRACE("returning 0x%08x, %s\n", hres, debugstr_w(*pbstrOut));
2180 return hres;
2183 /**********************************************************************
2184 * VarFormatDateTime [OLEAUT32.97]
2186 * Format a variant value as a date and/or time.
2188 * PARAMS
2189 * pVarIn [I] Variant to format
2190 * nFormat [I] Format type (see notes)
2191 * dwFlags [I] Flags for the format (VAR_ flags from "oleauto.h")
2192 * pbstrOut [O] Destination for formatted string.
2194 * RETURNS
2195 * Success: S_OK. pbstrOut contains the formatted value.
2196 * Failure: E_INVALIDARG, if any parameter is invalid.
2197 * E_OUTOFMEMORY, if enough memory cannot be allocated.
2198 * DISP_E_TYPEMISMATCH, if the variant cannot be formatted.
2200 * NOTES
2201 * This function uses LOCALE_USER_DEFAULT when determining the date format
2202 * characters to use.
2203 * Possible values for the nFormat parameter are:
2204 *| Value Meaning
2205 *| ----- -------
2206 *| 0 General date format
2207 *| 1 Long date format
2208 *| 2 Short date format
2209 *| 3 Long time format
2210 *| 4 Short time format
2212 HRESULT WINAPI VarFormatDateTime(LPVARIANT pVarIn, INT nFormat, ULONG dwFlags, BSTR *pbstrOut)
2214 static WCHAR szEmpty[] = { '\0' };
2215 const BYTE* lpFmt = NULL;
2217 TRACE("(%p->(%s%s),%d,0x%08x,%p)\n", pVarIn, debugstr_VT(pVarIn),
2218 debugstr_VF(pVarIn), nFormat, dwFlags, pbstrOut);
2220 if (!pVarIn || !pbstrOut || nFormat < 0 || nFormat > 4)
2221 return E_INVALIDARG;
2223 switch (nFormat)
2225 case 0: lpFmt = fmtGeneralDate; break;
2226 case 1: lpFmt = fmtLongDate; break;
2227 case 2: lpFmt = fmtShortDate; break;
2228 case 3: lpFmt = fmtLongTime; break;
2229 case 4: lpFmt = fmtShortTime; break;
2231 return VarFormatFromTokens(pVarIn, szEmpty, (BYTE*)lpFmt, dwFlags,
2232 pbstrOut, LOCALE_USER_DEFAULT);
2235 #define GETLOCALENUMBER(type,field) GetLocaleInfoW(LOCALE_USER_DEFAULT, \
2236 type|LOCALE_RETURN_NUMBER, \
2237 (LPWSTR)&numfmt.field, \
2238 sizeof(numfmt.field)/sizeof(WCHAR))
2240 /**********************************************************************
2241 * VarFormatNumber [OLEAUT32.107]
2243 * Format a variant value as a number.
2245 * PARAMS
2246 * pVarIn [I] Variant to format
2247 * nDigits [I] Number of digits following the decimal point (-1 = user default)
2248 * nLeading [I] Use a leading zero (-2 = user default, -1 = yes, 0 = no)
2249 * nParens [I] Use brackets for values < 0 (-2 = user default, -1 = yes, 0 = no)
2250 * nGrouping [I] Use grouping characters (-2 = user default, -1 = yes, 0 = no)
2251 * dwFlags [I] Currently unused, set to zero
2252 * pbstrOut [O] Destination for formatted string.
2254 * RETURNS
2255 * Success: S_OK. pbstrOut contains the formatted value.
2256 * Failure: E_INVALIDARG, if any parameter is invalid.
2257 * E_OUTOFMEMORY, if enough memory cannot be allocated.
2258 * DISP_E_TYPEMISMATCH, if the variant cannot be formatted.
2260 * NOTES
2261 * This function uses LOCALE_USER_DEFAULT when determining the number format
2262 * characters to use.
2264 HRESULT WINAPI VarFormatNumber(LPVARIANT pVarIn, INT nDigits, INT nLeading, INT nParens,
2265 INT nGrouping, ULONG dwFlags, BSTR *pbstrOut)
2267 HRESULT hRet;
2268 VARIANT vStr;
2270 TRACE("(%p->(%s%s),%d,%d,%d,%d,0x%08x,%p)\n", pVarIn, debugstr_VT(pVarIn),
2271 debugstr_VF(pVarIn), nDigits, nLeading, nParens, nGrouping, dwFlags, pbstrOut);
2273 if (!pVarIn || !pbstrOut || nDigits > 9)
2274 return E_INVALIDARG;
2276 *pbstrOut = NULL;
2278 V_VT(&vStr) = VT_EMPTY;
2279 hRet = VariantCopyInd(&vStr, pVarIn);
2281 if (SUCCEEDED(hRet))
2282 hRet = VariantChangeTypeEx(&vStr, &vStr, LCID_US, 0, VT_BSTR);
2284 if (SUCCEEDED(hRet))
2286 WCHAR buff[256], decimal[8], thousands[8];
2287 NUMBERFMTW numfmt;
2289 /* Although MSDN makes it clear that the native versions of these functions
2290 * are implemented using VarTokenizeFormatString()/VarFormatFromTokens(),
2291 * using NLS gives us the same result.
2293 if (nDigits < 0)
2294 GETLOCALENUMBER(LOCALE_IDIGITS, NumDigits);
2295 else
2296 numfmt.NumDigits = nDigits;
2298 if (nLeading == -2)
2299 GETLOCALENUMBER(LOCALE_ILZERO, LeadingZero);
2300 else if (nLeading == -1)
2301 numfmt.LeadingZero = 1;
2302 else
2303 numfmt.LeadingZero = 0;
2305 if (nGrouping == -2)
2307 WCHAR grouping[16];
2308 grouping[2] = '\0';
2309 GetLocaleInfoW(LOCALE_USER_DEFAULT, LOCALE_SDECIMAL, grouping,
2310 sizeof(grouping)/sizeof(WCHAR));
2311 numfmt.Grouping = grouping[2] == '2' ? 32 : grouping[0] - '0';
2313 else if (nGrouping == -1)
2314 numfmt.Grouping = 3; /* 3 = "n,nnn.nn" */
2315 else
2316 numfmt.Grouping = 0; /* 0 = No grouping */
2318 if (nParens == -2)
2319 GETLOCALENUMBER(LOCALE_INEGNUMBER, NegativeOrder);
2320 else if (nParens == -1)
2321 numfmt.NegativeOrder = 0; /* 0 = "(xxx)" */
2322 else
2323 numfmt.NegativeOrder = 1; /* 1 = "-xxx" */
2325 numfmt.lpDecimalSep = decimal;
2326 GetLocaleInfoW(LOCALE_USER_DEFAULT, LOCALE_SDECIMAL, decimal,
2327 sizeof(decimal)/sizeof(WCHAR));
2328 numfmt.lpThousandSep = thousands;
2329 GetLocaleInfoW(LOCALE_USER_DEFAULT, LOCALE_SDECIMAL, thousands,
2330 sizeof(thousands)/sizeof(WCHAR));
2332 if (GetNumberFormatW(LOCALE_USER_DEFAULT, 0, V_BSTR(&vStr), &numfmt,
2333 buff, sizeof(buff)/sizeof(WCHAR)))
2335 *pbstrOut = SysAllocString(buff);
2336 if (!*pbstrOut)
2337 hRet = E_OUTOFMEMORY;
2339 else
2340 hRet = DISP_E_TYPEMISMATCH;
2342 SysFreeString(V_BSTR(&vStr));
2344 return hRet;
2347 /**********************************************************************
2348 * VarFormatPercent [OLEAUT32.117]
2350 * Format a variant value as a percentage.
2352 * PARAMS
2353 * pVarIn [I] Variant to format
2354 * nDigits [I] Number of digits following the decimal point (-1 = user default)
2355 * nLeading [I] Use a leading zero (-2 = user default, -1 = yes, 0 = no)
2356 * nParens [I] Use brackets for values < 0 (-2 = user default, -1 = yes, 0 = no)
2357 * nGrouping [I] Use grouping characters (-2 = user default, -1 = yes, 0 = no)
2358 * dwFlags [I] Currently unused, set to zero
2359 * pbstrOut [O] Destination for formatted string.
2361 * RETURNS
2362 * Success: S_OK. pbstrOut contains the formatted value.
2363 * Failure: E_INVALIDARG, if any parameter is invalid.
2364 * E_OUTOFMEMORY, if enough memory cannot be allocated.
2365 * DISP_E_OVERFLOW, if overflow occurs during the conversion.
2366 * DISP_E_TYPEMISMATCH, if the variant cannot be formatted.
2368 * NOTES
2369 * This function uses LOCALE_USER_DEFAULT when determining the number format
2370 * characters to use.
2372 HRESULT WINAPI VarFormatPercent(LPVARIANT pVarIn, INT nDigits, INT nLeading, INT nParens,
2373 INT nGrouping, ULONG dwFlags, BSTR *pbstrOut)
2375 static const WCHAR szPercent[] = { '%','\0' };
2376 static const WCHAR szPercentBracket[] = { '%',')','\0' };
2377 WCHAR buff[256];
2378 HRESULT hRet;
2379 VARIANT vDbl;
2381 TRACE("(%p->(%s%s),%d,%d,%d,%d,0x%08x,%p)\n", pVarIn, debugstr_VT(pVarIn),
2382 debugstr_VF(pVarIn), nDigits, nLeading, nParens, nGrouping,
2383 dwFlags, pbstrOut);
2385 if (!pVarIn || !pbstrOut || nDigits > 9)
2386 return E_INVALIDARG;
2388 *pbstrOut = NULL;
2390 V_VT(&vDbl) = VT_EMPTY;
2391 hRet = VariantCopyInd(&vDbl, pVarIn);
2393 if (SUCCEEDED(hRet))
2395 hRet = VariantChangeTypeEx(&vDbl, &vDbl, LOCALE_USER_DEFAULT, 0, VT_R8);
2397 if (SUCCEEDED(hRet))
2399 if (V_R8(&vDbl) > (R8_MAX / 100.0))
2400 return DISP_E_OVERFLOW;
2402 V_R8(&vDbl) *= 100.0;
2403 hRet = VarFormatNumber(&vDbl, nDigits, nLeading, nParens,
2404 nGrouping, dwFlags, pbstrOut);
2406 if (SUCCEEDED(hRet))
2408 DWORD dwLen = strlenW(*pbstrOut);
2409 BOOL bBracket = (*pbstrOut)[dwLen] == ')' ? TRUE : FALSE;
2411 dwLen -= bBracket;
2412 memcpy(buff, *pbstrOut, dwLen * sizeof(WCHAR));
2413 strcpyW(buff + dwLen, bBracket ? szPercentBracket : szPercent);
2414 SysFreeString(*pbstrOut);
2415 *pbstrOut = SysAllocString(buff);
2416 if (!*pbstrOut)
2417 hRet = E_OUTOFMEMORY;
2421 return hRet;
2424 /**********************************************************************
2425 * VarFormatCurrency [OLEAUT32.127]
2427 * Format a variant value as a currency.
2429 * PARAMS
2430 * pVarIn [I] Variant to format
2431 * nDigits [I] Number of digits following the decimal point (-1 = user default)
2432 * nLeading [I] Use a leading zero (-2 = user default, -1 = yes, 0 = no)
2433 * nParens [I] Use brackets for values < 0 (-2 = user default, -1 = yes, 0 = no)
2434 * nGrouping [I] Use grouping characters (-2 = user default, -1 = yes, 0 = no)
2435 * dwFlags [I] Currently unused, set to zero
2436 * pbstrOut [O] Destination for formatted string.
2438 * RETURNS
2439 * Success: S_OK. pbstrOut contains the formatted value.
2440 * Failure: E_INVALIDARG, if any parameter is invalid.
2441 * E_OUTOFMEMORY, if enough memory cannot be allocated.
2442 * DISP_E_TYPEMISMATCH, if the variant cannot be formatted.
2444 * NOTES
2445 * This function uses LOCALE_USER_DEFAULT when determining the currency format
2446 * characters to use.
2448 HRESULT WINAPI VarFormatCurrency(LPVARIANT pVarIn, INT nDigits, INT nLeading,
2449 INT nParens, INT nGrouping, ULONG dwFlags,
2450 BSTR *pbstrOut)
2452 HRESULT hRet;
2453 VARIANT vStr;
2455 TRACE("(%p->(%s%s),%d,%d,%d,%d,0x%08x,%p)\n", pVarIn, debugstr_VT(pVarIn),
2456 debugstr_VF(pVarIn), nDigits, nLeading, nParens, nGrouping, dwFlags, pbstrOut);
2458 if (!pVarIn || !pbstrOut || nDigits > 9)
2459 return E_INVALIDARG;
2461 *pbstrOut = NULL;
2463 V_VT(&vStr) = VT_EMPTY;
2464 hRet = VariantCopyInd(&vStr, pVarIn);
2466 if (SUCCEEDED(hRet))
2467 hRet = VariantChangeTypeEx(&vStr, &vStr, LOCALE_USER_DEFAULT, 0, VT_BSTR);
2469 if (SUCCEEDED(hRet))
2471 WCHAR buff[256], decimal[8], thousands[8], currency[8];
2472 CURRENCYFMTW numfmt;
2474 if (nDigits < 0)
2475 GETLOCALENUMBER(LOCALE_IDIGITS, NumDigits);
2476 else
2477 numfmt.NumDigits = nDigits;
2479 if (nLeading == -2)
2480 GETLOCALENUMBER(LOCALE_ILZERO, LeadingZero);
2481 else if (nLeading == -1)
2482 numfmt.LeadingZero = 1;
2483 else
2484 numfmt.LeadingZero = 0;
2486 if (nGrouping == -2)
2488 WCHAR nGrouping[16];
2489 nGrouping[2] = '\0';
2490 GetLocaleInfoW(LOCALE_USER_DEFAULT, LOCALE_SDECIMAL, nGrouping,
2491 sizeof(nGrouping)/sizeof(WCHAR));
2492 numfmt.Grouping = nGrouping[2] == '2' ? 32 : nGrouping[0] - '0';
2494 else if (nGrouping == -1)
2495 numfmt.Grouping = 3; /* 3 = "n,nnn.nn" */
2496 else
2497 numfmt.Grouping = 0; /* 0 = No grouping */
2499 if (nParens == -2)
2500 GETLOCALENUMBER(LOCALE_INEGCURR, NegativeOrder);
2501 else if (nParens == -1)
2502 numfmt.NegativeOrder = 0; /* 0 = "(xxx)" */
2503 else
2504 numfmt.NegativeOrder = 1; /* 1 = "-xxx" */
2506 GETLOCALENUMBER(LOCALE_ICURRENCY, PositiveOrder);
2508 numfmt.lpDecimalSep = decimal;
2509 GetLocaleInfoW(LOCALE_USER_DEFAULT, LOCALE_SDECIMAL, decimal,
2510 sizeof(decimal)/sizeof(WCHAR));
2511 numfmt.lpThousandSep = thousands;
2512 GetLocaleInfoW(LOCALE_USER_DEFAULT, LOCALE_SDECIMAL, thousands,
2513 sizeof(thousands)/sizeof(WCHAR));
2514 numfmt.lpCurrencySymbol = currency;
2515 GetLocaleInfoW(LOCALE_USER_DEFAULT, LOCALE_SDECIMAL, currency,
2516 sizeof(currency)/sizeof(WCHAR));
2518 /* use NLS as per VarFormatNumber() */
2519 if (GetCurrencyFormatW(LOCALE_USER_DEFAULT, 0, V_BSTR(&vStr), &numfmt,
2520 buff, sizeof(buff)/sizeof(WCHAR)))
2522 *pbstrOut = SysAllocString(buff);
2523 if (!*pbstrOut)
2524 hRet = E_OUTOFMEMORY;
2526 else
2527 hRet = DISP_E_TYPEMISMATCH;
2529 SysFreeString(V_BSTR(&vStr));
2531 return hRet;
2534 /**********************************************************************
2535 * VarMonthName [OLEAUT32.129]
2537 * Print the specified month as localized name.
2539 * PARAMS
2540 * iMonth [I] month number 1..12
2541 * fAbbrev [I] 0 - full name, !0 - abbreviated name
2542 * dwFlags [I] flag stuff. only VAR_CALENDAR_HIJRI possible.
2543 * pbstrOut [O] Destination for month name
2545 * RETURNS
2546 * Success: S_OK. pbstrOut contains the name.
2547 * Failure: E_INVALIDARG, if any parameter is invalid.
2548 * E_OUTOFMEMORY, if enough memory cannot be allocated.
2550 HRESULT WINAPI VarMonthName(INT iMonth, INT fAbbrev, ULONG dwFlags, BSTR *pbstrOut)
2552 DWORD localeValue;
2553 INT size;
2555 if ((iMonth < 1) || (iMonth > 12))
2556 return E_INVALIDARG;
2558 if (dwFlags)
2559 FIXME("Does not support dwFlags 0x%x, ignoring.\n", dwFlags);
2561 if (fAbbrev)
2562 localeValue = LOCALE_SABBREVMONTHNAME1 + iMonth - 1;
2563 else
2564 localeValue = LOCALE_SMONTHNAME1 + iMonth - 1;
2566 size = GetLocaleInfoW(LOCALE_USER_DEFAULT,localeValue, NULL, 0);
2567 if (!size) {
2568 ERR("GetLocaleInfo 0x%x failed.\n", localeValue);
2569 return HRESULT_FROM_WIN32(GetLastError());
2571 *pbstrOut = SysAllocStringLen(NULL,size - 1);
2572 if (!*pbstrOut)
2573 return E_OUTOFMEMORY;
2574 size = GetLocaleInfoW(LOCALE_USER_DEFAULT,localeValue, *pbstrOut, size);
2575 if (!size) {
2576 ERR("GetLocaleInfo of 0x%x failed in 2nd stage?!\n", localeValue);
2577 SysFreeString(*pbstrOut);
2578 return HRESULT_FROM_WIN32(GetLastError());
2580 return S_OK;
2583 /**********************************************************************
2584 * VarWeekdayName [OLEAUT32.129]
2586 * Print the specified weekday as localized name.
2588 * PARAMS
2589 * iWeekday [I] day of week, 1..7, 1="the first day of the week"
2590 * fAbbrev [I] 0 - full name, !0 - abbreviated name
2591 * iFirstDay [I] first day of week,
2592 * 0=system default, 1=Sunday, 2=Monday, .. (contrary to MSDN)
2593 * dwFlags [I] flag stuff. only VAR_CALENDAR_HIJRI possible.
2594 * pbstrOut [O] Destination for weekday name.
2596 * RETURNS
2597 * Success: S_OK, pbstrOut contains the name.
2598 * Failure: E_INVALIDARG, if any parameter is invalid.
2599 * E_OUTOFMEMORY, if enough memory cannot be allocated.
2601 HRESULT WINAPI VarWeekdayName(INT iWeekday, INT fAbbrev, INT iFirstDay,
2602 ULONG dwFlags, BSTR *pbstrOut)
2604 DWORD localeValue;
2605 INT size;
2607 /* Windows XP oleaut32.dll doesn't allow iWekday==0, contrary to MSDN */
2608 if (iWeekday < 1 || iWeekday > 7)
2609 return E_INVALIDARG;
2610 if (iFirstDay < 0 || iFirstDay > 7)
2611 return E_INVALIDARG;
2612 if (!pbstrOut)
2613 return E_INVALIDARG;
2615 if (dwFlags)
2616 FIXME("Does not support dwFlags 0x%x, ignoring.\n", dwFlags);
2618 /* If we have to use the default firstDay, find which one it is */
2619 if (iFirstDay == 0) {
2620 DWORD firstDay;
2621 localeValue = LOCALE_RETURN_NUMBER | LOCALE_IFIRSTDAYOFWEEK;
2622 size = GetLocaleInfoW(LOCALE_USER_DEFAULT, localeValue,
2623 (LPWSTR)&firstDay, sizeof(firstDay) / sizeof(WCHAR));
2624 if (!size) {
2625 ERR("GetLocaleInfo 0x%x failed.\n", localeValue);
2626 return HRESULT_FROM_WIN32(GetLastError());
2628 iFirstDay = firstDay + 2;
2631 /* Determine what we need to return */
2632 localeValue = fAbbrev ? LOCALE_SABBREVDAYNAME1 : LOCALE_SDAYNAME1;
2633 localeValue += (7 + iWeekday - 1 + iFirstDay - 2) % 7;
2635 /* Determine the size of the data, allocate memory and retrieve the data */
2636 size = GetLocaleInfoW(LOCALE_USER_DEFAULT, localeValue, NULL, 0);
2637 if (!size) {
2638 ERR("GetLocaleInfo 0x%x failed.\n", localeValue);
2639 return HRESULT_FROM_WIN32(GetLastError());
2641 *pbstrOut = SysAllocStringLen(NULL, size - 1);
2642 if (!*pbstrOut)
2643 return E_OUTOFMEMORY;
2644 size = GetLocaleInfoW(LOCALE_USER_DEFAULT, localeValue, *pbstrOut, size);
2645 if (!size) {
2646 ERR("GetLocaleInfo 0x%x failed in 2nd stage?!\n", localeValue);
2647 SysFreeString(*pbstrOut);
2648 return HRESULT_FROM_WIN32(GetLastError());
2650 return S_OK;