#!/usr/bin/perl

# ***** BEGIN LICENSE BLOCK *****
# Version: MPL 1.1/GPL 2.0/LGPL 2.1
#
# The contents of this file are subject to the Mozilla Public License Version
# 1.1 (the "License"); you may not use this file except in compliance with
# the License. You may obtain a copy of the License at
# http://www.mozilla.org/MPL/
#
# Software distributed under the License is distributed on an "AS IS" basis,
# WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
# for the specific language governing rights and limitations under the
# License.
#
# The Original Code is Yerna Lindale.
#
# The Initial Developer of the Original Code is
# the Software Engineering Lab, INTEC, University Ghent.
# Portions created by the Initial Developer are Copyright (C) 2004
# the Initial Developer. All Rights Reserved.
#
# Contributor(s):
#   Kris De Schutter <kris.deschutter@ugent.be>
#
# Alternatively, the contents of this file may be used under the terms of
# either the GNU General Public License Version 2 or later (the "GPL"), or
# the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
# in which case the provisions of the GPL or the LGPL are applicable instead
# of those above. If you wish to allow use of your version of this file only
# under the terms of either the GPL or the LGPL, and not to allow others to
# use your version of this file under the terms of the MPL, indicate your
# decision by deleting the provisions above and replace them with the notice
# and other provisions required by the GPL or the LGPL. If you do not delete
# the provisions above, a recipient may use your version of this file under
# the terms of any one of the MPL, the GPL or the LGPL.
#
# ***** END LICENSE BLOCK *****

# This script "normalizes" a Cobol source program.
#
# "Normalisation" applies to comments and continuation lines.
# All forms of comments are reduced to just one standard type.
# All continuation lines are removed while preserving the literals.
# Null characters and backslashes ('\') are escaped (so flex won't
# have any problems parsing).
#
# This tool is part of "Yerna Lindale" (old music).
#
# @author Kris De Schutter <kris.deschutter@ugent.be>
# @date Fri. March 12, 2004

use Getopt::Long;

# Options...
$help = 0;
$version = 0;
$quiet = 0;
$skip_idents = 0;
$file_in = '';
$file_out = '';
$cobol_format = -1;

# Process command line options...
GetOptions (
  'help|?' => \$help,
  'version' => \$version,
  'quiet' => \$quiet,
  'skip_idents' => \$skip_idents,
  'in:s' => \$file_in,
  'out:s' => \$file_out,
  'ansi' => sub { $cobol_format = 1 },
  'terminal' => sub { $cobol_format = 2 }
) or usage ();

# Show help if requested...
if ($help) { usage (); }

# Show version info if requested...
if ($version) { version (); }

# If format not provided, and a file was given, have a guess...
if ($file_in and $cobol_format == -1) {
  $cmd = "guess_cobol_format ";
  if ($quiet) { $cmd = "$cmd -quiet"; }
  $cmd = "$cmd -in $file_in";
  system ($cmd);
  $cobol_format = ($? >> 8);
}

if ($cobol_format == 1) {
  # ANSI format.
  if (!$quiet) {
    print STDOUT ("Normalizing ANSI COBOL...\n");
  }

  $cmd = "normalize_ansi_cobol ";
  if ($quiet) { $cmd = "$cmd -quiet"; }
  if ($skip_idents) { $cmd = "$cmd -skip_idents"; }
  if ($file_in) { $cmd = "$cmd -in $file_in"; }
  if ($file_out) { $cmd = "$cmd -out $file_out"; }
  system ($cmd);
  exit ($?);
  
} elsif ($cobol_format == 2) {
  # TERMINAL format.
  if (!$quiet) {
    print STDOUT ("Normalizing TERMINAL COBOL...\n");
  }

  $cmd = "normalize_terminal_cobol ";
  if ($quiet) { $cmd = "$cmd -quiet"; }
  if ($skip_idents) { $cmd = "$cmd -skip_idents"; }
  if ($file_in) { $cmd = "$cmd -in $file_in"; }
  if ($file_out) { $cmd = "$cmd -out $file_out"; }
  system ($cmd);
  exit ($?);
  
} elsif ($cobol_format == 0) {
  # NORMALIZED format.
  if (!$quiet) {
    print STDOUT ("Source is already normalized.\n");
  }
  exit (0);
  
} else {
  # Unknown format.
  print STDERR ("Format for input is unknown. Aborting.\n");
  exit (1);
}

# ===================================================================

sub usage {
  print STDERR ("Usage: normalize_cobol [OPTIONS]...\n");
  print STDERR ("Where OPTIONS is one of:\n");
  print STDERR ("  -in FILE      read from FILE rather than STDIN\n");
  print STDERR ("  -out FILE     write to FILE rather than STDOUT\n");
  print STDERR ("  -quiet        no report at end of run\n");
  print STDERR ("  -skip_idents  do not look for identifications\n");
  print STDERR ("  -ansi         assume source is ANSI formatted\n");
  print STDERR ("  -terminal     assume source is TERMINAL formatted\n");
  print STDERR ("  -version      show version information\n");
  print STDERR ("  -help         print this message\n");
  print STDERR ("\n");
  exit (0);
}

# ===================================================================

sub version {
  print STDERR ("This is \"normalize_cobol\", version 0.0.1\n");
  print STDERR ("Part of Yerna Lindale (old music).\n");
  exit (0);
}

# ===================================================================

sub file_not_found {
  print STDERR ("File not found: $_[0]\n");
  exit (-101);
}

# ===================================================================

sub cannot_open_file {
  print STDERR ("Cannot open file: $_[0]\n");
  exit (-102);
}
