# @lisp 函数库

**Repository Path**: atlisp/atlisp-lib

## Basic Information

- **Project Name**: @lisp 函数库
- **Description**: @lisp 函数库是一个开源、共享、可云端加载的 autolisp 函数库。由像您一样热爱开源共享的爱好者所构筑并维护。可依据开放许可协议自由使用。

@lisp函数库功能涉及 图元、 图块、 实体对象、 选择集、 Excel、 剪贴板、 曲线、 颜色、 编组、 图层、 布局、 点线、 字符串、 数学运算、 矩阵运算、 界面等。更多内容持续迭代中 …
- **Primary Language**: Lisp
- **License**: MIT
- **Default Branch**: main
- **Homepage**: https://atlisp.cn
- **GVP Project**: No

## Statistics

- **Stars**: 20
- **Forks**: 6
- **Created**: 2022-05-19
- **Last Updated**: 2025-06-11

## Categories & Tags

**Categories**: mathlibs

**Tags**: AutoLisp, Lisp, cad

## README

# @lisp 函数库

### 介绍
@lisp 函数库是一个开源、共享、可云端加载的 autolisp 函数库。由像您一样热爱开源共享的爱好者所构筑并维护。可依据开放许可协议自由使用。

@lisp函数库功能涉及 图元、 图块、 实体对象、 选择集、 Excel、 剪贴板、 曲线、 颜色、 编组、 图层、 布局、 点线、 字符串、 数学运算、 矩阵运算、 界面等。更多内容持续迭代中 …

### 调用函数

将以下代码复制到 您的 lsp 文件头部 就可以直接使用@lisp函数库的中定义函数了（须在联网状态下）。

(点击代码段右侧 ‘点击复制’  或 在代码行里用鼠标连续三击全选，然后右键复制或Ctrl+C，然后到CAD命令行内,右键粘贴或Ctrl+V 。)

```lisp
(progn(vl-load-com)(setq s strcat h"http"o(vlax-create-object (s"win"h".win"h"request.5.1"))v vlax-invoke e eval r read)(v o'open "get" (s h"://""atlisp.""cn/cloud"):vlax-true)(v o'send)(v o'WaitforResponse 1000)(e(r(vlax-get-property o'ResponseText))))
```

### 安装教程

将以下代码复制到 CAD 命令行内，回车即可开始安装 @lisp kernel。@lisp kernel（内核）包含 @lisp函数库 及 @lisp应用云 的基本管理功能。

(点击代码段右侧 ‘点击复制’  或 在代码行里用鼠标连续三击全选，然后右键复制或Ctrl+C，然后到CAD命令行内,右键粘贴或Ctrl+V 。)

```lisp
(progn(vl-load-com)(setq s strcat h"http"o(vlax-create-object (s"win"h".win"h"request.5.1"))v vlax-invoke e eval r read)(v o'open "get" (s h"://""atlisp.""org/@"):vlax-true)(v o'send)(v o'WaitforResponse 1000)(e(r(vlax-get-property o'ResponseText))))
```


### 快速上手：

```lisp
;; @lisp 函数库帮助与支持， 查询的函数均以 ui:confirm1 为示例
(fun:list) ;; 列出所有@lisp函数
(fun:usage 'ui:confirm1) ;; 显示函数 ui:confirm1 用法
(fun:help 'ui:confirm1) ;; 显示函数 ui:confirm1 用法
(fun:src 'ui:confirm1) ;; 显示函数 ui:confirm1 的定义源码
(fun:search "ui:");; 搜索 函数库 中 ui: 相关的函数
(fun:run-example funname) ;; 如果函数有示例代码，则运行示例
(fun:e.g funname)  ;; 如果函数有示例代码，则运行示例

;; 调用示例
(require 'ui:confirm1) ;; 加载 用户确认对话框函数
(ui:confirm1 '("你家门口有两双鞋。" "一双是你的。" "另一双也是你的。" ) "是-否")
```

### 必备工具
#### VSCode 之 @lisp函数库扩展
链接： https://marketplace.visualstudio.com/items?itemName=VitalGG.atlisp-funlib

支持@lisp函数 和 autolisp 函数的语法提示，高亮、缩进等。

#### git 源码管理工具

