Using OSLib
Use this skill when code depends on the OSLib typed SWI interface library.
OSLib in this environment is exported under /riscos-resources/Export/Lib/OSLib.
This skill is about the OSLib API surface itself: headers, wrapper naming,
public types, and which function families are provided.
Default workflow
- Read
references/overview.md for the library layout and where to look.
- Read
references/naming.md when you need to map between PRM SWI names and
C wrapper names.
- Read only the area reference you need:
references/core.md,
references/computer.md, references/user.md, or
references/toolbox.md.
- For a specific call you are about to use, confirm the exact signature in
the matching exported header under
/riscos-resources/Export/Lib/OSLib/.../h.
- If assembler or DefMod naming matters, inspect the matching
hdr/ file for
the same component name.
What the reference files contain
The area reference files are source-derived inventories from the exported OSLib
headers. For each public header they list:
- the public typedef aliases declared there
- the exported wrapper functions declared there
This is intended to answer "what does OSLib provide?" without forcing every
agent to trawl the whole tree.
Scope notes
Core covers the fundamental OS-facing interfaces such as os, osbyte,
osword, osspriteop, colourtrans, messagetrans, territory, and
related service and event wrappers.Computer covers filing systems, osfile, osfind, osgbpb,
osfscontrol, sockets, serial, resourcefs, and machine-level subsystems.User covers desktop-facing APIs such as wimp, font, draw,
drawfile, jpeg, pdriver, and task/window helpers.Toolbox covers the Toolbox core plus object and gadget modules such as
window, menu, iconbar, saveas, writablefield, and friends.
Related environment details
The exported object variants currently present under
/riscos-resources/Export/Lib/OSLib/o are:
OSLibOSLib-32OSLib-64OSLibzmOSLibzm-32OSLibzm-64
The build-environment documentation also identifies ${OSLIB} as the OSLib
typed SWI interface library, and the 64-bit toolchain documentation shows
-loslib with -I$RO64EXPORT/Lib/OSLib as the direct compiler/linker form.
Limits
This skill inventories OSLib's exported headers. It does not replace the PRMs
for behavioural detail, and it does not describe RISC_OSLib, which is a
different library with its own conventions and helper layers.
1---2name: using-liboslib3description: Use when working with the OSLib typed SWI interface library in the RISC OS build environment, especially to identify which headers, functions, and public types exist for Core, Computer, User, or Toolbox APIs and to translate between SWI names and OSLib wrapper names.4license: MIT5---6# Using OSLib78Use this skill when code depends on the OSLib typed SWI interface library.910OSLib in this environment is exported under `/riscos-resources/Export/Lib/OSLib`.11This skill is about the OSLib API surface itself: headers, wrapper naming,12public types, and which function families are provided.1314## Default workflow15161. Read `references/overview.md` for the library layout and where to look.172. Read `references/naming.md` when you need to map between PRM SWI names and18 C wrapper names.193. Read only the area reference you need: `references/core.md`,20 `references/computer.md`, `references/user.md`, or21 `references/toolbox.md`.224. For a specific call you are about to use, confirm the exact signature in23 the matching exported header under `/riscos-resources/Export/Lib/OSLib/.../h`.245. If assembler or DefMod naming matters, inspect the matching `hdr/` file for25 the same component name.2627## What the reference files contain2829The area reference files are source-derived inventories from the exported OSLib30headers. For each public header they list:3132* the public typedef aliases declared there33* the exported wrapper functions declared there3435This is intended to answer "what does OSLib provide?" without forcing every36agent to trawl the whole tree.3738## Scope notes3940* `Core` covers the fundamental OS-facing interfaces such as `os`, `osbyte`,41 `osword`, `osspriteop`, `colourtrans`, `messagetrans`, `territory`, and42 related service and event wrappers.43* `Computer` covers filing systems, `osfile`, `osfind`, `osgbpb`,44 `osfscontrol`, sockets, serial, resourcefs, and machine-level subsystems.45* `User` covers desktop-facing APIs such as `wimp`, `font`, `draw`,46 `drawfile`, `jpeg`, `pdriver`, and task/window helpers.47* `Toolbox` covers the Toolbox core plus object and gadget modules such as48 `window`, `menu`, `iconbar`, `saveas`, `writablefield`, and friends.4950## Related environment details5152The exported object variants currently present under53`/riscos-resources/Export/Lib/OSLib/o` are:5455* `OSLib`56* `OSLib-32`57* `OSLib-64`58* `OSLibzm`59* `OSLibzm-32`60* `OSLibzm-64`6162The build-environment documentation also identifies `${OSLIB}` as the OSLib63typed SWI interface library, and the 64-bit toolchain documentation shows64`-loslib` with `-I$RO64EXPORT/Lib/OSLib` as the direct compiler/linker form.6566## Limits6768This skill inventories OSLib's exported headers. It does not replace the PRMs69for behavioural detail, and it does not describe `RISC_OSLib`, which is a70different library with its own conventions and helper layers.
gerph