Expunge revision histories in files.

[sw-tools] / src / sw_info.h

/* -*-c-*-
 *
 * $Id: sw_info.h,v 1.2 2004/04/08 01:52:19 mdw Exp $
 *
 * Maintenance of `.sw-info' files
 *
 * (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_INFO_H
#define SW_INFO_H

#ifdef __cplusplus
  extern "C" {
#endif

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

typedef struct swinfo {
  char *package;
  char *version;
  char *maintainer;
  char *date;
  char *only_arch;
  char *arch;
} swinfo;

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

/* --- @swinfo_clear@ --- *
 *
 * Arguments:	@swinfo *sw@ = pointe to info block
 *
 * Returns:	---
 *
 * Use:		Clears an info block so that it doesn't contain anything.
 *		This is mainly useful when building skeletons to apply using
 *		@swinfo_update@.
 */

extern void swinfo_clear(swinfo */*sw*/);

/* --- @swinfo_fetch@ --- *
 *
 * Arguments:	@swinfo *sw@ = pointer to info block to fill in
 *
 * Returns:	Zero if OK, else nonzero.
 *
 * Use:		Fills in the info block if it can.
 */

extern int swinfo_fetch(swinfo */*sw*/);

/* --- @swinfo_sanity@ --- *
 *
 * Arguments:	@swinfo *sw@ = pointer to an info block
 *
 * Returns:	Yes, if the block is OK.
 *
 * Use:		Objects if the information in the info block is bad.
 */

extern void swinfo_sanity(swinfo */*sw*/);

/* --- @swinfo_put@ --- *
 *
 * Arguments:	@swinfo *sw@ = pointer to an info block
 *
 * Returns:	Zero if it worked, nonzero if not.
 *
 * Use:		Writes an info block to the appropriate file.
 */

extern int swinfo_put(swinfo */*sw*/);

/* --- @swinfo_destroy@ --- *
 *
 * Arguments:	@swinfo *sw@ = pointer to info block
 *
 * Returns:	---
 *
 * Use:		Destroys an info block when it's not useful any more.
 */

extern void swinfo_destroy(swinfo */*sw*/);

/* --- @swinfo_update@ --- *
 *
 * Arguments:	@swinfo *sw@ = pointer to info block
 *		@swinfo *skel@ = pointer to skeleton values
 *
 * Returns:	---
 *
 * Use:		Updates the fields in an information block, except for the
 *		architecture names stuff.  (I'll leave that for later,
 *		because it's rather more involved.
 */

extern void swinfo_update(swinfo */*sw*/, swinfo */*skel*/);

/* --- Subcommands --- */

extern int sw_commit(int /*argc*/, char */*argv*/[]);
extern int sw_setup(int /*argc*/, char */*argv*/[]);
extern int sw_status(int /*argc*/, char */*argv*/[]);

#ifdef CMD_LINK
   static cmd cmd_commit = {
     CMD_LINK, "commit", sw_commit,
"commit\tWrites completed version information to the index file.  This\n\
	be the last step of an installation.\n"
   };
   static cmd cmd_status = {
     &cmd_commit, "status", sw_status,
"status\tDisplays information from the package status file.  The output is\n\
	slightly more readable than `cat .sw-info'.\n"
   };
   static cmd cmd_setup = {
     &cmd_status, "setup", sw_setup,
"setup PACKAGE VERSION [MAINTAINER]\n\
	Persistently configures the package and version number.  This\n\
	information is used by the later build and install steps.  If you\n\
	omit the maintainer's name, it's assumed to be your username.\n"
   };
#  undef CMD_LINK
#  define CMD_LINK &cmd_setup
#endif

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

#ifdef __cplusplus
  }
#endif

#endif