diff options
Diffstat (limited to 'framework/inc/jobs/joburl.hxx')
| -rw-r--r-- | framework/inc/jobs/joburl.hxx | 177 |
1 files changed, 177 insertions, 0 deletions
diff --git a/framework/inc/jobs/joburl.hxx b/framework/inc/jobs/joburl.hxx new file mode 100644 index 000000000000..15cc4f37da2e --- /dev/null +++ b/framework/inc/jobs/joburl.hxx @@ -0,0 +1,177 @@ +/************************************************************************* + * + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * Copyright 2000, 2010 Oracle and/or its affiliates. + * + * OpenOffice.org - a multi-platform office productivity suite + * + * 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. + * + ************************************************************************/ + +#ifndef __FRAMEWORK_JOBS_JOBURL_HXX_ +#define __FRAMEWORK_JOBS_JOBURL_HXX_ + +//_______________________________________ +// my own includes + +#include <threadhelp/threadhelpbase.hxx> +#include <macros/debug.hxx> +#include <stdtypes.h> +#include <general.h> + +//_______________________________________ +// interface includes + +//_______________________________________ +// other includes +#include <rtl/ustring.hxx> + +//_______________________________________ +// namespace + +namespace framework{ + +//_______________________________________ +// const + +#define JOBURL_PROTOCOL_STR "vnd.sun.star.job:" +#define JOBURL_PROTOCOL_LEN 17 + +#define JOBURL_EVENT_STR "event=" +#define JOBURL_EVENT_LEN 6 + +#define JOBURL_ALIAS_STR "alias=" +#define JOBURL_ALIAS_LEN 6 + +#define JOBURL_SERVICE_STR "service=" +#define JOBURL_SERVICE_LEN 8 + +#define JOBURL_PART_SEPERATOR ';' +#define JOBURL_PARTARGS_SEPERATOR ',' + +//_______________________________________ +/** + @short can be used to parse, validate and work with job URL's + @descr Job URLs are specified by the following syntax: + vnd.sun.star.job:{[event=<name>]|[alias=<name>]|[service=<name>]} + This class can analyze this structure and seperate it into his different parts. + After doing that these parts are accessible by the methods of this class. + */ +class JobURL : private ThreadHelpBase +{ + //___________________________________ + // types + + private: + + /** + possible states of a job URL + Note: These values are used in combination. So they must be + values in form 2^n. + */ + enum ERequest + { + /// mark a job URL as not valid + E_UNKNOWN = 0, + /// it's an event + E_EVENT = 1, + /// it's an alias + E_ALIAS = 2, + /// it's a service + E_SERVICE = 4 + }; + + //___________________________________ + // types + + private: + + /** knows the state of this URL instance */ + sal_uInt32 m_eRequest; + + /** holds the event part of a job URL */ + ::rtl::OUString m_sEvent; + + /** holds the alias part of a job URL */ + ::rtl::OUString m_sAlias; + + /** holds the service part of a job URL */ + ::rtl::OUString m_sService; + + /** holds the event arguments */ + ::rtl::OUString m_sEventArgs; + + /** holds the alias arguments */ + ::rtl::OUString m_sAliasArgs; + + /** holds the service arguments */ + ::rtl::OUString m_sServiceArgs; + + //___________________________________ + // native interface + + public: + + JobURL ( const ::rtl::OUString& sURL ); + sal_Bool isValid ( ) const; + sal_Bool getEvent ( ::rtl::OUString& sEvent ) const; + sal_Bool getAlias ( ::rtl::OUString& sAlias ) const; + sal_Bool getService ( ::rtl::OUString& sService ) const; + + //___________________________________ + // private helper + + private: + + static sal_Bool implst_split( const ::rtl::OUString& sPart , + const sal_Char* pPartIdentifier , + sal_Int32 nPartLength , + ::rtl::OUString& rPartValue , + ::rtl::OUString& rPartArguments ); + + //___________________________________ + // debug methods! + + #ifdef ENABLE_COMPONENT_SELF_CHECK + + public: + static void impldbg_checkIt(); + + private: + static void impldbg_checkURL( const sal_Char* pURL , + sal_uInt32 eExpectedPart , + const sal_Char* pExpectedEvent , + const sal_Char* pExpectedAlias , + const sal_Char* pExpectedService , + const sal_Char* pExpectedEventArgs , + const sal_Char* pExpectedAliasArgs , + const sal_Char* pExpectedServiceArgs ); + ::rtl::OUString impldbg_toString() const; + + sal_Bool getServiceArgs( ::rtl::OUString& sServiceArgs ) const; + sal_Bool getEventArgs ( ::rtl::OUString& sEventArgs ) const; + sal_Bool getAliasArgs ( ::rtl::OUString& sAliasArgs ) const; + + #endif // ENABLE_COMPONENT_SELF_CHECK +}; + +} // namespace framework + +#endif // __FRAMEWORK_JOBS_JOBURL_HXX_ |