home *** CD-ROM | disk | FTP | other *** search
/ Frozen Fish 1: Amiga / FrozenFish-Apr94.iso / bbs / alib / d5xx / d590 / mice.lha / MICE / Mice_Doc.Eng < prev    next >
Text File  |  1992-01-05  |  11KB  |  421 lines
  1.  
  2.  
  3.  
  4.  
  5.         ****************************************
  6.         ||                      ||
  7.         ||         MICE              ||
  8.         ||      by Pierre-Louis MANGEARD      ||
  9.         ||      © 1991, EquiLog S.P.          ||
  10.         ||         V1.2              ||
  11.         ||                      ||
  12.         ****************************************
  13.  
  14.  
  15.  
  16.  
  17.  
  18. MICE  means  :   My  Image  Code  Editor.   MICE generates source code from
  19. standard IFF pictures, just as brushes from Deluxe Paint.
  20.  
  21. MICE works with the req.library so take care that it features in your libs:
  22. directory.
  23.  
  24. Launch MICE from the CLI or from it's WorkBench icon.
  25.  
  26. MICE  generates  a  structured  source  code  for  DEVPAC 2 in assembly and
  27. LATTICE/SAS in C language.  For others, make the modifications yourself.
  28.  
  29.  
  30.  
  31. INSTRUCTIONS FOR USE :
  32. --------------------
  33.  
  34. To  understand  MICE  functions well please follow the instructions step by
  35. step.
  36.  
  37. Before  all  manipulations, you must run your favourite editor, but only if
  38. it has a file requester.
  39.  
  40. To  proceed with this  tests, you will find with this doc a directory named
  41. 'Brushes'  that  contains  three  IFF  brushes  names  'Brol',  'Gazm', and
  42. 'Rototo'.
  43.  
  44. For  each  test,  launch  MICE  from  its  icon  or from shell and open the
  45. 'Brushes' directory in the file requester.
  46.  
  47.  
  48.  
  49. I.- Simple-selecting :
  50.     ----------------
  51.  
  52. 1 -> 
  53. Double-click  on  file  'Rototo'.   The filerequester disappears.  A window
  54. opens  :   it  contains  a  few  boolean  gadgets and a string gadget named
  55. 'SOURCE CODE FILENAME'.
  56.  
  57. -  4 gadgets are pre-selected ('ASSEMBLY', 'IMAGE STRUCT', 'IMAGE DATA' and
  58. 'COMMENTS')
  59.  
  60. - one gadget is ghosted ('MULTIFILES')
  61.  
  62. - the string gadget contains the mention 'RAM:Mice.Code'
  63.  
  64.  
  65. 2 ->
  66. Now click on the 'DO & QUIT' gadget.  The window closes.
  67.  
  68. 3 ->
  69. From  your  editor,  load  from RAM:  the file that has been newly created,
  70. named 'Mice.Code'.
  71.  
  72.  
  73. This  file  contains  the  Image structure and the image datas of the brush
  74. 'Rototo',  coded  in  assembly,  with  comments.   This  code is immediatly
  75. available for GenIm2.
  76.  
  77. Note  that  the  code  retrieves  the filename of the brush, and the labels
  78. 'ImageRototo' and 'ImageDataRototo' are generated.
  79.  
  80. So, for the maximum efficiency of MICE, you must follow some rules when you
  81. name your brushes.  Please see the chapter 'LABELS AND FILENAMES'.
  82.  
  83.  
  84.  
  85. II.- Option 'COMMENTS' :
  86.      -----------------
  87.  
  88. In  the  previous test, the 'COMMENTS' option was selected by default.  Now
  89. let's see what that means exactly.
  90.  
  91.  
  92. 1 ->
  93. Double-click on file 'Rototo'.
  94.  
  95. 2 ->
  96. Click on the 'COMMENTS' gadget.  It is now deselected.
  97.  
  98. 3 ->
  99. In the string gadget, rename the output file, for example 'RAM:Mice1.code'.
  100.  
  101. 4 ->
  102. Click on the 'DO & QUIT' gadget.
  103.  
  104. 5 ->
  105. Load  this new file in a new window of your editor, so that you can compare
  106. it with the previous code.
  107.  
  108.  
  109. This  file  contains  the  Image structure and the image datas of the brush
  110. 'Rototo', coded in assembly, now WITHOUT comments.
  111.  
  112.  
  113.  
  114. III.- Option 'PALETTE' :
  115.       ----------------
  116.  
  117. This option adds the code of the palette.
  118.  
  119. To  see  the  result,  repeat  the  same  manipulations than I and II, with
  120. 'PALETTE' option.
  121.  
  122.  
  123.  
  124. IV.- Option 'C' :
  125.      ----------
  126.  
  127. This option makes MICE generate C code instead of assembly code.
  128.       
  129. To  see  the result, repeat the same manipulations than I, II, and III, but
  130. with the 'C' option.
  131.  
  132.  
  133.  
  134. V.- Multi-Selecting files without the 'MULTIFILES' option :
  135.     -----------------------------------------------------
  136.  
  137. V.1.- 'ASSEMBLY' option :
  138.  
  139.  
  140. 1 ->
  141. Press  the  SHIFT  key  and  click  successively on the three files 'Brol',
  142. 'Gazm', and 'Rototo'.
  143.  
  144. 2 ->
  145. Click on the 'OK' gadget of the filerequester.
  146.  
  147. 3 ->
  148. Select the 'PALETTE' option.
  149.  
  150. 4 ->
  151. Click on the 'DO & QUIT' gadget.
  152.  
  153. 5 ->
  154. Load 'RAM:Mice.Code' in your editor.
  155.  
  156.  
  157. The code you have obtained is made of three sections :
  158.  
  159. - SECTION Palette,DATA        with the palette
  160. - SECTION ImageStructure,DATA    with all the Image structures
  161. - SECTION ImageData,DATA_C    with all the Image datas
  162.  
  163. This  setting  allows  you  to  handle  great blocks of datas with only one
  164. cut-paste.
  165.  
  166. The  palette  features only once at the beginning of the file.  That is the
  167. palette  of  the  first  selected file, 'Brol'.  If there was no palette in
  168. 'Brol',  or if its palette was corrupted, there would be no palette section
  169. in Mice.Code.
  170.  
  171.  
  172. V.2.- 'C' option :
  173.  
  174.  
  175. The C code is differently structured than assembly code.
  176.  
  177. Repeat the same manipulations than in part V.1., but with the 'C' option.
  178.  
  179. The  palette features in first place, and the image datas are not separated
  180. of the Image structures.
  181.  
  182. Since  the  LATTICE/SAS  allows  the  use  of  the keyword 'chip', and that
  183. guarantees  that data within {} will be loaded into CHIP memory, then it is
  184. not necessary to separate the different types of datas.
  185.  
  186.  
  187.  
  188. VI.- Multi-Selecting with the 'MULTIFILES' option and without 'PALETTE' :
  189.      ------------------------------------------------------------------
  190.  
  191. 1 ->
  192. Press  the  SHIFT  key  and  click  successively on the three files 'Brol',
  193. 'Gazm', and 'Rototo'.
  194.  
  195. 2 ->
  196. Click on the 'OK' gadget of the filerequester.
  197.  
  198. 3 ->
  199. Select  the  'MULTIFILES'  option.   Note  that  the 'SOURCE CODE FILENAME'
  200. gadget now indicates 'RAM:' instead of 'RAM:Mice.Code'.
  201.  
  202. 4 ->
  203. Click on the 'DO & QUIT' gadget.
  204.  
  205. 5 ->
  206. On  the  filerequester of your editor, you can now discover three new files
  207. in  RAM:,  named 'Brol.Code', 'Gazm.Code', and 'Rototo.Code'.  Each of them
  208. contains the image structure and the image data of its parent brush.
  209.  
  210.  
  211.  
  212. VI.- Multi-Selecting with the 'MULTIFILES' option and with 'PALETTE' :
  213.      ---------------------------------------------------------------
  214.  
  215. 1 ->
  216. Press  the  SHIFT  key  and  click  successively on the three files 'Brol',
  217. 'Gazm', and 'Rototo'.
  218.  
  219. 2 ->
  220. Click on the 'OK' gadget of the filerequester.
  221.  
  222. 3 ->
  223. Select the 'PALETTE' option.
  224.  
  225. 4 ->
  226. Select the 'MULTIFILES' option.
  227.  
  228. 5 ->
  229. Click on the 'DO & QUIT' gadget.
  230.  
  231. 6 ->
  232. The  window  closes  and  a  requester  opens  with the following message :
  233. 'Repeat palette in each file ?'.  You may answer 'Yes' or 'No' :
  234.  
  235.  
  236. VII.1.  Answer 'Yes' to the requester :
  237.  
  238.  
  239. Load  successively  the  three files in RAM:  'Brol.Code', 'Gazm.Code', and
  240. 'Rototo.Code'.   Each of them contains the palette, the image structure and
  241. the  image  data  of  its parent brush.  But this time, the palette of each
  242. file    is    named    respectively    'PaletteBrol',   'PaletteGazm'   and
  243. 'PaletteRototo'.
  244.  
  245.  
  246. VII.2.  Answer 'No' to the requester :
  247.  
  248.  
  249. On the filerequester of your editor, you discover a new file in RAM:, named
  250. 'Palette.Code',  that  contains  the  palette.   However,  the three others
  251. files,  'PaletteBrol',  'PaletteGazm'  and  'PaletteRototo', do not anymore
  252. contain palette.
  253.  
  254.  
  255.  
  256. VIII.- Multi-Selecting files with only 'PALETTE' option :
  257.        ------------------------------------------------
  258.  
  259. In  most cases, when you want to code IFF brushes, they are parts of a same
  260. screen,  and  have  the  same palette.  That is why MICE generates only one
  261. palette, except in the case described in VII.1.
  262.  
  263. But  if you select ONLY the 'PALETTE' option, MICE will understand that you
  264. need the palette of each selected brush.
  265.  
  266. So  MICE will generate either a file with the three palettes 'PaletteBrol',
  267. 'PaletteGazm'  and  'PaletteRototo',  or,  if  you have chosen 'MULTIFILES'
  268. option,  three  files  'Brol.Code',  'Gazm.Code',  and  'Rototo.Code'  that
  269. contain respectively the palette of the parent brush.
  270.  
  271.  
  272.  
  273. IX.- 'SHOW IFF' :
  274.      ----------
  275.  
  276. IX.1.- Simple-Selecting :
  277.  
  278.  
  279. 1 ->
  280. Double-click on file 'Rototo'.
  281.  
  282. 2 ->
  283. Click on the gadget 'SHOW IFF'.
  284.  
  285. 3 ->
  286. A screen opens that shows you the brush 'Rototo'.
  287.  
  288. 4 ->
  289. Click  on  the left mousebutton.  The screen closes and you are back to the
  290. window.
  291.  
  292.  
  293. IX.2.- Multi-Selecting :
  294.  
  295.  
  296. 1 ->
  297. Press  the  SHIFT  key  and  click  successively on the three files 'Brol',
  298. 'Gazm', and 'Rototo'.
  299.  
  300. 2 ->
  301. Click on the 'OK' gadget of the filerequester.
  302.  
  303. 3 ->
  304. Click on the gadget 'SHOW IFF'.
  305.  
  306. 4 ->
  307. A screen opens that shows you the brush 'Brol'.
  308.  
  309. 5 ->
  310. Click  on  the  left mousebutton.  The screen closes and a new screen opens
  311. with the brush 'Gazm'.
  312.  
  313. 6 ->
  314. Click  on  the  left mousebutton.  The screen closes and a new screen opens
  315. with the brush 'Rototo'.
  316.  
  317. 7 ->
  318. Click  on  the left mousebutton.  The screen closes and you are back to the
  319. window.
  320.  
  321.  
  322.  
  323. X.- Options 'DO', 'DO & QUIT', 'CANCEL', 'QUIT' :
  324.     -------------------------------------------
  325.  
  326. The  'DO  &  QUIT' option allows you to code your image(s) and to quit MICE
  327. immediatly.
  328.  
  329. The  'QUIT'  option  allows you to code your image(s) and to go back to the
  330. filerequester for a new selection.
  331.  
  332. The  'CANCEL' option allows you to go back to the filerequester without any
  333. effect.
  334.  
  335. The 'QUIT' option allows you to quit MICE without any effect.
  336.  
  337.  
  338.  
  339. LABELS AND FILENAMES :
  340.     --------------------
  341.  
  342. MICE  retrieves  the  filename of your brush to generate its labels.  It is
  343. very  handy because you can create your label at the very beginning of your
  344. program, whilst you are drawing your bobs, images, gadgets, etc.
  345.  
  346. MICE  converts  the first letter of the filename in upper case if it is not
  347. yet.
  348.  
  349. For  example,  from  a  brush named 'rototo', MICE will generate the labels
  350. 'ImageRototo', 'ImageDataRototo' and, eventually, 'PaletteRototo'.
  351.  
  352. Since the filename becomes label, it must follow some rules :
  353.  
  354. - filename must begin by ASCII a-z, A-Z, or _
  355.  
  356. - filename must not contain other character than a-z, A-Z, 0-9 or _
  357.  
  358. - then, filename must not contain either space or accentuated characters.
  359.  
  360.  
  361. Examples of valid filenames :
  362.  
  363.     Rototo
  364.     veRGlUtoMItrOPhLerCABle
  365.     Ramb0
  366.     R2D2
  367.     Louis_XIV
  368.     _fna
  369.     __vlu
  370.  
  371. Examples of non-valid filenames :
  372.  
  373.     Starsky&Hutch
  374.     2001_A_Space_Odyssey
  375.     &%$?#(>*
  376.     _make room !
  377.     yékéké
  378.     etc...
  379.  
  380.  
  381. - MICE refuses a file if the first letter of the name is not available.
  382.  
  383. - MICE  accepts filenames that contains illegal characters  :  it keeps all
  384. the available part and ignore all the following.  Here are some examples of
  385. what that means :
  386.  
  387.     Starsky&Hutch    gives the label    ImageStarsky
  388.     brush.1           "      "    ImageBrush
  389.     brush.2           "      "    ImageBrush
  390.     brush(!&?<>)       "      "    ImageBrush
  391.     _make room !       "      "    Image_make
  392.     etc...           "      "    ImageEtc
  393.  
  394.  
  395. So  be  sure  that  the  first significant characters of your filenames are
  396. different for each file.
  397.  
  398. In  these examples, the two filenames 'brush.1' and 'brush.2' give the same
  399. label.   That would involve an error message at the assembly or compilation
  400. time.
  401.  
  402. If  you  have  chosen  the  'MULTIFILES' option, only one file will appear,
  403. named  'Brush.Code'.  It contains the source code of the last file that has
  404. been  treated,  because  the two generated files had the same filename, and
  405. the last saved has crashed the previous.
  406.  
  407.  
  408.  
  409.  
  410. MICE is an EquiLog product.
  411.  
  412. Please write to :
  413.  
  414.             EquiLog S.P.
  415.             c/o Pierre-Louis MANGEARD
  416.             15, rue des Cailles
  417.             Plateau Caillou
  418.             97460 SAINT PAUL
  419.             Ile de la Réunion
  420.  
  421.