13 | * Created by RubiTree ; On 2019-01-14.
14 | */
15 | public class MViewGroup extends MView implements ViewParent {
16 | private MView child;
17 | private boolean isChildNeedEvent = false;
18 | private boolean isSelfNeedEvent = false;
19 | private boolean isDisallowIntercept = false;
20 |
21 | public MViewGroup(MView child) {
22 | this.child = child;
23 | // 这里只是示意，实际中不建议这么写，会造成提前发布未构造完成的实例
24 | child.parent = this;
25 | }
26 |
27 | @Override
28 | public boolean dispatch(MotionEvent ev) {
29 | boolean handled = false;
30 |
31 | if (ev.getActionMasked() == MotionEvent.ACTION_DOWN) {
32 | clearStatus();
33 |
34 | if (!isDisallowIntercept && onIntercept(ev)) {
35 | isSelfNeedEvent = true;
36 | handled = onTouch(ev);
37 | }else{
38 | handled = child.dispatch(ev);
39 | if (handled) isChildNeedEvent = true;
40 |
41 | if (!handled) { // 这里没有用 if else 是因为这样写上下一致，更清晰
42 | handled = onTouch(ev);
43 | if (handled) isSelfNeedEvent = true; // 这一步有没有必要呢？还是有的，会更清晰，否则下面的else要多写一个不太清晰的else
44 | }
45 | }
46 | } else {
47 | // 这里 isSelfNeedEvent 条件判断应该放在 isChildNeedEvent 前面
48 | // 因为两个都为真的情况只能是自己之后通过 onIntercept 抢了控制权，那这之后的控制权就不会去 child 那儿了
49 | if (isSelfNeedEvent) {
50 | handled = onTouch(ev);
51 | } else if (isChildNeedEvent) {
52 | if (!isDisallowIntercept && onIntercept(ev)) {
53 | isSelfNeedEvent = true;
54 |
55 | MotionEvent cancel = MotionEvent.obtain(ev);
56 | cancel.setAction(MotionEvent.ACTION_CANCEL);
57 | handled = child.dispatch(cancel);
58 | cancel.recycle();
59 | } else {
60 | handled = child.dispatch(ev);
61 | }
62 | }
63 | // 这里不用再 else 了，因为如果 isSelfNeedEvent 和 isChildNeedEvent 都不为 true，上面不会再发事件下来了
64 | }
65 |
66 | if (ev.getActionMasked() == MotionEvent.ACTION_UP || ev.getActionMasked() == MotionEvent.ACTION_CANCEL) {
67 | this.clearStatus();
68 | }
69 |
70 | return handled;
71 | }
72 |
73 | private void clearStatus() {
74 | isChildNeedEvent = false;
75 | isSelfNeedEvent = false;
76 | isDisallowIntercept = false;
77 | }
78 |
79 | public boolean onIntercept(MotionEvent ev) {
80 | return false;
81 | }
82 |
83 | @Override
84 | public boolean onTouch(MotionEvent ev) {
85 | return false;
86 | }
87 |
88 | @Override
89 | public void requestDisallowInterceptTouchEvent(boolean isDisallowIntercept) {
90 | this.isDisallowIntercept = isDisallowIntercept;
91 | if (parent != null) {
92 | parent.requestDisallowInterceptTouchEvent(isDisallowIntercept);
93 | }
94 | }
95 | }
96 |
--------------------------------------------------------------------------------
/app/src/main/res/drawable/ic_launcher_background.xml:
--------------------------------------------------------------------------------
1 |
2 |
8 |
10 |
12 |
14 |
16 |
18 |
20 |
22 |
24 |
26 |
28 |
30 |
32 |
34 |
36 |
38 |
40 |
42 |
44 |
46 |
48 |
50 |
52 |
54 |
56 |
58 |
60 |
62 |
64 |
66 |
68 |
70 |
72 |
74 |
75 |
--------------------------------------------------------------------------------
/app/src/main/java/com/rubitree/dispatchtoucheventtutorial/sparrowdispatch/sparrow5/SparrowDispatch.kt:
--------------------------------------------------------------------------------
1 | package com.rubitree.dispatchtoucheventtutorial.sparrowdispatch.sparrow5
2 |
3 | import android.view.MotionEvent
4 |
5 | /**
6 | * >> Description <<
7 | *
8 | * >> Attention <<
9 | *
10 | * >> Others <<
11 | *
12 | * Created by RubiTree ; On 2019-01-14.
13 | */
14 | interface ViewParent {
15 | fun requestDisallowInterceptTouchEvent(isDisallowIntercept: Boolean)
16 | }
17 |
18 | open class MView {
19 | var parent: ViewParent? = null
20 |
21 | open fun dispatch(ev: MotionEvent): Boolean {
22 | // 源码里没有这么直接但区别不大，主要会考虑是否设置了 onTouchListener 和是否 enable
23 | return onTouch(ev)
24 | }
25 |
26 | open fun onTouch(ev: MotionEvent): Boolean {
27 | return false
28 | }
29 | }
30 |
31 | open class MViewGroup(private val child: MView) : MView(), ViewParent {
32 | private var isChildNeedEvent = false
33 | private var isSelfNeedEvent = false
34 | private var isDisallowIntercept = false
35 |
36 | init {
37 | child.parent = this // 这里只是示意，实际中不建议这么写，会造成提前发布未构造完成的实例
38 | }
39 |
40 | override fun dispatch(ev: MotionEvent): Boolean {
41 | var handled = false
42 |
43 | if (ev.actionMasked == MotionEvent.ACTION_DOWN) {
44 | clearStatus()
45 |
46 | if (!isDisallowIntercept && onIntercept(ev)) {
47 | isSelfNeedEvent = true
48 | handled = onTouch(ev)
49 | } else {
50 | handled = child.dispatch(ev)
51 | if (handled) isChildNeedEvent = true
52 |
53 | if (!handled) { // 这里没有用 if else 是因为这样写上下一致，更清晰
54 | handled = onTouch(ev)
55 | if (handled) isSelfNeedEvent = true // 这一步有没有必要呢？还是有的，会更清晰，否则下面的else要多写一个不太清晰的else
56 | }
57 | }
58 | } else {
59 | // 这里 isSelfNeedEvent 条件判断应该放在 isChildNeedEvent 前面
60 | // 因为两个都为真的情况只能是自己之后通过 onIntercept 抢了控制权，那这之后的控制权就不会去 child 那儿了
61 | if (isSelfNeedEvent) {
62 | handled = onTouch(ev)
63 | } else if (isChildNeedEvent) {
64 | if (!isDisallowIntercept && onIntercept(ev)) {
65 | isSelfNeedEvent = true
66 |
67 | val cancel = MotionEvent.obtain(ev)
68 | cancel.action = MotionEvent.ACTION_CANCEL
69 | handled = child.dispatch(cancel)
70 | cancel.recycle()
71 | } else {
72 | handled = child.dispatch(ev)
73 | }
74 | }
75 | // 这里不用再 else 了，因为如果 isSelfNeedEvent 和 isChildNeedEvent 都不为 true，上面不会再发事件下来了
76 | }
77 |
78 | if (ev.actionMasked == MotionEvent.ACTION_UP
79 | || ev.actionMasked == MotionEvent.ACTION_CANCEL) {
80 | clearStatus()
81 | }
82 |
83 | return handled
84 | }
85 |
86 | private fun clearStatus() {
87 | isChildNeedEvent = false
88 | isSelfNeedEvent = false
89 | isDisallowIntercept = false
90 | }
91 |
92 | override fun onTouch(ev: MotionEvent): Boolean {
93 | return false
94 | }
95 |
96 | open fun onIntercept(ev: MotionEvent): Boolean {
97 | return false
98 | }
99 |
100 | override fun requestDisallowInterceptTouchEvent(isDisallowIntercept: Boolean) {
101 | this.isDisallowIntercept = isDisallowIntercept
102 | parent?.requestDisallowInterceptTouchEvent(isDisallowIntercept)
103 | }
104 | }
105 |
106 | /**
107 | * 这里的大逻辑类似 MViewGroup，但细节很多不同，主要因为没有 onIntercept，会简单一些
108 | */
109 | open class MActivity(private val childGroup: MViewGroup) {
110 | private var isChildNeedEvent = false
111 | private var isSelfNeedEvent = false
112 |
113 | open fun dispatch(ev: MotionEvent): Boolean {
114 | var handled = false
115 |
116 | if (ev.actionMasked == MotionEvent.ACTION_DOWN) {
117 | clearStatus()
118 |
119 | handled = childGroup.dispatch(ev)
120 | if (handled) isChildNeedEvent = true
121 |
122 | if (!handled) {
123 | handled = onTouch(ev)
124 | if (handled) isSelfNeedEvent = true
125 | }
126 | } else {
127 | // 这里 isSelfNeedEvent 和 isChildNeedEvent 不会同时为真，顺序无所谓
128 | if (isSelfNeedEvent) {
129 | handled = onTouch(ev)
130 | } else if (isChildNeedEvent) {
131 | handled = childGroup.dispatch(ev)
132 | }
133 |
134 | if (!handled) handled = onTouch(ev)
135 | }
136 |
137 | if (ev.actionMasked == MotionEvent.ACTION_UP
138 | || ev.actionMasked == MotionEvent.ACTION_CANCEL) {
139 | clearStatus()
140 | }
141 |
142 | return handled
143 | }
144 |
145 | private fun clearStatus() {
146 | isChildNeedEvent = false
147 | isSelfNeedEvent = false
148 | }
149 |
150 | open fun onTouch(ev: MotionEvent): Boolean {
151 | return false
152 | }
153 | }
--------------------------------------------------------------------------------
/.idea/markdown-navigator.xml:
--------------------------------------------------------------------------------
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 |
--------------------------------------------------------------------------------
/gradlew:
--------------------------------------------------------------------------------
1 | #!/usr/bin/env sh
2 |
3 | ##############################################################################
4 | ##
5 | ## Gradle start up script for UN*X
6 | ##
7 | ##############################################################################
8 |
9 | # Attempt to set APP_HOME
10 | # Resolve links: $0 may be a link
11 | PRG="$0"
12 | # Need this for relative symlinks.
13 | while [ -h "$PRG" ] ; do
14 | ls=`ls -ld "$PRG"`
15 | link=`expr "$ls" : '.*-> \(.*\)$'`
16 | if expr "$link" : '/.*' > /dev/null; then
17 | PRG="$link"
18 | else
19 | PRG=`dirname "$PRG"`"/$link"
20 | fi
21 | done
22 | SAVED="`pwd`"
23 | cd "`dirname \"$PRG\"`/" >/dev/null
24 | APP_HOME="`pwd -P`"
25 | cd "$SAVED" >/dev/null
26 |
27 | APP_NAME="Gradle"
28 | APP_BASE_NAME=`basename "$0"`
29 |
30 | # Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
31 | DEFAULT_JVM_OPTS=""
32 |
33 | # Use the maximum available, or set MAX_FD != -1 to use that value.
34 | MAX_FD="maximum"
35 |
36 | warn () {
37 | echo "$*"
38 | }
39 |
40 | die () {
41 | echo
42 | echo "$*"
43 | echo
44 | exit 1
45 | }
46 |
47 | # OS specific support (must be 'true' or 'false').
48 | cygwin=false
49 | msys=false
50 | darwin=false
51 | nonstop=false
52 | case "`uname`" in
53 | CYGWIN* )
54 | cygwin=true
55 | ;;
56 | Darwin* )
57 | darwin=true
58 | ;;
59 | MINGW* )
60 | msys=true
61 | ;;
62 | NONSTOP* )
63 | nonstop=true
64 | ;;
65 | esac
66 |
67 | CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar
68 |
69 | # Determine the Java command to use to start the JVM.
70 | if [ -n "$JAVA_HOME" ] ; then
71 | if [ -x "$JAVA_HOME/jre/sh/java" ] ; then
72 | # IBM's JDK on AIX uses strange locations for the executables
73 | JAVACMD="$JAVA_HOME/jre/sh/java"
74 | else
75 | JAVACMD="$JAVA_HOME/bin/java"
76 | fi
77 | if [ ! -x "$JAVACMD" ] ; then
78 | die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME
79 |
80 | Please set the JAVA_HOME variable in your environment to match the
81 | location of your Java installation."
82 | fi
83 | else
84 | JAVACMD="java"
85 | which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
86 |
87 | Please set the JAVA_HOME variable in your environment to match the
88 | location of your Java installation."
89 | fi
90 |
91 | # Increase the maximum file descriptors if we can.
92 | if [ "$cygwin" = "false" -a "$darwin" = "false" -a "$nonstop" = "false" ] ; then
93 | MAX_FD_LIMIT=`ulimit -H -n`
94 | if [ $? -eq 0 ] ; then
95 | if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then
96 | MAX_FD="$MAX_FD_LIMIT"
97 | fi
98 | ulimit -n $MAX_FD
99 | if [ $? -ne 0 ] ; then
100 | warn "Could not set maximum file descriptor limit: $MAX_FD"
101 | fi
102 | else
103 | warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT"
104 | fi
105 | fi
106 |
107 | # For Darwin, add options to specify how the application appears in the dock
108 | if $darwin; then
109 | GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\""
110 | fi
111 |
112 | # For Cygwin, switch paths to Windows format before running java
113 | if $cygwin ; then
114 | APP_HOME=`cygpath --path --mixed "$APP_HOME"`
115 | CLASSPATH=`cygpath --path --mixed "$CLASSPATH"`
116 | JAVACMD=`cygpath --unix "$JAVACMD"`
117 |
118 | # We build the pattern for arguments to be converted via cygpath
119 | ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null`
120 | SEP=""
121 | for dir in $ROOTDIRSRAW ; do
122 | ROOTDIRS="$ROOTDIRS$SEP$dir"
123 | SEP="|"
124 | done
125 | OURCYGPATTERN="(^($ROOTDIRS))"
126 | # Add a user-defined pattern to the cygpath arguments
127 | if [ "$GRADLE_CYGPATTERN" != "" ] ; then
128 | OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)"
129 | fi
130 | # Now convert the arguments - kludge to limit ourselves to /bin/sh
131 | i=0
132 | for arg in "$@" ; do
133 | CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -`
134 | CHECK2=`echo "$arg"|egrep -c "^-"` ### Determine if an option
135 |
136 | if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then ### Added a condition
137 | eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"`
138 | else
139 | eval `echo args$i`="\"$arg\""
140 | fi
141 | i=$((i+1))
142 | done
143 | case $i in
144 | (0) set -- ;;
145 | (1) set -- "$args0" ;;
146 | (2) set -- "$args0" "$args1" ;;
147 | (3) set -- "$args0" "$args1" "$args2" ;;
148 | (4) set -- "$args0" "$args1" "$args2" "$args3" ;;
149 | (5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;;
150 | (6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;;
151 | (7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;;
152 | (8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;;
153 | (9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;;
154 | esac
155 | fi
156 |
157 | # Escape application args
158 | save () {
159 | for i do printf %s\\n "$i" | sed "s/'/'\\\\''/g;1s/^/'/;\$s/\$/' \\\\/" ; done
160 | echo " "
161 | }
162 | APP_ARGS=$(save "$@")
163 |
164 | # Collect all arguments for the java command, following the shell quoting and substitution rules
165 | eval set -- $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS "\"-Dorg.gradle.appname=$APP_BASE_NAME\"" -classpath "\"$CLASSPATH\"" org.gradle.wrapper.GradleWrapperMain "$APP_ARGS"
166 |
167 | # by default we should be in the correct project dir, but when run from Finder on Mac, the cwd is wrong
168 | if [ "$(uname)" = "Darwin" ] && [ "$HOME" = "$PWD" ]; then
169 | cd "$(dirname "$0")"
170 | fi
171 |
172 | exec "$JAVACMD" "$@"
173 |
--------------------------------------------------------------------------------
/readme.md:
--------------------------------------------------------------------------------
1 | # Dispatch TouchEvent Tutorial
2 |
3 |
4 |
5 | ## SparrowDispatch
6 |
7 | 可以在此处查看详细内容：[《看穿 > 触摸事件分发》](https://juejin.im/post/5c3c8538f265da6142741d63)
8 |
9 | [SparrowDispatch](https://github.com/RubiTree/DispatchTouchEventTutorial/blob/master/app/src/main/java/com/rubitree/dispatchtoucheventtutorial/sparrowdispatch/sparrow5/SparrowDispatch.kt)把源码中与事件分发相关的内容剥离了出来，至少有这两个优点：
10 |
11 | 1. 相比源码，这份代码足够短足够简单，那些跟事件分发无关的东西通通不要来干扰我
12 | 1. 长度总共不超过150行，剔除了所有跟事件分发无关的代码，并且把一些因为其他细节导致写得比较复杂的逻辑，用更简单直接的方式表达了
13 | 1. 相比那段经典的事件分发伪代码，这份代码又足够详细，详细到能告诉你所有你需要知道的事件分发的具体细节
14 | 1. 那段经典伪代码只能起到提纲挈领的作用，而这份麻雀代码虽然极其精简但它五脏俱全，全到可以直接跑
15 | 1. 你可以用它进行为伪布局，然后触发触摸事件，如果在回调中打印日志，它打印出的事件分发过程与你使用系统控件真实布局时事件分发的过程是一模一样的
16 |
17 | ## 测试
18 |
19 | 测试的思路是通过在每个事件分发的钩子中打印日志来跟踪事件分发的过程。
20 | 于是就需要在不同的 View 层级的不同钩子中，针对不同的触摸事件进行不同的操作，以制造各种事件分发的场景。
21 |
22 | 为了减少重复代码简单搭建了一个测试框架，包括一个可以代理 View 中这些的操作的接口`IDispatchDelegate`及其实现类，和一个`DispatchConfig`统一进行不同的场景的配置。
23 | 之后创建了使用统一配置和代理操作的 真实控件们`SystemViews` 和 用`SparrowDispatch`实现的麻雀控件们`SparrowViews`。
24 |
25 | 在`DispatchConfig`中配置好事件分发的策略后，直接启动`SystemViews`中的`DelegatedActivity`，进行触摸，使用关键字`TouchDojo`过滤，就能得到事件分发的跟踪日志。
26 | 同时，运行`SparrowActivityTest`中的`dispatch()`测试方法，也能得到麻雀控件的事件分发跟踪日志。
27 |
28 | ### 场景一
29 |
30 | 先配置策略，模拟`View`和`ViewGroup`都不消费事件的场景：
31 |
32 | ```kotlin
33 | fun getActivityDispatchDelegate(layer: String = "Activity"): IDispatchDelegate {
34 | return DispatchDelegate(layer)
35 | }
36 |
37 | fun getViewGroupDispatchDelegate(layer: String = "ViewGroup"): IDispatchDelegate {
38 | return DispatchDelegate(layer)
39 | }
40 |
41 | fun getViewDispatchDelegate(layer: String = "View"): IDispatchDelegate {
42 | return DispatchDelegate(layer)
43 | }
44 | ```
45 |
46 | 能看到打印的事件分发跟踪日志：
47 |
48 | ```log
49 | [down]
50 | |layer:SActivity |on:Dispatch_BE |type:down
51 | |layer:SViewGroup |on:Dispatch_BE |type:down
52 | |layer:SViewGroup |on:Intercept_BE |type:down
53 | |layer:SViewGroup |on:Intercept_AF |result(super):false |type:down
54 | |layer:SView |on:Dispatch_BE |type:down
55 | |layer:SView |on:Touch_BE |type:down
56 | |layer:SView |on:Touch_AF |result(super):false |type:down
57 | |layer:SView |on:Dispatch_AF |result(super):false |type:down
58 | |layer:SViewGroup |on:Touch_BE |type:down
59 | |layer:SViewGroup |on:Touch_AF |result(super):false |type:down
60 | |layer:SViewGroup |on:Dispatch_AF |result(super):false |type:down
61 | |layer:SActivity |on:Touch_BE |type:down
62 | |layer:SActivity |on:Touch_AF |result(super):false |type:down
63 | |layer:SActivity |on:Dispatch_AF |result(super):false |type:down
64 |
65 | [move]
66 | |layer:SActivity |on:Dispatch_BE |type:move
67 | |layer:SActivity |on:Touch_BE |type:move
68 | |layer:SActivity |on:Touch_AF |result(super):false |type:move
69 | |layer:SActivity |on:Dispatch_AF |result(super):false |type:move
70 |
71 | [move]
72 | ...
73 |
74 | [up]
75 | |layer:SActivity |on:Dispatch_BE |type:up
76 | |layer:SActivity |on:Touch_BE |type:up
77 | |layer:SActivity |on:Touch_AF |result(super):false |type:up
78 | |layer:SActivity |on:Dispatch_AF |result(super):false |type:up
79 | ```
80 |
81 | 1. 因为系统控件和麻雀控件打印的日志一模一样，所以只贴出一份
82 | 2. 这里用`BE`代表 `before`，表示该方法开始处理事件的时候，用`AF`代表`after`，表示该方法结束处理事件的时候，并且打印处理的结果
83 | 3. 从日志中能清楚看到，当`View`和`ViewGroup`都不消费`DOWN`事件时，后续事件将不再传递给`View`和`ViewGroup`
84 |
85 | ### 场景二
86 |
87 | 再配置策略，模拟`View`和`ViewGroup`都消费事件，同时`ViewGroup`在第二个`MOVE`事件时认为自己需要拦截事件的场景：
88 |
89 | ```kotlin
90 | fun getActivityDispatchDelegate(layer: String = "Activity"): IDispatchDelegate {
91 | return DispatchDelegate(layer)
92 | }
93 |
94 | fun getViewGroupDispatchDelegate(layer: String = "ViewGroup"): IDispatchDelegate {
95 | return DispatchDelegate(
96 | layer,
97 | ALL_SUPER,
98 | // 表示 onInterceptTouchEvent 方法中，DOWN 事件返回 false，第一个 MOVE 事件返回 false，第二个第三个 MOVE 事件返回 true
99 | EventsReturnStrategy(T_FALSE, arrayOf(T_FALSE, T_TRUE, T_TRUE), T_SUPER),
100 | ALL_TRUE
101 | )
102 | }
103 |
104 | fun getViewDispatchDelegate(layer: String = "View"): IDispatchDelegate {
105 | return DispatchDelegate(layer, ALL_SUPER, ALL_SUPER, ALL_TRUE)
106 | }
107 | ```
108 |
109 | 能看到打印的事件分发跟踪日志：
110 |
111 | ```log
112 | [down]
113 | |layer:SActivity |on:Dispatch_BE |type:down
114 | |layer:SViewGroup |on:Dispatch_BE |type:down
115 | |layer:SViewGroup |on:Intercept |result(false):false |type:down
116 | |layer:SView |on:Dispatch_BE |type:down
117 | |layer:SView |on:Touch |result(true):true |type:down
118 | |layer:SView |on:Dispatch_AF |result(super):true |type:down
119 | |layer:SViewGroup |on:Dispatch_AF |result(super):true |type:down
120 | |layer:SActivity |on:Dispatch_AF |result(super):true |type:down
121 |
122 | [move]
123 | |layer:SActivity |on:Dispatch_BE |type:move
124 | |layer:SViewGroup |on:Dispatch_BE |type:move
125 | |layer:SViewGroup |on:Intercept |result(false):false |type:move
126 | |layer:SView |on:Dispatch_BE |type:move
127 | |layer:SView |on:Touch |result(true):true |type:move
128 | |layer:SView |on:Dispatch_AF |result(super):true |type:move
129 | |layer:SViewGroup |on:Dispatch_AF |result(super):true |type:move
130 | |layer:SActivity |on:Dispatch_AF |result(super):true |type:move
131 |
132 | [move]
133 | |layer:SActivity |on:Dispatch_BE |type:move
134 | |layer:SViewGroup |on:Dispatch_BE |type:move
135 | |layer:SViewGroup |on:Intercept |result(true):true |type:move
136 | |layer:SView |on:Dispatch_BE |type:cancel
137 | |layer:SView |on:Touch_BE |type:cancel
138 | |layer:SView |on:Touch_AF |result(super):false |type:cancel
139 | |layer:SView |on:Dispatch_AF |result(super):false |type:cancel
140 | |layer:SViewGroup |on:Dispatch_AF |result(super):false |type:move
141 | |layer:SActivity |on:Touch_BE |type:move
142 | |layer:SActivity |on:Touch_AF |result(super):false |type:move
143 | |layer:SActivity |on:Dispatch_AF |result(super):false |type:move
144 |
145 | [move]
146 | |layer:SActivity |on:Dispatch_BE |type:move
147 | |layer:SViewGroup |on:Dispatch_BE |type:move
148 | |layer:SViewGroup |on:Touch |result(true):true |type:move
149 | |layer:SViewGroup |on:Dispatch_AF |result(super):true |type:move
150 | |layer:SActivity |on:Dispatch_AF |result(super):true |type:move
151 |
152 | [up]
153 | |layer:SActivity |on:Dispatch_BE |type:up
154 | |layer:SViewGroup |on:Dispatch_BE |type:up
155 | |layer:SViewGroup |on:Touch |result(true):true |type:up
156 | |layer:SViewGroup |on:Dispatch_AF |result(super):true |type:up
157 | |layer:SActivity |on:Dispatch_AF |result(super):true |type:up
158 | ```
159 |
160 | 1. 同样因为系统控件和麻雀控件打印的日志一模一样，所以只贴出一份
161 | 2. 从日志中能清楚看到，在`ViewGroup`拦截事件前后，事件是如何分发的
162 |
163 | ## License
164 | Apache License 2.0, here is the [LICENSE](https://github.com/RubiTree/DispatchTouchEventTutorial/blob/master/LICENSE).
165 |
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | Apache License
2 | Version 2.0, January 2004
3 | http://www.apache.org/licenses/
4 |
5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6 |
7 | 1. Definitions.
8 |
9 | "License" shall mean the terms and conditions for use, reproduction,
10 | and distribution as defined by Sections 1 through 9 of this document.
11 |
12 | "Licensor" shall mean the copyright owner or entity authorized by
13 | the copyright owner that is granting the License.
14 |
15 | "Legal Entity" shall mean the union of the acting entity and all
16 | other entities that control, are controlled by, or are under common
17 | control with that entity. For the purposes of this definition,
18 | "control" means (i) the power, direct or indirect, to cause the
19 | direction or management of such entity, whether by contract or
20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the
21 | outstanding shares, or (iii) beneficial ownership of such entity.
22 |
23 | "You" (or "Your") shall mean an individual or Legal Entity
24 | exercising permissions granted by this License.
25 |
26 | "Source" form shall mean the preferred form for making modifications,
27 | including but not limited to software source code, documentation
28 | source, and configuration files.
29 |
30 | "Object" form shall mean any form resulting from mechanical
31 | transformation or translation of a Source form, including but
32 | not limited to compiled object code, generated documentation,
33 | and conversions to other media types.
34 |
35 | "Work" shall mean the work of authorship, whether in Source or
36 | Object form, made available under the License, as indicated by a
37 | copyright notice that is included in or attached to the work
38 | (an example is provided in the Appendix below).
39 |
40 | "Derivative Works" shall mean any work, whether in Source or Object
41 | form, that is based on (or derived from) the Work and for which the
42 | editorial revisions, annotations, elaborations, or other modifications
43 | represent, as a whole, an original work of authorship. For the purposes
44 | of this License, Derivative Works shall not include works that remain
45 | separable from, or merely link (or bind by name) to the interfaces of,
46 | the Work and Derivative Works thereof.
47 |
48 | "Contribution" shall mean any work of authorship, including
49 | the original version of the Work and any modifications or additions
50 | to that Work or Derivative Works thereof, that is intentionally
51 | submitted to Licensor for inclusion in the Work by the copyright owner
52 | or by an individual or Legal Entity authorized to submit on behalf of
53 | the copyright owner. For the purposes of this definition, "submitted"
54 | means any form of electronic, verbal, or written communication sent
55 | to the Licensor or its representatives, including but not limited to
56 | communication on electronic mailing lists, source code control systems,
57 | and issue tracking systems that are managed by, or on behalf of, the
58 | Licensor for the purpose of discussing and improving the Work, but
59 | excluding communication that is conspicuously marked or otherwise
60 | designated in writing by the copyright owner as "Not a Contribution."
61 |
62 | "Contributor" shall mean Licensor and any individual or Legal Entity
63 | on behalf of whom a Contribution has been received by Licensor and
64 | subsequently incorporated within the Work.
65 |
66 | 2. Grant of Copyright License. Subject to the terms and conditions of
67 | this License, each Contributor hereby grants to You a perpetual,
68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69 | copyright license to reproduce, prepare Derivative Works of,
70 | publicly display, publicly perform, sublicense, and distribute the
71 | Work and such Derivative Works in Source or Object form.
72 |
73 | 3. Grant of Patent License. Subject to the terms and conditions of
74 | this License, each Contributor hereby grants to You a perpetual,
75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76 | (except as stated in this section) patent license to make, have made,
77 | use, offer to sell, sell, import, and otherwise transfer the Work,
78 | where such license applies only to those patent claims licensable
79 | by such Contributor that are necessarily infringed by their
80 | Contribution(s) alone or by combination of their Contribution(s)
81 | with the Work to which such Contribution(s) was submitted. If You
82 | institute patent litigation against any entity (including a
83 | cross-claim or counterclaim in a lawsuit) alleging that the Work
84 | or a Contribution incorporated within the Work constitutes direct
85 | or contributory patent infringement, then any patent licenses
86 | granted to You under this License for that Work shall terminate
87 | as of the date such litigation is filed.
88 |
89 | 4. Redistribution. You may reproduce and distribute copies of the
90 | Work or Derivative Works thereof in any medium, with or without
91 | modifications, and in Source or Object form, provided that You
92 | meet the following conditions:
93 |
94 | (a) You must give any other recipients of the Work or
95 | Derivative Works a copy of this License; and
96 |
97 | (b) You must cause any modified files to carry prominent notices
98 | stating that You changed the files; and
99 |
100 | (c) You must retain, in the Source form of any Derivative Works
101 | that You distribute, all copyright, patent, trademark, and
102 | attribution notices from the Source form of the Work,
103 | excluding those notices that do not pertain to any part of
104 | the Derivative Works; and
105 |
106 | (d) If the Work includes a "NOTICE" text file as part of its
107 | distribution, then any Derivative Works that You distribute must
108 | include a readable copy of the attribution notices contained
109 | within such NOTICE file, excluding those notices that do not
110 | pertain to any part of the Derivative Works, in at least one
111 | of the following places: within a NOTICE text file distributed
112 | as part of the Derivative Works; within the Source form or
113 | documentation, if provided along with the Derivative Works; or,
114 | within a display generated by the Derivative Works, if and
115 | wherever such third-party notices normally appear. The contents
116 | of the NOTICE file are for informational purposes only and
117 | do not modify the License. You may add Your own attribution
118 | notices within Derivative Works that You distribute, alongside
119 | or as an addendum to the NOTICE text from the Work, provided
120 | that such additional attribution notices cannot be construed
121 | as modifying the License.
122 |
123 | You may add Your own copyright statement to Your modifications and
124 | may provide additional or different license terms and conditions
125 | for use, reproduction, or distribution of Your modifications, or
126 | for any such Derivative Works as a whole, provided Your use,
127 | reproduction, and distribution of the Work otherwise complies with
128 | the conditions stated in this License.
129 |
130 | 5. Submission of Contributions. Unless You explicitly state otherwise,
131 | any Contribution intentionally submitted for inclusion in the Work
132 | by You to the Licensor shall be under the terms and conditions of
133 | this License, without any additional terms or conditions.
134 | Notwithstanding the above, nothing herein shall supersede or modify
135 | the terms of any separate license agreement you may have executed
136 | with Licensor regarding such Contributions.
137 |
138 | 6. Trademarks. This License does not grant permission to use the trade
139 | names, trademarks, service marks, or product names of the Licensor,
140 | except as required for reasonable and customary use in describing the
141 | origin of the Work and reproducing the content of the NOTICE file.
142 |
143 | 7. Disclaimer of Warranty. Unless required by applicable law or
144 | agreed to in writing, Licensor provides the Work (and each
145 | Contributor provides its Contributions) on an "AS IS" BASIS,
146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147 | implied, including, without limitation, any warranties or conditions
148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149 | PARTICULAR PURPOSE. You are solely responsible for determining the
150 | appropriateness of using or redistributing the Work and assume any
151 | risks associated with Your exercise of permissions under this License.
152 |
153 | 8. Limitation of Liability. In no event and under no legal theory,
154 | whether in tort (including negligence), contract, or otherwise,
155 | unless required by applicable law (such as deliberate and grossly
156 | negligent acts) or agreed to in writing, shall any Contributor be
157 | liable to You for damages, including any direct, indirect, special,
158 | incidental, or consequential damages of any character arising as a
159 | result of this License or out of the use or inability to use the
160 | Work (including but not limited to damages for loss of goodwill,
161 | work stoppage, computer failure or malfunction, or any and all
162 | other commercial damages or losses), even if such Contributor
163 | has been advised of the possibility of such damages.
164 |
165 | 9. Accepting Warranty or Additional Liability. While redistributing
166 | the Work or Derivative Works thereof, You may choose to offer,
167 | and charge a fee for, acceptance of support, warranty, indemnity,
168 | or other liability obligations and/or rights consistent with this
169 | License. However, in accepting such obligations, You may act only
170 | on Your own behalf and on Your sole responsibility, not on behalf
171 | of any other Contributor, and only if You agree to indemnify,
172 | defend, and hold each Contributor harmless for any liability
173 | incurred by, or claims asserted against, such Contributor by reason
174 | of your accepting any such warranty or additional liability.
175 |
176 | END OF TERMS AND CONDITIONS
177 |
178 | APPENDIX: How to apply the Apache License to your work.
179 |
180 | To apply the Apache License to your work, attach the following
181 | boilerplate notice, with the fields enclosed by brackets "{}"
182 | replaced with your own identifying information. (Don't include
183 | the brackets!) The text should be enclosed in the appropriate
184 | comment syntax for the file format. We also recommend that a
185 | file or class name and description of purpose be included on the
186 | same "printed page" as the copyright notice for easier
187 | identification within third-party archives.
188 |
189 | Copyright {yyyy} {name of copyright owner}
190 |
191 | Licensed under the Apache License, Version 2.0 (the "License");
192 | you may not use this file except in compliance with the License.
193 | You may obtain a copy of the License at
194 |
195 | http://www.apache.org/licenses/LICENSE-2.0
196 |
197 | Unless required by applicable law or agreed to in writing, software
198 | distributed under the License is distributed on an "AS IS" BASIS,
199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200 | See the License for the specific language governing permissions and
201 | limitations under the License.
202 |
--------------------------------------------------------------------------------
4 |
5 | ## SparrowDispatch
6 |
7 | 可以在此处查看详细内容：[《看穿 > 触摸事件分发》](https://juejin.im/post/5c3c8538f265da6142741d63)
8 |
9 | [SparrowDispatch](https://github.com/RubiTree/DispatchTouchEventTutorial/blob/master/app/src/main/java/com/rubitree/dispatchtoucheventtutorial/sparrowdispatch/sparrow5/SparrowDispatch.kt)把源码中与事件分发相关的内容剥离了出来，至少有这两个优点：
10 |
11 | 1. 相比源码，这份代码足够短足够简单，那些跟事件分发无关的东西通通不要来干扰我
12 | 1. 长度总共不超过150行，剔除了所有跟事件分发无关的代码，并且把一些因为其他细节导致写得比较复杂的逻辑，用更简单直接的方式表达了
13 | 1. 相比那段经典的事件分发伪代码，这份代码又足够详细，详细到能告诉你所有你需要知道的事件分发的具体细节
14 | 1. 那段经典伪代码只能起到提纲挈领的作用，而这份麻雀代码虽然极其精简但它五脏俱全，全到可以直接跑
15 | 1. 你可以用它进行为伪布局，然后触发触摸事件，如果在回调中打印日志，它打印出的事件分发过程与你使用系统控件真实布局时事件分发的过程是一模一样的
16 |
17 | ## 测试
18 |
19 | 测试的思路是通过在每个事件分发的钩子中打印日志来跟踪事件分发的过程。
20 | 于是就需要在不同的 View 层级的不同钩子中，针对不同的触摸事件进行不同的操作，以制造各种事件分发的场景。
21 |
22 | 为了减少重复代码简单搭建了一个测试框架，包括一个可以代理 View 中这些的操作的接口`IDispatchDelegate`及其实现类，和一个`DispatchConfig`统一进行不同的场景的配置。
23 | 之后创建了使用统一配置和代理操作的 真实控件们`SystemViews` 和 用`SparrowDispatch`实现的麻雀控件们`SparrowViews`。
24 |
25 | 在`DispatchConfig`中配置好事件分发的策略后，直接启动`SystemViews`中的`DelegatedActivity`，进行触摸，使用关键字`TouchDojo`过滤，就能得到事件分发的跟踪日志。
26 | 同时，运行`SparrowActivityTest`中的`dispatch()`测试方法，也能得到麻雀控件的事件分发跟踪日志。
27 |
28 | ### 场景一
29 |
30 | 先配置策略，模拟`View`和`ViewGroup`都不消费事件的场景：
31 |
32 | ```kotlin
33 | fun getActivityDispatchDelegate(layer: String = "Activity"): IDispatchDelegate {
34 | return DispatchDelegate(layer)
35 | }
36 |
37 | fun getViewGroupDispatchDelegate(layer: String = "ViewGroup"): IDispatchDelegate {
38 | return DispatchDelegate(layer)
39 | }
40 |
41 | fun getViewDispatchDelegate(layer: String = "View"): IDispatchDelegate {
42 | return DispatchDelegate(layer)
43 | }
44 | ```
45 |
46 | 能看到打印的事件分发跟踪日志：
47 |
48 | ```log
49 | [down]
50 | |layer:SActivity |on:Dispatch_BE |type:down
51 | |layer:SViewGroup |on:Dispatch_BE |type:down
52 | |layer:SViewGroup |on:Intercept_BE |type:down
53 | |layer:SViewGroup |on:Intercept_AF |result(super):false |type:down
54 | |layer:SView |on:Dispatch_BE |type:down
55 | |layer:SView |on:Touch_BE |type:down
56 | |layer:SView |on:Touch_AF |result(super):false |type:down
57 | |layer:SView |on:Dispatch_AF |result(super):false |type:down
58 | |layer:SViewGroup |on:Touch_BE |type:down
59 | |layer:SViewGroup |on:Touch_AF |result(super):false |type:down
60 | |layer:SViewGroup |on:Dispatch_AF |result(super):false |type:down
61 | |layer:SActivity |on:Touch_BE |type:down
62 | |layer:SActivity |on:Touch_AF |result(super):false |type:down
63 | |layer:SActivity |on:Dispatch_AF |result(super):false |type:down
64 |
65 | [move]
66 | |layer:SActivity |on:Dispatch_BE |type:move
67 | |layer:SActivity |on:Touch_BE |type:move
68 | |layer:SActivity |on:Touch_AF |result(super):false |type:move
69 | |layer:SActivity |on:Dispatch_AF |result(super):false |type:move
70 |
71 | [move]
72 | ...
73 |
74 | [up]
75 | |layer:SActivity |on:Dispatch_BE |type:up
76 | |layer:SActivity |on:Touch_BE |type:up
77 | |layer:SActivity |on:Touch_AF |result(super):false |type:up
78 | |layer:SActivity |on:Dispatch_AF |result(super):false |type:up
79 | ```
80 |
81 | 1. 因为系统控件和麻雀控件打印的日志一模一样，所以只贴出一份
82 | 2. 这里用`BE`代表 `before`，表示该方法开始处理事件的时候，用`AF`代表`after`，表示该方法结束处理事件的时候，并且打印处理的结果
83 | 3. 从日志中能清楚看到，当`View`和`ViewGroup`都不消费`DOWN`事件时，后续事件将不再传递给`View`和`ViewGroup`
84 |
85 | ### 场景二
86 |
87 | 再配置策略，模拟`View`和`ViewGroup`都消费事件，同时`ViewGroup`在第二个`MOVE`事件时认为自己需要拦截事件的场景：
88 |
89 | ```kotlin
90 | fun getActivityDispatchDelegate(layer: String = "Activity"): IDispatchDelegate {
91 | return DispatchDelegate(layer)
92 | }
93 |
94 | fun getViewGroupDispatchDelegate(layer: String = "ViewGroup"): IDispatchDelegate {
95 | return DispatchDelegate(
96 | layer,
97 | ALL_SUPER,
98 | // 表示 onInterceptTouchEvent 方法中，DOWN 事件返回 false，第一个 MOVE 事件返回 false，第二个第三个 MOVE 事件返回 true
99 | EventsReturnStrategy(T_FALSE, arrayOf(T_FALSE, T_TRUE, T_TRUE), T_SUPER),
100 | ALL_TRUE
101 | )
102 | }
103 |
104 | fun getViewDispatchDelegate(layer: String = "View"): IDispatchDelegate {
105 | return DispatchDelegate(layer, ALL_SUPER, ALL_SUPER, ALL_TRUE)
106 | }
107 | ```
108 |
109 | 能看到打印的事件分发跟踪日志：
110 |
111 | ```log
112 | [down]
113 | |layer:SActivity |on:Dispatch_BE |type:down
114 | |layer:SViewGroup |on:Dispatch_BE |type:down
115 | |layer:SViewGroup |on:Intercept |result(false):false |type:down
116 | |layer:SView |on:Dispatch_BE |type:down
117 | |layer:SView |on:Touch |result(true):true |type:down
118 | |layer:SView |on:Dispatch_AF |result(super):true |type:down
119 | |layer:SViewGroup |on:Dispatch_AF |result(super):true |type:down
120 | |layer:SActivity |on:Dispatch_AF |result(super):true |type:down
121 |
122 | [move]
123 | |layer:SActivity |on:Dispatch_BE |type:move
124 | |layer:SViewGroup |on:Dispatch_BE |type:move
125 | |layer:SViewGroup |on:Intercept |result(false):false |type:move
126 | |layer:SView |on:Dispatch_BE |type:move
127 | |layer:SView |on:Touch |result(true):true |type:move
128 | |layer:SView |on:Dispatch_AF |result(super):true |type:move
129 | |layer:SViewGroup |on:Dispatch_AF |result(super):true |type:move
130 | |layer:SActivity |on:Dispatch_AF |result(super):true |type:move
131 |
132 | [move]
133 | |layer:SActivity |on:Dispatch_BE |type:move
134 | |layer:SViewGroup |on:Dispatch_BE |type:move
135 | |layer:SViewGroup |on:Intercept |result(true):true |type:move
136 | |layer:SView |on:Dispatch_BE |type:cancel
137 | |layer:SView |on:Touch_BE |type:cancel
138 | |layer:SView |on:Touch_AF |result(super):false |type:cancel
139 | |layer:SView |on:Dispatch_AF |result(super):false |type:cancel
140 | |layer:SViewGroup |on:Dispatch_AF |result(super):false |type:move
141 | |layer:SActivity |on:Touch_BE |type:move
142 | |layer:SActivity |on:Touch_AF |result(super):false |type:move
143 | |layer:SActivity |on:Dispatch_AF |result(super):false |type:move
144 |
145 | [move]
146 | |layer:SActivity |on:Dispatch_BE |type:move
147 | |layer:SViewGroup |on:Dispatch_BE |type:move
148 | |layer:SViewGroup |on:Touch |result(true):true |type:move
149 | |layer:SViewGroup |on:Dispatch_AF |result(super):true |type:move
150 | |layer:SActivity |on:Dispatch_AF |result(super):true |type:move
151 |
152 | [up]
153 | |layer:SActivity |on:Dispatch_BE |type:up
154 | |layer:SViewGroup |on:Dispatch_BE |type:up
155 | |layer:SViewGroup |on:Touch |result(true):true |type:up
156 | |layer:SViewGroup |on:Dispatch_AF |result(super):true |type:up
157 | |layer:SActivity |on:Dispatch_AF |result(super):true |type:up
158 | ```
159 |
160 | 1. 同样因为系统控件和麻雀控件打印的日志一模一样，所以只贴出一份
161 | 2. 从日志中能清楚看到，在`ViewGroup`拦截事件前后，事件是如何分发的
162 |
163 | ## License
164 | Apache License 2.0, here is the [LICENSE](https://github.com/RubiTree/DispatchTouchEventTutorial/blob/master/LICENSE).
165 |
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | Apache License
2 | Version 2.0, January 2004
3 | http://www.apache.org/licenses/
4 |
5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6 |
7 | 1. Definitions.
8 |
9 | "License" shall mean the terms and conditions for use, reproduction,
10 | and distribution as defined by Sections 1 through 9 of this document.
11 |
12 | "Licensor" shall mean the copyright owner or entity authorized by
13 | the copyright owner that is granting the License.
14 |
15 | "Legal Entity" shall mean the union of the acting entity and all
16 | other entities that control, are controlled by, or are under common
17 | control with that entity. For the purposes of this definition,
18 | "control" means (i) the power, direct or indirect, to cause the
19 | direction or management of such entity, whether by contract or
20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the
21 | outstanding shares, or (iii) beneficial ownership of such entity.
22 |
23 | "You" (or "Your") shall mean an individual or Legal Entity
24 | exercising permissions granted by this License.
25 |
26 | "Source" form shall mean the preferred form for making modifications,
27 | including but not limited to software source code, documentation
28 | source, and configuration files.
29 |
30 | "Object" form shall mean any form resulting from mechanical
31 | transformation or translation of a Source form, including but
32 | not limited to compiled object code, generated documentation,
33 | and conversions to other media types.
34 |
35 | "Work" shall mean the work of authorship, whether in Source or
36 | Object form, made available under the License, as indicated by a
37 | copyright notice that is included in or attached to the work
38 | (an example is provided in the Appendix below).
39 |
40 | "Derivative Works" shall mean any work, whether in Source or Object
41 | form, that is based on (or derived from) the Work and for which the
42 | editorial revisions, annotations, elaborations, or other modifications
43 | represent, as a whole, an original work of authorship. For the purposes
44 | of this License, Derivative Works shall not include works that remain
45 | separable from, or merely link (or bind by name) to the interfaces of,
46 | the Work and Derivative Works thereof.
47 |
48 | "Contribution" shall mean any work of authorship, including
49 | the original version of the Work and any modifications or additions
50 | to that Work or Derivative Works thereof, that is intentionally
51 | submitted to Licensor for inclusion in the Work by the copyright owner
52 | or by an individual or Legal Entity authorized to submit on behalf of
53 | the copyright owner. For the purposes of this definition, "submitted"
54 | means any form of electronic, verbal, or written communication sent
55 | to the Licensor or its representatives, including but not limited to
56 | communication on electronic mailing lists, source code control systems,
57 | and issue tracking systems that are managed by, or on behalf of, the
58 | Licensor for the purpose of discussing and improving the Work, but
59 | excluding communication that is conspicuously marked or otherwise
60 | designated in writing by the copyright owner as "Not a Contribution."
61 |
62 | "Contributor" shall mean Licensor and any individual or Legal Entity
63 | on behalf of whom a Contribution has been received by Licensor and
64 | subsequently incorporated within the Work.
65 |
66 | 2. Grant of Copyright License. Subject to the terms and conditions of
67 | this License, each Contributor hereby grants to You a perpetual,
68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69 | copyright license to reproduce, prepare Derivative Works of,
70 | publicly display, publicly perform, sublicense, and distribute the
71 | Work and such Derivative Works in Source or Object form.
72 |
73 | 3. Grant of Patent License. Subject to the terms and conditions of
74 | this License, each Contributor hereby grants to You a perpetual,
75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76 | (except as stated in this section) patent license to make, have made,
77 | use, offer to sell, sell, import, and otherwise transfer the Work,
78 | where such license applies only to those patent claims licensable
79 | by such Contributor that are necessarily infringed by their
80 | Contribution(s) alone or by combination of their Contribution(s)
81 | with the Work to which such Contribution(s) was submitted. If You
82 | institute patent litigation against any entity (including a
83 | cross-claim or counterclaim in a lawsuit) alleging that the Work
84 | or a Contribution incorporated within the Work constitutes direct
85 | or contributory patent infringement, then any patent licenses
86 | granted to You under this License for that Work shall terminate
87 | as of the date such litigation is filed.
88 |
89 | 4. Redistribution. You may reproduce and distribute copies of the
90 | Work or Derivative Works thereof in any medium, with or without
91 | modifications, and in Source or Object form, provided that You
92 | meet the following conditions:
93 |
94 | (a) You must give any other recipients of the Work or
95 | Derivative Works a copy of this License; and
96 |
97 | (b) You must cause any modified files to carry prominent notices
98 | stating that You changed the files; and
99 |
100 | (c) You must retain, in the Source form of any Derivative Works
101 | that You distribute, all copyright, patent, trademark, and
102 | attribution notices from the Source form of the Work,
103 | excluding those notices that do not pertain to any part of
104 | the Derivative Works; and
105 |
106 | (d) If the Work includes a "NOTICE" text file as part of its
107 | distribution, then any Derivative Works that You distribute must
108 | include a readable copy of the attribution notices contained
109 | within such NOTICE file, excluding those notices that do not
110 | pertain to any part of the Derivative Works, in at least one
111 | of the following places: within a NOTICE text file distributed
112 | as part of the Derivative Works; within the Source form or
113 | documentation, if provided along with the Derivative Works; or,
114 | within a display generated by the Derivative Works, if and
115 | wherever such third-party notices normally appear. The contents
116 | of the NOTICE file are for informational purposes only and
117 | do not modify the License. You may add Your own attribution
118 | notices within Derivative Works that You distribute, alongside
119 | or as an addendum to the NOTICE text from the Work, provided
120 | that such additional attribution notices cannot be construed
121 | as modifying the License.
122 |
123 | You may add Your own copyright statement to Your modifications and
124 | may provide additional or different license terms and conditions
125 | for use, reproduction, or distribution of Your modifications, or
126 | for any such Derivative Works as a whole, provided Your use,
127 | reproduction, and distribution of the Work otherwise complies with
128 | the conditions stated in this License.
129 |
130 | 5. Submission of Contributions. Unless You explicitly state otherwise,
131 | any Contribution intentionally submitted for inclusion in the Work
132 | by You to the Licensor shall be under the terms and conditions of
133 | this License, without any additional terms or conditions.
134 | Notwithstanding the above, nothing herein shall supersede or modify
135 | the terms of any separate license agreement you may have executed
136 | with Licensor regarding such Contributions.
137 |
138 | 6. Trademarks. This License does not grant permission to use the trade
139 | names, trademarks, service marks, or product names of the Licensor,
140 | except as required for reasonable and customary use in describing the
141 | origin of the Work and reproducing the content of the NOTICE file.
142 |
143 | 7. Disclaimer of Warranty. Unless required by applicable law or
144 | agreed to in writing, Licensor provides the Work (and each
145 | Contributor provides its Contributions) on an "AS IS" BASIS,
146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147 | implied, including, without limitation, any warranties or conditions
148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149 | PARTICULAR PURPOSE. You are solely responsible for determining the
150 | appropriateness of using or redistributing the Work and assume any
151 | risks associated with Your exercise of permissions under this License.
152 |
153 | 8. Limitation of Liability. In no event and under no legal theory,
154 | whether in tort (including negligence), contract, or otherwise,
155 | unless required by applicable law (such as deliberate and grossly
156 | negligent acts) or agreed to in writing, shall any Contributor be
157 | liable to You for damages, including any direct, indirect, special,
158 | incidental, or consequential damages of any character arising as a
159 | result of this License or out of the use or inability to use the
160 | Work (including but not limited to damages for loss of goodwill,
161 | work stoppage, computer failure or malfunction, or any and all
162 | other commercial damages or losses), even if such Contributor
163 | has been advised of the possibility of such damages.
164 |
165 | 9. Accepting Warranty or Additional Liability. While redistributing
166 | the Work or Derivative Works thereof, You may choose to offer,
167 | and charge a fee for, acceptance of support, warranty, indemnity,
168 | or other liability obligations and/or rights consistent with this
169 | License. However, in accepting such obligations, You may act only
170 | on Your own behalf and on Your sole responsibility, not on behalf
171 | of any other Contributor, and only if You agree to indemnify,
172 | defend, and hold each Contributor harmless for any liability
173 | incurred by, or claims asserted against, such Contributor by reason
174 | of your accepting any such warranty or additional liability.
175 |
176 | END OF TERMS AND CONDITIONS
177 |
178 | APPENDIX: How to apply the Apache License to your work.
179 |
180 | To apply the Apache License to your work, attach the following
181 | boilerplate notice, with the fields enclosed by brackets "{}"
182 | replaced with your own identifying information. (Don't include
183 | the brackets!) The text should be enclosed in the appropriate
184 | comment syntax for the file format. We also recommend that a
185 | file or class name and description of purpose be included on the
186 | same "printed page" as the copyright notice for easier
187 | identification within third-party archives.
188 |
189 | Copyright {yyyy} {name of copyright owner}
190 |
191 | Licensed under the Apache License, Version 2.0 (the "License");
192 | you may not use this file except in compliance with the License.
193 | You may obtain a copy of the License at
194 |
195 | http://www.apache.org/licenses/LICENSE-2.0
196 |
197 | Unless required by applicable law or agreed to in writing, software
198 | distributed under the License is distributed on an "AS IS" BASIS,
199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200 | See the License for the specific language governing permissions and
201 | limitations under the License.
202 |
--------------------------------------------------------------------------------