135 lines
3.1 KiB
C
135 lines
3.1 KiB
C
/* $NetBSD: msgcat.h,v 1.2 2003/12/04 16:23:36 drochner Exp $ */
|
|
|
|
/*
|
|
* Copyright (C) 1999-2001 Internet Software Consortium.
|
|
*
|
|
* Permission to use, copy, modify, and distribute this software for any
|
|
* purpose with or without fee is hereby granted, provided that the above
|
|
* copyright notice and this permission notice appear in all copies.
|
|
*
|
|
* THE SOFTWARE IS PROVIDED "AS IS" AND INTERNET SOFTWARE CONSORTIUM
|
|
* DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL
|
|
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL
|
|
* INTERNET SOFTWARE CONSORTIUM BE LIABLE FOR ANY SPECIAL, DIRECT,
|
|
* INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING
|
|
* FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT,
|
|
* NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION
|
|
* WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
|
|
*/
|
|
|
|
/* Id: msgcat.h,v 1.8 2001/01/09 21:57:13 bwelling Exp */
|
|
|
|
#ifndef ISC_MSGCAT_H
|
|
#define ISC_MSGCAT_H 1
|
|
|
|
/*****
|
|
***** Module Info
|
|
*****/
|
|
|
|
/*
|
|
* ISC Message Catalog
|
|
*
|
|
* Message catalogs aid internationalization of applications by allowing
|
|
* messages to be retrieved from locale-specific files instead of
|
|
* hardwiring them into the application. This allows translations of
|
|
* messages appropriate to the locale to be supplied without recompiling
|
|
* the application.
|
|
*
|
|
* Notes:
|
|
* It's very important that message catalogs work, even if only the
|
|
* default_text can be used.
|
|
*
|
|
* MP:
|
|
* The caller must ensure appropriate synchronization of
|
|
* isc_msgcat_open() and isc_msgcat_close(). isc_msgcat_get()
|
|
* ensures appropriate synchronization.
|
|
*
|
|
* Reliability:
|
|
* No anticipated impact.
|
|
*
|
|
* Resources:
|
|
* <TBS>
|
|
*
|
|
* Security:
|
|
* No anticipated impact.
|
|
*
|
|
* Standards:
|
|
* None.
|
|
*/
|
|
|
|
/*****
|
|
***** Imports
|
|
*****/
|
|
|
|
#include <isc/lang.h>
|
|
#include <isc/types.h>
|
|
|
|
ISC_LANG_BEGINDECLS
|
|
|
|
/*****
|
|
***** Methods
|
|
*****/
|
|
|
|
void
|
|
isc_msgcat_open(const char *name, isc_msgcat_t **msgcatp);
|
|
/*
|
|
* Open a message catalog.
|
|
*
|
|
* Notes:
|
|
*
|
|
* If memory cannot be allocated or other failures occur, *msgcatp
|
|
* will be set to NULL. If a NULL msgcat is given to isc_msgcat_get(),
|
|
* the default_text will be returned, ensuring that some message text
|
|
* will be available, no matter what's going wrong.
|
|
*
|
|
* Requires:
|
|
*
|
|
* 'name' is a valid string.
|
|
*
|
|
* msgcatp != NULL && *msgcatp == NULL
|
|
*/
|
|
|
|
void
|
|
isc_msgcat_close(isc_msgcat_t **msgcatp);
|
|
/*
|
|
* Close a message catalog.
|
|
*
|
|
* Notes:
|
|
*
|
|
* Any string pointers returned by prior calls to isc_msgcat_get() are
|
|
* invalid after isc_msgcat_close() has been called and must not be
|
|
* used.
|
|
*
|
|
* Requires:
|
|
*
|
|
* *msgcatp is a valid message catalog or is NULL.
|
|
*
|
|
* Ensures:
|
|
*
|
|
* All resources associated with the message catalog are released.
|
|
*
|
|
* *msgcatp == NULL
|
|
*/
|
|
|
|
const char *
|
|
isc_msgcat_get(isc_msgcat_t *msgcat, int set, int message,
|
|
const char *default_text);
|
|
/*
|
|
* Get message 'message' from message set 'set' in 'msgcat'. If it
|
|
* is not available, use 'default_text'.
|
|
*
|
|
* Requires:
|
|
*
|
|
* 'msgcat' is a valid message catalog or is NULL.
|
|
*
|
|
* set > 0
|
|
*
|
|
* message > 0
|
|
*
|
|
* 'default_text' is a valid string.
|
|
*/
|
|
|
|
ISC_LANG_ENDDECLS
|
|
|
|
#endif /* ISC_MSGCAT_H */
|