framework/inc/queries.h

   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 #ifndef INCLUDED_FRAMEWORK_INC_QUERIES_H
  21 #define INCLUDED_FRAMEWORK_INC_QUERIES_H
  22
  23 #include "general.h"
  24
  25 #include <com/sun/star/uno/Sequence.hxx>
  26 #include <rtl/ustring.hxx>
  27 #include <rtl/ustrbuf.hxx>
  28
  29 namespace framework{
  30
  31 /*-************************************************************************************************************
  32     @short          These values describe our supported queries for type, filter ... properties.
  33                     They are used by our FilterFactory or our TypeDetection to return
  34                     subsets of our cached configuration.
  35 *//*-*************************************************************************************************************/
  36 #define BASE_QUERY_ALL                                  DECLARE_ASCII("_query_all"     )
  37 #define BASE_QUERY_WRITER                               DECLARE_ASCII("_query_Writer"  )
  38 #define BASE_QUERY_WEB                                  DECLARE_ASCII("_query_web"     )
  39 #define BASE_QUERY_GLOBAL                               DECLARE_ASCII("_query_global"  )
  40 #define BASE_QUERY_CHART                                DECLARE_ASCII("_query_chart"   )
  41 #define BASE_QUERY_CALC                                 DECLARE_ASCII("_query_calc"    )
  42 #define BASE_QUERY_IMPRESS                              DECLARE_ASCII("_query_impress" )
  43 #define BASE_QUERY_DRAW                                 DECLARE_ASCII("_query_draw"    )
  44 #define BASE_QUERY_MATH                                 DECLARE_ASCII("_query_math"    )
  45 #define BASE_QUERY_GRAPHICS                             DECLARE_ASCII("_query_graphics")
  46
  47 /*-************************************************************************************************************
  48     @short          These parameters can be used in combination with BASE_QUERY_... defines to
  49                     specialize it.
  50                     use follow syntax to do so:     "<query>[:<param>[=<value>]]"
  51                     e.g.:                           "_query_writer:default_first:use_order:sort_prop=uiname"
  52
  53                     argument                        description                                     default
  54                     -----------------------------------------------------------------------------------------------
  55                     iflags=<mask>                   include filters by given mask                   0
  56                     eflags=<mask>                   exclude filters by given mask                   0
  57                     sort_prop=<[name,uiname]>       sort by internal name or uiname                 name
  58                     descending                      sort descending                                 false
  59                     use_order                       use order flag of filters for sorting           false
  60                     default_first                   set default filter on top of return list        false
  61                     case_sensitive                  compare "sort_prop" case sensitive              false
  62 *//*-*************************************************************************************************************/
  63 #define SEPARATOR_QUERYPARAM                            ((sal_Unicode)':')
  64 #define SEPARATOR_QUERYPARAMVALUE                       ((sal_Unicode)'=')
  65
  66 #define QUERYPARAM_IFLAGS                               DECLARE_ASCII("iflags"          )
  67 #define QUERYPARAM_EFLAGS                               DECLARE_ASCII("eflags"          )
  68 #define QUERYPARAM_SORT_PROP                            DECLARE_ASCII("sort_prop"       )
  69
  70 #define QUERYPARAM_DESCENDING                           DECLARE_ASCII("descending"      )
  71 #define QUERYPARAM_USE_ORDER                            DECLARE_ASCII("use_order"       )
  72 #define QUERYPARAM_DEFAULT_FIRST                        DECLARE_ASCII("default_first"   )
  73 #define QUERYPARAM_CASE_SENSITIVE                       DECLARE_ASCII("case_sensitive"  )
  74
  75 #define QUERYPARAMVALUE_SORT_PROP_NAME                  DECLARE_ASCII("name"            )
  76 #define QUERYPARAMVALUE_SORT_PROP_UINAME                DECLARE_ASCII("uiname"          )
  77
  78 /*-************************************************************************************************************
  79     @short          Helper class to support easy building of a query statements.
  80 *//*-*************************************************************************************************************/
  81 class QueryBuilder
  82 {
  83     public:
  84
  85         // start with empty query
  86
  87         QueryBuilder()
  88         {
  89             resetAll();
  90         }
  91
  92         // returns full query as copy of internal set values
  93
  94         OUString getQuery()
  95         {
  96             OUStringBuffer sCopy( m_sParams );
  97             sCopy.insert( 0, m_sBase );
  98             return sCopy.makeStringAndClear();
  99         }
 100
 101         // set new or change existing base query part
 102
 103         void setBase( const OUString& sBase )
 104         {
 105             m_sBase = sBase;
 106         }
 107
 108         // add new parameter (with optional value) to param list
 109
 110         void addParam( const OUString& sParam, const OUString& sValue = OUString() )
 111         {
 112             m_sParams.append( SEPARATOR_QUERYPARAM );
 113             m_sParams.append( sParam               );
 114             if( sValue.getLength() > 0 )
 115             {
 116                 m_sParams.append( SEPARATOR_QUERYPARAMVALUE );
 117                 m_sParams.append( sValue                    );
 118             }
 119         }
 120
 121         // forget all setted params and start with empty ones
 122         // Attention: base of query isn't changed!
 123
 124         void resetParams()
 125         {
 126             m_sParams.makeStringAndClear();
 127             m_sParams.ensureCapacity( 256 );
 128         }
 129
 130         // start with new empty query
 131
 132         void resetAll()
 133         {
 134             m_sBase.clear();
 135             resetParams();
 136         }
 137
 138     private:
 139         OUString         m_sBase;
 140         OUStringBuffer   m_sParams;
 141
 142 };      // class QueryBuilder
 143
 144 /*-************************************************************************************************************
 145     @short          Helper class to analyze queries and split into his different parts (base, params and values).
 146 *//*-*************************************************************************************************************/
 147 class QueryAnalyzer
 148 {
 149     public:
 150
 151         // it's will not perform to compare strings as query type ...
 152         // so we convert it into these enum values.
 153         // default = E_ALL!
 154
 155         enum EQuery
 156         {
 157             E_ALL       ,
 158             E_WRITER    ,
 159             E_WEB       ,
 160             E_GLOBAL    ,
 161             E_CHART     ,
 162             E_CALC      ,
 163             E_IMPRESS   ,
 164             E_DRAW      ,
 165             E_MATH      ,
 166             E_GRAPHICS
 167         };
 168
 169         // these are valid values for param "sort_prop".
 170         // other ones are not supported!
 171         // default = E_NAME
 172
 173         enum ESortProp
 174         {
 175             E_NAME      ,
 176             E_UINAME
 177         };
 178
 179         // analyze given query and split it into his different parts; <base>:<param1>:<param2=value>...
 180
 181         QueryAnalyzer(const OUString& sQuery)
 182             // Don't forget to set default values for non given params!
 183             :   m_eQuery        ( E_ALL      )   // return ALL filter ...
 184             ,   m_nIFlags       ( 0          )   // which has set ANY flag ... (we remove all entries which match with these mask .. => 0!)
 185             ,   m_nEFlags       ( 0          )   // (only used, if nIFlags==0 and himself!=0!)
 186             ,   m_eSortProp     ( E_NAME     )   // sort it by internal name ...
 187             ,   m_bDescending   ( sal_False  )   // in ascending order ...
 188             ,   m_bCaseSensitive( sal_False  )   // ignore case ...
 189             ,   m_bUseOrder     ( sal_False  )   // don't use order flag ...
 190             ,   m_bDefaultFirst ( sal_False  )   // and don't handle default entries in special case!
 191         {
 192             // Translate old query format to new one first!
 193             OUString sNewQuery( sQuery );
 194             if (sQuery == "_filterquery_textdocument_withdefault")
 195                 sNewQuery = "_query_writer:default_first:use_order:sort_prop=uiname";
 196             else if (sQuery == "_filterquery_webdocument_withdefault")
 197                 sNewQuery = "_query_web:default_first:use_order:sort_prop=uiname";
 198             else if (sQuery == "_filterquery_globaldocument_withdefault")
 199                 sNewQuery = "_query_global:default_first:use_order:sort_prop=uiname";
 200             else if (sQuery == "_filterquery_chartdocument_withdefault")
 201                 sNewQuery = "_query_chart:default_first:use_order:sort_prop=uiname";
 202             else if (sQuery == "_filterquery_spreadsheetdocument_withdefault")
 203                 sNewQuery = "_query_calc:default_first:use_order:sort_prop=uiname";
 204             else if (sQuery == "_filterquery_presentationdocument_withdefault")
 205                 sNewQuery = "_query_impress:default_first:use_order:sort_prop=uiname";
 206             else if (sQuery == "_filterquery_drawingdocument_withdefault")
 207                 sNewQuery = "_query_draw:default_first:use_order:sort_prop=uiname";
 208             else if (sQuery == "_filterquery_formulaproperties_withdefault")
 209                 sNewQuery = "_query_math:default_first:use_order:sort_prop=uiname";
 210             else if (sQuery == "_filterquery_textdocument")
 211                 sNewQuery = "_query_writer:use_order:sort_prop=uiname";
 212             else if (sQuery == "_filterquery_webdocument")
 213                 sNewQuery = "_query_web:use_order:sort_prop=uiname";
 214             else if (sQuery == "_filterquery_globaldocument")
 215                 sNewQuery = "_query_global:use_order:sort_prop=uiname";
 216             else if (sQuery == "_filterquery_chartdocument")
 217                 sNewQuery = "_query_chart:use_order:sort_prop=uiname";
 218             else if (sQuery == "_filterquery_spreadsheetdocument")
 219                 sNewQuery = "_query_calc:use_order:sort_prop=uiname";
 220             else if (sQuery == "_filterquery_presentationdocument")
 221                 sNewQuery = "_query_impress:use_order:sort_prop=uiname";
 222             else if (sQuery == "_filterquery_drawingdocument")
 223                 sNewQuery = "_query_draw:use_order:sort_prop=uiname";
 224             else if (sQuery == "_filterquery_formulaproperties")
 225                 sNewQuery = "_query_math:use_order:sort_prop=uiname";
 226
 227             // Analyze query ...
 228             // Try to find base of it and safe it for faster access as enum value!
 229             sal_Int32 nToken = 0;
 230             OUString sParam;
 231             OUString sBase = sNewQuery.getToken( 0, SEPARATOR_QUERYPARAM, nToken );
 232
 233             if (sBase.equalsIgnoreAsciiCase(BASE_QUERY_ALL))
 234                 m_eQuery = E_ALL;
 235             else if( sBase.equalsIgnoreAsciiCase(BASE_QUERY_WRITER))
 236                 m_eQuery = E_WRITER;
 237             else if( sBase.equalsIgnoreAsciiCase(BASE_QUERY_WEB))
 238                 m_eQuery = E_WEB;
 239             else if( sBase.equalsIgnoreAsciiCase(BASE_QUERY_GLOBAL))
 240                 m_eQuery = E_GLOBAL;
 241             else if( sBase.equalsIgnoreAsciiCase(BASE_QUERY_CHART))
 242                 m_eQuery = E_CHART;
 243             else if( sBase.equalsIgnoreAsciiCase(BASE_QUERY_CALC))
 244                 m_eQuery = E_CALC;
 245             else if( sBase.equalsIgnoreAsciiCase(BASE_QUERY_IMPRESS))
 246                 m_eQuery = E_IMPRESS;
 247             else if( sBase.equalsIgnoreAsciiCase(BASE_QUERY_DRAW))
 248                 m_eQuery = E_DRAW;
 249             else if( sBase.equalsIgnoreAsciiCase(BASE_QUERY_MATH))
 250                 m_eQuery = E_MATH;
 251             else if( sBase.equalsIgnoreAsciiCase(BASE_QUERY_GRAPHICS))
 252                 m_eQuery = E_GRAPHICS;
 253
 254             // Try to get additional parameters ...
 255             while( nToken >= 0 )
 256             {
 257                 sParam = sNewQuery.getToken( 0, SEPARATOR_QUERYPARAM, nToken );
 258                 // "default_first"
 259                 if( sParam.startsWith( QUERYPARAM_DEFAULT_FIRST ) )
 260                 {
 261                     m_bDefaultFirst = sal_True;
 262                 }
 263                 // "use_order"
 264                 else if( sParam.startsWith( QUERYPARAM_USE_ORDER ) )
 265                 {
 266                     m_bUseOrder = sal_True;
 267                 }
 268                 // "descending"
 269                 else if( sParam.startsWith( QUERYPARAM_DESCENDING ) )
 270                 {
 271                     m_bDescending = sal_True;
 272                 }
 273                 // "case_sensitive"
 274                 else if( sParam.startsWith( QUERYPARAM_CASE_SENSITIVE ) )
 275                 {
 276                     m_bCaseSensitive = sal_True;
 277                 }
 278                 // "iflags=<mask>"
 279                 else if( sParam.startsWith( QUERYPARAM_IFLAGS ) )
 280                 {
 281                     sal_Int32       nSubToken  = 0;
 282                     sParam.getToken( 0, SEPARATOR_QUERYPARAMVALUE, nSubToken );
 283                     if( nSubToken > 0 )
 284                     {
 285                         m_nIFlags = sParam.getToken( 0, SEPARATOR_QUERYPARAMVALUE, nSubToken ).toInt32();
 286                     }
 287                 }
 288                 // "eflags=<mask>"
 289                 else if( sParam.startsWith( QUERYPARAM_EFLAGS ) )
 290                 {
 291                     sal_Int32       nSubToken  = 0;
 292                     sParam.getToken( 0, SEPARATOR_QUERYPARAMVALUE, nSubToken );
 293                     if( nSubToken > 0 )
 294                     {
 295                         m_nEFlags = sParam.getToken( 0, SEPARATOR_QUERYPARAMVALUE, nSubToken ).toInt32();
 296                     }
 297                 }
 298                 // "sort_prop=<[name,uiname]>"
 299                 else if( sParam.startsWith( QUERYPARAM_SORT_PROP ) )
 300                 {
 301                     sal_Int32       nSubToken  = 0;
 302                     sParam.getToken( 0, SEPARATOR_QUERYPARAMVALUE, nSubToken );
 303                     if( nSubToken > 0 )
 304                     {
 305                         OUString sParamValue = sParam.getToken( 0, SEPARATOR_QUERYPARAMVALUE, nSubToken );
 306                         if( sParamValue.startsWith( QUERYPARAMVALUE_SORT_PROP_NAME ) )
 307                             m_eSortProp = E_NAME;
 308                         else if( sParamValue.startsWith( QUERYPARAMVALUE_SORT_PROP_UINAME ) )
 309                             m_eSortProp = E_UINAME;
 310                     }
 311                 }
 312             }
 313         }
 314
 315         // return type of query. User can decide then, which action should be started.
 316         // For faster work we converted query string into corresponding enum value!
 317
 318         EQuery getQueryType() const { return m_eQuery; }
 319
 320         // access to additional parameter values
 321         // Methods return default of really set values!
 322
 323         sal_uInt32 getIFlags       () const { return m_nIFlags; }
 324         sal_uInt32 getEFlags       () const { return m_nEFlags; }
 325         ESortProp  getSortProp     () const { return m_eSortProp; }
 326         bool       getDescending   () const { return m_bDescending; }
 327         bool       getCaseSensitive() const { return m_bCaseSensitive; }
 328         bool       getUseOrder     () const { return m_bUseOrder; }
 329         bool       getDefaultFirst () const { return m_bDefaultFirst; }
 330
 331         // this method checks if given string match any supported query.
 332         // (ignore additional parameters!)
 333
 334         static bool isQuery( const OUString& sQuery )
 335         {
 336             return(
 337                     sQuery.startsWith("_query_") ||    // new style
 338                     sQuery.startsWith("_filterquery_")       // old style!
 339                   );
 340         }
 341
 342     private:
 343         EQuery      m_eQuery;
 344         sal_uInt32  m_nIFlags;
 345         sal_uInt32  m_nEFlags;
 346         ESortProp   m_eSortProp;
 347         bool        m_bDescending;
 348         bool        m_bCaseSensitive;
 349         bool        m_bUseOrder;
 350         bool        m_bDefaultFirst;
 351
 352 };      // class QueryAnalyzer
 353
 354 }       //  namespace framework
 355
 356 #endif // INCLUDED_FRAMEWORK_INC_QUERIES_H
 357
 358 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */