mirror of
https://github.com/fluffos/fluffos
synced 2026-08-12 18:26:06 -04:00
c914f03d66
* docs: add local full-text search and a contributor README Add @easyops-cn/docusaurus-search-local to the Docusaurus site so the docs get an offline search bar (index built at build time, no external service). English and zh-CN pages are both indexed, and matched terms are highlighted on the target page. Add docs/README.md describing the Docusaurus setup, local dev/build commands, search behavior, directory layout, and gotchas; exclude it from the published site alongside CLAUDE.md. Point the root README's docs/ entry at it. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01TSzcESzU9947zkGzQ6SMmE * docs: remove dead framework leftovers, fix index generation, complete the nav Delete the VitePress (.vitepress/) and Jekyll (_layouts/, css/) leftovers, the one-shot migration scripts (fix_md_header.py, fix_seealso.py), and the stale keywords.json snapshot; prune the matching .gitignore entries and docusaurus exclude patterns. Rewrite gen_index.py for Docusaurus: it emitted dead .html links and legacy 'layout: doc' frontmatter, choked on non-markdown entries, and dropped nested categories — regenerating an index would have broken it. It now emits the extension-less links the site actually uses, links nested category indexes (restoring apply/* on the zh-CN index), and refuses to run on the docs root. Fix update_index.sh's copy-paste titles (zh-CN efun/build were titled 'APPLY'), stop it clobbering the hand-written lpc/index.md, and cover cli/. Regenerated indexes pick up the missing driver/ffi-plan entry. add_missing_efuns.py now takes the keywords.json path as an argument instead of requiring a stale copy. Move CNAME and the Google site-verification file into static/ so they actually reach the published build output. Complete the sidebar: link the CLI category to cli/index and add the missing portbind/symbol/generate_keywords pages, and expose the previously orphaned stdlib section under Reference. Promote onBrokenLinks to 'throw' now the build is warning-free, and drop the empty Demo section from the landing page. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01TSzcESzU9947zkGzQ6SMmE * docs: strip legacy 'layout: doc' frontmatter from all pages Mechanical sweep removing the Jekyll-era 'layout: doc' line from every doc page's frontmatter (Docusaurus ignores it), and the matching line from the templates in docs/CLAUDE.md so new pages don't reintroduce it. No content changes. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01TSzcESzU9947zkGzQ6SMmE --------- Co-authored-by: Claude <noreply@anthropic.com>
55 lines
2.3 KiB
Markdown
55 lines
2.3 KiB
Markdown
---
|
|
title: general / adding_efuns
|
|
---
|
|
# adding_efuns
|
|
|
|
This document explains how to add efunctions to FluffOS driver. Here are the
|
|
steps:
|
|
|
|
1. Creating a directory under `src/packages/` with name `mypkg`.
|
|
|
|
2. inside `src/packages/mypkg` directory, create LPC function prototype file called `mypkg.spec`.
|
|
|
|
For example, the prototype for the cat() efun is as follows:
|
|
|
|
`int cat(string, void|int, void|int);`
|
|
|
|
The second and third arguments of `cat` can either be `void` or `int`. Here
|
|
'void' means optional. Thus `cat("xyz")` is allowed as is `cat("xyz",5,8);`
|
|
The return type of `cat()` is int.
|
|
|
|
If a function is to allow a variable number of arguments (vararg), you can
|
|
declare with trailing elipses:
|
|
|
|
`void call_out(string, int, ...);`
|
|
|
|
call_out() does not return a value.
|
|
|
|
3. Create a file `mypkg.cc` and create an `CMakeLists.txt` to compile it, add an library target called `PACKAGE_MYPKG`.
|
|
|
|
4. In your `mypkg.cc`, start by including the pkg API header,
|
|
|
|
`#include "base/package_api.h"`
|
|
|
|
Then add a function of the form `f_efunction_name() {}`
|
|
|
|
For examples of how to structure the f_efunction_name function, look at the other efun already defined in
|
|
the driver.
|
|
|
|
In addition, you should read the file ./doc/driver/stackmachine. This file is fairly old but is still
|
|
useful toward understanding the general structure of the driver stack machine.
|
|
|
|
The main points to know are that the arguments passed to an efunction are stored on a stack of svalues named `sp`.
|
|
For example, if the efunction is passed three arguments, then the first argument will be at `(sp - 2)`, the
|
|
second at `(sp - 1)`, and the third at sp. If a function allows a variable number of arguments, then the
|
|
num_arg parameter of the efun will be set to indicate the number of arguments actually passed (on the sp stack).
|
|
|
|
Each efunction is responsible for leaving a single svalue on the sp stack at the time the efunction exits(even if
|
|
the efunction is defined to return void).
|
|
|
|
The usual strategy is to use the stack values that you need `(sp - x)`, `pop_n_elems(num_args)` and then push a
|
|
result onto the stack.
|
|
|
|
Note, if an efunction takes a single argument and is defined to return void, then you needn't pop anything from
|
|
the stack or push anything on (the single argument can serve as the return value).
|
|
|