app私有bin

ancientcc

私有bin要解决两个问题，一是有哪些bin，二是如何构造这些bin。要回答这个两个问题，先了解bin.cfg，和Rose生成私有bin的过程。

一、bin.cfg
如果app有私有bin，那需要在它的<res>/app-<appid>目录下创建bin.cfg，通过该文件描述私有bin情况。对于bin.cfg的内容，它只有四个字段，没有块，以下是一个实例。

1. [bin]
   
2.         id_child = "campaign"
   
3.         scenario_child = "campaign_addon"
   
4.         macros = "data/core/app-kingdom/macros"
   
5.         path = "data/app-kingdom/campaigns"
   
6. [/bin]

复制代码

字段	描述	是否必须
id_child	config块名。含有id字段的块，除id外，该块下还有个特殊字段：define	必须
scenario_child	config块名。该块下的内容将成为私有bin内容	必须
macros	路径。构造私有bin的脚本来源1，用于定义宏。注1。它的前面部分是<res>	可选
path	路径。构造私有bin的脚本来源2，用于定义内容。它的前面部分<res>	必须

注
1：macros、path的前面部分是<res>。举个例子，macros = "data/core/app-kingdom/macros"，res是c:/sample，那macros的完整路径是“c:/sample/data/core/app-kingdom/macros”。

二、Rose生成私有bin的过程
让就以上面的bin.cfg实现描述生成过程。假设<res>是c:/sample

• 扫描c:/sample下的app-<appid>目录，发现c:/sample/app-kingdom下有bin.cfg。
• 解析“path”字段指示的脚本（注意此时不解析“macros”），形成一个config。枚举该config下子config（只是第一级），对于块名是campaign（id_child字段值）的就会对应一个bin，即有几个“campaign”该app就有几个bin。而“campaign”字段下的id值就会作为bin名称，像以下一个_main.cfg，它会对应siege.bin。
  
  1. 
     
  2. <res>/data/app-kingdom/campaigns/siege/_main.cfg"
     
  3. [campaign]
     
  4.         id = "siege"
     
  5.         define = CAMPAIGN_SIEGE
     
  6. [/campaign]
     
  7. #ifdef CAMPAIGN_SIEGE
     
  8. [campaign_addon]
     
  9.         ......
     
  10. [/campaign_addon]
      
  11. #endif

  复制代码
  
  
• 构造siege.bin。构造分四个步骤，1）如果[id_child]指定块中含有define字段，在构造时首先会定义该宏，像以上例子就会先定义“CAMPAIGN_SIEGE”宏。2）如果“macros”指定了路径，构造该路径，例子中是“c:/sample/data/core/app-kingdom/macros”。3）构造“path”指定的路径，例子中是“c:/sample/data/app-kingdom/campaigns”。4）从形成的config下子config（只是第一级）搜到第一个块名（只关心第一个）是“scenario_child”值的，该块内容就是最后bin文件内容，例子中就是“campaign_addon”块。
  

接下让回答开始提的两个问题。
问题一：有哪些bin
解析“path”字段指示的脚本（注意此时不解析“macros”），形成一个config。枚举该config下子config（只是第一级），对于块名是campaign（id_child字段值）的就会对应一个bin，即有几个<id_child>块该app就有几个bin。

问题二：如何构造这些bin
构造分四个步骤，1）如果[id_child]指定块中含有define字段，在构造时首先会定义该宏。2）如果“macros”指定了路径，构造该路径。3）构造“path”指定的路径。4）从形成的config下子config（只是第一级）搜到第一个块名（只关心第一个）是“scenario_child”值的，该块内容就是最后bin文件内容。

几个要点

• 两次构造。第一次构造目的是有为了“有哪些bin”，第二次构造是为了构造bin内容，这两次构造过程相互独立。相比于第一次，第二次构造多了两个步骤，1）多定义“define”字段指定的宏，2）在构造“path”前先构造“macros”路径。
• 第二次构造时为什么要多定义“define”字段指定的值。两次构造来源都要来自“path”，app可以通过该宏达到这么个目的：即使是同一个cfg也让出来两个config，比如上面写的“_main.cfg”，因为多了CAMPAIGN_SIEGE，第二次编译“_main.cfg”就比第一次多了“campaign_addon”块。
• 如何设定macros、path值。“macros”放置“path”中内容会使用到的宏，不要放置内容，内容都放在“path”。
  

要形成私有bin，app应该怎么做

• 在<res>/app-<appid>下创建bin.cfg。
• 确定名称所在块名：“id_child”值。
• 确定内容所在块名：“scenario_child”值。
• 如果须要宏目录，设定“macros”值。
• 确定内容目录，设定“path”值。
  

ancientcc

按要求把指定的多个cfg目录/文件转换成一个*.bin文件或另外cfg。

语法

1. bool editor::cfgs_2_cfg(const editor::BIN_TYPE type, const std::string& name, const std::string& app, bool write_file, uint32_t nfiles, uint32_t sum_size, uint32_t modified)

复制代码

参数

type	间接指示要生成的是哪个bin文件
name	在生成一些bin时须要这个值
app	app标识，在生成一些bin时须要这个值
write_file	true时把结果写入bin文件，false则不写
nfiles	bin头四元组中的nfiles
sum_size	bin头四元组中的sum_size
modified	bin头四元组中的modified

返回值
成功返回true，否则false。

范例

1. <Example>

复制代码

注释

类型(type)	文件名	描述	name
TB_DAT	tb-hexagonal.dat/tb-square.dat	地形数据	tb-hexagonal.dat/tb-square.dat
SCENARIO_DATA	duel.bin/hero_race.bin	app私有bin
GUI	gui.bin	窗口子系统	不须要
EXTENDABLE	不会生成文件	目的是生成campaigns_config_、tbs_config_。是概述，不是具体bin	不须要
MAIN_DATA	data.bin	主配置	不须要

相关类、函数
<Relative class, function>

ancientcc

按要求把指定的多个cfg目录/文件重新生成wml2bin_descs_。

语法

1. void teditor_::get_wml2bin_desc_from_wml(const std::vector<BIN_TYPE>& system_bin_types)

复制代码

参数

system_bin_types

要重新计算的系统bin

返回值
void

范例

1. <Example>

复制代码

注释
每个bin有个时间戳，这个时间戳是个四元组，

字段	类型	描述
name	std::string	短文件名
nfiles	uint32_t	文件数，只累计文件不包括目录。
sum_size	uint32_t	总字节数，只累计文件不包括目录。
modified	uint32_t	最近文件的修改时间，只计算文件不包括目录。

从硬盘上读出*.bin，基于目录中cfg计算出的四元组，如果要正确，须严格按cfg扩展机制计算出的四元组，但要能计算出这个值，那就意要深入每个cfg文件！

1. void data_tree_checksum(const std::vector<std::string>& defines, const std::vector<std::string>& paths, file_tree_checksum& checksum)

复制代码

这函数要耗不少cpu，但studio首页总是要重新计算所有bin，用这方法会有较大延迟。这里用种不深入每个cfg的替换方法。

1. void data_tree_checksum(const std::vector<std::string>& paths, file_tree_checksum& checksum, int filter)

复制代码

变量use_should_method指示构造该bin使用哪种方法。data.bin涉及到目录多，一定要用第一种方案。


相关类、函数
<Relative class, function>