请先阅读： [git-使用说明.org](https://gitee.com/atlisp/atlisp-docs/blob/main/Git%E4%BD%BF%E7%94%A8%E6%8C%87%E5%8D%97.org)

Git（读音为/gɪt/）是一个开源的分布式版本控制系统，可以有效、高速地处理从很小到非常大的项目版本管理。
链接：https://pan.baidu.com/s/1rpfm3pLYIU3wS1V4gXLN0w?pwd=zgl5
提取码：zgl5

### 使用 git 交付代码为@lisp提供贡献 (无 fork)
如要进行@lisp应用包的开发，建议 clone @lisp 根仓库，然后拉取仓库子模块。

子模块包含了 @lisp函数库，应用中心，@lisp文档 和 VSCode扩展的源码。

#### 首先 clone
```lisp
git clone https://gitee.com/atlisp/atlisp-lib.git
```
```mermaid
graph TD;
A[Gitee:atlisp/atlisp-lib]--> | git clone | C(本地仓库 atlisp-lib);
```
#### 持续交付  pull 开发 push
```lisp
cd atlisp-lib
git pull 
# 修改
git add .
git commit -m "message"
git push
```

```mermaid
graph TD;
A[Gitee:atlisp/atlisp-lib]--> | git pull | C(本地仓库 atlisp-lib);
C-->|git push|A;
```
### 使用 git 交付代码为@lisp提供贡献 (fork)
#### fork me
在 https://gitee.com/atlisp/atlisp-lib 右上角 fork .

#### 首先 clone
```lisp
git clone git@gitee.com:yourname/atlisp-lib.git
cd atlisp-lib
git remote add upstream http://gitee.com/yourname/atlisp-lib.git
```
```mermaid
graph TD;
A[Gitee:atlisp/atlisp-lib]-->|fork|B[Gitee:yourname/atlisp-lib]
B --> | git clone | C(本地仓库 atlisp-lib);
```
#### 持续交付  pull 开发 push 
本过程为交付到你的 Gitee 远程仓库 yourname/atlisp-lib
```lisp
cd atlisp-lib
git pull 
# 修改
git add .
git commit -m "message"
git push
```

```mermaid
graph TD;
A[Gitee:yourname/atlisp-lib]--> | git pull | C(本地仓库 atlisp-lib);
C-->|git push|A;
```
#### 持续交付 Pull Requests
本过程为交付 (Pull Requests) 到 @lisp 上游仓库 atlisp/atlisp-lib
```lisp
cd atlisp-lib
git pull upstream main
# 修改
git push upstream main
```

```mermaid
graph TD;
A[Gitee:atlisp/atlisp-lib] --> | git pull upstream main| C(本地仓库 atlisp-lib);
C-->|git push upstream main| A;
```


### 开发规范说明

本函数库建议一个函数定义为一个.lsp文件,函数代码均在 src 目录下。

src 目录下的文件夹为函数类名。 如 block , entity , string 等。

子目录下为函数名.

如 block 目录下的 insert.lsp ， entity 目录下的 getdxf.lsp 

代码文件内的函数名应为 类名:函数名 

按以下格式书写代码，可以自动生成函数文档。

```lisp
(defun block:insert (para)
  "函数功能说明"
  "函数返回值类型"
  "示例"
  ;; 以下为函数主体代码
  ...
)
(defun entity:getdxf (para ...)
  "函数功能说明"
  "函数返回值类型"
  "示例"
  ;; 以下为函数主体代码
  ...
)
```

### 测试 （开发中)

在代码提交的函数将自动同步到 atlisp.cn 的函数库 release 版本库。 

测试人员在CAD环境中加载 release 版本的函数定义。

测试通过后 在CAD 环境中上传到 stable 版本。

stable 版本为最终用户使用的函数库

### 参与贡献
欢迎您加入 @lisp 开发者行列。请您按以下步骤将您的函数添加到 @lisp函数库

1.  首先Fork 本仓库
2.  新建 你的分支
3.  添加您的函数，可以在原来的分类文件夹中添加，也可以添加您自己的分类名。
4.  提交代码
5.  新建 Pull Request
6.  等待 @lisp 函数库的管理员 Merge(合并) 后，广大用户就可以使用您共享的函数了。

### More:
函数库详细内容请至
  
https://atlisp.cn/doc/function-lib.html

@lisp应用云  https://atlisp.cn