由于V代码编译后生成的是C代码,然后再调用C编译器编译成可执行文件

    这样的机制决定了V语言可以很方便地调用C世界的各种代码库

    这对于V语言来说,是个很大的一个优势,毕竟C代码库经过多年的积累,很丰富

    如何调用

    在V代码里调用C代码也非常简单,在V标准库里随处可见

    以下是调用C代码库的基本步骤:

    1. 定义#flag

      定义flag这一步是可选的,比如调用C标准库的函数就不需要

      一般调用第三方库才需要用到,如果有需要,flag的定义要放在C语言宏之前

      关于#flag详细内容,参考下面的flag段落

    2. 在V代码中使用C语言宏

      比如#include宏或#define宏,编译时这些宏会被原封不动地搬到生成的C代码中

    3. 然后用V的语法定义要使用的C函数或C结构体的声明

      函数名或结构体名一定要在C名称的基础上添加C.前缀

    4. 然后就可以在V代码中使用C函数或结构体

      调用的时候,名称前可以使用C.作为前缀,也可以不使用,不过还是建议统一使用C.前缀,代码更容易区分是调用C函数或C结构体.

    调用标准库的例子:

    myslq库中的参考代码:

    2. #flag -lmysqlclient
    3. #flag linux -I/usr/include/mysql
    4. #include <mysql.h>
    5. //声明要使用的C结构体
    6. struct C.MYSQL
    7. struct C.MYSQL_RES
    8. //声明要使用的C函数
    9. fn C.mysql_init(mysql &C.MYSQL) &C.MYSQL
    10. fn C.mysql_real_connect(mysql &C.MYSQL, host &byte, user &byte, passwd &byte, db &byte, port u32, unix_socket &byte, clientflag u64) &C.MYSQL
    11. fn C.mysql_query(mysql &C.MYSQL, q &byte) int
    12. fn C.mysql_select_db(mysql &C.MYSQL, db &byte) int
    13. fn C.mysql_error(mysql &C.MYSQL) &byte
    14. fn C.mysql_errno(mysql &C.MYSQL) int
    15. fn C.mysql_num_fields(res &C.MYSQL_RES) int
    16. fn C.mysql_store_result(mysql &C.MYSQL) &C.MYSQL_RES
    17. fn C.mysql_fetch_row(res &C.MYSQL_RES) &&byte
    18. fn C.mysql_free_result(res &C.MYSQL_RES)
    19. fn C.mysql_real_escape_string_quote(mysql &C.MYSQL, to &byte, from &byte, len u64, quote byte) u64
    20. fn C.mysql_close(sock &C.MYSQL)
    22. //调用C函数或结构体
    23. pub fn connect(server, user, passwd, dbname string) ?DB {
    24.     conn := C.mysql_init(0)
    25.     if isnil(conn) {
    26.         return error_with_code(get_error_msg(conn), get_errno(conn))
    27.     }
    28.     conn2 := C.mysql_real_connect(conn, server.str, user.str, passwd.str, dbname.str, 0, 0, 0)
    29.     if isnil(conn2) {
    30.         return error_with_code(get_error_msg(conn), get_errno(conn))
    31.     }
    32.     return DB {conn: conn2}
    33. }

    另一个集成C代码库的例子:vlib/clipboard/clipboard_linux.c.v

    使用了结构体注解[typedef]来定义C语言的结构体

    1. //定义C宏
    2. #flag -lX11
    3. #include <X11/Xlib.h>
    5. [typedef]
    6. struct C.Display  //在v代码中只需使用C结构体,不使用结构体字段
    8. [typedef]
    9. struct C.XSelectionRequestEvent{ //在v代码中要使用结构体字段,要定义所需的字段
    10.     mut:
    11.     display &C.Display    /* Display the event was read from */
    12.     owner C.Window
    14.     selection C.Atom
    15.     target C.Atom
    16.     property C.Atom
    17.     time int
    18. }
    20. //定义C函数
    21. fn C.XInitThreads() int
    22. fn C.XCloseDisplay(d &Display)
    23. fn C.XFlush(d &Display)
    24. fn C.XDestroyWindow(d &Display, w C.Window)

    使用$env编译时函数

    $env也可以在#flay和#include等C宏中使用,让C宏的定义更灵活

    1. module main
    3. //可以在C宏语句中使用,让C宏的定义更灵活
    4. #flag linux -I $env('JAVA_HOME')/include
    6. fn main() {
    7.     compile_time_env := $env('PATH')
    8.     println(compile_time_env)
    9. }

    其实,直接在V代码中使用C函数或者结构体也是可以的,不过,由于命名方式不一致的原因,习惯上也可以对C函数或结构体,进行一层简单封装,名字可以重新改为V风格,或者更为简短的名字

    一般来说,对一个C代码库中的简单封装会涉及到:结构体,函数,枚举这3大类

    如果是小的C代码库,可以直接把这3类的简单封装都放在一个V源文件中

    如果C代码库规模大一些,也可以这3类,各自单独一个V源文件,归属于同一个V模块

    以下代码是GUI代码库中引用了sokol C代码库后,进行的简单封装:

    vlib/sokol/sokol.v部分代码:

    启用全局变量

    默认情况下编译器是没有全局变量声明的,但是为了跟C代码集成,有时候需要定义全局变量,可以在调用编译器时,通过增加 -enable-globals选项来启用

    1. v -enable-globals run main.v
    1. module main
    3. // 单个全局变量定义
    4. __global g1 int
    6. // 组定义全局变量,类似常量的定义
    7. __global (
    8.     g2 byte 
    9.     g3 byte 
    10. )
    12. fn main() {
    13.     g1 = 1
    14.     g2 = 2
    15.     g3 = 3
    16.     println(g1)
    17.     println(g2)
    18.     println(g3)
    19. }

    函数的[inline]注解

    对C函数进行简单的封装时,可以给函数添加inline注解,编译生成C代码时,这个函数就会变成C语言里的static inline函数

    内联函数有些类似于宏,内联函数的代码会被直接嵌入在它被调用的地方，调用几次就嵌入几次，没有使用call指令。这样省去了函数调用时的一些额外开销,不过调用次数多的话，会使可执行文件变大，这样会降低整个程序的运行速度

    像上面那个简单的封装,函数只有1行代码,嵌入到被调用的地方也还是1还代码,既能省去函数调用时的额外开销,提升性能,又不会使可执行文件变大

    1. [inline]
    2.     return C.sapp_width()
    3. }

    定义C结构体等价的V版本结构体,V版本结构体名称以C.做前缀

    这样就可以直接使用V版本的结构体来创建变量

    用V版本的结构体创建变量,编译生成的C代码中,就是用C版本结构体创建了变量

    C代码库中的结构体:

    定义等价的V版本结构体:字段数量一样,字段名称一样,字段类型一样

    如果字段类型是枚举的,也可以再定义等价的V版本枚举

    1. pub struct C.sapp_event {
    3.     frame_count u64
    4.     @type EventType //这个type字段有点特殊,因为是V的关键字,要用@开头才可以
    5.     key_code KeyCode //枚举类型
    6.     char_code u32
    7.     key_repeat bool
    8.     modifiers u32
    9.     mouse_button MouseButton //枚举类型,下面有MouseButton的V版本定义
    10.     mouse_x f32
    11.     mouse_y f32
    12.     scroll_x f32
    13.     scroll_y f32
    14.     num_touches int
    15.     touches [8]sapp_touchpoint //数组类型
    16.     window_width int
    17.     window_height int
    18.     framebuffer_width int
    19.     framebuffer_height int
    20. }

    枚举简单封装

    其实就是定义一个跟C版本枚举一样的枚举,枚举名和枚举值一样

    1. pub enum MouseButton {
    2.     invalid = -1
    3.     left = 0
    4.     right = 1
    5.     middle = 2
    6. }

    关于#flag标记

    这个#flag标记跟v编译器的-cflags选项的用法是一样的,用于传递额外的flag参数给C编译器

    关于C编译器的flag参数可以参考:

    1. 要在使用C宏之前先定义#flag

    2. -l 表示在库文件的搜索路径列表中添加指定的路径

      -I 表示在头文件的搜索路径中添加指定的路径

      -D 表示设置编译时变量

    3. 还可以在#flag后增加平台标识,针对不同的平台配置不同的flag,目前支持的平台有:linux,darwin,windows

    以下例子,提供参考:

    1. //#flag文档里面的:
    2. #flag linux -lsdl2
    3. #flag linux -Ivig
    4. #flag linux -DCIMGUI_DEFINE_ENUMS_AND_STRUCTS=1
    5. #flag linux -DIMGUI_DISABLE_OBSOLETE_FUNCTIONS=1
    6. #flag linux -DIMGUI_IMPL_API=
    1. //sokol包里面的:
    2. #flag -I @VROOT/thirdparty/sokol //@VROOT指向v编译器的根路径
    3. #flag -I @VROOT/thirdparty/sokol/util
    6. #flag darwin -fobjc-arc  //针对mac平台,提供额外的flag参数:-fobjc-arc
    7. #flag linux -lX11 -lGL    //针对linux平台,提供额外的flag参数
    10. #flag windows -lgdi32 //针对window平台,提供额外的flag参数:-l开头,表示链接gdi32
    13. // OPENGL
    14. #flag darwin -framework OpenGL -framework Cocoa -framework QuartzCore