Prepare阶段的执行流程和脚本优先级

[Stehsaer]

最近正在研究xmake源码，根据文档和源码，在AI的辅助下总结了xmake的准备（Prepare）阶段的执行流程和脚本优先级。我将我总结出的内容和一些疑问在Discussion这里，希望社区能够帮忙review下看看有没有什么错误，并且解答一些疑惑

执行流程

graph TB
    begin_prepare([Prepare Begins])
    before_prepare["before_prepare[cmd]"]
    on_prepare_override["Overrided on_prepare[cmd]"]

    subgraph on_prepare_builtin ["Builtin on_prepare"]
        direction TB

        on_prepare_start@{ shape: fork, label: "Fork or Join" }
        before_prepare_file["before_prepare[cmd]_file"] 
        before_prepare_files["before_prepare[cmd]_files"]
        on_prepare_file["on_prepare[cmd]_file"]
        on_prepare_files["on_prepare[cmd]_files"]
        after_prepare_file["after_prepare[cmd]_file"]
        after_prepare_files["after_prepare[cmd]_files"]
        on_prepare_end@{ shape: fork, label: "Fork or Join" }

        on_prepare_start --"on_prepare_files Not Specified"--> before_prepare_file --> on_prepare_file --> after_prepare_file --> on_prepare_end
        on_prepare_start --"on_prepare_files Specified"--> before_prepare_files --> on_prepare_files --> after_prepare_files --> on_prepare_end
    end

    after_prepare["after_prepare[cmd]"]
    end_prepare([Prepare Ends])

    begin_prepare --> before_prepare
    before_prepare --"on_prepare overrided"--> on_prepare_override
    before_prepare --"use builtin on_prepare"--> on_prepare_start
    on_prepare_end --> after_prepare
    on_prepare_override ----> after_prepare
    after_prepare --> end_prepare

Loading

优先级

这一部分有较多不确定和有疑问的地方

• Rule或Target中指定了on_prepare，手动指定的on_prepare应该会代替xmake内置的on_prepare流程，导致[before/on/after]_prepare[cmd]_file[s]都不会被执行；
  • Target指定的on_prepare应该会覆盖Rule中的on_prepare（如果有）
  • Rule之间的on_prepare不清楚具体的覆盖/优先级（若Target未指定on_prepare，且Target中的多个Rule都有指定on_prepare）？
• 在执行内置on_prepare流程时，如果hook了任意xxx_prepare[cmd]_files，xxx_prepare[cmd]_file应该会被覆盖且跳过执行（如图中所示，走了files的分支）
  • Target指定的on_prepare[cmd]_file[s]是否会覆盖rule中的on_prepare[cmd]_file[s]？如果不覆盖，它们的执行顺序是怎样的？
  • Target指定的[before/after]_prepare[cmd]_file[s]是否会覆盖rule中的[before/after]_prepare[cmd]_file[s]？如果不覆盖，它们的执行顺序是怎样的？
  • Target指定的[before/after]_prepare是否会覆盖rule中的[before/after]_prepare？如果不覆盖，它们的执行顺序是怎样的？
• 若同时指定了同一个事件的非batchcmd变体和batchcmd变体（如同时指定了on_prepare_files和on_preparecmd_files），哪个的优先级更高？
• 图中画的是只有指定了on_prepare[cmd]_files时，xx_prepare[cmd]_file才会被跳过。这部分也是不太确定的，是任意指定了[before/on/after]_prepare[cmd]_files就能覆盖掉xx_file的分支，还是必须指定了on_prepare[cmd]_files才能覆盖掉那个分支？（按个人推理来说是前者）

关于Source batch

根据文档推断，source batch应该是以rule为单位而不是以add_files为单位的？实际编写rule时，xmake确实好像也是以rule为单位，将target中所有的使用同一个rule的文件打包为source batch传给rules

泛用性

这一套覆盖的逻辑是否能够同样应用在build上面，毕竟它们的API几乎是一样的（除了名字为[before/on/after]_build[cmd][_file[s]]）

[waruqi]

Target指定的on_prepare应该会覆盖Rule中的on_prepare（如果有）

target 的优先级最高，on_prepare/on_build 会完整重写内置的实现

Target指定的on_prepare[cmd]_file[s]是否会覆盖rule中的on_prepare[cmd]_file[s]？如果不覆盖，它们的执行顺序是怎样的？

on_ 的都会覆盖

Target指定的[before/after]_prepare[cmd]_file[s]是否会覆盖rule中的[before/after]_prepare[cmd]_file[s]？如果不覆盖，它们的执行顺序是怎样的？

只有 on_ 会覆盖

Target指定的[before/after]_prepare是否会覆盖rule中的[before/after]_prepare？如果不覆盖，它们的执行顺序是怎样的？

target 优先执行，rule 里面未定义，除非你指定了 add_orders 控制了顺序

若同时指定了同一个事件的非batchcmd变体和batchcmd变体（如同时指定了on_prepare_files和on_preparecmd_files），哪个的优先级更高？

对于编译，优先 on_prepare/on_build， 没有才会 fallback 到 on_preparecmd/on_buildcmd

batchcmd 主要是给 project generator 用的，串行的，对于 project generator ，只会处理 batchcmd

图中画的是只有指定了on_prepare[cmd]_files时，xx_prepare[cmd]_file才会被跳过。这部分也是不太确定的，是任意指定了[before/on/after]_prepare[cmd]_files就能覆盖掉xx_file的分支，还是必须指定了on_prepare[cmd]_files才能覆盖掉那个分支？（按个人推理来说是前者）

包含关系，有 _files ，优先用，忽略 _file ，没有 _files，会 fallback 挨个处理 _file