mirror of
https://github.com/mozilla/gecko-dev.git
synced 2024-10-30 05:35:31 +00:00
146 lines
4.0 KiB
C
146 lines
4.0 KiB
C
/* -*- Mode: C; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*-
|
|
*
|
|
* The contents of this file are subject to the Netscape Public License
|
|
* Version 1.0 (the "NPL"); you may not use this file except in
|
|
* compliance with the NPL. You may obtain a copy of the NPL at
|
|
* http://www.mozilla.org/NPL/
|
|
*
|
|
* Software distributed under the NPL is distributed on an "AS IS" basis,
|
|
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the NPL
|
|
* for the specific language governing rights and limitations under the
|
|
* NPL.
|
|
*
|
|
* The Initial Developer of this code under the NPL is Netscape
|
|
* Communications Corporation. Portions created by Netscape are
|
|
* Copyright (C) 1998 Netscape Communications Corporation. All Rights
|
|
* Reserved.
|
|
*/
|
|
|
|
|
|
#ifndef _NLSMSG_H
|
|
#define _NLSMSG_H
|
|
|
|
|
|
#include "nlsxp.h"
|
|
#include "nlsuni.h"
|
|
#include "nlsfmt.h"
|
|
#include "nlsloc.h"
|
|
#include "nlscal.h"
|
|
|
|
#ifdef NLS_CPLUSPLUS
|
|
#include "fmtable.h"
|
|
#include "choicfmt.h"
|
|
#include "msgfmt.h"
|
|
#endif
|
|
|
|
|
|
NLS_BEGIN_PROTOS
|
|
|
|
/******************** Formatting Data Types ************************/
|
|
|
|
#ifndef NLS_CPLUSPLUS
|
|
typedef struct _MessageFormat MessageFormat;
|
|
#endif
|
|
|
|
/******************** Simple Formatting functions ************************/
|
|
|
|
/* NLS_FormatMessage
|
|
*
|
|
* varg simple message formatting.
|
|
* varg's are value pairs composed of NLS_FormattableType followed by
|
|
* argument. The last parameter to the routine should be -1 to indicate the
|
|
* end of the parameters.
|
|
* eg:
|
|
*
|
|
* err = NLS_FormatMessage(result,
|
|
* "There {0,choice,0#are no files|1#is one file|1<are {0,number} files}.",
|
|
* NLS_TYPE_STRING, "A Disk",
|
|
* NLS_TYPE_LONG, 5, -1);
|
|
*/
|
|
NLSFMTAPI_PUBLIC(NLS_ErrorCode)
|
|
NLS_FormatMessage(const Locale *locale, UnicodeString *result, const UnicodeString* pattern, ...);
|
|
|
|
|
|
/******************** Formatting Constructor functions ************************/
|
|
|
|
/* NLS_NewMessageFormat
|
|
*
|
|
* Create a MessageFormat from a pattern. The patern is a choice format
|
|
* specification of the form
|
|
*
|
|
* "There {0,choice,0#are no files|1#is one file|1<are {0,number} files}."
|
|
*
|
|
* Status Return
|
|
* NLS_SUCCESS
|
|
* NLS_PARAM_ERROR - parameter verification failed
|
|
*/
|
|
NLSFMTAPI_PUBLIC(NLS_ErrorCode)
|
|
NLS_NewMessageFormat(const Locale *locale, MessageFormat ** result, const UnicodeString* pattern);
|
|
|
|
/********************* Formatting Destructor functions *******************************/
|
|
|
|
/* NLS_DeleteMessageFormat
|
|
*
|
|
* Delete a MessageFormat object.
|
|
*
|
|
* Status Return
|
|
* NLS_SUCCESS
|
|
* NLS_PARAM_ERROR - parameter verification failed
|
|
*/
|
|
NLSFMTAPI_PUBLIC(NLS_ErrorCode)
|
|
NLS_DeleteMessageFormat(MessageFormat * that);
|
|
|
|
/******************** Formatting API ************************/
|
|
|
|
/* NLS_MessageFormatSetPattern
|
|
*
|
|
* Change the patter associated with the MessageFormat object
|
|
*
|
|
* Status Return
|
|
* NLS_SUCCESS
|
|
* NLS_PARAM_ERROR - parameter verification failed
|
|
*/
|
|
NLSFMTAPI_PUBLIC(NLS_ErrorCode)
|
|
NLS_MessageFormatSetPattern(MessageFormat * that, const UnicodeString* pattern);
|
|
|
|
/* NLS_MessageFormatGetPattern
|
|
*
|
|
* Get the pattern associated with a choice format object
|
|
*
|
|
* Status Return
|
|
* NLS_SUCCESS
|
|
* NLS_PARAM_ERROR - parameter verification failed
|
|
*/
|
|
|
|
NLSFMTAPI_PUBLIC(NLS_ErrorCode)
|
|
NLS_MessageFormatGetPattern(MessageFormat * that, UnicodeString* pattern);
|
|
|
|
/* NLS_MessageFormat
|
|
*
|
|
* Generate a formatted string using the pattern associated
|
|
* with the choice format, based on the specified parameters
|
|
*
|
|
* varg's are value pairs composed of NLS_FormattableType followed by
|
|
* argument. The last parameter to the routine should be -1 to indicate the
|
|
* end of the parameters.
|
|
* eg:
|
|
*
|
|
* err = NLS_MessageFormat(MessageFormat, result,
|
|
* NLS_TYPE_STRING, "A Disk",
|
|
* NLS_TYPE_LONG, 5, -1);
|
|
*
|
|
* Status Return
|
|
* NLS_SUCCESS
|
|
* NLS_PARAM_ERROR - parameter verification failed
|
|
*/
|
|
|
|
NLSFMTAPI_PUBLIC(NLS_ErrorCode)
|
|
NLS_MessageFormat(const MessageFormat * that, UnicodeString* result, ...);
|
|
|
|
|
|
/************************ End ******************************/
|
|
|
|
NLS_END_PROTOS
|
|
#endif /* _NLSMSG_H */
|
|
|