home *** CD-ROM | disk | FTP | other *** search
/ Otherware / Otherware_1_SB_Development.iso / amiga / programm / libs / reqtool.lha / ReqTools / RTPatch / RTPatch.doc < prev    next >
Encoding:
Text File  |  1992-08-15  |  12.5 KB  |  303 lines
  1.  
  2.                       **********************************
  3.  
  4.                             RTPatch 1.0b
  5.  
  6.                             The ReqTools Patcher
  7.  
  8.                             (c) 1992 Nico Franτois
  9.  
  10.                       **********************************
  11.  
  12.  
  13. Preface
  14. =======
  15.  
  16. The programs and files in this distribution are freely distributable, but are
  17. also copyright (c) Nico Franτois.  They may be freely distributed as long as
  18. no more than a nominal fee is charged to cover time and copying costs.
  19.    No commercial usage is permitted without written permission from the
  20. author.  Everything in this distribution must be kept together, in original
  21. unmodified form.
  22.    The above is generally known as freeware.
  23.  
  24.    If you have suggestions or remarks about this program, or if you find
  25. any bugs, please let me know.
  26.  
  27.    Contacting the author:
  28.  
  29.      Fido:  2:292/603.10 (Nico Francois)
  30.  
  31.      UUCP:  Nico.Francois@p10.f603.n292.z2.FidoNet.Org
  32.  
  33.      Mail:  Nico Franτois
  34.             Corbielaan 13
  35.             B-3060 Bertem
  36.             BELGIUM
  37.  
  38.    If you can please use e-mail.  That way you'll stand a much better chance
  39. of getting a reply quickly.
  40.  
  41.  
  42. Contents
  43. ========
  44.  
  45. 1. Introduction
  46.  
  47. 2. Usage
  48.  
  49. 3. Compatibility
  50.  
  51.  
  52. 1. Introduction
  53. ===============
  54.  
  55.    RTPatch is a small program that will re-route functions from most popular
  56. requester libraries to ReqTools.  Libraries currently supported are Arp, Req
  57. and Asl.  RTPatch will also patch some functions in Intuition to give you
  58. improved system requesters.
  59.  
  60.    The patches RTPatch makes are these:
  61.  
  62.      o Intuition  : AutoRequest and EasyRequest (on 2.0) are patched so
  63.                     normal system requesters, like 'Insert Disk...'
  64.                     requesters, will be replaced by ReqTools EZRequesters.
  65.                     They will appear near the mouse pointer and respond to
  66.                     many keyboard shortcuts.  On 2.0 OpenScreenTagList() is
  67.                     also patched to always open a new-look 3D screen.  This
  68.                     will make for example CygnusEd 2.12 open a nice new-look
  69.                     screen.  You may also ask RTPatch to patch OpenScreen()
  70.                     to open _all_ screens with a 3D look.  Beware however
  71.                     that this makes a lot of old programs look ugly!
  72.      o req.library: File requester, font requester, palette requester,
  73.                     string requester and integer requester are replaced by
  74.                     ReqTools requesters.
  75.      o arp.library: File requester is replaced by ReqTools file requester.
  76.      o asl.library: Currently only file requester is replaced by ReqTools
  77.                     file requester.  Font and screen mode requesters are not
  78.                     patched yet.
  79.  
  80.    RTPatch uses an intelligent patch mechanism.  It will only patch a
  81. library when it is actually opened.  This means that if you never use the
  82. arp.library (for example) it will not be patched and, more importantly, it
  83. will not unnecessaryly be loaded into memory!  If you do run a program that
  84. uses Arp and you quit it, it will close Arp.  RTPatch will then allow the
  85. patched Arp to be expunged from memory.  If Arp is reloaded again later it
  86. will be re-patched.  Note that RTPatch patches exec.library/OpenLibrary() and
  87. exec.library/OldOpenLibrary() to accomplish all this.
  88.  
  89.    RTPatch is a 100% assembly program, for maximum efficiency.  It only
  90. takes 4336 bytes of memory once installed (excluding memory occupied by
  91. reqtools.library).  It uses *NO* processor time while installed.
  92.  
  93.  
  94. 2. Usage
  95. ========
  96.  
  97.    RTPatch can be used from Workbench and from the Shell (CLI).
  98.  
  99.    Shell usage:
  100.    ~~~~~~~~~~~~
  101.      RTPatch 1.0b ⌐ 1992 Nico Franτois
  102.      Usage: RTPatch [NOREQ] [NOASL] [NOARP] [NOINTUITION]
  103.                     [OPENSCRPATCH] [NOOPENSCRTAGPATCH]
  104.  
  105.    Explanation of options:
  106.  
  107.       NOREQ             : Do not patch req.library.
  108.       NOASL             : Do not patch asl.library.
  109.       NOARP             : Do not patch arp.library.
  110.       NOINTUITION       : Do not patch intuition.library.
  111.       OPENSCRPATCH:     : Patch OpenScreen() in intuition.library so _all_
  112.                           screens will open with a 3D look.
  113.       NOOPENSCRTAGPATCH : Do not patch OpenScreenTagList() in
  114.                           intuition.library.
  115.  
  116.    Workbench usage:
  117.    ~~~~~~~~~~~~~~~~
  118.    RTPatch recognizes following tooltypes:
  119.  
  120.       NOREQ             : Do not patch req.library.
  121.       NOASL             : Do not patch asl.library.
  122.       NOARP             : Do not patch arp.library.
  123.       NOINTUITION       : Do not patch intuition.library.
  124.       OPENSCRPATCH:     : Patch OpenScreen() in intuition.library so _all_
  125.                           screens will open with a 3D look.
  126.       NOOPENSCRTAGPATCH : Do not patch OpenScreenTagList() in
  127.                           intuition.library.
  128.       QUIET             : Don't open requester informing patches have been
  129.                           installed.  Set this tooltype if you intend to drag
  130.                           RTPatch to your WbStartup drawer.
  131.  
  132. NOTE: Run RTPatch when *NO* program has req.library, asl.library or
  133.       arp.library open!  RTPatch will complain if one of these libraries
  134.       is in use and will refuse to install or remove patches.  Running
  135.       RTPatch in your user-startup or from your WbStartup should be ok.
  136.  
  137. WARNING: Asl V38 (distributed with Workbench 2.1) always keeps its library
  138.          open count at 0.  It does this so ramlib will always call its
  139.          Expunge() function when memory is low.  This does however mean
  140.          RTPatch cannot see if this library is in use or not.  So you must
  141.          be very careful not to install or remove RTPatch when you have a
  142.          program running that uses Asl.  If you are still using Workbench 1.3
  143.          or 2.0 there is no problem.
  144.  
  145.  
  146. 3. Compatibility
  147. ================
  148.  
  149.    RTPatch supports all basic requester functions and options.  Other
  150. supported things that are worth mentioning:
  151.  
  152.      arp.library (V39)
  153.      ~~~~~~~~~~~~~~~~~
  154.      o File callback function (FRF_DoWildFunc).  The A4 global data register
  155.        is valid when this callback function is called (documented feature).
  156.      o Message callback function (FRF_DoMsgFunc) for requesters which share
  157.        their IDCMP port with the parent window.
  158.      o Save mode (FRF_DoColor flag).
  159.      o Shared IDCMP with parent window or new IDCMP (FRF_NewIDCMP flag).
  160.      o 'Empty filename is ok' behaviour is supported.
  161.  
  162.      asl.library (V36/V38)
  163.      ~~~~~~~~~~~~~~~~~~~~~
  164.      o File callback function/hook (FRF_DOWILDFUNC and ASLFR_FilterFunc tag).
  165.        The A4 global data register is valid when this callback function is
  166.        called for maximum compatibility (undocumented feature of Asl V36).
  167.      o Intuition message callback function/hook (FRF_DOMSGFUNC and
  168.        ASLFR_IntuiMsgFunc tag) for requesters with shared IDCMP.
  169.      o Multi-selection (FRB_DOMULTISELECT flag or ASLFR_DoMultiSelect tag).
  170.      o Directory requester, no files. (FRF_DRAWERSONLY flag or
  171.        ASLFR_DrawersOnly tag).
  172.      o Save mode (FRF_DOSAVEMODE flag or ASLFR_DoSaveMode tag).
  173.      o Shared IDCMP with parent window or new IDCMP (FRF_PRIVATEIDCMP flag
  174.        or ALSFR_PrivateIDCMP tag).
  175.      o Putting to sleep of parent window (ASLFR_SleepWindow tag).
  176.      o Font for requester (ASLFR_TextAttr tag).  Note that if a proportional
  177.        font is supplied it will be rejected by the ReqTools file requester.
  178.      o Pattern gadget (FRF_DOPATTERNS flag or ASLFR_DoPatterns tag).
  179.      o 'Empty filename is ok' behaviour is supported to ensures compatibility
  180.        with e.g. AssignX, PageStream 2.2 and no doubt many other programs.
  181.      o Undocumented fields in file requester structure are filled in, so even
  182.        "dirty" programs will work.
  183.      o Accept and reject patterns (ASLFR_AcceptPattern/ASLFR_RejectPattern).
  184.  
  185.      req.library (V2)
  186.      ~~~~~~~~~~~~~~~~
  187.      o Multi-selection.
  188.      o Buffers for file and font requester.
  189.      o Directory requester (no files).
  190.      o Save mode (FRQSAVINGM flag).
  191.      o Minimum and maximum value of GetLong() requester.
  192.  
  193.      Additional enhancements
  194.      ~~~~~~~~~~~~~~~~~~~~~~~
  195.      o Buffered directories for Asl file requester.
  196.  
  197.  
  198.      Following things are NOT supported (yet?):
  199.                           »»»
  200.      arp.library
  201.      ~~~~~~~~~~~
  202.      o FRF_NewWindFunc and FRF_AddGadFunc/FRF_GEventFunc callback functions
  203.        are not called.  As far as I can tell nobody ever used the latter two
  204.        and the former function is certainly not used a lot.
  205.        In short: this should not pose any problems.
  206.  
  207.      asl.library
  208.      ~~~~~~~~~~~
  209.      o ASLFR_InitialWidth and ASLFR_NegativeText tags are ignored.
  210.      o FRB_REJECTICONS flag and ASLFR_RejectIcons tag are ignored.
  211.      o FRB_FILTERDRAWERS flag and ASLFR_FilterDrawers tag are ignored.
  212.  
  213.      req.library
  214.      ~~~~~~~~~~~
  215.      o Timeout and abort mask (req.library requester will be used).
  216.      o freq->frq_Hide is ignored (freq->frq_Show is however supported).
  217.      o TR_KeyMask is not completely supported.  If it is not 0xffff
  218.        (no qualifers) the requester will only respond to Left Amiga V/B.
  219.        This should suffice in most cases however.
  220.  
  221.    If you find any compatibility problems let me know.  Please give a detailed
  222. description of the problem.  Not 'RTPatch doesn't work with PageStream',
  223. but more like: 'when I do this and this in PageStream ... doesn't work".
  224.  
  225.  
  226.                                                        Enjoy.
  227.  
  228.  
  229.                                PROGRAM HISTORY:
  230.  
  231. *****************************************************************************
  232. RELEASE 0.9▀
  233.  
  234.     o First BETA release.
  235.  
  236. *****************************************************************************
  237. RELEASE 0.91▀
  238.  
  239.     o Bug fixes: Req GetLong requester no longer returns FALSE when you enter
  240.       the value 0 and Req file requester now properly returns full pathname.
  241.     o Now correctly patches AutoRequest when run on Kickstart 1.2/1.3.
  242.  
  243. *****************************************************************************
  244. RELEASE 1.0
  245.  
  246.     o First "real" release, big improvement over previous beta versions.
  247.     o Fixed some small bugs.
  248.     o Now only patches libraries when they are actually opened.  This saves
  249.       oodles of memory, especially when you never or rarely use certain
  250.       libraries!  Also allows patched libraries to be expunged from memory
  251.       unlike many other patchers.
  252.     o In conjunction with ReqTools V38 empty directories are now allowed for
  253.       improved compatibility.  This makes it e.g. possible to use AssignX.
  254.     o Asl (V36-V38) library is now also patched (file requester only).
  255.     o Command line arguments/icon tooltypes to set some options.
  256.  
  257. *****************************************************************************
  258. RELEASE 1.0a
  259.  
  260.     o ASLFR_AcceptPattern and ASLFR_RejectPattern tags are now supported.
  261.     o Req TextRequest() patch now handles textrequests without gadgets.
  262.       An 'Ok' gadget will be added by RTPatch.
  263.     o Bug fixed: Asl callback hook (filter function) is now only called for
  264.       files, not for directories as well.  The callback hook also makes
  265.       sure the fr_Drawer field of the Asl requester is pointing to the
  266.       current directory (only with ReqTools release 2.0b or higher!).
  267.     o Now allows you to also patch OpenScreen() to force _all_ screens to
  268.       open with a 3D look. This is not default because it makes a lot of old
  269.       programs look ugly.
  270.       WARNING: NOOPENSCRPATCH switch has been changed to NOOPENSCRTAGPATCH!
  271.     o OpenScreenTagList() patch tweeked a bit.
  272.     o On Kickstart 2.0 or higher RTPatch will now set the RNF_WILDSTAR flag
  273.       in the DOS rootnode. This allows you to use '*' as a wildcard.
  274.  
  275. *****************************************************************************
  276. RELEASE 1.0b
  277.  
  278.     o OpenScreenTagList() patch tweeked a bit more :)  Will not force a 3D
  279.       look if no taglist was supplied. Will also leave the picking of the
  280.       pens completely up to Intuition. Patch made more future-compatible :)
  281.     o Bug fix: Arp message callback function didn't work.  This caused TxEd
  282.       Plus 2.2 to crash.  Thanks to Bill Sorensen for reporting this bug.
  283.     o Fixed problem with AutoRequest() and EasyRequest() patches.  Requesters
  284.       weren't opened on the default public screen if the window argument was
  285.       NULL.  They were opened on the screen of the window in pr_WindowPtr.
  286.       Thanks to Roger Nordin for reporting this.
  287.  
  288. *****************************************************************************
  289.  
  290. RTPatch 1.0b written by Nico Franτois (Yes, Nico is my first name :-)
  291.  
  292.  
  293. "Is that you Mo-Dean?
  294.  It's me Mo-Dean
  295.  The Interdimensional outer space being" - The B-52's
  296.  
  297.  
  298. (c) 1992 Nico Franτois
  299.  
  300.                                    //
  301.                        Thanks to \X/ Amiga for being the best computer ever!
  302.  
  303.