TweetFollow Us on Twitter

TextEdit in Forth
Volume Number:1
Issue Number:7
Column Tag:Forth Forum

TextEdit

By Jörg Langowski

Through the set of routines called TextEdit, the toolbox provides the basic functions necessary for editing and formatting text: cutting, pasting, copying, inserting, deleting and scrolling within windows.

You are already familiar with all of the functions supported by TextEdit, since almost every application makes use of them, and selecting text with the mouse is one of the basic principles of the Macintosh user interface.

In this column we shall set up a simple TextEdit (TE) record in a window under MacForth and learn about some principles of TE.

TE basically forms an interface between an ASCII text and a GrafPort, the drawing environment of QuickDraw. Given the port in which to display the text and some other parameters, which I’ll soon explain, it will automatically draw the visible part of the text on the screen. TE then also responds to mouse action like clicking and dragging by moving the ‘insertion point’ (the blinking vertical line) and by highlighting the selected text correspondingly.

The GrafPort that we are drawing in generally is part of a window. Fig.1 reviews the structure of a window record as it is given in the Window Manager part of IM. As you can see, the GrafPort comprises the first and largest part of the window record. Most of the parameters important for drawing text and pictures are given there; however, a reference to an ASCII text record cannot be seen anywhere. This is correct; the standard convention is rather that the TE record contains a pointer to the GrafPort in which the text is to appear.

Fig. 2 shows the complete arrangement of a TE record.The text to be edited is referred to by the handle hText.TE displays this text in the destination rectangle; the drawing is clipped to the view rectangle. Both rectangles are specified in the TE record and given in the coordinates of the grafPort. The text is displayed in word wrap mode, so that words are not split when new lines are started. The start positions of new lines are kept in the array lineStarts and are automatically adjusted when the text is redrawn in a different destination rectangle.

The standard way to use a TE record is first to obtain a handle to a new record from the system. The toolbox trap that does this is TENew, which needs the destination and view rectangles on the stack (two 8-byte items) and returns a handle to a TE record within the current grafPort. MacForth calls this trap through the built-in compiling word TEXT.FIELD, which creates a dictionary entry that contains the TE handle as well as the current window that this particular TE record resides in. TEXT.FIELD is defined as follows:

: text.field  ( destRect\viewRect\windowPtr -- )
       create  get.window >r  window 
                   tenew  ,   get.window  ,   r>  window  ;

Now take a look at the sample program (Listing 1). Here we define a window at the very beginning with the additional attribute TEXT.RECORD, which sets a flag indicating that there is a TE record in this window. The actual setup of the TE record happens close to the end of the program text, where we get the address of the content area rectangle (+WCBOUNDS) and use it both as destination and view rectangle (since we want to see everything we are typing into the window).

The new variable TEST.TEXT can now be used to store the TE record handle in the refCon field of the window record; this field is kept free for use by the application, and MacForth expects the current TE handle here.

TextEdit Procedures

The important toolbox procedures that process TE records are TEClick, TEKey, TECut, TECopy, TEPaste, and some others (which are also described in IM).

Calling these procedures is somewhat simpler under MacForth than described in IM. The toolbox traps normally expect a TE handle on top of the stack. MacForth assumes that you want to edit text in the currently active window and therefore gets the TE handle that was stored in the refCon field. TE requests under MacForth are handled through the F line trap dispatcher (see V1,No.3; Fig.1 on p.24). The TE trap handler jumps to a self-modifying piece of code (similar to the OS trap handler) that gets the TE handle first and puts it on top of the stack, then executes the trap. Fig. 3 shows this piece of code.

MOVE.L  (SP),A1  ;trap word -> A1
MOVE.L  (A5),A0  ;QD globals ptr -> A0
MOVE.L  (A0),A0  ;active port ptr -> A0
MOVE.L  $98(A0),(SP) ;put TE handle-> stk  
MOVE  (A1),$32FE(A4) ;put trap word
AXXX  <--------------   ;right here !
JMP(A4) ;and jump to NEXT

