TweetFollow Us on Twitter

Terminal Emulation
Volume Number:2
Issue Number:3
Column Tag:Threaded Code: Neon

Scrap Support for Terminal Emulation

By Jörg Langowski, EMBL, c/o I.L.L., Grenoble, Cedex, France, MacTutor Editorial Board

"NQSD" terminal emulator

First, lets continue and finish the example from last month's NEON column by adding (finally!) the scrap support (You may remember that I promised to write something about scrap handling some time ago).

Actually, I have reworked the example somewhat. Neon supports a rudimentary form of multitasking which makes event handling a lot simpler, so I added that; then, of course, I promised to add support for serial I/O so that we would end up with a not-quite-so-dumb terminal program (not quite, since we will be able to do cutting/pasting and therefore capture text files). The 'finished' example (to be expanded and improved by you) is shown in Listing 1.

Scrap handling in NEON (and other Forths, for that matter)

Let's first look at the way the scrap can be passed around between applications. I will limit myself to text scrap only, since that's what our example is using.

The crucial point here is that the 'scrap' that TextEdit uses is internal to the TextEdit routines, so that it will not automatically become part of the clipboard after a TECut is executed. If you don't believe this, start up last month's example and open the Note Pad desk accessory. Cut or Copy some text from the TE window (using the TEmenu), click the notepad and then try to paste it (using ctrl-V, since the Edit menu has been lost). Nothing happens. Also, if you cut text from the notepad and try to paste it into the TEwindow, that won't work either.

This proves what you might have known already, namely that the desk scrap (contained in the Clipboard) does not have anything to do with the TE scrap, and that we need a set of routines that transfer text between those two kinds of scrap.

Refer to the listing. The magic numbers that we need are system globals, the length of the TE scrap at $AB0 and its handle at $AB4. The length of the desk scrap is maintained in $960.

Two routines transfer the scrap from TE to desk and vice versa. put.tescrap, as you might have guessed, takes the TE scrap and puts it into the clipboard. It uses the toolbox trap putscrap, which is a function that returns a 32-bit result code (0 if ok) and is called with the stack set up as follows:

- 0 for the return code

- a 32-bit integer giving the length of the data that goes into the scrap

- the resource type, 'TEXT' or 'PICT'

- a pointer to the beginning of the data.

We first check whether there is any text edit scrap available at all, and if it is, zero the desk scrap (=: clear the clipboard). Then the parameters for putscrap are set up, converting absolute addresses to NEON-relative (-base) and dereferencing handles where necessary. After exiting, the clipboard will contain a copy of the text edit scrap. The resource type constant 'TEXT'is contained in txtype, which is defined in FrontEnd.

get.tescrap does the opposite: if desk scrap is available, it will transfer it into the TE scrap by calling getscrap with the parameters:

- 0 to hold the return result (the total length in bytes)

- the handle to the TE scrap

- the resource type 'TEXT'

- the value variable theOffset, also defined in FrontEnd.

We assume that there is only TEXT type scrap in the clipboard, so theOffset (which tells you where in the clipboard the desired type of resource starts) won't interest us. After the call, the TE scrap will contain whatever TEXT scrap was in the clipboard.

put.tescrap and get.tescrap will now have to be built into the code that defines our editing window. put.tescrap is installed into the window's activate action vector. No vector is provided in NEON to handle deactivate events, therefore we redefine the disable: method for that window so that it includes get.tescrap.

You might now want to install just these changes into last month's example, then run the program and open the note pad. Now cutting text out of the note pad (using ctrl-X), clicking the edit window and pasting it there (using the TEmenu) should give the correct results. The opposite transfer should work, too.

In order to install the serial I/O support and simplify the whole application somewhat, we'll use the multitasking that is provided in the NEON source files. Let me first say some words about how multitasking can be achieved under NEON.

Multi-tasking the NEON way

The NEON system supports a simple form of 'concurrency' (contained in the file Tasks that is part of the NEON system). Tasks redefines the null event vector NULL-EVT in such a way that it sequentially executes a set of words that are contained in the Ordered-Col list tasklist (This feature is not described in the first release of the manual). To use the multitasking support simply type // tasks .

