src/ccl.h

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