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

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