[linux-block.git] / scripts / get_abi.pl

#!/usr/bin/perl
# SPDX-License-Identifier: GPL-2.0

use strict;
use Pod::Usage;
use Getopt::Long;
use File::Find;
use Fcntl ':mode';

my $help;
my $man;
my $debug;
my $prefix="Documentation/ABI";

#
# If true, assumes that the description is formatted with ReST
#
my $description_is_rst = 0;

GetOptions(
	"debug|d+" => \$debug,
	"rst-source!" => \$description_is_rst,
	"dir=s" => \$prefix,
	'help|?' => \$help,
	man => \$man
) or pod2usage(2);

pod2usage(1) if $help;
pod2usage(-exitstatus => 0, -verbose => 2) if $man;

pod2usage(2) if (scalar @ARGV < 1 || @ARGV > 2);

my ($cmd, $arg) = @ARGV;

pod2usage(2) if ($cmd ne "search" && $cmd ne "rest" && $cmd ne "validate");
pod2usage(2) if ($cmd eq "search" && !$arg);

require Data::Dumper if ($debug);

my %data;

#
# Displays an error message, printing file name and line
#
sub parse_error($$$$) {
	my ($file, $ln, $msg, $data) = @_;

	print STDERR "file $file#$ln: $msg at\n\t$data";
}

