Source:NetHack 3.4.3/src/hacklib.c

From NetHackWiki
Jump to navigation Jump to search

Below is the full text to src/hacklib.c from NetHack 3.4.3. To link to a particular line, write [[hacklib.c#line123]], for example.

The C functions in hacklib.c are old but still work. (Today's standard C libraries provide better replacements for some of them.) They provide miscellaneous features such as handling character strings and finding the phase of the moon. The setrandom code to seed the random number generator is also here.

Top of file

/*	SCCS Id: @(#)hacklib.c	3.4	2002/12/13	*/
/* Copyright (c) Stichting Mathematisch Centrum, Amsterdam, 1985. */
/* Copyright (c) Robert Patrick Rankin, 1991		  */
/* NetHack may be freely redistributed.  See license for details. */

The NetHack General Public License applies to screenshots, source code and other content from NetHack.

This content was modified from the original NetHack source code distribution (by splitting up NetHack content between wiki pages, and possibly further editing). See the page history for a list of who changed it, and on what dates. 

/* We could include only config.h, except for the overlay definitions... */
#include "hack.h"
/*=
Assorted 'small' utility routines.	They're virtually independent of
NetHack, except that rounddiv may call panic().

return type     routine name    argument type(s)
	boolean		digit		(char)
	boolean		letter		(char)
	char		highc		(char)
	char		lowc		(char)
	char *		lcase		(char *)
	char *		upstart		(char *)
	char *		mungspaces	(char *)
	char *		eos		(char *)
	char *		strkitten	(char *,char)
	char *		s_suffix	(const char *)
	char *		xcrypt		(const char *, char *)
	boolean		onlyspace	(const char *)
	char *		tabexpand	(char *)
	char *		visctrl		(char)
	const char *	ordin		(int)
	char *		sitoa		(int)
	int		sgn		(int)
	int		rounddiv	(long, int)
	int		distmin		(int, int, int, int)
	int		dist2		(int, int, int, int)
	boolean		online2		(int, int)
	boolean		pmatch		(const char *, const char *)
	int		strncmpi	(const char *, const char *, int)
	char *		strstri		(const char *, const char *)
	boolean		fuzzymatch	(const char *,const char *,const char *,boolean)
	void		setrandom	(void)
	int		getyear		(void)
	char *		yymmdd		(time_t)
	long		yyyymmdd	(time_t)
	int		phase_of_the_moon	(void)
	boolean		friday_13th	(void)
	int		night		(void)
	int		midnight	(void)
=*/
#ifdef LINT
# define Static		/* pacify lint */
#else
# define Static static
#endif

digit

The digit function tests if the character is a digit, any of 0 to 9 in ASCII. If we rewrote NetHack today, we would instead use the isdigit function provided by ANSI C. 

#ifdef OVLB
boolean
digit(c)		/* is 'c' a digit? */
char c;
{
return((boolean)('0' <= c && c <= '9'));
}

letter

The letter function tests if the character is a letter. One would use isalpha, but this letter function has the caveat that @ (which is the character before A) in ASCII counts as a letter, in addition to the uppercase and lowercase letters. Thus most monsters are letters, but punctuation including lizards : and sea creatures ; are not letters. 

boolean
letter(c)		/* is 'c' a letter?  note: '@' classed as letter */
char c;
{
return((boolean)(('@' <= c && c <= 'Z') || ('a' <= c && c <= 'z')));
}
#endif /* OVLB */

highc

The highc function converts any character to uppercase. It converts 'a' to 'z' into uppercase, but copies any other character. Today we would use toupper in ANSI C. 

#ifdef OVL1
char
highc(c)			/* force 'c' into uppercase */
char c;
{
return((char)(('a' <= c && c <= 'z') ? (c & ~040) : c));
}

lowc

The lowc function converts any character to lowercase, the opposite but not the inverse of highc. Today we would use tolower in ANSI C. 

char
lowc(c)			/* force 'c' into lowercase */
char c;
{
return((char)(('A' <= c && c <= 'Z') ? (c | 040) : c));
}
#endif /* OVL1 */

lcase

The lcase function converts a string buffer to lowercase in place, by overwriting not copying the string. To follow ANSI C, we could rewrite this using tolower. 

#ifdef OVLB
char *
lcase(s)		/* convert a string into all lowercase */
char *s;
{
register char *p;

for (p = s; *p; p++)
	if ('A' <= *p && *p <= 'Z') *p |= 040;
return s;
}

The rewritten version would be: 

/* not part of hacklib.c */
#include <ctype.h>
char *
lcase(char *s)
{
    char* p;
    for(p = s; *p; p++)
	*p = tolower(*p);
    return s;
}

The old version works if the character set is ASCII, and might be more efficient if the C compiler does not optimise well. The rewritten version is easier to understand, but there is no reason for us to replace the old lcase function that already does best.

upstart

The upstart function uppercases the first letter of a string buffer in place (by overwriting and not copying). We need this when placing nouns for monsters like "it" and "the newt" at the beginning of a sentence. 

char *
upstart(s)		/* convert first character of a string to uppercase */
char *s;
{
if (s) *s = highc(*s);
return s;
}

The if statement upon line 101 ensures that upstart((char *)0) does not dereference a null pointer. Though it is best to be safe, this check was probably unnecessary because in general we should only pass '\0'-terminated strings to functions like these.

mungspaces

The mungspaces function condenses each group of consecutive spaces or tabs (of a string buffer) into a single space in place (by overwriting and not copying). It also trims the spaces and tabs from the beginning and end of the buffer. 

/* remove excess whitespace from a string buffer (in place) */
char *
mungspaces(bp)
char *bp;
{
register char c, *p, *p2;
boolean was_space = TRUE;

for (p = p2 = bp; (c = *p) != '\0'; p++) {
	if (c == '\t') c = ' ';
	if (c != ' ' || !was_space) *p2++ = c;
	was_space = (c == ' ');
}
if (was_space && p2 > bp) p2--;
*p2 = '\0';
return bp;
}

#endif /* OVLB */

To make that code easier to read, here is a pretty version: 

/* not part of hacklib.c */
char *
mungspaces(char *bp)
{
    char c, *p, *p2;
    boolean was_space = TRUE; /* trim beginning of string */

    p = p2 = bp;
    while ((c = *p) != '\0') { /* until p is end of string */
	if (c == '\t') c = ' ';
	if (c != ' ' || !was_space) {
	    *p2 = c; /* copy it */
	    p2++;
	}
	was_space = (c == ' ');
	p++;
    }

    if (was_space && p2 > bp) p2--; /* trim end of string */
    *p2 = '\0';
    return bp;
}

The mungspaces function is slightly less safe than the upstart function because mungspaces((char *)0) will dereference the null pointer. However mungspaces("") will work because the p2 > bp prevents us from trying to write a '\0' before the start of the buffer.

eos

Given some string, the eos function returns a pointer to the '\0' that terminates it. 

#ifdef OVL0
char *
eos(s)			/* return the end of a string (pointing at '\0') */
register char *s;
{
while (*s) s++;	/* s += strlen(s); */
return s;
}

As the comment on line 130 shows, one could just do s += strlen(s). Someone must have thought that it was a waste of performance to count the number of times we do s++ as strlen would do. Some C compilers will optimise when they see strlen, but the developers wrote NetHack for older compilers.

strkitten

The strkitten function is a baby version of strcat that has less experience points and a weaker attack; see kitten, cat.

Actually, strkitten concatenates a single character to the end of a string. Like the strcat, the strkitten modifies the string being appended to. This function uses the eos function defined above. 

/* strcat(s, {c,'\0'}); */
char *
strkitten(s, c)		/* append a character to a string (in place) */
char *s;
char c;
{
char *p = eos(s);

*p++ = c;
*p = '\0';
return s;
}

It is important to not use the strkitten function if your buffer does not have room for one more character!

s_suffix

The s_suffix function converts a string (typically naming a monster) to the possessive form, for example gnome to gnome's. Unlike many of the above functions, this one creates a new string instead of modifying the original string in place. 

char *
s_suffix(s)		/* return a name converted to possessive */
const char *s;
{
Static char buf[BUFSZ];

Strcpy(buf, s);
if(!strcmpi(buf, "it"))
	Strcat(buf, "s");
else if(*(eos(buf)-1) == 's')
	Strcat(buf, "'");
else
	Strcat(buf, "'s");
return buf;
}

From the above code, we determine the following rules:

  • it has s appended (as it to its, It to Its)
  • names ending in s have apostrophe appended (as "Orcus" to "Orcus'")
  • other names have s and apostrophe appended (as the gnome to the gnome's)

Unlike strcpy, this s_suffix function does not take a buffer for the new string as a parameter. Instead, s_suffix places the posessive string in its own static buffer. This has two consequences:

  • String longer than BUFSZ-1 would overflow, so we must not use very long names.
  • We can have only one possessive noun at each time. This translates the rule that whenever we call pline or any of its variants in pline.c, we can use s_suffix only once, for example "You eat the gnome's brain!" (uhitm.c#line1537) Using a second possessive from a different function like Your or mhis (a macro in you.h) does not count, for example "The gnome's helmet blocks your attack to her head!"

Programmers that use languages with garbage collection (as in Java or Perl) would write s_suffix to dynamically allocate the buffer containing the possessive noun, and not need to later free it.

xcrypt

The xcrypt function decodes the Oracle messages and rumors stored in NetHack's playground. When building NetHack, makedefs hid that information so that players looking in the playground would not become spoiled. Though the cipher is symmetric (so that encoding and decoding use the same function), makedefs has its own copy of the xcrypt function.

You pass the input string as the first argument str and an output buffer as the second argument buf; this is the reverse of the order that you would expect from strcpy and memcpy. 

char *
xcrypt(str, buf)	/* trivial text encryption routine (see makedefs) */
const char *str;
char *buf;
{
register const char *p;
register char *q;
register int bitmask;

for (bitmask = 1, p = str, q = buf; *p; q++) {
	*q = *p++;
	if (*q & (32|64)) *q ^= bitmask;
	if ((bitmask <<= 1) >= 32) bitmask = 1;
}
*q = '\0';
return buf;
}
#endif /* OVL0 */

As do some other symmetric ciphers, the xcrypt generates a stream of data, then exclusive-ors the generated stream with the ciphertext to decode it (or with the plaintext to encode it). Because xcrypt does not use a secret key to seed a secure random number generator, xcrypt provides only trivial security, though xcrypt does better than ROT13.

onlyspace

The onlyspace function tests if the string contains only spaces and tabs. The mungspaces function would transform such a string to the empty string "". 

#ifdef OVL2
boolean
onlyspace(s)		/* is a string entirely whitespace? */
const char *s;
{
for (; *s; s++)
	if (*s != ' ' && *s != '\t') return FALSE;
return TRUE;
}
#endif /* OVL2 */

tabexpand

The tabexpand function replaces tabs with spaces, as if the tab advanced to the next column and the colums were 8 characters wide. It does this expansion in place. (Actually, it does the expansion in its internal buffer, then copies the result overwriting the input buffer.)

The input buffer sbuf needs to be at least BUFSZ large to keep room for the expansion. The internal buffer char buf[BUFSZ] prevents tabexpand from handling longer expansions. 

#ifdef OVLB
char *
tabexpand(sbuf)		/* expand tabs into proper number of spaces */
char *sbuf;
{
char buf[BUFSZ];
register char *bp, *s = sbuf;
register int idx;

if (!*s) return sbuf;

/* warning: no bounds checking performed */
for (bp = buf, idx = 0; *s; s++)
	if (*s == '\t') {
	    do *bp++ = ' '; while (++idx % 8);
	} else {
	    *bp++ = *s;
	    idx++;
	}
*bp = 0;
return strcpy(sbuf, buf);
}

The tabexpand function overflows if the expansion is larger than BUFSZ-1 characters. A string containing only 32 tabs would overflow the buffer when BUFSZ is 256. The comment upon line 204 warns that the function will not check against overflow, even though the programmer knew that buf holds only BUFSZ bytes.

NetHack uses tabexpand when displaying from files that contain tabs.

visctrl

The visctrl character formats an ASCII character as a visible string. Control characters are formatted like ^B by using a caret ^ and a bit flip. (This is exactly how many Unix commands (like cat -v) and Unix editors would display them.) All other characters are copied. 

char *
visctrl(c)		/* make a displayable string from a character */
char c;
{
Static char ccc[3];

c &= 0177;

ccc[2] = '\0';
if (c < 040) {
	ccc[0] = '^';
	ccc[1] = c | 0100;	/* letter */
} else if (c == 0177) {
	ccc[0] = '^';
	ccc[1] = c & ~0100;	/* '?' */
} else {
	ccc[0] = c;		/* printable character */
	ccc[1] = '\0';
}
return ccc;
}
#endif /* OVLB */
Input Output
ASCII control characters from 0 to 31 (octal 0 to 040) caret and control character plus 64 (octoal 0100)
^@, ^A, ^B ... ^Y, ^Z, ^[, ^\, ^], ^^, ^_
ASCII delete character 127 (octal 0177) caret and question mark 63 (octal 077)
^?
all other characters, including spaces and characters above 127 (8-bit meta characters) copied from input

Because visctrl outputs into an internal buffer, we follow the rule of one control character per sentence fragment, similar to the rule for using s_suffix.

The BSD C library provides a function vis that does something similar. Upon BSD (but not most other platforms!), we could rewrite the visctrl function this way: 

/* not part of hacklib.c */
#include <vis.h>
char *
visctrl(char c)
{
    static char ccc[3];
    vis(ccc, c, VIS_TAB | VIS_NL | VIS_NOSLASH, 0);
    return ccc;
}

The rewritten visctrl also formats meta-characters like M-B.

ordin

The ordin function returns the string constant "st" or "nd" or "rd" suffix for a number. 

#ifdef OVL2
const char *
ordin(n)		/* return the ordinal suffix of a number */
int n;			/* note: should be non-negative */
{
register int dd = n % 10;

return (dd == 0 || dd > 3 || (n % 100) / 10 == 1) ? "th" :
	    (dd == 1) ? "st" : (dd == 2) ? "nd" : "rd";
}
#endif /* OVL2 */

The string from ordin does not include the number, but it should be easy to use pline or snprintf to print the number: 

pline("%d%s", i, ordin(i));

sitoa

The sitoa function converts an integer to ASCII, including the sign. It uses sprintf with either "%d" or "+%d", including the + for any nonnegative number. (This should use snprintf and check for overflow, but older systems do not have snprintf and the INT_MIN of -2147483648 or INT_MAX of +2147483647 fit in 12 bytes.) 

#ifdef OVL1
char *
sitoa(n)		/* make a signed digit string from a number */
int n;
{
Static char buf[13];

Sprintf(buf, (n < 0) ? "%d" : "+%d", n);
return buf;
}

The name of sitoa is short for signed integer to ascii. It is named for "itoa", the inverse of atoi. (There is no "itoa" function in NetHack or the C library.)

sgn

The sgn function extracts the sign from an integer, returning either -1 or 0 or 1. Though this is a common function (and there is a Wikipedia entry for sign function), it is not in the C library. 

int
sgn(n)			/* return the sign of a number: -1, 0, or 1 */
int n;
{
return (n < 0) ? -1 : (n != 0);
}
#endif /* OVL1 */

This could easily have been a macro function buried in global.h, like so many other simple functions from NetHack: 

/* not in NetHack */
#define sgn(n) (((n) < 0) ? -1 : ((n) != 0))

rounddiv

The rounddiv function computes x divided by y, rounding the quotient toward the nearest integer, rounding multiples of 1/2 away from zero. For example,

  • rounddiv((long)4, 2) yields 2
  • rounddiv((long)-14, 3) yields 5
  • rounddiv((long)5, 2) yields 3
  • rounddiv((long)-5, 2) yields -3

NetHack has exactly one call to rounddiv; that is somewhere in eat.c. 

#ifdef OVLB
int
rounddiv(x, y)		/* calculate x/y, rounding as appropriate */
long x;
int  y;
{
int r, m;
int divsgn = 1;

if (y == 0)
	panic("division by zero in rounddiv");
else if (y < 0) {
	divsgn = -divsgn;  y = -y;
}
if (x < 0) {
	divsgn = -divsgn;  x = -x;
}
r = x / y;
m = x % y;
if (2*m >= y) r++;

return divsgn * r;
}
#endif /* OVLB */

The procedure is simple:

  1. If denominator y is zero, panic.
  2. Make x and y nonnegative, saving the sign in divsgn.
  3. Divide x by y to set quotient r.
  4. Compute x modulo y to set remainder m.
  5. If twice m is at least y, then add 1 to r (thus rounding it).
  6. Return divsgn times quotient r.

Today, one could use the ANSI C ldiv function integer division, however it rounds toward zero and is of no use to us.

A peculiar feature of rounddiv in NetHack is that it takes numerator x as a long but takes denominator y as an int and returns an int. It would be wrong to pass an int as x without widening it to a long. There is a (long) cast in the call to rounddiv from eat.c. (Today, everyone has ANSI C or ISO C prototypes, and the compiler will see long in the prototype and do a cast. On some systems, int and long have the same width.)

distmin

The distmin function computes the number of moves in the shortest path between two points in the dungeon, using the formula: 

distmin[(x0,y0),(x1,y1)] = max[ |x0-x1|, |y0-y1| ]

Horizontal, vertical and diagonal moves each have a move of length one. If |x0-x1| > |y0-y1|, we need only horizontal and diagonal moves, so we count only |x0-x1| moves. 

#ifdef OVL0
int
distmin(x0, y0, x1, y1) /* distance between two points, in moves */
int x0, y0, x1, y1;
{
register int dx = x0 - x1, dy = y0 - y1;
if (dx < 0) dx = -dx;
if (dy < 0) dy = -dy;
/*  The minimum number of moves to get from (x0,y0) to (x1,y1) is the
:  larger of the [absolute value of the] two deltas.
*/
return (dx < dy) ? dy : dx;
}

The mindist function gives a minimum distance in a sufficiently open dungeon, or with a cursor that ignores obstacles. In a dungeon that actually has walls, monsters, traps and other obstacles, an adventurer may need more moves.

dist2

The dist2 returns the distance squared between two points in the dungeon using Pythagoras' famous theorem. 

int
dist2(x0, y0, x1, y1)	/* square of euclidean distance between pair of pts */
int x0, y0, x1, y1;
{
register int dx = x0 - x1, dy = y0 - y1;
return dx * dx + dy * dy;
}

The returned distance is in square squares! We take the unit to be "squares", because each dungeon square has sides of length 1. Take the distance between two dungeon squares in squares, and multiply it by itself, squaring it, yielding square squares. This leads to the important corollary,

Some squares are not square.

To find the actual distance between two squares, we would need to take the square root. This would either involve floating-point arithmetic or the digging of a tree. The dist2 square squares are square enough for ordered comparisons.

Both distmin and dist2 have several uses throughout the source code of NetHack. Sometimes, two horizontal moves have as much length as two diagonal moves, but sometimes the diagonal moves have more length.

In fact, the 2 in dist2 does not refer to the squaring, but to the 2 points in the arguments. The hack.h file has a distu macro that supplies your position as one of the points.

online2

The online2 function answers the question, can I shoot you? If I am a kobold, but you the adventurer are not on the same horizontal, vertical or diagonal as me, then I will not throw my darts. 

boolean
online2(x0, y0, x1, y1) /* are two points lined up (on a straight line)? */
int x0, y0, x1, y1;
{
int dx = x0 - x1, dy = y0 - y1;
/*  If either delta is zero then they're on an orthogonal line,
*  else if the deltas are equal (signs ignored) they're on a diagonal.
*/
return((boolean)(!dy || !dx || (dy == dx) || (dy + dx == 0)));	/* (dy == -dx) */
}

#endif /* OVL0 */

The onlineu macro in hack.h supplies your position as one of the arguments.

pmatch

Wikipedia
Wikipedia has an article about:

The pmatch is a simple pattern matcher that treats the characters * and ? like the Unix shell. That is, a * in the pattern matches any zero or more characters in the string, while a ? in the pattern matches any one character in the string.

NetHack rarely uses this function, but there are a few calls to pmatch in pager.c, pickup.c and sounds.c. 

#ifdef OVLB

boolean
pmatch(patrn, strng)	/* match a string against a pattern */
const char *patrn, *strng;
{
char s, p;
/*
:  Simple pattern matcher:  '*' matches 0 or more characters, '?' matches
:  any single character.  Returns TRUE if 'strng' matches 'patrn'.
*/
pmatch_top:
s = *strng++;  p = *patrn++;	/* get next chars and pre-advance */
if (!p)			/* end of pattern */
	return((boolean)(s == '\0'));		/* matches iff end of string too */
else if (p == '*')		/* wildcard reached */
	return((boolean)((!*patrn || pmatch(patrn, strng-1)) ? TRUE :
		s ? pmatch(patrn-1, strng) : FALSE));
else if (p != s && (p != '?' || !s))  /* check single character */
	return FALSE;		/* doesn't match */
else				/* return pmatch(patrn, strng); */
	goto pmatch_top;	/* optimize tail recursion */
}
#endif /* OVLB */

The comments in the source explain how it works. The function returns either TRUE or FALSE, those constants having been defined in global.h. The goto statement of line 350, along with the ++ operators of 341, "optimize tail recursion" into iteration, though some compilers can also do this. A while loop or for loop might have made an easier read.

We could rewrite this function with the fnmatch function in the C libraries of Unix systems: 

/* not part of NetHack */
#include <fnmatch.h>
#include <stdbool.h> /* C99 bool type */
bool pmatch(const char *patrn, const char *strng)
{
    int r;

    r = fnmatch(patrn, strng, FNM_NOESCAPE);
    if (r == FNM_NOMATCH)
	return false;
    else
	return true;
}

But then:

  • the square brackets [ and ] would also have special meanings in the pattern.
  • the function would not be portable.

strncmpi

#ifdef OVL2
#ifndef STRNCMPI
int
strncmpi(s1, s2, n)	/* case insensitive counted string comparison */
register const char *s1, *s2;
register int n; /*(should probably be size_t, which is usually unsigned)*/
{					/*{ aka strncasecmp }*/
register char t1, t2;

while (n--) {
	if (!*s2) return (*s1 != 0);	/* s1 >= s2 */
	else if (!*s1) return -1;	/* s1  < s2 */
	t1 = lowc(*s1++);
	t2 = lowc(*s2++);
	if (t1 != t2) return (t1 > t2) ? 1 : -1;
}
return 0;				/* s1 == s2 */
}
#endif	/* STRNCMPI */
#endif /* OVL2 */

strncmpi() compares the first n characters of the two strings s1 and s2, ignoring case.

strstri

#ifdef OVLB
#ifndef STRSTRI

char *
strstri(str, sub)	/* case insensitive substring search */
const char *str;
const char *sub;
{
register const char *s1, *s2;
register int i, k;
# define TABSIZ 0x20	/* 0x40 would be case-sensitive */
char tstr[TABSIZ], tsub[TABSIZ];	/* nibble count tables */
# if 0
assert( (TABSIZ & ~(TABSIZ-1)) == TABSIZ ); /* must be exact power of 2 */
assert( &lowc != 0 );			/* can't be unsafe macro */
# endif

/* special case: empty substring */
if (!*sub)	return (char *) str;

/* do some useful work while determining relative lengths */
for (i = 0; i < TABSIZ; i++)  tstr[i] = tsub[i] = 0;	/* init */
for (k = 0, s1 = str; *s1; k++)  tstr[*s1++ & (TABSIZ-1)]++;
for (	s2 = sub; *s2; --k)  tsub[*s2++ & (TABSIZ-1)]++;

/* evaluate the info we've collected */
if (k < 0)	return (char *) 0;  /* sub longer than str, so can't match */
for (i = 0; i < TABSIZ; i++)	/* does sub have more 'x's than str? */
	if (tsub[i] > tstr[i])	return (char *) 0;  /* match not possible */

/* now actually compare the substring repeatedly to parts of the string */
for (i = 0; i <= k; i++) {
	s1 = &str[i];
	s2 = sub;
	while (lowc(*s1++) == lowc(*s2++))
	    if (!*s2)  return (char *) &str[i];		/* full match */
}
return (char *) 0;	/* not found */
}
#endif	/* STRSTRI */

fuzzymatch

/* compare two strings for equality, ignoring the presence of specified
characters (typically whitespace) and possibly ignoring case */
boolean
fuzzymatch(s1, s2, ignore_chars, caseblind)
const char *s1, *s2;
const char *ignore_chars;
boolean caseblind;
{
register char c1, c2;

do {
	while ((c1 = *s1++) != '\0' && index(ignore_chars, c1) != 0) continue;
	while ((c2 = *s2++) != '\0' && index(ignore_chars, c2) != 0) continue;
	if (!c1 || !c2) break;	/* stop when end of either string is reached */

	if (caseblind) {
	    c1 = lowc(c1);
	    c2 = lowc(c2);
	}
} while (c1 == c2);

/* match occurs only when the end of both strings has been reached */
return (boolean)(!c1 && !c2);
}

#endif /* OVLB */

Time routines

#ifdef OVL2

/*
* Time routines
*
* The time is used for:
*	- seed for rand()
*	- year on tombstone and yyyymmdd in record file
*	- phase of the moon (various monsters react to NEW_MOON or FULL_MOON)
*	- night and midnight (the undead are dangerous at midnight)
*	- determination of what files are "very old"
*/

#if defined(AMIGA) && !defined(AZTEC_C) && !defined(__SASC_60) && !defined(_DCC) && !defined(__GNUC__)
extern struct tm *FDECL(localtime,(time_t *));
#endif
static struct tm *NDECL(getlt);

setrandom

void
setrandom()
{
	/* the types are different enough here that sweeping the different
	 * routine names into one via #defines is even more confusing
	 */
#ifdef RANDOM	/* srandom() from sys/share/random.c */
	srandom((unsigned int) time((time_t *)0));
#else
# if defined(__APPLE__) || defined(BSD) || defined(LINUX) || defined(ULTRIX) || defined(CYGWIN32) /* system srandom() */
#  if defined(BSD) && !defined(POSIX_TYPES)
#   if defined(SUNOS4)
	(void)
#   endif
		srandom((int) time((long *)0));
#  else
		srandom((int) time((time_t *)0));
#  endif
# else
#  ifdef UNIX	/* system srand48() */
	srand48((long) time((time_t *)0));
#  else		/* poor quality system routine */
	srand((int) time((time_t *)0));
#  endif
# endif
#endif
}

getlt

static struct tm *
getlt()
{
	time_t date;

#if defined(BSD) && !defined(POSIX_TYPES)
	(void) time((long *)(&date));
#else
	(void) time(&date);
#endif
#if (defined(ULTRIX) && !(defined(ULTRIX_PROTO) || defined(NHSTDC))) || (defined(BSD) && !defined(POSIX_TYPES))
	return(localtime((long *)(&date)));
#else
	return(localtime(&date));
#endif
}

getyear

int
getyear()
{
	return(1900 + getlt()->tm_year);
}

yymmdd

#if 0
/* This routine is no longer used since in 2000 it will yield "100mmdd". */
char *
yymmdd(date)
time_t date;
{
	Static char datestr[10];
	struct tm *lt;

	if (date == 0)
		lt = getlt();
	else
#if (defined(ULTRIX) && !(defined(ULTRIX_PROTO) || defined(NHSTDC))) || defined(BSD)
		lt = localtime((long *)(&date));
#else
		lt = localtime(&date);
#endif

	Sprintf(datestr, "%02d%02d%02d",
		lt->tm_year, lt->tm_mon + 1, lt->tm_mday);
	return(datestr);
}
#endif

yyyymmdd

long
yyyymmdd(date)
time_t date;
{
	long datenum;
	struct tm *lt;

	if (date == 0)
		lt = getlt();
	else
#if (defined(ULTRIX) && !(defined(ULTRIX_PROTO) || defined(NHSTDC))) || (defined(BSD) && !defined(POSIX_TYPES))
		lt = localtime((long *)(&date));
#else
		lt = localtime(&date);
#endif

	/* just in case somebody's localtime supplies (year % 100)
	   rather than the expected (year - 1900) */
	if (lt->tm_year < 70)
	    datenum = (long)lt->tm_year + 2000L;
	else
	    datenum = (long)lt->tm_year + 1900L;
	/* yyyy --> yyyymm */
	datenum = datenum * 100L + (long)(lt->tm_mon + 1);
	/* yyyymm --> yyyymmdd */
	datenum = datenum * 100L + (long)lt->tm_mday;
	return datenum;
}

phase_of_the_moon

/*
* moon period = 29.53058 days ~= 30, year = 365.2422 days
* days moon phase advances on first day of year compared to preceding year
*	= 365.2422 - 12*29.53058 ~= 11
* years in Metonic cycle (time until same phases fall on the same days of
*	the month) = 18.6 ~= 19
* moon phase on first day of year (epact) ~= (11*(year%19) + 29) % 30
*	(29 as initial condition)
* current phase in days = first day phase + days elapsed in year
* 6 moons ~= 177 days
* 177 ~= 8 reported phases * 22
* + 11/22 for rounding
*/
int
phase_of_the_moon()		/* 0-7, with 0: new, 4: full */
{
	register struct tm *lt = getlt();
	register int epact, diy, goldn;

	diy = lt->tm_yday;
	goldn = (lt->tm_year % 19) + 1;
	epact = (11 * goldn + 18) % 30;
	if ((epact == 25 && goldn > 11) || epact == 24)
		epact++;

	return( (((((diy + epact) * 6) + 11) % 177) / 22) & 7 );
}

friday_13th

boolean
friday_13th()
{
	register struct tm *lt = getlt();

	return((boolean)(lt->tm_wday == 5 /* friday */ && lt->tm_mday == 13));
}

night

int
night()
{
	register int hour = getlt()->tm_hour;

	return(hour < 6 || hour > 21);
}

midnight

int
midnight()
{
	return(getlt()->tm_hour == 0);
}
#endif /* OVL2 */

/*hacklib.c*/
Retrieved from "https://nethackwiki.com/index.php?title=Source:NetHack_3.4.3/src/hacklib.c&oldid=69520"