types.h

Go to the documentation of this file.

/* Copyright (C) 2007,2010,2011,2013,2014,2017,2018 Olly Betts
 *
 * 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 2 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, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
 */

#ifndef XAPIAN_INCLUDED_TYPES_H
#define XAPIAN_INCLUDED_TYPES_H

#if !defined XAPIAN_IN_XAPIAN_H && !defined XAPIAN_LIB_BUILD
# error Never use <xapian/types.h> directly; include <xapian.h> instead.
#endif

#include <xapian/deprecated.h>
#include <xapian/version.h>

namespace Xapian {

typedef unsigned XAPIAN_DOCID_BASE_TYPE doccount;

typedef XAPIAN_DOCID_BASE_TYPE doccount_diff;

typedef unsigned XAPIAN_DOCID_BASE_TYPE docid;

typedef double doclength;

XAPIAN_DEPRECATED(typedef int percent);

typedef unsigned XAPIAN_TERMCOUNT_BASE_TYPE termcount;

typedef XAPIAN_TERMCOUNT_BASE_TYPE termcount_diff;

typedef unsigned XAPIAN_TERMPOS_BASE_TYPE termpos;

typedef XAPIAN_TERMPOS_BASE_TYPE termpos_diff; /* FIXME: can overflow. */

XAPIAN_DEPRECATED(typedef unsigned timeout);

typedef unsigned valueno;

typedef int valueno_diff; /* FIXME: can overflow. */

XAPIAN_DEPRECATED(typedef double weight);

const valueno BAD_VALUENO = 0xffffffff;

typedef XAPIAN_REVISION_TYPE rev;

typedef XAPIAN_TOTALLENGTH_TYPE totallength;

}

#endif /* XAPIAN_INCLUDED_TYPES_H */