TweetFollow Us on Twitter

Eject the Disk
Volume Number:1
Issue Number:12
Column Tag:Basic School

Building A Library Routine To Eject The Disk

By Dave Kelly, Hybrids Engineer, MacTutor Editorial Board

This months BASIC column features some of the ins and outs of installing your own 68000 code to your MS BASIC programs. The potential power that this provides is mind boggling. With just a few lines of code you can access some of the other ROM routines that are not provided with MS BASIC 2.0.

First off, if you are not already familiar with the Apple Macintosh 68000 Development System then I suggest that you read through the manual to become familiar with the system. In MacTutor Vol. 1 No. 1 the Assembly Language Lab column provides an overview of the MDS system that will be useful for our discussion in this column. It is not necessary that you know 68000 assembly to enter and compile the BASIC Library we will be installing. I will try to lead you through step by step from the point of view of someone that is not very familiar with the MDS system.

Now before we get into the thick of things we will discuss the BASIC LIBRARY statement. The LIBRARY command is a BASIC reserved word but there is no description of it in the BASIC manual other than a brief mention of it on page 103. This page also refers to some special documentation entitled "Microsoft BASIC for the Macintosh -- Building Machine Language Libraries" (hereafter abbreviated as BMLL) which is available by contacting the Microsoft Consumer Response Department. The BMLL document has all the necessary information required to set up your own machine language library and includes 3 sample libraries: CopyFile, PrintArgs, and AddStrings.

A BASIC Library is a Macintosh resource with one or more named CODE segments. Refer to the Inside Macintosh Programmer's Guide section for the definition of the file structure of a resource file. Other sections of Inside Macintosh will be useful in setting up your own routines.

To open a library file you use the statement LIBRARY <filename string expression>. Up to 5 library files may be opened at the same time. When the Library file is opened BASIC calls the routine LIBinit which must exist in each file. The purpose of LIBinit is to allow a way for you to inform BASIC of the compatability of your library routine with the version of BASIC being used. If the library routine is incompatible or the LIBinit routine does not exist or the handshake with that routine fails, then the library is closed and an "Illegal function call" error is generated. This statement can result in other errors which are described in BMLL.

Once the library has been opened the routines within the library may be called by BASIC with the BASIC statements: <routine name> [argument-list] or by CALL <routine name> [(argument-list)]. More on the CALL statement may be found in your BASIC manual starting on page 101.

Constructing a library resource for BASIC

A library is detatched from BASIC whenever NEW, SYSTEM, RUN, or LIBRARY CLOSE is executed. To close the library, BASIC looks for the routine called LIBterm if present and executes it. The routine LIBterm should release any memory which was allocated from the heap, and close any files which were opened by routines in the library. Unless you need to allocate or deallocate memory you probably won't need to use LIBterm.

A sample source file for LIBinit is given with BMLL, but you'll have to work out your own LIBterm if needed depending on the routine you are writing. The sample LIBinit file demonstrates how the routine can check the BASIC version and see if it is compatible with the routines in the library. This sample checks to see that the binary version of BASIC is being used and tells BASIC if it is not compatible. Also included is an equate file named BASIC.D which defines entry points in BASIC which you should use to communicate with BASIC. For my sample library I have included all applicable equates in my source listing so the equate file will not be needed. You will want to use these routines to allocate memory and read the variable argument lists in the BASIC CALL statement. It is advisable that you obtain BMLL before writing your own routines as there are alot of useful routines that can be used that are part of BASIC. BMLL explains what each routine does and what registers are effected.

Alright, now we'll get right down to business. First we need to create several files with the MDS editor which are to be used by the assembler, linker and resource compiler. The two code segments that we want to create are listed below and should be saved with the file names shown. The LIBinit routine will be installed as the first segment and our routine called Eject will be the second segment. Eject will allow you to eject either the internal or external disk from within your program (under BASIC control). Type in the two routines then save them to disk.

Save this routine as "LIBinit.asm".

;
; LIBinit ROUTINE
;Sample version of LIBinit routine
;
;  REGISTER INFORMATION
;
;  A0 = pointer to a version record containing:
;     2 bytes = version of Basic interpreter (ie 2 for 2.01)
;  2 bytes = revision number of Basic interpreter (01)
;  2 bytes = 0 if decimal math, 1 if IEEE binary format
;2 bytes = compatibility variable of this routine to Basic:
;0 = compatible
;-1= incompatible
;8 bytes = reserved array of four INTEGER values
;
; A4 = pointer to a handle (long word) owned by this library
;Use this as a handle to a static data segment.
; A5 = pointer to the base of the application jump table
; D0 = 0 on exit if this routine is purgeable.

LIBVER_Result  EQU 6 ;offset to version record field
 ;for compatibility. (See above)
 
LIBinit:
 CLR.W  LIBVER_Result(A0)       ;assume compatible 
LIBinitExit:
 MOVEQ  #0,D0
 RTS

Here is the Eject Library source code. Save this file as "Eject.asm".

; BASIC Eject Library Source Code
; By Dave Kelly
; MacTutor 1985

;Synopsis:
;CALL Eject ( VolRefNum )
;Output:
;The specified disk is ejected (not dismounted) from
;the selected drive where VolRefNum may be 0 for the
;default drive, 1 for the internal drive, 2 for the
;external drive.

GetNextLibArg  EQU $2A    ; Basic Lib offset from A5
IntegerArgEQU  $32   ; Basic Lib offset from A5
BasicErrorEQU  $42 ; Basic Lib offset from A5

.TRAP _Eject$A000+23 ;toolbox  trap

Ejectdisk:
 BSR  GetIntegerVar;integer arg in [d3:w]
 CMP.W  #0,d3
 BEQ  Doit;branch if on 0 (default drive)
 CMP.W  #1,d3
 BEQ  Doit;branch if on 1 (internal drive)
 CMP.W  #2,d3
 BEQ  Doit;branch if on 2 (external drive)
UnknownVol:
 MOVEQ  #74,d2   ;Unknown Volume error
 JSR  BasicError(a5) 
Doit: 
 LEA  ParamBlock,a0;get pointer
 MOVE.W d3,22(a0);move drive # to ioVRefNum 
 _Eject 
 RTS  
GetIntegerVar:
 JSR  GetNextLibArg(a5) ;Get the next  ;argument
 JSR  IntegerArg(a5) ;[d3:w] = integer ;(error if arg can't be forced 
 ;into an integer
 RTS

;  local data area
 
ParamBlock:
 DC.L 0 ;ioLinkptr.
 DC.W 0 ;ioType
 DC.W 0 ;ioTrap
 DC.L 0 ;ioCmdAddr
 DC.L 0 ;ioCompletionptr.
 DC.W 0 ;ioResult
 DC.L 0 ;ioFileNameptr.
 DC.W 0 ;ioDrvNum (ioVRefNum)

 END

By the way, the Eject routine shows an example of using the file manager parameter block similar to what has been discussed in a few places in the last few MacTutor issues. Refer to those columns for more information. (ie Vol. 1 number 7 & 8)

Next we need to start a new MDS editor file to create a link file for the linker to use. The link shown below should be typed in and saved as "EjectLib.link". Note that if you are not using the default (startup) disk to save these files, the volume name must also be included with the filename.

;Eject Library Link
;MacTutor 1985

/OUTPUT EjectLib
LIBinit.Rel
<
Eject.Rel
$

Now create one last editor file for the Resource compiler. This file creates the resource file that BASIC will call to use the library. Be sure that each line (including the last one) has a carriage return at the end of the line or all the resources may not be compiled. Save this file as "EjectLib.R"

EjectLib.Rsrc
BLIB
TYPE CODE = GNRL
LIBinit,1
.R
EjectLib CODE 1

TYPE CODE = GNRL
Eject,2
.R
EjectLib CODE 2

Ok, we are now ready to assemble our code segments. Assemble LIBinit.asm and Eject.asm by selecting ASM from the MDS system transfer menu or by double clicking on the assembler if you are running the finder desktop. A standard file dialog box will appear and you can select each file and assemble them one at a time. Two new files containing the assembled code are stored on the disk, LIBinit.Rel and Eject.Rel. These two files will be used by the linker to create a linked application file. Select the LINK application from the transfer menu of the MDS system. Note you may have to push the cancel button from the dialog box to get to the transfer menu. The LINKER will create an application to be used by RMAKER. Don't try to run the EjectLib application as it will BOMB!! It only contains resource code segments and is not a regular application program. After linking, select RMAKER from the transfer menu and use the EjectLib.R file to create the resource file to be used by our BASIC library.

Figure 1 shows the files required and the flow of the above procedures. If you have any problems with this then I recommend that you study the MDS system manual and the BMLL supplement.

To try out the Eject Library routine, type in the Eject Demo program. To call the Eject routine, open the Eject Library and then use CALL Eject (VolRefNum). The VolRefNum is a number for the volume which you want to eject. A "0" will eject the disk in the default drive, a "1" will eject the internal drive and "2" will eject the external drive. For any other VolRefNum the file manager returns a unknown volume name error which could be trapped in your BASIC error trap routine if necessary. By the way, using ResEdit you can move the resource segments from the resource files into your BASIC program file (data file where your program is stored). Then the routine can be called by opening up the library with the filename the same as the program. The program would now be completely transportable as one file.

Installing the routines is the easy part. After trying out the demo routines in the BMLL supplement and the Eject routine your mouth may be watering for some more. Well next time we will take a look at some routines which have been prewritten to attach to your BASIC programs allowing access to over a hundred more ROM routines. They are available from a company called Clear Lake Research, 5353 Dora Street #7, Houston, Texas 77005 (1-800-835-2246 X199). If you've felt that BASIC just didn't have enough access to ROM routines then check this one out.

'Eject Library Demo
'By Dave Kelly
'MacTutor ©1985

'Note: EjectLib.Rsrc must be on default disk
'or you must specify vol name in Library statement
LIBRARY  "EjectLib.Rsrc"
'Set up menus
FOR i=1 TO 5
    MENU i,0,0,""
NEXT i
MENU 1,0,1,"File"
MENU 1,1,1,"Quit"
MENU 2,0,1,"Eject Disk"
MENU 2,1,1,"Eject Default Disk"
MENU 2,2,1,"Eject Internal Disk"
MENU 2,3,1,"Eject External Disk"

ON MENU GOSUB Menucheck:MENU ON
pause:GOTO pause

Menucheck:
    menunumber = MENU(0)
    menuitem=MENU(1):MENU
    IF menunumber = 1 THEN filemenu
    IF menunumber <>2 THEN RETURN
    IF menuitem = 1 THEN vol= 0
    IF menuitem = 2 THEN vol = 1
    IF menuitem = 3 THEN vol = 2
    CALL Eject (vol)
    RETURN
    
filemenu:
    IF menuitem <> 1 THEN RETURN
    MENU RESET:LIBRARY CLOSE:END

Thanks go to Robert Millis for sending us an improvement to the Cursor Editor routine in the August '85 issue. Due to editorial deadlines it is not possible to streamline all the code used in each issue for maximum efficiency. We do try to make sure that each and every program works. Keep in mind also that the code for most of the columns must be edited to fit properly. The programs are run before editing and placed on the source disks which you may order from us. We encourage you to modify and improve our programs. Please feel encouraged to send us any improvements that you have made so that our other readers may also benefit. The following code may replace the getpixel routine in the August Cursor Editor for improved speed and usability of the program:

getpixel: 'For Cursor Editor
    pixel%=256
    xp=MOUSE(1):yp=MOUSE(2)
    IF xp<20 OR xp>196 THEN RETURN
    IF yp<20 OR yp>196 THEN RETURN
    row=INT((yp-20)/11):col = INT((xp-20)/11)
    pixel%=row*16+(15-col)
    RETURN

It should be noted that the same routine was used in the September Paint Pattern Editor with some minor differences. Don't mix them up; they are different. The following code may replace the getpixel routine in Paint Pattern Editor:

getpixel: 'For Paint Pattern Editor
    pixel%=64
    xp=MOUSE(1):yp=MOUSE(2)
    IF xp<20 OR xp>108 THEN RETURN
    IF yp<20 OR yp>108 THEN RETURN
    row=INT((yp-20)/11):col = INT((xp-20)/11)
    pixel%=row*8+(7-col)
    RETURN
 

Community Search:
MacTech Search:

Software Updates via MacUpdate

calibre 2.17 - Complete e-library manage...
Calibre is a complete e-book library manager. Organize your collection, convert your books to multiple formats, and sync with all of your devices. Let Calibre be your multi-tasking digital librarian... Read more
OmniGraffle Pro 6.1.2 - Create diagrams,...
OmniGraffle Pro helps you draw beautiful diagrams, family trees, flow charts, org charts, layouts, and (mathematically speaking) any other directed or non-directed graphs. We've had people use... Read more
OmniGraffle 6.1.2 - Create diagrams, flo...
OmniGraffle helps you draw beautiful diagrams, family trees, flow charts, org charts, layouts, and (mathematically speaking) any other directed or non-directed graphs. We've had people use Graffle to... Read more
RoboForm 2.0.2 - Password manager; syncs...
RoboForm is a password manager that offers one-click login, mobile syncing, easy form filling, and reliable security. Password Manager. RoboForm remembers your passwords so you don't have to! Just... Read more
Apple MainStage 3.1 - Live performance t...
Love the sound you got on your recording? MainStage 3 makes it easy to bring all the same instruments and effects to the stage. Everything from the Sound Library and Smart Controls you're familiar... Read more
Freeway Pro 7.0.2 - Drag-and-drop Web de...
Freeway Pro lets you build websites with speed and precision... without writing a line of code! With its user-oriented drag-and-drop interface, Freeway Pro helps you piece together the website of... Read more
A Better Finder Rename 9.44 - File, phot...
A Better Finder Rename is the most complete renaming solution available on the market today. That's why, since 1996, tens of thousands of hobbyists, professionals and businesses depend on A Better... Read more
Stacks 2.6.9 - New way to create pages i...
Stacks is a new way to create pages in RapidWeaver. It's a plugin designed to combine drag-and-drop simplicity with the power of fluid layout. Features: Fluid Layout: Stacks lets you build pages... Read more
Sid Meier's Civilization: Beyond Ea...
Sid Meier's Civilization: Beyond Earth is a new science-fiction-themed entry into the award-winning Civilization series. Set in the future, global events have destabilized the world leading to a... Read more
Logic Pro X 10.1 - Music creation and au...
Apple Logic Pro X is the most advanced version of Logic ever. Sophisticated new tools for professional songwriting, editing, and mixing are built around a modern interface that's designed to get... Read more

Choice Provisions is Set to Launch Destr...
Choice Provisions is Set to Launch Destructamundo on iOS This Month Posted by Tre Lawrence on January 23rd, 2015 [ permalink ] Choice Provisions – home stable to | Read more »
King of Thieves – An Interview With Zept...
Ahead of the release of ZeptoLab’s King of Thieves, we were able to ask ZeptoLab’s co-founder, Semyon Voinov, a few questions about the inspiration behind the game and what that means for the Cut the Rope franchise. | Read more »
Handle Review
Handle Review By Jennifer Allen on January 23rd, 2015 Our Rating: :: SPEEDY ORGANIZINGUniversal App - Designed for iPhone and iPad Handle is a very convenient way of juggling your emails, To Do list, and Calendar all through one... | Read more »
The New Disney Inquizitive App Offers a...
The New Disney Inquizitive App Offers a Place for Fans to Take Disney Quizzes Posted by Tre Lawrence on January 23rd, 2015 [ permalink ] | Read more »
Hands-On With Cut the Rope Developer Zep...
Marking quite a departure from ZeptoLab’s past successes, namely the Cut The Rope series, King of Thieves is shaping up to be quite promising. Due for release in February, we were lucky enough to have some time with a preview build to see exactly... | Read more »
Fast Fishing Review
Fast Fishing Review By Jennifer Allen on January 23rd, 2015 Our Rating: :: LIVES UP TO ITS NAMEUniversal App - Designed for iPhone and iPad Fishing is far from relaxing in Fast Fishing, but it is fun.   | Read more »
Head Back to Dark World of Arnashia in B...
Head Back to Dark World of Arnashia in Blood Brothers 2 Posted by Jessica Fisher on January 23rd, 2015 [ permalink ] Universal App - Designed for iPhone and iPad | Read more »
Saved Review
Saved Review By Jennifer Allen on January 23rd, 2015 Our Rating: :: SIMPLE BUDGETINGiPhone App - Designed for the iPhone, compatible with the iPad Saved is a convenient and speedy way of adding expenses and keeping track of your... | Read more »
Wooga Announces Agent Alice, a New Hidde...
Wooga Announces Agent Alice, a New Hidden Object Game Posted by Jessica Fisher on January 23rd, 2015 [ permalink ] Wooga, makers of | Read more »
One Tap Desert Hero Review
One Tap Desert Hero Review By Campbell Bird on January 23rd, 2015 Our Rating: :: DRY GAMEPLAYiPhone App - Designed for the iPhone, compatible with the iPad This one-touch arcade game uses random elements and unlocks to try to keep... | Read more »

Price Scanner via MacPrices.net

College Student Deals are back, additional $5...
Take an additional $50 off all MacBooks and iMacs at Best Buy Online with their College Students Deals Savings, valid through April 11, 2015. Anyone with a valid .EDU email address can take advantage... Read more
iPhone 6 and 6 Plus GIve Apple Half Of US Mob...
Chicago-based Consumer Intelligence Research Partners, LLC (CIRP) have released analysis of the results of its research on mobile phone manufacturers for the calendar quarter that ended December 31,... Read more
Save $100 on MacBook Airs with 256GB of stora...
B&H Photo has 256GB MacBook Airs on sale for $100 off MSRP. Shipping is free, and B&H charges NY sales tax only: - 11″ 1.4GHz/256GB MacBook Air: $999 $100 off MSRP - 13″ 1.4GHz/256GB MacBook... Read more
21-inch 2.7GHz iMac on sale for $1179, save $...
B&H Photo has the 21″ 2.7GHz iMac on sale for $1179 including free shipping plus NY sales tax only. Their price is $120 off MSRP, and it’s the lowest price available for this model from any... Read more
iPhone Usage Rates by State Correlate With Ed...
Chitika Insights notes that despite iPhones being the largest source of smartphone Internet traffic in North America, their latest study finds a relatively high degree of variation of iPhone usage... Read more
ProGearX Extendable Pole “Pov/Selfie Stick” M...
There’s something inescapably narcissistic about the concept of selfies as they’ve developed as a smartphone-driven social (particularly social media) phenomenon that rubs me the wrong way. However,... Read more
iPad Air 2 on sale for up to $100 off MSRP, 2...
 Best Buy has iPad Air 2s on sale for up to $100 off MSRP on their online store for the next two days. Choose free shipping or free local store pickup (if available). Sale prices available for online... Read more
Roundup of Apple refurbished MacBook Pros and...
The Apple Store has Apple Certified Refurbished 2014 MacBook Pros and MacBook Airs available for up to $400 off the cost of new models. An Apple one-year warranty is included with each model, and... Read more
Sale! 13-inch 2.8GHz Retina MacBook Pro for $...
 B&H Photo has the 13″ 2.8GHz Retina MacBook Pro on sale for $1599 including free shipping plus NY sales tax only. Their price is $200 off MSRP, and it’s the lowest price available for this model... Read more
Next OS X/iOS Version Upgrades Should Concent...
On stage at Apple’s World Wide Developers’ Conference in June 2009, Bertrand Serlet, the company’s Senior Vice President of Software Engineering at the time, announced that the forthcoming OS X... Read more

Jobs Board

*Apple* Acura/Subaru Service Technicians - A...
Apple Automotive is one of the fastest growing dealer…and it shows. Consider making the switch to the Apple Automotive Group today! At Apple Automotive , Read more
Business Development Manager - *Apple* Pay...
**Job Summary** Apple Pay is seeking an experienced business development manager to support the identification, recruitment, negotiation and ongoing management of Read more
*Apple* Solutions Consultant (ASC)- Retail S...
**Job Summary** The ASC is an Apple employee who serves as an Apple brand ambassador and influencer in a Reseller's store. The ASC's role is to grow Apple Read more
*Apple* Solutions Consultant - Retail Sales...
**Job Summary** As an Apple Solutions Consultant (ASC) you are the link between our customers and our products. Your role is to drive the Apple business in a retail Read more
*Apple* Lead Operator, GSOC - Apple (United...
**Job Summary** Apple is seeking an exceptional, customer service oriented and experienced persons to fulfill the role of Apple Lead Operator (ALO) as part of the Read more
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.