20230322

[shlib.git] / doc / UM.txt.zh_CN / codegen.txt

[shlib]
+ @ v0.1.0，shlibinc，gplib.shlib，stdio.shlib，dbgout.shlib，(eng-doc)
=> @ v0.2.0，scripttest，args.shlib，term.shlib，cataid.shlib，catadir.shlib，(code-trimp，eng-cn-doc，tut)
@ v0.3.0，catalog，scripttest，attr.shlib，strsyntax.shlib，catalog.shlib，
@ v0.4.0，tmpl，imi，evnstr，strfmt.shlib，imi.shlib，
@ v0.5.0，codegen，code-tmpl，
@ v0.6.0，setdir，wrap，etz，pkg-install，paths.shlib，
@ v0.7.0，flocker.shlib，fsvar.shlib，
@ v0.8.0，dvar，dtype，@，bzsh，fsdvar.shlib，preproc.shlib，pub-dir-set，
@ v0.9.0，dstruct，hexfmt，rwfile.shlib，dtype.shlib，dv_offset.shlib，dvload.shlib，
@ v0.10.0，taskload，taskunit，svclaunch，scripttest，taskload.shlib，task-unit，
@ v0.11.0，dbglogview，fmtdbgout.shlib，
@ v0.11.n，(fix bugs)
@ v1.0.0，(v1 version，long time support version)
@ *v1.1.0，xml，record，db，libxml2.shlib，recutils.shlib，sqlite.shlib，
@ *v1.2.0，code-tmpl，init-task-unit，wrap-lib，pub-dir-set，
@

[list]
@ dev-utils & shlib
# scripttest(attr，strsyntax，catalog/cataid/catadir，)，args调整，程序banner信息修改。
# codegen(strfmt，imi，tmpl，code-tmpl)
# shlib add(etz/pkg-install，sysdir，wrap，taskload，depnode)

@ shlib-cmd(xml，recutils，sqlite，idutils，shmm，ttyrec)
@ shlib-lite
# compact
# devutils(scripttest，codegen，modify，wordlist)
# pkg-mngr(软件包信息管理)(etz/paths/cfgdir/wrap/pkg-install/pkg-mngr)
# fsdvar(fsvar/dvar/dstruct/dtype/@/bzsh)
# datatypes，snbb/sqltg
# taskunit(taskload/svclaunch/nodedep)
# utilities(depend on shlib-cmd)
@ shlib-std

@ pkg-builder
# pkg-builder(subcmd/taglib，toolchain-mngr，taskunit)
# util pkg compile
# * old ver gcc
# pkg-config
# build-pkglist

@ libs
# libcxt(sqltg，allocator，plugin)，libsyslib，libhw，libemb
# mvc/compo: libtypes，libmodel，libarch，compolibs

@ dvar(fsdvar-shlib，libdvar，libappvfs，libdvarfs，dvarfsd，dvar/dtype，bzsh，)
@ pinit(taskunit，pinit，drvlaunch，fsload，network，subsys)
@ utilities(hexfmt/lxr/gmr/txtfmt/protod/collectd，rpipe/cron/xinet)
@ *soft-mngr(pkg/prog，app/soft/midware/bsp/drv/soft-center/soft-repository)
@ linux-skeletone

@ bzbox(libbzsh，bzsh，libbzgmr-std，libbzcmd-std，libbzgmr-ext，libbzcmd-ext)

@ linux-dev-studio
# code-analyze(codegen，codefmt，code-assistent，)
@ soft-designer
@ skeletone-linux

@
# args参数处理
# env/attr/fsvar/dvar
# param参数文件(imi/xml/catalog/rec)
# 字符串函数集
# 调试信息模块
# 多任务功能模块
# cron功能模块
# MVC功能集合
# 终端功能集合
# ui功能集合
# net功能集合
# xinet功能模块
# db功能集合
# audio/sampling功能集合
# picture功能集合
# video功能集合
# crypto功能集合
# rt功能集合
# emb功能集合
# txt语法功能
# hex格式数据
# usefull功能模块






