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
 

Community Search:
MacTech Search:

Software Updates via MacUpdate

How to get all the crabs in Mr Crab 2
Mr. Crab 2 may look like a cutesy platformer for kids, but if you're the kind of person who likes to complete a game 100%, you'll soon realise that it's a tougher than a crustacean's shell. [Read more] | Read more »
How to be a star in Britney Spears: Amer...
If you've ever wanted to be a star, baby, then you've probably already checked out Britney Spears: American Dream and are happily making your way up the charts. But fame doesn't come easy, and everyone needs a helping hand sometimes. So we've got... | Read more »
AppSpy is hiring a part time Staff Write...
| Read more »
How to save lives in ER Surgery Simulato...
A serious earthquake has struck a nearby town in ER Surgery Simulator - Emergency Doctor, and it’s up to you to save the victims. [Read more] | Read more »
Tips and tricks to get a high score in G...
Ketchapp Games loves the endless runner genre. And its newest game, Gravity Switch, is no exception. Gravity Switch takes a fresh approach, though, as you move a block, suspended in zero gravity, safely through a maze of shifting pillars. If the... | Read more »
Tips and tricks to get a high score in S...
Smash Fu is a high-paced tile-tapping game that requires quick reflexes and some practice. You’ll have to smash bricks with the skill of a seasoned black belt to get a high score. To raise the stakes a bit, you’ll also have to avoid tapping any... | Read more »
How to keep the ball rolling in Dropple
If you're new to the minimalist puzzler Dropple, you may find yourself struggling to make it beyond the first couple of steps before your ball falls into the endless abyss below. [Read more] | Read more »
Game Craft releases new Legend of War ti...
Set for release at the end of this month, real time strategy title Legend of War seems sure to delight with a veritable feast of sweet features to get stuck into. Developed by Game Craft, the game is due for release through both the App Store and... | Read more »
How not to die in Traffic Rider
Traffic Rider, an Out Run-esque game in which your ride a motorcycle recklessly into trffic, might not seem particularly complicated. [Read more] | Read more »
How to adjust your chess game for Regici...
At first glance you might likenWarhammer 40,000: Regicide to Chess - and you'd be right. Regicideputs its own spin on the classic board game though, so some of your tried and true methods may not work quite so well here. [Read more] | Read more »

Price Scanner via MacPrices.net

Textkraft Professional Becomes A Mobile Produ...
The new update 4.1 of Textkraft Professional for the iPad comes with many new and updated features that will be particularly of interest to self-publishers of e-books. Highlights include import and... Read more
SnipNotes 2.0 – Intelligent note-taking for i...
Indie software developer Felix Lisczyk has announced the release and immediate availability of SnipNotes 2.0, the next major version of his productivity app for iOS devices and Apple Watch.... Read more
Pitch Clock – The Entrepreneur’s Wingman Laun...
Grand Rapids, Michigan based Skunk Tank has announced the release and immediate availability of Pitch Clock – The Entrepreneur’s Wingman 1.1, the company’s new business app available exclusively on... Read more
13-inch 2.9GHz Retina MacBook Pro on sale for...
B&H Photo has the 13″ 2.9GHz Retina MacBook Pro (model #MF841LL/A) on sale for $1599 including free shipping plus NY tax only. Their price is $200 off MSRP. Amazon also has the 13″ 3.9GHz Retina... Read more
Apple price trackers, updated continuously
Scan our Apple Price Trackers for the latest information on sales, bundles, and availability on systems from Apple’s authorized internet/catalog resellers. We update the trackers continuously: - 15″... Read more
Clearance 12-inch Retina MacBooks available s...
B&H Photo has dropped prices on leftover 2015 12″ Retina MacBooks with models now available starting at $999. Shipping is free, and B&H charges NY tax only: - 12″ 1.1GHz Gray Retina MacBook... Read more
Check Apple prices on any device with the iTr...
MacPrices is proud to offer readers a free iOS app (iPhones, iPads, & iPod touch) and Android app (Google Play and Amazon App Store) called iTracx, which allows you to glance at today’s lowest... Read more
New 2016 13-inch 256GB MacBook Air on sale fo...
B&H Photo has the new 13″ 1.6GHz/256GB MacBook Air (model MMGG2LL/A) on sale for $1149 including free shipping plus NY sales tax only. Their price is $50 off MSRP. Amazon has the 13″ 1.6GHz/256GB... Read more
Apple refurbished iPad Air 2s available start...
Apple has Certified Refurbished iPad Air 2 available starting at $339. Apple’s one-year warranty is included with each model, and shipping is free: - 128GB Wi-Fi iPad Air 2: $499 - 64GB Wi-Fi iPad... Read more
Accenture and Vatican Opera Romana Pellegrina...
Accenture has announced that the official mobile application for the Extraordinary Jubilee Year of Mercy declared by Pope Francis has been built and launched by Accenture Mobility, part of Accenture... Read more

Jobs Board

*Apple* Nissan Service Technicians - Apple A...
Apple Automotive is one of the fastest growing dealer...and it shows. Consider making the switch to the Apple Automotive Group today! At Apple Automotive , Read more
ISCS *Apple* ID Site Support Engineer - APP...
…position, we are looking for an individual who has experience supporting customers with Apple ID issues and enjoys this area of support. This person should be Read more
Automotive Sales Consultant - Apple Ford Linc...
…you. The best candidates are smart, technologically savvy and are customer focused. Apple Ford Lincoln Apple Valley is different, because: $30,000 annual salary Read more
*Apple* Support Technician II - Worldventure...
…global, fast growing member based travel company, is currently sourcing for an Apple Support Technician II to be based in our Plano headquarters. WorldVentures is Read more
Restaurant Manager (Neighborhood Captain) - A...
…in every aspect of daily operation. WHY YOU'LL LIKE IT: You'll be the Big Apple . You'll solve problems. You'll get to show your ability to handle the stress and Read more
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.