Fig.3: Trap Handler for TE Routines

The activate routine of the example window first calls TEACTIVATE, which highlights the selection range in the TE record or displays the caret (vertical line) at the text insertion point. Then the routine drops into the usual event loop. Three kinds of events are handled explicitly: mouse down, window resizing and keyboard events. Furthermore, the event loop periodically calls the routine TEIDLE, which blinks the caret. If a key down event is recognized, TEKEY is called, which inserts the character on top of the stack into the TE record at the insertion point. A mouse down event inside the editing window calls the Forth word TEXT.CLICK, which is an interface to the TEClick trap and automatically handles selecting and highlighting a piece of text.

Resizing The Window - TEUpdate

When the window is resized, we want to change the appearance of the edited text so that all of it is still visible. Therefore, we have to reset the view and destination rectangles in the TE record, using the resized window’s new content area. RECALC in our example does this; it first moves the rectangle data from the window to the TE record and then calls TECALTEXT, which recalculates the line beginnings. The whole content area of the new window is then erased and marked invalid (requiring an update) so that TEXT.UPDATE, when called, will redraw the text correctly. (You may try and see what happens if you don’t erase the window before updating or if you do not set the content area invalid).

Scrolling Text Inside The Window

Just with the routines described so far, any text that is bigger than what the window can hold will disappear beyond the bottom of the window. Of course, we want to be able to scroll within our text so that we can see it all. I have added a vertical scroll bar to our window, and the event loop contains the necessary procedures to handle scrolling. The range of the scroll bar is fixed to 0 1000, corresponding to a display range of 1000 pixels. If you ever want to make a full-fledged editor out of this example, you will probably want to adjust the control range to reflect the actual size of the text. Up and down buttons scroll by 10 pixels, page areas by 100 pixels each. The scrolling is done by TESCROLL, which scrolls the text horizontally and vertically by a relative amount, and the application itself has to keep track of the absolute position within the text. After resizing, the text starts at the beginning again, and the scroll bar is reset to zero.

Cutting, Copying, Pasting

The menu TE.MENU handles cut/paste within our text record. It does not cut/paste correctly to and from other applications, since I did not add anything to handle the scrap. The MacForth handbook gives a short description of the scrap handling words, and I’ll explain the scrap in a later column. Nevertheless, cutting and pasting within the example window can be done in a very simple way by calls to the TE routines TECUT, TECOPY, and TEPASTE, which do exactly what you expect from their names.

You see that the example program really forms a ‘mini-editor’; if you add a routine to save/read a disk file, you have a complete small editor program.

Vectored Execution: The DOER/MAKE Pair

Those of you who read the excellent book Thinking FORTH by Leo Brodie, might have noticed the DOER/MAKE routines for vectored execution near the end of the book. They might also have noticed that none of them work under MacForth (I know of at least one reader who has).

DOER is a defining word that creates a dictionary entry with a vector address in its parameter field. When a word defined by DOER is executed, it will place this address on the return stack, then call EXIT and thus jump to the routine that the vector points to.

The word that changes the vector of a DOER word is called MAKE. Suppose you define:

   DOER TEST                 and
 : CHANGE  MAKE TEST .” Hi!” ;

then TEST will do nothing after the first definition, and will printout “Hi!” after CHANGE was executed. DOER/MAKE can therefore be used to dynamically change the execution behavior of FORTH code (something like a jump table in other languages).

The reason why Brodie’s examples do not work with MacForth is that MacForth does not store addresses of Forth routines in the threaded code, but tokens, which are addresses offset from a base pointer (register A4).

Therefore the only thing one has to do to make DOER/MAKE work correctly, is to insert a TOKEN>ADDR into the definition of (MAKE) given by Brodie, so that the address and not the token of the DOER word appears on the stack. Listing 2 gives the complete set of routines, modified so that they work on the Mac.

Remarks on MacModula-2

Shortly after I had sent off my first review of Modula-2 across the ocean, I received the new official release of the MacModula-2 system by Modula Corp. Enough has been changed (and improved) that another short comment is appropriate.

