[perl5.git] / emacs / ptags

# Make a TAGS file for emacs ``M-x find-tag'' from all <c,h,y,xs> source files.
# (``make realclean'' first to avoid generated files, or ``make'' first
# to get tags from all files.)
#
# (IZ: to be a happier jumper: install 'imenu-go.el' from
#      ftp://ftp.math.ohio-state.edu/pub/users/ilya/emacs.)
#
# (Some tags should probably live in their own subdirs, like those in x2p/,
# but I have never been interested in x2p anyway.)
#
# Hallvard B Furuseth <h.b.furuseth@usit.uio.no>, Aug -96.
#
# Ilya Zakharevich, Oct 97: minor comments, add CPerl scan;
#   Use Hallvard's scan for XS files - since he processes the "C" part too -
#   but with a lot of improvements: now it is no worse than CPerl's one.

# Avoid builtin on OS/2:
if test ! -z "$OS2_SHELL"; then alias find=gnufind; fi

# Insure proper order (.h after .c, .xs before .c in subdirs):
# Move autogenerated less-informative files to the end:
# Hard to do embed.h and embedvar.h in one sweep:

topfiles="`echo ' ' *.y *.c *.h ' ' | sed 's/ /  /g' | sed 's/ embedvar\.h\|embed\.h\|perlapi\.h\|\(globals\|perlapi\)\.c / /g'`"
subdirs="`find ./* -maxdepth 0 -type d`"
subdirfiles="`find $subdirs -name '*.[cy]' -print | sort`"
subdirfiles1="`find $subdirs -name '*.[hH]' -print | sort`"
xsfiles="`find . -name '*.xs' -print | sort`"

# etags -d : process defines too (default now)

# These are example lines for global variables and PP-code:
## IEXT SV *       Iparsehook;
## IEXT char *     Isplitstr IINIT(" ");
## dEXTCONST char rcsid[] = "perl.c\nPatch level: ###\n";
## PP(pp_const)
## PERLVARI(Grsfp, PerlIO *, Nullfp)
## PERLVAR(cvcache,      HV *)

# Putting PL_\1 in the substitution line makes etags dump core
# Thus we do it later (but 20.2.92 does it OK).
set x	-d -l c \
	-r '/[dI]?EXT\(CONST\)?[ \t*]+\([a-zA-Z_0-9]+[ \t*]+\)*\([a-zA-Z_0-9]+\)[ \t]*\($\|;\|\[\|[ \t]I+NIT[ \t]*(\|\/\*\)/\3/' \
	-r '/IEXT[ \t][^\/]*[ \t*]I\([a-zA-Z_][a-zA-Z_0-9]*\)[\[; \t]/\1/'  \
	-r '/PERLVAR[a-zA-Z_0-9]*[ \t]*([ \t]*[GIT]?\([a-zA-Z_][a-zA-Z_0-9]*\)[ \t]*[\[,]/\1/'  \
	-r '/PP[ \t]*([ \t]*\([^ \t()]*\)[ \t]*)/\1/'

shift

rm -f TAGS.tmp TAGS.tm2

# Process lines like this: #define MEM_ALIGNBYTES $alignbytes      /**/
etags -o TAGS.tmp \
	-l none -r '/#\(\$[a-zA-Z_0-9]+\|define\)[ \t]+\([a-zA-Z_0-9]+\)/\2/' \
	config_h.SH
# Process lines like this: Mcc (Loc.U):
etags -o TAGS.tmp -a \
	-l none -r '/^\([a-zA-Z_0-9]+\)[ \t]+(/\$\1/' \
		-r '/^\([a-zA-Z_0-9]+\)[ \t]+(/\1/' Porting/Glossary

etags -o TAGS.tmp -a "$@" $topfiles

# Now add these PL_:
perl -w014pe 'if (s/^( .* PERLVAR A?I?	# 1:   TAG group
		       \s* \( \s* [GIT] #
		       .*		#
		     \x7F		#      End of description
		     ) 
		     ( .* \x01 )	# 2:   Exact group
		   /${1}PL_$2/mgx) {	# Add PL_
		  $chars = chomp;
		  s/^((\n.+,)\d+)/ $2 . (length($_) - length($1) - 1) /e;
		  $_ .= ("\f" x $chars);
	      }' TAGS.tmp > TAGS.tm1 && mv TAGS.tm1 TAGS.tmp


