/* origin.c -- tracking location from which lists were read

   Copyright (C) 2001 John Harper <jsh@pixelslut.com>

   $Id$

   This file is part of librep.

   librep 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, or (at your option)
   any later version.

   librep 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 librep; see the file COPYING.  If not, write to
   the Free Software Foundation, 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.  */

#define _GNU_SOURCE

#include "repint.h"

typedef struct origin_item origin_item;
struct origin_item {
    origin_item *next;
    repv form;
    repv file;
    long line;
};

#define BLOCK_SIZE (4084 / sizeof (struct origin_item))

typedef struct origin_block origin_block;
struct origin_block {
    origin_block *next;
    struct origin_item items[BLOCK_SIZE];
};

static origin_item *free_list;
static origin_block *block_list;
static repv guardian;

rep_bool rep_record_origins;

#define HASH_SIZE 1024
#define HASH(x) (((x) >> 3) % HASH_SIZE)

static origin_item *buckets[HASH_SIZE];

static void
new_item_block (void)
{
    origin_block *b;
    int i;
    b = rep_alloc (sizeof (origin_block));
    for (i = 0; i < (BLOCK_SIZE - 1); i++)
	b->items[i].next = &(b->items[i+1]);
    b->items[i].next = free_list;
    free_list = &(b->items[0]);

    b->next = block_list;
    block_list = b;
}

void
rep_record_origin (repv form, repv stream, long start_line)
{
    origin_item *item;

    if (!rep_record_origins
	|| !rep_CONSP (form)
	|| !rep_FILEP (stream)
	|| (rep_FILE (stream)->car & rep_LFF_BOGUS_LINE_NUMBER) != 0)
    {
	/* nothing to record here */
	return;
    }

    if (free_list == 0)
	new_item_block ();

    item = free_list;
    free_list = item->next;

    item->form = form;
    item->file = rep_FILE (stream)->name;
    item->line = (start_line > 0
		  ? start_line : rep_FILE (stream)->line_number);

    item->next = buckets[HASH (form)];
    buckets[HASH (form)] = item;

    Fprimitive_guardian_push (guardian, form);
}

DEFUN ("call-with-lexical-origins", Fcall_with_lexical_origins,
       Scall_with_lexical_origins, (repv thunk), rep_Subr1)
{
    rep_bool old_record_origins = rep_record_origins;
    repv result;

    rep_record_origins = rep_TRUE;
    result = rep_call_lisp0 (thunk);
    rep_record_origins = old_record_origins;

    return result;
}

DEFUN ("lexical-origin", Flexical_origin,
       Slexical_origin, (repv form), rep_Subr1)
{
    origin_item *item;

    if (rep_FUNARGP (form))
	form = rep_FUNARG (form)->fun;

    if (!rep_CONSP (form))
	return Qnil;

    for (item = buckets[HASH (form)]; item != 0; item = item->next)
    {
	if (item->form == form)
	    return Fcons (item->file, rep_make_long_int (item->line));
    }

    /* no direct hit, scan into the list */
    while (rep_CONSP (form))
    {
	repv out = Flexical_origin (rep_CAR (form));
	if (out != Qnil)
	    return out;
	form = rep_CDR (form);
    }

    return Qnil;
}

void
rep_mark_origins (void)
{
    int i;
    rep_MARKVAL (guardian);
    for (i = 0; i < HASH_SIZE; i++)
    {
	origin_item *item;
	for (item = buckets[i]; item != 0; item = item->next)
	    rep_MARKVAL (item->file);
    }
}

DEFUN ("origin-after-gc", Forigin_after_gc, Sorigin_after_gc, (void), rep_Subr0)
{
    repv form;
    while ((form = Fprimitive_guardian_pop (guardian)) != Qnil)
    {
	origin_item **ptr = buckets + HASH (form);
	while (*ptr != 0)
	{
	    if ((*ptr)->form == form)
	    {
		origin_item *item = *ptr;
		*ptr = item->next;
		item->next = free_list;
		free_list = item;
	    }
	    else
		ptr = &(*ptr)->next;
	}
    }
    return Qnil;
}

void
rep_origin_init (void)
{
    repv tem;

    guardian = Fmake_primitive_guardian ();

    tem = Fsymbol_value (Qafter_gc_hook, Qt);
    if (rep_VOIDP (tem))
	tem = Qnil;
    Fset (Qafter_gc_hook, Fcons (rep_VAL(&Sorigin_after_gc), tem));

    tem = rep_push_structure ("rep.lang.debug");
    rep_ADD_SUBR(Scall_with_lexical_origins);
    rep_ADD_SUBR(Slexical_origin);
    rep_pop_structure (tem);
}
