1 files changed, 123 insertions, 0 deletions
diff --git a/framework/inc/protocols.h b/framework/inc/protocols.h
new file mode 100644
index 000000000..c0a1743b6
--- /dev/null
+++ b/framework/inc/protocols.h
@@ -0,0 +1,123 @@
+/* -*- 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 .
+ */
+
+/*TODO outline this implementation :-) */
+
+#ifndef INCLUDED_FRAMEWORK_INC_PROTOCOLS_H
+#define INCLUDED_FRAMEWORK_INC_PROTOCOLS_H
+
+#include <rtl/ustring.hxx>
+
+namespace framework{
+
+/**
+    some protocols must be checked during loading or dispatching URLs manually
+    It can be necessary to decide, if a URL represent a non visible content or
+    a real visible component.
+ */
+
+// indicates a loadable content in general!
+#define SPECIALPROTOCOL_PRIVATE           "private:"
+// indicates loading of components using a model directly
+#define SPECIALPROTOCOL_PRIVATE_OBJECT    "private:object"
+// indicates loading of components using a stream only
+#define SPECIALPROTOCOL_PRIVATE_STREAM    "private:stream"
+// indicates creation of empty documents
+#define SPECIALPROTOCOL_PRIVATE_FACTORY   "private:factory"
+// internal protocol of the sfx project for generic dispatch functionality
+#define SPECIALPROTOCOL_SLOT              "slot:"
+// external representation of the slot protocol using names instead of id's
+#define SPECIALPROTOCOL_UNO               ".uno:"
+// special sfx protocol to execute macros
+#define SPECIALPROTOCOL_MACRO             "macro:"
+// generic way to start uno services during dispatch
+#define SPECIALPROTOCOL_SERVICE           "service:"
+// for sending mails
+#define SPECIALPROTOCOL_MAILTO            "mailto:"
+// for sending news
+#define SPECIALPROTOCOL_NEWS              "news:"
+
+/** well known protocols */
+enum class EProtocol
+{
+    PrivateObject,
+    PrivateStream,
+    PrivateFactory,
+    Slot,
+    Uno,
+    Macro,
+    Service,
+    MailTo,
+    News
+};
+
+class ProtocolCheck
+{
+    public:
+
+    /**
+        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 bool isProtocol( const OUString& sURL, EProtocol eRequired )
+    {
+        bool bRet = false;
+        switch(eRequired)
+        {
+            case EProtocol::PrivateObject:
+                bRet = sURL.startsWith(SPECIALPROTOCOL_PRIVATE_OBJECT);
+                break;
+            case EProtocol::PrivateStream:
+                bRet = sURL.startsWith(SPECIALPROTOCOL_PRIVATE_STREAM);
+                break;
+            case EProtocol::PrivateFactory:
+                bRet = sURL.startsWith(SPECIALPROTOCOL_PRIVATE_FACTORY);
+                break;
+            case EProtocol::Slot:
+                bRet = sURL.startsWith(SPECIALPROTOCOL_SLOT);
+                break;
+            case EProtocol::Uno:
+                bRet = sURL.startsWith(SPECIALPROTOCOL_UNO);
+                break;
+            case EProtocol::Macro:
+                bRet = sURL.startsWith(SPECIALPROTOCOL_MACRO);
+                break;
+            case EProtocol::Service:
+                bRet = sURL.startsWith(SPECIALPROTOCOL_SERVICE);
+                break;
+            case EProtocol::MailTo:
+                bRet = sURL.startsWith(SPECIALPROTOCOL_MAILTO);
+                break;
+            case EProtocol::News:
+                bRet = sURL.startsWith(SPECIALPROTOCOL_NEWS);
+                break;
+            default:
+                bRet = false;
+                break;
+        }
+        return bRet;
+    }
+};
+
+} // namespace framework
+
+#endif // INCLUDED_FRAMEWORK_INC_PROTOCOLS_H
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */