1 Star 2 Fork 2

AGeek / kconfiglib_tool

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
GPL-2.0

kconfiglib_tool

kcfg3

开源地址:https://gitee.com/nikolan/kconfiglib_tool

kconfiglib_tool工具实现宏定义配置图形化选项菜单, 能让你在Windows平台下使用kconifg,来管理你的系统配置选项, 适用于为各种单片机宏定义配置图形化选项菜单。

kconifg是一种配置文件的语法
如果有接触过esp-idf或者是Linux的menuconfig,相信就对这个比较熟悉。

这个工具最终目的是通过简单的命令行字符图形界面
来方便地配置各种选项最终生成一个头文件的各种宏定义
这些宏定义最终会间接影响编译生成的固件
通过这个可以方便地裁剪功能或者选择不同的配置

而近年来越来越多厂商提供的SDK,
都是以kconfig来实现的menuconfig来做一些配置。

例如:

  • esp-idf
  • Zephyr
  • rt-thread-env
  • NuttX

使用方法

基本测试

这个kconfig.exe是使用了pyinstaller打包的exe可执行文件
理论上是没有pyhton环境的电脑也可以打开使用
不过我也没法测试

所以在放到你工程上使用前可以先跑一下项目我测试的这个demo

直接双击打开kconfig.exe会重新menuconfig类似的界面
kcfg1

然后随便修改一个选项
kcfg2

按q退出时会询问是否保存修改
选Yes
kcfg3

接着查看生成的这个gen_config.h里面的宏定义的值
是否和你在界面修改的一致。
kcfg4

放到工程上使用

1.首先使用kconfig的语法来
编写对应配置菜单文件
conifg.in
如果你对kconfig一点都不懂
就看我的demo改字符串就行
后面再看看语法,都比较简单

kcfg5

2.复制 kconfig.exe
到你工程的tool工具目录下

3.然后复制user.json
到kconfig.exe的同一目录
填写必要的配置
填写无误后直接运行就能生成gen_config.h
kcfg7

4.以下对json文件的配置项做详细说明
其实如果你没有什么要求只需要修改下
input_file_path
output_file_path
include_libs
这三项就可以了,其他没什么必要改,只是留出来接口给大家玩玩

kcfg6

  • input_file_path": "./config.in"
    填写kconfig的菜单描述文件.in所在目录

  • "output_file_path": "./gen_config.h"
    填写最终生成的.h头文件配置的目录

  • "defconfig_path":"./defconfig.config",
    填写初步处理的配置项文件的目录

  • "defconfig_header":"./defconfig.h",
    填写按配置项文件转为宏定义后的初步头文件目录

  • "update_time": true,
    是否开启每次配置后更新头文件的生成配置的时间,默认开启

  • "add_extern_c": false,
    是否给头文件加入extern c语法使得c++可兼容使用,默认开启

  • "fg_color":"white",
    终端字体的颜色

  • "bg_color":"green",
    终端背景的颜色

  • "encoding":"utf-8",
    字体编码UTF-8,好像如果有非英文字体不用UTF-8会报错

  • "creator":"your name here",
    配置的作者名称

  • "first_letter_of_macro":"#",
    字符串首字符为#时,取消字符串双引号,只取字符串名称

  • "item_prefix":"CONFIG_",
    生成的配置项宏定义的前缀,好像Linux都是加这个前缀的

  • "description":[
    "your Description!"
    ],
    添加头文件的描述,这里可以写自己的一些说明注意事项什么的

  • "include_libs": [


"#include \"stdint.h\"",
"#include \"stdbool.h\"",
"#include \"stm32f4xx.h\""

]
添加需要引入到生成的配置头文件的各种头文件和库
注意这些双引号在字符串内需要使用\",以逗号分开每一项

二次开发添加的功能

这个和kconfig的menuconfig的功能
基本变化不大,语法也是和kconfig一样
就稍微添加了2个功能方便配置.

通过json文件来配置程序

kcfg6 因为直接打包为exe
方便没有python和各种库
都能直接运行在电脑上
而且需要配置的功能比较多
通过命令行传参比较麻烦

干脆就用一个user.json
来填写各种参数程序来读取这个文件

字符串以#开头则二次处理取消字符串的双引号

kcfg7 这个主要是为了能直接填写宏定义的名称和变量名称
因为kconfig的变量类型不能直接填名称

但是我希望配置一下底层的HAL库的结构体
某些选项就需要填宏定义的名称,
总不能填地址或者去库翻一翻宏定义是什么数值吧
这样配置的话可读性也太差了。