# Now remove these Perl_, add empty- and perl_-flavors:
perl -w014pe 'if (s/^(Perl_		# 1:   First group
		       (\w+) \(		# 2:   Stripped name
		       \x7F		#      End of description
		     )			#      End of description
		     (\d+,\d+\n)	# 3:   TAGS Trail
		   /$1$3$1$2\x01$3$1perl_$2\x01$3/mgx) {	# Repeat, add empty and perl_ flavors
		  $chars = chomp;
		  s/^((\n.+,)\d+)/ $2 . (length($_) - length($1) - 1) /e;
		  $_ .= ("\f" x $chars);
	      }' TAGS.tmp > TAGS.tm1 && mv TAGS.tm1 TAGS.tmp

# Now remove these S_, add empty-flavor:
perl -w014pe 'if (s/^(S_		# 1:   First group
		       (\w+) \(		# 2:   Stripped name
		       \x7F		#      End of description
		     )			#      End of description
		     (\d+,\d+\n)	# 3:   TAGS Trail
		   /$1$3$1$2\x01$3/mgx) {	# Repeat, add empty_ flavor
		  $chars = chomp;
		  s/^((\n.+,)\d+)/ $2 . (length($_) - length($1) - 1) /e;
		  $_ .= ("\f" x $chars);
	      }' TAGS.tmp > TAGS.tm1 && mv TAGS.tm1 TAGS.tmp

etags -o TAGS.tmp -a -D -l none -r '/#define.*\t\(Perl_.*\)/\1/' embed.h
etags -o TAGS.tmp -a globals.c embedvar.h perlapi.c perlapi.h

# The above processes created a lot of descriptions with an
# an explicitly specified tag.  Such descriptions have higher
# precedence than descriptions without an explicitely specified tag.
# To restore the justice, make all the descriptions explicit.
perl -w014pe 'if (s/^( [^\n\x7F\x01]*\b	# 1:   TAG group
	               (\w+)		#   2: word
		       [^\w\x7F\x01\n]*	#      Most anything
		       \x7F		#      End of description
		     )
		     (\d+,\d+\n)	# 3:   TAGS Trail
		   /$1$2\x01$3/mgx) {	# Add specific marking
		  $chars = chomp;
		  s/^((\n.+,)\d+)/ $2 . (length($_) - length($1) - 1) /e;
		  $_ .= ("\f" x $chars);
	      }' TAGS.tmp > TAGS.tm1 && mv TAGS.tm1 TAGS.tmp

# Add MODULE lines to TAG files (to be postprocessed later),
#   and BOOT: lines (in DynaLoader processed twice?)

# This skips too many XSUBs:

# etags -o TAGS.tmp -a -d -l c \
# 	-r '/MODULE[ \t=]+\(.*PACKAGE[ \t]*=[ \t]*\)?\([^ \t]+\)\([ \t]*PREFIX[ \t]*=[ \t]*\([^ \t]+\)\)?/\2/' \
# 	-r '/[ \t]*BOOT:/' \
# 	$xsfiles

etags -o TAGS.tmp -a -d -l c \
	-r '/MODULE[ \t=]+\(.*PACKAGE[ \t]*=[ \t]*\)?\([^ \t]+\)\([ \t]*PREFIX[ \t]*=[ \t]*\([^ \t]+\)\)?/\2/' \
	-r '/[ \t]*BOOT:/' \
	-r '/\([_a-zA-Z][a-zA-Z0-9_:]*\)(/' \
	$xsfiles

#	-r '/MODULE[ \t=]+\(.*PACKAGE[ \t]*=[ \t]*\)?\([^ \t]+\)/\2/' \
#	-r '/MODULE.*PREFIX[ \t]*=[ \t]*\([^ \t]+\)/\1/'	\
#	$xsfiles

etags -o TAGS.tmp -a "$@" $subdirfiles
etags -o TAGS.tmp -a "$@" $subdirfiles1

if test ! -f emacs/cperl-mode.elc ; then
    ( cd emacs; emacs -batch -q -no-site-file -f batch-byte-compile cperl-mode.el )
fi

# This should work with newer Emaxen

cp TAGS.tmp TAGS
if emacs -batch -q -no-site-file -l emacs/cperl-mode.elc -f cperl-add-tags-recurse-noxs ; then
    mv TAGS TAGS.tmp
fi

