Expunge revision histories in files.

[sw-tools] / src / sw_arch.h

/* -*-c-*-
 *
 * $Id: sw_arch.h,v 1.2 2004/04/08 01:52:19 mdw Exp $
 *
 * Messing with architectures
 *
 * (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_ARCH_H
#define SW_ARCH_H

#ifdef __cplusplus
  extern "C" {
#endif

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

#include <mLib/dstr.h>

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

/* --- @archcons@ --- *
 *
 * Links architectures into a list.  It's done like this so that we can have
 * multiple lists all referring to the same data.
 */

typedef struct archcons {
  struct archent *car;
  struct archcons *cdr;
} archcons;

/* --- @archent@ --- *
 *
 * Records information extracted from the `archtab' file, together with some
 * other data used at run-time for the parallel build stuff.
 */
    
typedef struct archent {
  struct archcons cons;			/* Cons for linking these together */
  char *arch;				/* The architecture name */
  char *host;				/* The architecture representative */
  int status;				/* Exit status from build process */
  struct sw_remote *r;			/* Remote command control block */
  void *pres;				/* Data for presentation handler */
  unsigned flags;			/* Various other flags */
} archent;

/* --- Flags --- */

enum {
  archFlag_touched = 1,			/* Unique flag: see @arch_filter@ */
  archFlag_built = 2,			/* This architecture is up-to-date */
  archFlag_home = 4			/* This is the current arch */
};

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

/* --- @arch_readtab@ --- *
 *
 * Arguments:	---
 *
 * Returns:	The address of the archtab list.
 *
 * Use:		Reads the archtab file (if necessary) and returns a list of
 *		its contents.
 */

extern archcons *arch_readtab(void);

/* --- @arch_lookup@ --- *
 *
 * Arguments:	@const char *arch@ = pointer to archtecture name
 *		@int abbrev@ = whether abbreviations are OK
 *
 * Returns:	Pointer to archtab block, or null.
 *
 * Use:		Translates an architecture name into the name of a host
 *		supporting that architecture.
 */

extern archent *arch_lookup(const char */*arch*/, int /*abbrev*/);

/* --- @arch_filter@ --- *
 *
 * Arguments:	@archcons *a@ = input list to filter
 *		@const char *p@ = pointer to a textual list of architectures
 *		@unsigned and@, @unsigned xor@ = flags to look for
 *
 * Returns:	A newly constructed architecture list containing only the
 *		listed architectures.
 *
 * Use:		Filters the architecture list down to a few interesting
 *		architectures.
 *
 *		If @p@ is non-null, it is a textual list of architecture
 *		names (possibly abbreviated), and separated by whitespace
 *		and/or commas: only the named architectures are included in
 *		the resulting list.  If @p@ is null, all architectures are
 *		considered.
 *
 *		The list is further trimmed down by examining the flags words
 *		in each entry.  Only entries with flags @f@ where @(f ^ xor)
 *		& and@ is zero are left in the resulting list.  (To include
 *		all entries, clear @and@ to zero.  To require a flag to be
 *		clear, set the corresponding bit in @and@.  To require a flag
 *		to be set, set the corresponding bit in both @and@ and @xor@.
 *
 *		(Don't try to filter on the @archFlag_touched@ flag.  That
 *		flag is for the internal use of this routine.)
 */

extern archcons *arch_filter(archcons */*a*/, const char */*p*/,
			     unsigned /*and*/, unsigned /*xor*/);

/* --- @arch_free@ --- *
 *
 * Arguments:	@archcons *a@ = pointer to a list
 *
 * Returns:	---
 *
 * Use:		Contrary to anything you might have expected from the Lispy
 *		naming, old architecture lists don't get garbage collected.
 *		This routine throws away an old list when you don't want it
 *		any more.  Don't call this on the main list!  It will fail
 *		miserably, because the cons cells in the main list are
 *		faked.
 */

extern void arch_free(archcons */*a*/);

/* --- @arch_toText@ --- *
 *
 * Arguments:	@dstr *d@ = pointer to dynamic string to build result in
 *		@archcons *a@ = list to write into the string
 *		@unsigned and@, @unsigned xor@ = flags to look for
 *
 * Returns:	---
 *
 * Use:		Writes a textual list of architectures to a string.  This can
 *		then be used (for example) as the `only-arch' list in the
 *		info file, by filling it into a skeleton and calling
 *		@swinfo_update@.  The @and@ and @xor@ arguments work in the
 *		same way as with @arch_filter@.
 */

extern void arch_toText(dstr */*d*/, archcons */*a*/,
			unsigned /*and*/, unsigned /*xor*/);

/* --- Subcommands --- */

extern int sw_arch(int /*argc*/, char */*argv*/[]);
extern int sw_listarch(int /*argc*/, char */*argv*/[]);
extern int sw_host(int /*argc*/, char */*argv*/[]);
extern int sw_only(int /*argc*/, char */*argv*/[]);
extern int sw_all(int /*argc*/, char */*argv*/[]);

#ifdef CMD_LINK
   static cmd cmd_only = {
     CMD_LINK, "only-arch", sw_only,
"only-arch ARCH,...\n\
	Restrict builds to a selection of architectures.  (This option is\n\
	persistent.  An `--arch' command-line option takes precedence,\n\
	though.)\n"
   };
   static cmd cmd_all = {
     &cmd_only, "all-arch", sw_all,
"all-arch\n\
	Clears the `only-arch' list.  Subsequent builds occur across all\n\
	architectures.\n"
   };
   static cmd cmd_host = {
     &cmd_all, "host", sw_host,
"host ARCH\n\
	Display the name of a host supporting architecture ARCH.\n"
   };
   static cmd cmd_listarch = {
     &cmd_host, "listarch", sw_listarch,
"listarch\n\
	Display a list of all architectures known.\n"
   };
   static cmd cmd_arch = {
     &cmd_listarch, "arch", sw_arch,
"arch\tDisplay the architecture name of the current host.\n"
   };
#  undef CMD_LINK
#  define CMD_LINK &cmd_arch
#endif

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

#ifdef __cplusplus
  }
#endif

#endif