home *** CD-ROM | disk | FTP | other *** search
/ Club Amiga de Montreal - CAM / CAM_CD_1.iso / files / 493.lha / SmallIFFParseLibrary / ReadMe < prev    next >
Encoding:
Text File  |  1991-04-06  |  3.9 KB  |  98 lines
  1.               The Small IFF Parser - By Michael Jansson
  2.  
  3.  
  4. WHAT IS IT?
  5.  
  6. This archive contains files that when compiled will produce a standard amiga
  7. library that is an exact sub-set of the iffparse.library. 
  8.  
  9. The library is an EXACT sub-set in the sense that you can rename it to be
  10. iffparse.library and put it in your LIBS:  directory and then let programs
  11. that normally requires the true iffparse.library use this imposture ;-).
  12.  
  13. It is an exact SUB-SET because some of the function does only exist as dummy
  14. functions that always fails (noop:s) and some of the function only supports
  15. some of the functionality of the real thing.  The big difference is that
  16. only DOS-files and the Clipboard can be used as input/output and that the
  17. parser can only be used in the raw-step mode (No StopOnExit, StopChunk
  18. etc).  Look in the code for more details.
  19.  
  20. Do you want to know how to use the functions?  Read the code ;-) or buy
  21. the autodocs for the iffparser.
  22.  
  23. I have included a few programs that illustrates the use of the iffparser.
  24. They will work with both the small and the real iffparser.
  25.  
  26. THE CONTENT
  27.  
  28. I have included two versions of the library:  SafeSmallIFFParse.library and
  29. SmallIFFParse.library.  The 'safe' version will prompt you for a reply
  30. whenever a program opens the library.  The unsafe version will offer its
  31. services to any programs that wants it.  Properly written program will in
  32. worst case notice that the library can't do some of the true library's
  33. functions and should just fail.
  34.  
  35. The programs I have included will manipulate the clipboard.  They are
  36. called LsClip, CutClip and PasteClip and they will list the IFF-content, 
  37. put some text in the clipboard and paste text from the clipboard.
  38.  
  39.  
  40. HOW DO I USE IT
  41.  
  42. The library is used by renaming one of the versions to 'iffparse.library'
  43. (IMPORTANT!) and then put it in LIBS:.
  44.  
  45. You need 2.0 includes to re-compile the library and the programs and
  46. Manx C-compiler and the libstart.asm file that comes with Manx 5.0.
  47.  
  48.  
  49. LEGALITY
  50.  
  51. This library has NOT been written by any means of reverse engineering or
  52. disassembling of the true library.  The only thing I have 'stolen' is the
  53. specification and the library offsets (I assume that anyone may use them in
  54. this way once you have purchased them from SAS, Manx, CATS or what-ever).
  55. I find no ethical problems with this and since it has been done before in
  56. some sense (remember arp?) I guess it is ok to do so.  The people I have
  57. been in contact with feel the same way so I assume that I am not violating
  58. any copyrights.
  59.  
  60. The code is in Public Domain so you may use it or abuse it in any way you
  61. want, and I assume that I will get the proper credits if you do (a kind
  62. word or a beer will do ;-).
  63.  
  64.  
  65. WHO NEEDS IT?
  66.  
  67. If you have legally required the true iffparse.library then you don't want
  68. to use this library because it is only a inferior sub-set of it, unless you
  69. are interested in saving some disk space.  If you don't have the true
  70. iffparse.library then you might find that some programs that uses the
  71. iffparse.library works with this sub-set.  In either case you might want to
  72. use the code to port 2.0 programs that uses the iffparser to be usable
  73. without the library.
  74.  
  75.  
  76. GUARANTEES
  77.  
  78. Sorry, there is no such thing.  If it blows up then it blows up - Don't
  79. blame me ;-).  I am using the library with another project of mine where I
  80. am using both the clipboard and files to read write very complex IFF:s.  My
  81. programs works equally good with the real thing and my substitute both under
  82. normal circumstances and when error occurs.
  83.  
  84. I practice safe programming ;-) which means that I check every function
  85. that might fail and I deallocate and closes all resources that was
  86. allocated or opened in the code (this is obvious of course) so the code
  87. will probably work in both normal and extreme circumstances.
  88.  
  89.  
  90. MISSING THINGS?
  91.  
  92. Have I missed something essential in the library?  Let me know and I might
  93. fix it.
  94.  
  95.  
  96. !(c) 1991, Michael Jansson.
  97. E-Mail: mij@ida.liu.se
  98.