/*

[0] Fix | Delete

* Copyright (C) Internet Systems Consortium, Inc. ("ISC")

[1] Fix | Delete

*

[2] Fix | Delete

* This Source Code Form is subject to the terms of the Mozilla Public

[3] Fix | Delete

* License, v. 2.0. If a copy of the MPL was not distributed with this

[4] Fix | Delete

* file, you can obtain one at https://mozilla.org/MPL/2.0/.

[5] Fix | Delete

*

[6] Fix | Delete

* See the COPYRIGHT file distributed with this work for additional

[7] Fix | Delete

* information regarding copyright ownership.

[8] Fix | Delete

*/

[9] Fix | Delete

[10] Fix | Delete

[11] Fix | Delete

#ifndef ISC_MSGCAT_H

[12] Fix | Delete

#define ISC_MSGCAT_H 1

[13] Fix | Delete

[14] Fix | Delete

/*****

[15] Fix | Delete

***** Module Info

[16] Fix | Delete

*****/

[17] Fix | Delete

[18] Fix | Delete

/*! \file isc/msgcat.h

[19] Fix | Delete

* \brief The ISC Message Catalog

[20] Fix | Delete

* aids internationalization of applications by allowing

[21] Fix | Delete

* messages to be retrieved from locale-specific files instead of

[22] Fix | Delete

* hardwiring them into the application. This allows translations of

[23] Fix | Delete

* messages appropriate to the locale to be supplied without recompiling

[24] Fix | Delete

* the application.

[25] Fix | Delete

*

[26] Fix | Delete

* Notes:

[27] Fix | Delete

*\li It's very important that message catalogs work, even if only the

[28] Fix | Delete

* default_text can be used.

[29] Fix | Delete

*

[30] Fix | Delete

* MP:

[31] Fix | Delete

*\li The caller must ensure appropriate synchronization of

[32] Fix | Delete

* isc_msgcat_open() and isc_msgcat_close(). isc_msgcat_get()

[33] Fix | Delete

* ensures appropriate synchronization.

[34] Fix | Delete

*

[35] Fix | Delete

* Reliability:

[36] Fix | Delete

*\li No anticipated impact.

[37] Fix | Delete

*

[38] Fix | Delete

* Resources:

[39] Fix | Delete

*\li TBS

[40] Fix | Delete

*

[41] Fix | Delete

* \li Security:

[42] Fix | Delete

* No anticipated impact.

[43] Fix | Delete

*

[44] Fix | Delete

* \li Standards:

[45] Fix | Delete

* None.

[46] Fix | Delete

*/

[47] Fix | Delete

[48] Fix | Delete

/*****

[49] Fix | Delete

***** Imports

[50] Fix | Delete

*****/

[51] Fix | Delete

[52] Fix | Delete

#include <isc/lang.h>

[53] Fix | Delete

#include <isc/types.h>

[54] Fix | Delete

[55] Fix | Delete

ISC_LANG_BEGINDECLS

[56] Fix | Delete

[57] Fix | Delete

/*****

[58] Fix | Delete

***** Methods

[59] Fix | Delete

*****/

[60] Fix | Delete

[61] Fix | Delete

void

[62] Fix | Delete

isc_msgcat_open(const char *name, isc_msgcat_t **msgcatp);

[63] Fix | Delete

/*%<

[64] Fix | Delete

* Open a message catalog.

[65] Fix | Delete

*

[66] Fix | Delete

* Notes:

[67] Fix | Delete

*

[68] Fix | Delete

*\li If memory cannot be allocated or other failures occur, *msgcatp

[69] Fix | Delete

* will be set to NULL. If a NULL msgcat is given to isc_msgcat_get(),

[70] Fix | Delete

* the default_text will be returned, ensuring that some message text

[71] Fix | Delete

* will be available, no matter what's going wrong.

[72] Fix | Delete

*

[73] Fix | Delete

* Requires:

[74] Fix | Delete

*

[75] Fix | Delete

*\li 'name' is a valid string.

[76] Fix | Delete

*

[77] Fix | Delete

*\li msgcatp != NULL && *msgcatp == NULL

[78] Fix | Delete

*/

[79] Fix | Delete

[80] Fix | Delete

void

[81] Fix | Delete

isc_msgcat_close(isc_msgcat_t **msgcatp);

[82] Fix | Delete

/*%<

[83] Fix | Delete

* Close a message catalog.

[84] Fix | Delete

*

[85] Fix | Delete

* Notes:

[86] Fix | Delete

*

[87] Fix | Delete

*\li Any string pointers returned by prior calls to isc_msgcat_get() are

[88] Fix | Delete

* invalid after isc_msgcat_close() has been called and must not be

[89] Fix | Delete

* used.

[90] Fix | Delete

*

[91] Fix | Delete

* Requires:

[92] Fix | Delete

*

[93] Fix | Delete

*\li *msgcatp is a valid message catalog or is NULL.

[94] Fix | Delete

*

[95] Fix | Delete

* Ensures:

[96] Fix | Delete

*

[97] Fix | Delete

*\li All resources associated with the message catalog are released.

[98] Fix | Delete

*

[99] Fix | Delete

*\li *msgcatp == NULL

[100] Fix | Delete

*/

[101] Fix | Delete

[102] Fix | Delete

const char *

[103] Fix | Delete

isc_msgcat_get(isc_msgcat_t *msgcat, int set, int message,

[104] Fix | Delete

const char *default_text);

[105] Fix | Delete

/*%<

[106] Fix | Delete

* Get message 'message' from message set 'set' in 'msgcat'. If it

[107] Fix | Delete

* is not available, use 'default_text'.

[108] Fix | Delete

*

[109] Fix | Delete

* Requires:

[110] Fix | Delete

*

[111] Fix | Delete

*\li 'msgcat' is a valid message catalog or is NULL.

[112] Fix | Delete

*

[113] Fix | Delete

*\li set > 0

[114] Fix | Delete

*

[115] Fix | Delete

*\li message > 0

[116] Fix | Delete

*

[117] Fix | Delete

*\li 'default_text' is a valid string.

[118] Fix | Delete

*/

[119] Fix | Delete

[120] Fix | Delete

ISC_LANG_ENDDECLS

[121] Fix | Delete

[122] Fix | Delete

#endif /* ISC_MSGCAT_H */

[123] Fix | Delete

[124] Fix | Delete