The first big surprise to me was the handbook. This manual is a master example in understatement; on every other page you can read that a detailed explanation of the toolbox is ‘beyond the scope of a 90 dollar product’, only to find out that almost everything is explained rather concisely a couple of pages later. The existing interfaces to the toolbox routines are collected into a set of modules that can be directly used on a 512K machine, or pasted into your program on a 128K system. Of course, some module names, the module numbers for external calling and the routine numbers within the modules have changed, so our example from the last issue won’t work as it is. However, it still works if you do the necessary changes.

All in all one can say that the MacModula-2 documentation almost is a mini-’Inside Macintosh’. When I work with Modula, I still have IM at hand, but I get most of the information about the routines (i.e. mainly how to call them) out of the Modula manual. Very convenient.

The benchmarks that I ran on the new version gave the same results as on the beta release; the speed of the interpreter does not seem to be changed. So you still can go get some coffee while a longer program is compiled, and since it is so easy to make errors in Modula, program development is still a rather lengthy process.

Rumor has it that the company that distributes MacModula-2 in Germany is working on a native code compiler for this system. Wouldn’t that be nice! I only hope that they don’t forget to re-compile the Compiler and Linker from M-code to native code to speed up things a little. The annual Hannover fair starts in a few weeks, and I hope they will show up there so that I can give you some more information.

International ‘Compatibility’

One of the important features of the Mac is international compatibility, or at least that’s what Apple says. You are supposed to be able to modify applications to work under different languages, change keyboard configurations, to metri or non-metric, formatting on dates, etc. Well, in principle, yes After having worked with different Macs here in Germany, I have my objections.

Of course, I have a U.S. Mac and a U.S. keyboard. I also have some disks with the U.S. System and Finder files on them. Now, if you try to start up a system with a German (or other ‘international’) keyboard with the US disk, it will work fine at first. Try to type something, and you’ll find that 1) not only have the keys changed which are different on that particular keyboard (such as y and z on the German board, or ; and ö, [ and ü etc.), but 2) that the whole lower row of keys is shifted one position. Anytime you hit a ‘b’, the Mac will present you with an ‘n’ and so on. When you hit the return key, you get the backslash, to get return, you have to press the ‘#’ key. There are probably still more surprises, but this was already rather frustrating.

The next ‘feature’ (i.e. planned bug) that struck me as a little strange was that the designers of the Mac wanted to be 100% international and even changed the name of the Desktop file (which is invisible anyway) to the appropriate language. So it’s ‘Schreibtisch’ in German, and probably (I didn’t have the chance to find out) ‘bureau’ in French or ‘scrivania’ in Italian. Very cute. So what happens when you stick a U.S. disk into a system that has a German startup disk in it? Nothing, for a very long time up to several minutes. This is because the system looks for the ‘Schreibtisch’ but there is only a ‘Desktop’. So it assumes the ‘Schreibtisch’ has been destroyed and proceeds by pulling all the files out of their folders and organizing a new ‘Schreibtisch’. So if you had some 70-odd files on your disk, you have to straighten out the mess before you can continue working. Not mentioning that the keyboard gets messed up again as soon as you start an application from your U.S. disk. So much for the touted ‘international compatibility’ of the Mac. Apple probably hasn’t realized that people also exchange programs across country borders. Still I am very happy that I can type my ä-s, ö-s, ü-s and ß-s (and åæøçñã as well) without changing character ROMs.

Listing 1
( TE Test Window )
( © 032985 MacTutor by J. Langowski )
new.window te.window 
“ TETest Window “ te.window w.title
   50 50  300 400   te.window  w.bounds
   sys.window te.window w.behind
   close.box  scroll.up/down  +  text.record + size.box +   
   te.window w.attributes          te.window add.window

: text.update get.window terecord +tvisrect teupdate ;
: set.inval get.window +wcbounds dup
                                                    invalid.rect erase.rect 
;
: recalc get.window +wcbounds  get.window terecord
         over over 2  lmove  8+ 2  lmove
         tecaltext set.inval text.update
  get.window dup  +vbar @ 0 set.control  show.controls ;

( init display pointer ) variable textval  0 textval ! 

( redisplay after scroll ) : redisplay get.window dup
  show.controls  +vbar @ get.control dup 
  textval @ swap - 0 swap tescroll textval ! ;

( controls ) : do.control   @mouse.dn get.window
  find.control ?dup if case
      in.thumb of this.control @ @mouse track.control 
                        drop ( flag ) redisplay endof
      up.button of this.control @ dup get.control
               10 - set.control redisplay  endof
      down.button  of this.control @ dup get.control
               10 + set.control redisplay  endof
      page.up  of this.control @ dup get.control
               100 - set.control redisplay  endof
      page.down of this.control @ dup get.control
               100 + set.control redisplay  endof
             drop endcase  then   ;

( mouse handler ) : do.mouse  @mouse  get.window
  +wcbounds  ptinrect  if  text.click  else do.control  then  ;

: adjust.cursor  @mouse get.window +wcbounds ptinrect
       if  ibeam set.cursor   else  init.cursor then  ;

( main event loop ) : t.edit    teactivate
    begin  adjust.cursor  teidle  do.events
     case  mouse.down  of do.mouse endof
           in.size.box of wait.mouse.up drop recalc  endof
           ?keystroke if tekey then
     endcase  again   ;

( activate / deactivate window ) : text.activate
    if    te.window show.window  t.edit
    else  tedeactivate  then  ;

( setup edit field ) : text.edit  ( edit field -- )
    dup @ swap 4+ @ swap over +wrefcon !
    dup on.activate text.activate  dup on.update  text.update
    dup  terecord   0 over 72 + W!    1 swap 74 + W!
         ( auto new line & Geneva font )  ;

( set control range ) : set.scroll.range 
  te.window +vbar @ 0 1000 set.control.range ;

( create TE record in window ) 
te.window +wcbounds dup te.window  text.field  test.text
test.text  text.edit    set.scroll.range

( TextEdit menu definitions)  5 constant te.menu
    0  “ TextEdit”   te.menu  new.menu
    “ Cut;Copy;Paste”  te.menu append.items draw.menu.bar
: te.function  te.menu menu.selection:  0 hilite.menu
    case 1 of  tecut   endof   2 of  tecopy  endof
         3 of  tepaste endof  endcase  ;

te.function

Listing 2

( DOER/MAKE MacForth © MacTutor by J. Langowski ) 
: nothing  ;                                                    
: doer  create  ‘ nothing , does>  @  >r ;                      
variable marker                                                 
: (make)  r> dup 2+ dup 2+ swap w@ token>addr 2+ !                   
 w@ ?dup if >r then ;                                        
: make  state @ if ( compiling)                                 
     compile (make)  here marker !  0 w,                        
     else here  [compile] ‘ !                                   
     smudge [compile] ]  then ;  immediate                      
: ;and  compile exit  here marker @ w! ;  immediate             
: undo  ‘ nothing  [compile] ‘ ! ;

 

Community Search:
MacTech Search:

Software Updates via MacUpdate

Trend Micro 11.0.2062 - An essential sec...
Trend Micro Antivirus provides essential security for macOS with real-time malware detection and mitigation in an affordable solution with a simple, intuitive interface. However, be aware that more... Read more
Backblaze 7.0.2.490 - Online backup serv...
Backblaze is an online backup service designed from the ground-up for the Mac. With unlimited storage available for $6 per month, as well as a free 15-day trial, peace of mind is within reach with... Read more
Pro Video Formats 2.2.1 - Updates for pr...
Pro Video Formats includes support for the following professional video codecs: Apple Intermediate Codec Apple ProRes AVC-Intra 50 / 100 / 200 / 4:4:4 / LT AVC-LongG XAVC XF-AVC DVCPRO HD HDV XDCAM... Read more
Boom 3D 1.3.11 - $19.99
Boom 3D is a revolutionary app with 3D Surround Sound and phenomenally rich and intense audio that is realistic and works on any headphones. Features 3D surround sound Built-in audio player... Read more
Final Cut Pro 10.5.2 - Professional vide...
Redesigned from the ground up, Final Cut Pro combines revolutionary video editing with a powerful media organization and incredible performance to let you create at the speed of thought.... Read more
Chromium 89.0.4389.72 - Fast and stable...
Chromium is an open-source browser project that aims to build a safer, faster, and more stable way for all Internet users to experience the web. Version 89.0.4389.72: Complete list of changes can... Read more
iMovie 10.2.3 - Edit personal videos and...
With a streamlined design and intuitive editing features, iMovie lets you create Hollywood-style trailers and beautiful movies like never before. Browse your video library, share favorite moments,... Read more
OmniPlan 4.2.5 - Professional-grade proj...
With OmniPlan, you can create logical, manageable project plans with Gantt charts, schedules, summaries, milestones, and critical paths. Break down the tasks needed to make your project a success,... Read more
Compressor 4.5.2 - Adds power and flexib...
Compressor adds power and flexibility to Final Cut Pro X export. Customize output settings, work faster with distributed encoding, and tap into a comprehensive set of delivery features. Features:... Read more
Motion 5.5.1 - Create and customize Fina...
Motion is designed for video editors, Motion 5 lets you customize Final Cut Pro titles, transitions, and effects. Or create your own dazzling animations in 2D or 3D space, with real-time feedback as... Read more

Latest Forum Discussions

See All

Frogger in Toy Town's latest update...
Konami Digital Entertainment has announced today that their Apple Arcade title Frogger in Toy Town has been updated to introduce a new ranked Endurance Mode. This new game variant's arrival is also accompanied by a few other changes. [Read more] | Read more »
Mitoza is surreal adventure toy you can...
The folks behind the Rusty Lake games have just put a new title onto the App Store. Second Maze, Rusty Lake's collaborative publishing brand, has just brought this 10 year old adventure game from Gal Mamalya to mobile. The best part about all of... | Read more »
Pocket Gamer Awards 2021: You have five...
Three weeks ago our sister site, Pocket Gamer, entered the voting stage for the upcoming Pocket Gamer Awards 2021 and is now in the final stretch. You only have a few hours left to vote for the games you’ve enjoyed on mobile in the past year, as... | Read more »
Patty Stack is a casual arcade game, ava...
Patty Stack is a casual arcade title that's available now for iOS and Android. It's the debut game from developer Feeka Games tasks players with making an increasingly giant burger tower. Think of it as Tower Bloxx but more edible. [Read more] | Read more »
Distract Yourself With These Great Mobil...
There’s a lot going on right now, and I don’t really feel like trying to write some kind of pithy intro for it. All I’ll say is lots of people have been coming together and helping each other in small ways, and I’m choosing to focus on that as I... | Read more »
Genshin Impact Guide - Gacha Strategy: W...
This is part 2 of our Genshin Impact gacha strategy guides. See part 1 here. You can check out more guides for Genshin Impact here. | Read more »
Slashy Camp is a new endless runner insp...
Blue Wizard Digital has released Slashy Camp onto iOS and Android after it spent a short amount of time in early access. [Read more] | Read more »
Kinder World is a relaxing game about lo...
Lumi Interactive is releasing a game called Kinder World later this year on iOS and Android, which is all about looking after houseplants. [Read more] | Read more »
Steam Link Spotlight - Fights in Tight S...
Steam Link Spotlight is a feature where we look at PC games that play exceptionally well using the Steam Link app. Our last entry was on Hades. Read about how it plays using Steam Link over here. | Read more »
Lyxo, the light-based puzzler for mobile...
Vienna-based independent game studio Emoak has just released its unique light-based puzzler for iOS and Android. Founded in 2014 by Tobias Sturn, the company is also the creative force behind the infinite climbing game Paper Climb, as well as the... | Read more »

Price Scanner via MacPrices.net

Weekend Sale: $100 off Apple iPad Magic Keybo...
Amazon has Apple iPad Magic Keyboards on sale for $100 off MSRP for a limited time. Amazon’s prices are the lowest available for iPad Magic Keyboard from any Apple reseller this weekend: – Magic... Read more
Gazelle now offering a full line of refurbish...
Gazelle is now offering a full range of discounted, refurbished, unlocked Apple iPhone 12 models starting at $649. iPhones are offered in Fair, Good, and Excellent conditions, and multiple colors are... Read more
These are the latest discounted iPhones Apple...
Apple has a range of Certified Refurbished iPhones available right now starting at only $339. Apple includes a standard one-year warranty, new outer shell, and shipping is free. According to Apple, “... Read more
Save up to $64 on new M1 MacBook Airs at Expe...
Apple reseller Expercom has 2020 13″ M1 MacBook Airs on sale for $51-$64 off Apple’s MSRP with prices starting at $947.96. In addition to their MacBook Air sale prices, take $50 off AppleCare+ when... Read more
Discounts available on 16″ MacBook Pros with...
Upgrade a 16″ 6-Core or 8-Core MacBook Pro from 16GB of standard RAM to 32GB at Adorama, and save $100-$210 over Apple’s price for this custom option: – 16″ 6-Core MacBook Pro/32GB RAM: $2699, save $... Read more
10.9″ iPad Airs on sale for $50-$70 off Apple...
Amazon has new 2020 10.9″ Apple WiFi iPad Airs in stock and on sale today for up to $70 off MSRP with prices starting at $549. Note that Amazon’s sale price might be restricted to certain colors (see... Read more
Apple restocks 2020 27″ 5K iMacs for up to $3...
After an initial offering in January, Apple has restocked a full line of Certified Refurbished 2020 27″ 5K iMacs starting at $1529 and up to $350 off original MSRP. Apple’s one-year warranty is... Read more
Sale! 16″ 8-Core MacBook Pro for $2449, $350...
Apple reseller Adorama has the 16″ 2.3GHz 8-Core Space Gray MacBook Pro in stock and on sale today for $2449 including free shipping. Their price is $350 off Apple’s MSRP for this model, and it’s the... Read more
Roundup of 13″ Multi-Core Intel MacBook Pro s...
Apple resellers are offering significant sales & deals this week on 2020 13″ MacBook Pros with 10th generation Intel CPUs. Take up to $250 off Apple’s MSRP, get free fast shipping, and/or pay no... Read more
64GB iPhone 8 Plus available for $379 at Appl...
Apple has the 64GB iPhone 8 Plus in Space Gray & Gold colors available for $379 today, Certified Refurbished. Each phone is unlocked and comes with Apple’s standard 1-year warranty and free... Read more

Jobs Board

Geek Squad Advanced Repair *Apple* Professi...
**795178BR** **Job Title:** Geek Squad Advanced Repair Apple Professional **Job Category:** Store Associates **Store Number or Department:** 001406-Allen Park-Store Read more
Geek Squad *Apple* Consultation Professiona...
**796549BR** **Job Title:** Geek Squad Apple Consultation Professional **Job Category:** Store Associates **Store Number or Department:** 001800-Hot Springs-Store Read more
*Apple* Mobility Specialist - Best Buy (Unit...
**796014BR** **Job Title:** Apple Mobility Specialist **Job Category:** Store Associates **Store Number or Department:** 001776-Woodmore Towne Centre-Store **Job Read more
Systems Architect, *Apple* Production Engin...
…package beginning on your first day? If so, we hope you'll keep reading! The Apple Sales Engineering and account team is looking for a stellar presales engineer with Read more
Systems Engineer, Webscale, *Apple* Retail,...
…beginning on your first day? If so, we hope you'll keep reading! The Apple Sales Engineering team is looking for a pre-sales engineer with Enterprise engineering Read more
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.