File: exdoc

package info (click to toggle)
mono 4.6.2.7%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 778,148 kB
  • ctags: 914,052
  • sloc: cs: 5,779,509; xml: 2,773,713; ansic: 432,645; sh: 14,749; makefile: 12,361; perl: 2,488; python: 1,434; cpp: 849; asm: 531; sql: 95; sed: 16; php: 1
file content (325 lines) | stat: -rw-r--r-- 7,809 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
#!/usr/bin/perl

if ($ARGV[0] eq "-h"){
    $sourcedir = $ARGV[1];
    $dir = $sourcedir;
    $html = 1;
    shift @ARGV;
    shift @ARGV;
}
open (FILE, "$dir/api-style.css" || die "Did not find $dir/api-style.css");
while (<FILE>){
    $css = $css . $_;
}

if ($ARGV[0] eq "-t"){
    $dir = $ARGV[1];
    shift @ARGV;
}

if ($html){
    opendir (D, "$sourcedir/sources/") || die "Can not open $dir";
    while ($n = readdir (D)){
	if ($n =~ /mono-api-.*\.html$/){
	    open (IN, "$sourcedir/sources/$n") || die "Can not open $n";
	    $files[$filecount] = $n;
	    while (<IN>){
		@files_content[$filecount] .= $_;
		if (/name="api:(.*?)"/){
		    $_ =~ s/.*name="api:(\w+?)".*/\1/;
		    $apis[$filecount] .= "$_";
		}
	    }
	    $filecount++;
	    close IN;
	}
    }
}

while (<ARGV>){
	if (/\/\*\* *\n/){
		&process_doc;
	} else {
		#print "IGNORING: $_";
	}
}

