FYI: move channel declarations in a package

[Alexandre Duret-Lutz]

I'm checking this in on HEAD.

This move channel declaration and supporting functions in a separate
package so that
  1) other programs can use them (not sure if this is really important
     if aclocal disappears)
  2) other packages can use them (I need this before I can "objectify"
     variables and targets).

Index: ChangeLog
from  Alexandre Duret-Lutz  <address@hidden>

        * lib/Automake/ChannelDefs.pm: New file.
        * lib/Automake/Makefile.am (dist_perllib_DATA): Add ChannelDefs.pm.
        * automake.in: Move all "register_channel" calls to ChannelDefs.pm.
        (prog_error, error, fatal, verb, switch_warning, parse_WARNINGS,
        parse_warnings): Move to ChannelDefs.pm.
        (usage): Move the warning list to Automake::ChannelDefs::usage
        and call it.
        (set_strictness): Move channel setings to
        Automake::ChannelDefs::set_strictness and call it.

Index: automake.in
===================================================================
RCS file: /home/adl/CVSROOT/LOCAL/HEAD4-20021225-1439/automake.in,v
retrieving revision 1.2
diff -u -r1.2 automake.in
--- automake.in 25 Dec 2002 14:23:15 -0000 1.2
+++ automake.in 25 Dec 2002 15:02:09 -0000
@@ -115,6 +115,7 @@
 use Automake::General;
 use Automake::XFile;
 use Automake::Channels;
+use Automake::ChannelDefs;
 use Automake::Location;
 use Automake::Conditional qw/TRUE FALSE/;
 use Automake::ConditionalSet;
@@ -865,44 +866,6 @@
 
 ################################################################
 
-# Initialize our list of error/warning channels.
-# Do not forget to update &usage and the manual
-# if you add or change a warning channel.
-
-# Fatal errors.
-register_channel 'fatal', type => 'fatal';
-# Common errors.
-register_channel 'error', type => 'error';
-# Errors related to GNU Standards.
-register_channel 'error-gnu', type => 'error';
-# Errors related to GNU Standards that should be warnings in `foreign' mode.
-register_channel 'error-gnu/warn', type => 'error';
-# Errors related to GNITS Standards (silent by default).
-register_channel 'error-gnits', type => 'error', silent => 1;
-# Internal errors.
-register_channel 'automake', type => 'fatal', backtrace => 1,
-  header => ("####################\n" .
-            "## Internal Error ##\n" .
-            "####################\n"),
-  footer => "\nPlease contact <address@hidden>.";
-
-# Warnings related to GNU Coding Standards.
-register_channel 'gnu', type => 'warning';
-# Warnings about obsolete features (silent by default).
-register_channel 'obsolete', type => 'warning', silent => 1;
-# Warnings about non-portable constructs.
-register_channel 'portability', type => 'warning', silent => 1;
-# Weird syntax, unused variables, typos...
-register_channel 'syntax', type => 'warning';
-# Warnings about unsupported (or mis-supported) features.
-register_channel 'unsupported', type => 'warning';
-
-# For &verb.
-register_channel 'verb', type => 'debug', silent => 1;
-# Informative messages.
-register_channel 'note', type => 'debug', silent => 0;
-
-
 # Initialize our list of languages that are internally supported.
 
 # C.
@@ -1164,35 +1127,6 @@
 
 # Error reporting functions.
 
-# prog_error ($MESSAGE, [%OPTIONS])
-# -------------------------------
-# Signal a programming error, display $MESSAGE, and exit 1.
-sub prog_error ($;%)
-{
-  my ($msg, %opts) = @_;
-  msg 'automake', '', $msg, %opts;
-}
-
-# error ($WHERE, $MESSAGE, [%OPTIONS])
-# error ($MESSAGE)
-# ------------------------------------
-# Uncategorized errors.
-sub error ($;$%)
-{
-  my ($where, $msg, %opts) = @_;
-  msg ('error', $where, $msg, %opts);
-}
-
-# fatal ($WHERE, $MESSAGE, [%OPTIONS])
-# fatal ($MESSAGE)
-# ----------------------------------
-# Fatal errors.
-sub fatal ($;$%)
-{
-  my ($where, $msg, %opts) = @_;
-  msg ('fatal', $where, $msg, %opts);
-}
-
 # err_var ($VARNAME, $MESSAGE, [%OPTIONS])
 # ----------------------------------------
 # Uncategorized errors about variables.
@@ -1319,14 +1253,6 @@
   return 0;
 }
 
