12 KiB
3.Pikascript标准开发流程
本篇文档将会介绍基于PikaScript开发的标准流程，这个标准流程将会涵盖大部分情况下会用到的PikaScript相关技术。
我们依然以keil的仿真工程为例，如果还没有获得仿真工程，请参考1.三分钟快速上手
(1). 使用已有的PikaScript类包
a) PikaScript类包与包接口
我们打开pikascript文件夹，发现文件夹根目录下除了main.py，还有Device.py，PikaObj.py和PikaStdLib.py，这三个.py文件分别对应三个PikaScript类包(class package)，简称包(package)，每个.py文件本身称为包接口(package interface)。一个类包中可以包含若干个相关性较强的类。
每一个PikaScript类包由包接口和包实现(package implement)两部分组成。
我们先打开Device.py查看一下内容，在后续的文档中我们会称Device.py为Device包接口。
以下就是Device.py的全部内容。
# Device.py
from PikaObj import *
class LED(TinyObj):
def on():
pass
def off():
pass
class Uart(TinyObj):
def send(data:str):
pass
def setName(name:str):
pass
def printName():
pass
可以看到，Device.py中使用pyhon标准语法定义了两个类，分别是LED类和Uart类，这两个类都继承自TinyObj。
LED类中定义了两个方法，分别是on()方法和off()方法，而Uart类则定义了send(data:str)方法、setName(name:str)方法和printName()方法。
可以看到，这些方法都有一个特点，与其说这是方法的定义，不如说是方法的声明，因为所有的方法实现都pass掉了，都没有写实现。而且方法的入口参数都是带有类型声明的。比如data:str就表示一个data参数，参数类型为str即字符串类型。
这是因为这个包的包实现是由C语言编写的，也就是说，PikaScript的所有类包，都是使用python语法编写声明，而使用C语言编写实现。PikaScript的类包开发是一种面向接口编程的混合编程技术。
然而在使用已有的类包时，是不需要了解包实现的，只需要了解包接口，即可使用这个类包。
b) 导入并调用包
下面我们看一下如何使用这个类包。
我们打开工程中的main.py，见名知意，这个文件是PikaScript的入口文件。
main.py的内容如下
# main.py
from PikaObj import *
import Device
import PikaStdLib
led = Device.LED()
uart = Device.Uart()
mem = PikaStdLib.MemChecker()
print('hello wrold')
uart.setName('com1')
uart.send('My name is:')
uart.printName()
print('mem used max:')
mem.max()
print('mem used now:')
mem.now()
导入一个已经编写好的类包是非常简单的，比如导入Device包，只需要import Device即可，要注意的是所有的.py文件应当放在pikascript文件架的根目录下。
然后使用Device中的LED类新建对象，只需要写一句uart = Device.Uart()即可，这表示新建一个uart对象，这个对象的类是Device包中的Uart类。
调用方法则使用uart.setName('com')这种形式，这都是Python的标准语法，不需要过多介绍。
在main.py中写好包的调用后，双击rust-msc-v0.5.0.exe即可预编译PikaScript工程，预编译的输出文件在pikascrip-api文件夹内。
pika预编译器会为导入的包生成.h声明文件和-api.c构造器文件。文件名以包名开头，每个类对应一个.h文件和一个-api.c文件。
而PikaMain-api.c和PikaMain.h则是对应了一个特殊的类，这个类是PikaScript的主类，由main.py编译而成。
pikaScript.c和pikaScript.h则是根据main.py编译出的初始化函数，运行初始化函数时，会自动执行启动脚本。
在现在的main.py中，启动脚本是写在最外层的方法调用，也就是:
print('hello wrold')
uart.setName('com1')
uart.send('My name is:')
uart.printName()
print('mem used max:')
mem.max()
print('mem used now:')
mem.now()
编译出的pikaScriptInit()初始化函数对应的是:
PikaObj * pikaScriptInit(){
PikaObj * pikaMain = newRootObj("pikaMain", New_PikaMain);
obj_run(pikaMain, "print('hello wrold')");
obj_run(pikaMain, "uart.setName('com1')");
obj_run(pikaMain, "uart.send('My name is:')");
obj_run(pikaMain, "uart.printName()");
obj_run(pikaMain, "print('mem used max:')");
obj_run(pikaMain, "mem.max()");
obj_run(pikaMain, "print('mem used now:')");
obj_run(pikaMain, "mem.now()");
return pikaMain;
}
(2) 编写新的PikaScript类包
a)新建包接口
编写一个新的类包，首先需要编写包接口文件，比如编写一个数学计算类包Math，第一步是编写Math.py，包名首字母应当大写。
如果要从PikaScript基本类中创建新的类，则需要import PikaObj类包，导入PikaObj类包应使用from PikaObj import *的引入方式，实际上Pika预编译器是不会编译使用from语法导入的包的，这样写只是为了获得python编辑器的智能语法提示，PikaObj是内置于Pika运行时内核的。
# Math.py
from PikaObj import *
我们可以打开PikaObj.py文件查看里面的类接口
# PikaObj.py
class TinyObj:
pass
class BaseObj(TinyObj):
pass
def print(val: any):
pass
def set(argPath: str, val: any):
pass
可以看到里面有TinyObj和BaseObj两个类，这两个类是由PikaScript内核实现的基本类，TinyObj是没有任何功能的最基本的类，内存占用最少，BaseObj和TinyObj相似，但是BaseObj可以挂载子对象。
print(val: any)表示输入参数为泛型的函数，set(argPath:str, val:any)也是泛型函数，这两个函数由内核实现，PikaScript类包目前还不支持自定义泛型函数。
b)编写类接口
现在我们可以在Math.py里面新建类了，比如我们要新建一个Adder类来实现相关的加法运算，我们就可以在Math.py里面添加Adder类，为了节省内存，Adder类从TinyObj基类中继承。
然后我们希望Adder可以为整形、浮点型数据提供加法运算，那么就可以添加byInt方法和byFloat方法。
# Math.py
class Adder(TinyObj):
def byInt(a:int, b:int)->int:
pass
def byFloat(a:float, b:float)->float:
pass
上面的一段代码中我们定义了Adder类，并添加了两个方法的声明，byInt(a:int,b:int)->int表示方法名为byInt,输入参数为a和b，a和b的类型都是int型，而返回值也是int型，返回值由->int来确定，这都是python的标准语法，是带类型声明的写法。
我们再向math.py里面添加一个Multiplier类，用来实现乘法，Multiplier的写法如下所示，Multiplier类同样从TinyObj基类中继承：
# Math.py
class Multiplier(TinyObj):
def byInt(a:int, b:int)->int:
pass
def byFloat(a:float, b:float)->float:
pass
到此类接口就编写完成了。我们在main.py中引入Math包，这样Pika预编译器就会去编译Math类包了。
# main.py
import Math
双击运行pika预编译器。
打开pikascript-api文件夹可以发现，我们新编写的类包接口已经可以被编译出来了。
c)编写类的实现
我们把刚刚新编译出的两个-api.c文件添加到工程，然后编译一下试试。
发现编译报错了，提示是有四个函数没有找到定义。
这是正常的，因为我们之前并没有为Math包的类编写实现，下面我们就来编写这些类的实现。
为了包管理的方便，我们把实现文件都放在pikascript-lib文件夹下，
在pikascript-lib文件夹下，新建一个Math文件夹，用来放Math包的实现代码。
然后在Math文件夹下新建.c文件，建议用"包名_类名.c"的命名方式为每一个类新建一个.c文件，提高代码的清晰性。
然后我们在这两个.c文件里面编写类的方法实现。那么问题来了，我们如何知道应当编写哪些实现呢？
这个很简单，我们打开Math_Multiplier.h和Math_Adder.h就可以发现，我们需要编写的实现函数已经被声明好了。
/* Math_Multiplier.h */
/* ******************************** */
/* Warning! Don't modify this file! */
/* ******************************** */
#ifndef __Math_Multiplier__H
#define __Math_Multiplier__H
#include <stdio.h>
#include <stdlib.h>
#include "PikaObj.h"
PikaObj *New_Math_Multiplier(Args *args);
float Math_Multiplier_byFloat(PikaObj *self, float a, float b);
int Math_Multiplier_byInt(PikaObj *self, int a, int b);
#endif
/* Math_Adder.h */
/* ******************************** */
/* Warning! Don't modify this file! */
/* ******************************** */
#ifndef __Math_Adder__H
#define __Math_Adder__H
#include <stdio.h>
#include <stdlib.h>
#include "PikaObj.h"
PikaObj *New_Math_Adder(Args *args);
float Math_Adder_byFloat(PikaObj *self, float a, float b);
int Math_Adder_byInt(PikaObj *self, int a, int b);
#endif
然后我们直接在Math_Adder.c和Math_Multipler.c里面去实现这四个函数就ok了。
/* Math_Adder.c */
#include "pikaScript.h"
float Math_Adder_byFloat(PikaObj *self, float a, float b)
{
return a + b;
}
int Math_Adder_byInt(PikaObj *self, int a, int b)
{
return a + b;
}
/* Math_Multipler.c */
#include "pikaScript.h"
float Math_Multiplier_byFloat(PikaObj *self, float a, float b)
{
return a * b;
}
int Math_Multiplier_byInt(PikaObj *self, int a, int b)
{
return a * b;
}
这时,再编译项目，就可以通过了。
d)测试一下效果
我们用下面的main.py来测试一下我们新编写的类包
# main.py
import Math
adder = Math.Adder()
muler = Math.Multiplier()
res1 = adder.byInt(1, 2)
print('1 + 2')
print(res1)
res2 = adder.byFloat(2.3, 4.2)
print('2.3 + 4.2')
print(res2)
res3 = muler.byInt(2, 3)
print('2 * 3')
print(res3)
res4 = muler.byFloat(2.3, 44.2)
print('2.3 * 44.2')
print(res4)
运行的效果如下：
这说明我们编写的类包工作正常了。
e)发布类包
出于开源的精神，发布你自己的类包是一件非常酷且激动人心的事情。
发布类包只需要发布类接口和类实现文件即可。
比如发布刚刚新编写的Math类包，就是发布Math.py文件和pikascript-lib/Math文件夹。
这样一个类包就完成了，你可以把这个类包发布在github的独立仓库中，或者也可以使用pull request功能将你的类包添加进pikascript主仓库！
到此为止，pikascript标准开发流程就结束了。
更多的进阶应用请关注PikaScript内核Api手册。