File: XmlActionExecutor.h

package info (click to toggle)
android-platform-frameworks-base 1%3A7.0.0%2Br33-1
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 137,116 kB
  • sloc: java: 704,370; cpp: 206,670; xml: 185,778; python: 2,626; ansic: 486; sh: 291; makefile: 48; sed: 19
file content (108 lines) | stat: -rw-r--r-- 2,964 bytes parent folder | download
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
/*
 * Copyright (C) 2016 The Android Open Source Project
 *
 * Licensed 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
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#ifndef AAPT_XML_XMLPATTERN_H
#define AAPT_XML_XMLPATTERN_H

#include "Diagnostics.h"
#include "xml/XmlDom.h"

#include <android-base/macros.h>
#include <functional>
#include <map>
#include <string>
#include <vector>

namespace aapt {
namespace xml {

enum class XmlActionExecutorPolicy {
    /**
     * Actions on run if elements are matched, errors occur only when actions return false.
     */
    None,

    /**
     * The actions defined must match and run. If an element is found that does not match
     * an action, an error occurs.
     */
    Whitelist,
};

/**
 * Contains the actions to perform at this XML node. This is a recursive data structure that
 * holds XmlNodeActions for child XML nodes.
 */
class XmlNodeAction {
public:
    using ActionFuncWithDiag = std::function<bool(Element*, SourcePathDiagnostics*)>;
    using ActionFunc = std::function<bool(Element*)>;

    /**
     * Find or create a child XmlNodeAction that will be performed for the child element
     * with the name `name`.
     */
    XmlNodeAction& operator[](const std::u16string& name) {
        return mMap[name];
    }

    /**
     * Add an action to be performed at this XmlNodeAction.
     */
    void action(ActionFunc f);
    void action(ActionFuncWithDiag);

private:
    friend class XmlActionExecutor;

    bool execute(XmlActionExecutorPolicy policy, SourcePathDiagnostics* diag, Element* el) const;

    std::map<std::u16string, XmlNodeAction> mMap;
    std::vector<ActionFuncWithDiag> mActions;
};

/**
 * Allows the definition of actions to execute at specific XML elements defined by their
 * hierarchy.
 */
class XmlActionExecutor {
public:
    XmlActionExecutor() = default;

    /**
     * Find or create a root XmlNodeAction that will be performed for the root XML element
     * with the name `name`.
     */
    XmlNodeAction& operator[](const std::u16string& name) {
        return mMap[name];
    }

    /**
     * Execute the defined actions for this XmlResource.
     * Returns true if all actions return true, otherwise returns false.
     */
    bool execute(XmlActionExecutorPolicy policy, IDiagnostics* diag, XmlResource* doc) const;

private:
    std::map<std::u16string, XmlNodeAction> mMap;

    DISALLOW_COPY_AND_ASSIGN(XmlActionExecutor);
};

} // namespace xml
} // namespace aapt

#endif /* AAPT_XML_XMLPATTERN_H */