Return to arch.h CVS log

Up to [local] / src / usr.bin / make

Mostly clean-up:
- cut up those huge include files into separate interfaces for all modules.
Put the interface documentation there, and not with the implementation.
- light-weight includes for needed concrete types (lst_t.h, timestamp_t.h).
- cut out some more logically separate parts: cmd_exec, varname, parsevar,
timestamp.
- put all error handling functions together, so that we will be able to
clean them up.
- more systematic naming: functioni  to handle interval, function to handle
string.
- put the init/end code apart to minimize coupling.
- kill weird types like ReturnStatus and Boolean. Use standard bool (with a
fallback for non-iso systems)
- better interface documentation for lots of subsystems.

As a result, make compilation goes somewhat faster (5%, even considering
the largish BSD copyrights to read). The corresponding preprocessed
source goes down from 1,5M to 1M.

A few minor code changes as well: Parse_DoVar is no longer destructive.
Parse_IsVar functionality is folded into Parse_DoVar (as it knows what an
assignment is), a few more interval handling functions. Avoid calling
XXX_End when they do nothing, just #define XXX_End   to nothing.

Parse_DoVar is slightly more general: it will handle compound assignments
as long as they make sense, e.g., VAR +!= cmd
will work.  As a side effect, VAR++=value now triggers an error
(two + in assignment).
- this stuff doesn't occur in portable Makefiles.
- writing VAR++ = value or VAR+ +=value  disambiguates it.
- this is a good thing, it uncovered a bug in bsd.port.mk.

Tested by naddy@. Okayed millert@. I'll handle the fallback if there is
any. This went through a full make build anyways, including isakmpd
(without mickey's custom binutils, as he didn't see fit to share it with me).

#ifndef ARCH_H
#define ARCH_H
/*	$OpenPackages$ */
/*	$OpenBSD: arch.h,v 1.1 2001/05/23 12:34:40 espie Exp $ */

/*
 * Copyright (c) 2001 Marc Espie.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE OPENBSD PROJECT AND CONTRIBUTORS
 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OPENBSD
 * PROJECT OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

/*-
 * arch --
 *	Functions to manipulate libraries, archives and their members.
 */

#ifndef TIMESTAMP_TYPE
#include "timestamp_t.h"
#endif

/* Initialization and cleanup */
extern void Arch_Init(void);
#ifdef CLEANUP
extern void Arch_End(void);
#else
#define Arch_End()
#endif

/* ok = Arch_ParseArchive(&begin, nodeLst, ctxt);
 *	Given an archive specification, add list of corresponding GNodes to
 *	nodeLst, one for each member in the spec.  
 *	false is returned if the specification is invalid for some reason.
 *	Side-effect: begin is bumped to the end of the specification.  */
extern bool Arch_ParseArchive(char **, Lst, SymTable *);
/* Arch_Touch(node);
 *	Alter the modification time of the archive member described by node 
 *	to the current time.  */
extern void Arch_Touch(GNode *);
/* Arch_TouchLib(node);
 *	Update the modification time of the library described by node. 
 *	This is distinct from Arch_Touch, as it also updates the mtime
 *	of the library's table of contents.  */
extern void Arch_TouchLib(GNode *);
/* stamp = Arch_MTime(node);		
 *	Find the modification time of a member of an archive *in the
 *	archive*, and returns it.
 *	The time is also stored in the member's GNode.  */
extern TIMESTAMP Arch_MTime(GNode *);
/* stamp = Arch_MemMTime(node);		
 *	Find the modification time of a member of an archive and returns it. 
 *	To use when the member only exists within the archive.  */
extern TIMESTAMP Arch_MemMTime(GNode *);
/* Arch_FindLib(node, path);
 *	Search for a library node along a path, and fills the gnode's path
 *	field to the actual complete path. If we don't find it, we set the
 *	library name to libname.a, assuming some other mechanism will take
 *	care of finding it.  The library name should be in -l<name> format.  */
extern void Arch_FindLib(GNode *, Lst);
/* bool = Arch_LibOODate(node);
 *	Decide whether a library node is out-of-date. */
extern bool Arch_LibOODate(GNode *);

/* bool = Arch_IsLib(node);
 *	Decide whether a node is a library.  */
extern bool Arch_IsLib(GNode *);

#endif