CN115794057A - 命令行函数代码生成方法、装置和计算机可读存储介质 - Google Patents

Abstract

一种命令行函数代码生成方法、装置和计算机可读存储介质，该方法包括：获取建模输入文件；解析所述建模输入文件中的命令行内容，所述命令行内容包括命令行对应函数名称、命令的完全名称、命令的描述；根据所述命令行内容生成命令行函数的代码。通过该实施例的方案，能够自动生成命令行函数的代码，大大提高开发效率，还能避免人工编码错误。

Description

命令行函数代码生成方法、装置和计算机可读存储介质

技术领域

本公开实施例涉及计算机技术领域，更具体地，涉及一种命令行函数代码生成方法、装置和计算机可读存储介质。

背景技术

在软件开发工具包(SDK：Software Development Kit)的开发过程中，软件主要提供应用程序编程接口(API：Application Programming Interface)给客户使用，开发API的同时需要撰写命令行用于API的验证。命令行是一种通过对字符串的解析来调用API的方法，使用命令行可以达到覆盖API封装的寄存器读写操作，完成寄存器功能验证等目的。在API开发中部分时间用于编写这些命令行代码，当API对应命令行验证通过才能达到自测要求。为了使SDK开发更加优质和高效，快速和正确的编写命令行代码是开发中的迫切需求。

发明内容

本公开提供了一种命令行函数代码生成方法、装置和计算机可读存储介质，能够根据建模文件的输入信息，秒级时间内即可自动生成多个命令行函数的代码，不仅能够大大提高开发效率，而且还能避免人工编写可能存在的错误。

本公开一实施例提供了一种命令行函数代码生成方法，包括：

获取建模输入文件；

解析所述建模输入文件中的命令行内容，所述命令行内容包括命令行对应函数名称、命令的完全名称、命令的描述；

根据所述命令行内容生成命令行函数的代码。

本公开一实施例还提供了一种命令行函数代码生成装置，包括处理器以及存储有计算机程序的存储器，其中，所述处理器执行所述计算机程序时能够实现如本公开任一实施例所述的命令行函数代码生成方法。

本公开一实施例还提供了一种非瞬态计算机可读存储介质，所述计算机可读存储介质存储有计算机程序，其中，所述计算机程序时被处理器执行时能够实现如本公开任一实施例所述的命令行函数代码生成方法。

与相关技术相比，本公开实施例提供的命令行函数代码生成方法和装置，采用建模的方式，从建模输入文件中提取生成代码的建模逻辑作为生成程序，使用抽象出命令行生成逻辑的程序自动生成命令行函数的代码，开发人员可以专注在命令行本身的编写，在填写完建模输入文件后执行所述程序，秒级时间内即可完成多个命令行函数代码的生成，不仅能够大大提高开发效率，而且还能避免人工编码可能存在的错误。

本公开的其它特征和优点将在随后的说明书中阐述，并且，部分地从说明书中变得显而易见，或者通过实施本公开而了解。本公开的其他优点可通过在说明书以及附图中所描述的方案来实现和获得。

附图说明

附图用来提供对本公开技术方案的理解，并且构成说明书的一部分，与本公开的实施例一起用于解释本公开的技术方案，并不构成对本公开技术方案的限制。

图1是本公开一实施例命令行函数代码生成方法的流程图；

图2是本公开一实施例一示例性的必选项存储到字典树的数据结构的示意图；

图3是本公开一实施例命令行函数生成方法的流程图；

图4是本公开一实施例命令行函数代码生成装置的示意图。

具体实施方式

本公开描述了多个实施例，但是该描述是示例性的，而不是限制性的，并且对于本领域的普通技术人员来说显而易见的是，在本公开所描述的实施例包含的范围内可以有更多的实施例和实现方案。尽管在附图中示出了许多可能的特征组合，并在具体实施方式中进行了讨论，但是所公开的特征的许多其它组合方式也是可能的。除非特意加以限制的情况以外，任何实施例的任何特征或元件可以与任何其它实施例中的任何其他特征或元件结合使用，或可以替代任何其它实施例中的任何其他特征或元件。

本公开包括并设想了与本领域普通技术人员已知的特征和元件的组合。本公开已经公开的实施例、特征和元件也可以与任何常规特征或元件组合，以形成由权利要求限定的独特的发明方案。任何实施例的任何特征或元件也可以与来自其它发明方案的特征或元件组合，以形成另一个由权利要求限定的独特的发明方案。因此，应当理解，在本公开中示出和/或讨论的任何特征可以单独地或以任何适当的组合来实现。因此，除了根据所附权利要求及其等同替换所做的限制以外，实施例不受其它限制。此外，可以在所附权利要求的保护范围内进行各种修改和改变。

