Mercurial > emacs
view admin/check-doc-strings @ 59146:9bde7721ad0f
* dispextern.h: Change HAVE_CARBON to MAC_OS.
(struct glyph_string): Likewise.
* emacs.c (main) [MAC_OS8]: Call mac_term_init instead of
mac_initialize.
* fileio.c (Fnext_read_file_uses_dialog_p, Fread_file_name):
Change TARGET_API_MAC_CARBON to HAVE_CARBON.
* fns.c (vector): Change MAC_OSX to MAC_OS.
* frame.c (x_set_frame_parameters, x_report_frame_params)
(x_set_fullscreen): Remove #ifndef HAVE_CARBON.
(x_set_border_width, Vdefault_frame_scroll_bars): Change
HAVE_CARBON to MAC_OS.
* image.c [MAC_OS]: Include sys/stat.h.
[MAC_OS && !MAC_OSX]: Include sys/param.h, ImageCompression.h, and
QuickTimeComponents.h.
* mac.c [!MAC_OSX] (mac_wait_next_event): Add extern.
[!MAC_OSX] (select): Use mac_wait_next_event.
[!MAC_OSX] (run_mac_command): Change EXEC_SUFFIXES to
Vexec_suffixes.
[!MAC_OSX] (select, run_mac_command): Change `#ifdef
TARGET_API_MAC_CARBON' to `#if TARGET_API_MAC_CARBON'.
(mac_clear_font_name_table): Add extern.
(Fmac_clear_font_name_table): New defun.
(syms_of_mac): Defsubr it.
[MAC_OSX] (SELECT_POLLING_PERIOD_USEC): New define.
[MAC_OSX] (select_and_poll_event): New function.
[MAC_OSX] (sys_select): Use it.
[MAC_OSX && SELECT_USE_CFSOCKET] (socket_callback): New function.
[MAC_OSX && SELECT_USE_CFSOCKET]
(SELECT_TIMEOUT_THRESHOLD_RUNLOOP, EVENT_CLASS_SOCK): New defines.
[MAC_OSX] (sys_select) [SELECT_USE_CFSOCKET]: Use CFSocket and
RunLoop for simultaneously monitoring two kinds of inputs, window
events and process outputs, without periodically polling.
* macfns.c (mac_initialized): Remove extern.
(stricmp): Put in #if 0. All callers changed to use xstricmp in
xfaces.c.
(strnicmp): Decrement `n' at the end of each loop, not the
beginning.
(check_mac): Use the term "Mac native windows" instead of "Mac
OS".
(check_x_display_info, x_display_info_for_name): Sync with xfns.c.
(mac_get_rdb_resource): New function (from w32reg.c).
(x_get_string_resource): Use it.
(install_window_handler): Add extern.
(mac_window): New function.
(Fx_create_frame): Use it instead of make_mac_frame. Set
parameter for Qfullscreen. Call x_wm_set_size_hint.
(Fx_open_connection, Fx_close_connection): New defuns.
(syms_of_macfns): Defsubr them.
(x_create_tip_frame) [TARGET_API_MAC_CARBON]: Add
kWindowNoUpdatesAttribute to the window attribute.
(x_create_tip_frame) [!TARGET_API_MAC_CARBON]: Use NewCWindow.
(x_create_tip_frame): Don't call ShowWindow.
(Fx_show_tip): Call ShowWindow.
(Fx_file_dialog): Change `#ifdef TARGET_API_MAC_CARBON' to `#if
TARGET_API_MAC_CARBON'.
(mac_frame_parm_handlers): Set handlers for Qfullscreen.
(syms_of_macfns) [MAC_OSX]: Initialize mac_in_use to 0.
* macgui.h [!MAC_OSX]: Don't include Controls.h. Include
Windows.h.
(Window): Typedef to WindowPtr and move outside `#if
TARGET_API_MAC_CARBON'.
(XSizeHints): New struct.
* macterm.c (x_update_begin, x_update_end)
[TARGET_API_MAC_CARBON]: Disable screen updates during update of a
frame.
(x_draw_glyph_string_background, x_draw_glyph_string_foreground)
[MAC_OS8]: Use XDrawImageString/XDrawImageString16.
(construct_mouse_click): Put in #if 0.
(x_check_fullscreen, x_check_fullscreen_move): Remove decls.
(x_scroll_bar_create, x_scroll_bar_handle_click): Change `#ifdef
TARGET_API_MAC_CARBON' to `#if TARGET_API_MAC_CARBON'.
(activate_scroll_bars, deactivate_scroll_bars)
[!TARGET_API_MAC_CARBON]: Use ActivateControl/DeactivateControl.
(x_make_frame_visible) [TARGET_API_MAC_CARBON]: Reposition window
if the position is neither user-specified nor program-specified.
(x_free_frame_resources): Free size_hints.
(x_wm_set_size_hint): Allocate size_hints if needed. Set
size_hints.
(mac_clear_font_name_table): New function.
(mac_do_list_fonts): Initialize font_name_table if needed.
(x_list_fonts): Don't initialize font_name_table. Add BLOCK_INPUT
around mac_do_list_fonts.
(mac_unload_font): New function.
(x_load_font): Add BLOCK_INPUT around XLoadQueryFont.
(init_mac_drag_n_drop, mac_do_receive_drag): Enclose declarations
and definitions with #if TARGET_API_MAC_CARBON.
[USE_CARBON_EVENTS] (mac_handle_window_event): Add decl.
(install_window_handler): Add decl.
(do_window_update): Add BeginUpdate/EndUpdate for the tooltip
window. Use UpdateControls. Get the rectangle that should be
updated and restrict the target of expose_frame to it.
(do_grow_window): Set minimum height/width according to
size_hints.
(do_grow_window) [TARGET_API_MAC_CARBON]: Use ResizeWindow.
(do_zoom_window): Don't use x_set_window_size.
[USE_CARBON_EVENTS] (mac_handle_window_event): New function.
(install_window_handler): New function.
[!USE_CARBON_EVENTS] (mouse_region): New variable.
[!USE_CARBON_EVENTS] (mac_wait_next_event): New function.
(XTread_socket) [USE_CARBON_EVENTS]: Move call to
GetEventDispatcherTarget inside BLOCK_INPUT.
(XTread_socket) [!USE_CARBON_EVENTS]: Use mac_wait_next_event.
Update mouse_region when mouse is moved.
(make_mac_frame): Remove.
(make_mac_terminal_frame): Put in #ifdef MAC_OS8. Initialize
mouse pointer shapes. Change values of f->left_pos and
f->top_pos. Don't use make_mac_frame. Use NewCWindow. Don't
call ShowWindow.
(mac_initialize_display_info) [MAC_OSX]: Create mac_id_name from
Vinvocation_name and Vsystem_name.
(mac_make_rdb): New function (from w32term.c).
(mac_term_init): Use it. Add BLOCK_INPUT. Error if display has
already been opened. Don't pass argument to
mac_initialize_display_info. Don't set dpyinfo->height/width.
Add entries to x_display_list and x_display_name_list.
(x_delete_display): New function.
(mac_initialize): Don't call mac_initialize_display_info.
(syms_of_macterm) [!MAC_OSX]: Don't call Fprovide.
* macterm.h (check_mac): Add extern.
(struct mac_output): New member size_hints.
(FRAME_SIZE_HINTS): New macro.
(mac_unload_font): Add extern.
* xdisp.c (expose_window, expose_frame): Remove kludges for Mac.
* xfaces.c (clear_font_table) [MAC_OS]: call mac_unload_font.
author | Steven Tamm <steventamm@mac.com> |
---|---|
date | Mon, 27 Dec 2004 17:27:30 +0000 |
parents | 695cf19ef79e |
children | 4e2606f6ee72 375f2633d815 |
line wrap: on
line source
: #-*- Perl -*- eval 'exec perl -w -S $0 ${1+"$@"}' # Portability kludge if 0; # Author: Martin Buchholz use strict; use POSIX; (my $myName = $0) =~ s@.*/@@; my $usage=" Usage: $myName Finds DOCSTRING arg mismatches between formal parameters, docstrings, and lispref texi. This program is in the public domain.\n"; die $usage if @ARGV; die $usage unless -r "src/alloc.c" && -d "CVS" && -d "lisp"; my %texi_funtype; my %texi_arglist; my %code_funtype; my %code_arglist; sub FileContents { local $/ = undef; open (FILE, "< $_[0]") or die "$_[0]: $!"; return scalar <FILE>; } sub Show_details { my ($show_details, $function, $parms, $docstring) = @_; if ($show_details) { print "function = $function $parms\n$docstring\n", "-" x 70, "\n"; } } sub Check_texi_function { my ($function, $funtype, $docstring, @parms) = @_; my %docstring_parm; my %docstring_word; my %arglist_parm; my $show_details = 0; if (exists $texi_funtype{$function}) { print "duplicate texidoc: $function @parms\n"; return; # later definition likely bogus package def } $texi_funtype{$function} = $funtype; $texi_arglist{$function} = "@parms"; foreach my $parm (@parms) { next if $parm eq '&optional' || $parm eq '&rest'; $arglist_parm{$parm} = 1; } foreach my $parm ($docstring =~ /\@var{([^{}]+)}/g) { $docstring_parm{$parm} = 1; } foreach my $hit ($docstring =~ /[^\`]\`[A-Za-z-]+\'/g) { print "texi \@code missing: $function: $hit\n"; $show_details = 1; } # (my $raw_docstring = $docstring) =~ s/\@var{[^{}]+}//g; # $raw_docstring =~ s/[^a-zA-Z_-]+/ /g; # foreach my $word (split (' ', $raw_docstring)) { # if ($word =~ /^[A-Z][A-Z-]+$/) { # print "Missing \@var: $function: $word\n"; # } # } foreach my $parm (keys %docstring_parm) { if (! exists $arglist_parm{$parm}) { print "bogus texi parm: $function: $parm\n"; $show_details = 1; } } foreach my $parm (keys %arglist_parm) { if (! exists $docstring_parm{$parm}) { print "undocumented texi parm: $function: $parm\n"; $show_details = 1; } } Show_details $show_details, $function, "@parms", $docstring; } sub Check_function { my ($function, $funtype, $docstring, @parms) = @_; my %docstring_parm; my %arglist_parm; my $show_details = 0; if (exists $code_funtype{$function}) { print "duplicate codedef: $function @parms\n"; return; # later definition likely bogus package def } $code_funtype{$function} = $funtype; $code_arglist{$function} = "@parms"; #foreach my $parm ($parms =~ /\b[a-z0-9-]{3,}\b/g) { # $arglist_parm{$parm} = 1; #} foreach my $parm (@parms) { next if $parm eq '&optional' || $parm eq '&rest'; $arglist_parm{$parm} = 1; } my $doc_tmp = $docstring; $doc_tmp =~ s/[^A-Za-z0-9_-]/ /g; foreach my $parm (split (' ', $doc_tmp)) { if ($parm =~ /^[A-Z][A-Z0-9-]*$/) { next if $parm =~ /I18N/; next if $parm =~ /M17N/; $parm =~ tr[A-Z][a-z]; $docstring_parm{$parm} = 1; } } # foreach my $parm ($docstring =~ /\b[A-Z0-9-]{1,}\b/g) { # next if $parm =~ /-$/; # $parm =~ tr[A-Z][a-z]; # $docstring_parm{$parm} = 1; # } foreach my $parm (keys %docstring_parm) { next if $parm eq 'tty'; next if $parm eq 'fsf'; next if $parm eq 'note'; next if $parm eq 'warning'; next if $parm eq 'bug'; next if $parm eq 'ascii'; next if $parm eq 'iso'; next if $parm eq 'and'; next if $parm eq 'absolutely'; next if $parm eq 'doc'; next if $parm eq 'user'; next if $parm eq 'not'; next if $parm eq 'must'; next if $parm eq 'nil'; next if $parm eq 'esc'; next if $parm eq 'lfd'; next if $parm eq 'gpm'; next if $parm eq 'primary'; next if $parm eq 'secondary'; next if $parm eq 'clipboard'; next if length $parm < 3; if (! exists $arglist_parm{$parm}) { print "bogus parm: $function: $parm\n"; $show_details = 1; } } foreach my $parm (keys %arglist_parm) { if (! exists $docstring_parm{$parm}) { print "Undocumented parm: $function: $parm\n"; $show_details = 1; } } if ($docstring !~ /[\]}!\)\.]\s*\Z/m && $docstring =~ /\S/ && $docstring !~ /Keywords supported/) { print "Missing trailing period: $function\n"; $show_details = 1; } if (exists $texi_arglist{$function} and "@parms" ne $texi_arglist{$function} and not ("@parms" eq 'int nargs Lisp-Object *args' && $texi_arglist{$function} =~ /&rest/)) { my @texi_parms = split (' ', $texi_arglist{$function}); my @a = ("@parms" =~ /&optional/g); my @b = ("@parms" =~ /&rest/g); my @c = ("@texi_parms" =~ /&optional/g); my @d = ("@texi_parms" =~ /&rest/g); if (@parms != @texi_parms || (@a != @c) || (@b != @d)) { print "serious mismatch: $function: @parms --- @texi_parms\n"; } else { print "texi mismatch: $function: @parms --- $texi_arglist{$function}\n"; } $show_details = 1; } if (exists $texi_funtype{$function} && $texi_funtype{$function} ne $funtype) { print "interactiveness mismatch: $function: $funtype --- $texi_funtype{$function}\n"; $show_details = 1; } Show_details $show_details, $function, "@parms", $docstring; } my $lisprefdir; if (-d "man/lispref") { $lisprefdir = "man/lispref"; } elsif (-d "lispref") { $lisprefdir = "lispref"; } else { die "Can't find lispref texi directory.\n"; } open (FIND, "find $lisprefdir -name '*.texi' -print |") or die; while (my $file = <FIND>) { my @matches = ((FileContents $file) =~ /\@(def(?:fn|un))([^\n]+)\n(.*?)\n\@end def(?:un|fn)/sgo); # /^\@(def(?:un|fn))\s+(.*)\n([.|\n]*?)^\@end def(?:un|fn)\n/mgo); while (@matches) { my ($defform, $defn, $docstring) = splice (@matches, 0, 3); #print "defform = $defform\n"; #print "defn = $defn\n"; #print "docstring = $docstring\n"; my ($function, @parms, $funtype); if ($defform eq 'defun') { ($funtype, $function, @parms) = ('Function', split (' ', $defn)); } else { die unless $defform eq 'deffn'; ($funtype, $function, @parms) = split (' ', $defn); } next if $funtype eq '{Syntax' or $funtype eq '{Prefix'; Check_texi_function $function, $funtype, $docstring, @parms; } } open (FIND, "find src -name '*.c' -print |") or die; while (my $file = <FIND>) { my @matches = ((FileContents $file) =~ /\bDEFUN\s*\(\s*\"((?:[^\\\"]|\\.)+)\"\s*,\s*\S+\s*,\s*(\S+)\s*,\s*(\S+)\s*,\s*((?:0|\"(?:(?:[^\\\"]|\\.)*)\"))\s*,\s*\/\*(.*?)\*\/\s*\(([^()]*)\)\)/sgo); while (@matches) { my ($function, $minargs, $maxargs, $interactive, $docstring, $parms) = splice (@matches, 0, 6); $docstring =~ s/^\n+//s; $docstring =~ s/\n+$//s; $parms =~ s/,/ /g; my @parms = split (' ',$parms); for (@parms) { tr/_/-/; s/-$//; } if ($parms !~ /Lisp_Object/) { if ($minargs < @parms) { if ($maxargs =~ /^\d+$/) { die unless $maxargs eq @parms; splice (@parms, $minargs, 0, '&optional'); } } } my $funtype = ($interactive =~ /\"/ ? 'Command' : 'Function'); Check_function $function, $funtype, $docstring, @parms; } } my @pkgs; if (-d "../xemacs-packages") { @pkgs = qw (libs/edebug libs/xemacs-base comm/eudc oa/edit-utils); } else { @pkgs = (); } for (@pkgs) { s@^@../xemacs-packages/@; } open (FIND, "find lisp @pkgs -name '*.el' -print |") or die; while (my $file = <FIND>) { my $contents = FileContents $file; $contents =~ s/(?:\s|;);.*//mog; my @matches = ($contents =~ /\((def(?:un|subst|macro))\s+(\S+)\s+\(([^()]*)\)\s+\"((?:[^\\\"]|\\.)+)\"(.*?)\)/sgo); while (@matches) { my ($defform, $function, $parms, $docstring, $code_fragment) = splice (@matches, 0, 5); my $funtype = $defform eq 'defmacro' ? 'Macro' : $code_fragment =~ /^\s*\(interactive\b/so ? 'Command' : 'Function'; $docstring =~ s/^\n+//s; $docstring =~ s/\n+$//s; my @parms = split (' ', $parms); Check_function $function, $funtype, $docstring, @parms; } } open (FIND, "find lisp @pkgs -name '*.el' -print |") or die; while (my $file = <FIND>) { my $contents = FileContents $file; $contents =~ s/(?:\s|;);.*//mog; my @matches = ($contents =~ /^\((?:defalias|fset|define-function)\s+\'([A-Za-z0-9_-]+)\s+\'([A-Za-z0-9_-]+)/mog); while (@matches) { my ($alias, $aliasee) = splice (@matches, 0, 2); print "alias $alias aliasee $aliasee\n"; if (exists $code_funtype{$aliasee}) { $code_funtype{$alias} = $code_funtype{$aliasee}; } if (exists $code_arglist{$aliasee}) { $code_arglist{$alias} = $code_arglist{$aliasee}; } } } foreach my $fun (sort keys %texi_funtype) { if (not exists $code_funtype{$fun}) { print "nuke-this-doc: $fun $texi_funtype{$fun}\n"; } } # arch-tag: e75331f5-5d1b-4393-ad5b-b0f87b5d47b0