gnu/dist/gettext/gettext-tools/src/read-po.h

   1 /* Reading PO files.
   2    Copyright (C) 1995-1998, 2000-2003 Free Software Foundation, Inc.
   3    This file was written by Bruno Haible <haible@clisp.cons.org>.
   4
   5    This program is free software; you can redistribute it and/or modify
   6    it under the terms of the GNU General Public License as published by
   7    the Free Software Foundation; either version 2, or (at your option)
   8    any later version.
   9
  10    This program is distributed in the hope that it will be useful,
  11    but WITHOUT ANY WARRANTY; without even the implied warranty of
  12    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13    GNU General Public License for more details.
  14
  15    You should have received a copy of the GNU General Public License
  16    along with this program; if not, write to the Free Software Foundation,
  17    Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.  */
  18
  19 #ifndef _READ_PO_H
  20 #define _READ_PO_H
  21
  22 #include "message.h"
  23 #include "read-po-abstract.h"
  24
  25 #include <stdbool.h>
  26 #include <stdio.h>
  27
  28
  29 /* For including this file in C++ mode.  */
  30 #ifdef __cplusplus
  31 # define this thiss
  32 #endif
  33
  34 #ifdef __cplusplus
  35 extern "C" {
  36 #endif
  37
  38
  39 /* The following pair of structures cooperate to create a derived class from
  40    class abstract_po_reader_ty.  (See read-po-abstract.h for an explanation.)
  41    It implements the default behaviour of reading a PO file and converting it
  42    to an 'msgdomain_list_ty *'.  */
  43
  44 /* Forward declaration.  */
  45 struct default_po_reader_ty;
  46
  47
  48 typedef struct default_po_reader_class_ty default_po_reader_class_ty;
  49 struct default_po_reader_class_ty
  50 {
  51   /* Methods inherited from superclass.  */
  52   struct abstract_po_reader_class_ty super;
  53
  54   /* How to change the current domain.  */
  55   void (*set_domain) (struct default_po_reader_ty *pop, char *name);
  56
  57   /* How to add a message to the list.  */
  58   void (*add_message) (struct default_po_reader_ty *pop,
  59                        char *msgid, lex_pos_ty *msgid_pos, char *msgid_plural,
  60                        char *msgstr, size_t msgstr_len, lex_pos_ty *msgstr_pos,
  61                        bool force_fuzzy, bool obsolete);
  62
  63   /* How to modify a new message before adding it to the list.  */
  64   void (*frob_new_message) (struct default_po_reader_ty *pop, message_ty *mp,
  65                             const lex_pos_ty *msgid_pos,
  66                             const lex_pos_ty *msgstr_pos);
  67 };
  68
  69
  70 #define DEFAULT_PO_READER_TY \
  71   ABSTRACT_PO_READER_TY                                                 \
  72                                                                         \
  73   /* If true, pay attention to comments and filepos comments.  */       \
  74   bool handle_comments;                                                 \
  75                                                                         \
  76   /* If true, remember comments for file name and line number for each  \
  77      msgid, if present in the reference input.  */                      \
  78   bool handle_filepos_comments;                                         \
  79                                                                         \
  80   /* If false, domain directives lead to an error messsage.  */         \
  81   bool allow_domain_directives;                                         \
  82                                                                         \
  83   /* If false, duplicate msgids in the same domain and file generate an \
  84      error.  If true, such msgids are allowed; the caller should treat  \
  85      them appropriately.  */                                            \
  86   bool allow_duplicates;                                                \
  87                                                                         \
  88   /* If true, allow duplicates if they have the same translation.  */   \
  89   bool allow_duplicates_if_same_msgstr;                                 \
  90                                                                         \
  91   /* List of messages already appeared in the current file.  */         \
  92   msgdomain_list_ty *mdlp;                                              \
  93                                                                         \
  94   /* Name of domain we are currently examining.  */                     \
  95   const char *domain;                                                   \
  96                                                                         \
  97   /* List of messages belonging to the current domain.  */              \
  98   message_list_ty *mlp;                                                 \
  99                                                                         \
 100   /* Accumulate comments for next message directive.  */                \
 101   string_list_ty *comment;                                              \
 102   string_list_ty *comment_dot;                                          \
 103                                                                         \
 104   /* Accumulate filepos comments for the next message directive.  */    \
 105   size_t filepos_count;                                                 \
 106   lex_pos_ty *filepos;                                                  \
 107                                                                         \
 108   /* Flags transported in special comments.  */                         \
 109   bool is_fuzzy;                                                        \
 110   enum is_format is_format[NFORMATS];                                   \
 111   enum is_wrap do_wrap;                                                 \
 112
 113 typedef struct default_po_reader_ty default_po_reader_ty;
 114 struct default_po_reader_ty
 115 {
 116   DEFAULT_PO_READER_TY
 117 };
 118
 119 extern void default_constructor (abstract_po_reader_ty *that);
 120 extern void default_destructor (abstract_po_reader_ty *that);
 121 extern void default_parse_brief (abstract_po_reader_ty *that);
 122 extern void default_parse_debrief (abstract_po_reader_ty *that);
 123 extern void default_directive_domain (abstract_po_reader_ty *that, char *name);
 124 extern void default_directive_message (abstract_po_reader_ty *that,
 125                                        char *msgid,
 126                                        lex_pos_ty *msgid_pos,
 127                                        char *msgid_plural,
 128                                        char *msgstr, size_t msgstr_len,
 129                                        lex_pos_ty *msgstr_pos,
 130                                        bool force_fuzzy, bool obsolete);
 131 extern void default_comment (abstract_po_reader_ty *that, const char *s);
 132 extern void default_comment_dot (abstract_po_reader_ty *that, const char *s);
 133 extern void default_comment_filepos (abstract_po_reader_ty *that,
 134                                      const char *name, size_t line);
 135 extern void default_comment_special (abstract_po_reader_ty *that,
 136                                      const char *s);
 137 extern void default_set_domain (default_po_reader_ty *this, char *name);
 138 extern void default_add_message (default_po_reader_ty *this,
 139                                  char *msgid,
 140                                  lex_pos_ty *msgid_pos,
 141                                  char *msgid_plural,
 142                                  char *msgstr, size_t msgstr_len,
 143                                  lex_pos_ty *msgstr_pos,
 144                                  bool force_fuzzy, bool obsolete);
 145
 146 /* Allocate a fresh default_po_reader_ty (or derived class) instance and
 147    call its constructor.  */
 148 extern default_po_reader_ty *
 149        default_po_reader_alloc (default_po_reader_class_ty *method_table);
 150
 151
 152 /* If nonzero, remember comments for file name and line number for each
 153    msgid, if present in the reference input.  Defaults to true.  */
 154 extern DLL_VARIABLE int line_comment;
 155
 156 /* If false, duplicate msgids in the same domain and file generate an error.
 157    If true, such msgids are allowed; the caller should treat them
 158    appropriately.  Defaults to false.  */
 159 extern DLL_VARIABLE bool allow_duplicates;
 160
 161 /* Expected syntax of the input files.  */
 162 extern DLL_VARIABLE input_syntax_ty input_syntax;
 163
 164 /* Read the input file from a stream.  Returns a list of messages.  */
 165 extern msgdomain_list_ty *read_po (FILE *fp, const char *real_filename,
 166                                    const char *logical_filename);
 167
 168 /* Read the input file with the name INPUT_NAME.  The ending .po is added
 169    if necessary.  If INPUT_NAME is not an absolute file name and the file is
 170    not found, the list of directories in "dir-list.h" is searched.  Returns
 171    a list of messages.  */
 172 extern msgdomain_list_ty *read_po_file (const char *input_name);
 173
 174
 175 #ifdef __cplusplus
 176 }
 177 #endif
 178
 179
 180 #endif /* _READ_PO_H */