在SDK的开发过程中，软件主要提供API给客户使用，开发API的同时需要撰写命令行用于API的验证。而目前这些命令行代码是依靠人工进行编写的，会存在以下问题：

人工撰写工作量大，很多命令行比API本身的代码行数还要多，并且数量上和API个数不相上下(比如会有多个命令行对应一个API函数，或者一个命令行对应多个API函数的情况)，所以，在人工撰写过程中会存在重复性的工作，并且需要耗费大量的精力。

容易出错，这点特别体现在命令行参数序号和必选项比较多的情况。参数序号就是输入的参数位于命令行字符中以空格分隔的第几个，关于参数序号错误，比如，在修改命令行后很容易忘记修改对应的API代码，导致序号出错，解析错误；或必选项比较复杂时，人工容易数错造成参数选项判断错误；

在必选项比较多的情况下，人工选择不同字符选项的差异作为判断条件，很容易看花眼，导致编码错误。

时间长，开发效率低。不同命令之间没有可复用性，每个新命令都需要重新编写，导致开发效率低。

为此，本公开一实施例提供了一种命令行函数代码生成方法，如图1所示，包括以下步骤：

步骤S110，获取建模输入文件；

步骤S120，解析所述建模输入文件中的命令行内容，所述命令行内容包括命令行对应函数名称、命令的完全名称、命令的描述；

步骤S130，根据所述命令行内容生成命令行函数的代码。

本实施例采用建模的方式，从建模输入文件提取生成代码的建模逻辑写入到自动生成代码的程序中，然后利用所述程序一键生成SDK开发中API相关命令行函数的代码。所述自动生成代码的方式简单，能够大大提高开发效率，而且还能避免人工编码可能存在的错误。

在本公开一示例性的实施例中，所述根据所述命令行内容生成命令行函数的代码，包括：对所述建模输入文件中的每一条命令行内容，按以下方式生成相应命令行函数的代码：

根据命令的描述生成命令行函数的注释；

根据命令行对应函数名称和命令的完全名称生成命令行函数的函数头；

根据命令的完全名称生成命令行函数的命令字段。

在本实施例的一示例中，所述建模输入文件为Excel文件，表1示出了其中的一条命令行内容：

表1

根据表1的命令行内容包括注释信息(命令的描述)、函数头信息(命令行对应函数名称和命令的完全名称)和命令字段信息(命令的完全名称)，可分别生成命令行函数的注释、函数头和命令字段。

在本实施例的一示例中，所述根据命令的描述生成命令行函数的注释，包括：在所述命令的描述的基础上添加注释符号，作为命令行的注释信息；及，将所述命令行的注释添加到所述命令行函数的开头。

表1所示的示例中，在命令的描述“prbs的结果读取命令”的首尾加上C语言的注释符号，生成命令行函数的注释：/*prbs的结果读取命令*/。

在本实施例的一示例中，所述函数头依次包括声明函数(extern函数)和命令定义宏，所述根据命令行对应函数名称和命令的完全名称生成命令行函数的函数头，包括：

为所述命令行对应函数名称添加第一后缀，作为所述extern函数和所述命令定义宏中表示函数的参数；为所述命令行对应函数名称添加第二后缀，作为所述命令定义宏中的结构体参数；

根据所述命令行对应函数名称生成所述extern函数的输入输出参数；

根据所述命令的完全名称生成所述命令定义宏中的当前命令行字符及分段字符的提示信息。

在本实施例的一示例中，命令的完全名称包括多个字符，字符之间用空格分隔，该多个字符包括固定字符，还可以包括非固定字符。基于空格可以从命令的完全名称中提取出命令的完全名称中的每一个字符。其中，非固定字符包括可选项字段和必选项字段。对于必选项字段，可以根据必选项字段的标志来判断字符否为必选项字段，比如，根据字符是否是用“()”括起来判断其是否必选项字段。另外可以通过整个命令的长度判断是否输入可选项字段。另外，每一个可选项字段和必选项字段中包括多个用分隔符(如“|”)隔开的分段字符。在所述命令字段解析建模以生成代码的过程中，固定字符不需要解析，这部分字符是命令行机制解析区分于其他命令的。非固定字符需要进行解析，可以使用字典树数据结构的相关算法作为非固定字符(如必选项字段、可选项字段)处理的主要算法逻辑，根据所述非固定字符中的分隔符，提取所述非固定字符所包括的分段字符，并将所有分段字符保存在一字典树形式的数据结构中，根据字典树的遍历形成必选项不同内容的解析语句，输出作为函数字段解析的代码。

