TweetFollow Us on Twitter

PICT to RMaker
Volume Number:3
Issue Number:5
Column Tag:Toolbox Techniques

PICT to RMaker Source in MacForth

ArticleSubhead

By Larry Tannenbaum, Long Beach, CA

This program illustrates calling traps, using dialog boxes, the desk scrap, and the memory manager from MacFORTH. It takes a picture from the clipboard and converts it to RMaker resource format. The converted picture is put back into the desk scrap, so you can paste it into your resource file, using MockWrite or other editor.

Dialog boxes make programs more Mac-like and more "attractive", but they can be a bit tricky in MacFORTH. The reason is that the MacFORTH window always executes an ABORT when it is activated, and it is always activated when the dialog box is erased, if it was active before the dialog was drawn (To see what else is done when the MacFORTH window is activated, try SYS.WINDOW +ON.ACTIVATE W@. Use the forth decompiler from MacTutor Vol 1,#2 to decompile this token). For example, you start your program that calls a modal dialog box by typing the highest-level word in the MacFORTH window. When the dialog box is drawn in front, the MacFORTH window is de-activated. When the dialog is disposed of, the MacFORTH window is automatically activated and your program is aborted. This program works because all processing is done, before the dialog box is disposed of.

A couple of words in the program are from Thinking Forth:

: \  >IN @ 3C0 AND C/L + >IN ! ;  IMMEDIATE  (skips rest of line)
: ASCII  BL WORD 1+ C@ COMPILING IF [COMPILE] LITERAL THEN ;

IMMEDIATE  (leaves ascii value of following character on stack, or compiles 
it as a literal if used within a definition)

I also used one naming convention from Thinking Forth. Word names starting with "/" imply "bytes per", so /Row means bytes per row. I also tried to use descriptive names and ample comments. Forth can be hard to decipher, but doesn't have to be.

MacFORTH provides several pre-defined words for defining your own trap-calling words. What they do is compile machine code into your definitions that formats the stack for you, such as converting items that are supposed to be integers from the 32 bits that MacFORTH uses for everything, to 16 bits, or taking all of the arguments off the stack, reserving space for a returned result, then putting the arguments back on the stack. They also compile the trap code into the word.

Fig. 1 Pict to RMaker source Dialog Box

These pre-defined words are listed in table 1 along with the argument patterns they work for. Since the "FUNC" words must reserve space on the stack for a returned value underneath the arguments, they are for very specific cases only; the "MT" words are more general. For example, W>MT may be used with a trap that needs one 16-bit item on top of any number of 32-bit items, but W>FUNC>L must be used with a trap that takes one 16-bit argument only. If the trap you want to use doesn't fit any of these patterns, you must format the stack yourself and use MT for your definition.

Blocks 1 to 4 contain examples of calling traps from MacFORTH. The word WAdj, in Block 1, converts 32-bit items to 16 bits; it adds 2 to the stack pointer, essentially chopping off the two most significant bytes of the top stack item. I couldn't get OPEN.RSRC, supplied by MacFORTH 1.2 K2.3, to work, so I defined my own word, OpenRFile, to do the job. The 2nd line of code in block 2 is executed while the file is loading. It takes the name of the loading file as the resource file name. This way, if you rename the file, the resource fork will be opened properly without changing the code.

How do you get resources into a block's file? First, compile the resources with RMaker. The type and creator of the output file should be BLKS M4TH. Go to MacFORTH and open the new resource file with OPEN" rfilename". You have just opened the empty data fork of the file. Append enough blocks to it to hold the program (APPEND.BLOCKS). Either type in the program, or use XFER.BLOCKS (block 12 of Forth Blocks) to transfer it from another block's file. It's easier to use separate resource and blocks files, when developing a program. Finally, change the name of your completed file, because RMaker will delete it, if you recompile the resources.

I decided to use the desk scrap for the input and output of this program so that I could paste the picture resource into the middle of an existing file. It's also easy to select a portion of a picture with Paint Grabber or similar desk accessory and retrieve it from the desk scrap using GET.SCRAP.

Table 1: MacForth trap calling defining words

GET.SCRAP copies the scrap data to a handle that you pass to it. The handle is automatically sized, so it can be any length, including zero. You must also specify the type of data you are looking for. The most common types are text and pictures. Use the constant "TEXT or "PICT to designate the type you want. If the data in the scrap is different from the type you asked for, error code -102 is returned. An error code of zero indicates no error.

PUT.SCRAP works similarly. Give it the address and length of the data, and the data type. It will copy your data to the end of the desk scrap and return a result code.

ZERO.SCRAP deletes all data in the desk scrap and sets the scrap length to zero. You must execute ZERO.SCRAP before the first time you execute PUT.SCRAP, and before putting data into the scrap of the same type that is already there. This last restriction is necessary because GET.SCRAP always returns the first block of data of the type requested. If more than one chunk of data of a particular type is in the scrap, only the first one that was written is accessible.

Two other words help conserve memory: LOAD.SCRAP and UNLOAD.SCRAP. UNLOAD.SCRAP writes the desk scrap to the clipboard file on disk, releasing the memory used by the scrap. LOAD.SCRAP "knows" whether the scrap data is on disk or not and reads it into memory, if necessary. GET.SCRAP apparently will not get the data from the disk, even though Inside Macintosh says it will, so call LOAD.SCRAP first, if there is the possibility of it being in the clipboard file.

SCRAP.HANDLE returns the address where the handle to the desk scrap is stored. SCRAP.COUNTER returns the number of times the scrap has been zeroed since system start-up. According to Inside Macintosh, you can check to see if this value has changed during the operation of a desk accessory. If so, the accessory has probably put some data into the scrap.

SCRAP.LEN returns the address containing the length of the scrap data. This length includes 8 bytes for the scrap header. Sometimes the scrap is 8 bytes longer than the picture length, and sometimes it is 9 bytes longer. I suspect this has to do with whether the picture size is odd or even. The program needs the length of the picture. The easiest way to get it is from the first two bytes of the picture itself, so I don't use SCRAP.LEN. Block 8 contains the definitions using the scrap interface words.

Block 5 holds the memory manager interface definitions. Many programs in MacTutor have dealt with getting, releasing, resizing, locking, and unlocking handles, so I won't go into detail. The MacFORTH words that do these things have explicit names, except maybe FROM.HEAP, which gets a handle, and TO.HEAP, which releases one.

The program uses only one handle. GET.SCRAP copies the picture into it, then the handle is resized to hold the ascii. To avoid overwriting the data, the program starts converting from the end of the picture.

Blocks 9 and 10 contain the code that actually does the conversion. The constant /Row, in block 9, determines how many bytes of the picture are represented on each row of text. It can be changed to any convenient value.

Using this program, you can personalize your dialog and alert boxes, and keep the pictures in your source, rather than having to paste them in after compilation with ResEdit. The output format could also be changed to MDS or MacASM.

( Block 0    ***********Instructions*********** )

To use this program:
    1.  Cut or copy picture to be used as resource so it will
        be in the ClipBoard.
    2.  Load this file.
    3.  Execute Pict>Rsrc. The PICT in the clipboard
        will be converted to type TEXT in RMaker hex format.
    4.  Using MockWrite or other editor, paste the data from
        the clipboard into the RMaker file.

( Block #1   ***********Toolbox interface***********)

HEX

Create WAdj -2 Allot 548F { ADDQ.L #2,SP} W, 4ED4 W,

A997 L>FUNC>W <OpenRFile>        A99A W>MT <CloseRFile>
A97C MT <GetNewDlog>             A983 MT <DisposDlog>
A98D MT <GetDItem>               A991 MT <ModalDlog>
A990 MT <GetIText>               A98F MT <SetIText>
A95F MT <SetCTitle>              A95D W>MT <HiliteControl>
A987 MT <NoteAlert>

DECIMAL
    2 11 Thru

( Block #2   ******ToolBox InterfaceVariables*********)

Create   RFileName    30 Allot \ same name as this file
Block-File @ @File.Name    Dup C@ 1+ RFileName Swap CMove
Variable RFileRefNum           \ returned by OpenRFile
Variable DlogPtr               \ returned by GetNewDlog
Create   ItemHit 2 Allot       \ returned by ModalDlog
Create   ItemType 2 Allot      \ returned by GetDItem
Variable ItemHandle            \ returned by GetDItem
Create   ItemRect 8 Allot      \ returned by GetDItem
Create   Item$ 30 Allot        \ for manipulating text items
Create   Ok$ ," Done"          \ new title for control
1 Constant ConvertButton       \ compared to ItemHit when
                               \ ModalDlog returns

( Block #3    ***********Resource File/Alert***********)

: OpenRFile    RFileName <OpenRFile> Dup 0>
    If   RFileRefNum !
    Else Abort" Couldn't open resource file!" Then ;
: CloseRFile   RFileRefNum @ <CloseRFile> ;
: NoPictAlert  128 WAdj ( id) 0 ( filter proc) <NoteAlert> ;

( Block #4    ***********Dialog Interface***********)

: GetDlog    0 ( reserve stack space for returned dptr)
    128 WAdj ( id) 0 ( on heap) -1 ( in front)
    <GetNewDlog>    DlogPtr ! ;
: DisposeDlog  DlogPtr @ <DisposDlog> ;
: ModalDlog    0 ( filter proc) ItemHit <ModalDlog> ;
: GetDItem    ( item#)    DlogPtr @ Swap WAdj
    ItemType  ItemHandle ItemRect <GetDItem> ;
: GetIHandle  ( item#--handle)    GetDItem ItemHandle @ ;
: GetIText    ( $\item#)    GetIHandle Swap <GetIText> ;
: SetIText    ( item#)    GetIHandle Item$ <SetIText> ;
: Ok>Done  1  ( item#) GetIHandle Ok$ <SetCTitle> ;
: Can'tCancel 2 ( item#) GetIHandle 255 <HiliteControl> ;

( Block #5    ***********Memory Manager***********)

Variable DataH    \ holds handle to data

: GetH ( size--handle)    From.Heap Dup DataH ! Dup 0=
    If DisposeDlog CloseRFile
        1 Abort" Handle Allocation Error!" Then ;
: DataPtr ( --ad of data)    DataH @@ Mask.Handle ;
: /Data ( --data size in bytes)    DataH @ Handle.Size ;
: ResizeH ( new size--)    DataH @ Dup Rot Resize.Handle
        0< If   DisposeDlog CloseRFile
            1 Abort" Handle Resize Error!"
        Else Lock.Handle Then ;
: ReleaseH
   /Data 0< Not If DataH @ Dup Unlock.Handle To.Heap Then ;

( Block #6    ***********PICT Resource Header***********)

13 Constant CRet    \ ascii for carriage return
: AddCR ( ad--)     Count 1- +    CRet Swap C! ;
\ Asterisk in string is place holder for carriage return
Create Type$ ," TYPE PICT = GNRL*"  Type$ AddCR
Create Hex$  ," .H*"                Hex$  AddCR
Create Name$ 25 Allot
Create ID#$  10 Allot
: /Header ( --n)    Type$ C@ Hex$ C@ Name$ C@ ID#$ C@ + + + ;
: (Header>Text) ( ptr\$--updated ptr)
    Count >R Over R@ CMove R> + ;
: !Header    DataPtr            Type$ (Header>Text)
             Name$ (Header>Text) Id#$  (Header>Text)
             Hex$  (Header>Text) Drop ;

( Block #7    ***********Get/Set Dialog Items***********)

: Num>Str ( n)       <# #S #> Item$ 2Dup C!    1+ Swap Cmove ;
: AddChar ( $\char)  Over Count + C!    Dup C@ 1+ Swap C! ;
: SetPictSize        DataPtr W@ Num>Str 9 SetIText ;
: SetPictWidth
    DataPtr Dup 8+ W@ Swap 4+ W@ - Num>Str 11 SetIText ;
: SetPictHeight
    DataPtr Dup 6+ W@ Swap 2+ W@ - Num>Str 13 SetIText ;
: GetPictName    Name$ Dup 5 GetIText Ascii , AddChar ;
: GetPictID#     ID#$ Dup 7 GetIText CRet AddChar ;
: GetHeader      GetPictName    GetPictID# ;
: SetUpDlog
    GetDlog SetPictSize SetPictWidth SetPictHeight ModalDlog ;
: DoneDlog       Ok>Done Can'tCancel ModalDlog ;

( Block #8    ***********Desk Scrap Interface***********)

: ScrapErr? ( result code--)
    0< IF ReleaseH DisposeDlog CloseRfile
          1 Abort" Scrap Error!" Then ;
: /Pict ( --bytes)
    Scrap.Handle @ Dup 0< If Drop 0 Else @ 4+ @ Then ;
: PictFromScrap ( --result code)   Load.Scrap ScrapErr?
    /Pict GetH    "PICT Get.Scrap ;
: Text>Scrap    Zero.Scrap ScrapErr?
    DataPtr /Data "TEXT Put.Scrap ScrapErr?
    ReleaseH    Unload.Scrap ScrapErr? ;

( Block #9    ***********Picture conversion***********)

16 Constant /Row   \ 1 row of text represents 16 bytes of pict
: #CR'S ( pict size--# of CR's in text )
    /Row W/Mod Swap If 1+ Then ;
: /Text ( --text size) /Pict Dup 2* Swap #CR'S + /Header + ;
: PictEnd ( --ad)    DataPtr /Pict + 1- ;
: TextEnd ( --ad)    DataPtr /Text + 1- ;
    Create Char$ ," 123456789ABCDEF"    Ascii 0 Char$ C!
:  >Ascii ( nybble--char)    Char$ + C@ ;
: !Byte  ( ad\byte--new ad)    Dup>R 15 And >Ascii Over C! 1-
                               R> 16/    >Ascii Over C! 1- ;
: !Cr    ( ad--new ad)    CRet Over C! 1- ;

( Block #10   ***********Picture conversion***********)

Variable PictAd

: RowLimits ( #bytes--limit\index)
    PictAd @ Dup Rot - Dup PictAd ! 1+ Swap ;
: !Row    ( dest ad\#bytes--new dest ad)
    RowLimits Do IC@ !Byte -1 +Loop ;
: !Pict    PictEnd PictAd !    TextEnd
    1 /Pict Do !Cr   I /Row Min !Row  /Row Negate +Loop Drop ;
: Pict>Text    Watch Set.Cursor  GetHeader
        /Text ResizeH    !Pict !Header   Init.Cursor ;

( Block #11    ***********User Interface***********)

: Convert?    ItemHit W@ ConvertButton = If
    Pict>Text Text>Scrap DoneDlog Then ;
: ConvertPict    SetUpDlog Convert? DisposeDlog ;
: Pict>Rsrc      OpenRFile PictFromScrap
    0< If   NoPictAlert
       Else ConvertPict
       Then CloseRFile ;
 
AAPL
$101.66
Apple Inc.
+0.23
MSFT
$46.70
Microsoft Corpora
-0.31
GOOG
$575.62
Google Inc.
-5.73

MacTech Search:
Community Search:

Software Updates via MacUpdate

Screenshot Path 1.2.1 - Change the defau...
Screenshot Path lets you change the folder where OS X saves screenshots. Screenshots are saved by default to the user’s desktop. This is handy for the occasional screenshot but those looking to take... Read more
Fantastical 1.3.16 - Create calendar eve...
Fantastical is the Mac calendar you'll actually enjoy using. Creating an event with Fantastical is quick, easy, and fun: Open Fantastical with a single click or keystroke Type in your event details... Read more
GIMP 2.8.14 - Powerful, free image editi...
GIMP is a multi-platform photo manipulation tool. GIMP is an acronym for GNU Image Manipulation Program. The GIMP is suitable for a variety of image manipulation tasks, including photo retouching,... Read more
HoudahSpot 3.9.3 - Advanced front-end fo...
HoudahSpot is an advanced file search tool built upon MacOS X Spotlight. Spotlight unleashed Create detailed queries to locate the exact file you need Narrow down searches. Zero in on files Save... Read more
djay 4.2.3 - Transform your Mac into a f...
djay transforms your Mac into a full-fledged DJ system, allowing you to mix your iTunes music library on a hyper-realistic turntable interface. Perform live, record mixes on-the-go, or enable... Read more
iDefrag 2.2.8 - Disk defragmentation and...
iDefrag helps defragment and optimize your disk for improved performance. Features include: Supports HFS and HFS+ (Mac OS Extended). Supports case sensitive and journaled filesystems. Supports... Read more
Bookends 12.2.3 - Reference management a...
Bookends is a full-featured bibliography/reference and information-management system for students and professionals. Access the power of Bookends directly from Mellel, Nisus Writer Pro, or MS Word (... Read more
Copy 1.47.0410 - Cloud storage and file...
Note: You must first sign up to use Copy (get a 5GB sign-up bonus through our 'Download' link above). Copy lets you sync, protect, and share. Everywhere. Want to bring some files home? No problem!... Read more
Stacks 2.6.3 - New way to create pages i...
Stacks is a new way to create pages in RapidWeaver: A plugin designed to combine drag-and-drop simplicity with the power of fluid layout. Features: Fluid Layout: Stacks lets you build pages that... Read more
RestoreMeNot 2.0 - Disable window restor...
RestoreMeNot provides a simple way to disable the window restoration for individual applications so that you can fine-tune this behavior to suit your needs. Please note that RestoreMeNot is designed... Read more

Latest Forum Discussions

See All

This Week at 148Apps: September 8-12, 20...
Expert App Reviewers   So little time and so very many apps. What’s a poor iOS devotee to do? Fortunately, 148Apps is here to give you the rundown on the latest and greatest releases. And we even have a tremendous back catalog of reviews; just check... | Read more »
Rejoice, Kittens! Kitty Powers’ Matchmak...
Rejoice, Kittens! | Read more »
Upcoming Digital Board Game SettleForge...
Upcoming Digital Board Game SettleForge is Headed to iOS Posted by Jessica Fisher on September 12th, 2014 [ permalink ] SettleForge is a single-player board game where players take on the role of the king as they try to | Read more »
Air Supply SOS Set to Bring Retro Sheep...
Air Supply SOS Set to Bring Retro Sheep Rescuing to iOS Soon Posted by Ellis Spice on September 12th, 2014 [ permalink ] Quantum Sheep has announced that the latest entry in the | Read more »
Star Wars: Commander Reveals Who is Winn...
Star Wars: Commander Reveals Who is Winning the Galactic Civil War Posted by Jessica Fisher on September 12th, 2014 [ permalink ] Disney Interactive has released a new infographic detailing the stat | Read more »
The New MOGA REBEL iOS Controller is Set...
The New MOGA REBEL iOS Controller is Set to Be Released on September 17 Posted by Jessica Fisher on September 12th, 2014 [ permalink ] MO | Read more »
Scuba Dupa Review
Scuba Dupa Review By Rob Thomas on September 12th, 2014 Our Rating: :: BUBBLE TROUBLEUniversal App - Designed for iPhone and iPad Scuba Dupa is cute and simple fun, but you’re going to have to part with a bit too much sunken... | Read more »
Get Ready for the iPhone 6 – Amazon Trad...
Get Ready for the iPhone 6 – Amazon Trade-in Program Locks in Used Gadget Prices Until October 10 Posted by Ellis Spice on September 12th, 2014 [ permalink ] | Read more »
Kings of the Realm Review
Kings of the Realm Review By Jennifer Allen on September 12th, 2014 Our Rating: :: STANDARD BASE BUILDINGUniversal App - Designed for iPhone and iPad Kings of the Realm offers some handy tweaks, but it’s still the familiar format... | Read more »
Five Nights at Freddy's (Games)
Five Nights at Freddy's 1.0 Device: iOS Universal Category: Games Price: $2.99, Version: 1.0 (iTunes) Description: | Read more »

Price Scanner via MacPrices.net

Save $75 on the 16GB iPad mini with Retina Di...
Best Buy has the 16GB iPad mini with Retina Display on sale for $324.99 on their online store for a limited time. Their price is $75 off MSRP, and it’s the lowest price available for this mini.... Read more
21-inch 1.4GHz iMac on sale for $979, $120 of...
B&H Photo has the new 21″ 1.4GHz iMac on sale for $979.99 including free shipping plus NY sales tax only. Their price is $120 off MSRP. B&H will also include free copies of Parallels Desktop... Read more
Apple restocks refurbished 21-inch 1.4GHz iMa...
The Apple Store has restocked Apple Certified Refurbished 21″ 1.4GHz iMacs for $929 including free shipping plus Apple’s standard one-year warranty. Their price is $170 off the cost of new models,... Read more
13-inch 2.6GHz/256GB Retina MacBook Pro on sa...
Adorama has the 13″ 2.6GHz/256GB Retina MacBook Pro on sale for $1379 including free shipping plus NY & NJ sales tax only. Their price is $120 off MSRP, and it’s the lowest price available for... Read more
Macally iPhone 6 Cases
Macally has introduced a Line of Snap-On Shell Cases, Frame Bumper Cases and a Rugged Protective Case for iPhone 6 with 4.7inch Screen, such as the SNAP case in a variety of brilliant metallic... Read more
Belkin Launches New Accessories iPhone 6 and...
Belkin has unveiled a new collection of products for iPhone 6 and iPhone Plus. Belkin’s new iPhone 6 and iPhone 6 Plus accessories include athletic-inspired armbands, classic phone cases and advanced... Read more
Skinit Debuts Customizable Apple iPhone 6 Cas...
Skinit, pioneer creators of protective personalized solutions for consumer electronic devices, has introduced its new collection of customizable Skinit cases and skins for the new Apple iPhone 6.... Read more
Apple refurbished MacBook Pros available for...
The Apple Store has Apple Certified Refurbished 13″ and 15″ MacBook Pros available starting at $929. Apple’s one-year warranty is standard, and shipping is free: - 13″ 2.5GHz MacBook Pros (4GB RAM/... Read more
Save $200 with Apple refurbished 27-inch Thun...
The Apple Store has Apple Certified Refurbished 27″ Thunderbolt Displays available for $799 including free shipping. That’s $200 off the cost of new models. Read more
Free $25 iTunes gift card with purchase of Ap...
The Apple Store is offering a free $25 iTunes Gift Card with the purchase of a $99 Apple TV for a limited time. Shipping is free. Read more

Jobs Board

*Apple* Retail - Multiple Positions (US) - A...
Sales Specialist - Retail Customer Service and Sales Transform Apple Store visitors into loyal Apple customers. When customers enter the store, you're also the Read more
*Apple* Retail - Multiple Positions (US) - A...
Sales Specialist - Retail Customer Service and Sales Transform Apple Store visitors into loyal Apple customers. When customers enter the store, you're also the Read more
*Apple* Retail - Multiple Positions (US) - A...
Sales Specialist - Retail Customer Service and Sales Transform Apple Store visitors into loyal Apple customers. When customers enter the store, you're also the Read more
*Apple* Retail - Multiple Positions (US) - A...
Sales Specialist - Retail Customer Service and Sales Transform Apple Store visitors into loyal Apple customers. When customers enter the store, you're also the Read more
*Apple* Retail - Multiple Positions (US) - A...
Sales Specialist - Retail Customer Service and Sales Transform Apple Store visitors into loyal Apple customers. When customers enter the store, you're also the Read more
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.