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
|
#!/usr/bin/tclsh
# Copyright (C) 2001-2023 Artifex Software, Inc.
# All Rights Reserved.
#
# This software is provided AS-IS with no warranty, either express or
# implied.
#
# This software is distributed under license and may not be copied,
# modified or distributed except as expressly authorized under the terms
# of the license contained in the file LICENSE in this distribution.
#
# Refer to licensing information at http://www.artifex.com or contact
# Artifex Software, Inc., 39 Mesa Street, Suite 108A, San Francisco,
# CA 94129, USA, for further information.
#
# Make TOC from 1-line module headers in source files.
# Usage: headers.tcl
# Reads src/*.[ch], writes headers.txt
##############################################################################
#
# get_header Scan file for the initial comment block skipping
# Copyright and optional RCS keyword lines
#
# args: FInName Input file name
# FOUTvar Output File ID
#
# return: integer 0 normal header processed
# 1 No Header Found
#
proc get_header { FInName FOUT } {
# Maximum lines allowed in the copyright or comment block
set limit 30
set FIN [open $FInName r]
# Print out the file name -- pad filename to a specific length
puts -nonewline $FOUT [format {%-16s} "$FInName: "]
# Skip initial comment block (Copyright block) by scanning for
# terminating '*/'
set i 0
while { 1 } {
incr i
set s [gets $FIN Line]
if { $s == -1 || $i == $limit } then {
puts stderr "Fail to find end of Copyright block in: $FInName"
puts $FOUT " **** PROBLEM PROCESSING COPYRIGHT BLOCK ****"
close $FIN
return 1
}
if { [regexp {\*/} $Line] } then {
#DEBUG puts "Found end of Copyright at line $i"
break
}
}
# Scan for the start of the header line/block -- ignore RCS keyword lines
set i 0
while { 1 } {
incr i
set s [gets $FIN Line]
if { $s == -1 || $i == $limit } then {
puts stderr "Fail to find header after Copyright in: $FInName"
puts $FOUT " **** NO HEADER FOUND AFTER COPYRIGHT BLOCK ****"
close $FIN
return 1
break
}
# Ignore RCS keyword comment lines
if { [regexp {\$.+\$} $Line] } then {
continue
}
if { [regexp {^[ ]*/[*/]} $Line] } then {
break
}
}
# Process header lines -- stripping off leading and trailing delimiters
# including '/*', '*', and '*/'
set f 0
for { set i 0 } { $i < $limit } { incr i } {
regsub {/[*/]} $Line {} Lx
regsub {\*/} $Lx {} Lx
regsub {^[ ]*(\*|)} $Lx {} Lx
set blank [expr [regexp {^[ ]$} $Lx] || [string length $Lx] == 0]
if { $f == 0 && $blank == 1 } then {
#DEBUG puts "Ignoring leading blank header line #$linecount"
} else {
if { $blank == 1 } then {
break
}
incr f
if { $f > 1 } then {
set Lx " $Lx"
}
puts $FOUT $Lx
if { [regexp {\*/} $Line] } then {
break
}
}
set s [gets $FIN Line]
}
if { $i == $limit } then {
puts stderr "Comment lines ignored in file: $FInName"
}
close $FIN
return 0
}
######################### Begin processing #####################################
# overwrite the file without asking
set FOUT [open headers.txt w]
set NoHeaderCount 0
foreach Group {a b c d e f g[0-9a-c] gd g[e-z] h i j k l m n o p q r s t u v w x y z} {
set List [concat [glob -nocomplain src/$Group*.c] [glob -nocomplain src/$Group*.h]]
if { $List != {} } {
puts "Processing Group: $Group"
puts $FOUT " ------------------- $Group ------------------"
foreach File [lsort $List] {
set s [get_header $File $FOUT]
incr NoHeaderCount $s
}
}
}
puts $FOUT "Number of modules without descriptions: $NoHeaderCount"
close $FOUT
puts "Number of modules without descriptions: $NoHeaderCount"
|