-# verb ($MESSAGE, [%OPTIONS])
-# ---------------------------
-sub verb ($;%)
-{
-  my ($msg, %opts) = @_;
-  msg 'verb', '', $msg, %opts;
-}
-
 ################################################################
 
 # subst ($TEXT)
@@ -1406,76 +1332,6 @@
 ################################################################
 
 
-# switch_warning ($CATEGORY)
-# --------------------------
-# If $CATEGORY is mumble, turn on the mumble channel.
-# If it's no-mumble, turn mumble off.
-# Else handle `all' and `none' for completeness.
-sub switch_warning ($)
-{
-  my ($cat) = @_;
-  my $has_no = 0;
-
-  if ($cat =~ /^no-(.*)$/)
-    {
-      $cat = $1;
-      $has_no = 1;
-    }
-
-  if ($cat eq 'all')
-    {
-      setup_channel_type 'warning', silent => $has_no;
-    }
-  elsif ($cat eq 'none')
-    {
-      setup_channel_type 'warning', silent => ! $has_no;
-    }
-  elsif ($cat eq 'error')
-    {
-      $warnings_are_errors = ! $has_no;
-      # Set exit code if Perl warns about something
-      # (like uninitialized variables).
-      $SIG{"__WARN__"} =
-       $has_no ? 'DEFAULT' : sub { print STDERR @_; $exit_code = 1; };
-    }
-  elsif (channel_type ($cat) eq 'warning')
-    {
-      setup_channel $cat, silent => $has_no;
-    }
-  else
-    {
-      return 1;
-    }
-  return 0;
-}
-
-# parse_WARNINGS
-# --------------
-# Honor the WARNINGS environment variable.
-sub parse_WARNINGS ($$)
-{
-  if (exists $ENV{'WARNINGS'})
-    {
-      # Ignore unknown categories.  This is required because WARNINGS
-      # should be honored by many tools.
-      switch_warning $_ foreach (split (',', $ENV{'WARNINGS'}));
-    }
-}
-
-# parse_warning ($OPTION, $ARGUMENT)
-# ----------------------------------
-# Parse the argument of --warning=CATEGORY or -WCATEGORY.
-sub parse_warnings ($$)
-{
-  my ($opt, $categories) = @_;
-
-  foreach my $cat (split (',', $categories))
-    {
-      msg 'unsupported', "unknown warning category `$cat'"
-       if switch_warning $cat;
-    }
-}
-
 # Parse command line.
 sub parse_arguments ()
 {
@@ -8943,48 +8799,19 @@
 {
   $strictness_name = $_[0];
 
-  # FIXME: 'portability' warnings are currently disabled by default.
-  # Eventually we want to turn them on in GNU and GNITS modes, but
-  # we don't do this yet in Automake 1.7 to help the 1.6/1.7 transition.
-  #
-  # Indeed there would be only two ways to get rid of these new warnings:
-  #  1. adjusting Makefile.am
-  #     This is not always easy (or wanted).  Consider %-rules or
-  #     $(function args) variables.
-  #  2. using -Wno-portability
-  #     This means there is no way to have the same Makefile.am
-  #     working both with Automake 1.6 and 1.7 (since 1.6 does not
-  #     understand -Wno-portability).
-  #
-  # In Automake 1.8 (or whatever it is called) we can turn these
-  # warnings on, since -Wno-portability will not be an issue for
-  # the 1.7/1.8 transition.
+  Automake::ChannelDefs::set_strictness ($strictness_name);
+
   if ($strictness_name eq 'gnu')
     {
       $strictness = GNU;
-      setup_channel 'error-gnu', silent => 0;
-      setup_channel 'error-gnu/warn', silent => 0, type => 'error';
-      setup_channel 'error-gnits', silent => 1;
-      # setup_channel 'portability', silent => 0;
-      setup_channel 'gnu', silent => 0;
     }
   elsif ($strictness_name eq 'gnits')
     {
       $strictness = GNITS;
-      setup_channel 'error-gnu', silent => 0;
-      setup_channel 'error-gnu/warn', silent => 0, type => 'error';
-      setup_channel 'error-gnits', silent => 0;
-      # setup_channel 'portability', silent => 0;
-      setup_channel 'gnu', silent => 0;
     }
   elsif ($strictness_name eq 'foreign')
     {
       $strictness = FOREIGN;
-      setup_channel 'error-gnu', silent => 1;
-      setup_channel 'error-gnu/warn', silent => 0, type => 'warning';
-      setup_channel 'error-gnits', silent => 1;
-      # setup_channel 'portability', silent => 1;
-      setup_channel 'gnu', silent => 1;
     }
   else
     {
@@ -9103,17 +8930,8 @@
   -c, --copy             with -a, copy missing files (default is symlink)
   -f, --force-missing    force update of standard files
 
-Warning categories include:
-  `gnu'           GNU coding standards (default in gnu and gnits modes)
-  `obsolete'      obsolete features or constructions
-  `portability'   portability issues
-  `syntax'        dubious syntactic constructs (default)
-  `unsupported'   unsupported or incomplete features (default)
-  `all'           all the warnings
-  `no-CATEGORY'   turn off warnings in CATEGORY
-  `none'          turn off all the warnings
-  `error'         treat warnings as errors
 ";
+    Automake::ChannelDefs::usage;
 
     my ($last, @lcomm);
     $last = '';
Index: lib/Automake/ChannelDefs.pm
===================================================================
RCS file: lib/Automake/ChannelDefs.pm
diff -N lib/Automake/ChannelDefs.pm
--- /dev/null   1 Jan 1970 00:00:00 -0000
+++ lib/Automake/ChannelDefs.pm 25 Dec 2002 18:44:02 -0000
@@ -0,0 +1,394 @@
+# Copyright (C) 2002 Free Software Foundation, Inc.
+
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 2, or (at your option)
+# any later version.
+
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
+# 02111-1307, USA.
+
+package Automake::ChannelDefs;
+
+use Automake::Channels;
+
+=head1 NAME
+
+Automake::ChannelDefs - channel definitions for Automake and helper functions
+
+=head1 SYNOPSIS
+
+  use Automake::ChannelDefs;
+
+  Automake::ChannelDefs::usage ();
+  prog_error ($MESSAGE, [%OPTIONS]);
+  error ($WHERE, $MESSAGE, [%OPTIONS]);
+  error ($MESSAGE);
+  fatal ($WHERE, $MESSAGE, [%OPTIONS]);
+  fatal ($MESSAGE);
+  verb ($MESSAGE, [%OPTIONS]);
+  switch_warning ($CATEGORY);
+  parse_WARNINGS ();
+  parse_warning ($OPTION, $ARGUMENT);
+  Automake::ChannelDefs::set_strictness ($STRICTNESS_NAME);
+
+=head1 DESCRIPTION
+
+This packages defines channels that can be used in Automake to
+output diagnostics and other messages (via C<msg()>).  It also defines
+some helper function to enable or disable these channels, and some
+shorthand function to output on specific channels.
+
+=cut
+
+use 5.005;
+use strict;
+use Exporter;
+
+use vars qw (@ISA @EXPORT);
+
address@hidden = qw (Exporter);
address@hidden = qw (&prog_error &error &fatal &verb
+             &switch_warning &parse_WARNINGS &parse_warnings);
+
+=head2 CHANNELS
+
+The following channels can be used as the first argument of
+C<Automake::Channel::msg>.  For some of them we list a shorthand
+function that makes the code more readable.
+
+=over 4
+
+=item C<fatal>
+
+Fatal errors.  Use C<&fatal> to send messages over this channel.
+
+=item C<error>
+
+Common errors.   Use C<&error> to send messages over this channel.
+
+=item C<error-gnu>
+
+Errors related to GNU Standards.
+
+=item C<error-gnu/warn>
+
+Errors related to GNU Standards that should be warnings in `foreign' mode.
+
+=item C<error-gnits>
+
+Errors related to GNITS Standards (silent by default).
+
+=item C<automake>
+
+Internal errors.  Use C<&prog_error> to send messages over this channel.
+
+=item C<gnu>
+
+Warnings related to GNU Coding Standards.
+
+=item C<obsolete>
+
+Warnings about obsolete features (silent by default).
+
+=item C<portability>
+
+Warnings about non-portable constructs.
+
+=item C<syntax>
+
+Weird syntax, unused variables, typos...
+
+=item C<unsupported>
+
+Warnings about unsupported (or mis-supported) features.
+
+=item C<verb>
+
+Messages output in C<--verbose> mode.  Use C<&verb> to send such messages.
+
+=item C<note>
+
+Informative messages.
+
+=back
+
+=cut
+
+# Initialize our list of error/warning channels.
+# Do not forget to update &usage and the manual
+# if you add or change a warning channel.
+
+register_channel 'fatal', type => 'fatal';
+register_channel 'error', type => 'error';
+register_channel 'error-gnu', type => 'error';
+register_channel 'error-gnu/warn', type => 'error';
+register_channel 'error-gnits', type => 'error', silent => 1;
+register_channel 'automake', type => 'fatal', backtrace => 1,
+  header => ("####################\n" .
+            "## Internal Error ##\n" .
+            "####################\n"),
+  footer => "\nPlease contact <address@hidden>.";
+
+register_channel 'gnu', type => 'warning';
+register_channel 'obsolete', type => 'warning', silent => 1;
+register_channel 'portability', type => 'warning', silent => 1;
+register_channel 'syntax', type => 'warning';
+register_channel 'unsupported', type => 'warning';
+
+register_channel 'verb', type => 'debug', silent => 1;
+register_channel 'note', type => 'debug', silent => 0;
+
+=head2 FUNCTIONS
+
+=over 4
+
+=item C<usage ()>
+
+Display warning categories.
+
+=cut
+
+sub usage ()
+{
+  print "Warning categories include:
+  `gnu'           GNU coding standards (default in gnu and gnits modes)
+  `obsolete'      obsolete features or constructions
+  `portability'   portability issues
+  `syntax'        dubious syntactic constructs (default)
+  `unsupported'   unsupported or incomplete features (default)
+  `all'           all the warnings
+  `no-CATEGORY'   turn off warnings in CATEGORY
+  `none'          turn off all the warnings
+  `error'         treat warnings as errors
+";
+}
+
+=item C<prog_error ($MESSAGE, [%OPTIONS])>
+
+Signal a programming error (on channel C<automake>),
+display C<$MESSAGE>, and exit 1.
+
+=cut
+
+sub prog_error ($;%)
+{
+  my ($msg, %opts) = @_;
+  msg 'automake', '', $msg, %opts;
+}
+
+=item C<error ($WHERE, $MESSAGE, [%OPTIONS])>
+
+=item C<error ($MESSAGE)>
+
+Uncategorized errors.
+
+=cut
+
+sub error ($;$%)
+{
+  my ($where, $msg, %opts) = @_;
+  msg ('error', $where, $msg, %opts);
+}
+
+=item C<fatal ($WHERE, $MESSAGE, [%OPTIONS])>
+
+=item C<fatal ($MESSAGE)>
+
+Fatal errors.
+
+=cut
+
+sub fatal ($;$%)
+{
+  my ($where, $msg, %opts) = @_;
+  msg ('fatal', $where, $msg, %opts);
+}
+
+=item C<verb ($MESSAGE, [%OPTIONS])>
+
+C<--verbose> messages.
+
+=cut
+
+sub verb ($;%)
+{
+  my ($msg, %opts) = @_;
+  msg 'verb', '', $msg, %opts;
+}
+
+=item C<switch_warning ($CATEGORY)>
+
+If C<$CATEGORY> is C<mumble>, turn on channel C<mumble>.
+If it's C<no-mumble>, turn C<mumble> off.
+Else handle C<all> and C<none> for completeness.
+
+=cut
+
+sub switch_warning ($)
+{
+  my ($cat) = @_;
+  my $has_no = 0;
+
+  if ($cat =~ /^no-(.*)$/)
+    {
+      $cat = $1;
+      $has_no = 1;
+    }
+
+  if ($cat eq 'all')
+    {
+      setup_channel_type 'warning', silent => $has_no;
+    }
+  elsif ($cat eq 'none')
+    {
+      setup_channel_type 'warning', silent => ! $has_no;
+    }
+  elsif ($cat eq 'error')
+    {
+      $warnings_are_errors = ! $has_no;
+      # Set exit code if Perl warns about something
+      # (like uninitialized variables).
+      $SIG{"__WARN__"} =
+       $has_no ? 'DEFAULT' : sub { print STDERR @_; $exit_code = 1; };
+    }
+  elsif (channel_type ($cat) eq 'warning')
+    {
+      setup_channel $cat, silent => $has_no;
+    }
+  else
+    {
+      return 1;
+    }
+  return 0;
+}
+
+=item C<parse_WARNINGS ()>
+
+Parse the WARNINGS environment variable.
+
+=cut
+
+sub parse_WARNINGS ()
+{
+  if (exists $ENV{'WARNINGS'})
+    {
+      # Ignore unknown categories.  This is required because WARNINGS
+      # should be honored by many tools.
+      switch_warning $_ foreach (split (',', $ENV{'WARNINGS'}));
+    }
+}
+
+=item C<parse_warning ($OPTION, $ARGUMENT)>
+
+Parse the argument of C<--warning=CATEGORY> or C<-WCATEGORY>.
+
+C<$OPTIONS> is C<"--warning"> or C<"-W">, C<$ARGUMENT> is C<CATEGORY>.
+
+This is meant to be used as a argument to C<Getopt>.
+
+=cut
+
+sub parse_warnings ($$)
+{
+  my ($opt, $categories) = @_;
+
+  foreach my $cat (split (',', $categories))
+    {
+      msg 'unsupported', "unknown warning category `$cat'"
+       if switch_warning $cat;
+    }
+}
+
+=item C<set_strictness ($STRICTNESS_NAME)>
+
+Configure channels for strictness C<$STRICTNESS_NAME>.
+
+=cut
+
+sub set_strictness ($)
+{
+  my ($name) = @_;
+
+  # FIXME: 'portability' warnings are currently disabled by default.
+  # Eventually we want to turn them on in GNU and GNITS modes, but
+  # we don't do this yet in Automake 1.7 to help the 1.6/1.7 transition.
+  #
+  # Indeed there would be only two ways to get rid of these new warnings:
+  #  1. adjusting Makefile.am
+  #     This is not always easy (or wanted).  Consider %-rules or
+  #     $(function args) variables.
+  #  2. using -Wno-portability
+  #     This means there is no way to have the same Makefile.am
+  #     working both with Automake 1.6 and 1.7 (since 1.6 does not
+  #     understand -Wno-portability).
+  #
+  # In Automake 1.8 (or whatever it is called) we can turn these
+  # warnings on, since -Wno-portability will not be an issue for
+  # the 1.7/1.8 transition.
+
+  if ($name eq 'gnu')
+    {
+      setup_channel 'error-gnu', silent => 0;
+      setup_channel 'error-gnu/warn', silent => 0, type => 'error';
+      setup_channel 'error-gnits', silent => 1;
+      # setup_channel 'portability', silent => 0;
+      setup_channel 'gnu', silent => 0;
+    }
+  elsif ($name eq 'gnits')
+    {
+      setup_channel 'error-gnu', silent => 0;
+      setup_channel 'error-gnu/warn', silent => 0, type => 'error';
+      setup_channel 'error-gnits', silent => 0;
+      # setup_channel 'portability', silent => 0;
+      setup_channel 'gnu', silent => 0;
+    }
+  elsif ($name eq 'foreign')
+    {
+      setup_channel 'error-gnu', silent => 1;
+      setup_channel 'error-gnu/warn', silent => 0, type => 'warning';
+      setup_channel 'error-gnits', silent => 1;
+      # setup_channel 'portability', silent => 1;
+      setup_channel 'gnu', silent => 1;
+    }
+  else
+    {
+      prog_error "level `$name' not recognized\n";
+    }
+}
+
+=back
+
+=head1 SEE ALSO
+
+L<Automake::Channels>
+
+=head1 HISTORY
+
+Written by Alexandre Duret-Lutz E<lt>F<address@hidden>E<gt>.
+
+=cut
+
+### Setup "GNU" style for perl-mode and cperl-mode.
+## Local Variables:
+## perl-indent-level: 2
+## perl-continued-statement-offset: 2
+## perl-continued-brace-offset: 0
+## perl-brace-offset: 0
+## perl-brace-imaginary-offset: 0
+## perl-label-offset: -2
+## cperl-indent-level: 2
+## cperl-brace-offset: 0
+## cperl-continued-brace-offset: 0
+## cperl-label-offset: -2
+## cperl-extra-newline-before-brace: t
+## cperl-merge-trailing-else: nil
+## cperl-continued-statement-offset: 2
+## End:
Index: lib/Automake/Makefile.am
===================================================================
RCS file: /home/adl/CVSROOT/LOCAL/HEAD4-20021225-1439/lib/Automake/Makefile.am,v
retrieving revision 1.1
diff -u -r1.1 Makefile.am
--- lib/Automake/Makefile.am 25 Dec 2002 13:39:58 -0000 1.1
+++ lib/Automake/Makefile.am 25 Dec 2002 14:41:09 -0000
@@ -4,6 +4,7 @@
 
 perllibdir = $(pkgvdatadir)/Automake
 dist_perllib_DATA = \
+  ChannelDefs.pm \
   Channels.pm \
   Conditional.pm \
   ConditionalSet.pm \
Index: lib/Automake/Makefile.in
===================================================================
RCS file: /home/adl/CVSROOT/LOCAL/HEAD4-20021225-1439/lib/Automake/Makefile.in,v
retrieving revision 1.1
diff -u -r1.1 Makefile.in
--- lib/Automake/Makefile.in 25 Dec 2002 13:39:58 -0000 1.1
+++ lib/Automake/Makefile.in 25 Dec 2002 14:41:59 -0000
@@ -97,6 +97,7 @@
 
 perllibdir = $(pkgvdatadir)/Automake
 dist_perllib_DATA = \
+  ChannelDefs.pm \
   Channels.pm \
   Conditional.pm \
   ConditionalSet.pm \

     

-- 
Alexandre Duret-Lutz