src/haddock/haddock-check.perl


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


# checking that a file is haddocky

# limitations:
#   - does not check that type aliases are put in the export list
#   - there might be some problems with nested comments

for $file (@ARGV) {
  $file =~ s/\.hs//;

  open F, "<$file.hs";
  $_ = join "", <F>;
  close F;

  # print "- $file\n";

  # removing comments
  s/\{-.*?-\}//gs;
  s/--.*?\n/\n/g;

  # export list
  if (/\nmodule\s+(\w+)\s+\((.*?)\)\s+where/s) {
    ($module, $exportlist) = ($1, $2);

    # removing modules from exportlist
    $exportlist =~ s/module\s+[A-Z]\w*//gs;

    # type signatures
    while (/\n([a-z]\w*)\s*::/gs) {
      $function = $1;
      $exportlist =~ s/\b$function\b//;
    }

    # type aliases
    while (/\ntype\s+(\w+)/gs) {
      $type = $1;
      next if $exportlist =~ /\b$type\b/;
      printf "%-30s | Type alias not in export list: %s\n", $file, $type;
    }

    # exported functions without type signatures
    while ($exportlist =~ /\b(\w+)\b/gs) {
      $function = $1;
      next if $function =~ /^[A-Z]/;
      printf "%-30s | No type signature for function: %s\n", $file, $function;
    }

  } else {
    # modules without export lists
    printf "%-30s | No export list\n", $file;
  }

}