perl -w014pe '
    $update  = s/^PP\(\177\d+,\d+\n//gm;
    $update += s/^(I?EXT.*[ \t])IINIT[ \t]*\((\177)/$1$2/gm;
    if (/^\n*[^\s,]+\.xs,/s) {
	$mod = $cmod = $bmod = $pref = "";
	s/^(.*\n)\1+/$1/mg;			# Remove duplicate lines
	$_ = join("", map {
	    if (/^MODULE[ \t]*=[ \t]*(\S+)(?:[ \t]+PACKAGE[ \t]*=[ \t]*(\S+))?[ \t\177]/m) {
		$mod = $+;
		($bmod = $mod) =~ tr/:/_/;
		$cmod = "XS_${bmod}_";
		$pref = "";
		if (s/[ \t]+PREFIX[ \t]*=[ \t]*([^\s\177]+)(\177)/$+/) {
		    $pref = $1;
		    $pref =~ s/([^\w\s])/\\$1/g;
		    $pref = "(?:$pref)?";
		}
	    } elsif ($mod ne "") {
		# Ref points for Module::subr, XS_Module_subr, subr
		s/^($pref(\w+)[ \t()]*\177)(\d+,\d+)$/$1${mod}::${2}\01$3\n$1$2\01$3\n$1$cmod$2\01$3/gm;
		# Ref for Module::bootstrap bootstrap boot_Module
		s/^([ \t]*BOOT:\177)(\d+,\d+)$/$1${mod}::bootstrap\01$2\n${1}bootstrap\01$2\n${1}boot_$bmod\01$2/gm;
	    }
	    $_;
	} split(/(\nMODULE[ \t]*=[^\n\177]+\177)/));

	$update = 1;
    }
    if ($update) {
	$chars = chomp;
	s/^((\n.+,)\d+)/ $2 . (length($_) - length($1) - 1) /e;
	$_ .= ("\f" x $chars);
    }' TAGS.tmp > TAGS.tm2

rm -f TAGS
mv TAGS.tm2 TAGS
rm -f TAGS.tmp
Commit	Line	Data
3ee700d1 IZ	1	# Make a TAGS file for emacs ``M-x find-tag'' from all <c,h,y,xs> source files.
	2	# (``make realclean'' first to avoid generated files, or ``make'' first
	3	# to get tags from all files.)
	4	#
	5	# (IZ: to be a happier jumper: install 'imenu-go.el' from
	6	# ftp://ftp.math.ohio-state.edu/pub/users/ilya/emacs.)
	7	#
	8	# (Some tags should probably live in their own subdirs, like those in x2p/,
	9	# but I have never been interested in x2p anyway.)
	10	#
	11	# Hallvard B Furuseth <h.b.furuseth@usit.uio.no>, Aug -96.
	12	#
	13	# Ilya Zakharevich, Oct 97: minor comments, add CPerl scan;
	14	# Use Hallvard's scan for XS files - since he processes the "C" part too -
	15	# but with a lot of improvements: now it is no worse than CPerl's one.
	16
777e9161	17	# Avoid builtin on OS/2:
3ee700d1 IZ	18	if test ! -z "$OS2_SHELL"; then alias find=gnufind; fi
	19
	20	# Insure proper order (.h after .c, .xs before .c in subdirs):
777e9161 IZ	21	# Move autogenerated less-informative files to the end:
	22	# Hard to do embed.h and embedvar.h in one sweep:
	23
acfe0abc	24	topfiles="`echo ' ' .y .c *.h ' ' \| sed 's/ / /g' \| sed 's/ embedvar\.h\\|embed\.h\\|perlapi\.h\\|\(globals\\|perlapi\)\.c / /g'`"
3625ddea IZ	25	subdirs="`find ./* -maxdepth 0 -type d`"
	26	subdirfiles="`find $subdirs -name '*.[cy]' -print \| sort`"
	27	subdirfiles1="`find $subdirs -name '*.[hH]' -print \| sort`"
3ee700d1 IZ	28	xsfiles="`find . -name '*.xs' -print \| sort`"
3ee700d1 IZ	29
777e9161	30	# etags -d : process defines too (default now)
3ee700d1 IZ	31
	32	# These are example lines for global variables and PP-code:
	33	## IEXT SV * Iparsehook;
	34	## IEXT char * Isplitstr IINIT(" ");
	35	## dEXTCONST char rcsid[] = "perl.c\nPatch level: ###\n";
	36	## PP(pp_const)
3aefca04 IZ	37	## PERLVARI(Grsfp, PerlIO *, Nullfp)
3aefca04 IZ	38	## PERLVAR(cvcache, HV *)
3ee700d1	39
777e9161 IZ	40	# Putting PL_\1 in the substitution line makes etags dump core
777e9161 IZ	41	# Thus we do it later (but 20.2.92 does it OK).
3ee700d1 IZ	42	set x -d -l c \
	43	-r '/[dI]?EXT\(CONST\)?[ \t]+\([a-zA-Z_0-9]+[ \t]+\)\([a-zA-Z_0-9]+\)[ \t]\($\\|;\\|\[\\|[ \t]I+NIT[ \t](\\|\/\\)/\3/' \
	44	-r '/IEXT[ \t][^\/][ \t]I\([a-zA-Z_][a-zA-Z_0-9]*\)[\[; \t]/\1/' \
777e9161	45	-r '/PERLVAR[a-zA-Z_0-9][ \t]([ \t][GIT]?\([a-zA-Z_][a-zA-Z_0-9]\)[ \t]*[\[,]/\1/' \
3ee700d1 IZ	46	-r '/PP[ \t]([ \t]\([^ \t()]\)[ \t])/\1/'
	47
	48	shift
	49
	50	rm -f TAGS.tmp TAGS.tm2
	51
	52	# Process lines like this: #define MEM_ALIGNBYTES $alignbytes /**/
	53	etags -o TAGS.tmp \
	54	-l none -r '/#\(\$[a-zA-Z_0-9]+\\|define\)[ \t]+\([a-zA-Z_0-9]+\)/\2/' \
	55	config_h.SH
3625ddea IZ	56	# Process lines like this: Mcc (Loc.U):
	57	etags -o TAGS.tmp -a \
	58	-l none -r '/^\([a-zA-Z_0-9]+\)[ \t]+(/\$\1/' \
	59	-r '/^\([a-zA-Z_0-9]+\)[ \t]+(/\1/' Porting/Glossary
	60
3ee700d1	61	etags -o TAGS.tmp -a "$@" $topfiles
777e9161 IZ	62
777e9161 IZ	63	# Now add these PL_:
51371543	64	perl -w014pe 'if (s/^( .* PERLVAR A?I? # 1: TAG group
777e9161 IZ	65	\s* \( \s* [GIT] #
	66	.* #
	67	\x7F # End of description
	68	)
3625ddea	69	( .* \x01 ) # 2: Exact group
777e9161 IZ	70	/${1}PL_$2/mgx) { # Add PL_
	71	$chars = chomp;
	72	s/^((\n.+,)\d+)/ $2 . (length($_) - length($1) - 1) /e;
	73	$_ .= ("\f" x $chars);
	74	}' TAGS.tmp > TAGS.tm1 && mv TAGS.tm1 TAGS.tmp
	75
	76
0c9e4c8c GS	77	# Now remove these Perl_, add empty- and perl_-flavors:
	78	perl -w014pe 'if (s/^(Perl_ # 1: First group
	79	(\w+) \( # 2: Stripped name
	80	\x7F # End of description
	81	) # End of description
	82	(\d+,\d+\n) # 3: TAGS Trail
	83	/$1$3$1$2\x01$3$1perl_$2\x01$3/mgx) { # Repeat, add empty and perl_ flavors
	84	$chars = chomp;
	85	s/^((\n.+,)\d+)/ $2 . (length($_) - length($1) - 1) /e;
	86	$_ .= ("\f" x $chars);
	87	}' TAGS.tmp > TAGS.tm1 && mv TAGS.tm1 TAGS.tmp
	88
	89	# Now remove these S_, add empty-flavor:
	90	perl -w014pe 'if (s/^(S_ # 1: First group
	91	(\w+) \( # 2: Stripped name
	92	\x7F # End of description
	93	) # End of description
	94	(\d+,\d+\n) # 3: TAGS Trail
	95	/$1$3$1$2\x01$3/mgx) { # Repeat, add empty_ flavor
	96	$chars = chomp;
	97	s/^((\n.+,)\d+)/ $2 . (length($_) - length($1) - 1) /e;
	98	$_ .= ("\f" x $chars);
	99	}' TAGS.tmp > TAGS.tm1 && mv TAGS.tm1 TAGS.tmp
