Mercurial > hg > xemacs-beta
annotate lib-src/getopt.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 | ed624ab64583 |
| children | 061f4f90f874 |
| rev | line source |
|---|---|
| 428 | 1 /* Declarations for getopt. |
| 2 Copyright (C) 1989,90,91,92,93,94,96,97 Free Software Foundation, Inc. | |
| 3 | |
| 4 NOTE: The canonical source of this file is maintained with the GNU C Library. | |
| 5 Bugs can be reported to bug-glibc@prep.ai.mit.edu. | |
| 6 | |
| 7 This program is free software; you can redistribute it and/or modify it | |
| 8 under the terms of the GNU General Public License as published by the | |
| 9 Free Software Foundation; either version 2, or (at your option) any | |
| 10 later version. | |
| 11 | |
| 12 This program 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 this program; if not, write to the Free Software | |
| 19 Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, | |
| 20 USA. */ | |
| 21 | |
| 22 #ifndef _GETOPT_H | |
| 23 #define _GETOPT_H 1 | |
| 24 | |
| 25 #ifdef __cplusplus | |
| 26 extern "C" { | |
| 27 #endif | |
| 28 | |
| 29 /* For communication from `getopt' to the caller. | |
| 30 When `getopt' finds an option that takes an argument, | |
| 31 the argument value is returned here. | |
| 32 Also, when `ordering' is RETURN_IN_ORDER, | |
| 33 each non-option ARGV-element is returned here. */ | |
| 34 | |
| 35 extern char *optarg; | |
| 36 | |
| 37 /* Index in ARGV of the next element to be scanned. | |
| 38 This is used for communication to and from the caller | |
| 39 and for communication between successive calls to `getopt'. | |
| 40 | |
| 41 On entry to `getopt', zero means this is the first call; initialize. | |
| 42 | |
| 43 When `getopt' returns -1, this is the index of the first of the | |
| 44 non-option elements that the caller should itself scan. | |
| 45 | |
| 46 Otherwise, `optind' communicates from one call to the next | |
| 47 how much of ARGV has been scanned so far. */ | |
| 48 | |
| 49 extern int optind; | |
| 50 | |
| 51 /* Callers store zero here to inhibit the error message `getopt' prints | |
| 52 for unrecognized options. */ | |
| 53 | |
| 54 extern int opterr; | |
| 55 | |
| 56 /* Set to an option character which was unrecognized. */ | |
| 57 | |
| 58 extern int optopt; | |
| 59 | |
| 60 /* Describe the long-named options requested by the application. | |
| 61 The LONG_OPTIONS argument to getopt_long or getopt_long_only is a vector | |
| 62 of `struct option' terminated by an element containing a name which is | |
| 63 zero. | |
| 64 | |
| 65 The field `has_arg' is: | |
| 66 no_argument (or 0) if the option does not take an argument, | |
| 67 required_argument (or 1) if the option requires an argument, | |
| 68 optional_argument (or 2) if the option takes an optional argument. | |
| 69 | |
| 70 If the field `flag' is not NULL, it points to a variable that is set | |
| 71 to the value given in the field `val' when the option is found, but | |
| 72 left unchanged if the option is not found. | |
| 73 | |
| 74 To have a long-named option do something other than set an `int' to | |
| 75 a compiled-in constant, such as set a value from `optarg', set the | |
| 76 option's `flag' field to zero and its `val' field to a nonzero | |
| 77 value (the equivalent single-letter option character, if there is | |
| 78 one). For long options that have a zero `flag' field, `getopt' | |
| 79 returns the contents of the `val' field. */ | |
| 80 | |
| 81 struct option | |
| 82 { | |
| 83 #if defined (__STDC__) && __STDC__ | |
| 84 const char *name; | |
| 85 #else | |
| 86 char *name; | |
| 87 #endif | |
| 88 /* has_arg can't be an enum because some compilers complain about | |
| 89 type mismatches in all the code that assumes it is an int. */ | |
| 90 int has_arg; | |
| 91 int *flag; | |
| 92 int val; | |
| 93 }; | |
| 94 | |
| 95 /* Names for the values of the `has_arg' field of `struct option'. */ | |
| 96 | |
| 97 #define no_argument 0 | |
| 98 #define required_argument 1 | |
| 99 #define optional_argument 2 | |
| 100 | |
| 5091 | 101 #if defined (__GNU_LIBRARY__) || defined (__cplusplus) || defined (HAVE_CONFIG_H) |
| 428 | 102 /* Many other libraries have conflicting prototypes for getopt, with |
| 103 differences in the consts, in stdlib.h. To avoid compilation | |
| 104 errors, only prototype getopt for the GNU C library. */ | |
| 105 extern int getopt (int argc, char *const *argv, const char *shortopts); | |
| 440 | 106 #else /* not __GNU_LIBRARY__ || C++ */ |
| 428 | 107 extern int getopt (); |
| 440 | 108 #endif /* __GNU_LIBRARY__ || C++ */ |
| 428 | 109 extern int getopt_long (int argc, char *const *argv, const char *shortopts, |
| 110 const struct option *longopts, int *longind); | |
| 111 extern int getopt_long_only (int argc, char *const *argv, | |
| 112 const char *shortopts, | |
| 113 const struct option *longopts, int *longind); | |
| 114 | |
| 115 /* Internal only. Users should not call this directly. */ | |
| 116 extern int _getopt_internal (int argc, char *const *argv, | |
| 117 const char *shortopts, | |
| 118 const struct option *longopts, int *longind, | |
| 119 int long_only); | |
| 120 | |
| 121 #ifdef __cplusplus | |
| 122 } | |
| 123 #endif | |
| 124 | |
| 125 #endif /* _GETOPT_H */ |