lambdamoo/version.c

/******************************************************************************
  Copyright (c) 1992, 1995, 1996 Xerox Corporation.  All rights reserved.
  Portions of this code were written by Stephen White, aka ghond.
  Use and copying of this software and preparation of derivative works based
  upon this software are permitted.  Any distribution of this software or
  derivative works must comply with all applicable United States export
  control laws.  This software is made available AS IS, and Xerox Corporation
  makes no warranty about the software, its performance or its conformity to
  any specification.  Any person obtaining a copy of this software is requested
  to send their name and post office or electronic mail address to:
    Pavel Curtis
    Xerox PARC
    3333 Coyote Hill Rd.
    Palo Alto, CA 94304
    Pavel@Xerox.Com
 *****************************************************************************/

/*
 *  The server_version is a character string containing three decimal numbers
 *  separated by periods:
 *
 *      <major>.<minor>.<release>
 *
 *  The major version number changes very slowly, only when existing MOO code
 *  might stop working, due to an incompatible change in the syntax or
 *  semantics of the programming language, or when an incompatible change is
 *  made to the database format.
 *
 *  The minor version number changes more quickly, whenever an upward-
 *  compatible change is made in the programming language syntax or semantics.
 *  The most common cause of this is the addition of a new kind of expression,
 *  statement, or built-in function.
 *
 *  The release version number changes as frequently as bugs are fixed in the
 *  server code.  Changes in the release number indicate changes that should
 *  only be visible to users as bug fixes, if at all.
 *
 */

#include "version.h"

#include "config.h"
#include "options.h"

#include "structures.h"
#include "list.h"
#include "storage.h"
#include "utils.h"
#include "exceptions.h"
#include "streams.h"
#include "utf-ctype.h"

/*
 * Server executable version
 */

#include "version_make.h"
#include "version_src.h"
#ifndef VERSION_MAJOR
#  define VERSION_MAJOR 1
#  define VERSION_MINOR 9
#  define VERSION_RELEASE 0
#endif
#ifndef VERSION_EXT
#  define VERSION_EXT "+?_ad_hoc_??"
#endif
#ifndef VERSION_STRING
#  define _V(MAJ,MIN,REL) #MAJ "." #MIN "." #REL
#  define _V2(_1,_2,_3) _V(_1,_2,_3)
#  define VERSION_STRING _V2(VERSION_MAJOR,VERSION_MINOR,VERSION_RELEASE) VERSION_EXT
#endif
#ifndef VERSION_SOURCE
#  define VERSION_SOURCE(DEF) DEF(vcs,"unknown")
#endif

const char *server_version = VERSION_STRING;

static Var *version_structure = 0;

static char *dotted_list(Stream *s, uint32_t vn)
{
    stream_printf(s, "%d.%d.%d", vn>>16, (vn>>8)&0xff, vn & 0xff);
    return reset_stream(s);
}