777e9161	100
3ee700d1	101	etags -o TAGS.tmp -a -D -l none -r '/#define.\t\(Perl_.\)/\1/' embed.h
acfe0abc	102	etags -o TAGS.tmp -a globals.c embedvar.h perlapi.c perlapi.h
3ee700d1	103
0c9e4c8c GS	104	# The above processes created a lot of descriptions with an
	105	# an explicitly specified tag. Such descriptions have higher
	106	# precedence than descriptions without an explicitely specified tag.
	107	# To restore the justice, make all the descriptions explicit.
3625ddea	108	perl -w014pe 'if (s/^( [^\n\x7F\x01]*\b # 1: TAG group
79e58eb3	109	(\w+) # 2: word
3625ddea	110	[^\w\x7F\x01\n]* # Most anything
79e58eb3 IZ	111	\x7F # End of description
	112	)
	113	(\d+,\d+\n) # 3: TAGS Trail
3625ddea	114	/$1$2\x01$3/mgx) { # Add specific marking
79e58eb3 IZ	115	$chars = chomp;
	116	s/^((\n.+,)\d+)/ $2 . (length($_) - length($1) - 1) /e;
	117	$_ .= ("\f" x $chars);
	118	}' TAGS.tmp > TAGS.tm1 && mv TAGS.tm1 TAGS.tmp
	119
