/usr/include/xapian/registry.h is in libxapian-dev 1.2.16-2ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 | /** @file registry.h
* @brief Class for looking up user subclasses during unserialisation.
*/
/* Copyright 2009 Lemur Consulting Ltd
* Copyright 2009,2011 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_REGISTRY_H
#define XAPIAN_INCLUDED_REGISTRY_H
#include <xapian/base.h>
#include <xapian/visibility.h>
#include <string>
namespace Xapian {
// Forward declarations.
class MatchSpy;
class PostingSource;
class Weight;
/** Registry for user subclasses.
*
* This class provides a way for the remote server to look up user subclasses
* when unserialising.
*/
class XAPIAN_VISIBILITY_DEFAULT Registry {
public:
/// Class holding details of the registry.
class Internal;
private:
/// @internal Reference counted internals.
Xapian::Internal::RefCntPtr<Internal> internal;
public:
/** Copy constructor.
*
* The internals are reference counted, so copying is cheap.
*
* @param other The object to copy.
*/
Registry(const Registry & other);
/** Assignment operator.
*
* The internals are reference counted, so assignment is cheap.
*
* @param other The object to copy.
*/
Registry & operator=(const Registry & other);
/** Default constructor.
*
* The registry will contain all standard subclasses of user-subclassable
* classes.
*/
Registry();
~Registry();
/** Register a weighting scheme.
*
* @param wt The weighting scheme to register.
*/
void register_weighting_scheme(const Xapian::Weight &wt);
/** Get the weighting scheme given a name.
*
* @param name The name of the weighting scheme to find.
* @return An object with the requested name, or NULL if the
* weighting scheme could not be found. The returned
* object is owned by the registry and so must not be
* deleted by the caller.
*/
const Xapian::Weight *
get_weighting_scheme(const std::string & name) const;
/** Register a user-defined posting source class.
*
* @param source The posting source to register.
*/
void register_posting_source(const Xapian::PostingSource &source);
/** Get a posting source given a name.
*
* @param name The name of the posting source to find.
* @return An object with the requested name, or NULL if the
* posting source could not be found. The returned
* object is owned by the registry and so must not be
* deleted by the caller.
*/
const Xapian::PostingSource *
get_posting_source(const std::string & name) const;
/** Register a user-defined match spy class.
*
* @param spy The match spy to register.
*/
void register_match_spy(const Xapian::MatchSpy &spy);
/** Get a match spy given a name.
*
* @param name The name of the match spy to find.
* @return An object with the requested name, or NULL if the
* match spy could not be found. The returned
* object is owned by the registry and so must not be
* deleted by the caller.
*/
const Xapian::MatchSpy *
get_match_spy(const std::string & name) const;
};
}
#endif /* XAPIAN_INCLUDED_REGISTRY_H */
|