@ shlib
# 添加系统初始化脚本，在系统初始化时运行。脚本中添加各个功能模块在开机定义的alias，imi的配置中定义的shlib。
# session中load的shlib避免重复include，以及shlibinc避免重复load。一些imi的load占用cpu资源较多，在系统setup时load，避免每次运行load。



@ catalog
# varlist/strsyntax，
# cataid，
# catadir，
# catalog，
# foreach & varlist
@ scripttest & codegen
@ imi
@ fsdvar

@ tips
# varlist仅提供foreach函数，以及var的get/set。
# strsyntax定义单解析/输出的syntax。
# cataid根据name分配，不固定使用CATA_ID。
+ # cataid中catadir相关的inc/dec，归类到catadir.shlib中。
# catadir，varlist，catalog之间的foreach函数和sync。
# line-str使用\为续行符，读取行首不含white-space的一行字符串，连接到字符串中。

@ catalog
# catalog
# catadir
# cataid(syntax_judgement)
# varlist/attr(module::section::attr，var_list)
# strsyntax(str2arr，arr2str，syntax_fmt，syntax_regepr，syntax_sepchar)

@ varlist(var::id::attr，var_list)
# 多级名称的环境变量名称组合，及访问。var下所有attr都存储到var_list，用于release。
# attr add var id attr
# attr getvn var id attr
# attr list var id
# attr del var
# attr foreach var

@ strsyntax
# 用于字符串到数组的解析。使用固定分隔符，或使用RegExpr。解析后数组id与属性名称之间以attr_idx进行映射。
# str2arr，
# arr2str，
# syntax_fmt，
# syntax_regepr，
# syntax_sepchar，attr_idx，nid_idx，默认使用分隔符组成的数组。根据attr_idx数组的值输出"对应的环境变量名称"。
# strsyntax，包含cata_syntax_*和dir<N>_syntax_*，用于两种用途的格式定义。

@ catalog文件
# 包含其它参数。
# [catalog]目录定义区，和[content]内容定义区

# item-node的定义
<->.[item].name."description".[src::c-h-testc-mdl]

<->.[item].name."description".[test::sh-stdout]

<->.[item].name."description".[file]
<->.[file].name."description".[sh]
<->.[file].name."description".[stdout]

catalog_ext_param_test_dispatch ()
{
    # 将NFEXT的扩展名解析后调用proc函数
    :
}

# 用于item enter时的proc函数，创建文件节点
catalog_file_touch ()
{
    :
}

# 用于item leave时的proc函数，根据tmpl和content-list创建文件内容
catalog_file_gen ()
{
    :
}

# global参数变量定义区，包含cata_syntax_*和dir<N>_syntax_*，用于两种格式的定义。
# catalog node string
# attr cata::syntax::fmt=''
cata__syntax__fmt='<@{0}>.[@{1}].@{2}."@{3}"'
#cata__syntax__regepr=
cata__syntax__sepchar='.'
cata__syntax__attr_idx=( NID NTYPE NNAME NDESC )
cata__syntax__nid_idx= 0

# src file name string
src__syntax__fmt='@{2}.@{4}'
#src__syntax__regepr=
src__syntax__sepchar='.'
src__syntax__attr_idx=( NNAME NFEXT )
src__syntax__nid_idx=

# test file name string
test__syntax__fmt='@{0}.@{2}.sh'
#test__syntax__regepr=
test__syntax__sepchar='.'
test__syntax__attr_idx=( NID NNAME NFEXT )
test__syntax__nid_idx=0

# test stdout file name string
stdout__syntax__fmt='@{0}.@{2}.sh.@{3}.stdout'
#stdout__syntax__regepr=
stdout__syntax__sepchar='.'
stdout__syntax__attr_idx=( NID NNAME txt NDESC NFEXT )
stdout__syntax__nid_idx=0