3ee700d1 IZ	120	# Add MODULE lines to TAG files (to be postprocessed later),
	121	# and BOOT: lines (in DynaLoader processed twice?)
	122
	123	# This skips too many XSUBs:
	124
	125	# etags -o TAGS.tmp -a -d -l c \
	126	# -r '/MODULE[ \t=]+\(.PACKAGE[ \t]=[ \t]\)?\([^ \t]+\)\([ \t]PREFIX[ \t]=[ \t]\([^ \t]+\)\)?/\2/' \
	127	# -r '/[ \t]*BOOT:/' \
	128	# $xsfiles
	129
	130	etags -o TAGS.tmp -a -d -l c \
	131	-r '/MODULE[ \t=]+\(.PACKAGE[ \t]=[ \t]\)?\([^ \t]+\)\([ \t]PREFIX[ \t]=[ \t]\([^ \t]+\)\)?/\2/' \
	132	-r '/[ \t]*BOOT:/' \
	133	-r '/\([_a-zA-Z][a-zA-Z0-9_:]*\)(/' \
	134	$xsfiles
	135
	136	# -r '/MODULE[ \t=]+\(.PACKAGE[ \t]=[ \t]*\)?\([^ \t]+\)/\2/' \
	137	# -r '/MODULE.PREFIX[ \t]=[ \t]*\([^ \t]+\)/\1/' \
	138	# $xsfiles
	139
	140	etags -o TAGS.tmp -a "$@" $subdirfiles
3625ddea	141	etags -o TAGS.tmp -a "$@" $subdirfiles1
3ee700d1	142
79e58eb3	143	if test ! -f emacs/cperl-mode.elc ; then
3ee700d1 IZ	144	( cd emacs; emacs -batch -q -no-site-file -f batch-byte-compile cperl-mode.el )
	145	fi
	146
	147	# This should work with newer Emaxen
	148
	149	cp TAGS.tmp TAGS
	150	if emacs -batch -q -no-site-file -l emacs/cperl-mode.elc -f cperl-add-tags-recurse-noxs ; then
	151	mv TAGS TAGS.tmp
	152	fi
	153
	154	perl -w014pe '
	155	$update = s/^PP\(\177\d+,\d+\n//gm;
	156	$update += s/^(I?EXT.[ \t])IINIT[ \t]\((\177)/$1$2/gm;
	157	if (/^\n*[^\s,]+\.xs,/s) {
	158	$mod = $cmod = $bmod = $pref = "";
	159	s/^(.*\n)\1+/$1/mg; # Remove duplicate lines
	160	$_ = join("", map {
	161	if (/^MODULE[ \t]=[ \t](\S+)(?:[ \t]+PACKAGE[ \t]=[ \t](\S+))?[ \t\177]/m) {
	162	$mod = $+;
	163	($bmod = $mod) =~ tr/:/_/;
	164	$cmod = "XS_${bmod}_";
	165	$pref = "";
	166	if (s/[ \t]+PREFIX[ \t]=[ \t]([^\s\177]+)(\177)/$+/) {
	167	$pref = $1;
	168	$pref =~ s/([^\w\s])/\\$1/g;
	169	$pref = "(?:$pref)?";
	170	}
	171	} elsif ($mod ne "") {
	172	# Ref points for Module::subr, XS_Module_subr, subr
	173	s/^($pref(\w+)[ \t()]*\177)(\d+,\d+)$/$1${mod}::${2}\01$3\n$1$2\01$3\n$1$cmod$2\01$3/gm;
	174	# Ref for Module::bootstrap bootstrap boot_Module
	175	s/^([ \t]*BOOT:\177)(\d+,\d+)$/$1${mod}::bootstrap\01$2\n${1}bootstrap\01$2\n${1}boot_$bmod\01$2/gm;
	176	}
	177	$_;
	178	} split(/(\nMODULE[ \t]*=[^\n\177]+\177)/));
	179
	180	$update = 1;
	181	}
	182	if ($update) {
	183	$chars = chomp;
	184	s/^((\n.+,)\d+)/ $2 . (length($_) - length($1) - 1) /e;
	185	$_ .= ("\f" x $chars);
	186	}' TAGS.tmp > TAGS.tm2
	187
	188	rm -f TAGS
	189	mv TAGS.tm2 TAGS
	190	rm -f TAGS.tmp
	191
	192
	193