所述分段字符的提示信息通过以下方式生成：从所述命令的完全名称中提取非固定字符中的分段字符；及，按照提取的分段字符在所述命令的完全名称中的顺序，为每一分段字符添加回车符并写入所述命令定义宏，作为该分段字符的提示信息。

在表1所示的示例中，生成的函数头中extern函数的代码为：

extern XC_INT32 xc68_osu_olsdh_prbs_result_get_cmd(PCMDELEMENT self,scrn_t*xscrn,int argc,char**argv)。

其中，“xc68_osu_olsdh_prbs_result_get_cmd”是为命令行对应函数名称添加上第一后缀“cmd”标识的通用命令解析中extern函数中表示参数的参数。括号中是根据命令行对应函数名称生成的输入输出参数。

在表1所示的示例中，生成的函数头中命令定义宏的代码为：

其中，xc68_osu_olsdh_prbs_result_get_cmd是基于命令行函数名称添加第一后缀“cmd”得到的表示函数的参数；xc68_osu_olsdh_prbs_result_get_struct

是基于命令行函数名称添加第二后缀“struct”得到的命令定义宏中的结构体参数；“show\n”是某一个分段字符添加回车符后得到的该分段字符的提示信息。

在本实施例的一示例中，所述根据命令的完全名称生成命令行函数的命令字段，包括：

根据非固定字符的标志确定所述命令的完全名称中包括非固定字符时，对所述非固定字符进行解析，生成命令行函数的解析代码，所述非固定字符包括可选项字段和必选项字段。

其中，所述对所述非固定字符进行解析，生成命令行函数的解析代码，包括：

根据所述非固定字符中的分隔符(例如“|”)，提取所述非固定字符所包括的分段字符，并将所有分段字符保存在一字典树形式的数据结构中；

遍历所述字典树并结合所述非固定字符在所述命令的完全名称中的位置，生成对于每一分段字符的解析代码。

例如，在对可选项字段或必选项字段内容处理过程中，根据必选项字段或可选项字段中是否包含“|”判断其是否包含多个分段字符，当包含可能多个分段字符时，处理所述必选项字段或可选项字段是通过使用字典树将“|”区分的分段字符如单词插入字典树中，解析时遍历字典树就得到了对每个必选项字段或可选项字段的解析。

在表1的示例中，命令的完全名称中的第5个字符是必选项字段，包括两个分段字符“hp”和“lp”，则根据本示例所述的命令行函数代码生成方法，上述表1中要编写的命令行生成的分段命令为：

上述代码中，argv[4][0]中的“[4]”表示字符在命令的完全名称中的索引为4，“[0]”表示该字符中索引为0的字母即第1个字母，argv[4][0]可以将命令的完全名称中索引为4的字符中索引为0的字母提取出来。

上述分段命令可以用于解析API验证时输入的命令行中的必选项字段，在API验证时输入的命令行中的必选项字段只有一个取值即一个分段字符，通过上述代码即可以实现对该段字符的解析。

在另一示例中，假定命令的完全名称中第5个字符为一个必选项字段(ab|c|ac)时，将(ab|c|ac)分隔后保存在字典树中如图2所示，图2中的a、b、c代表必选项字段中的小写字母a、b、c。然后，遍历所述字典树即得到对该必选项字段的处理逻辑，对可选项字段的处理类似，不再赘述。

假设(ab|c|ac)为命令的完全名称中位置4上的必选项。根据深度优先遍历(即先为比较字符的位置)的过程，生成下述命令行函数的命令字段的代码：

本示例使用字典树数据结构的相关算法作为主要算法逻辑，将空格作为分隔符，根据空格分隔符得到所述非固定字符在所述命令的完全名称中的位置，当为必选项时，根据“|”提取该可选项所包括的分段字符，保存在一字典树形式的数据结构中，然后根据字典树遍历得到选项的判断条件，生成相关的命令行函数的代码。即命令行函数的参数序号和必选项判断条件使用算法生成，能够避免人工编写可能存在的错误，

上述人工编写的错误具体可能如下：

当命令的完全名称中的第9个字符是必选项字段“((jx_cfg_profile_sel|rx_c2_chk|rx_c2_value|etsl_vld|rx_k3_mode|rx_rei_blk|rx_bip_blk|force_ais))”时，其中“force_ais”的“f”的if判断语句应为if(argv[8][0]＝＝'f')，其中8和0的id很容易数错。