static void
init_version_structure(void)
{

#define SET_INT(W,value)  (W).type = TYPE_INT;  (W).v.num = (value)
#define SET_STR(W,value)  (W).type = TYPE_STR;  (W).v.str = str_dup(value)
#define SET_OBJ(W,value)  (W).type = TYPE_OBJ;  (W).v.obj = (value)
#define SET_VAR(W,value)  (W) = var_ref(value)

#define DEPTH 4

    Var stack[DEPTH];
    Var *the_list = stack;

#define BEGIN_LIST(n)				\
    if (++the_list - stack >= DEPTH)		\
	panic("init_version_structure:  push");	\
    the_list[0] = new_list(n)

#define END_LIST()				\
    if (the_list-- == stack)			\
	panic("init_version_structure:  pop");	\
    the_list[0] = listappend(the_list[0],the_list[1])

#define BEGIN_GROUP(name)			\
    BEGIN_LIST(1);				\
    SET_STR(the_list[0].v.list[1],#name);	\
    BEGIN_LIST(0)

#define END_GROUP()   END_LIST(); END_LIST()

    Var item;

#define PUSH_VALUE(WHAT,value)			\
    SET_##WHAT(item,value);			\
    the_list[0] = listappend(the_list[0], item);

#define PUSH_STR(str)  PUSH_VALUE(STR,str)

#define PUSH_PAIR(name,WHAT,value)		\
    item = new_list(2);				\
    SET_STR(item.v.list[1],name);		\
    SET_##WHAT(item.v.list[2],value);		\
    the_list[0] = listappend(the_list[0], item);

    /* create non-string/int true and false values */
    Var falsev;
    Var truev = new_list(1);
    SET_INT(truev.v.list[1],0);
    SET_OBJ(falsev,-1);

    the_list[0] = new_list(0);
    PUSH_PAIR("major",INT,VERSION_MAJOR);
    PUSH_PAIR("minor",INT,VERSION_MINOR);
    PUSH_PAIR("release",INT,VERSION_RELEASE);
    PUSH_PAIR("ext",STR,VERSION_EXT);
    PUSH_PAIR("string",STR,server_version);

    BEGIN_GROUP(features);
#ifdef VERSION_XTLIST
    VERSION_XTLIST(PUSH_STR);
#endif
    END_GROUP();

    BEGIN_GROUP(options);
#define _DINT(name,value) PUSH_PAIR(name,INT,value)
#define _DSTR(name,value) PUSH_PAIR(name,STR,value)
#define _DDEF(name)       PUSH_PAIR(name,VAR,truev)
#define _DNDEF(name)      PUSH_PAIR(name,VAR,falsev)
#include "version_options.h"
    END_GROUP();

#define _QNDEF(name,value) PUSH_PAIR(#name,STR,value)

#ifdef VERSION_MAKEVARS
    BEGIN_GROUP(make);
    VERSION_MAKEVARS(_QNDEF);
    END_GROUP();
#endif

    BEGIN_GROUP(source);
#ifdef VERSION_SOURCE
    VERSION_SOURCE(_QNDEF);
#endif
    END_GROUP();

#ifdef VERSION_CONFIG
    BEGIN_GROUP(config);
    VERSION_CONFIG(_QNDEF);
    END_GROUP();
#endif
    {
	Stream *ds = new_stream(5);
	BEGIN_GROUP(unicode);
	_DSTR("version",     dotted_list(ds, my_unicode_version()));
	_DSTR("lib",         my_unilib_name);
	_DSTR("lib_version", dotted_list(ds, my_unilib_version()));
	END_GROUP();
	free_stream(ds);
    }

    if (stack != the_list)
	panic("init_version_structure: unpopped stuff");

    free_var(truev);
    free_var(falsev);
    version_structure = the_list[0].v.list;
}

Var
server_version_full(Var arg)
{
    Var r;
    const char *s;
    Var *tree;
    if (!version_structure) {
	init_version_structure();
    }
    if (arg.type != TYPE_STR || arg.v.str[0] == '\0' ) {
	r.type   = TYPE_LIST;
	r.v.list = version_structure;
	return var_ref(r);
    }
    s = arg.v.str;
    tree = version_structure;
    for (;;) {
	/* invariants:
	 *   s is a nonempty string;
	 *   tree has at least one string or {string,_} pair
	 */
	int i = tree[0].v.num;
	const char *e = s;
	while (*e != '/' && *++e != '\0');
	do {
	    --i; ++tree;
	    switch (tree[0].type) {
	    default:
		break;
	    case TYPE_STR:
	        if (memo_strlen(tree[0].v.str) == (size_t)(e - s) &&
		    strncmp(tree[0].v.str, s, e - s) == 0)
		    goto found;
		break;
	    case TYPE_LIST:
		if (tree[0].v.list[0].v.num == 2 &&
		    tree[0].v.list[1].type == TYPE_STR &&
		    memo_strlen(tree[0].v.list[1].v.str) == (size_t)(e - s) &&
		    strncmp(tree[0].v.list[1].v.str, s, e - s) == 0) {

		    if (tree[0].v.list[0].v.num > 1)
			tree = tree[0].v.list + 2;
		    else
			tree = tree[0].v.list + 1;
		    goto found;
		}
		break;
	    }
	} while (i > 0);
	break;
      found:
	s = (*e != '\0' ? e+1 : e); /* skip trailing slash */
	if (*s == '\0')
	    return var_ref(tree[0]);
	if (tree[0].type != TYPE_LIST)
	    break;
	tree = tree[0].v.list;
	if (tree[0].v.num <= 0 ||
	    (tree[1].type != TYPE_STR &&
	     tree[1].type != TYPE_LIST))
	    break;
    }
    r.type  = TYPE_ERR;
    r.v.err = E_INVARG;
    return r;
}

/*
 * Database format version
 */

int
check_db_version(DB_Version version)
{
    return version < Num_DB_Versions;
}