#
# Parse an ABI file, storing its contents at %data
#
sub parse_abi {
	my $file = $File::Find::name;

	my $mode = (stat($file))[2];
	return if ($mode & S_IFDIR);
	return if ($file =~ m,/README,);

	my $name = $file;
	$name =~ s,.*/,,;

	my $nametag = "File $name";
	$data{$nametag}->{what} = "File $name";
	$data{$nametag}->{type} = "File";
	$data{$nametag}->{file} = $name;
	$data{$nametag}->{filepath} = $file;
	$data{$nametag}->{is_file} = 1;

	my $type = $file;
	$type =~ s,.*/(.*)/.*,$1,;

	my $what;
	my $new_what;
	my $tag;
	my $ln;
	my $xrefs;
	my $space;
	my @labels;
	my $label;

	print STDERR "Opening $file\n" if ($debug > 1);
	open IN, $file;
	while(<IN>) {
		$ln++;
		if (m/^(\S+)(:\s*)(.*)/i) {
			my $new_tag = lc($1);
			my $sep = $2;
			my $content = $3;

			if (!($new_tag =~ m/(what|where|date|kernelversion|contact|description|users)/)) {
				if ($tag eq "description") {
					# New "tag" is actually part of
					# description. Don't consider it a tag
					$new_tag = "";
				} elsif ($tag ne "") {
					parse_error($file, $ln, "tag '$tag' is invalid", $_);
				}
			}

			# Invalid, but it is a common mistake
			if ($new_tag eq "where") {
				parse_error($file, $ln, "tag 'Where' is invalid. Should be 'What:' instead", $_);
				$new_tag = "what";
			}

			if ($new_tag =~ m/what/) {
				$space = "";
				if ($tag =~ m/what/) {
					$what .= ", " . $content;
				} else {
					parse_error($file, $ln, "What '$what' doesn't have a description", "") if ($what && !$data{$what}->{description});

					$what = $content;
					$label = $content;
					$new_what = 1;
				}
				push @labels, [($content, $label)];
				$tag = $new_tag;

				push @{$data{$nametag}->{xrefs}}, [($content, $label)] if ($data{$nametag}->{what});
				next;
			}

			if ($tag ne "" && $new_tag) {
				$tag = $new_tag;

				if ($new_what) {
					@{$data{$what}->{label}} = @labels if ($data{$nametag}->{what});
					@labels = ();
					$label = "";
					$new_what = 0;

					$data{$what}->{type} = $type;
					$data{$what}->{file} = $name;
					$data{$what}->{filepath} = $file;
					print STDERR "\twhat: $what\n" if ($debug > 1);
				}

				if (!$what) {
					parse_error($file, $ln, "'What:' should come first:", $_);
					next;
				}
				if ($tag eq "description") {
					# Preserve initial spaces for the first line
					$content = ' ' x length($new_tag) . $sep . $content;
					$content =~ s,^(\s*):,$1 ,;
					if ($content =~ m/^(\s*)(.*)$/) {
						$space = $1;
						$content = $2;
					}
					while ($space =~ s/\t+/' ' x (length($&) * 8 - length($`) % 8)/e) {}
					$data{$what}->{$tag} .= $content;
				} else {
					$data{$what}->{$tag} = $content;
				}
				next;
			}
		}

		# Store any contents before tags at the database
		if (!$tag && $data{$nametag}->{what}) {
			$data{$nametag}->{description} .= $_;
			next;
		}

		if ($tag eq "description") {
			if (!$data{$what}->{description}) {
				s/^($space)//;
				if (m/^(\s*)(.*)/) {
					my $sp = $1;
					while ($sp =~ s/\t+/' ' x (length($&) * 8 - length($`) % 8)/e) {}
					my $content = "$sp$2";

					$content =~ s/^($space)//;

					$data{$what}->{$tag} .= "$content";
				}
			} else {
				my $content = $_;
				if (m/^\s*\n/) {
					$data{$what}->{$tag} .= $content;
					next;
				}

				while ($content =~ s/\t+/' ' x (length($&) * 8 - length($`) % 8)/e) {}
				$space = "" if (!($content =~ s/^($space)//));

				# Compress spaces with tabs
				$content =~ s<^ {8}> <\t>;
				$content =~ s<^ {1,7}\t> <\t>;
				$content =~ s< {1,7}\t> <\t>;
				$data{$what}->{$tag} .= $content;
			}
			next;
		}
		if (m/^\s*(.*)/) {
			$data{$what}->{$tag} .= "\n$1";
			$data{$what}->{$tag} =~ s/\n+$//;
			next;
		}

		# Everything else is error
		parse_error($file, $ln, "Unexpected line:", $_);
	}
	$data{$nametag}->{description} =~ s/^\n+//;
	close IN;
}

#
# Outputs the book on ReST format
#

my %labels;

sub output_rest {
	foreach my $what (sort {
				($data{$a}->{type} eq "File") cmp ($data{$b}->{type} eq "File") ||
				$a cmp $b
			       } keys %data) {
		my $type = $data{$what}->{type};
		my $file = $data{$what}->{file};
		my $filepath = $data{$what}->{filepath};

		my $w = $what;
		$w =~ s/([\(\)\_\-\*\=\^\~\\])/\\$1/g;


		foreach my $p (@{$data{$what}->{label}}) {
			my ($content, $label) = @{$p};
			$label = "abi_" . $label . " ";
			$label =~ tr/A-Z/a-z/;

			# Convert special chars to "_"
			$label =~s/([\x00-\x2f\x3a-\x40\x5b-\x60\x7b-\xff])/_/g;
			$label =~ s,_+,_,g;
			$label =~ s,_$,,;

			# Avoid duplicated labels
			while (defined($labels{$label})) {
			    my @chars = ("A".."Z", "a".."z");
			    $label .= $chars[rand @chars];
			}
			$labels{$label} = 1;

			$data{$what}->{label} .= $label;

			printf ".. _%s:\n\n", $label;

			# only one label is enough
			last;
		}


		$filepath =~ s,.*/(.*/.*),\1,;;
		$filepath =~ s,[/\-],_,g;;
		my $fileref = "abi_file_".$filepath;

		if ($type eq "File") {
			my $bar = $w;
			$bar =~ s/./-/g;

			print ".. _$fileref:\n\n";
			print "$w\n$bar\n\n";
		} else {
			my @names = split /\s*,\s*/,$w;

			my $len = 0;

			foreach my $name (@names) {
				$len = length($name) if (length($name) > $len);
			}

			print "What:\n\n";

			print "+-" . "-" x $len . "-+\n";
			foreach my $name (@names) {
				printf "| %s", $name . " " x ($len - length($name)) . " |\n";
				print "+-" . "-" x $len . "-+\n";
			}
			print "\n";
		}

		print "Defined on file :ref:`$file <$fileref>`\n\n" if ($type ne "File");

		my $desc = $data{$what}->{description};

		if (!($desc =~ /^\s*$/)) {
			if ($description_is_rst) {
				print "$desc\n\n";
			} else {
				$desc =~ s/^\s+//;

				# Remove title markups from the description, as they won't work
				$desc =~ s/\n[\-\*\=\^\~]+\n/\n\n/g;

				if ($desc =~ m/\:\n/ || $desc =~ m/\n[\t ]+/  || $desc =~ m/[\x00-\x08\x0b-\x1f\x7b-\xff]/) {
					# put everything inside a code block
					$desc =~ s/\n/\n /g;

					print "::\n\n";
					print " $desc\n\n";
				} else {
					# Escape any special chars from description
					$desc =~s/([\x00-\x08\x0b-\x1f\x21-\x2a\x2d\x2f\x3c-\x40\x5c\x5e-\x60\x7b-\xff])/\\$1/g;
					print "$desc\n\n";
				}
			}
		} else {
			print "DESCRIPTION MISSING for $what\n\n" if (!$data{$what}->{is_file});
		}

		if ($data{$what}->{xrefs}) {
			printf "Has the following ABI:\n\n";

			foreach my $p(@{$data{$what}->{xrefs}}) {
				my ($content, $label) = @{$p};
				$label = "abi_" . $label . " ";
				$label =~ tr/A-Z/a-z/;

				# Convert special chars to "_"
				$label =~s/([\x00-\x2f\x3a-\x40\x5b-\x60\x7b-\xff])/_/g;
				$label =~ s,_+,_,g;
				$label =~ s,_$,,;

				# Escape special chars from content
				$content =~s/([\x00-\x1f\x21-\x2f\x3a-\x40\x7b-\xff])/\\$1/g;

				print "- :ref:`$content <$label>`\n\n";
			}
		}
	}
}

#
# Searches for ABI symbols
#
sub search_symbols {
	foreach my $what (sort keys %data) {
		next if (!($what =~ m/($arg)/));

		my $type = $data{$what}->{type};
		next if ($type eq "File");

		my $file = $data{$what}->{filepath};

		my $bar = $what;
		$bar =~ s/./-/g;

		print "\n$what\n$bar\n\n";

		my $kernelversion = $data{$what}->{kernelversion};
		my $contact = $data{$what}->{contact};
		my $users = $data{$what}->{users};
		my $date = $data{$what}->{date};
		my $desc = $data{$what}->{description};
		$kernelversion =~ s/^\s+//;
		$contact =~ s/^\s+//;
		$users =~ s/^\s+//;
		$users =~ s/\n//g;
		$date =~ s/^\s+//;
		$desc =~ s/^\s+//;

		printf "Kernel version:\t\t%s\n", $kernelversion if ($kernelversion);
		printf "Date:\t\t\t%s\n", $date if ($date);
		printf "Contact:\t\t%s\n", $contact if ($contact);
		printf "Users:\t\t\t%s\n", $users if ($users);
		print "Defined on file:\t$file\n\n";
		print "Description:\n\n$desc";
	}
}


#
# Parses all ABI files located at $prefix dir
#
find({wanted =>\&parse_abi, no_chdir => 1}, $prefix);

print STDERR Data::Dumper->Dump([\%data], [qw(*data)]) if ($debug);

#
# Handles the command
#
if ($cmd eq "rest") {
	output_rest;
} elsif ($cmd eq "search") {
	search_symbols;
}


__END__

=head1 NAME

abi_book.pl - parse the Linux ABI files and produce a ReST book.

=head1 SYNOPSIS

B<abi_book.pl> [--debug] [--man] [--help] --[(no-)rst-source] [--dir=<dir>] <COMAND> [<ARGUMENT>]

Where <COMMAND> can be:

=over 8

B<search> [SEARCH_REGEX] - search for [SEARCH_REGEX] inside ABI

B<rest>                  - output the ABI in ReST markup language

B<validate>              - validate the ABI contents

=back

=head1 OPTIONS

=over 8

=item B<--dir>

Changes the location of the ABI search. By default, it uses
the Documentation/ABI directory.

=item B<--rst-source> and B<--no-rst-source>

The input file may be using ReST syntax or not. Those two options allow
selecting between a rst-compliant source ABI (--rst-source), or a
plain text that may be violating ReST spec, so it requres some escaping
logic (--no-rst-source).

=item B<--debug>

Put the script in verbose mode, useful for debugging. Can be called multiple
times, to increase verbosity.

=item B<--help>

Prints a brief help message and exits.

=item B<--man>

Prints the manual page and exits.

=back

=head1 DESCRIPTION

Parse the Linux ABI files from ABI DIR (usually located at Documentation/ABI),
allowing to search for ABI symbols or to produce a ReST book containing
the Linux ABI documentation.

=head1 EXAMPLES

Search for all stable symbols with the word "usb":

=over 8

$ scripts/get_abi.pl search usb --dir Documentation/ABI/stable

=back

Search for all symbols that match the regex expression "usb.*cap":

=over 8

$ scripts/get_abi.pl search usb.*cap

=back

Output all obsoleted symbols in ReST format

=over 8

$ scripts/get_abi.pl rest --dir Documentation/ABI/obsolete

=back

=head1 BUGS

Report bugs to Mauro Carvalho Chehab <mchehab+samsung@kernel.org>

=head1 COPYRIGHT

Copyright (c) 2016-2019 by Mauro Carvalho Chehab <mchehab+samsung@kernel.org>.

License GPLv2: GNU GPL version 2 <http://gnu.org/licenses/gpl.html>.

This is free software: you are free to change and redistribute it.
There is NO WARRANTY, to the extent permitted by law.

=cut
Commit	Line	Data
bbc249f2	1	#!/usr/bin/perl
ecb351f1	2	# SPDX-License-Identifier: GPL-2.0
bbc249f2 MCC	3
	4	use strict;
	5	use Pod::Usage;
	6	use Getopt::Long;
	7	use File::Find;
	8	use Fcntl ':mode';
	9
	10	my $help;
	11	my $man;
	12	my $debug;
33e3e991	13	my $prefix="Documentation/ABI";
bbc249f2	14
11ce90a4 MCC	15	#
	16	# If true, assumes that the description is formatted with ReST
	17	#
	18	my $description_is_rst = 0;
	19
bbc249f2 MCC	20	GetOptions(
bbc249f2 MCC	21	"debug\|d+" => \$debug,
11ce90a4	22	"rst-source!" => \$description_is_rst,
33e3e991	23	"dir=s" => \$prefix,
bbc249f2 MCC	24	'help\|?' => \$help,
	25	man => \$man
	26	) or pod2usage(2);
	27
	28	pod2usage(1) if $help;
	29	pod2usage(-exitstatus => 0, -verbose => 2) if $man;
	30
33e3e991	31	pod2usage(2) if (scalar @ARGV < 1 \|\| @ARGV > 2);
bbc249f2	32
33e3e991 MCC	33	my ($cmd, $arg) = @ARGV;
33e3e991 MCC	34
7ce7b89b	35	pod2usage(2) if ($cmd ne "search" && $cmd ne "rest" && $cmd ne "validate");
33e3e991	36	pod2usage(2) if ($cmd eq "search" && !$arg);
bbc249f2 MCC	37
	38	require Data::Dumper if ($debug);
	39
	40	my %data;
	41
	42	#
	43	# Displays an error message, printing file name and line
	44	#
	45	sub parse_error($$$$) {
	46	my ($file, $ln, $msg, $data) = @_;
	47
	48	print STDERR "file $file#$ln: $msg at\n\t$data";
	49	}
	50
	51	#
	52	# Parse an ABI file, storing its contents at %data
	53	#
	54	sub parse_abi {
	55	my $file = $File::Find::name;
	56
	57	my $mode = (stat($file))[2];
	58	return if ($mode & S_IFDIR);
	59	return if ($file =~ m,/README,);
	60
	61	my $name = $file;
	62	$name =~ s,.*/,,;
	63
d0ebaf51 MCC	64	my $nametag = "File $name";
	65	$data{$nametag}->{what} = "File $name";
	66	$data{$nametag}->{type} = "File";
	67	$data{$nametag}->{file} = $name;
33e3e991	68	$data{$nametag}->{filepath} = $file;
d0ebaf51 MCC	69	$data{$nametag}->{is_file} = 1;
d0ebaf51 MCC	70
bbc249f2 MCC	71	my $type = $file;
	72	$type =~ s,./(.)/.*,$1,;
	73
	74	my $what;
	75	my $new_what;
	76	my $tag;
	77	my $ln;
6619c661	78	my $xrefs;
4e6a6234	79	my $space;
d0ebaf51 MCC	80	my @labels;
d0ebaf51 MCC	81	my $label;
bbc249f2 MCC	82
	83	print STDERR "Opening $file\n" if ($debug > 1);
	84	open IN, $file;
	85	while(<IN>) {
	86	$ln++;
4e6a6234	87	if (m/^(\S+)(:\s)(.)/i) {
bbc249f2	88	my $new_tag = lc($1);
4e6a6234 MCC	89	my $sep = $2;
4e6a6234 MCC	90	my $content = $3;
bbc249f2	91
7ce7b89b	92	if (!($new_tag =~ m/(what\|where\|date\|kernelversion\|contact\|description\|users)/)) {
bbc249f2	93	if ($tag eq "description") {
4e6a6234 MCC	94	# New "tag" is actually part of
	95	# description. Don't consider it a tag
	96	$new_tag = "";
7d7ea8d2	97	} elsif ($tag ne "") {
bbc249f2 MCC	98	parse_error($file, $ln, "tag '$tag' is invalid", $_);
	99	}
	100	}
	101
2c0700e7 MCC	102	# Invalid, but it is a common mistake
	103	if ($new_tag eq "where") {
	104	parse_error($file, $ln, "tag 'Where' is invalid. Should be 'What:' instead", $_);
	105	$new_tag = "what";
	106	}
	107
bbc249f2	108	if ($new_tag =~ m/what/) {
4e6a6234	109	$space = "";
bbc249f2 MCC	110	if ($tag =~ m/what/) {
	111	$what .= ", " . $content;
	112	} else {
4e6a6234 MCC	113	parse_error($file, $ln, "What '$what' doesn't have a description", "") if ($what && !$data{$what}->{description});
4e6a6234 MCC	114
bbc249f2	115	$what = $content;
d0ebaf51	116	$label = $content;
bbc249f2 MCC	117	$new_what = 1;
bbc249f2 MCC	118	}
d0ebaf51	119	push @labels, [($content, $label)];
bbc249f2	120	$tag = $new_tag;
6619c661	121
d0ebaf51	122	push @{$data{$nametag}->{xrefs}}, [($content, $label)] if ($data{$nametag}->{what});
bbc249f2 MCC	123	next;
	124	}
	125
7d7ea8d2	126	if ($tag ne "" && $new_tag) {
4e6a6234	127	$tag = $new_tag;
bbc249f2	128
4e6a6234	129	if ($new_what) {
d0ebaf51 MCC	130	@{$data{$what}->{label}} = @labels if ($data{$nametag}->{what});
	131	@labels = ();
	132	$label = "";
4e6a6234	133	$new_what = 0;
bbc249f2	134
4e6a6234 MCC	135	$data{$what}->{type} = $type;
4e6a6234 MCC	136	$data{$what}->{file} = $name;
33e3e991	137	$data{$what}->{filepath} = $file;
4e6a6234 MCC	138	print STDERR "\twhat: $what\n" if ($debug > 1);
4e6a6234 MCC	139	}
bbc249f2	140
4e6a6234 MCC	141	if (!$what) {
	142	parse_error($file, $ln, "'What:' should come first:", $_);
	143	next;
	144	}
	145	if ($tag eq "description") {
11ce90a4 MCC	146	# Preserve initial spaces for the first line
	147	$content = ' ' x length($new_tag) . $sep . $content;
	148	$content =~ s,^(\s*):,$1 ,;
	149	if ($content =~ m/^(\s)(.)$/) {
	150	$space = $1;
	151	$content = $2;
4e6a6234	152	}
11ce90a4 MCC	153	while ($space =~ s/\t+/' ' x (length($&) * 8 - length($`) % 8)/e) {}
11ce90a4 MCC	154	$data{$what}->{$tag} .= $content;
4e6a6234 MCC	155	} else {
	156	$data{$what}->{$tag} = $content;
	157	}
bbc249f2 MCC	158	next;
bbc249f2 MCC	159	}
bbc249f2 MCC	160	}
bbc249f2 MCC	161
4e6a6234	162	# Store any contents before tags at the database
d0ebaf51 MCC	163	if (!$tag && $data{$nametag}->{what}) {
d0ebaf51 MCC	164	$data{$nametag}->{description} .= $_;
6619c661 MCC	165	next;
6619c661 MCC	166	}
bbc249f2	167
4e6a6234 MCC	168	if ($tag eq "description") {
4e6a6234 MCC	169	if (!$data{$what}->{description}) {
11ce90a4	170	s/^($space)//;
4e6a6234	171	if (m/^(\s)(.)/) {
11ce90a4 MCC	172	my $sp = $1;
	173	while ($sp =~ s/\t+/' ' x (length($&) * 8 - length($`) % 8)/e) {}
	174	my $content = "$sp$2";
	175
	176	$content =~ s/^($space)//;
	177
	178	$data{$what}->{$tag} .= "$content";
4e6a6234 MCC	179	}
	180	} else {
	181	my $content = $_;
	182	if (m/^\s*\n/) {
	183	$data{$what}->{$tag} .= $content;
	184	next;
	185	}
	186
	187	while ($content =~ s/\t+/' ' x (length($&) * 8 - length($`) % 8)/e) {}
	188	$space = "" if (!($content =~ s/^($space)//));
	189
	190	# Compress spaces with tabs
	191	$content =~ s<^ {8}> <\t>;
	192	$content =~ s<^ {1,7}\t> <\t>;
	193	$content =~ s< {1,7}\t> <\t>;
	194	$data{$what}->{$tag} .= $content;
	195	}
	196	next;
	197	}
bbc249f2 MCC	198	if (m/^\s(.)/) {
	199	$data{$what}->{$tag} .= "\n$1";
	200	$data{$what}->{$tag} =~ s/\n+$//;
	201	next;
	202	}
	203
	204	# Everything else is error
	205	parse_error($file, $ln, "Unexpected line:", $_);
	206	}
d0ebaf51	207	$data{$nametag}->{description} =~ s/^\n+//;
bbc249f2 MCC	208	close IN;
	209	}
	210
33e3e991 MCC	211	#
	212	# Outputs the book on ReST format
	213	#
45f96517	214
2e7ce055 MCC	215	my %labels;
2e7ce055 MCC	216
bbc249f2	217	sub output_rest {
45f96517 MCC	218	foreach my $what (sort {
	219	($data{$a}->{type} eq "File") cmp ($data{$b}->{type} eq "File") \|\|
	220	$a cmp $b
	221	} keys %data) {
bbc249f2 MCC	222	my $type = $data{$what}->{type};
bbc249f2 MCC	223	my $file = $data{$what}->{file};
45f96517	224	my $filepath = $data{$what}->{filepath};
bbc249f2 MCC	225
	226	my $w = $what;
	227	$w =~ s/([\(\)\_\-\*\=\^\~\\])/\\$1/g;
	228
4e6a6234	229
d0ebaf51 MCC	230	foreach my $p (@{$data{$what}->{label}}) {
	231	my ($content, $label) = @{$p};
	232	$label = "abi_" . $label . " ";
	233	$label =~ tr/A-Z/a-z/;
	234
	235	# Convert special chars to "_"
	236	$label =~s/([\x00-\x2f\x3a-\x40\x5b-\x60\x7b-\xff])/_/g;
	237	$label =~ s,_+,_,g;
	238	$label =~ s,_$,,;
	239
2e7ce055 MCC	240	# Avoid duplicated labels
	241	while (defined($labels{$label})) {
	242	my @chars = ("A".."Z", "a".."z");
	243	$label .= $chars[rand @chars];
	244	}
	245	$labels{$label} = 1;
	246
d0ebaf51 MCC	247	$data{$what}->{label} .= $label;
	248
	249	printf ".. _%s:\n\n", $label;
	250
	251	# only one label is enough
	252	last;
6619c661 MCC	253	}
6619c661 MCC	254
6619c661	255
45f96517 MCC	256	$filepath =~ s,./(./.*),\1,;;
	257	$filepath =~ s,[/\-],_,g;;
	258	my $fileref = "abi_file_".$filepath;
	259
	260	if ($type eq "File") {
	261	my $bar = $w;
	262	$bar =~ s/./-/g;
	263
	264	print ".. _$fileref:\n\n";
	265	print "$w\n$bar\n\n";
	266	} else {
	267	my @names = split /\s,\s/,$w;
	268
	269	my $len = 0;
	270
	271	foreach my $name (@names) {
	272	$len = length($name) if (length($name) > $len);
	273	}
	274
	275	print "What:\n\n";
	276
	277	print "+-" . "-" x $len . "-+\n";
	278	foreach my $name (@names) {
	279	printf "\| %s", $name . " " x ($len - length($name)) . " \|\n";
	280	print "+-" . "-" x $len . "-+\n";
	281	}
	282	print "\n";
	283	}
	284
	285	print "Defined on file :ref:`$file <$fileref>`\n\n" if ($type ne "File");
bbc249f2 MCC	286
bbc249f2 MCC	287	my $desc = $data{$what}->{description};
bbc249f2	288
4e6a6234	289	if (!($desc =~ /^\s*$/)) {
11ce90a4 MCC	290	if ($description_is_rst) {
11ce90a4 MCC	291	print "$desc\n\n";
4e6a6234	292	} else {
11ce90a4	293	$desc =~ s/^\s+//;
bbc249f2	294
11ce90a4 MCC	295	# Remove title markups from the description, as they won't work
	296	$desc =~ s/\n[\-\*\=\^\~]+\n/\n\n/g;
	297
	298	if ($desc =~ m/\:\n/ \|\| $desc =~ m/\n[\t ]+/ \|\| $desc =~ m/[\x00-\x08\x0b-\x1f\x7b-\xff]/) {
	299	# put everything inside a code block
	300	$desc =~ s/\n/\n /g;
	301
	302	print "::\n\n";
	303	print " $desc\n\n";
	304	} else {
	305	# Escape any special chars from description
	306	$desc =~s/([\x00-\x08\x0b-\x1f\x21-\x2a\x2d\x2f\x3c-\x40\x5c\x5e-\x60\x7b-\xff])/\\$1/g;
	307	print "$desc\n\n";
	308	}
4e6a6234	309	}
bbc249f2	310	} else {
d0ebaf51	311	print "DESCRIPTION MISSING for $what\n\n" if (!$data{$what}->{is_file});
bbc249f2	312	}
6619c661	313
d0ebaf51 MCC	314	if ($data{$what}->{xrefs}) {
	315	printf "Has the following ABI:\n\n";
	316
	317	foreach my $p(@{$data{$what}->{xrefs}}) {
	318	my ($content, $label) = @{$p};
	319	$label = "abi_" . $label . " ";
	320	$label =~ tr/A-Z/a-z/;
	321
	322	# Convert special chars to "_"
	323	$label =~s/([\x00-\x2f\x3a-\x40\x5b-\x60\x7b-\xff])/_/g;
	324	$label =~ s,_+,_,g;
	325	$label =~ s,_$,,;
	326
	327	# Escape special chars from content
	328	$content =~s/([\x00-\x1f\x21-\x2f\x3a-\x40\x7b-\xff])/\\$1/g;
	329
	330	print "- :ref:`$content <$label>`\n\n";
	331	}
	332	}
bbc249f2 MCC	333	}
	334	}
	335
33e3e991 MCC	336	#
	337	# Searches for ABI symbols
	338	#
	339	sub search_symbols {
	340	foreach my $what (sort keys %data) {
	341	next if (!($what =~ m/($arg)/));
	342
	343	my $type = $data{$what}->{type};
	344	next if ($type eq "File");
	345
	346	my $file = $data{$what}->{filepath};
	347
	348	my $bar = $what;
	349	$bar =~ s/./-/g;
	350
	351	print "\n$what\n$bar\n\n";
	352
	353	my $kernelversion = $data{$what}->{kernelversion};
	354	my $contact = $data{$what}->{contact};
	355	my $users = $data{$what}->{users};
	356	my $date = $data{$what}->{date};
	357	my $desc = $data{$what}->{description};
	358	$kernelversion =~ s/^\s+//;
	359	$contact =~ s/^\s+//;
	360	$users =~ s/^\s+//;
	361	$users =~ s/\n//g;
	362	$date =~ s/^\s+//;
	363	$desc =~ s/^\s+//;
	364
	365	printf "Kernel version:\t\t%s\n", $kernelversion if ($kernelversion);
	366	printf "Date:\t\t\t%s\n", $date if ($date);
	367	printf "Contact:\t\t%s\n", $contact if ($contact);
	368	printf "Users:\t\t\t%s\n", $users if ($users);
	369	print "Defined on file:\t$file\n\n";
	370	print "Description:\n\n$desc";
	371	}
	372	}
	373
	374
bbc249f2 MCC	375	#
	376	# Parses all ABI files located at $prefix dir
	377	#
	378	find({wanted =>\&parse_abi, no_chdir => 1}, $prefix);
	379
	380	print STDERR Data::Dumper->Dump([\%data], [qw(*data)]) if ($debug);
	381
	382	#
33e3e991	383	# Handles the command
bbc249f2	384	#
33e3e991 MCC	385	if ($cmd eq "rest") {
33e3e991 MCC	386	output_rest;
7ce7b89b	387	} elsif ($cmd eq "search") {
33e3e991 MCC	388	search_symbols;
33e3e991 MCC	389	}
bbc249f2 MCC	390
	391
	392	__END__
	393
	394	=head1 NAME
	395
	396	abi_book.pl - parse the Linux ABI files and produce a ReST book.
	397
	398	=head1 SYNOPSIS
	399
11ce90a4	400	B<abi_book.pl> [--debug] [--man] [--help] --[(no-)rst-source] [--dir=<dir>] <COMAND> [<ARGUMENT>]
33e3e991 MCC	401
	402	Where <COMMAND> can be:
	403
	404	=over 8
	405
	406	B<search> [SEARCH_REGEX] - search for [SEARCH_REGEX] inside ABI
	407
7ce7b89b MCC	408	B<rest> - output the ABI in ReST markup language
	409
	410	B<validate> - validate the ABI contents
33e3e991 MCC	411
33e3e991 MCC	412	=back
bbc249f2 MCC	413
	414	=head1 OPTIONS
	415
	416	=over 8
	417
33e3e991 MCC	418	=item B<--dir>
	419
	420	Changes the location of the ABI search. By default, it uses
	421	the Documentation/ABI directory.
	422
11ce90a4 MCC	423	=item B<--rst-source> and B<--no-rst-source>
	424
	425	The input file may be using ReST syntax or not. Those two options allow
	426	selecting between a rst-compliant source ABI (--rst-source), or a
	427	plain text that may be violating ReST spec, so it requres some escaping
	428	logic (--no-rst-source).
	429
bbc249f2 MCC	430	=item B<--debug>
	431
	432	Put the script in verbose mode, useful for debugging. Can be called multiple
	433	times, to increase verbosity.
	434
	435	=item B<--help>
	436
	437	Prints a brief help message and exits.
	438
	439	=item B<--man>
	440
	441	Prints the manual page and exits.
	442
	443	=back
	444
	445	=head1 DESCRIPTION
	446
33e3e991 MCC	447	Parse the Linux ABI files from ABI DIR (usually located at Documentation/ABI),
	448	allowing to search for ABI symbols or to produce a ReST book containing
	449	the Linux ABI documentation.
	450
	451	=head1 EXAMPLES
	452
	453	Search for all stable symbols with the word "usb":
	454
	455	=over 8
	456
	457	$ scripts/get_abi.pl search usb --dir Documentation/ABI/stable
	458
	459	=back
	460
	461	Search for all symbols that match the regex expression "usb.*cap":
	462
	463	=over 8
	464
	465	$ scripts/get_abi.pl search usb.*cap
	466
	467	=back
	468
	469	Output all obsoleted symbols in ReST format
	470
	471	=over 8
	472
	473	$ scripts/get_abi.pl rest --dir Documentation/ABI/obsolete
	474
	475	=back
bbc249f2 MCC	476
	477	=head1 BUGS
	478
7ce7b89b	479	Report bugs to Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
bbc249f2 MCC	480
	481	=head1 COPYRIGHT
	482
7ce7b89b	483	Copyright (c) 2016-2019 by Mauro Carvalho Chehab <mchehab+samsung@kernel.org>.
bbc249f2 MCC	484
	485	License GPLv2: GNU GPL version 2 <http://gnu.org/licenses/gpl.html>.
	486
	487	This is free software: you are free to change and redistribute it.
	488	There is NO WARRANTY, to the extent permitted by law.
	489
	490	=cut