所以参考就添加这么个方法把以#开头的字符串
直接填字符而不加双引号

利用这个方法,如果你和我一样
其实并不需要使用kconfig的其他复杂功能
只需要能用图形配置菜单填写宏定义的值
那么甚至可以简化kconfig的语法
把几乎所有选项全变为字符串类型

只需要会用这个格式
就能轻松自定义设计menuconfig的菜单了


menu "menu_name"
config A
	string "A"
	default "#xxx"
endmenu

如果你希望这个宏定义A是整数1
default "#1"就直接处理为1

如果你希望它是浮点数
default "#1.2"直接处理为1.2

如果你希望直接填宏定义或变量名称
default "#GPIOA"直接处理为GPIOA

如果你就需要它是字符串则不以#开头
default "string"处理为"string"

当然这个是pyhton二次处理的,不是kconfig的标准语法。
直接用kconfig也没有什么难度
这个处理只有你字符串不使用#开头语法也不冲突

后续 TODO


最初这个东西是运行于Linux的
有看到移植到window的版本

python的版本:
是现在这个Kconfiglib
https://github.com/ulfalizer/Kconfiglib

c的版本:
是这个kconfig-frontends
官方原版:https://github.com/uvc-ingenieure/kconfig-frontends
乐鑫fork的版本:https://github.com/espressif/kconfig-frontends

这里使用python版本进行重新封装开发一下
c版本的因为cmake报错没找到解决办法
安装了一堆gunwin32的各种依赖库
cmake终于生成Makefile了
后面make都到100%
连接为exe文件时又说有什么定义找不到了编译失败
搞了一天了没办法最后还是选择用python这个

kcfg8

在python的这个kconfiglib
我有尝试了使用中文字符来做配置菜单
在普通cmd终端下会重新中文文字重叠
换一个比较好的终端切换界面后会有中文字体的残留

猜测是底层对中文字符串不太支持,
应该是删除时,为了速度没有全刷而是局刷
但是没考虑中文的宽度,
pyhton的库也没法查查源码排查就放弃做中文支持了。

如果使用C语言版本的说不定是能查查代码改一下API的
尝试解决字体残留的
但是C语言版本的编译不过
就先这样了

___ageek一个极客开源

二次开发环境搭建

请安装pyhton3 然后通过pip install 安装kconfig.py需要用到的各种库 例如


pip install kconfiglib
pip install pyinstaller

之后直接


python ./kconfig

进行调试

最终通过pyinstaller来打包为exe 这样exe就不需要python环境单独执行了 打包完成后的exe在./dist下

