home *** CD-ROM | disk | FTP | other *** search
/ World of A1200 / World_Of_A1200.iso / programs / develop / calcprg / calc.doc < prev    next >
Text File  |  1995-02-27  |  9KB  |  277 lines
  1.                              Calc 37.302
  2.  
  3.                                   by
  4.                             Douglas Keller
  5.  
  6.                 Copyright 1993 Synthetic Technologies
  7.  
  8.                            February 28, 1993
  9.  
  10.  
  11. 0.  Introduction
  12. ----------------
  13.  
  14. Calc is a RPN programmers calculator with only integer support, it
  15. does not support floating point numbers.  It is unique in that it
  16. displays four bases at the same time, binary, octal, decimal, and
  17. hexadecimal.  It supports the basic integer arthritic like addition,
  18. subtraction, multiplication, division, and modulus.  It also supports
  19. all the basic logical arthritic like shift, and, or, xor, and not.
  20.  
  21. Calc requires AmigaDOS 2.0 and has been tested with Enforcer and
  22. Mungwall.
  23.  
  24.  
  25. 1.  Contents
  26. ------------
  27.  
  28. Calc      - Calc executable.
  29.  
  30. Calc.info - Icon for Calc.
  31.  
  32. Calc.doc  - Doc file for Calc.
  33.  
  34.  
  35. 2.  Command Line Options
  36. ------------------------
  37.  
  38. P=PUBSCREEN/K,F=FRONTSCREEN/S,FORCEFRONT/S:
  39.  
  40. P=PUBSCREEN/K   - Pubscreen lets you specify a public screen to open
  41.                   Calc on.
  42.  
  43. F=FRONTSCREEN/S - Frontscreen lets you open Calc on the front most
  44.                   screen, if it is a public screen.
  45.  
  46. FORCEFRONT/S    - Forcefront lets you open Calc on the front most
  47.                   screen even if the screen is NOT a public screen.
  48.                   This can be kind of nasty to the front
  49.                   screen that is why it is an option.
  50.  
  51.  
  52. 3.  Window Layout
  53. -----------------
  54.  
  55. Calc's window is made up of two parts, the Display Area and the
  56. Keyboard Area.
  57.  
  58. 3.1  Display Area
  59. -----------------
  60.  
  61. On the top of the window is the display area that looks like this:
  62.  
  63.     .----------------------------------------.
  64.     | bin  0000 0000 ... 0000 0000 | 3:    0 |
  65.     |------------------------------|---------|
  66.     | oct                        0 | 2:    0 |
  67.     |------------------------------|---------|
  68.     | dec·                       0 | 1:    0 |
  69.     |------------------------------|---------|
  70.     | hex  0000 0000     0000 0000 | 0:    0 |
  71.     `----------------------------------------'
  72.  
  73. There are four text areas labeled bin, oct, dec, and hex.  Each one
  74. displays the current number in the respective base, they can be
  75. selected with the mouse to select the base.  The current input base is
  76. shown in the highlighted text color and with a small box after the
  77. base name.  The current input base can also be changed from the menus.
  78.  
  79. To the right is the stack which is used like any standard RPN
  80. calculator.
  81.  
  82. 3.2  Keyboard Area
  83. ------------------
  84.  
  85. Below the display area are the keys which look like this:
  86.  
  87.     Drop  | &  « » / *
  88.     Clr   a b  7 8 9 -
  89.     Swap  c d  4 5 6 +
  90.     Undo  e f  1 2 3
  91.     ±  %  ^ ~  0   . E
  92.  
  93. Drop/<= - The drop gadget displays either drop or a <= (backarrow).
  94.           It is a backarrow while a number is being entered and it is
  95.           drop once enter has been pressed.  When it is a backarrow it
  96.           will delete the last entered digit.  When it is drop it will
  97.           drop the bottom level off the stack and bring each level
  98.           down one.  The keyboard equivalent of this gadget is the
  99.           backspace key.
  100.  
  101. Clr     - The clr gadget will clear the entire stack.  They keyboard
  102.           equivalent of this gadget is the spacebar.
  103.  
  104. Swap    - The swap gadget will swap the bottom two levels of the
  105.           stack, levels zero and one.  The keyboard equivalent of this
  106.           gadget is the 's' key.
  107.  
  108. Undo    - The undo gadget will undo the last operation.  Since it
  109.           undoes the last operation, if undo is pressed twice the
  110.           original stack will be restored.  The keyboard equivalent of
  111.           this gadget is the 'u' key.  This gadget is the same as the
  112.           undo menu item in the Edit menu.
  113.  
  114. ±       - The ± (plus/minus) gadget will toggle the current number
  115.           between the positive and negative state.  This gadget will be
  116.           disabled if Calc is in unsigned mode, see the Options menu
  117.           for changing between signed and unsigned mode of the
  118.           calculator.  The keyboard equivalent of this gadget is the
  119.           'p' key.
  120.  
  121. %       - The % gadget performs the modulus operation on the bottom
  122.           two levels of the stack.  The keyboard equivalent of this
  123.           gadget is the '%' key.
  124.  
  125. |       - The | gadget performs a logical OR between the bottom two
  126.           levels of the stack.  The keyboard equivalent of this gadget
  127.           is the '|' key.
  128.  
  129. &       - The & gadget performs a logical AND between the bottom two
  130.           levels of the stack.  The keyboard equivalent of this gadget
  131.           is the '&' key.
  132.  
  133. ^       - The ^ gadget performs a logical exclusive OR between the
  134.           bottom two levels of the stack.  The keyboard equivalent of
  135.           this gadget is the '^' key.
  136.  
  137. ~       - The ~ gadget performs a logical complement of the current
  138.           number.  The keyboard equivalent of this gadget is the '~'
  139.           key.
  140.  
  141. «       - The « gadget performs a logical shift left of the current
  142.           number.  The keyboard equivalent of this gadget is the '('
  143.           key.
  144.  
  145. »       - The » gadget performs a logical shift right of the current
  146.           number.  The keyboard equivalent of this gadget is the ')'
  147.           key.
  148.  
  149. /,*,-,+ - These gadget perform integer arithmetic on the bottom two
  150.           levels of the stack.  There keyboard equivalents are the same
  151.           as there symbol.
  152.  
  153.           If there an overflow these operations will appear to do
  154.           nothing.  For example if the current mode is unsigned byte
  155.           where the valid range of numbers are 0 to 255, and 250 + 6 is
  156.           entered it will do nothing.  Maybe this should be changed to
  157.           do the operation all the time and somehow show that overflow
  158.           has occurred.
  159.  
  160. E       - The E gadget is the standard enter key found on RPN
  161.           calculators.  The keyboard equivalents of this gadget are
  162.           the Enter and the Return keys.
  163.  
  164. .       - The . gadget cycles through the input bases; binary, octal,
  165.           decimal, and hexadecimal.  The input base can also be
  166.           changed by clicking on the display area or using the Input
  167.           Base Item in the Options menu.  The keyboard equivalent of
  168.           this gadget is the '.' key.
  169.  
  170. 0,1,2,  - These gadgets are used to enter digits for the current
  171. 3,4,5,    number.  Some of these gadgets might be disabled depending
  172. 6,7,8,    on the current input base.  For example in binary mode only
  173. 9,a,b,    the 0 and 1 gadgets will be enabled.
  174. c,d,e,
  175. f
  176.  
  177. 3.3  Other keys
  178. ---------------
  179.  
  180. The arrow keys can be used to move Calc's window around, they will
  181. move the window twenty pixels in appropriate direction.
  182.  
  183. If shift is held down when an arrow is pressed the window is moved to
  184. edge of the screen.
  185.  
  186. The escape key will cause Calc to quit.  When Calc quits, it saves the
  187. stack and the current state of the calculator to a file called
  188. 'env:calc'.  When Calc is run again it will read 'env:calc' so it will
  189. have the same stack and be in the same state as when it exited.  This
  190. is the same as the Quit menu item.
  191.  
  192.  
  193. 4.  Menus
  194. ---------
  195.  
  196. Calc has the following menus:
  197.  
  198.     Project  Edit    Options
  199.       About    Cut     Input Base
  200.       Quit     Copy      Binary
  201.                Paste     Octal
  202.                Undo      Decimal
  203.                          Hexadecimal
  204.                        Word Size
  205.                          Byte
  206.                          Word
  207.                          Long
  208.                        Sign
  209.                          Signed
  210.                          Unsigned
  211. 4.1  Project Menu
  212. -----------------
  213.  
  214. About A-? - Shows a little about Calc.
  215.  
  216. Quit  A-Q - Quits Calc, the escape key can also be used to quit Calc.
  217.  
  218. 4.2  Edit Menu
  219. --------------
  220.  
  221. Cut   A-X - Cut will cut the current number to the clipboard in the
  222.             format of the current base.
  223.  
  224. Copy  A-C - Copy will copy the current number to the clipboard in the
  225.             format of the current base.
  226.  
  227. Paste A-V - Paste will paste from the clipboard to the current number
  228.  
  229. Undo  A-Z - Undo will undo the last operation.  This is the same as
  230.             the undo gadget.
  231.  
  232. 4.3  Options Menu
  233. -----------------
  234.  
  235. Input Base - This is used to select the input base.  The current input
  236.              base is shown in the highlighted text color and with a
  237.              small box after the base name.  The current input base
  238.              can be changed by selecting the input base with the
  239.              mouse.  The valid input bases are:
  240.  
  241.              Binary      A-2 - base 2
  242.              Octal       A-O - base 8
  243.              Decimal     A-D - base 10
  244.              Hexadecimal A-H - base 16
  245.  
  246. Word Size - This is used to select the word size.  The word size can
  247.             be byte, word, and longword.
  248.  
  249.             Byte     A-B - 8 bit
  250.             Word     A-W - 16 bit
  251.             Longword A-L - 32 bit
  252.  
  253. Sign - This is used to select between signed and unsigned mode.
  254.  
  255.        Signed   A-S
  256.        Unsigned A-U
  257.  
  258.  
  259. 5.  Legal junk
  260. --------------
  261.  
  262. Permission is granted to distribute this program and its documentation
  263. for non-commercial purposes as long as the copyright notices are not
  264. removed.  This program may not be distributed for a profit without
  265. permission from Doug Keller.  Fred Fish has permission to distribute
  266. this program as part of the Fred Fish library.
  267.  
  268.  
  269. 7.  Bugs and Info
  270. -----------------
  271.  
  272. If you would like to get in touch with me I can be reached on the
  273. following:
  274.  
  275.             Bix : dkeller
  276.         Internet: dkeller@vnet.ibm.com
  277.