CBM Funet Archive/cbm-funet-archive-2003.iso/cpm/editors/zde16.pma/ZDKCOM13.DOC

Text File | 1979-12-31 | 10KB | 209 lines

                              zdkcom



                    kEY fILE cOMPILER FOR zde



                     vERSION 1.3   01 jUN 90



  zdkcom AND ITS DOCUMENTATION ARE ADAPTED WITH PERMISSION FROM

  vdkcom12.lbr, BY fRED hAINES, gLENDALE lITTERA rcpm/qbbs, 818

  956-6164.  vdkcom VERSION 1.2 IS COPYRIGHT 1988 BY fRED hAINES,

  AND IS RELEASED BY THE AUTHOR TO THE cp/m COMMUNITY FOR ALL

  REASONABLE NONCOMMERCIAL PURPOSES.  fOR THE z80 SOURCE CODE TO

  zdkcom, SEE zdkcom13.lbr.





                             contents



                    1.  hOW TO uSE zdkcom.

                    2.  pROGRAMMER'S nOTE.





1.  hOW TO uSE zdkcom.



     zdkcom COMPILES AN ascii TEXT FILE INTO A *.zdk FILE OF KEY

MACROS WHICH zdenstal WILL INSTALL IN zde.  iT ALSOS CONVERT AN

EXISTING zdk FILE INTO A TEXT FILE WITH THE EXTENSION zdt.  iT

ALLOWS YOU TO CREATE, EDIT, AND RE-EDIT COMPLICATED KEY MACROS

WITH A FULL-FEATURED WORD PROCESSOR - zde ITSELF - INSTEAD OF THE

BACKSPACE-ONLY LINE EDITOR IN zdenstal.  tHE SYNTAX IS:



 zdkcom <UFN>.zdt

   CONVERTS TEXT FILE TO zdk OVERLAY



 zdkcom <UFN>.zdk

   CONVERTS OVERLAY TO zdt TEXT FILE



     uSE zde IN nondocument MODE TO TYPE A FILE THAT LOOKS LIKE

WHAT YOU SEE WHEN YOU USE THE k OPTION OF zdenstal, SUBSTITUTING

LOWER CASE "N" OR "Q" FOR THE nO rEPEAT AND qUIET OPTION

INDICATORS <n> AND <q>:



  QtHIS LINE WOULD BE FOR KEY 0 IN qUIET MODE.^m

  NtHIS LINE WOULD BE FOR KEY 1 IN nO rEPEAT MODE.^m



  tHIS LINE WOULD BE KEY 3, WITH KEY 2 UNASSIGNED.

  N<tHIS LINE WOULD APPEAR IN ANGLE BRACKETS.>^m^m^m

  tHE LINE ABOVE, KEY 4, PRINTS WITH TWO BLANK LINES FOLLOWING IT.

  Q"tHIS IS IN QUOTES, BUT NO CARRIAGE RETURN AT THE END."

  "tHIS LINE IS ^p^bmACRO kEY 7^p^b WITH EMBEDDED BOLDFACE CODES."^m

  Q^vtHIS LINE TURNS INSERT ON BEFORE PRINTING THE LINE.^a^a^a^a_^f^d_^m

  N <kEY 9 NOT INSTALLED>^a^a^a^a



...AND SO ON.  lINES CORRESPOND TO THE NUMBER KEYS IN 0 TO 9

ORDER, WITH BLANK LINES FOR UNASSIGNED KEYS.  dO not EMBED CONTROL

CODES.  tYPE EVERYTHING IN ascii.  fOR INSTANCE, TO UNDERLINE,

TYPE OUT '^p^sWORDS UNDERLINED^p^s'.  iT'S A GOOD IDEA TO MAKE

HARD CARRIAGE RETURNS VISIBLE BY TOGGLING THEM ON WITH THE ^od

COMMAND.  zdkcom ACCEPTS TRAILING SPACES AS PART OF THE MACRO,

EVEN THOUGH YOU CAN'T SEE THEM, SO, IF YOU DON'T WANT THEM, MAKE

SURE EACH LINE IS TERMINATED BY A HARD CARRIAGE RETURN.

     iNDIVIDUAL KEY MACRO STRINGS MAY NOT EXCEED 127 BYTES IN THE

zdk FILE, THOUGH THEY MAY IN THE zdt TEXT FILE, SINCE ascii

REPRESENTATIONS OF SINGLE-BYTE CONTROL CODES REQUIRE TWO BYTES,

AND OPTION FLAGS AND SLASHES DON'T CONTRIBUTE TO THE LENGTH OF THE

STRING.

     tHE TOTAL OF ALL STRINGS MAY NOT EXCEED 498 OUTPUT BYTES.

tHIS IS TWO BYTES LESS THAN ALLOWED BY zde AND zdenstal, BUT,

UNDER THE PROGRAM'S PRESENT LOGIC, IT WOULD REQUIRE AN INORDINATE

AMOUNT OF CODE TO MAKE THOSE LAST TWO BYTES AVAILABLE.  iF YOU

REALLY NEED THEM, ADD THEM TO THE zdk FILE WITH zpatch OR ANY

OTHER PATCHER, LOCATE THE LAST STRING-LENGTH BYTE, AND ADD 2 (IN

HEX) TO IT.

     fOR A QUICK DEMO, REMOVE THE LEADING SPACES FROM THE LINES

BELOW, MARK THEM AS A BLOCK, AND WRITE THEM OUT TO <UFN>.zdt.  rUN

zdkcom <UFN>.zdt.  tHEN LOAD THE RESULTING zdk FILE INTO zde WITH

