extra/cpu/8080/emulator/emulator-docs.factor

   1 ! Copyright (C) 2007 Chris Double.\r
   2 ! See http://factorcode.org/license.txt for BSD license.\r
   3 USING: help.markup help.syntax sequences strings ;\r
   4 IN: cpu.8080.emulator\r
   5 \r
   6 HELP: load-rom \r
   7 { $values { "filename" string } { "cpu" cpu } }\r
   8 { $description \r
   9 "Read the ROM file into the cpu's memory starting at address 0000. " \r
  10 "The filename is relative to the path stored in the " { $link rom-root }\r
  11 " variable. An exception is thrown if this variable is not set."\r
  12 }\r
  13 { $see-also load-rom* } ;\r
  14 \r
  15 HELP: load-rom*\r
  16 { $values { "seq" sequence } { "cpu" cpu } }\r
  17 { $description \r
  18 "Loads one or more ROM files into the cpu's memory. Each file is "\r
  19 "loaded at a particular starting address. 'seq' is a sequence of "\r
  20 "2 element arrays. The first element is the address and the second "\r
  21 "element is the file to load at that address." $nl\r
  22 "The filenames are relative to the path stored in the " { $link rom-root }\r
  23 " variable. An exception is thrown if this variable is not set."\r
  24 }\r
  25 { $examples\r
  26   { $code "{ { 0x0000 \"invaders.rom\" } } <cpu> load-rom*" }\r
  27 }\r
  28 { $see-also load-rom } ;\r
  29 \r
  30 HELP: rom-root\r
  31 { $description \r
  32 "Holds the path where the ROM files are stored. Used for expanding "\r
  33 "the relative filenames passed to " { $link load-rom } " and "\r
  34 { $link load-rom* } "."\r
  35 }\r
  36 { $see-also load-rom load-rom* } ;\r