summaryrefslogtreecommitdiffstats
path: root/framework/inc/jobs/joburl.hxx
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-27 16:51:28 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-27 16:51:28 +0000
commit940b4d1848e8c70ab7642901a68594e8016caffc (patch)
treeeb72f344ee6c3d9b80a7ecc079ea79e9fba8676d /framework/inc/jobs/joburl.hxx
parentInitial commit. (diff)
downloadlibreoffice-940b4d1848e8c70ab7642901a68594e8016caffc.tar.xz
libreoffice-940b4d1848e8c70ab7642901a68594e8016caffc.zip
Adding upstream version 1:7.0.4.upstream/1%7.0.4upstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'framework/inc/jobs/joburl.hxx')
-rw-r--r--framework/inc/jobs/joburl.hxx111
1 files changed, 111 insertions, 0 deletions
diff --git a/framework/inc/jobs/joburl.hxx b/framework/inc/jobs/joburl.hxx
new file mode 100644
index 000000000..32c2fc809
--- /dev/null
+++ b/framework/inc/jobs/joburl.hxx
@@ -0,0 +1,111 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
+/*
+ * This file is part of the LibreOffice project.
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * This file incorporates work covered by the following license notice:
+ *
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed
+ * with this work for additional information regarding copyright
+ * ownership. The ASF licenses this file to you under the Apache
+ * License, Version 2.0 (the "License"); you may not use this file
+ * except in compliance with the License. You may obtain a copy of
+ * the License at http://www.apache.org/licenses/LICENSE-2.0 .
+ */
+
+#ifndef INCLUDED_FRAMEWORK_INC_JOBS_JOBURL_HXX
+#define INCLUDED_FRAMEWORK_INC_JOBS_JOBURL_HXX
+
+#include <rtl/ustring.hxx>
+
+namespace framework{
+
+#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_SEPARATOR ';'
+#define JOBURL_PARTARGS_SEPARATOR ','
+
+/**
+ @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 separate it into his different parts.
+ After doing that these parts are accessible by the methods of this class.
+ */
+class JobURL
+{
+
+ // 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 */
+ OUString m_sEvent;
+
+ /** holds the alias part of a job URL */
+ OUString m_sAlias;
+
+ /** holds the service part of a job URL */
+ OUString m_sService;
+
+ // native interface
+
+ public:
+
+ JobURL ( const OUString& sURL );
+ bool isValid ( ) const;
+ bool getEvent ( OUString& sEvent ) const;
+ bool getAlias ( OUString& sAlias ) const;
+ bool getService ( OUString& sService ) const;
+
+ // private helper
+
+ private:
+
+ static bool implst_split( const OUString& sPart ,
+ const char* pPartIdentifier ,
+ sal_Int32 nPartLength ,
+ OUString& rPartValue ,
+ OUString& rPartArguments );
+};
+
+} // namespace framework
+
+#endif // INCLUDED_FRAMEWORK_INC_JOBS_JOBURL_HXX
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */