src/ccl.h

   1 /* Header for CCL (Code Conversion Language) interpreter.
   2    Copyright (C) 1995, 1998, 2000
   3      National Institute of Advanced Industrial Science and Technology (AIST)
   4      Registration Number H14PRO021
   5
   6 This file is part of GNU Emacs.
   7
   8 GNU Emacs is free software; you can redistribute it and/or modify
   9 it under the terms of the GNU General Public License as published by
  10 the Free Software Foundation; either version 2, or (at your option)
  11 any later version.
  12
  13 GNU Emacs is distributed in the hope that it will be useful,
  14 but WITHOUT ANY WARRANTY; without even the implied warranty of
  15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16 GNU General Public License for more details.
  17
  18 You should have received a copy of the GNU General Public License
  19 along with GNU Emacs; see the file COPYING.  If not, write to
  20 the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  21 Boston, MA 02110-1301, USA.  */
  22
  23 #ifndef EMACS_CCL_H
  24 #define EMACS_CCL_H
  25
  26 /* Macros for exit status of CCL program.  */
  27 #define CCL_STAT_SUCCESS        0 /* Terminated successfully.  */
  28 #define CCL_STAT_SUSPEND_BY_SRC 1 /* Terminated by empty input.  */
  29 #define CCL_STAT_SUSPEND_BY_DST 2 /* Terminated by output buffer full.  */
  30 #define CCL_STAT_INVALID_CMD    3 /* Terminated because of invalid
  31                                      command.  */
  32 #define CCL_STAT_QUIT           4 /* Terminated because of quit.  */
  33
  34 /* Structure to hold information about running CCL code.  Read
  35    comments in the file ccl.c for the detail of each field.  */
  36 struct ccl_program {
  37   int idx;                      /* Index number of the CCL program.
  38                                    -1 means that the program was given
  39                                    by a vector, not by a program
  40                                    name.  */
  41   int size;                     /* Size of the compiled code.  */
  42   Lisp_Object *prog;            /* Pointer into the compiled code.  */
  43   int ic;                       /* Instruction Counter (index for PROG).  */
  44   int eof_ic;                   /* Instruction Counter for end-of-file
  45                                    processing code.  */
  46   int reg[8];                   /* CCL registers, reg[7] is used for
  47                                    condition flag of relational
  48                                    operations.  */
  49   int private_state;            /* CCL instruction may use this
  50                                    for private use, mainly for saving
  51                                    internal states on suspending.
  52                                    This variable is set to 0 when ccl is
  53                                    set up.  */
  54   int last_block;               /* Set to 1 while processing the last
  55                                    block. */
  56   int status;                   /* Exit status of the CCL program.  */
  57   int buf_magnification;        /* Output buffer magnification.  How
  58                                    many times bigger the output buffer
  59                                    should be than the input buffer.  */
  60   int stack_idx;                /* How deep the call of CCL_Call is nested.  */
  61   int eol_type;                 /* When the CCL program is used for
  62                                    encoding by a coding system, set to
  63                                    the eol_type of the coding system.
  64                                    In other cases, always
  65                                    CODING_EOL_LF.  */
  66   int multibyte;                /* 1 if the source text is multibyte.  */
  67   int cr_consumed;              /* Flag for encoding DOS-like EOL
  68                                    format when the CCL program is used
  69                                    for encoding by a coding
  70                                    system.  */
  71   int suppress_error;           /* If nonzero, don't insert error
  72                                    message in the output.  */
  73   int eight_bit_control;        /* If nonzero, ccl_driver counts all
  74                                    eight-bit-control bytes written by
  75                                    CCL_WRITE_CHAR.  After execution,
  76                                    if no such byte is written, set
  77                                    this value to zero.  */
  78 };
  79
  80 /* This data type is used for the spec field of the structure
  81    coding_system.  */
  82
  83 struct ccl_spec {
  84   struct ccl_program decoder;
  85   struct ccl_program encoder;
  86   unsigned char valid_codes[256];
  87   int cr_carryover;             /* CR carryover flag.  */
  88   unsigned char eight_bit_carryover[MAX_MULTIBYTE_LENGTH];
  89 };
  90
  91 /* Alist of fontname patterns vs corresponding CCL program.  */
  92 extern Lisp_Object Vfont_ccl_encoder_alist;
  93
  94 /* Setup fields of the structure pointed by CCL appropriately for the
  95    execution of ccl program CCL_PROG (symbol or vector).  */
  96 extern int setup_ccl_program P_ ((struct ccl_program *, Lisp_Object));
  97
  98 /* Check if CCL is updated or not.  If not, re-setup members of CCL.  */
  99 extern int check_ccl_update P_ ((struct ccl_program *));
 100
 101 extern int ccl_driver P_ ((struct ccl_program *, unsigned char *,
 102                            unsigned char *, int, int, int *));
 103
 104 /* Vector of CCL program names vs corresponding program data.  */
 105 extern Lisp_Object Vccl_program_table;
 106
 107 /* Symbols of ccl program have this property, a value of the property
 108    is an index for Vccl_protram_table. */
 109 extern Lisp_Object Qccl_program_idx;
 110
 111 #endif /* EMACS_CCL_H */
 112
 113 /* arch-tag: 14681df7-876d-43de-bc71-6b78e23a4e3c
 114    (do not change this comment) */