compactor.h

Go to the documentation of this file.

/* Copyright (C) 2003,2004,2005,2006,2007,2008,2009,2010,2011,2013,2014,2015,2018 Olly Betts
 * Copyright (C) 2008 Lemur Consulting Ltd
 *
 * 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_COMPACTOR_H
#define XAPIAN_INCLUDED_COMPACTOR_H

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

#include <xapian/constants.h>
#include <xapian/deprecated.h>
#include <xapian/intrusive_ptr.h>
#include <xapian/visibility.h>
#include <string>

namespace Xapian {

class Database;

class XAPIAN_VISIBILITY_DEFAULT Compactor {
  public:
    class Internal;

    typedef enum {
        STANDARD = 0,
        FULL = 1,
        FULLER = 2
    } compaction_level;

  private:
    Xapian::Internal::intrusive_ptr<Internal> internal;

    void set_flags_(unsigned flags, unsigned mask = 0);

  public:
    Compactor();

    virtual ~Compactor();

    XAPIAN_DEPRECATED(void set_block_size(size_t block_size));

    XAPIAN_DEPRECATED(void set_renumber(bool renumber)) {
        set_flags_(renumber ? 0 : DBCOMPACT_NO_RENUMBER,
                   ~unsigned(DBCOMPACT_NO_RENUMBER));
    }

    XAPIAN_DEPRECATED(void set_multipass(bool multipass)) {
        set_flags_(multipass ? DBCOMPACT_MULTIPASS : 0,
                   ~unsigned(DBCOMPACT_MULTIPASS));
    }

    XAPIAN_DEPRECATED(void set_compaction_level(compaction_level compaction)) {
        set_flags_(compaction, ~unsigned(STANDARD|FULL|FULLER));
    }

    XAPIAN_DEPRECATED(void set_destdir(const std::string & destdir));

    XAPIAN_DEPRECATED(void add_source(const std::string & srcdir));

    XAPIAN_DEPRECATED(void compact());

    virtual void
    set_status(const std::string & table, const std::string & status);

    virtual std::string
    resolve_duplicate_metadata(const std::string & key,
                               size_t num_tags, const std::string tags[]);
};

}

#endif /* XAPIAN_INCLUDED_COMPACTOR_H */