DOSjpCNJg @ hpNupNudos.librarykR3 a few lines of assembler glue code for the TextRequest routine. The TextRequest routine is a little bit more complicated to use, but it allows correspondingly more flexibility. It is fairly simple to modify the glue code to allow still more high level entry points to the TextRequest routine. This is a complete program that makes use of the SimpleRequest function from assembler, and demonstrates a few of the features of Format (which is used by SimpleRequl;est). ;-------------------------------------------------------------------- ;-----CUT HERE---------------CUT HERE-------------------------------- ;-------------------------------------------------------------------- INCLUDE "libraries/reqbase.i" public SimpleRequest public _ReqBase,_main ;-------------------------------------------------------- ; This file should be linked with reqglue.o, for the SimpleRequest ;function. ;-------------------------------------------------------m - SYS MACRO XREF _LVO\1 JSR _LVO\1(A6) ENDM ;-------------------------------------------------------- _main OpenReq mystart MOVE.L A6,A5 MOVE.L A6,_ReqBase PEA string MOVE.L #$C0FFEE,-(SP) MOVE.W #$1CE,-(SP) MOVE.W #'B',-(SP) MOVE.L #-12345,-(SP) MOVE.L SP,A1 LEA Text,A0 JSR SimpleRequest LEA 16(SP),SP MOVE.L A5,A1 MOVE.L 4,A6 SYS CloseLibrary MOVEQ #0,D0 RTS string DC.B "This is a string.",0 Text DC.B "A long (signed) decimal is: %ld,",10 DC.B "n =\a character is: %c,",10 DC.B "a 16 bit hex val might be: %x, ",10 DC.B "a register-style format 32 bit hex: $%08lx,",10 DC.B "and a string might read: `%s'.",0 dseg _ReqBase DC.L 0 ;The SimpleRequest function in the glue code ;needs this variable. END ;-------------------------------------------------------------------- ;-----CUT HERE---------------CUT HERE-------------------------------- ;-------------------------------------------------------------------- ;------o]-------------------------------------------------------------- TwoGadRequest NAME TwoGadRequest - bring up a text requester and wait for the user to acknowledge it. SYNPOSIS result = TwoGadRequest(string, parameterlist, , ,) A0 A1 FUNCTION Bring up a requester (actually a window) containing a message to the user and wait for the user to click on either the OK or the CANCEL gadget. The window automatically sizes to fit the text and printf() style formattip cng can be used by TextRequest() to generate the message to the user. INPUTS string - a null terminated string, containing printf() style formatting commands if desired. parameterlist - the parameters corresponding to the printf() style formatting commands in the string. In C these are listed after the control string, exactly as with printf(). In assembler, the address of the list of parameters is put in A1. RESULT Either one or zero is returned, depending on whq ,ether the user selected, respectively, the OK or the CANCEL gadget. BUGS See TextRequest SEE ALSO TextRequest SimpleRequest This function was designed to make it as easy to give messages to the user and get a response in an intuition style requester as it is using printf() and getc(). Simply replace almost any call to printf() with a call to SimpleRequest and a requester will appear and not disappear until the user responds to it (either with a keystroke or with r ޡ}the mouse). Example: if (TwoGadRequest("There have %d changes made to this file.\n" "O.K. to continue?", numchanges)) exit(10); Please see the TextRequest documentation for further important details. This routine is simply a few lines of assembler glue code for the TextRequest routine. The TextRequest routine is a little bit more complicated to use, but it allows correspondingly more flexibility. It is fairly simple to modify the glusmHu7e code to allow still more high level entry points to the TextRequest routine. ------------------------------------------------------------------- NAME GetString BOOL = GetString(buffer, title, window, visiblechars, maxchars) D0 A0 A1 A2 D0 D1 DESCRIPTION This routine allows you to bring up a nice intuition style string requester in its own window and get a single line of input from the user in just a one line function call. buffe` \ be used. Since the RawDoFmt() function of the ROM is used to do the formatting, only functions supported by it can be used. For complete documentation, see the documentation of the RawDoFmt() command. The main things to be aware of is that floating point numbers can not be printed, and, if you are using a compiler that uses thirty-two bit ints then we will have to specify '%ld' to print an int, since the RawDoFmt command assumes an int size of sixteen bitsa ә&. The Controls field points to a list of parameters, one for each of the '%' parameters in the Text field. Normally these will be pushed on to the stack and the stack pointer copied into the Controls field. The first parameter used (the first one to occur in the string) should be at the beginning of the list, that is, at the lowest address, the one pointed at by the Controls parameter. The Window field can be used to specify what screen you would like the requester to appeab7Yr on. This field is usually not necessary since the same information can be conveyed in the pr_WindowPtr field of your process structure. However this field was left in so that the TextRequest function could be called from a task (which lacks a process structure and therefore a pr_WindowPtr field). If this field is non-zero or if the calling program is a task then this field takes precedence over the pr_WindowPtr field. MiddleText, PositiveText and NegativeTexcOKQt are the pieces of text used for the three gadgets. These three gadgets, when present, are placed in the middle, the left and the right of the window respectively. All three gadgets are placed along the bottom of the window. All of the gadgets are optional. If a gadget is not wanted, the text pointer should be set to zero. The values returned if the user clicks on these gadgets are two, one or zero, respectively. If none of the gadgets are present (ifdO+K, all of the text fields are zero) then a standard CLOSEWINDOW gadget is attached to the window. This gadget returns a zero. The requester attempt to appear so that the negative gadget is underneath the mouse pointer. If the negative gadget is not present it will attempt to appear so that a different gadget is underneath the mouse pointer. This is to make it as convenient as possible for the user to respond to, and especially to respond negatively to, the requesteer. In addition to responding to the requester with the mouse, keyboard shortcuts are available. The user can type ESC, 'N', 'Q' or 'B' as a shortcut to clicking on the negative gadget. The user can type 'Y' or 'V' as a shortcut to clicking on the positive gadget and can type 'M' as a shortcut to clicking on the middle gadget. The Title field of the structure should either point to a null terminated string to be used in the windows title bar or should be nfXull. The KeyMask field is used to regulate the use of keyboard shortcuts. The qualifier field of all keyboard messages is ANDed with this field, and the keypress is ignored if the result is zero. Therefore, to enable all keypresses to be used as keyboard shortcuts, initialize this field to $FFFF. To turn off the keyboard shortcuts, initialize this field to 0. To force the user to hold down the left or right amiga key, initialize this field to AMIGAKEYS. Tg`he textcolor, detailcolor and blockcolor fields can be left unitialized (ie; set to zero) if you wish, in which case the requester will use the default values of one, zero and one respectively. The textcolor field is used for the color of the actual text message and the detail and block color fields are simple copied into the fields of the same name in the new window structure. ;-------------------------------------------------------------------- SimpleRequest NAME Sh(impleRequest - bring up a text requester and wait for the user to acknowledge it. SYNPOSIS SimpleRequest(string, parameterlist, , ,) A0 A1 FUNCTION Bring up a requester (actually a window) containing a message to the user and wait for the user to acknowledge it. The window automatically sizes to fit the text and printf() style formatting can be used by TextRequest() to generate the message to the user. INPUTS string - a null terminated string, conie1taining printf() style formatting commands if desired. parameterlist - the parameters corresponding to the printf() style formatting commands in the string. In C these are listed after the control string, exactly as with printf(). In assembler, the address of the list of parameters is put in A1. RESULT No result code is returned. BUGS See TextRequest SEE ALSO TextRequest TwoGadRequest This function was designed to make it as easy to give messages to the user and joBawait acknowledgment in an intuition style requester as it is using printf() and getc(). Simply replace almost any call to printf() with a call to SimpleRequest and a requester will appear and not disappear until the user acknowledges it (either with a keystroke or with the mouse). Example: SimpleRequest("There have %d changes made to this file.", numchanges); Please see the TextRequest documentation for further important details. This routine is simplyUX~4 typically be eight or nine (for eighty or sixty column topaz). This can be set to one if your data is continuous (as in the case of some graphics). PropGadget is a pointer to the prop gadget which is being used to control this scroll area. RedrawAll is a pointer to a function that you must supply to redraw the entire visible window. This routine is called whenever the user gets so far ahead of the scroll routine that scrolling to where the users wants toV q be would take to long. Before calling this routine, the ScrollStruct that was passed to this routine is updated with the desired TopEntryNumber so that your routine will know which data to redraw. ReadMore is an optional routine that will usually not be used. It is used if more data is being added while the scrolling is going on. This is used, for instance, by the FileRequest in the requester library, to continue attempting to read the directoy while the user iW̌s scrolling. Leave this set to zero if you don't need it. It is only called when no scrolling is being done, but the user has not released the scroll bar. ScrollAndDraw is the most important routine. This routine, which you must supply, is called whenever the data must be scrolled. The actual scrolling and redrawing of the data is done by this routine, but because the scroll amount, the lines to be drawn and the number of lines to be drawn are passed to this routinXh-e, the routine is fairly simple. Four parameters are passed to this routine: ScrollAndDraw(firstlinenum, firstliney, scrollamount, numlines); All four parameters are passed as longs, both on the stack and in D0-D3, so that the routine can easily be written in either C or assembler. When the ScrollAndDraw, ReadMore or RedrawAll routines are called, A4, A5 and A6 all contain the same values they contained when RealTimeScroll was called. This allows programs wY*~5ritten in C using the small data model to be able to access their data properly from these routines without any special work. All other registers (except those that are used to pass parameters in) could contain anything. ;-------------------------------------------------------------------- TextRequest NAME TextRequest - bring up a text requester with one to three gadgets and get a response. SYNOPSIS result = TextRequest(&TRStructure); D0 A0 FUNCTION BringZ5 up a requester (actually a window) containing a message to the user and give him a choice of from one to three different responses. The window automatically sizes to fit the text and printf() style formatting can be used by TextRequest() to generate the message to the user. INPUTS &TRStructure - pointer to an initialized text requester structure. RESULT Returns either zero, one or two, depending on which gadget the user clicks on. All of the gadget[N s are optional, so that the requester can be used to bring up requesters that give the user a message, without demanding an answer, by having only a single gadget. The gadget in the lower right hand corner (the negative gadget) returns a zero, the gadget in the lower left hand corner (the positive gadget) returns a one and the gadget in the middle returns a two. If none of these three gadgets are requested, a close gadget is attached to the window and it returns a \t#Cit is used instead of the pr_WindowPtr field of your process structure. Important note: It is VERY important that you reset the pr_WindowPtr field back to its original value before your program exits. If you don't, the next program run may try to open a requester window on a now closed screen. The file requester was carefully designed so that it could be called without having to initialize very many fields. This is demonstrated by seeing that it is po;?1${ssible to call it without initializing any fields. There are a few fields that are necessary to actually get any use out of it, but very view. Those few are documented in the following paragraph. Although you can bring the file requester up without initializing any fields there are a couple of fields that you will definitely want to initialize. The file requester isn't much use unless you get a file name back out of it, and for this you need to initialize the <@DiIDir and File fields. These two fields should point to character arrays that are, respectively, DSIZE+1 and FCHARS+1 bytes long. When the file requester is first run the file requester looks in these arrays for the default directory and file names and if the user selects a file name the directory and file name are copied back into these arrays. You will probably want to initialize the Title field with the message that you want to have appear at the top of the fi=Ale requester window. If you initialize the PathName field (it should point an array of at least DSIZE+FCHARS+2 characters) then when the user selects a file, the complete path name will be put into this array. The Window field is used to specify what window the file requester is associated with. This is used to get the file requester to show up on a custom screen. Generally this field should be unnecessary. There is a variable provided in a process structure which is us>,bed for this purpose. Any program that opens a custom screen and uses any DOS functions should set the pr_Window pointer in their process structure to a pointer to their window so that DOS requesters will show up on their custom screen. If you do this, then the file requester will also show up on your custom screen. If you are not using a custom screen then you don't need to set the pr_Window pointer or the Window field in the file requester structure. Note: If)C.tI left corner of the box, and (MaxX,MaxY) are the lower right. The pen is left at the upper left corner (MinX,MinY). ;-------------------------------------------------------------------- NAME MakeButton SYNOPSIS MakeButton(Buffer,Image,Image2,Width,Height,Depth) A0 A1 A2 D0 D1 D2 struct TwoImageGadget *Buffer; char *Image; /* Pointer to the actual bitplane data */ char *Image2; /* Pointer to the second image. */ long Width,Height,Depth;*DC& DESCRIPTION The purpose of this routine is one similar to MakeGadget, but instead of using text for the button, it uses a graphic. You supply a bitmap, and MakeButton will use it in it's rendering. You may have either one or two images, the routine handles it routinely. If you supply one image, then this sets GADGHCOMP, and if you have two images, it sets GADGHIMAGE. RELVERIFY is always set, so as long as you the user is pressing that gadget, the alter+E[znate highlight is shown. Buffer has room for two images. Image is a pointer to the actual image data, in CHIP memory, for this gadget. Image2 is a pointer to the alternate image data. Width and Height make up the size of your image. Depth is how many bitplanes of data you've supplied. BUGS It's not really a bug, but if your images aren't the same size, then one won't erase the other when it is drawn, so you may be showing an image with traces of the other one left the,F\tget routines. This one obviously links the string gadget to the window's gadget list. In fact, the only difference between this and the MakeString routine is the addition of the NewWindow pointer. SEE MakeStringGadget ;-------------------------------------------------------------------- NAME LinkPropGadget SYNOPSIS LinkPropGadget(Buffer,nw, Width, Height, Flags, LeftEdge, TopEdge) A0 A3 D0 D1 D2 D3 D4 struct PropBlock NϘ A0 struct ExtendedColorRequester colorreqstruct; DESCRIPTION This call brings up exactly the same color requester as the ColorRequester call. The only difference is that this routine allows you to specify more parameters. The difference is actually quite small right now, because there is only one additional parameter that can be passed through this entry point. This is the ecr_window parameter, used to specify what window (and hence what scrO>]ieen) the color 'requester' appears on. This parameter is rarely needed because the window the requester opens up on can be specified by setting the pr_WindowPtr field in your process structure to the address of your window structure (see the beginning of the docs for an overview on this procedure). The only time this entry point is needed, currently, is if you try to bring up the color requester on a custom screen from a task, since a task does not have a pr_WindowPtr  Peb7and can therefore not specify the window and screen. RETURNS Color number that the user selected, -1 if the user cancels the colour requester. The changed colours will be in the viewport structure for your screen. SEE ColorRequester BUGS none known. EXAMPLE /* This should generally be declared as a global variable */ /* so that all of it's elements get initialized to zero. */ /* If you declare it as a local variable, be sure to zero */ /* all of the fie!Q|lds, even the unused ones. */ struct ExtendedColorRequester colorstruct; colorstruct.defcolor = 0; colorstruct.window = mywindow; newcolor = ExtendedColorRequester(&colorstruct); ;-------------------------------------------------------------------- NAME MakeGadget SYNOPSIS MakeGadget(Buffer,String, X, Y) A0 A1 D0 D1 struct Buffer *GadgetBlock; char *String; long D0,D1; DESCRIPTION This routine prepares a buffer to be a standard BOOLEAN text gadge"Rbd,.t. This is a simple way of producing gadgets for code that must be reentrant, and it is more efficient than defining gadgets in data statements. The routine initializes the gadgets to a set of 'standard' values that should cover most cases and then links the four parts of the GadgetBlock together. Buffer is a pointer to a unitialized GadgetBlock, which contains the necessary Gadget, Border, border pairs and IntuitText structures needed to render a boolean gadget #Svwith a border and some text. String is a pointer to the text that should appear inside the gadget. The gadget is automatically sized to match the strings length. X and Y are the gadgets initial position, they are simply copied into LeftEdge and TopEdge in the gadget structure. RETURNS SEE BUGS EXAMPLE ;-------------------------------------------------------------------- NAME MakeString SYNOPSIS MakeString(Buffer,StringBuff,UndoBuff,MaxWidthBits,MaxNumChars,$T X, Y) A0 A1 A2 D0 D1 D2 D3 struct Buffer *StringBlock; char *StringBuff; char *UndoBuff; long MaxWidthBits, MaxNumChars, X, Y; DESCRIPTION As with all of the MakeGadget functions, this one prepares a buffer to be used as a string gadget, that may be used re-entrantly. The buffer need not be cleared first. This means that you may create a temporary gadget on the stack. The StringBuff is where the body of text i%Ubnside the gadget will reside. When the gadget is activated, the text in StringBuff is automatically copied (by intuition) into UndoBuff. This allows you to type Amiga-Q and get the old string back. This field may be null if you wish to have no undo. MaxWidthBits is the width of the frame around the gadget. MaxNumChars is the maximum number of characters that you will be able to type into the gadget, including the terminating zero on the string. MAKE SURE th&V37vat this number is no greater than your StringBuff size, or else you're going to be typing over memory that isn't yours. X,Y are the position of the upper left hand corner of the gadget. The border is actually 2 pixels above and to the left of this corner. RETURNS Nothing SEE MakeGadget,MakeProp,MakeScrollbar,LinkGadget,LinkProp,LinkString ;-------------------------------------------------------------------- NAME MakeProp SYNOPSIS MakeProp(Buffer,Width,Height,Flags) 'Wum A0 D0 D1 D2 struct Buffer *PropBlock; long Width, Height, Flags; DESCRIPTION This routine prepares an un-initialized buffer for use as a prop gadget. Buffer, on return, will contain the gadget, along with the necessary PropInfo and Image structures, all linked together. Width is the with of the container, in pixels. Height is the height of the container in pixels. The Flags parameter is where you decide if you want FREEHORIZ, FREEVERT, or bo(BLuth. It is simply copied into the gadget flags field. RETURNS Nothing ;-------------------------------------------------------------------- NAME DrawBox SYNOPSIS DrawBox(rp,MinX,MinY,MaxX,MaxY) A1 D0 D1 D2 D3 struct RastPort *rp; long MinX,MinY,MaxX,MaxY; DESCRIPTION This routine allows you to draw a simple box in one command. It draws the box in APen color, in the current draw mode, with the current line pattern. (MinX,MinY) are the upperYsEu position the window as close as possible to the correct location. To allow this routine to work accurately it is necessary to have already initialized the new window structure to specify on what screen the window is going to be open. ie; you should set the Type and Screen fields before calling Center(). This routine disturbs no registers. RETURNS nothing SEE BUGS None known ;-------------------------------------------------------------------- NAME SetSize Z2eSYNOPSIS SizeVal=SetSize(MaxValue,ViewSize) D0.W D0.L D1.L short SizeVal; long MaxValue,ViewSize; DESCRIPTION This routine is designed to correctly handle sizing a prop gadget to a range. The range is given in in MaxValue/ViewSize. MaxValue is the maximum value that this prop is supposed to be able to represent. Viewsize is how large the display area is. For instance, if your maximum value was 200 (files, for example), and your viewsize was 15 [a"m(lines of text), then you would call this as so: SizeVal=SetSize(200,15); Then you would put SizeVal into the appropriate PropInfo structure element (in the case of the file requester, that would be VertBody). RETURNS The 16 bit value to be put into the PropInfo structure of the prop gadget. SEE SetLocation, ReadLocation BUGS Bugs? what bugs? ;-------------------------------------------------------------------- NAME SetLocation SYNOPSIS NewLoc = SetLocation(MaxVa\$W*lue,ViewSize,Value); D0 D0 D1 D2 short NewLoc; long MaxValue,ViewSize,Value; DESCRIPTION When you have a prop gadget that you wish to directly set, then this is the routine to use. It allows you to pass any 32 bit value and properly set the gadget. RETURNS The return is the value to put into either HorizPot or VertPot, depending on what orientation you have the gadget. BUGS n/a EXAMPLE SEE SetSize(),ReadLocation() ;----------------------------]úS---------------------------------------- NAME ReadLocation SYNOPSIS LocVal=ReadLocation(MaxValue,ViewSize,PotValue) D0 D0.L D1.L D2.W long LocVal,MaxVal,ViewSize; short PotValue; DESCRIPTION If you prop gadget has been moved, this is the routine that you would use to determine where it's been moved to. RETURNS Returns the decoded value of the prop, as an unsigned 32 bit. This is the element number (line number usually) that should be^R\ displayed on the first line of your display window. SEE SetSize(), SetLocation() BUGS n/a EXAMPLE ;-------------------------------------------------------------------- NAME Format SYNOPSIS Format(Buffer,string,values) A2 A0 A1 char *Buffer,string[]; char **values; DESCRIPTION This does the same thing as sprintf(), except that it isn't in the stdio library, and doesn't use up very much room. This function uses the ROM function RawDoFmt to do the_.Ld print() style formatting. This routine does not allow the use of all of the '%' directives (for example, floating point numbers can not be printed with this). For full documentation on what directives are supported, see the documentation on RawDoFmt. This is the routine that TextRequest (and therefore SimpleRequest and TwoGadRequest) use for their text formatting, so these restrictions apply to them also. The RawDoFmt routine also assumes that 'int's are`. sixteen bits long. Therefore, if you are using a compiler with an int size of thirty-two bits and you want to print an int or a short, you must use '%ld', rather than '%d'. RETURNS The number of characters in the formatted string. BUGS none known EXAMPLE Format(Buffer,"There are %d changes to the file %s.",numchanges, filename); Format(Buffer,"%x is a hex number, %c is a character.", num, chr); SEE TextRequest, SimpleRequest, TwoGadRequest. Further information oa n printf() style formatting is available in the AutoDocs on RawDoFmt and in C manuals discussing printf(). ;-------------------------------------------------------------------- NAME ColorRequester SYNOPSIS NewColor=ColorRequester(DesiredColor); D0 D0 long DesiredColor; DESCRIPTION This is a full-fledged color requester. It is intelligent enough to open with the right number of colours in the palette automatically. It shows you both the colour yb)[+ou are working with, and the numerical RGB value of that colour. It has Spread, Undo, Ok and Cancel functions. Planned is the addition of HSV. The cursor keys move the color-cursor around the palette, RETURN selects the current color and ESC cancels out. You pass this routine the color that you would like initially highlighted (typically the current drawing colour). The ExtendedColorRequester function has slightly more options, but is slightly more work to MQcall. RETURNS Color number that the user selected, -1 if the user cancels the colour requester. The changed colours will be in the viewport structure for your screen. SEE ExtendedColorRequester BUGS none known. EXAMPLE newcolor = ColorRequester(oldcolor); ;-------------------------------------------------------------------- NAME ExtendedColorRequester SYNOPSIS NewColor=ExtendedColorRequester(&(struct ExtendedColorRequester) D0 d)UtY important that it restore the previous value of pr_WindowPtr. If you don't, then your program will work in some situations, but will BLOW UP in others. For example, if you execute (without using the 'run' command) a program, which then sets the pr_WindowPtr to point at one of its windows and the exits without restoring it, then the next time a DOS requester tries to appear... BOOM! The machine will probably crash as DOS tries to open a requester on a now closed sc ev)|reen. Therefore, before leaving: myprocess->pr_WindowPtr = oldwindowptr; or: MOVE.L _myprocess,A0 MOVE.L _oldwindowptr,pr_WindowPtr(A0) One final note. The pr_WindowPtr field exists in the process structure. This means that a task does not have this field. Therefore, if you want to call one of the requester library functions from a task, you will not be able to specify what screen you would like the requester to appear on by setting the pr_WindowP fDXDtr field. All of the functions that open requesters and can be called from a task (the file requester/font requester is the only one that can't be called froma task) have some other way of specifying which screen you would like them to open on. They will have either have a field in the structure which you must pass them or a parameter which can contain a window pointer to one of the windows on your custom screen. If this pointer is non-zero then it overrides the pr_WindowP gvtr field. By opening the requester library, you not only gain access to all of the functions documented below, but to some other goodies as well. Req.library needs and therefore opens several other libraries, including dos.library, intuition.library, graphics.library and the console device. All of these pointers are stored in the ReqLib structure which you get a pointer to when you open the req.library. Therefore, you can save yourself a little bit  h:of code by grabbing these fields after opening the requester library. The only thing to beware of is don't use these values after you have close the requester library, because at that point there is no guarantee that they will still be valid. In addition to these libraries, the Images pointer in the req library structure points to a set of ten small images (four arrows and ssix letters) which have are guaranteed to be in chip memory. These can be used if your program  i#requires this type of images. One thing to keep in mind when using the gadget creation routines is that there isn't any way for us to check that you have passed us a pointer to the correct size of buffer, so you _must_ make sure that you are allocating the right amount of memory. -------------------------------------------------------------- Here's a quick list of the functions available: -------------------------------------------------------------- Center..............j:!....Center a new window over the mouse. SetSize.................Prop gadget handling routines (32 bit) SetLocation ReadLocation Format..................sprintf() format routine SimpleRequest...........Starter gluecode to TextRequest- Single gadget TwoGadRequest...........Starter gluecode to TextRequest- Two gadgets FileRequester...........FileRequester routines PurgeFiles ColorRequester..........a colorrequester MakeGadget..............Gadget creation routines MakeString MakePrk{=^op MakeButton MakeScrollBar...........3 part gadget; 2 arrows and a prop. Horizontal or Vertical LinkGadget..............Gadget creation routines that self-hook into the newwindow LinkStringGadget........gadget list. LinkPropGadget DrawBox.................Draw a box (x1y1)(x2y2) in one command GetFontHeightAndWidth...return height and width of current font RealTimeScroll..........scroll routine used in file requester TextRequest.............Powerful reqliuester function GetString...............Get a line of text from the user GetLong.................Get a signed long from the user RawKeyToAscii...........Convert raw key to ascii NewGetString A second point to GetString. Different way of passing parameters. ---------------------------------------------------------------- NAME Center SYNOPSIS Center( &nw, x, y) A0 D0 D1 struct NewWindow *nw; USHORT x,y; DESCRIPTION Center() is used to adjust a NewWmcxindow structure so that the window that it opens will appear immediately under the mouse. The x,y values are used to specify which part of the window you would like to appear underneath the mouse. If x or y is zero, that tells Center() to position the window so that the window center (in the x or y direction respectively) is underneath the mouse. If x or y is positive, that tells Center() to position the window so that the mouse is that many pixels from the XE5& left or top edge of the window respectively. If x or y is negative, that tells Center() to position the window structure so that the mouse appears that many pixels from the right or bottom edge of the window respectively (ie; x = -10 tells Center to position the mouse ten pixels to the left of the right edge). If it is impossible to position the window exactly where requested (if the mouse pointer is too close to the edge of the screen) then this routine will ok$depends on it. APTR rl_GfxLib ; APTR rl_SegList APTR rl_Images ;pointer to the arrow images. BYTE rl_Flags BYTE rl_Pad APTR rl_ConsoleDev ;for RawKeyToAscii APTR rl_ConsoleHandle ;so we can close the device later LABEL MyLib_Sizeof LIBINIT LIBDEF _LVOCenter ;1e LIBDEF _LVOSetSize ;24 LIBDEF _LVOSetLocation ;2a LIBDEF _LVOReadLocation ;30 LIBDEF _LVOFormat ;36 LIBDEF _LVOFakeFunction1 ;3c Old function. Don't use. LIBDEF _LVOFakeFunction2 ;42 Old fup)Mnction. Don't use. LIBDEF _LVOFakeFunction3 ;48 Old function. Don't use. LIBDEF _LVOFakeFunction4 ;4e Old function. Don't use. LIBDEF _LVOFileRequester ;54 LIBDEF _LVOColorRequester ;5a LIBDEF _LVODrawBox ;60 LIBDEF _LVOMakeButton ;66 LIBDEF _LVOMakeScrollBar ;6c LIBDEF _LVOPurgeFiles ;72 LIBDEF _LVOGetFontHeightAndWidth ;78 LIBDEF _LVOMakeGadget ;7e LIBDEF _LVOMakeString ;84 LIBDEF _LVOMakeProp ;8a LIBDEF _LVOLinkGadget ;90 LIBDEF _LVOLinkStringG qQadget ;96 LIBDEF _LVOLinkPropGadget ;9c LIBDEF _LVOGetString ;a2 LIBDEF _LVORealTimeScroll ;a8 LIBDEF _LVOTextRequest ;ae LIBDEF _LVOGetLong ;b4 LIBDEF _LVORawKeyToAscii ;ba LIBDEF _LVOExtendedColorRequester ;c0 LIBDEF _LVONewGetString ;c6 REQNAME MACRO DC.B 'req.library',0 ENDM ; This macro will open the RequesterLibrary for you. At the end, A6 will ;contain the library and D0/A0 will be correct. (What dos passed you) OpenReq MACRO BRA.S opnrq dname DC.B '!rdos.library',0 rlibmsg DC.B 'You need V1+ of ' ReqName REQNAME DC.B 10,13,0 ;;;rliblng EQU *-rlibmsg rliblng EQU 30 DS.W 0 EVEN opnrq: MOVEM.L d0/a0,-(sp) MOVE.L 4,A6 LEA.L ReqName,a1 MOVEQ.L #ReqVersion,d0 SYS OpenLibrary TST.L d0 BNE.S itsokay LEA dname,A1 SYS OpenLibrary TST.L D0 BEQ.S 1$ MOVE.L D0,A6 SYS Output MOVE.L d0,d1 BEQ.S 1$ ;No output. Phooey. MOVE.L #rlibmsg,d2 ;Tell user he needs to find library. MOVE.L #rliblng,D3 SYS Write 1$: ADDQ #8,sp RTS"=MFM itsokay: MOVE.L D0,A6 MOVEM.L (SP)+,D0/A0 ENDM ENDC ng ;a2 LIBDEF _LVORealTimeScroll ;a8 LIBDEF _LVOTextRequest ;ae LIBDEF _LVOGetLong ;b4 LIBDEF _LVORawKeyToAscii ;ba LIBDEF _LVOExtendedColorRequester ;c0 LIBDEF _LVONewGetString ;c6 REQNAME MACRO DC.B 'req.library',0 ENDM ; This macro will open the RequesterLibrary for you. At the end, A6 will ;contain the library and D0/A0 will be correct. (What dos passed you) OpenReq MACRO BRA.S opnrq dname DC.B 't0alled the pr_WindowPtr. This pointer is used by DOS to decide where to put it's requesters. If pr_WindowPtr contains a zero, requesters go on the workbench screen. If it contains the address of a window, then requesters go on that window's screen. If it contains a negative one, then no DOS requesters come up. The req.library requesters all use this variable, if they are called from a process . However, if the pointer is -1, the req.library functions do still appumh_ear, on the workbench screen. The second way was put in mainly so that the requesters can be called from tasks. Since a task does not have a process structure, it also lacks a pr_WindowPtr. Therefore, all of the requester functions which can be used from a task (currently everything except the file requester) can be passed a window pointer, either as a parameter or as an element in a structure. Important: This pointer takes precedence over the pr_WindowPtr so if yv[pr_WindowPtr; myprocess->pr_WindowPtr = window; or: MOVE.L 4,A6 MOVE.L #0,A1 SYS FindTask ;Find my task. MOVE.L D0,_myprocess MOVE.L D0,A0 MOVE.L pr_WindowPtr(A0),_oldwindowptr MOVE.L _window,pr_WindowPtr(A0) Before your program exits it is VERx'%oft Software). Req.library is a freely distributable library that may be used in commercial products without paying any royalties. We encourage you to use the requester library in all of your programs, to make them easier to write, and to use. Req.library is not public domain. The requester library and all documentation and example programs are all copyright 1989. The requester library must be distributed with the documentation file (req.doc), and the three incs4lude files (req.h, reqbase.h and reqbase.i). Req.library is dedicated to the programmers who make the Amiga shine the way it was meant to. OverView: All of the req.library functions that bring up requesters allow you two ways of specifying what screen you would like the requester to appear on. The first way is the more efficient way, because you only have to set it up once and then it takes care of things automatially. There is a field in all process structures czȣzcolumns in device window. ULONG frq_Flags ; Various - umm - flags. See above for more info. UWORD frq_dirnamescolor ;These five colors will all default UWORD frq_filenamescolor ;to color one if you don't specify UWORD frq_devicenamescolor ;a color (ie; if you specify color zero). UWORD frq_fontnamescolor ;If you want color zero to be used, specify UWORD frq_fontsizescolor ;color 32, or some other too large number ;which mods down to zero. UWORD frq_detailcolor ;If bo{w#th of these colors are specified as UWORD frq_blockcolor ;zero then the block pen will be set to one. UWORD frq_gadgettextcolor ;The color for the text of the five boolean gadgets. Defaults to 1. UWORD frq_textmessagecolor ;The color for the message at the screen top. Defaults to 1. UWORD frq_stringnamecolor ;The color for the words Drawer, File, Hide and Show. Defaults to 3. UWORD frq_stringgadgetcolor ;The color for the borders of the string gadgets. Defaults to 3. |a;Unfortunately it is not possible to specify ;the color of the actual text in an Intuition ;string gadget. UWORD frq_boxbordercolor ;The color for the boxes around the file and directory areas. Defaults to 3. UWORD frq_gadgetboxcolor ;The color for the boxes around the five boolean gadgets. Defaults to 3. STRUCT frq_RFU_Stuff,36 ;This area, which is reserved for ;future use, should all be zero. STRUCT frq_DirDateStamp,ds_SIZEOF ; A copy of the cached director}Gies date stamp. ; There should never be any need to change this. UWORD frq_WindowLeftEdge; ;These two fields are only used when the UWORD frq_WindowTopEdge; ;FRQABSOLUTEXY flag is set. They specify ;the location of the upper left hand ;corner of the window. UWORD frq_FontYSize ;These fields are used to return the selected UWORD frq_FontStyle ;font size and style, only applicable when the ;font bit is set. ;If you set the extended select bit and ~?-the user extended selects, the list of filenames will start from here. APTR frq_ExtendedSelect ; Linked list of ESStructures if more than one filename is chosen. ;All of the following variables you shouldn't need to touch. They contain fields that the file ;requester sets and likes to preserve over calls, just to make life easier for the user. STRUCT frq_Hide,WILDLENGTH+2 ; Wildcards for files to hide. STRUCT frq_Show,WILDLENGTH+2 ; Wildcards for files to show. WORD frq_Fil5eBufferPos ; Cursor's position and first WORD frq_FileDispPos ; displayed character number in WORD frq_DirBufferPos ; the three string gadgets. No WORD frq_DirDispPos ; need to initialized these if WORD frq_HideBufferPos ; you don't want to. WORD frq_HideDispPos WORD frq_ShowBufferPos WORD frq_ShowDispPos ; The following fields are PRIVATE! Don't go messing with them or ; wierd things may/will happen. If this isn't enough of a warning, go read ; the onnLe in intuition.h, that should scare you off. APTR frq_Memory ; Memory allocated for dir entries. APTR frq_Memory2 ; Used for currently hidden files. APTR frq_Lock ; Contains lock on directories being read across calls. STRUCT frq_PrivateDirBuffer,DSIZE+2 ; Used for keeping a record of which ; directory we have file names for. APTR frq_FileInfoBlock WORD frq_NumEntries WORD frq_NumHiddenEntries WORD frq_filestartnumber WORD frq_devicestartnumber LABEL frq_SIZEOFOH ; This is used with the RealTimeScroll function. STRUCTURE ScrollStruct,0 ULONG ss_TopEntryNumber ;This is the ordinal number of the first ;displayed entry. ULONG ss_NumEntries ;This is the total number of entries in ;the list. UWORD ss_LineSpacing ;This is how many pixels high each entry is. ULONG ss_NumLines ;This is how many entries can be displayed simultaneously. APTR ss_PropGadget ;This is a pointer to the prop gadget being monitored. APTR, ss_RedrawAll ;This routine is used to redraw all of the ;entries when the user moves far enough ;that scrolling will take too long. APTR ss_ReadMore ;An optional routine that is called when ;the scroll routine is waiting for movement. ;This allows reading of new data while real ;time scrolling. APTR ss_ScrollAndDraw ;This routine is called when the data needs ;to be scrolled and updated. This routine is ;passed four long parameters (on the stbback and ;in D0-D3) which are, respectively: ;D0 - entry number of first line to be drawn. ;D1 - pixel offset to draw first line at. ;D2 - amount to scroll before doing any drawing. ;D3 - number of lines of data to draw. WORD versionnumber ;Make SURE this is set to zero. LONG rfu1 ;Make SURE you leave these two zeroed also. LONG rfu2 ;Make SURE you leave these two zeroed also. LABEL ss_SIZEOF STRUCTURE Arrows,0 STRUCT ArrowUp,20 STRUCT ArrowDonbwn,20 STRUCT ArrowLeft,18 STRUCT ArrowRight,18 STRUCT Letter_R,20 STRUCT Letter_G,20 STRUCT Letter_B,20 STRUCT Letter_H,20 STRUCT Letter_S,20 STRUCT Letter_V,20 LABEL chipstuff_SIZEOF ; These are the positions relative to the rl_Images pointer. ;ie ; MOVE.L rl_Images(A6),A0 ; ADD.L #ArrowLeft,A0 ;A0 now points at the left arrow. STRUCTURE ReqLib,LIB_SIZE APTR rl_SysLib APTR rl_DosLib ;These must be kept in the same order, APTR rl_IntuiLib ;the library expunge code M}1G gl_minlimit LONG gl_maxlimit LONG gl_result APTR gl_window WORD gl_versionnumber; ;Make SURE this is set to zero. LONG gl_flags; ;Some, uh flags. See above for bit definitions. LONG gl_rfu2; ;Make SURE you leave these two zeroed also. LABEL gl_SIZEOF STRUCTURE GetStringStruct,0 APTR gs_titlebar APTR gs_stringbuffer APTR gs_window WORD gs_stringsize WORD gs_visiblesize WORD gs_versionnumber LONG gs_flags LONG gs_rfu1 LONG gs_rfu2 LONG gs_rfu3 LABEL gs_SIZEOF  Xؠ ; Remember, if you don't want to go through the hassle of ; initializing a ExtendedColorRequester structure, you can always just call ; ColorRequester (as opposed to ExtendedColorRequester). ColorRequester ; just takes a single parameter, in D0, the color that should start out ; being highlit. It returns a single value, the color that was selected at ; the end. ; This structure is for use with the ExtendedColorRequester (_not_, ; the ColorRequest ėger) function. STRUCTURE ExtendedColorRequesterStruct,0 LONG ecr_defcolor ;The color that is initially highlit. APTR ecr_window ;The window the 'requester' opens up in (zero normally). LONG ecr_rfu1 ;Who knows what these will be used for, LONG ecr_rfu2 ;but I'm sure we'll think of something. LONG ecr_rfu3 ;Until then, just keep these zeroed. LONG ecr_rfu4 ;Okay? LONG ecr_rfu5 LABEL ecr_SIZEOF IFND DSIZE DSIZE EQU 130 FCHARS EQU 30 ENDC WILDLENGTH EQU 30 FRQ ..SHOWINFOB EQU 0 ;Set this in Flags if you want .info files to show. They default to hidden. FRQEXTSELECTB EQU 1 ;Set this in Flags if you want extended select. Default is not. FRQCACHINGB EQU 2 ;Set this in Flags if you want directory caching. Default is not. FRQGETFONTSB EQU 3 ;Set this in Flags if you want a font requester rather than a file requester. FRQINFOGADGETB EQU 4 ;Set this in Flags if you want a hide-info files gadget. FRQHIDEWILDSB EQU 5 ;Set this in Flags if you DON' 2/%T want 'show' and 'hide' string gadgets. FRQABSOLUTEXYB EQU 6 ;Use absolute x,y positions rather than centering on mouse. FRQCACHEPURGEB EQU 7 ;Purge the cache whenever the directory date stamp changes if this is set. FRQNOHALFCACHEB EQU 8 ;Don't cache a directory unless it is completely read in when this is set. FRQNOSORTB EQU 9 ;Set this in Flags if you DON'T want sorted directories. FRQNODRAGB EQU 10 ;Set this in Flags if you DON'T want a drag bar and depth gadgets. FRQSAVINGB EQU ~6 11 ;Set this bit if you are selecting a file to save to. FRQLOADINGB EQU 12 ;Set this bit if you are selecting a file(s) to load from. ;These two bits (save and load) aren't currently used for ;anything, but they may be in the future, so you should ;remember to set them. Also, these bits make it easier if ;somebody wants to customize the file requester for their ;machine. They can make it behave differently for loading ;vs saving. FRQDIRONLYB EQU 13 ;Allow bthe user to select a directory, rather than a file. FRQSHOWINFOM EQU 1<