THE COMMAND zdenstal zde <UFN>.zdk.



  Q^c^c^c^e^e^e^e^e^[^e

  Q^[B^[0^qS^x^[=^m1^[= 1^s^v ^d^[!0^[1^qB^b^kU

  ^[=^m0^v^i^v^b^g^[![^[0^x

  ^[=^m0^t^b^n^[0^x

  Q^p^[^p^i^p^k^p^[9

  Q^v^kRa0:lh.fmt^m

  Q^g^g^g^g^x

  Q<NOT INSTALLED>^a^a^s

  Q<NOT INSTALLED>^a^a^s

  Q^kRheader^m



kEY MACRO 0 MEASURES OFF ONE FULL PAGE IF THE TOP MARGIN IS 0 AND

THE PAGE LENGTH IS 58 LINES.  aDJUST FOR DIFFERENT PAGE LENGTHS BY

ADDING OR SUBTRACTING ^e'S.  i USE THIS MACRO TO MOVE FROM LINE 1

OF A PAGE TO LINE 1 OF THE NEXT PAGE.  i THEN USE KEY MACRO 9 TO

READ IN A PAGE HEADER FROM A SEPARATE FILE THAT CONTAINS NOTHING

BUT THE PROPERLY SPACED HEADER TEXT WITH A # IN PLACE OF THE PAGE

NUMBER.  i SEARCH FOR # WITH A ^qF AND REPLACE IT WITH THE

APPROPRIATE PAGE NUMBERS.

     tHIS HAPPENS SO QUICKLY ON A 9 MHZ sb180 WITH HARD DISK THAT

IT IS VIRTUALLY UNNOTICEABLE, BUT THERE IS A FASTER WAY TO DO IT.

jUST MAKE UP A HEADER AT THE TOP OF THE FIRST PAGE, OR, IF YOU

WANT TO START PAGE HEADERS ONLY ON PAGE TWO, AT THE FOOT OF THE

FILE, AND MARK IT AS A BLOCK.  uSE KEY MACRO 0 TO MOVE FROM THE

TOP LINE OF A PAGE TO THE TOP LINE OF THE NEXT, AND COPY THE

HEADER INTO PLACE WITH THE ^kc COMMAND.  dON'T FORGET TO ERASE THE

ORIGINAL OF THE HEADER AT THE FOOT OF THE FILE WHEN YOU GET THERE.

     kEY MACRO 1 SOFTENS AND REFORMS A PARAGRAPH BY REMOVING THE

HARD CARRIAGE RETURNS FROM THE ENDS OF EACH LINE.

     kEY MACRO 2 CHANGES A DOCUMENT IN FLUSH LEFT BLOCK FORMAT

(LIKE THIS ONE) TO INDENTED PARAGRAPH FORM, AND KEY MACRO 3

CHANGES IT BACK AGAIN.

     kEY MACRO 4 EMBEDS MY diablo 1610-COMPATIBLE PRINTER'S CODE

FOR SETTING A LEFT MARGIN IN COLUMN 11 (^k=0bH) IN THE DOCUMENT.

iF i WANT ANOTHER MARGIN i ADD OR SUBTRACT FROM 0bH AND OVERWRITE

THE ^k WITH THE APPROPRIATE CONTROL CHARACTER.  yOU MAY WELL BE

ABLE TO SUBSTITUTE YOUR OWN PRINTER'S SET LEFT MARGIN CODE FOR

THIS ONE.

     kEY MACRO 5 READS IN A PREVIOUSLY PREPARED LETTERHEAD STORED

AS lh.fmt ON DRIVE/USER a0.

     kEY MACRO 6 REMOVES FOUR SPACES OR CHARACTERS FROM THE

BEGINNING OF EACH LINE, USED TO REMOVE LINE NUMBERS FROM THE

BEGINNINGS OF MESSAGES IN MODEM CAPTURE FILES.





2.  pROGRAMMER'S nOTE.



     a zdk FILE IS A DATA STRUCTURE FOUR RECORDS LONG.  tHE FIRST

TWO BYTES ARE AN id NUMBER WHICH zdenstal CHECKS TO ENSURE THAT IT

IS WORKING WITH THE CORRECT VERSION.  tHE CURRENT NUMBER, 0250H,

IS VALID FOR SEVERAL RECENT VERSIONS OF zde.

     tHESE TWO BYTES ARE FOLLOWED BY UP TO TEN STRINGS, EACH

PRECEDED BY A STRING-LENGTH BYTE WHICH zde USES TO INDEX THE

STRING'S LOCATION.  eACH STRING IS LIMITED BY THE SIZE OF A BUFFER

IN zde TO 127 BYTES.

     aN EMPTY STRING IS INDICATED BY A STRING-LENGTH BYTE OF 00H.

aFTER THE LAST BYTE OF THE LAST STRING, THE REMAINDER OF THE 512

BYTES ARE FILLED WITH 00H.

     iT IS A PECULIARITY OF zdkcom THAT IT NEEDS TO WRITE TWO NULL

BYTES AT THE END OF THE FILE, WHICH MEANS THAT IT WILL ACCEPT ONLY

498 BYTES FOR THE TOTAL LENGTH OF ALL STRINGS (512, LESS TWO id

BYTES, LESS 10 STRING-LENGTH BYTES, LESS THESE TWO MORE) RATHER

THAN THE 500 THAT zde AND zdenstal ALLOW.

     wHEN YOU LOOK AT THE KEY MACRO BUFFER OF zde USING THE k

OPTION OF zdenstal, YOU SEE SOMETHING THAT LOOKS LIKE THIS:



  <0><q>tHIS LINE WOULD BE FOR KEY 0 IN qUIET MODE.^m

  <1><n>tHIS LINE WOULD BE FOR KEY 1 IN nO rEPEAT MODE.^m

  <2><>

  <3>tHIS LINE WOULD BE KEY 3, WITH KEY 2 UNASSIGNED.

  <4><n><tHIS LINE WOULD APPEAR IN ANGLE BRACKETS.>^m^m^m

  <5>tHE LINE ABOVE, KEY 4, PRINTS WITH TWO BLANK LINES FOLLOWING IT.

  <6><q>"tHIS IS IN QUOTES, BUT NO CARRIAGE RETURN AT THE END."

  <7>"tHIS LINE IS ^p^bmACRO kEY 7^p^b WITH EMBEDDED BOLDFACE CODES."^m

  <8><>

  <9><>



tHE NUMBERS DOWN THE SIDE AND THE OPTION INDICATORS <n>, <q>, AND

<> (NO OPTION) ARE SUPPLIED BY zdenstal.  tHE zdt TEXT FILE

VERSION OF THE SAME MACRO KEYS WOULD OMIT THE STRING NUMBERS AND

NO OPTION INDICATORS, AND CONVERT THE <n> AND <q> TO SIMPLE LOWER

CASE 'N' AND 'Q'.  iF YOU NEED LOWER CASE 'N' OR 'Q' AS THE FIRST

CHARACTER OF A KEY MACRO, JUST PRECEDE IT WITH A SLASH, WHICH WILL

BE IGNORED.

     zdkcom RECOGNIZES BLANK LINES AS UNASSIGNED KEYS.  tHESE

PRODUCE AN "ERROR" MESSAGE WHEN INVOKED BY zde.

     zde RECOGNIZES A nO rEPEAT OPTION IF THE THE HIGH BIT IS SET

ON THE FIRST BYTE OF THE MACRO STRING AFTER THE LENGTH BYTE, AND A

qUIET OPTION IF THE HIGH BIT IS SET ON BOTH OF THE FIRST TWO BYTES

OF THE STRING.

     tHE TRANSLATION PROCEDURE FROM TEXT TO OVERLAY REQUIRES:



  eNTER TWO-BYTE id STRING 02H 50H IN OUTPUT FILE.



  eNTER 00H TO SAVE A PLACE FOR A STRING LENGTH BYTE.



  cHECK FOR "N" OR "Q" AS FIRST THREE BYTES OF NEW STRING AND ADD

  80H TO THE NEXT BYTE OR NEXT TWO BYTES INPUT AS REQUIRED.



  rEAD IN THE REST OF THE STRING BYTE BY BYTE AND OUTPUT EACH BYTE

  TO THE OUTPUT FILE.  iF "^" APPEARS IN THE STRING, DROP IT AND

  SUBTRACT 40H FROM NEXT BYTE TO MAKE IT INTO A REAL CONTROL

  CHARACTER.  iF "/" APPEARS, IGNORE IT AND PRINT THE NEXT

  CHARACTER LITERALLY.  "/^" PRINTS "^" RATHER THAN TURN THE

  CHARACTER FOLLOWING THE CARAT INTO A CONTROL CODE, AND "//"

  PRINTS A SINGLE SLASH.  a SINGLE INPUT SLASH IS IGNORED.



  wHEN THE crlf PAIR IS ENCOUNTERED IN THE INPUT TEXT FILE,

  CONVERT IT TO A 00H PLACE MARKER FOR THE LENGTH OF THE NEXT

  STRING.  gET THE NUMBER OF BYTES OUTPUT IN THE LAST STRING AND

  WRITE IT TO THE POSITION OF THE STRING-LENGTH BYTE AT THE HEAD

  OF THE PRECEDING STRING.



  wHEN THE TEXT FILE'S ^z eof IS ENCOUNTERED, FILL THE REMAINDER

  OF THE TOTAL 512 BYTES WITH 00H AND CLOSE THE FILES.



wHEN CONVERTING zdk OVERLAYS TO zdt TEXT FILES, THE PROCEDURE IS

MORE OR LESS REVERSED.  zdkcom CONVERTS THE STRING LENGTH BYTES TO

crlf PAIRS, THE CONTROL CODE BYTES TO TWO-BYTE ascii STRINGS '^C',

AND FINISHES OFF THE FILE WHEN ALL STRINGS ARE ACCOUNTED FOR BY

INSERTING AN eof ^z.

     iN ADDITION, zdkcom HAS ERROR CHECKING FOR FILE OPENING AND

CLOSING AND FOR INDIVIDUAL AND OVERALL STRING LENGTH, AND IT

REPORTS ACTIVITY TO KEEP THE USER FROM THINKING THE PROGRAM HAS

HUNG, THOUGH THE COUNTERS ON THE SCREEN ARE OTHERWISE MEANINGLESS.

     tHE STRUCTURE OF THE FOUR-SECTOR zdk FILE IN cp/m IS SO

SIMILAR TO THE EIGHT-SECTOR ms/dos VERSION THAT YOU CAN USE

zdkcom, ALONG WITH A PATCHER, TO CREATE A vdk FILE FOR

INSTALLATION IN vde12, THE ms/dos VERSION OF zde.  mAKE UP THE zdt

FILE AS YOU WOULD FOR cp/m, THEN PATCH THE SECOND id BYTE FROM 50H

TO 60H AND ADD FOUR RECORDS OF NULLS.