Add GNU LGPL headers to all .c .C and .h files
[oweals/cde.git] / cde / programs / dtappbuilder / src / abmf / msg_fileP.h
1 /*
2  * CDE - Common Desktop Environment
3  *
4  * Copyright (c) 1993-2012, The Open Group. All rights reserved.
5  *
6  * These libraries and programs are free software; you can
7  * redistribute them and/or modify them under the terms of the GNU
8  * Lesser General Public License as published by the Free Software
9  * Foundation; either version 2 of the License, or (at your option)
10  * any later version.
11  *
12  * These libraries and programs are distributed in the hope that
13  * they will be useful, but WITHOUT ANY WARRANTY; without even the
14  * implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
15  * PURPOSE. See the GNU Lesser General Public License for more
16  * details.
17  *
18  * You should have received a copy of the GNU Lesser General Public
19  * License along with these librararies and programs; if not, write
20  * to the Free Software Foundation, Inc., 51 Franklin Street, Fifth
21  * Floor, Boston, MA 02110-1301 USA
22  */
23 /*
24  *      $XConsortium: msg_fileP.h /main/3 1995/11/06 18:10:51 rswiston $
25  *
26  * @(#)msg_fileP.h      1.5 12 Oct 1994 cde_app_builder/src/abmf
27  *
28  *      RESTRICTED CONFIDENTIAL INFORMATION:
29  *      
30  *      The information in this document is subject to special
31  *      restrictions in a confidential disclosure agreement between
32  *      HP, IBM, Sun, USL, SCO and Univel.  Do not distribute this
33  *      document outside HP, IBM, Sun, USL, SCO, or Univel without
34  *      Sun's specific written approval.  This document and all copies
35  *      and derivative works thereof must be returned or destroyed at
36  *      Sun's request.
37  *
38  *      Copyright 1993 Sun Microsystems, Inc.  All rights reserved.
39  *
40  */
41
42 #ifndef _ABMF_MSG_FILEP_H_
43 #define _ABMF_MSG_FILEP_H_
44
45 /*
46  * msg_fileP.h - ADT implementation declrn for message file [re]generation.
47  */
48
49 #include "msg_file.h"
50
51 #define DTB_GEN_MSG_SET_PREFIX  "DTBMS_"
52
53 /* INTERNAL: A message */
54 typedef struct _MsgRec {
55     BOOL        is_referenced;
56     int         msg_number;
57     ISTRING     msg_string;     /* message string */
58     ISTRING     msg_comment;    /* comment after the message: i18n guide */
59 } MsgRec, *Msg;
60
61
62 /* EXPORT: A message set */
63 typedef struct _MsgSetRec {
64     int         set_number;
65     char        *set_name;      
66     BOOL        allow_msg_delete;
67     BOOL        is_generated;   /* false <-> msgs are NULL; everything
68                                                 stored as set comment */
69     BOOL        is_referenced;
70     char        *set_comment;   /* comment after $set stmt: i18n guide */
71     Msg         *msgs;
72     int         num_msgs;
73     int         alloced_slots;
74 } MsgSetRec;
75
76
77 /* EXPORT: Memory representation of a message file */
78 typedef struct _MsgFileRec {
79     FILE        *fp;            /* pointer to file which was loaded */
80     char        *file_comment;  /* comment before first $set stmt */
81     MsgSet      *msg_sets;      /* in order read from msg_file */
82     int         num_msg_sets;
83     int         alloced_slots;
84 } MsgFileRec;
85
86 #endif /* !_ABMF_MSG_FILEP_H_ */