home *** CD-ROM | disk | FTP | other *** search
/ GEMini Atari / GEMini_Atari_CD-ROM_Walnut_Creek_December_1993.iso / files / program / funnel / mapper.h < prev    next >
Encoding:
C/C++ Source or Header  |  1993-10-23  |  3.5 KB  |  70 lines
  1. /*##############################################################################
  2.  
  3. FUNNNELWEB COPYRIGHT
  4. ====================
  5. FunnelWeb is a literate-programming macro preprocessor.
  6.  
  7. Copyright (C) 1992 Ross N. Williams.
  8.  
  9.    Ross N. Williams
  10.    ross@spam.adelaide.edu.au
  11.    16 Lerwick Avenue, Hazelwood Park 5066, Australia.
  12.  
  13. This program is free software; you can redistribute it and/or modify
  14. it under the terms of Version 2 of the GNU General Public License as
  15. published by the Free Software Foundation.
  16.  
  17. This program is distributed WITHOUT ANY WARRANTY; without even the implied
  18. warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
  19. See Version 2 of the GNU General Public License for more details.
  20.  
  21. You should have received a copy of Version 2 of the GNU General Public
  22. License along with this program. If not, you can FTP the license from
  23. prep.ai.mit.edu/pub/gnu/COPYING-2 or write to the Free Software
  24. Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  25.  
  26. Section 2a of the license requires that all changes to this file be
  27. recorded prominently in this file. Please record all changes here.
  28.  
  29. Programmers:
  30.    RNW  Ross N. Williams  ross@spam.adelaide.edu.au
  31.  
  32. Changes:
  33.    07-May-1992  RNW  Program prepared for release under GNU GPL V2.
  34.  
  35. ##############################################################################*/
  36.  
  37.  
  38. /******************************************************************************/
  39. /*                                  MAPPER.H                                  */
  40. /******************************************************************************/
  41. /*                                                                            */
  42. /* The mapper is the first of FunnelWeb's four front end processors: (mapper, */
  43. /* scanner, parser, analyser). The sole task of the mapper is, given the      */
  44. /* name of a file, to create an image of that file in memory. This approach   */
  45. /* is not wasteful of memory at all because FunnelWeb requires random access  */
  46. /* to each input file at all times anyway so it can scramble the text around. */
  47. /*                                                                            */
  48. /******************************************************************************/
  49.  
  50. #include "style.h"
  51.  
  52. /******************************************************************************/
  53.  
  54. EXPORT char *map_file P_((char *,char **,ulong *));
  55. /* Allocates a block of memory and places a Unix text stream representation   */
  56. /* (with EOL marking end of line and no character marking end of file) of the */
  57. /* file 'p_name' in the block of memory. Returns a pointer to the address and */
  58. /* len of the file in the mem block in the parameters (pp_mem and p_length).  */
  59. /* Returns NULL upon success or a pointer to an error message string upon     */
  60. /* failure. Note: Parameters are: p_name, pp_mem, p_length.                   */
  61. /* Note: Allocates enough memory so that there is guaranteed to be at least   */
  62. /* two extra bytes of spare memory at the end of the mapped file. The         */
  63. /* scanner uses this space to put EOL and EOF characters.                     */
  64. /* Note: The mapper grabs its memory using mm_temp, so it can be recycled     */
  65. /* as part of a call to mm_zapt.                                              */
  66.  
  67. /******************************************************************************/
  68. /*                               End of MAPPER.H                              */
  69. /******************************************************************************/
  70.