filter/source/config/cache/querytokenizer.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #pragma once
  21
  22 #include <rtl/ustring.hxx>
  23 #include <unordered_map>
  24
  25
  26 namespace filter::config {
  27
  28
  29 /** @short      It can be used to split any query string (which can be used at the
  30                 related interface <type scope="css::container">XContainerQuery</type>)
  31                 into its different tokens using a fix schema.
  32
  33     @descr      All queries implemented of the services
  34                 <ul>
  35                     <li><type scope="css::document">TypeDetection</type></li>
  36                     <li><type scope="css::document">FilterFactory</type></li>
  37                     <li><type scope="css::document">ExtendedTypeDetectionFactory</type></li>
  38                     <li><type scope="css::frame">FrameLoaderFactory</type></li>
  39                     <li><type scope="css::frame">ContentHandlerFactory</type></li>
  40                 </ul>
  41                 uses this schema.
  42
  43     @attention  This class is not threadsafe implemented. Because it's not necessary.
  44                 But you have to make sure that it's not used as such :-)
  45  */
  46 class QueryTokenizer : public std::unordered_map< OUString, OUString >
  47 {
  48
  49     // member
  50
  51     private:
  52
  53         /** @short  Because the given query can contain errors,
  54                     it should be checked outside.
  55
  56             TODO    May it's a good idea to describe the real problem
  57                     more detailed ...
  58          */
  59         bool m_bValid;
  60
  61
  62     // interface
  63
  64     public:
  65
  66         /** @short  create a new tokenizer instance with a
  67                     a new query.
  68
  69             @descr  The given query is immediately analyzed
  70                     and separated into its token, which can
  71                     be access by some specialized method later.
  72
  73             @param  sQuery
  74                     the query string.
  75          */
  76         explicit QueryTokenizer(std::u16string_view sQuery);
  77
  78
  79         /** @short  destruct an instance of this class.
  80          */
  81         virtual ~QueryTokenizer();
  82
  83
  84         /** @short  can be used to check if analyzing of given query
  85                     was successful or not.
  86          */
  87         bool valid() const;
  88 };
  89
  90 } // namespace filter::config
  91
  92 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */