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

Live Home 3D Pro 3.6.2 - $49.99
Live Home 3D Pro is powerful yet intuitive home design software that lets you build the house of your dreams right on your Mac, iPhone or iPad. It has every feature of Live Home 3D, plus some... Read more
RapidWeaver 8.2 - Create template-based...
RapidWeaver is a next-generation Web design application to help you easily create professional-looking Web sites in minutes. No knowledge of complex code is required, RapidWeaver will take care of... Read more
Opera 60.0.3255.109 - High-performance W...
Opera is a fast and secure browser trusted by millions of users. With the intuitive interface, Speed Dial and visual bookmarks for organizing favorite sites, news feature with fresh, relevant content... Read more
DEVONthink Pro 3.0beta2 - Knowledge base...
DEVONthink Pro is your essential assistant for today's world, where almost everything is digital. From shopping receipts to important research papers, your life often fills your hard drive in the... Read more
Tunnelblick 3.7.9 - GUI for OpenVPN.
Tunnelblick is a free, open source graphic user interface for OpenVPN on OS X. It provides easy control of OpenVPN client and/or server connections. It comes as a ready-to-use application with all... Read more
Carbon Copy Cloner 5.1.9 - Easy-to-use b...
Carbon Copy Cloner backups are better than ordinary backups. Suppose the unthinkable happens while you're under deadline to finish a project: your Mac is unresponsive and all you hear is an ominous,... Read more
Dropbox 73.4.118 - Cloud backup and sync...
Dropbox is an application that creates a special Finder folder that automatically syncs online and between your computers. It allows you to both backup files and keeps them up-to-date between systems... Read more
Postbox 6.1.18 - Powerful and flexible e...
Postbox is a new email application that helps you organize your work life and get stuff done. It has all the elegance and simplicity of Apple Mail, but with more power and flexibility to manage even... Read more
Wireshark 3.0.2 - Network protocol analy...
Wireshark is one of the world's foremost network protocol analyzers, and is the standard in many parts of the industry. It is the continuation of a project that started in 1998. Hundreds of... Read more
BetterTouchTool 2.856 - Customize multi-...
BetterTouchTool adds many new, fully customizable gestures to the Magic Mouse, Multi-Touch MacBook trackpad, and Magic Trackpad. These gestures are customizable: Magic Mouse: Pinch in / out (zoom... Read more

AFK Arena guide - Everything you need to...
Ok, so if you're like me, you've been playing (and sometimes waiting) your way through AFK Arena, only to learn there's a lot more to it than there appears on the surface. There's guilds, a PvP arena, and all sorts of other systems and game modes... | Read more »
Explore an epic fantasy world in MMORPG...
Webzen have just announced the official launch date for its stunning MMORPG ‘MU Origin 2’ which will arrive for iOS and Android on May 28th. It will be the second spinoff from the classic PC-based MU Online, and it looks to further refine the... | Read more »
Solar Explorer: New Dawn guide - Tips an...
Solar Explorer: New Dawn is a lunar lander game that really ratchets the intensity up to 11. With all of the asteroids flying around as you fly around at seemingly breakneck speeds, it can be easy to feel overwhelmed bythe whole thing. | Read more »
The Dalaran Heist - How Hearthstone...
I am someone who wrote Hearthstone off a while ago. It was hard not to try and stick with it. The game has incredible production values and a core of really great talent working on the game continuously to keep it feeling fresh and fun (full... | Read more »
Steam Link App - Everything You Need to...
Steam Link has finally released for iOS! That’s right, you can play your epic backlog of PC games on the go now. Well… sort of. While the Steam Link app was announced seemingly ages ago, it only got actual approval for release last night. Check out... | Read more »
Pre-register now for endless superhero r...
Talking Tom Hero Dash is set to take the ever-popular Talking Tom and Friends franchise in a brand new direction as it opens pre-registration to players worldwide. Not only does it promise to be a beautifully rendered, fast-paced, action-packed... | Read more »
AFK Arena - Guild Wars guide
Ok, so if you're like me, you've been playing (and sometimes waiting) your way through AFK Arena, only to learn there's a lot more to it than there appears on the surface. There's guilds, a PvP arena, and all sorts of other systems and game modes... | Read more »
Superhero-themed Talking Tom Hero Dash i...
One of the exciting releases that we’re looking forward to is Talking Tom Hero Dash, an upcoming superhero-themed runner created by Outfit7. This new game is an action-packed endless runner that takes you on an epic adventure to assemble the... | Read more »
Kingdom Rush Vengeance Update Guide 2 -...
Kingdom Rush: Vengeance just got updated once again to add more content to the game. This addition, called The Frozen Nightmare, adds three new levels, five new enemies, two new heroes, and some new achievements. | Read more »
Save the world with SCIENCE in the upcom...
Previous versions of space colonization game TerraGenesis encouraged you to explore the galaxy and settle its planets. The eagerly-awaited 5.0 update will try to smash them to bits. Yep, with a new "world killers" setting, you can unleash... | Read more »

Price Scanner via MacPrices.net

12″ 1.2GHz MacBooks on sale for $999, $300 of...
Amazon has current-generation 12″ 1.2GHz Retina MacBooks on sale for $300 off Apple’s MSRP. Shipping is free: 12″ 1.2GHz Space Gray MacBook: $999.99 $300 off MSRP 12″ 1.2GHz Silver MacBook: $999.99 $... Read more
Here’s how to save $200 on Apple’s new 8-Core...
Apple has released details of their Education discount associated with the new 2019 15″ 6-Core and 8-Core MacBook Pros. Take $200 off the price of the new 8-Core model (now $2599) and $150 off the 15... Read more
Price drops! 2018 15″ 2.2GHz 6-Core MacBook P...
Amazon has dropped prices on clearance 2018 15″ 2.2GHz 6-Core Touch Bar MacBook Pros by $300 with models now available for $2099. These are the same models sold by Apple in their retail and online... Read more
Apple drops prices on 2018 13″ 2.3GHz Quad-Co...
Apple has dropped prices on Certified Refurbished 2018 13″ 2.3GHz 4-Core Touch Bar MacBook Pros with prices now starting at $1489. Apple’s one-year warranty is included, shipping is free, and each... Read more
Apple drops prices on 2018 Certified Refurbis...
Apple has dropped prices on clearance 2018 15″ 6-Core Touch Bar MacBook Pro, Certified Refurbished, with models available starting at only $1999. Each model features a new outer case, shipping is... Read more
Price drops! Clearance 2018 13″ Quad Core Mac...
Amazon has dropped prices on 2018 13″ Apple Quad-Core MacBook Pros with models now available for $250 off original MSRP. Shipping is free. Select Amazon as the seller, rather than a third-party, to... Read more
How Much Is ‘Solace’ Of Mind Worth When Buyin...
COMMENTARY: 05.22.19- Smartphone cases give us peace of mind by providing ample protection for such a fragile gadget and the sky’s the limit as far as choices go with a plethora of brands, styles,... Read more
Get a 13″ Touch Bar MacBook Pro for the lowes...
Apple has Certified Refurbished 2017 13″ 3.1GHz Dual-Core i5 Touch Bar MacBook Pros available starting at $1439, ranging up to $390 off original MSRP. Each MacBook features a new outer case, shipping... Read more
Apple adds new 15″ 8-Core MacBook Pro to line...
Apple has added a new 15″ MacBook Pro to its lineup featuring a 9th generation 2.3GHz 8-Core Intel i9 processor, 16GB of RAM, a 512GB SSD, and a Radeon Pro 560X with 4GB of GDDR5 memory for $2799.... Read more
21″ 2.3GHz iMac available for $999 at B&H...
B&H Photo has the 2018 21″ 2.3GHz Apple iMac on sale for $100 off MSRP. This is the same model offering by Apple in their retail and online stores. Shipping is free: – 21″ 2.3GHz iMac (MMQA2LL/A... Read more

Jobs Board

Best Buy *Apple* Computing Master - Best Bu...
**690427BR** **Job Title:** Best Buy Apple Computing Master **Job Category:** Sales **Location Number:** 000860-Charlottesville-Store **Job Description:** **What Read more
*Apple* Mobile Master - Best Buy (United Sta...
**696430BR** **Job Title:** Apple Mobile Master **Job Category:** Store Associates **Location Number:** 001012-Bismarck-Store **Job Description:** **What does a Best Read more
Manager - *Apple* Team - SHI International...
…opportunity available in the Hardware & Advanced Solutions Department as the Manager of the Apple Team The Manager must be familiar with all aspects of Apple Read more
Best Buy *Apple* Computing Master - Best Bu...
**696375BR** **Job Title:** Best Buy Apple Computing Master **Job Category:** Sales **Location Number:** 000203-North Austin-Store **Job Description:** **What does a Read more
Geek Squad *Apple* Master Consultation Agen...
**696286BR** **Job Title:** Geek Squad Apple Master Consultation Agent **Job Category:** Services/Installation/Repair **Location Number:** 000172-Rivergate-Store Read more
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.