if ($html){
    for ($f = 0; $f < $filecount; $f++){
	$name = $files[$f];
	open (OUT, "> $dir/html/$name") || die "Can not create $dir/html/$name";
	print "Merging: $name\n";
	print OUT<<EOF;
<?xml version="1.0" encoding="utf-8"?>
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
    <title>$name</title>
    <style type="text/css">
$css
   </style>
</head>
<body>
<div class="mapi-docs">
EOF
	@a = split (/\n/, $files_content[$f]);
	$strikeextra = "";
	$api_shown = 0;
	for ($ai = 0; $ai < $#a; $ai++){
	    $line = $a[$ai];
	    
	    ($api,$caption) = $line =~  /<h4><a name=\"api:(\w+)\">(\w+)<\/a><\/h4>/;
	    if ($api ne ""){
		if ($api_shown == 1){
		    print OUT "</div> <!-- class=mapi -->\n\n";
		    if ($deprecated{$api}){
			$strike = "mapi-strike";
			$strikeextra = "</div><br><div class='mapi-deprecated'><b>Deprecated:</b> " . $deprecated{$api};
		    } else {
			$strike = "";
			$strikeextra = "";
		    }
		}
		$api_shown = 1;
		$proto = $prototype{$api};
		if ($proto eq ""){
		    $proto = "$api";
		}

                print OUT<<EOF;
<a name="api:$api"></a>
<div class="mapi">
    <div class="mapi-entry $strike"><code>$api$strikeextra</code></div>
    <div class="mapi-height-container">
        <div class="mapi-ptr-container"></div>
        <div class="mapi-description">
            <div class="mapi-ptr"></div>

            <div class="mapi-declaration mapi-section">Syntax</div>
            <div class="mapi-prototype">$proto</div>
            <p>
EOF
                $ppars = $arguments{$api};
		if ($ppars ne "" && (!($ppars =~ /^[ \t]+$/))){
		    print OUT "            <div class=\"mapi-section\">Parameters</div>\n";
		    print OUT "            <table class=\"mapi-parameters\"><tbody>".${arguments{$api}}."</tbody></table>";
	        }
	    
		&opt_print ("Return value", $returns{$api}, 0);
		&opt_print ("Description", $bodies{$api}, 0);
		print OUT "        </div><!--mapi-description-->\n    </div><!--height container-->\n";
	    } else {
		if ($line =~ /@API_IDX@/){
		    $apis_toc = &create_toc ($apis[$f]);
		    $line =~ s/\@API_IDX\@/$apis_toc/;
		}
		if ($line =~ /^<h4/){
		    print OUT "</div>\n";
		    $api_shown = 0;
		}
		if ($line =~ /`/){
		}
		print OUT "$line\n";
	    }
	}
	print OUT<<EOF;
   </div>
</body>
</html>
EOF
	close OUT;
	system ("$ENV{runtimedir}/mono-wrapper convert.exe $dir/html/$name $dir/html/x-$name");


	# clean up the mess that AgilityPack does, it CDATAs our CSS
	open HACK, "$dir/html/x-$name" || die "Could not open $dir/html/x-$name";
	open HACKOUT, ">$dir/deploy/$name" || die "Could not open output";

	$line = 0;
	$doprint = 0;
	while (<HACK>){
	    print HACKOUT $last if ($doprint);
	    $line++;
	    s/^\/\/<!\[CDATA\[//;
	    s/^\/\/\]\]>\/\///;

	    # Remove the junk <span> wrapper generated by AgilityPack
	    if ($line==1){
		s/<span>//;
	    }
	    if (/<style type/){
		# Replace the CSS in the XHTML output with the original CSS
		print HACKOUT $_;
		print HACKOUT $css;
		while (<HACK>){
		    last if (/<\/style>/);
		}
	    }
	    $last = $_;
	    $doprint = 1;
	}
	if (!($last =~ /span/)){
	    print HACKOUT $last;
	}

	#system ("cp.exe $dir/html/$name $dir/deploy/$name");
    }
}

sub process_doc {
	$doc = "";
	$func = <>;
	chop $func;
	$func =~ s/^ \* //;
	$func =~ s/:$//;
	print "Function: $func\n" if (!$html);
	$args = "";
	$inbody = 0;
	$returns = "";
	$body = "";
	$functions[$fn++] = $func;
	$deprecated = 0;
	# Process arguments
	while (<>){
	    s/NULL/<code>NULL<\/code>/g;
	    s/TRUE/<code>TRUE<\/code>/g;
	    s/FALSE/<code>FALSE<\/code>/g;
	    if (/^ \*\*?\//){
		    $body =~ s/@(\w+)/<i>\1<\/i>/g;
		    $returns =~ s/@(\w+)/<i>\1<\/i>/g;
		    $args =~ s/@(\w+)/<i>\1<\/i>/g;

		    $body =~ s/#(\w+)/<code>\1<\/code>/g;
		    $returns =~ s/#(\w+)/<code>\1<\/code>/g;
		    $args =~ s/#(\w+)/<code>\1<\/code>/g;

		    $returns =~ s/\`([:.\w\*]+)\`/<code>\1<\/code>/g;
		    $args =~ s/\`([:.\w\*]+)\`/<code>\1<\/code>/g;
		    $body =~ s/\`([:.\w\*]+)\`/<code>\1<\/code>/g;
		    
		    $body =~ s/\n/ /;
		    $bodies{$func} = $body;
		    $arguments{$func} = $args;
		    $deprecated{$func} = $deprecated;
		    $returns{$func} = $returns;
		    $proto = "";
		    while (<>){
			$proto .= $_;
			last if (/\{/);
		    }
		    $proto =~ s/{//;
		    # clean it up a little, remove newlines, empty space at end
		    $proto =~ s/ +$//;
		    # Turn "Type * xxx" into "Type* xxx"
		    $proto =~ s/^(\w+)\W+\*/\1\*/;
		    $prototype{$func} = $proto;
		    return;
		}
		chop;
		s/^\ \*//;
		$_ = "<p>" if (/^\s*$/);
				
		if ($inbody == 0){
		    if (/\s*(\w+):(.*)/){
			if ($1 eq "deprecated"){
			    $deprecated = $2;
			} else {
			    #$args .= "<dt><i>$1:</i></dt><dd>$2</dd>";
			    $args .= "<tr><td><i>$1</i><td>$2</td></td></tr>";
			}
		    } else {
			
			$body = "\t$_\n";

			$inbody = 1;
		    }
		} elsif ($inbody == 1) {
		    if (/Returns?:/){
			s/Returns?://;
			$returns = "\t$_\n";
			$inbody = 2;
		    } else {
			$body .= "\n\t$_";
		    }
		} else {
		    $returns .= "\n\t$_";
		}
		   
	}
}

sub create_toc {
    my ($apis_listed) = @_;
    my $type_size = 0;
    my $name_size = 0;
    my $ret, $xname, $args, $line;
    $apis_toc = "";


    # Try to align things, so compute type size, method size, and arguments
    foreach $line (split /\n/, $apis_listed){
	$p = $prototype{$line};
	($ret, $xname, $args) = $p =~ /(.*)\n(\w+)[ \t](.*)/;
	$tl = length ($ret);
	$pl = length ($xname);

	$type_size = $tl if ($tl > $type_size);
	$name_size = $pl if ($pl > $name_size);
    }

    $type_size++;
    $name_size++;

    foreach $line (split /\n/, $apis_listed){
	chop;
	$p = $prototype{$line};
	($ret, $xname, $args) = $p =~ /(.*)\n(\w+)[ \t](.*)/;
	if ($xname eq ""){
	    $xname = $line;
	}
	
	$rspace = " " x ($type_size - length ($ret));
	$nspace = " " x ($name_size - length ($xname));
	$args = &format ($args, length ($ret . $rspace . $xname . $nspace), 60);
	$apis_toc .= "$ret$rspace<a href=\"\#api:$line\">$xname</a>$nspace$args\n";
    }
    return $apis_toc;
}

#
# Formats the rest of the arguments in a way that will fit in N columns
#
sub format {
    my ($args, $size, $limit) = @_;
    my $sret = "";

#    return $args if ((length (args) + size) < $limit);
    
    $remain = $limit - $size;
    @sa = split /,/, $args;
    $linelen = $size;
    foreach $arg (@sa){
	if ($sret eq ""){
	    $sret = $arg . ", ";
	    $linelen += length ($sret);
	} else {
	    if ($linelen + length ($arg) < $limit){
		$sret .= "FITS" . $arg . ", ";
	    } else {
		$newline = " " x ($size) . $arg . ", ";
		$linelen = length ($newline);
		$sret .= "\n" . $newline;
	    }
	}
    }
    $sret =~ s/, $/;/;
    return $sret;
}

sub opt_print {
    my ($caption, $opttext, $quote) = @_;

    if ($opttext ne "" && (!($opttext =~ /^[ \t]+$/))){
	print OUT "             <div class=\"mapi-section\">$caption</div>\n";
        print OUT "             <div>$opttext</div>\n";
    }
}