perllib/FVWM/create-commands

   1 #!/usr/bin/perl -w
   2
   3 use FindBin;
   4 use lib "$FindBin::Bin/..";
   5 use General::FileSystem;
   6 use POSIX;
   7
   8 chdir($FindBin::Bin) || die "Can't chmod $FindBin::Bin: $!\n";
   9
  10 my $functable_src = "../../fvwm/functable.c";
  11 my $content_ref = load_file($functable_src);
  12 die "No commands found, so Commands.pm is not generated.\n" unless $content_ref;
  13
  14 my $command_entries_code = "";
  15 foreach my $entry ($$content_ref =~
  16         m{(?:/\* )?CMD_ENT\(\s*(?:"|PRE_).*?\),(?: \*/)?.*?/\* .*?- .*? \*/}sg)
  17 {
  18         my ($name, $flags, $cursor, $name2, $descr) = $entry =~ m{
  19                 ,
  20                 .*? CMD_(\w+) ,
  21                 .*? ,
  22                 .*? ([\w\s|]+?) ,
  23                 .*? (?:CRS_)?(\w+)
  24                 .*? \) ,
  25                 .*? /\*\s (?:(.+)\s)? -\s (.*?) \s\*/
  26         }xs;
  27         $name = $name2 if $name2;
  28         my $window = $flags =~ FUNC_NEEDS_WINDOW? 1: 0;
  29         $cursor = "" if $cursor eq "0";
  30         $command_entries_code .=
  31                 "\t{\n\t\tname => '$name',\n\t\tcursor => '$cursor',\n" .
  32                 "\t\twindow => $window,\n\t\tdescr => q{$descr},\n\t},\n";
  33 }
  34
  35 my $version = `egrep '^VERSION = |^VERSIONINFO = ' Makefile | cut -d"=" -f2 \\
  36         | perl -pe 's/^ //;s/\\n//'`;
  37 my $time = time;
  38
  39 my $output = <<ENDOUTPUT;
  40 # Autogenerated from the fvwm sources.
  41
  42 package FVWM::Commands;
  43
  44 use vars qw(\$VERS \$TIME \@LIST);
  45
  46 \$VERS = '$version';
  47 \$TIME = $time;
  48
  49 \@LIST = (
  50 $command_entries_code);
  51
  52 1;
  53
  54 __END__
  55
  56 =head1 NAME
  57
  58 FVWM::Commands - lists all available fvwm commands
  59
  60 =head1 DESCRIPTION
  61
  62 This class is autogenerated from the fvwm sources.
  63
  64 It may be used to get a list of all available fvwm commands including the
  65 command name, its short description and some other command properties.
  66
  67 =head1 USAGE
  68
  69     use lib `fvwm-perllib dir`;
  70     use FVWM::Commands;
  71     use POSIX;
  72
  73     my \$date = strftime("%d-%b-%Y", gmtime(\$FVWM::Commands::TIME));
  74     my \$version = \$FVWM::Commands::VERS;
  75     print "The recognized commands for fvwm \$version as of \$date:\\n\\n";
  76     foreach my \$command (\@FVWM::Commands::LIST) {
  77         printf "  %-21s - %s\\n", \$command->{name}, \$command->{descr};
  78     }
  79
  80 =head1 PUBLIC CONSTANTS
  81
  82 =over 4
  83
  84 =item \$VERS
  85
  86 The fvwm version number at the generation time like "2.6.0" plus the info
  87 that may indicate that this is not a final version, but a cvs snapshot.
  88
  89 =item \$TIME
  90
  91 The unix time of the command list generation.
  92
  93 Example:
  94
  95     print "The fvwm command list found on your system was generated "
  96         . (time() - \$FVWM::Commands::TIME) / 86400 . " days ago\\n";
  97
  98 =item \@LIST
  99
 100 The command list that is an array of hashes with keys I<name>, I<cursor>,
 101 I<descr> (string) and I<window> (boolean).
 102
 103 I<name> may be special, like "+", "#" and "*".  Other names usually contain
 104 only isalpha characters, like B<Move>, B<SendToModule>.
 105
 106 I<cursor> may be either empty or the cursor context used in B<CursorStyle>
 107 (like "SELECT" or "MOVE"), associated with the command.
 108
 109 I<descr> is a short one line description of the command.
 110
 111 I<window> is true for commands that need a window.
 112
 113 Example:
 114
 115     # get command names only
 116     \@command_names = map { \$_->{name} } \@FVWM::Commands::LIST;
 117
 118 =back
 119
 120 =head1 AUTHOR
 121
 122 Mikhael Goikhman <migo\@homemail.com>.
 123
 124 =head1 SEE ALSO
 125
 126 For more information about the commands themselves, see fvwm(1).
 127
 128 =cut
 129 ENDOUTPUT
 130
 131 # ---------------------------------
 132 print "Creating Commands.pm\n";
 133 save_file("Commands.pm", \$output);
 134
 135 # ---------------------------------
 136 print "Testing  Commands.pm\n";
 137 eval qq{
 138         use lib '$FindBin::Bin/..';
 139         use FVWM::Commands;
 140 };
 141 die $@ if $@;
 142 $FVWM::Commands::TIME ||= 0;  # avoid "used once" warning
 143
 144 my $date = strftime("%d-%b-%Y", gmtime($FVWM::Commands::TIME));
 145 my $cmds = "The recognized commands for fvwm $version as of $date:\n\n";
 146 foreach my $command (@FVWM::Commands::LIST = @FVWM::Commands::LIST) {
 147         $cmds .= sprintf "  %-21s - %s\n", $command->{name}, $command->{descr};
 148 }
 149
 150 # ---------------------------------
 151 print "Creating ../../docs/COMMANDS\n";
 152 save_file("../../docs/COMMANDS", \$cmds);