annotate src/mule-ccl.h @ 5169:6c6d78781d59

cleanup of code related to xfree(), better KKCC backtrace capabilities, document XD_INLINE_LISP_OBJECT_BLOCK_PTR, fix some memory leaks, other code cleanup -------------------- ChangeLog entries follow: -------------------- src/ChangeLog addition: 2010-03-24 Ben Wing <ben@xemacs.org> * array.h: * array.h (XD_LISP_DYNARR_DESC): * dumper.c (pdump_register_sub): * dumper.c (pdump_store_new_pointer_offsets): * dumper.c (pdump_reloc_one_mc): * elhash.c: * gc.c (lispdesc_one_description_line_size): * gc.c (kkcc_marking): * lrecord.h: * lrecord.h (IF_NEW_GC): * lrecord.h (enum memory_description_type): * lrecord.h (enum data_description_entry_flags): * lrecord.h (struct opaque_convert_functions): Rename XD_LISP_OBJECT_BLOCK_PTR to XD_INLINE_LISP_OBJECT_BLOCK_PTR and document it in lrecord.h. * data.c: * data.c (finish_marking_weak_lists): * data.c (continue_marking_ephemerons): * data.c (finish_marking_ephemerons): * elhash.c (MARK_OBJ): * gc.c: * gc.c (lispdesc_indirect_count_1): * gc.c (struct): * gc.c (kkcc_bt_push): * gc.c (kkcc_gc_stack_push): * gc.c (kkcc_gc_stack_push_lisp_object): * gc.c (kkcc_gc_stack_repush_dirty_object): * gc.c (KKCC_DO_CHECK_FREE): * gc.c (mark_object_maybe_checking_free): * gc.c (mark_struct_contents): * gc.c (mark_lisp_object_block_contents): * gc.c (register_for_finalization): * gc.c (mark_object): * gc.h: * lisp.h: * profile.c: * profile.c (mark_profiling_info_maphash): Clean up KKCC code related to DEBUG_XEMACS. Rename kkcc_backtrace() to kkcc_backtrace_1() and add two params: a `size' arg to control how many stack elements to print and a `detailed' arg to control whether Lisp objects are printed using `debug_print()'. Create front-ends to kkcc_backtrace_1() -- kkcc_detailed_backtrace(), kkcc_short_backtrace(), kkcc_detailed_backtrace_full(), kkcc_short_backtrace_full(), as well as shortened versions kbt(), kbts(), kbtf(), kbtsf() -- to call it with various parameter values. Add an `is_lisp' field to the stack and backtrace structures and use it to keep track of whether an object pushed onto the stack is a Lisp object or a non-Lisp structure; in kkcc_backtrace_1(), don't try to print a non-Lisp structure as a Lisp object. * elhash.c: * extents.c: * file-coding.c: * lrecord.h: * lrecord.h (IF_NEW_GC): * marker.c: * marker.c (Fmarker_buffer): * mule-coding.c: * number.c: * rangetab.c: * specifier.c: New macros IF_OLD_GC(), IF_NEW_GC() to simplify declaration of Lisp objects when a finalizer may exist in one but not the other. Use them appropriately. * extents.c (finalize_extent_info): Don't zero out data->soe and data->extents before trying to free, else we get memory leaks. * lrecord.h (enum lrecord_type): Make the first lrecord type have value 1 not 0 so that 0 remains without implementation and attempts to interpret zeroed memory as a Lisp object will be more obvious. * array.c (Dynarr_free): * device-msw.c (msprinter_delete_device): * device-tty.c (free_tty_device_struct): * device-tty.c (tty_delete_device): * dialog-msw.c (handle_directory_dialog_box): * dialog-x.c: * emacs.c (free_argc_argv): * emodules.c (attempt_module_delete): * file-coding.c (chain_finalize_coding_stream_1): * file-coding.c (chain_finalize_coding_stream): * glyphs-eimage.c: * glyphs-eimage.c (jpeg_instantiate_unwind): * glyphs-eimage.c (gif_instantiate_unwind): * glyphs-eimage.c (png_instantiate_unwind): * glyphs-eimage.c (tiff_instantiate_unwind): * imgproc.c: * imgproc.c (build_EImage_quantable): * insdel.c (uninit_buffer_text): * mule-coding.c (iso2022_finalize_detection_state): * objects-tty.c (tty_finalize_color_instance): * objects-tty.c (tty_finalize_font_instance): * objects-tty.c (tty_font_list): * process.c: * process.c (finalize_process): * redisplay.c (add_propagation_runes): * scrollbar-gtk.c: * scrollbar-gtk.c (gtk_free_scrollbar_instance): * scrollbar-gtk.c (gtk_release_scrollbar_instance): * scrollbar-msw.c: * scrollbar-msw.c (mswindows_free_scrollbar_instance): * scrollbar-msw.c (unshow_that_mofo): * scrollbar-x.c (x_free_scrollbar_instance): * scrollbar-x.c (x_release_scrollbar_instance): * select-x.c: * select-x.c (x_handle_selection_request): * syntax.c: * syntax.c (uninit_buffer_syntax_cache): * text.h (eifree): If possible, whenever we call xfree() on a field in a structure, set the field to 0 afterwards. A lot of code is written so that it checks the value being freed to see if it is non-zero before freeing it -- doing this and setting the value to 0 afterwards ensures (a) we won't try to free twice if the cleanup code is called twice; (b) if the object itself stays around, KKCC won't crash when attempting to mark the freed field. * rangetab.c: Add a finalization method when not NEW_GC to avoid memory leaks. (#### We still get memory leaks when NEW_GC; need to convert gap array to Lisp object).
author Ben Wing <ben@xemacs.org>
date Wed, 24 Mar 2010 01:22:51 -0500
parents 0c54de4c4b9d
children 308d34e9f07d
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
1 /* Header for CCL (Code Conversion Language) interpreter.
444
576fb035e263 Import from CVS: tag r21-2-37
cvs
parents: 442
diff changeset
2 Copyright (C) 1995 Electrotechnical Laboratory, JAPAN.
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
3 Licensed to the Free Software Foundation.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
4
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
5 This file is part of XEmacs.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
6
613
023b83f4e54b [xemacs-hg @ 2001-06-10 10:42:16 by ben]
ben
parents: 444
diff changeset
7 XEmacs is free software; you can redistribute it and/or modify
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
8 it under the terms of the GNU General Public License as published by
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
9 the Free Software Foundation; either version 2, or (at your option)
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
10 any later version.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
11
613
023b83f4e54b [xemacs-hg @ 2001-06-10 10:42:16 by ben]
ben
parents: 444
diff changeset
12 XEmacs is distributed in the hope that it will be useful,
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
15 GNU General Public License for more details.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
16
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
17 You should have received a copy of the GNU General Public License
613
023b83f4e54b [xemacs-hg @ 2001-06-10 10:42:16 by ben]
ben
parents: 444
diff changeset
18 along with XEmacs; see the file COPYING. If not, write to
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
19 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
20 Boston, MA 02111-1307, USA. */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
21
440
8de8e3f6228a Import from CVS: tag r21-2-28
cvs
parents: 428
diff changeset
22 #ifndef INCLUDED_mule_ccl_h_
8de8e3f6228a Import from CVS: tag r21-2-28
cvs
parents: 428
diff changeset
23 #define INCLUDED_mule_ccl_h_
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
24
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
25 /* Macros for exit status of CCL program. */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
26 #define CCL_STAT_SUCCESS 0 /* Terminated successfully. */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
27 #define CCL_STAT_SUSPEND_BY_SRC 1 /* Terminated by empty input. */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
28 #define CCL_STAT_SUSPEND_BY_DST 2 /* Terminated by output buffer full. */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
29 #define CCL_STAT_INVALID_CMD 3 /* Terminated because of invalid
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
30 command. */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
31 #define CCL_STAT_QUIT 4 /* Terminated because of quit. */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
32
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
33 /* Structure to hold information about running CCL code. Read
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
34 comments in the file ccl.c for the detail of each field. */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
35 struct ccl_program {
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
36 int size; /* Size of the compiled code. */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
37 Lisp_Object *prog; /* Pointer into the compiled code. */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
38 int ic; /* Instruction Counter (index for PROG). */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
39 int eof_ic; /* Instruction Counter for end-of-file
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
40 processing code. */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
41 int reg[8]; /* CCL registers, reg[7] is used for
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
42 condition flag of relational
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
43 operations. */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
44 int private_state; /* CCL instruction may use this
444
576fb035e263 Import from CVS: tag r21-2-37
cvs
parents: 442
diff changeset
45 for private use, mainly for saving
576fb035e263 Import from CVS: tag r21-2-37
cvs
parents: 442
diff changeset
46 internal states on suspending.
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
47 This variable is set to 0 when ccl is
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
48 set up. */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
49 int last_block; /* Set to 1 while processing the last
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
50 block. */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
51 int status; /* Exit status of the CCL program. */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
52 int buf_magnification; /* Output buffer magnification. How
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
53 many times bigger the output buffer
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
54 should be than the input buffer. */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
55 int stack_idx; /* How deep the call of CCL_Call is nested. */
444
576fb035e263 Import from CVS: tag r21-2-37
cvs
parents: 442
diff changeset
56 int eol_type; /* When the CCL program is used for
576fb035e263 Import from CVS: tag r21-2-37
cvs
parents: 442
diff changeset
57 encoding by a coding system, set to
576fb035e263 Import from CVS: tag r21-2-37
cvs
parents: 442
diff changeset
58 the eol_type of the coding
576fb035e263 Import from CVS: tag r21-2-37
cvs
parents: 442
diff changeset
59 system. */
576fb035e263 Import from CVS: tag r21-2-37
cvs
parents: 442
diff changeset
60 int multibyte; /* 1 if the source text is multibyte. */
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
61 };
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
62
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
63 #define CCL_MODE_ENCODING 0
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
64 #define CCL_MODE_DECODING 1
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
65
444
576fb035e263 Import from CVS: tag r21-2-37
cvs
parents: 442
diff changeset
66 #define CCL_CODING_EOL_LF 0 /* Line-feed only, same as Emacs'
576fb035e263 Import from CVS: tag r21-2-37
cvs
parents: 442
diff changeset
67 internal format. */
576fb035e263 Import from CVS: tag r21-2-37
cvs
parents: 442
diff changeset
68 #define CCL_CODING_EOL_CRLF 1 /* Sequence of carriage-return and
576fb035e263 Import from CVS: tag r21-2-37
cvs
parents: 442
diff changeset
69 line-feed. */
576fb035e263 Import from CVS: tag r21-2-37
cvs
parents: 442
diff changeset
70 #define CCL_CODING_EOL_CR 2 /* Carriage-return only. */
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
71
4745
0c54de4c4b9d Resolve the unregistered-CCL-programs-get-garbage-collected problem correctly
Aidan Kehoe <kehoea@parhasard.net>
parents: 613
diff changeset
72 /* If OBJECT is symbol designating a registered CCL program, return it.
0c54de4c4b9d Resolve the unregistered-CCL-programs-get-garbage-collected problem correctly
Aidan Kehoe <kehoea@parhasard.net>
parents: 613
diff changeset
73 Else if OBJECT is a vector CCL program with no unresolved symbols, return
0c54de4c4b9d Resolve the unregistered-CCL-programs-get-garbage-collected problem correctly
Aidan Kehoe <kehoea@parhasard.net>
parents: 613
diff changeset
74 it.
0c54de4c4b9d Resolve the unregistered-CCL-programs-get-garbage-collected problem correctly
Aidan Kehoe <kehoea@parhasard.net>
parents: 613
diff changeset
75 Else, if OBJECT is a vector CCL program with unresolved symbols, return a
0c54de4c4b9d Resolve the unregistered-CCL-programs-get-garbage-collected problem correctly
Aidan Kehoe <kehoea@parhasard.net>
parents: 613
diff changeset
76 newly-created vector reflecting the CCL program with all symbols
0c54de4c4b9d Resolve the unregistered-CCL-programs-get-garbage-collected problem correctly
Aidan Kehoe <kehoea@parhasard.net>
parents: 613
diff changeset
77 resolved, if that is currently possible in this XEmacs.
444
576fb035e263 Import from CVS: tag r21-2-37
cvs
parents: 442
diff changeset
78
4745
0c54de4c4b9d Resolve the unregistered-CCL-programs-get-garbage-collected problem correctly
Aidan Kehoe <kehoea@parhasard.net>
parents: 613
diff changeset
79 Otherwise, signal `invalid-argument'. */
0c54de4c4b9d Resolve the unregistered-CCL-programs-get-garbage-collected problem correctly
Aidan Kehoe <kehoea@parhasard.net>
parents: 613
diff changeset
80 extern Lisp_Object get_ccl_program (Lisp_Object object);
0c54de4c4b9d Resolve the unregistered-CCL-programs-get-garbage-collected problem correctly
Aidan Kehoe <kehoea@parhasard.net>
parents: 613
diff changeset
81
0c54de4c4b9d Resolve the unregistered-CCL-programs-get-garbage-collected problem correctly
Aidan Kehoe <kehoea@parhasard.net>
parents: 613
diff changeset
82 /* Set up fields of the structure pointed by CCL appropriately for the
0c54de4c4b9d Resolve the unregistered-CCL-programs-get-garbage-collected problem correctly
Aidan Kehoe <kehoea@parhasard.net>
parents: 613
diff changeset
83 execution of ccl program CCL_PROG (a symbol or a vector).
0c54de4c4b9d Resolve the unregistered-CCL-programs-get-garbage-collected problem correctly
Aidan Kehoe <kehoea@parhasard.net>
parents: 613
diff changeset
84
0c54de4c4b9d Resolve the unregistered-CCL-programs-get-garbage-collected problem correctly
Aidan Kehoe <kehoea@parhasard.net>
parents: 613
diff changeset
85 If CCL_PROG is a vector and contains unresolved symbols, this function
0c54de4c4b9d Resolve the unregistered-CCL-programs-get-garbage-collected problem correctly
Aidan Kehoe <kehoea@parhasard.net>
parents: 613
diff changeset
86 will throw an assertion failure. To avoid this, call get_ccl_program at
0c54de4c4b9d Resolve the unregistered-CCL-programs-get-garbage-collected problem correctly
Aidan Kehoe <kehoea@parhasard.net>
parents: 613
diff changeset
87 the point that you receive the CCL program from Lisp, and use and store
0c54de4c4b9d Resolve the unregistered-CCL-programs-get-garbage-collected problem correctly
Aidan Kehoe <kehoea@parhasard.net>
parents: 613
diff changeset
88 its (resolved) result instead. */
0c54de4c4b9d Resolve the unregistered-CCL-programs-get-garbage-collected problem correctly
Aidan Kehoe <kehoea@parhasard.net>
parents: 613
diff changeset
89 extern int setup_ccl_program (struct ccl_program *, Lisp_Object ccl_prog);
444
576fb035e263 Import from CVS: tag r21-2-37
cvs
parents: 442
diff changeset
90
576fb035e263 Import from CVS: tag r21-2-37
cvs
parents: 442
diff changeset
91 extern int ccl_driver (struct ccl_program *, const unsigned char *,
576fb035e263 Import from CVS: tag r21-2-37
cvs
parents: 442
diff changeset
92 unsigned_char_dynarr *, int, int *, int);
576fb035e263 Import from CVS: tag r21-2-37
cvs
parents: 442
diff changeset
93
576fb035e263 Import from CVS: tag r21-2-37
cvs
parents: 442
diff changeset
94 EXFUN (Fregister_ccl_program, 2);
576fb035e263 Import from CVS: tag r21-2-37
cvs
parents: 442
diff changeset
95
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
96 extern Lisp_Object Qccl_program;
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
97
444
576fb035e263 Import from CVS: tag r21-2-37
cvs
parents: 442
diff changeset
98 /* Vector of CCL program names vs corresponding program data. */
576fb035e263 Import from CVS: tag r21-2-37
cvs
parents: 442
diff changeset
99 extern Lisp_Object Vccl_program_table;
576fb035e263 Import from CVS: tag r21-2-37
cvs
parents: 442
diff changeset
100
576fb035e263 Import from CVS: tag r21-2-37
cvs
parents: 442
diff changeset
101 /* Symbols of ccl program have this property, a value of the property
576fb035e263 Import from CVS: tag r21-2-37
cvs
parents: 442
diff changeset
102 is an index for Vccl_program_table. */
576fb035e263 Import from CVS: tag r21-2-37
cvs
parents: 442
diff changeset
103 extern Lisp_Object Qccl_program_idx;
576fb035e263 Import from CVS: tag r21-2-37
cvs
parents: 442
diff changeset
104
440
8de8e3f6228a Import from CVS: tag r21-2-28
cvs
parents: 428
diff changeset
105 #endif /* INCLUDED_mule_ccl_h_ */