pcjs/modules/pcjs/lib

PCjs Sources

Structure

All the code for PCjs is contained in the following JavaScript files, which roughly divide the functionality into major PC components, aka "devices". However, not every file implements a device, and "component" is an overloaded term, since Component is also the name of the shared base class used for most PCjs devices (see component.js). So it's best to refer to these files generically as "modules", and more specifically as "device modules" whenever they implement a specific device (or set of devices, in the case of Chipset).

Examples of non-device modules include UI modules like panel.js and debugger.js, and sub-modules like x86opxx.js, x86mods.js and x86help.js that separate the CPU functionality of x86.js into more manageable pieces.

These modules should always be loaded or compiled in the order listed by the pcJSFiles property in package.json, which includes all the necessary shared modules as well. At the time of this writing, the order is:

• shared/defines.js
• shared/diskapi.js
• shared/dumpapi.js
• shared/reportapi.js
• shared/userapi.js
• shared/strlib.js
• shared/usrlib.js
• shared/weblib.js
• shared/component.js
• pcjs/defines.js
• pcjs/panel.js
• pcjs/bus.js
• pcjs/mem.js
• pcjs/cpu.js
• pcjs/x86.js
• pcjs/x86seg.js
• pcjs/x86cpu.js
• pcjs/x86grps.js
• pcjs/x86help.js
• pcjs/x86mods.js
• pcjs/x86op0f.js
• pcjs/x86opxx.js
• pcjs/chipset.js
• pcjs/rom.js
• pcjs/ram.js
• pcjs/keyboard.js
• pcjs/video.js
• pcjs/serial.js
• pcjs/mouse.js
• pcjs/disk.js
• pcjs/fdc.js
• pcjs/hdc.js
• pcjs/debugger.js
• pcjs/state.js
• pcjs/computer.js
• shared/embed.js

Some of the modules can be reordered or even omitted (eg, debugger.js or embed.js), but you should observe the following:

• component.js must be listed before any module that extends Component
• panel.js should be loaded early to initialize the Control Panel (if any) as soon as possible
• computer.js should be the last device module, as it supervises and notifies all the other device modules

To minimize ordering requirements, the init() handlers and constructors of all modules should avoid referencing other modules. Device modules should define an initBus() notification handler, which the Computer will call after it has created/initialized the Bus object.