@ catalog参数
# -c，将catalog中的<->设置成实际的id。
# 。将catalog中的id同步到content的id。
# 。将catalog中的id进行设置。
# 。将catalog中的id设置为<->

@ codegen参数
# -y，从catalog同步更新输出到已存在的dir/file
# -S，从dir/file同步更新到catalog
# 输出内容是否存在，由程序中判断。如有存在，先备份。


[catalog和文件输出的相互转换]
@ 转换输出时，使用tarball压缩文件backup已存在内容。
@
# dir/file输出catalog，catalog未存在时，根据attr创建catalog，未定义项空白。
# dir/file输出catalog，catalog已存在时，dir/file包含NID，根据NID值更新到catalog，dir/file中未包含的属性，使用对应name的attr为默认值。
# dir/file输出catalog，catalog已存在时，dir/file不包含NID，
根据catalog的varlist的NNAME，chk是否存在dir/file，存在即已创建，使用dir/file的attr输出node;不存在删除，输出del提示信息，dir/file中新增项添加到catalog，新增项的NID为<->。

# catalog输出dir/file，dir/file未存在时，根据attr创建dir/file
# catalog输出dir/file，dir/file已存在时，dir/file包含NID，根据NID值和NNAME值更新到对应的dir/file，使用rename/mv，避免content内容的误删除。dir/file不存在时，根据NID值匹配对应item，使用rename/mv更新文件名。如果文件名和NID都未匹配，输出new。如果某个catalog下的node已更新，对应dir下未更新的dir/file放入trash，并在log输出del。
# catalog输出dir/file，dir/file已存在时，dir/file不包含NID，rename/mv更新dir/file的名称信息。dir/file不存在时，新建。catalog中的node已输出，dir/file中存在的冗余项，保存到trash。


@ catalog2dircontent，
# 根据dir/file获取dir-varlist，

# dir-node和item-node，与dir-varlist比较，已存在且不同，则rename; 未存在，新建dir/item; dir-varlist中多出来的，move到trash-dir中。

# item-enter时，新建文件，
# content时，添加到cont-varlist，
# item-leave时，根据cont-varlist以及item的tmpl信息，输出文件的content。

@ catalog2dircontent，方法1
# 根据catadir获取varlist，
# foreach catalog，使用str2arr获取var。逐个node进行函数响应。忽略content-node
# foreach catalog，只对item-node和content-node进行处理。

@ catalog2dircontent，方法2
# 根据catadir获取dir-varlist，
# foreach catalog，使用str2arr获取var，获取node-varlist
# foreach varlist，与dir-varlist比较
# foreach catalog，只对item和content处理。

@ catalog2dircontent，方法3
# foreach catalog，使用str2arr获取var。逐个node进行函数响应。
# dir-node和item-node不使用varlist，使用文件exist比较。

@ compare
# 读取dir-varlist和文件目录比较，对于多余的节点比较容易辨识。
# content和dir分两个stage，程序中的varlist可release再更新content。
# dst输出到node遍历，如

@ dircontent2catalog，
# 文件系统中dir-node/item-node遍历，输出dir-varlist，
# 遍历catalog的dir和item，输出并删减dir-varlist中的node。如dir-varlist中不存在，提示该node未存在。一个dir下的node有多余时，append到末尾。
# 根据dir-varlist中的item，将每个item文件内容输出成[catalog-content]中的item和content。
# dir的遍历使用find并获取var，输出catalog的node，比逐个目录ls减少磁盘io。
# dir名称中不包含id信息的，输出到catalog与原有的位置或不相同。使用dir-varlist，进行name的比较，使用原有的排序。或使用参数，以id为compare。


scripttest improve









[script-utils]

