;;; mode-compile.el ---  Smart command for compiling files
;;                       according to major-mode.
;;
;;   Copyright (c) 1994 - 2006 heddy Boubaker C.E.N.A.
;;
;;   Author: Heddy Boubaker <heddy.Boubaker@cena.fr>
;;   Maintainer: Heddy Boubaker <heddy.Boubaker@cena.fr>
;;   Created: June 1994
;;   Last modified: 2006/12/01 13:52:47
;;   Version: 2.29
;;   Keywords: compile, compilation, modes, languages
;;   Tested for:
;;     XEmacs (Lucid GNU Emacs) >= 19.10
;;     Must work with FSF GNU Emacs > 19.31 ;-)
;;     Do not work anymore for Emacses <= 18
;;   Ftp access:
;;    archive.cis.ohio-state.edu:pub/gnu/emacs/elisp-archive/misc/mode-compile.el.Z
;;   WWW access:
;;    <URL http://www.tls.cena.fr/~boubaker/Emacs/>
;;
;; LCD Archive Entry:
;; mode-compile|Heddy Boubaker|boubaker@cena.fr|
;; Smart command for compiling files according to major-mode and more.|
;; 2003/04/01 13:52:47|2.28|~/misc/mode-compile.el.Z|
;;
;;; This file is NOT part of GNU Emacs but the same permissions apply.
;;
;; GNU Emacs 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.
;;
;; GNU Emacs  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 GNU Emacs; see the  file COPYING.  If  not, write to the Free Software
;; Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
;;
;; @ Purpose:
;; ==========
;;
;;  Provide `mode-compile' function as a replacement  for the use of `compile'
;;  command which  is  very dumb  for  creating it's  compilation command (use
;;  "make  -k" by default).  `mode-compile'  is  a layer  above `compile'; Its
;;  purpose is mainly   to  build a  smart  compile-command for  `compile'  to
;;  execute  it. This   compile-command is   built   according  to number   of
;;  parameters:
;;   - the major-mode.
;;   - presence or not of a makefile in current directory.
;;   - the buffer-file-name and extension.
;;   - what is in the current buffer (`main' function,"#!/path/shell", ...).
;;   - and more ... (see Commentary section below).
;;  Most  of  these  parameters  are  higly customizable  throught Emacs  Lisp
;;  variables  (to be  set  in your  .emacs  or  through Customization  menu).
;;  Running  mode-compile after   an  universal-argument (C-u)  allows  remote
;;  compilations, user is  prompted  for a host name   to run the  compilation
;;  command on.   Another  function  provided  is  `mode-compile-kill'   which
;;  terminate a running compilation session launched by `mode-compile'.
;;
;; @ Installation:
;; ===============
;;
;;   Byte compile this file (*) somewhere in your `load-path' and add in
;;  your .emacs:
;;  (autoload 'mode-compile "mode-compile"
;;   "Command to compile current buffer file based on the major mode" t)
;;  (global-set-key "\C-cc" 'mode-compile)
;;  (autoload 'mode-compile-kill "mode-compile"
;;   "Command to kill a compilation launched by `mode-compile'" t)
;;  (global-set-key "\C-ck" 'mode-compile-kill)
;;
;;  By  default mode-compile is  very verbose  and  waits a  few seconds (1 by
;;  default) after  each message for   the user to have  time  to read it. You
;;  could      set           variables      `mode-compile-expert-p'        and
;;  `mode-compile-reading-time'   to  change  this    behaviour.  On X-Windows
;;  systems  setting the variable  `mode-compile-other-frame-p'  will create a
;;  new frame and launch the compilation command in it.
;;
;;  (*) Don't take care of messages:
;;        ** reference to free variable efs-remote-shell-file-name
;;      This is perfectly normal ;-}. But if you know a way to avoid it let me
;;      know.
;;
;; @ Bug Reports:
;; ==============
;;
;;   To   report a  bug  please  use function `mode-compile-submit-bug-report'
;;   Please note that this bug-report facility uses Barry Warsaw's reporter.el
;;   which is part of GNU Emacs v19 and bundled with many  other packages.  If
;;   needed, you can obtain a copy of reporter.el at the elisp-archive.
;;
;; @ Documentation:
;; ================
;;
;;  This section will explain how the `compile-command' are built according to
;;  the `major-mode' and how to  customize it.  The major modes `mode-compile'
;;  currently known are:
;;   - c-mode, c++-mode, makefile-mode, dired-mode, ada-mode, emacs-lisp-mode,
;;     lisp-interaction-mode, sh-mode, csh-mode, fundamental-mode,  text-mode,
;;     indented-text-mode     compilation-mode,  fortran-mode,    c?perl-mode,
;;     zsh-mode java-mode, tcl-mode, python-mode, ruby-mode
;;  For other modes a default behaviour is provided.
;;
;;  When    running    `mode-compile'  or     `mode-compile-kill'   the  hooks
;;  `mode-compile-(before|after)-(compile|kill)-hook'  are   executed.     The
;;  current   buffer   could   be      automaticaly    saved    if    variable
;;  `mode-compile-always-save-buffer-p' is  set  to   `t'.  ALL  the  modified
;;  buffers could  be automaticaly saved if variable `mode-compile-save-all-p'
;;  is set to `t'.
;;
;; @@ fundamental-mode, text-mode, indented-text-mode & UNKNOWN MODES:
;;    *** THIS IS TOO THE DEFAULT BEHAVIOR FOR UNKNOWN MODES ***
;;    Try to guess what the file is by:
;;   - 1st looking at it's name and extension (see variable
;;     `mode-compile-filename-regexp-alist').
;;   - 2nd looking at string "#!/path/shell" at first line to extract shell
;;     to run the script with (see variable `mode-compile-shell-alist').
;;   - 3rd looking at a makefile in current directory.
;;   - then calling `compile' with the last compile command which is
;;     asked to be edited by user ...
;;   The `kill-compile' command is then bound dynamically (buffer-local).
;;
;; @@ compilation-mode:
;;    Call `compile' with the last compile command.
;;
;; @@ makefile-mode:
;;    The makefile is run with make throught `compile' (user is prompted
;;   for        the        rule         to      run,      see         variable
;;   `mode-compile-prefered-default-makerule'  to  see how  a   default choice
;;   could be selected).
;;
;; @@ emacs-lisp-mode, lisp-interaction-mode:
;;    If the buffer is a .el file byte-compile it to produce a .elc file,
;;   else  just  byte-compile  the   buffer  (this   don't  use  `compile' but
;;   `byte-compile').
;;
;; @@ dired-mode:
;;   Find a makefile   in   the directory and  run    make with  it   (like in
;;   makefile-mode),  else try  to byte-recompile  all .el   files olders than
;;   their associated  .elc  files (unlike  `byte-recompile-directory' this is
;;   not  recursive),  finally if  no  .el  files  are present ask compilation
;;   command to  user by  calling  `default-compile'.  To  find  a  makefile a
;;   regexp is provided which name is `mode-compile-makefile-regexp'.
;;
;; @@ sh-mode, csh-mode, zsh-mode:
;;    Run "[cz]?sh" with debugging arguments as specified in
;;   `[cz]?sh-dbg-flags' on the currently edited file.
;;
;; @@ c?perl-mode:
;;    Run  file with "perl   -w"  (can step   throught errors  with  compile's
;;    `next-error' command).
;;
;; @@ tcl-mode:
;;    Run     file  with "wish"  (can     step  throught errors with compile's
;;    `next-error' command).
;;
;; @@ c-mode, c++-mode:
;;   First it try to see if there is a makefile in the directory, makefiles to
;;   look for are  specified  by the variable  `mode-compile-makefile-regexp'.
;;   If yes two cases could happen: there  is only one  makefile so use it, or
;;   there is more  than one (sometimes when  you need to  write portable soft
;;   you  could have  some makefiles by  system:  SunOs.make, HP.make ...), in
;;   that case prompt to  user for choice  (with smart completion).   Once the
;;   makefile has been selected  it extract the rules from  it and ask to user
;;   to   choose  a   rule  to  make  (with  smart  completion,  see  variable
;;   `mode-compile-prefered- default-makerule'  to  see  how  a default choice
;;   could be selected).
;;
;;   There are some cases where no makefiles are  presents (YES I KNOW this is
;;   bad  practice but you  sometimes have no  needs  to write a Makefile)