Blame devel/mkapidoc.sh

Packit 7d6a7d
#!/bin/bash
Packit 7d6a7d
################################################################################
Packit 7d6a7d
#
Packit 7d6a7d
#  mkapidoc.sh -- generate apidoc.fnc from scanning the Perl source
Packit 7d6a7d
#
Packit 7d6a7d
################################################################################
Packit 7d6a7d
#
Packit 7d6a7d
#  Version 3.x, Copyright (C) 2004-2013, Marcus Holland-Moritz.
Packit 7d6a7d
#  Version 2.x, Copyright (C) 2001, Paul Marquess.
Packit 7d6a7d
#  Version 1.x, Copyright (C) 1999, Kenneth Albanowski.
Packit 7d6a7d
#
Packit 7d6a7d
#  This program is free software; you can redistribute it and/or
Packit 7d6a7d
#  modify it under the same terms as Perl itself.
Packit 7d6a7d
#
Packit 7d6a7d
################################################################################
Packit 7d6a7d
Packit 7d6a7d
function isperlroot
Packit 7d6a7d
{
Packit 7d6a7d
  [ -f "$1/embed.fnc" ] && [ -f "$1/perl.h" ]
Packit 7d6a7d
}
Packit 7d6a7d
Packit 7d6a7d
function usage
Packit 7d6a7d
{
Packit 7d6a7d
  echo "USAGE: $0 [perlroot] [output-file] [embed.fnc]"
Packit 7d6a7d
  exit 0
Packit 7d6a7d
}
Packit 7d6a7d
Packit 7d6a7d
if [ -z "$1" ]; then
Packit 7d6a7d
  if isperlroot "../../.."; then
Packit 7d6a7d
    PERLROOT=../../..
Packit 7d6a7d
  else
Packit 7d6a7d
    PERLROOT=.
Packit 7d6a7d
  fi
Packit 7d6a7d
else
Packit 7d6a7d
  PERLROOT=$1
Packit 7d6a7d
fi
Packit 7d6a7d
Packit 7d6a7d
if [ -z "$2" ]; then
Packit 7d6a7d
  if [ -f "parts/apidoc.fnc" ]; then
Packit 7d6a7d
    OUTPUT="parts/apidoc.fnc"
Packit 7d6a7d
  else
Packit 7d6a7d
    usage
Packit 7d6a7d
  fi
Packit 7d6a7d
else
Packit 7d6a7d
  OUTPUT=$2
Packit 7d6a7d
fi
Packit 7d6a7d
Packit 7d6a7d
if [ -z "$3" ]; then
Packit 7d6a7d
  if [ -f "parts/embed.fnc" ]; then
Packit 7d6a7d
    EMBED="parts/embed.fnc"
Packit 7d6a7d
  else
Packit 7d6a7d
    usage
Packit 7d6a7d
  fi
Packit 7d6a7d
else
Packit 7d6a7d
  EMBED=$3
Packit 7d6a7d
fi
Packit 7d6a7d
Packit 7d6a7d
if isperlroot $PERLROOT; then
Packit 7d6a7d
  cat >$OUTPUT <
Packit 7d6a7d
::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::
Packit 7d6a7d
:
Packit 7d6a7d
:  !!!! Do NOT edit this file directly! -- Edit devel/mkapidoc.sh instead. !!!!
Packit 7d6a7d
:
Packit 7d6a7d
:  This file was automatically generated from the API documentation scattered
Packit 7d6a7d
:  all over the Perl source code. To learn more about how all this works,
Packit 7d6a7d
:  please read the F<HACKERS> file that came with this distribution.
Packit 7d6a7d
:
Packit 7d6a7d
::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::
Packit 7d6a7d
Packit 7d6a7d
:
Packit 7d6a7d
: This file lists all API functions/macros that are documented in the Perl
Packit 7d6a7d
: source code, but are not contained in F<embed.fnc>.
Packit 7d6a7d
:
Packit 7d6a7d
Packit 7d6a7d
EOF
Packit 7d6a7d
  grep -hr '^=for apidoc' $PERLROOT | sed -e 's/=for apidoc //' | grep '|' | sort | uniq \
Packit 7d6a7d
     | perl -e'$f=pop;open(F,$f)||die"$f:$!";while(<F>){(split/\|/)[2]=~/(\w+)/;$h{$1}++}
Packit 7d6a7d
               while(<>){s/[ \t]+$//;(split/\|/)[2]=~/(\w+)/;$h{$1}||print}' $EMBED >>$OUTPUT
Packit 7d6a7d
else
Packit 7d6a7d
  usage
Packit 7d6a7d
fi