@ scripttest
# shlib add。add args，term，attr，strsyntax，cataid/catadir/catalog，
+ args desc字符串格式改进，使用单个分隔符
+ helper改为optstr，helper根据xxx_helper_desc产生，可多个组合使用。
+ 多个程序optstr的引用，使用--loadshlib参数不运行main。
+ 目录遍历和catalog遍历的代码放到catadir和catalog中。
+ varlist的遍历放到attr中
+ new shlib ver
# improve scripttest， add catalog，catadir，catavarlist，
+ design-doc分析功能模块和接口函数
+ catavarlist/attrvar，以name，cataid，attr的结构存储的var，以及get/set函数。同样也可适用于imi
+ catadir，catalog，tmpl data translate
+

@ add codegen， tmpl，strfmt，evaln
=># imi，
=># c/cpp/sh templete(c/cpp/sh src file-skltn)，
=># catalog，(nodeSyntax，contentNodeSyntax，contentSync)(dirSync2Cata时，添加add/del/modify的comment)
=> # cataid.shlib(init，)
=> # codegen.shlib
=> # code-gen，
@ templete(cmnt-tag-grammar，code-feature-desc，code-tmpl，)
# code-skltn，

@ shlib & devutils
+ # add shlib for scripttest to shlib-v0.02, args，term，catalog，cataid。 scripttest, and improve the code of catalog。
# add docsgen.sh to devutils，and relative pkg
# etz/pkg-install，wrap，path & cfgdirs，

@ scripttest
# scripttest helper，
# catalog，
# taskload，
# desc string improve，use =~ and BASH_REMATCH
# defargs.shlib，

@ pkg-builder
# path & cfgdirs(pkg-install)，
# builders(flist，plist，gen-proclib，proclib)


@ fsdvar-shlib
# flocker，rwfile，fsvar，decl/dvar/dtype/dstruct，txtproc
# bzsh(dvar/dtype/@)(sh-decode，dvar-fmt-decode)，
# sqltg
@ dvar(libbzsh，symbol，dtype，dvar，expr，execlist...)
# dvar(libdvar，libdvarfs，dvarfsd，)

[libcxt]
@ libcxt(libcxt，libsyslib，libhal，libemb)(sqltg，mem，symbol，struct/cstruct，)，vais(vector，array，index，string)，plf(pipe，linestr-pipe，frame-stream)
@ libcxt：sqltg，allocator，strings，symtbl，"plugin/compo/cntlr"，element，xcontent/thr/fiber，ivkfilter，stream(stdio，fifo，frame)，fmtdbgout，imi，args，param，"appfs"，
# ivk-chain，(inotify，libacl，libattr)
@ libsyslib
# libsyslib：thr-sys，thr-msg/thr-event，ipc，shmem，rpc，mem，serial，net，

@ libcompo
# libtypes，libcompo，libarch，libmodel，compolibs，(code-if-xml，module-list，module-member-list，)
# uml-compo-type
# type-compo，sharp-edit/combine/alias/action/property-dialog，

@ bzbox(bzsh+libcxt+typelib+lib库)(libcxt-dvar，libbzsh-dvarfs，libcxt-typelib，libbzsh-)


[shlib]
@ fmtdbgout.shlib/dbglogview，
@ pinit:
# initunit，pexec，nodedep
# taskload，svc/svclaunch，mpexec，nettask，
@ strfmt，evaln，
# tmpl，imi，catalog，depnode
# etz，dircfg/syscfg，path定义
# cmdlist，
# imi，rec，xml，log，lxr，gmr，var/type，基于文本的文件定义和使用
# gnu程序recutils，ttyrec，xmlint，screen/termux

@ dev-utils(dev-xxx)，(modify，pkgname，version-id，compile-param，cross-param，shargs，cargs，tagdoc，codegen，)cunit/cppunit，
# dbglogview，
# scripttest，testcase，testinglib，


@ build-pkg/build-pkglist/build-config
/code-utils(code-xxx)

@ *tui(ncurses，form/menu/pannel，guile-ncurses，dialog，libcdk，ui-script，)