root/htags/cache.c

/* [<][>][^][v][top][bottom][index][help] */

DEFINITIONS

This source file includes following definitions.
  1. cache_open
  2. cache_put
  3. cache_get
  4. cache_close

/*
 * Copyright (c) 2004, 2005 Tama Communications Corporation
 *
 * This file is part of GNU GLOBAL.
 *
 * This program 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 3 of the License, or
 * (at your option) any later version.
 * 
 * This program 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 this program.  If not, see <http://www.gnu.org/licenses/>.
 */
#ifdef HAVE_CONFIG_H
#include <config.h>
#endif
#include <stdio.h>
#ifdef HAVE_STRING_H
#include <string.h>
#else
#include <strings.h>
#endif
#include <errno.h>
#include "global.h"
#include "assoc.h"
#include "htags.h"
#include "cache.h"

static ASSOC *assoc[GTAGLIM];
/*
 * Cache file is used for duplicate object entry.
 *
 * If function 'func()' is defined more than once then the cache record
 * of GTAGS has (1) the frequency and the name of duplicate object entry file,
 * else it has (2) the tag definition.
 * It can be distinguished the first character of the cache record.
 * If it is a blank then it is the former else the latter.
 *
 * (1) The frequency and the id of duplicate object entry file (=fid).
 *      +----------------------+
 *      |' '<fid>' '<frequency>|
 *      +----------------------+
 *    The duplicate object entry file can be referred to as 'D/<fid>.html'.
 *      
 * (2) The tag definition.
 *      +---------------------------+
 *      |<line number>' '<file name>|
 *      +---------------------------+
 *    The tag entry is referred to as 'S/<fid>.html#<line number>'.
 *    The <fid> can be calculated by path2fid(<file name>).
 */

/*
 * cache_open: open cache file.
 */
void
cache_open(void)
{
        assoc[GTAGS]  = assoc_open('d');
        assoc[GRTAGS] = assoc_open('r');
        assoc[GSYMS] = symbol ? assoc_open('y') : NULL;
}
/*
 * cache_put: put tag line.
 *
 *      i)      db      db type
 *      i)      tag     tag name
 *      i)      line    tag line
 */
void
cache_put(int db, const char *tag, const char *line)
{
        if (db >= GTAGLIM)
                die("I don't know such tag file.");
        assoc_put(assoc[db], tag, line);
}
/*
 * cache_get: get tag line.
 *
 *      i)      db      db type
 *      i)      tag     tag name
 *      r)              tag line
 */
const char *
cache_get(int db, const char *tag)
{
        if (db >= GTAGLIM)
                die("I don't know such tag file.");
        return assoc_get(assoc[db], tag);
}
/*
 * cache_close: close cache file.
 */
void
cache_close(void)
{
        int i;

        for (i = GTAGS; i < GTAGLIM; i++) {
                if (assoc[i]) {
                        assoc_close(assoc[i]);
                        assoc[i] = NULL;
                }
        }
}

/* [<][>][^][v][top][bottom][index][help] */