summaryrefslogtreecommitdiff
path: root/framework/inc/jobs/joburl.hxx
blob: 2e3e2cb0c0c9dfbcd55f381165c00cbdefff0751 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
/* -*- 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 <stdtypes.h>
#include <general.h>

#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 sal_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: */