/usr/include/nepomuk/queryparser.h is in kdelibs5-dev 4:4.13.0-0ubuntu1.
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 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 | /*
This file is part of the Nepomuk KDE project.
Copyright (C) 2007-2010 Sebastian Trueg <trueg@kde.org>
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Library General Public
License version 2 as published by the Free Software Foundation.
This library 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
Library General Public License for more details.
You should have received a copy of the GNU Library General Public License
along with this library; see the file COPYING.LIB. If not, write to
the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
Boston, MA 02110-1301, USA.
*/
#ifndef _NEPOMUK_SEARCH_QUERY_PARSER_H_
#define _NEPOMUK_SEARCH_QUERY_PARSER_H_
#include "query.h"
#include <QtCore/QString>
#include "nepomukquery_export.h"
namespace Nepomuk {
namespace Query {
/**
* \class QueryParser queryparser.h Nepomuk/Query/QueryParser
*
* \brief Parser for desktop user queries.
*
* \warning This is NOT a SPARQL parser.
*
* The QueryParser can be used to parse user queries, ie. queries that the user
* would enter in any search interface, and convert them into Query instances.
*
* The syntax is fairly simple: plain strings match to LiteralTerm terms,
* URIs need to be N3-encoded, when using white space parenthesis need to
* be put around properties and values, terms can be excluded via \p '-'.
*
* \section queryparser_examples Examples
*
* %Query everything that contains the term "nepomuk":
* \code
* nepomuk
* \endcode
*
* %Query everything that contains both the terms "Hello" and "World":
* \code
* Hello World
* \endcode
*
* %Query everything that contains the term "Hello World":
* \code
* "Hello World"
* \endcode
*
* %Query everything that has a tag whose label matches "nepomuk" (actually
* this is where Query::resolveProperties would match "hastag" to nao:hasTag):
* \code
* hastag:nepomuk
* \endcode
*
* %Query everything that has a tag labeled "nepomuk" or a tag labeled "scribo:
* \code
* hastag:nepomuk OR hastag:scribo
* \endcode
*
* %Query everything that has a tag labeled "nepomuk" but not a tag labeled "scribo":
* \code
* +hastag:nepomuk AND -hastag:scribo
* \endcode
*
* The parser can handle one special case of nesting (TODO: implement a "real" parser)
* which matches all resources that are related to a resource which in turn has a certain
* property:
* \code
* related:(hastag:nepomuk)
* \endcode
*
* \author Sebastian Trueg <trueg@kde.org>
*
* \since 4.4
*/
class NEPOMUKQUERY_EXPORT QueryParser
{
public:
/**
* Create a new query parser.
*/
QueryParser();
/**
* Destructor
*/
~QueryParser();
/**
* Flags to change the behaviour of the parser.
*
* \since 4.5
*/
enum ParserFlag {
/**
* No flags. Default for parse()
*/
NoParserFlags = 0x0,
/**
* Make each full text term use a '*' wildcard
* to match longer strings ('foobar' is matched
* by 'foob*').
*
* Be aware that the query engine needs at least
* 4 chars to do globbing though.
*
* This is disabled by default.
*/
QueryTermGlobbing = 0x1,
/**
* Try to detect filename pattern like *.mp3
* or hello*.txt and create appropriate ComparisonTerm
* instances using ComparisonTerm::Regexp instead of
* ComparisonTerm::Contains.
*
* \since 4.6
*/
DetectFilenamePattern = 0x2
};
Q_DECLARE_FLAGS( ParserFlags, ParserFlag )
/**
* Parse a user query.
*
* \return The parsed query or an invalid Query object
* in case the parsing failed.
*/
Query parse( const QString& query ) const;
/**
* Parse a user query.
*
* \param query The query string to parse
* \param flags a set of flags influencing the parsing process.
*
* \return The parsed query or an invalid Query object
* in case the parsing failed.
*
* \since 4.5
*/
Query parse( const QString& query, ParserFlags flags ) const;
/**
* Try to match a field name as used in a query string to actual
* properties.
*
* The matching is cached inside the Query instance for fast
* subsequent lookups.
*
* Example:
* \code
* hastag:nepomuk
* \endcode
*
* \return A list of properties that match \p fieldName or an empty
* list in case nothing was matched.
*
* This method is used by parse() to match properties used in user queries.
*/
QList<Types::Property> matchProperty( const QString& fieldName ) const;
/**
* Convenience method to quickly parse a query without creating an object.
*
* \return The parsed query or an invalid Query object
* in case the parsing failed.
*/
static Query parseQuery( const QString& query );
/**
* \overload
*
* \param query The query string to parse
* \param flags a set of flags influencing the parsing process.
*
* \since 4.6
*/
static Query parseQuery( const QString& query, ParserFlags flags );
private:
class Private;
Private* const d;
};
}
}
Q_DECLARE_OPERATORS_FOR_FLAGS( Nepomuk::Query::QueryParser::ParserFlags )
#endif
|