home *** CD-ROM | disk | FTP | other *** search
/ C/C++ Interactive Guide / c-cplusplus-interactive-guide.iso / c_ref / csource4 / 225_01 / deff3.txt < prev    next >
Text File  |  1987-06-10  |  18KB  |  536 lines
  1.                         DEFF3.TXT
  2.                         ---------
  3.  
  4.          I have given, below, a description of each of the functions
  5.          which I have written for the file -
  6.  
  7.                    DEFF3.C
  8.  
  9.          and which may be accessed through -
  10.  
  11.                    DEFF3(.CRL)
  12.  
  13.          when you use the CLINK function with BDS C.   It is not
  14.          necessary to specify "DEFF3" on the command line as BDS C
  15.          will look for any missing functions in the DEFF files,
  16.          automatically, in answer to a RETURN entered when it asks
  17.          you for instructions as to which CRL files it should search
  18.          for the missing functions.
  19.  
  20.          If you intend to use DEFF3 in this way then it should be on
  21.          the same disk as the BDS C DEFF files.   Now, the functions
  22.          I have written are -
  23.  
  24.  
  25.          BINARY         GET_DEFAULT         RESET_DSK
  26.          BITCOUNT       GET_IOBYTE          REVERSE
  27.          CGET           INDEX               SEARCH_FIRST
  28.          CLOSE_FILE     ISALNUM             SEARCH_NEXT
  29.          CLRSCREEN      ITOA                SELECT_DSK
  30.          CPUT           LISTC               SET_ATTRIBUTES
  31.          CON_STAT       MAKE_RO             SETDMA
  32.          CREATE_FILE    OPEN_FILE           SET_IOBYTE
  33.          DIRECTC        PRINT_DEC           SHELL_SORT
  34.          DPB_ADR        PRT_STR             SWAP_POINTERS
  35.          ERASE_FILE     READ_SEQ_SEC        USER_ID
  36.          GET_CPM        READ_STR            WRITE_SEQ_SEC
  37.  
  38.                    ADDED FUNCTIONS
  39.                    ---------------
  40.  
  41.          L_SHIFT        R_SHIFT             PRT_BIN
  42.          BIT_SET        BIT_RESET           ISPRINT
  43.          SCOPY_N        GET_ALV
  44.  
  45.  
  46.  
  47.          char BINARY(x, v, n)
  48.          int x, v[], n;
  49.          --------------------
  50.  
  51.          Checks whether a binary number (x) occurs in a sorted array
  52.          (v, of n elements) and, if so, returns the binary number or
  53.          else returns -1 if it doesn't occur.
  54.  
  55.  
  56.          char BITCOUNT(n)
  57.          unsigned n;
  58.          ----------------
  59.  
  60.          Returns the number of set bits ( = 1) in a byte.
  61.  
  62.  
  63.          unsigned BIT_RESET(u, n)
  64.          unsigned u;
  65.          int n;
  66.          ------------------------
  67.  
  68.          Will reset (to zero) the nominated bit number ( n = 0 to 15)
  69.          in an unsigned integer "u".   Returns the unsigned integer
  70.          with the nominated bit reset to zero.
  71.  
  72.  
  73.          unsigned BIT_SET(u, n)
  74.          unsigned u;
  75.          int n;
  76.          ----------------------
  77.  
  78.          Will set (to one) the nominated bit number ( n = 0 to 15)
  79.          in an unsigned integer "u".   Returns the unsigned integer
  80.          with the nominated bit set to one.
  81.  
  82.  
  83.          char CGET()
  84.          -----------
  85.  
  86.          Similar to "getchar" in what it does except that it will
  87.          read ANY byte value from the console.  i.e. the value you
  88.          enter doesn't have to be either ASCII or printable.
  89.  
  90.          It returns the value of the byte entry.
  91.  
  92.  
  93.          char CLOSE_FILE(fcb)
  94.          char fcb[36];
  95.          --------------------
  96.  
  97.          This will close the file whose name is included in the file
  98.          control block pointed to by "fcb".   It is the companion
  99.          function to "OPEN_FILE" and should be used to close any file
  100.          previously opened with OPEN_FILE.   It returns the same
  101.          values as OPEN_FILE.
  102.  
  103.  
  104.          void CLRSCREEN()
  105.          ----------------
  106.  
  107.          Will clear the screen and home the cursor, using in-built
  108.          terminal software commands.   It is (probably) only usable
  109.          by Hazeltine family terminals but could be altered to suit
  110.          other terminals provided you know the byte value(s) to send
  111.          to the terminal to activate the clear screen/home function.
  112.  
  113.          Doesn't return anything.
  114.  
  115.  
  116.          char CON_STAT()
  117.          ---------------
  118.  
  119.          This checks the console status and returns ZERO if there is
  120.          no character waiting, else it returns 0xff....NOT the
  121.          character itself.   It is a useful function for those inputs
  122.          where you tell the user -
  123.  
  124.               "Enter any character to continue."
  125.  
  126.  
  127.          void CPUT(c)
  128.          int c;
  129.          ------------
  130.  
  131.          Similar to "putchar" except that it will send ANY byte value
  132.          to the console.   Naturally the console will only display
  133.          the "visible" characters.   Doesn't return anything useful.
  134.  
  135.  
  136.          char CREATE_FILE(fcb)
  137.          char fcb[36];
  138.          ---------------------
  139.  
  140.          This will create the file named in the file control block
  141.          (see open_file for a description of this) an initialise it
  142.          for both read and write functions.   Note particularly that
  143.          it doesn't check to see whether a file of this name already
  144.          exists so you need to do this independently if you want to
  145.          make sure you haven't got two files of the same name in the
  146.          disk directory.
  147.  
  148.          It is supposed to return 0xff (255 decimal) if the disk is
  149.          full and the name can't be created, but I'm not so sure
  150.          that you can rely on it to do so.   Probably the best way
  151.          to be sure is to now try to open the file (with open_file)
  152.          and see what happens then.
  153.  
  154.  
  155.          char DIRECTC(duty)
  156.          int duty;
  157.          ------------------
  158.  
  159.  
  160.          This is CP/M function No. 6 and it can be used to either get
  161.          a character from the terminal, or to send a character to the
  162.          console.   It depends on the value of "duty" which should be
  163.          either -
  164.  
  165.               0xff                for input from the terminal
  166.          or   the byte value      for output to the console
  167.  
  168.          It returns the input character in the first case or zero in
  169.          the second case.
  170.  
  171.          unsigned DPB_ADR()
  172.          ------------------
  173.  
  174.          Gives the Disk Parameter Block address (pointer to).   You
  175.          should first have declared the pointer as -
  176.  
  177.                    struct dpb *pointer;
  178.  
  179.          This allows access to the following values -
  180.  
  181.          int  pointer->SPT        No. of records per track
  182.          char pointer->BSH        Block Shift Factor
  183.          char pointer->BKM        Block Mask
  184.          char pointer->EXM        Extent Mask
  185.          int  pointer->DSM        Disk Space Maximum (highest block)
  186.          int  pointer->DRM        Directory Maximum (highest entry)
  187.          char pointer->AL0        Initial Allocation Vector
  188.          char pointer->AL1        do (high byte)
  189.          int  pointer->CKS        Check Area Size
  190.          int  pointer->OFF        Count of reserved tracks
  191.  
  192.          Note that the definition for "dpb" is given in "PEC.H" and
  193.          this should be "included" in the programme if you wish to
  194.          access the disk parameter block.
  195.  
  196.  
  197.          char ERASE_FILE(fcb)
  198.          char fcb[36];
  199.          --------------------
  200.  
  201.          Erases from the directory the name of the file in the file
  202.          control block.   For a description of this see open_file.
  203.          It will return 0xff if the file isn't found.
  204.  
  205.  
  206.          unsigned GET_ALV()
  207.          ------------------
  208.  
  209.          Returns a pointer to the Allocation Vector which gives the
  210.          allocation block map for the selected disk.   Note the map
  211.          is a number of bytes with a particular bit set if the block
  212.          is in use.   You can obtain the highest allocation block
  213.          number from the Disk Parameter Block (see DPB_ADR).
  214.  
  215.  
  216.          int GET_CPM()
  217.          -------------
  218.  
  219.          Returns a 16-bit number (in HL) with the details -
  220.  
  221.               H = 0x00 for CP/M  OR  H = 0x01 for MP/M
  222.               L = 0x00 for all releases prior to 2.0
  223.               L = 0x20 for version 2.0, 0x21 for version 2.1, 0x22
  224.                   for version 2.2, and so on.
  225.  
  226.          If you want to use any of this information then you will
  227.          need to mask off H (or L) to find out what it was the
  228.          function returned.
  229.  
  230.  
  231.          char GET_DEFAULT()
  232.          -----