在本公开一示例性的实施例中，所述根据所述命令行内容生成命令行函数的代码之后，所述方法还包括：将所述命令行函数的代码写入到指定的代码文件，并按照所述代码文件的保存路径对所述代码文件进行保存。

在本实施例的一示例中，所述代码文件为C语言格式的文件；所述命令行函数的代码是SDK中API的命令行函数的代码。但本公开不局限于此，本实施例的命令行函数代码生成方法也可以用于生成其他命令行函数的代码。

在本公开一实施例中提供了一种命令行函数的生成方法，其使用于本公开上述实施例的命令行函数代码生成方法，如图3所示，所述命令行函数的生成方法包括以下步骤：

步骤S310，撰写建模Excel文件，具体为：

将要编写的命令行按照建模的三部分信息(命令行对应函数名称、命令的完全名称、命令的描述)填入指定Excel表的一行中。表2示出了是要编写的命令行的内容。

步骤S320，程序生成cmd.c文件，具体为：

执行包含命令行生成逻辑的程序，采用本公开任一实施例所述的命令行函数代码生成方法解析所述Excel文件中的每条命令行内容，生成每条命令行内容对应的命令行函数的代码，并将生成的命令行函数的代码写入指定的代码文件。本示例中，所述代码文件保存为命名为cmd.c的C语言格式的代码文件。

步骤S330，补充cmd.c文件中命令行函数的API调用部分和将API使用结构体进行组装。

仍使用表1所示的示例中，将表1中要编写代码的命令行生成命令行函数的代码后，补充API调用部分和将API使用结构体进行组装的代码为：

表1中要编写的命令行经过上述实施例所示的命令行函数代码生成方法，和人工补充API相关代码后，最终生成的完整代码为：

本实施例采用Excel文档作为建模的输入文件，采用抽象出命令行生成逻辑的程序作为建模数据的核心解析程序，提炼出命令行代码中的注释、函数头、提示信息、参数判断的生成的逻辑，一键生成SDK开发中API相关命令行的C语言代码，并输出到结果文件cmd.c中。使得开发人员可以专注于命令行本身的编写，只需要填写完Excel文档中的命令信息后执行所述程序，秒级时间内即可完成多个命令行函数C语言代码的生成，并且自动生成的代码可以直接编译通过，开发人员只需要适配一下API即可进行验证，不仅能够大大提高开发效率，还能避免人工编写可能存在的错误。

本公开一实施例还提供了一种命令行函数代码生成装置，参见图4，包括处理器以及存储有计算机程序的存储器，其中，所述处理器执行所述计算机程序时能够实现如本公开任一实施例所述的命令行函数代码生成方法。

本公开上述实施例的处理器可以是通用处理器，包括中央处理器(CPU)、网络处理器(Network Processor，简称NP)、微处理器等等，也可以是其他常规的处理器等；所述处理器还可以是数字信号处理器(DSP)、专用集成电路(ASIC)、现成可编程门阵列(FPGA)、离散逻辑或者其他可编程逻辑器件、分立门或者晶体管逻辑器件、分立硬件组件，或其它等效集成或离散的逻辑电路，也可以是上述器件的组合。即上述实施例的处理器可以是实现本发明实施例中公开的各方法、步骤及逻辑框图的任何处理器件或器件组合。如果部分地以软件来实施本公开实施例，那么可将用于软件的指令存储在合适的非易失性计算机可读存储媒体中，且可使用一个或多个处理器在硬件中执行所述指令从而实施本公开实施例的方法。本文中所使用的术语“处理器”可指上述结构或适合于实施本文中所描述的技术的任意其它结构。

本公开一实施例还提供了一种非瞬态计算机可读存储介质，所述计算机可读存储介质存储有计算机程序，其中，所述计算机程序时被处理器执行时能够实现如本公开任一实施例所述的命令行函数代码生成方法。

在以上一个或多个示例性实施例中，所描述的功能可以硬件、软件、固件或其任一组合来实施。如果以软件实施，那么功能可作为一个或多个指令或代码存储在计算机可读介质上或经由计算机可读介质传输，且由基于硬件的处理单元执行。计算机可读介质可包含对应于例如数据存储介质等有形介质的计算机可读存储介质，或包含促进计算机程序例如根据通信协议从一处传送到另一处的任何介质的通信介质。以此方式，计算机可读介质通常可对应于非暂时性的有形计算机可读存储介质或例如信号或载波等通信介质。数据存储介质可为可由一个或多个计算机或者一个或多个处理器存取以检索用于实施本公开中描述的技术的指令、代码和/或数据结构的任何可用介质。计算机程序产品可包含计算机可读介质。

