Expunge revision histories in files.

[sw-tools] / src / sw_build.h

/* -*-c-*-
 *
 * $Id: sw_build.h,v 1.3 2004/04/08 01:52:19 mdw Exp $
 *
 * Management of build processes
 *
 * (c) 1999 EBI
 */

/*----- Licensing notice --------------------------------------------------* 
 *
 * This file is part of sw-tools.
 *
 * sw-tools 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 of the License, or
 * (at your option) any later version.
 * 
 * sw-tools 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 sw-tools; if not, write to the Free Software Foundation,
 * Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
 */

#ifndef SW_BUILD_H
#define SW_BUILD_H

#ifdef __cplusplus
  extern "C" {
#endif

/*----- Header files ------------------------------------------------------*/

#ifndef SW_ARCH_H
#  include "sw_arch.h"
#endif

#ifndef SW_INFO_H
#  include "sw_info.h"
#endif

#ifndef SW_RSH_H
#  include "sw_rsh.h"
#endif

/*----- Data structures ---------------------------------------------------*/

/* --- Information about a presentation handler --- *
 *
 * The @pres@ structure includes everything you need to know about a
 * presentation handler.
 *
 * Presentation handler blocks are linked into a list, in a similar way to
 * commands.  (See the `sw.h' header for information on this.)  The magic
 * link macro is @PRES_LINK@.
 *
 * The `name' field is used to resolve the `--output=' option argument into a
 * presentation.  Make the first few characters distinctive: it uses
 * abbreviation-matching to choose a presentation style.
 *
 * The various routines work like this:
 *
 *   * @ok@ is used to find out whether the handler can *in principle* run in
 *     the current environment.  For example, a presentation handler which
 *     makes use of special terminal features would ensure that standard
 *     output is a terminal; similarly, an X-based handler would ensure that
 *     there is a current display set.  If the handler responds `false' to
 *     this request, the `plain' handler is chosen instead.  A zero value
 *     means that it's always OK to use this handler.
 *
 *  * @init@ is used to initialize the chosen handler.  It returns zero for
 *    success, nonzero for failure.  A failure at this point is a fatal
 *    error: the decision about which handler to run has already been made.
 *    The function is passed the build list as an argument.  Entries with
 *    null remote contexts are not to be built and can be ignored here.  Note
 *    that the actual build jobs have not been started yet.  They're left
 *    until last because they're the most difficult things to stop.  (Indeed,
 *    if some don't start, the others are left to run anyway.)  A zero value
 *    means this handler needs no initialization.
 *
 *  * @output@ reports new output for a particular build: a pointer to the
 *    appropriate archtecture entry is passed.  The handler should format the
 *    text in the buffer in some pleasing and useful manner, and then return.
 *    Any errors which occur at this point are the handler's own problem to
 *    sort out.  It is not permitted for a handler to have a null output
 *    routine.
 *
 *  * @close@ informs the handler that a particular build has completed.  The
 *    @ok@ argument is nonzero if the build was successful, and zero
 *    otherwise.  (A message describing the failure will have been
 *    synthetically output before this point, so only a small visual cue is
 *    needed here.)  A zero value means this handler is not interested in
 *    close events.  The argument @summ@ is a quick summary of the exit
 *    status.
 *
 *  * @done@ informs the handler that all builds have completed.  The handler
 *    should make sure that the display will remain as long as is needed, and
 *    deallocate any resources it obtained eariler.  A zero value means the
 *    handler needs no cleanup and its output is persistent anyway.
 *
 *  * @abort@ cleans up immediately, because something went horribly wrong.
 *    This shouldn't happen very often, but when it is, it's normally
 *    followed by a call to @die@.  A zero value means that this sort of
 *    thing isn't necessary.
 *
 * That's all there is.  Any questions?
 *
 * (The current structure doesn't interface very well with X toolkits.  Some
 * kind of call-tree inverstion would be handy for that, although I don't
 * want to make all the handlers able to cope with `select' management.  This
 * needs thought, if I ever decide to add an X interface here.)
 */

typedef struct pres {
  struct pres *next;
  const char *name;
  int (*ok)(void);
  int (*init)(archcons */*a*/);
  void (*output)(archent */*e*/, const char */*p*/, size_t /*sz*/);
  void (*close)(archent */*e*/, int /*ok*/, const char */*summ*/);
  void (*done)(archcons */*a*/);
  void (*abort)(archcons */*a*/);
} pres;

/*----- Functions provided ------------------------------------------------*/

/* --- @swbuild_archlist@ --- *
 *
 * Arguments:	@swinfo *sw@ = pointer to the build information block
 *
 * Returns:	A list of architectures which are to be built.
 *
 * Use:		Decides which architectures need building, and returns them
 *		in a list.
 */

extern archcons *swbuild_archlist(swinfo */*sw*/);

/*----- Subcommands -------------------------------------------------------*/

extern int sw_run(int /*argc*/, char */*argv*/[]);
extern int sw_make(int /*argc*/, char */*argv*/[]);
extern int sw_conf(int /*argc*/, char */*argv*/[]);
extern int sw_reset(int /*argc*/, char */*argv*/[]);
extern void swrsh_build(sw_remote */*r*/, char */*argv*/[], char */*env*/[]);

#ifdef CMD_LINK
   static cmd cmd_reset = {
     CMD_LINK, "reset", sw_reset,
"reset\tClears all the architecture build flags, so that all architectures\n\
	will be built next time.  This is useful just before a call to\n\
	`sw make clean', for example.\n"
   };
   static cmd cmd_run = {
     &cmd_reset, "run", sw_run,
"run COMMAND [ARGS...]\n\
	Run COMMAND across all architectures that haven't been built yet,\n\
	in architecture-specific subdirectories.  The output is written to\n\
	logfiles in the subdirectories, and displayed in some way by the\n\
	selected output style.\n"
   };
   static cmd cmd_make = {
     &cmd_run, "make", sw_make,
"make [ARGS...]\n\
	Syntactic sugar for `run make ARGS'.  The `make' program named in\n\
	the environment variable `SW_MAKE' is used by preference.\n"
   };
   static cmd cmd_conf = {
     &cmd_make, "configure", sw_conf,
"configure [ARGS...]\n\
	Syntactic sugar for `run ../configure --prefix=PREFIX'.  Put other\n\
	autoconf site configuration in the `config.site' script.  The\n\
	`prefix' value used is " PREFIX ".\n"
   };
#  undef CMD_LINK
#  define CMD_LINK &cmd_conf
#endif

#ifdef RCMD_LINK
   static rcmd rcmd_build = { RCMD_LINK, "build", swrsh_build };
#  undef RCMD_LINK
#  define RCMD_LINK &rcmd_build
#endif

/*----- That's all, folks -------------------------------------------------*/

#ifdef __cplusplus
  }
#endif

#endif