pyinstaller ./kconfig.py
GNU GENERAL PUBLIC LICENSE Version 2, June 1991 Copyright (C) 1989, 1991 Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. Preamble The licenses for most software are designed to take away your freedom to share and change it. By contrast, the GNU General Public License is intended to guarantee your freedom to share and change free software--to make sure the software is free for all its users. This General Public License applies to most of the Free Software Foundation's software and to any other program whose authors commit to using it. (Some other Free Software Foundation software is covered by the GNU Lesser General Public License instead.) You can apply it to your programs, too. When we speak of free software, we are referring to freedom, not price. Our General Public Licenses are designed to make sure that you have the freedom to distribute copies of free software (and charge for this service if you wish), that you receive source code or can get it if you want it, that you can change the software or use pieces of it in new free programs; and that you know you can do these things. To protect your rights, we need to make restrictions that forbid anyone to deny you these rights or to ask you to surrender the rights. These restrictions translate to certain responsibilities for you if you distribute copies of the software, or if you modify it. For example, if you distribute copies of such a program, whether gratis or for a fee, you must give the recipients all the rights that you have. You must make sure that they, too, receive or can get the source code. And you must show them these terms so they know their rights. We protect your rights with two steps: (1) copyright the software, and (2) offer you this license which gives you legal permission to copy, distribute and/or modify the software. Also, for each author's protection and ours, we want to make certain that everyone understands that there is no warranty for this free software. If the software is modified by someone else and passed on, we want its recipients to know that what they have is not the original, so that any problems introduced by others will not reflect on the original authors' reputations. Finally, any free program is threatened constantly by software patents. We wish to avoid the danger that redistributors of a free program will individually obtain patent licenses, in effect making the program proprietary. To prevent this, we have made it clear that any patent must be licensed for everyone's free use or not licensed at all. The precise terms and conditions for copying, distribution and modification follow. GNU GENERAL PUBLIC LICENSE TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION 0. This License applies to any program or other work which contains a notice placed by the copyright holder saying it may be distributed under the terms of this General Public License. The "Program", below, refers to any such program or work, and a "work based on the Program" means either the Program or any derivative work under copyright law: that is to say, a work containing the Program or a portion of it, either verbatim or with modifications and/or translated into another language. (Hereinafter, translation is included without limitation in the term "modification".) Each licensee is addressed as "you". Activities other than copying, distribution and modification are not covered by this License; they are outside its scope. The act of running the Program is not restricted, and the output from the Program is covered only if its contents constitute a work based on the Program (independent of having been made by running the Program). Whether that is true depends on what the Program does. 1. You may copy and distribute verbatim copies of the Program's source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice and disclaimer of warranty; keep intact all the notices that refer to this License and to the absence of any warranty; and give any other recipients of the Program a copy of this License along with the Program. You may charge a fee for the physical act of transferring a copy, and you may at your option offer warranty protection in exchange for a fee. 2. You may modify your copy or copies of the Program or any portion of it, thus forming a work based on the Program, and copy and distribute such modifications or work under the terms of Section 1 above, provided that you also meet all of these conditions: a) You must cause the modified files to carry prominent notices stating that you changed the files and the date of any change. b) You must cause any work that you distribute or publish, that in whole or in part contains or is derived from the Program or any part thereof, to be licensed as a whole at no charge to all third parties under the terms of this License. c) If the modified program normally reads commands interactively when run, you must cause it, when started running for such interactive use in the most ordinary way, to print or display an announcement including an appropriate copyright notice and a notice that there is no warranty (or else, saying that you provide a warranty) and that users may redistribute the program under these conditions, and telling the user how to view a copy of this License. (Exception: if the Program itself is interactive but does not normally print such an announcement, your work based on the Program is not required to print an announcement.) These requirements apply to the modified work as a whole. If identifiable sections of that work are not derived from the Program, and can be reasonably considered independent and separate works in themselves, then this License, and its terms, do not apply to those sections when you distribute them as separate works. But when you distribute the same sections as part of a whole which is a work based on the Program, the distribution of the whole must be on the terms of this License, whose permissions for other licensees extend to the entire whole, and thus to each and every part regardless of who wrote it. Thus, it is not the intent of this section to claim rights or contest your rights to work written entirely by you; rather, the intent is to exercise the right to control the distribution of derivative or collective works based on the Program. In addition, mere aggregation of another work not based on the Program with the Program (or with a work based on the Program) on a volume of a storage or distribution medium does not bring the other work under the scope of this License. 3. You may copy and distribute the Program (or a work based on it, under Section 2) in object code or executable form under the terms of Sections 1 and 2 above provided that you also do one of the following: a) Accompany it with the complete corresponding machine-readable source code, which must be distributed under the terms of Sections 1 and 2 above on a medium customarily used for software interchange; or, b) Accompany it with a written offer, valid for at least three years, to give any third party, for a charge no more than your cost of physically performing source distribution, a complete machine-readable copy of the corresponding source code, to be distributed under the terms of Sections 1 and 2 above on a medium customarily used for software interchange; or, c) Accompany it with the information you received as to the offer to distribute corresponding source code. (This alternative is allowed only for noncommercial distribution and only if you received the program in object code or executable form with such an offer, in accord with Subsection b above.) The source code for a work means the preferred form of the work for making modifications to it. For an executable work, complete source code means all the source code for all modules it contains, plus any associated interface definition files, plus the scripts used to control compilation and installation of the executable. However, as a special exception, the source code distributed need not include anything that is normally distributed (in either source or binary form) with the major components (compiler, kernel, and so on) of the operating system on which the executable runs, unless that component itself accompanies the executable. If distribution of executable or object code is made by offering access to copy from a designated place, then offering equivalent access to copy the source code from the same place counts as distribution of the source code, even though third parties are not compelled to copy the source along with the object code. 4. You may not copy, modify, sublicense, or distribute the Program except as expressly provided under this License. Any attempt otherwise to copy, modify, sublicense or distribute the Program is void, and will automatically terminate your rights under this License. However, parties who have received copies, or rights, from you under this License will not have their licenses terminated so long as such parties remain in full compliance. 5. You are not required to accept this License, since you have not signed it. However, nothing else grants you permission to modify or distribute the Program or its derivative works. These actions are prohibited by law if you do not accept this License. Therefore, by modifying or distributing the Program (or any work based on the Program), you indicate your acceptance of this License to do so, and all its terms and conditions for copying, distributing or modifying the Program or works based on it. 6. Each time you redistribute the Program (or any work based on the Program), the recipient automatically receives a license from the original licensor to copy, distribute or modify the Program subject to these terms and conditions. You may not impose any further restrictions on the recipients' exercise of the rights granted herein. You are not responsible for enforcing compliance by third parties to this License. 7. If, as a consequence of a court judgment or allegation of patent infringement or for any other reason (not limited to patent issues), conditions are imposed on you (whether by court order, agreement or otherwise) that contradict the conditions of this License, they do not excuse you from the conditions of this License. If you cannot distribute so as to satisfy simultaneously your obligations under this License and any other pertinent obligations, then as a consequence you may not distribute the Program at all. For example, if a patent license would not permit royalty-free redistribution of the Program by all those who receive copies directly or indirectly through you, then the only way you could satisfy both it and this License would be to refrain entirely from distribution of the Program. If any portion of this section is held invalid or unenforceable under any particular circumstance, the balance of the section is intended to apply and the section as a whole is intended to apply in other circumstances. It is not the purpose of this section to induce you to infringe any patents or other property right claims or to contest validity of any such claims; this section has the sole purpose of protecting the integrity of the free software distribution system, which is implemented by public license practices. Many people have made generous contributions to the wide range of software distributed through that system in reliance on consistent application of that system; it is up to the author/donor to decide if he or she is willing to distribute software through any other system and a licensee cannot impose that choice. This section is intended to make thoroughly clear what is believed to be a consequence of the rest of this License. 8. If the distribution and/or use of the Program is restricted in certain countries either by patents or by copyrighted interfaces, the original copyright holder who places the Program under this License may add an explicit geographical distribution limitation excluding those countries, so that distribution is permitted only in or among countries not thus excluded. In such case, this License incorporates the limitation as if written in the body of this License. 9. The Free Software Foundation may publish revised and/or new versions of the General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. Each version is given a distinguishing version number. If the Program specifies a version number of this License which applies to it and "any later version", you have the option of following the terms and conditions either of that version or of any later version published by the Free Software Foundation. If the Program does not specify a version number of this License, you may choose any version ever published by the Free Software Foundation. 10. If you wish to incorporate parts of the Program into other free programs whose distribution conditions are different, write to the author to ask for permission. For software which is copyrighted by the Free Software Foundation, write to the Free Software Foundation; we sometimes make exceptions for this. Our decision will be guided by the two goals of preserving the free status of all derivatives of our free software and of promoting the sharing and reuse of software generally. NO WARRANTY 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. END OF TERMS AND CONDITIONS How to Apply These Terms to Your New Programs If you develop a new program, and you want it to be of the greatest possible use to the public, the best way to achieve this is to make it free software which everyone can redistribute and change under these terms. To do so, attach the following notices to the program. It is safest to attach them to the start of each source file to most effectively convey the exclusion of warranty; and each file should have at least the "copyright" line and a pointer to where the full notice is found. <one line to give the program's name and a brief idea of what it does.> Copyright (C) <year> <name of author> This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. Also add information on how to contact you by electronic and paper mail. If the program is interactive, make it output a short notice like this when it starts in an interactive mode: Gnomovision version 69, Copyright (C) year name of author Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. This is free software, and you are welcome to redistribute it under certain conditions; type `show c' for details. The hypothetical commands `show w' and `show c' should show the appropriate parts of the General Public License. Of course, the commands you use may be called something other than `show w' and `show c'; they could even be mouse-clicks or menu items--whatever suits your program. You should also get your employer (if you work as a programmer) or your school, if any, to sign a "copyright disclaimer" for the program, if necessary. Here is a sample; alter the names: Yoyodyne, Inc., hereby disclaims all copyright interest in the program `Gnomovision' (which makes passes at compilers) written by James Hacker. <signature of Ty Coon>, 1 April 1989 Ty Coon, President of Vice This General Public License does not permit incorporating your program into proprietary programs. If your program is a subroutine library, you may consider it more useful to permit linking proprietary applications with the library. If this is what you want to do, use the GNU Lesser General Public License instead of this License.

简介

kconfiglib_tool工具实现宏定义配置图形化选项菜单,能让你在Windows平台下使用kconifg,来管理你的系统配置选项,适用于为各种单片机宏定义配置图形化选项菜单。 展开 收起
HTML 等 5 种语言
GPL-2.0
取消

贡献者

全部

近期动态

加载更多
不能加载更多了
1
https://gitee.com/nikolan/kconfiglib_tool.git
git@gitee.com:nikolan/kconfiglib_tool.git
nikolan
kconfiglib_tool
kconfiglib_tool
master

搜索帮助