举例来说且并非限制，此类计算机可读存储介质可包括RAM、ROM、EEPROM、CD-ROM或其它光盘存储装置、磁盘存储装置或其它磁性存储装置、快闪存储器或可用来以指令或数据结构的形式存储所要程序代码且可由计算机存取的任何其它介质。而且，还可以将任何连接称作计算机可读介质举例来说，如果使用同轴电缆、光纤电缆、双绞线、数字订户线(DSL)或例如红外线、无线电及微波等无线技术从网站、服务器或其它远程源传输指令，则同轴电缆、光纤电缆、双纹线、DSL或例如红外线、无线电及微波等无线技术包含于介质的定义中。然而应了解，计算机可读存储介质和数据存储介质不包含连接、载波、信号或其它瞬时(瞬态)介质，而是针对非瞬时有形存储介质。如本文中所使用，磁盘及光盘包含压缩光盘(CD)、激光光盘、光学光盘、数字多功能光盘(DVD)、软磁盘或蓝光光盘等，其中磁盘通常以磁性方式再生数据，而光盘使用激光以光学方式再生数据。上文的组合也应包含在计算机可读介质的范围内。

Claims (11)

1.一种命令行函数代码生成方法，其特征在于，包括：

获取建模输入文件；

解析所述建模输入文件中的命令行内容，所述命令行内容包括命令行对应函数名称、命令的完全名称、命令的描述；

根据所述命令行内容生成命令行函数的代码。

2.根据权利要求1所述的方法，其特征在于：

所述根据所述命令行内容生成命令行函数的代码，包括：对每一条命令行内容，按以下方式生成相应命令行函数的代码：

根据命令的描述生成命令行函数的注释；

根据命令行对应函数名称和命令的完全名称生成命令行函数的函数头；

根据命令的完全名称生成命令行函数的命令字段。

3.根据权利要求2所述的方法，其特征在于，所述根据命令的描述生成命令行函数的注释，包括：

在所述命令的描述的基础上添加注释符号，作为命令行的注释信息；

将所述命令行的注释添加到所述命令行函数的开头。

4.根据权利要求2所述的方法，其特征在于：

所述函数头依次包括声明函数和命令定义宏，所述根据命令行对应函数名称和命令的完全名称生成命令行函数的函数头，包括：

为所述命令行对应函数名称添加第一后缀，作为所述声明函数和所述命令定义宏中表示函数的参数；为所述命令行对应函数名称添加第二后缀，作为所述命令定义宏中的结构体参数；

根据所述命令行对应函数名称生成所述声明函数的输入输出参数；

根据所述命令的完全名称生成所述命令定义宏中的当前命令行字符及分段字符的提示信息。

5.根据权利要求4所述的方法，其特征在于：

所述分段字符的提示信息通过以下方式生成：从所述命令的完全名称中提取非固定字符中的分段字符；及，按照提取的分段字符在所述命令的完全名称中的顺序，为每一分段字符添加回车符并写入所述命令定义宏，作为该分段字符的提示信息。

6.根据权利要求2所述的方法，其特征在于：

所述根据命令的完全名称生成命令行函数的命令字段，包括：

根据非固定字符的标志确定所述命令的完全名称中包括非固定字符时，对所述非固定字符进行解析，生成命令行函数的解析代码，所述非固定字符包括可选项字段和必选项字段。

7.根据权利要求6所述的方法，其特征在于：

对所述非固定字符进行解析，生成命令行函数的解析代码，包括：

根据所述非固定字符中的分隔符，提取所述非固定字符所包括的分段字符，并将所有分段字符保存在一字典树形式的数据结构中；

遍历所述字典树并结合所述非固定字符在所述命令的完全名称中的位置，生成对于每一分段字符的解析代码。

8.根据权利要求1所述的方法，其特征在于：

根据所述命令行内容生成命令行函数的代码之后，所述方法还包括：

将所述命令行函数的代码写入到指定的代码文件，并按照所述代码文件的保存路径对所述代码文件进行保存。

9.根据权利要求8所述的方法，其特征在于：

所述代码文件为C语言格式的文件；

所述命令行函数的代码是软件开发工具包中应用程序编程接口的命令行函数的代码。

10.一种命令行函数代码生成装置，包括处理器以及存储有计算机程序的存储器，其中，所述处理器执行所述计算机程序时能够实现如权利要求1至9中任一所述的命令行函数代码生成方法。

11.一种非瞬态计算机可读存储介质，所述计算机可读存储介质存储有计算机程序，其中，所述计算机程序时被处理器执行时能够实现如权利要求1至9中任一所述的命令行函数代码生成方法。

Images