Home Building DHTML Scripting Using Diaperglu Documention Key Script Commands Reference C Library API Reference Handy References About License Contact Forth Draft Standard
Directory Documentation key   C Functions dg_forthdots dg_forthdumphex dg_forthwords dg_forthbye dg_forthsynonym
// //////////////////////////////////////////////////////////////////////////////////////
//
// dg_forthdots ( .S )  
//
// C prototype:
//  void dg_forthdots (Bufferhandle* pBHarrayhead)
//
// Inputs:
//  Bufferhandle* pBHarrayhead    pointer to a Bufferhandle structure which is 
//                                 used as the bufferhandle for the array where the 
//                                 other bufferhandles are stored.
//
// Stack action shorthand:
//  ( -- )
//                                                            
// Action:
//  displays the contents of the data stack from first pushed to most recently pushed
//
// Forth standard:
//  15.6.1.0220
//
// Failure cases:
//  not checked
//  
// //////////////////////////////////////////////////////////////////////////////////////
// //////////////////////////////////////////////////////////////////////////////////////
//
// dg_forthdumphex ( DUMP )
//
// C prototype:
//  void dg_forthdumphex (Bufferhandle* pBHarrayhead)
//
// Inputs:
//  Bufferhandle* pBHarrayhead  pointer to a Bufferhandle structure which is 
//
//
// Stack action shorthand:
//  ( addr length -- )
//
// Data stack in:
//  addr                        start address of memory to display
//  length                      length of memory to display
//
// Action:
//  displays memory in DUMP format
//
// Forth standard:
//  15.6.1.1280
//
// Failure cases:
//  error popping parameters from the data stack
//  error changing base
//  bad address error
//   
// //////////////////////////////////////////////////////////////////////////////////////
// //////////////////////////////////////////////////////////////////////////////////////
//
// dg_forthwords ( WORDS )  
//
// C prototype:
//  void dg_forthwords (Bufferhandle* pBHarrayhead)
//
// Inputs:
//  Bufferhandle* pBHarrayhead    pointer to a Bufferhandle structure which is 
//                                 used as the bufferhandle for the array where the 
//                                 other bufferhandles are stored.
//
// Stack action shorthand:
//  ( -- )
//                                                            
// Action:
//  shows the names of the definitions in the top word list in the search order
//
// Forth standard:
//  15.6.1.2465
//
// Failure cases:
//  not checked
//  
// //////////////////////////////////////////////////////////////////////////////////////
// //////////////////////////////////////////////////////////////////////////////////////
//
// dg_forthbye ( BYE )
//
// C prototype:
//  void dg_forthbye (Bufferhandle* pBHarrayhead)
//
// Inputs:
//  Bufferhandle*  pBHarrayhead      pointer to a Bufferhandle structure which is 
//                                    used as the bufferhandle for the array where the 
//                                    other bufferhandles are stored
//
// Stack action shorthand:
//  ( -- )
//
// Action:
//  Sets the exit process flag which causes the process to exit the next time it gets 
//   back to the main QUIT loop.
//
// Forth standard:
//  15.6.2.0830
//
// Failure cases:
//  error changing the state of the exit flag (subroutine pushes error)
//   
// //////////////////////////////////////////////////////////////////////////////////////
// //////////////////////////////////////////////////////////////////////////////////////
//
// dg_forthsynonym ( SYNONYM )
//
// C prototype:
//  void dg_forthsynonym (Bufferhandle* pBHarrayhead)
//
// Inputs:
//  Bufferhandle* pBHarrayhead    pointer to a Bufferhandle structure which is 
//                                 used as the bufferhandle for the array where the 
//                                 other bufferhandles are stored.
//
// Stack action shorthand:
//  ( "<delimiters>oldword<delimiters>morestuff<delimiters>
//    newword<delimiters>morestuff"
//     -currentinputbuffer- "<delimiters>morestuff")
//  ( -- )
//            
// Current input buffer at current offset in:
//  "<delimiters>oldword<delimiters>morestuff<delimiters>
//    newword<delimiters>morestuff"                     
//
// Current input buffer at current offset out:
//  "<spaces>morestuff"  
//                                                              
// Action:
//  Parses two word names from the current input buffer. Then finds the first name in
//   current search order. If a word is found that has the first name, this then 
//   creates a new word in the current new word wordlist that has the same compile 
//   routine buffer and offset of the first word, and the same data buffer and offset 
//   of the first word, but has the 2nd parsed name as it's name.
//   The new word will have a different execution token from the old word.
//
// Forth standard:
//  in the proposal state July 26, 2020
//
// Handling of ambiguous conditions:  
//
// Failure cases:
//  
// //////////////////////////////////////////////////////////////////////////////////////