A new task is added to the tasklist by putting its cfa on the stack and calling addtask, it is removed again from the list by calling killtask with the task's cfa on the stack. So instead of redefining the event handler to include a call to TEIdle and cursor adjustment (as we did last time), we can simply define

: idle.text 
  idle: mytext adjust.cursor ;

and then put the cfa of this word into the task list by saying

'c idle.text addtask

This will make the caret blink and give the cursor the correct shape while the main event loop can be kept in the simple form given in the NEON manual

begin key makeint key: mytext again

where the makeint comes in because TEkey expects a 16-bit integer on the stack.

What is done here is not true multi-tasking, of course. Each word that is put into the task list is executed all the way to its end before the next 'task' becomes active. True multi-tasking would include some means to leave a word before it is finished, saving the task's parameters so that it may be resumed where it was left.

One way multi-tasking can be done, for example, is to issue interrupts at regular intervals (by some real-time clock or, in the Mac, through the vertical retrace), and on each interrupt switch tasks. At this point one would save a copy of the task's register status in an area local to that task and proceed to the next one. Another possibility is that the task itself calls the scheduler to switch to the next task at certain strategic points - like when a character is being output to the screen.

The way VBL tasks are handled in the Mac is an example of the first method [see also the article by Bob Denny in MacTutor V1#9]. The problem on the Mac is that the time allocated for a VBL task cannot be too long. All tasks within the VBL task queue must complete before the next vertical blanking interrupt comes in (which is 16.67 msec). Here again, there is no possibility to leave a task in the middle of execution and jump to another one.

An example for the other method (the task itself calls the scheduler, which activates the next task) is the way desk accessories are handled, because here you will call SystemTask from within your application each time you think the desk accessories should get something to eat. However, the DA's Control routine will have to execute all the way until it is finished - no interruption possible -, so in this case we have a master task (the application) which calls slave tasks (the desk accessories).

A full implementation of the second method of task scheduling has been achieved in a new Forth system - Mach1 - which has been advertised in this journal and which I am going to review in the next article. This system - under Forth - is almost as close as you can get to true multitasking on the Macintosh; watch for some new exciting information next month.

For the time being, we will have to stick to the constraints of the NEON multitasker, which means that words installed into the tasklist have to be short in execution because they will have to finish before the next task gets its turn. The idling routine is fast enough so that you don't notice any annoying delay.

Serial port handling

Another task that we will put into tasklist is a routine that will watch for characters to come in through the serial port and put them into the TE record wherever the insertion point is. Then we may - optionally - send the keystrokes not directly into the TE record, but to the serial output port and convert our editing example into a terminal emulator.

The listing shows how to do it. Serial port handling is contained in the NEON source file drvr and serial, so these will have to be loaded first. We define modin and modout for the serial input and output ports and initialize them to 8 data bits, 2 stop bits, no parity and 300 baud. (Yes, unfortunately this program will handle only 300 baud, because no handshake has been added yet. You may use it at any speed, but have to watch for characters getting lost.)

The init: , config: and baud: methods will set the configuration word of the port object, but not actually reconfigure the serial port itself. This is done by reset:, which may be used only after sending an open: to the port (otherwise -> bomb).

We implement the input and output handlers to work asynchronously, using the methods readNW: and writeNW: provided by the system. These routines need the pointer to a completion routine as a parameter. The completion routines are defined using the NEON word :proc (note that you may never execute a :proc directly, but may only pass it as a parameter to a toolbox routine).

A :proc should be short, and therefore the routines only set flags that indicate that something has been received in the buffer or that the port is ready to transmit another character.

getone and typeone are the words that are used to read and write the serial port. getone does absolutely nothing as long as no character has been received; otherwise, it inserts this character into the TE record at the insertion point and starts the next asynchronous read. typeone will wait until the output port is ready to send data and then initiate an asynchronous write.

The background serial read is installed into the task list by

'c getone addtask

and when a character is typed out using typeone, the echo will be inserted into the TE record at the right position (assuming that the modem port is connected to some other system that supports full duplex communication).

I have provided two routines that let you change between typing text into the TE record locally and doing full duplex communication. Another menu -localmenu- is provided to switch between these two modes. The revised menu text is printed in listing 2.

This terminal emulator is now ready to capture text files through the serial port and transferring them through the clipboard to other applications.

Coming up: the review of the multi-tasking Forth system Mach1; a revision of the decompiler that can be used on NEON words and objects; and more.

Listing 1: Text Edit in NEON with scrap handling and serial support
\ application template example 
\ added scrap handling and some serial support
\ (c) J. Langowski 1986 for MacTutor V2#3
 
( te scrap to  desk scrap copy, uses definitions from frontEnd ) 
 hex    AB0 constant tescrap.len                                
          AB4 constant tescrap.handle
          960 constant scrap.len
decimal
                             
: put.tescrap  ( copy te scrap to desk scrap )  
     tescrap.len -base w@  ( scrap available? ) 
     if  0 call zeroscrap drop
         0 tescrap.len -base w@  txtype 
         tescrap.handle -base @ >ptr +base  
         call putscrap drop
     then   
;            

: get.tescrap  ( copy desk scrap to te scrap )       
     scrap.len -base @  0> 
     if   0 tescrap.handle -base @ txtype abs: theOffset 
            call getscrap 
            tescrap.len -base W! 
     then   
;    

\ revised version of class editwindow.
\ some of the previously defined words 
\ are needed in this class 

:class editwindow <super ctlwind
    TErecord text
    var TEscrollbar
    int position

    :M teinit: new:    text ;M
    :M settext: settext: text ;M
    :M terec:  addr:   text ;M
    :M key:    key:    text ;M 
    :M idle:   idle:   text ;M

    :M act:    act:    text ;M
\ deactivate has to be handled explicitly by disable: 
\ for correct scrap handling
    :M deact:  deact:  text ;M
    :M disable: deact: text  put.tescrap  
         disable: super ;M
 
    :M click:  click:  text ;M
    :M cut:    cut:    text ;M
    :M copy:   copy:   text ;M
    :M paste:  paste:  text ;M
    :M getcont: getrect: self swap 15 - swap ;M

\ draw: redraws window, recalculates text boundaries
    :M draw: getvrect: self calc.scroll.length
       16 swap size: [ obj: TEscrollbar ]
             moveto: [ obj: TEscrollbar ] draw: super 
       getcont: self setdest: text  
       getcont: self setview: text
       recalc: text  
       0 get: [ obj: TEscrollbar ] -1 * scroll: text
       getrect: self put: temprect 
       abs: temprect call invalrect
       (abs) call beginupdate  update: text 
       (abs) call endupdate 
    ;M
    
    :M release: release: text dispose: TEscrollbar ;M
    :M setcr:  setcr:  text ;M
    :M showscr: show: [ obj: TEscrollbar ] ;M
    :M classinit: heap> Vscroll put: TEscrollbar ;M
    :M initscroll: getvrect: self calc.scroll.length 
         addr: self  new: [ obj: TEscrollbar ] 
    ;M
    :M scroll: 
         dup +: position 0 swap -1 * scroll: text 
    ;M
    :M adjust: get: [ obj: TEscrollbar ] 
         get: position - scroll: self 
    ;M
    :M getscr: obj: TEscrollbar ;M
;class  

\ now setup serial support for window
     port modin    port modout
    0 0   init: modin    0 1   init: modout
    300 baud: modin   1 8 0 config: modin
\ the next line isn't really necessary, 
\ since the control routines work on both ports
\ simultaneously, anyway...
    300 baud: modout 1 8 0 config: modout

open: modin        open: modout
reset: modin       reset: modout

0 value rxfull   0 value txempty
0 variable serbuf

:proc inputdone     1 -> rxfull     ;proc
:proc outputdone   1 -> txempty ;proc

\ define main editing window
editwindow mytext

\ routines for background tasks
: adjust.cursor 
    word0 where: themouse pack 
    getcont: mytext put: temprect 
    abs: temprect call ptinrect word0 
    if ibeamcurs else call initcursor then 
;

: idle.text 
    idle: mytext adjust.cursor ;

\ serial i/o for TE record
: getone 
    rxfull if
            0 -> rxfull
            serbuf c@ dup 10 = 
                if drop 0 then  \ remove linefeeds
            makeint key: mytext
            'c inputdone serbuf 1 readNW: modin
            drop  \ get rid of fcode
           then
;

: typeone
    txempty if 
             serbuf c!
             'c outputdone serbuf 1 writeNW: modout
             drop \ junk fcode
            then
;


\ action words, changed w/multitasking support
: myact get.tescrap act: mytext ;
: ciao 
    'c getone killtask
    'c idle.text killtask 
    select: fwind set: fwind 
    release: mytext put.tescrap quit 
;
: mycont where: fevent g->l false makeint 
  click: mytext ;
: initwind <[ 4 ]> 'cfas ciao myact null mycont 
  actions: mytext 
;

: inup get: [ getscr: mytext ]  10 - 
  put: [ getscr: mytext ] adjust: mytext ;
: indn get: [ getscr: mytext ]  10 + 
  put: [ getscr: mytext ] adjust: mytext ;
: pgup get: [ getscr: mytext ] 100 - 
  put: [ getscr: mytext ] adjust: mytext ;
: pgdn get: [ getscr: mytext ] 100 + 
  put: [ getscr: mytext ] adjust: mytext ;
: thmb adjust: mytext ;
: initctl <[ 5 ]> 'cfas inup indn pgup pgdn thmb 
           actions: [ getscr: mytext ] ;

\ menu handlers
\ Edit menu
: cut cut: mytext ;
: copy copy: mytext ;
: paste paste: mytext ;

\ local/line switch
1 value linesw
: local  0 -> linesw ;
: online 1 -> linesw ;

: start.edit 
    begin key linesw 
    if typeone else makeint key: mytext then 
    again 
;

2 menu localmenu  
3 menu TEmenu 
1 menu filmen

rect edw  rect edest  rect eview
50 50 400 250 put: edw
5 5 380 240 put: edest  get: edest put: eview

: main  " TEmenu.txt" getmtxt 
    edw " Test Edit Window" docwind true true 
    new: mytext  initwind  
    call teinit 
    0 abs: edest abs: eview  teinit: mytext
    32 32 500 300 true setgrow: mytext
    10 10 500 300 true setdrag: mytext
    0 setcr: mytext  initscroll: mytext  initctl
" Text Edit Window, example MacTutor V2#3 (c) 1985 J. Langowski"
            settext: mytext
    0 2000 putrange: [ getscr: mytext ]
    select: mytext  set: mytext  
    'c idle.text addtask
    1 -> rxfull   1 -> txempty
    'c getone addtask
    start.edit 
;
Listing 2: Menu Text file for example
APPLEMEN  1
  "$14" 
    "About Neon™..." about
    "(___________"  null
    "RES"  DRVR   \  get desk acc
    "\\\"  
FILMEN  256
  "File"
     "Quit"   bye
     "\\\"
TEMENU 261
  "TEMenu"
     "Cut/X" cut
     "Copy/C" copy
     "Paste/V" paste
     "\\\"
LOCALMENU 262
    "Terminal"
        "Local" local
        "Line" online
        "\\\"
xxx
 
AAPL
$100.53
Apple Inc.
+1.37
MSFT
$45.33
Microsoft Corpora
+0.22
GOOG
$586.86
Google Inc.
+4.70

MacTech Search:
Community Search:

Software Updates via MacUpdate

Chromium 36.0.1985.143 - 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. FreeSMUG-Free OpenSource Mac User Group build is... Read more
Macgo Blu-ray Player 2.10.6.1691 - Blu-r...
Macgo Mac Blu-ray Player can bring you the most unforgettable Blu-ray experience on your Mac. Overview Macgo Mac Blu-ray Player can satisfy just about every need you could possibly have in a Blu-ray... Read more
Apple Motion 5.1.2 - Create and customiz...
Apple 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... Read more
A Better Finder Rename 9.39 - 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
PopChar X 6.6 - Floating window shows av...
PopChar X helps you get the most out of your font collection. With its crystal-clear interface, PopChar X provides a frustration-free way to access any font's special characters. Expanded... Read more
MacUpdate Desktop 6.0.2 - Install Mac ap...
MacUpdate Desktop 6 brings seamless 1-click installs and version updates to your Mac. With a free MacUpdate account and MacUpdate Desktop 6, Mac users can now install almost any Mac app on macupdate.... Read more
PDFpenPro 6.3.2 - Advanced PDF toolkit f...
PDFpenPro allows users to edit PDF's easily. Add text, images and signatures. Fill out PDF forms. Merge or split PDF documents. Reorder and delete pages. Even correct text and edit graphics! Create... Read more
PDFpen 6.3.2 - Edit and annotate PDFs wi...
PDFpen allows users to easily edit PDF's. Add text, images and signatures. Fill out PDF forms. Merge or split PDF documents. Reorder and delete pages. Even correct text and edit graphics! Features... Read more
OS X Yosemite 10.10 DP6 - Developer Prev...
Note: This is a Developer Preview. You must be a registered Apple Mac Developer to download this update. You can also sign up for the free OS X Beta Program to download and preview public beta... Read more
Flavours 1.1.15 - Create and apply theme...
Flavours is a Mac application that allow users to create, apply and share beautifully designed themes. Classy Give your Mac a gorgeous new look by applying delicious themes! Easy Unleash your... Read more

Latest Forum Discussions

See All

Go to Bed – An Interview With Touchfight...
Touchfight Games is an exciting new indie studio that was co-formed between game journalist and author Nathan Meunier, artist Leonard Kenyon, and programmer Jon Kenyon. Their debut game Go To Bed will be released this fall, and with all the... | Read more »
Assault Vector Review
Assault Vector Review By Rob Thomas on August 19th, 2014 Our Rating: :: SIMPLE STRATEGYUniversal App - Designed for iPhone and iPad While this hex-based warp ride is fine in theory, Assault Vector is a bit too simple to be... | Read more »
Tom Hanks’ Hanx Writer has Taken the App...
Tom Hanks’ Hanx Writer has Taken the App Store by Storm Posted by Jessica Fisher on August 19th, 2014 [ permalink ] iPad Only App - Designed for the iPad | Read more »
It Came from Canada: Galaxy Dash
With its use of well-established tropes like endless flying and sci-fi space shooting, the upcoming Galaxy Dash: Race to the Outer Run most likely won’t confound expectations. However, with its robust amount of opportunities for fun player... | Read more »
PromptSmart Review
PromptSmart Review By Jennifer Allen on August 19th, 2014 Our Rating: :: SNAPPY SPEECHGIVINGUniversal App - Designed for iPhone and iPad Offering you a teleprompter in your pocket, PromptSmart is immensely helpful for those who do... | Read more »
The Firm (Games)
The Firm 1 Device: iOS iPhone Category: Games Price: $.99, Version: 1 (iTunes) Description: RELEASE SPECIAL SALE 50%! Welcome to THE FIRM, Your profil retained our full consideration and we have the pleasure to inform you that your... | Read more »
They Need To Be Fed 3 (Games)
They Need To Be Fed 3 1.0.0 Device: iOS Universal Category: Games Price: $1.99, Version: 1.0.0 (iTunes) Description: 360 degree gravity platforming is back! Run, jump, collect, avoid enemies and feed yourself to the monster at the... | Read more »
Who Wore it Best? Phantom Flower vs. And...
Who Wore it Best? takes a break from all the bloodshed to check out two decidedly tranquil and nature-loving puzzles games: Phantom Flower and And Then it Rained. [ Who Wore it Best? Phantom Flower vs. And Then it Rained is a post from... | Read more »
Sentinel 4: Dark Star Review
Sentinel 4: Dark Star Review By Jennifer Allen on August 19th, 2014 Our Rating: :: STURDY TOWER DEFENSEUniversal App - Designed for iPhone and iPad After 4 years, the latest entry to the Sentinel series is here. It’s not quite as... | Read more »
TrashEver2 - You can move your selected...
TrashEver2 - You can move your selected notes to trash box. 1.0.0 Device: iOS Universal Category: Productivity Price: $.99, Version: 1.0.0 (iTunes) Description: TrashEver is an application only for throwing away the note of Evernote... | Read more »

Price Scanner via MacPrices.net

Razer Taipan Mouse For Gamers And Non-Gamers...
If you’re a serious gamer on either Mac or Windows PCs, a serious gaming mouse is a necessity for first-tier performance. However, even if like me you’re not much of a gamer, there’s still a strong... Read more
15-inch 2.2GHz MacBook Pro on sale for $1899,...
Adorama has the new 15″ 2.2GHz Retina MacBook Pro on sale for $1899 including free shipping plus NY & NJ sales tax only. Their price is $100 off MSRP, and it’s the lowest price available for this... Read more
Mid-Size Tablet Shootout Posted: iPad mini wi...
I ‘m curious about how many iPads Apple is actually selling these days. It’s been widely rumored and anticipated that new models with A8 SoCs, 2 GB of RAM, 8 megapixel cameras, and fingerprint... Read more
The 15 Biggest iPad Air Problems And How To A...
What’s this? Fifteen “biggest” problems with the iPad Air? Does that mean there are a lot of smaller problems as well? Say it isn’t so! My old iPad 2 has manifested no hardware problems in three... Read more
TYLT Syncable-Duo, 2-in-1 USB Cable With Appl...
TYLT has introduced the Syncable-Duo, a universal cable solution for charging and syncing data to smartphones and tablets. The Syncable-Duo eliminates the need for multiple cables by incorporating... Read more
Save up to $140 off MSRP with Apple refurbish...
Apple is offering Certified Refurbished iPad Airs for up to $140 off MSRP. Apple’s one-year warranty is included with each model, and shipping is free. Stock tends to come and go with some of these... Read more
2.5GHz Mac mini on sale for $549, save $50
B&H Photo has the 2.5GHz Mac mini on sale for $549.99 including free shipping. That’s $50 off MSRP, and B&H will also include a free copy of Parallels Desktop software. NY sales tax only. Read more
Chromebooks Are Actually Sometimes A Better C...
Mac360′s Kate MacKenzie notes that when Steve Jobs announced the post-PC era, he was assuming that the dominant post-PC device would be the iPad he was unveiling, or another Apple product like the... Read more
Files-Finder Edition 1.0 app Brings Finder/Ex...
Appsicum’s Files Finder App is designed for iPad users who miss the functionality of the OS X Finder and Windows’ Explorer on their tablet. Files-Finder Edition App is a complete tool having rich... Read more
Apple and Samsung Both Face Growth Declines I...
As the tablet PC market matures and growth slows, the dominance of market leaders Apple and Samsung is also weakening, according to the latest NPD DisplaySearch Monthly Tablet PC Panel Shipment... Read more

Jobs Board

Project Manager / Business Analyst, WW *Appl...
…a senior project manager / business analyst to work within our Worldwide Apple Fulfillment Operations and the Business Process Re-engineering team. This role will work Read more
Position Opening at *Apple* - Apple (United...
**Job Summary** As businesses discover the power of Apple computers and mobile devices, it's your job - as a Solutions Engineer - to show them how to introduce these Read more
Position Opening at *Apple* - Apple (United...
**Job Summary** As more and more people discover Apple , they visit our stores seeking ways to incorporate our products into their lives. It's your job, as a Store Read more
Position Opening at *Apple* - Apple (United...
**Job Summary** Being a Business Manager at an Apple Store means you're the catalyst for businesses to discover and leverage the power, ease, and flexibility of Apple Read more
Project Manager / Business Analyst, WW *Appl...
…a senior project manager / business analyst to work within our Worldwide Apple Fulfillment Operations and the Business Process Re-engineering team. This role will work Read more
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.