20ca39ff3e
2008/04/01 10:57:42 thb 1.6.318.2: #i85898# Stripping all external header guards 2008/03/28 15:34:30 rt 1.6.318.1: #i87441# Change license header to LPGL v3.
160 lines
7.7 KiB
C++
160 lines
7.7 KiB
C++
/*************************************************************************
|
|
*
|
|
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
|
|
*
|
|
* Copyright 2008 by Sun Microsystems, Inc.
|
|
*
|
|
* OpenOffice.org - a multi-platform office productivity suite
|
|
*
|
|
* $RCSfile: protocols.h,v $
|
|
* $Revision: 1.7 $
|
|
*
|
|
* This file is part of OpenOffice.org.
|
|
*
|
|
* OpenOffice.org is free software: you can redistribute it and/or modify
|
|
* it under the terms of the GNU Lesser General Public License version 3
|
|
* only, as published by the Free Software Foundation.
|
|
*
|
|
* OpenOffice.org 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 Lesser General Public License version 3 for more details
|
|
* (a copy is included in the LICENSE file that accompanied this code).
|
|
*
|
|
* You should have received a copy of the GNU Lesser General Public License
|
|
* version 3 along with OpenOffice.org. If not, see
|
|
* <http://www.openoffice.org/license.html>
|
|
* for a copy of the LGPLv3 License.
|
|
*
|
|
************************************************************************/
|
|
|
|
/*TODO outline this implementation :-) */
|
|
|
|
#ifndef __FRAMEWORK_PROTOCOLS_H_
|
|
#define __FRAMEWORK_PROTOCOLS_H_
|
|
|
|
//_________________________________________________________________________________________________________________
|
|
// includes
|
|
//_________________________________________________________________________________________________________________
|
|
|
|
#include <macros/generic.hxx>
|
|
|
|
//_________________________________________________________________________________________________________________
|
|
// namespace
|
|
//_________________________________________________________________________________________________________________
|
|
|
|
namespace framework{
|
|
|
|
//_______________________________________________________________________
|
|
/**
|
|
some protocols must be checked during loading or dispatching URLs manually
|
|
It can be neccessary to decide, if a URL represent a non visible content or
|
|
a real visible component.
|
|
*/
|
|
|
|
#define SPECIALPROTOCOL_PRIVATE DECLARE_ASCII("private:" ) // indicates a loadable content in general!
|
|
#define SPECIALPROTOCOL_PRIVATE_OBJECT DECLARE_ASCII("private:object" ) // indicates loading of components using a model directly
|
|
#define SPECIALPROTOCOL_PRIVATE_STREAM DECLARE_ASCII("private:stream" ) // indicates loading of components using a stream only
|
|
#define SPECIALPROTOCOL_PRIVATE_FACTORY DECLARE_ASCII("private:factory") // indicates creation of empty documents
|
|
#define SPECIALPROTOCOL_SLOT DECLARE_ASCII("slot:" ) // internal protocol of the sfx project for generic dispatch funtionality
|
|
#define SPECIALPROTOCOL_UNO DECLARE_ASCII(".uno:" ) // external representation of the slot protocol using names instead of id's
|
|
#define SPECIALPROTOCOL_MACRO DECLARE_ASCII("macro:" ) // special sfx protocol to execute macros
|
|
#define SPECIALPROTOCOL_SERVICE DECLARE_ASCII("service:" ) // generic way to start uno services during dispatch
|
|
#define SPECIALPROTOCOL_MAILTO DECLARE_ASCII("mailto:" ) // for sending mails
|
|
#define SPECIALPROTOCOL_NEWS DECLARE_ASCII("news:" ) // for sending news
|
|
|
|
class ProtocolCheck
|
|
{
|
|
public:
|
|
|
|
//_______________________________________________________________________
|
|
/**
|
|
enums for well known protocols
|
|
*/
|
|
enum EProtocol
|
|
{
|
|
E_UNKNOWN_PROTOCOL ,
|
|
E_PRIVATE ,
|
|
E_PRIVATE_OBJECT ,
|
|
E_PRIVATE_STREAM ,
|
|
E_PRIVATE_FACTORY ,
|
|
E_SLOT ,
|
|
E_UNO ,
|
|
E_MACRO ,
|
|
E_SERVICE ,
|
|
E_MAILTO ,
|
|
E_NEWS
|
|
};
|
|
|
|
//_______________________________________________________________________
|
|
/**
|
|
it checks, if the given URL string match one of the well known protocols.
|
|
It returns the right enum value.
|
|
Protocols are defined above ...
|
|
*/
|
|
static EProtocol specifyProtocol( const ::rtl::OUString& sURL )
|
|
{
|
|
// because "private:" is part of e.g. "private:object" too ...
|
|
// we must check it before all other ones!!!
|
|
if (sURL.compareTo(SPECIALPROTOCOL_PRIVATE,SPECIALPROTOCOL_PRIVATE.getLength()) == 0)
|
|
return E_PRIVATE;
|
|
else
|
|
if (sURL.compareTo(SPECIALPROTOCOL_PRIVATE_OBJECT,SPECIALPROTOCOL_PRIVATE_OBJECT.getLength()) == 0)
|
|
return E_PRIVATE_OBJECT;
|
|
else
|
|
if (sURL.compareTo(SPECIALPROTOCOL_PRIVATE_STREAM,SPECIALPROTOCOL_PRIVATE_STREAM.getLength()) == 0)
|
|
return E_PRIVATE_STREAM;
|
|
else
|
|
if (sURL.compareTo(SPECIALPROTOCOL_PRIVATE_FACTORY,SPECIALPROTOCOL_PRIVATE_FACTORY.getLength()) == 0)
|
|
return E_PRIVATE_FACTORY;
|
|
else
|
|
if (sURL.compareTo(SPECIALPROTOCOL_SLOT,SPECIALPROTOCOL_SLOT.getLength()) == 0)
|
|
return E_SLOT;
|
|
else
|
|
if (sURL.compareTo(SPECIALPROTOCOL_UNO,SPECIALPROTOCOL_UNO.getLength()) == 0)
|
|
return E_UNO;
|
|
else
|
|
if (sURL.compareTo(SPECIALPROTOCOL_MACRO,SPECIALPROTOCOL_MACRO.getLength()) == 0)
|
|
return E_MACRO;
|
|
else
|
|
if (sURL.compareTo(SPECIALPROTOCOL_SERVICE,SPECIALPROTOCOL_SERVICE.getLength()) == 0)
|
|
return E_SERVICE;
|
|
else
|
|
if (sURL.compareTo(SPECIALPROTOCOL_MAILTO,SPECIALPROTOCOL_MAILTO.getLength()) == 0)
|
|
return E_MAILTO;
|
|
else
|
|
if (sURL.compareTo(SPECIALPROTOCOL_NEWS,SPECIALPROTOCOL_NEWS.getLength()) == 0)
|
|
return E_NEWS;
|
|
else
|
|
return E_UNKNOWN_PROTOCOL;
|
|
}
|
|
|
|
//_______________________________________________________________________
|
|
/**
|
|
it checks if given URL match the required protocol only
|
|
It should be used instead of specifyProtocol() if only this question
|
|
is interesting to perform the code. We must not check for all possible protocols here...
|
|
*/
|
|
static sal_Bool isProtocol( const ::rtl::OUString& sURL, EProtocol eRequired )
|
|
{
|
|
switch(eRequired)
|
|
{
|
|
case E_PRIVATE : return (sURL.compareTo(SPECIALPROTOCOL_PRIVATE ,SPECIALPROTOCOL_PRIVATE.getLength() ) == 0);
|
|
case E_PRIVATE_OBJECT : return (sURL.compareTo(SPECIALPROTOCOL_PRIVATE_OBJECT ,SPECIALPROTOCOL_PRIVATE_OBJECT.getLength() ) == 0);
|
|
case E_PRIVATE_STREAM : return (sURL.compareTo(SPECIALPROTOCOL_PRIVATE_STREAM ,SPECIALPROTOCOL_PRIVATE_STREAM.getLength() ) == 0);
|
|
case E_PRIVATE_FACTORY : return (sURL.compareTo(SPECIALPROTOCOL_PRIVATE_FACTORY,SPECIALPROTOCOL_PRIVATE_FACTORY.getLength()) == 0);
|
|
case E_SLOT : return (sURL.compareTo(SPECIALPROTOCOL_SLOT ,SPECIALPROTOCOL_SLOT.getLength() ) == 0);
|
|
case E_UNO : return (sURL.compareTo(SPECIALPROTOCOL_UNO ,SPECIALPROTOCOL_UNO.getLength() ) == 0);
|
|
case E_MACRO : return (sURL.compareTo(SPECIALPROTOCOL_MACRO ,SPECIALPROTOCOL_MACRO.getLength() ) == 0);
|
|
case E_SERVICE : return (sURL.compareTo(SPECIALPROTOCOL_SERVICE ,SPECIALPROTOCOL_SERVICE.getLength() ) == 0);
|
|
case E_MAILTO : return (sURL.compareTo(SPECIALPROTOCOL_MAILTO ,SPECIALPROTOCOL_MAILTO.getLength() ) == 0);
|
|
case E_NEWS : return (sURL.compareTo(SPECIALPROTOCOL_NEWS ,SPECIALPROTOCOL_NEWS.getLength() ) == 0);
|
|
default : return sal_False;
|
|
}
|
|
return sal_False;
|
|
}
|
|
};
|
|
|
|
} // namespace framework
|
|
|
|
#endif // #ifndef __FRAMEWORK_PROTOCOLS_H_
|