framework/inc/protocols.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 /*TODO outline this implementation :-) */
  21
  22 #ifndef INCLUDED_FRAMEWORK_INC_PROTOCOLS_H
  23 #define INCLUDED_FRAMEWORK_INC_PROTOCOLS_H
  24
  25 #include <rtl/ustring.hxx>
  26
  27 namespace framework{
  28
  29 /**
  30     some protocols must be checked during loading or dispatching URLs manually
  31     It can be necessary to decide, if a URL represent a non visible content or
  32     a real visible component.
  33  */
  34
  35 // indicates a loadable content in general!
  36 #define SPECIALPROTOCOL_PRIVATE           "private:"
  37 // indicates loading of components using a model directly
  38 #define SPECIALPROTOCOL_PRIVATE_OBJECT    "private:object"
  39 // indicates loading of components using a stream only
  40 #define SPECIALPROTOCOL_PRIVATE_STREAM    "private:stream"
  41 // indicates creation of empty documents
  42 #define SPECIALPROTOCOL_PRIVATE_FACTORY   "private:factory"
  43 // internal protocol of the sfx project for generic dispatch funtionality
  44 #define SPECIALPROTOCOL_SLOT              "slot:"
  45 // external representation of the slot protocol using names instead of id's
  46 #define SPECIALPROTOCOL_UNO               ".uno:"
  47 // special sfx protocol to execute macros
  48 #define SPECIALPROTOCOL_MACRO             "macro:"
  49 // generic way to start uno services during dispatch
  50 #define SPECIALPROTOCOL_SERVICE           "service:"
  51 // for sending mails
  52 #define SPECIALPROTOCOL_MAILTO            "mailto:"
  53 // for sending news
  54 #define SPECIALPROTOCOL_NEWS              "news:"
  55
  56 class ProtocolCheck
  57 {
  58     public:
  59
  60     /**
  61         enums for well known protocols
  62      */
  63     enum EProtocol
  64     {
  65         E_UNKNOWN_PROTOCOL  ,
  66         E_PRIVATE           ,
  67         E_PRIVATE_OBJECT    ,
  68         E_PRIVATE_STREAM    ,
  69         E_PRIVATE_FACTORY   ,
  70         E_SLOT              ,
  71         E_UNO               ,
  72         E_MACRO             ,
  73         E_SERVICE           ,
  74         E_MAILTO            ,
  75         E_NEWS
  76     };
  77
  78     /**
  79         it checks if given URL match the required protocol only
  80         It should be used instead of specifyProtocol() if only this question
  81         is interesting to perform the code. We must not check for all possible protocols here...
  82      */
  83     static bool isProtocol( const OUString& sURL, EProtocol eRequired )
  84     {
  85         bool bRet = false;
  86         switch(eRequired)
  87         {
  88             case E_PRIVATE:
  89                 bRet = sURL.startsWith(SPECIALPROTOCOL_PRIVATE);
  90                 break;
  91             case E_PRIVATE_OBJECT:
  92                 bRet = sURL.startsWith(SPECIALPROTOCOL_PRIVATE_OBJECT);
  93                 break;
  94             case E_PRIVATE_STREAM:
  95                 bRet = sURL.startsWith(SPECIALPROTOCOL_PRIVATE_STREAM);
  96                 break;
  97             case E_PRIVATE_FACTORY:
  98                 bRet = sURL.startsWith(SPECIALPROTOCOL_PRIVATE_FACTORY);
  99                 break;
 100             case E_SLOT:
 101                 bRet = sURL.startsWith(SPECIALPROTOCOL_SLOT);
 102                 break;
 103             case E_UNO:
 104                 bRet = sURL.startsWith(SPECIALPROTOCOL_UNO);
 105                 break;
 106             case E_MACRO:
 107                 bRet = sURL.startsWith(SPECIALPROTOCOL_MACRO);
 108                 break;
 109             case E_SERVICE:
 110                 bRet = sURL.startsWith(SPECIALPROTOCOL_SERVICE);
 111                 break;
 112             case E_MAILTO:
 113                 bRet = sURL.startsWith(SPECIALPROTOCOL_MAILTO);
 114                 break;
 115             case E_NEWS:
 116                 bRet = sURL.startsWith(SPECIALPROTOCOL_NEWS);
 117                 break;
 118             default:
 119                 bRet = false;
 120                 break;
 121         }
 122         return bRet;
 123     }
 124 };
 125
 126 } // namespace framework
 127
 128 #endif // INCLUDED_FRAMEWORK_INC_PROTOCOLS_H
 129
 130 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */